Increase test coverage (#538)

Also fix array in map bug.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,19 @@
+<!--
+
+Thank you for your pull request!
+
+Please read the Code changes section of the CONTRIBUTING.md file,
+and make sure you have followed the instructions.
+
+https://github.com/pelletier/go-toml/blob/v2/CONTRIBUTING.md#code-changes
+
+-->
+
+Explanation of what this pull request does.
+
+More detailed description of the decisions being made and the reasons why (if
+the patch is non-trivial).
+
+---
+
+Paste `benchstat` results here

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "gomod"
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,67 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master, v2 ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '26 19 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'go' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/coverage.yml

@@ -0,0 +1,23 @@
+name: coverage
+on:
+  push:
+    branches:
+      - v2
+  pull_request:
+    branches:
+      - v2
+
+jobs:
+  report:
+    runs-on: 'ubuntu-latest'
+    name: report
+    steps:
+      - uses: actions/checkout@master
+        with:
+          fetch-depth: 0
+      - name: Setup go
+        uses: actions/setup-go@master
+        with:
+          go-version: 1.16
+      - name: Run tests with coverage
+        run: ./ci.sh coverage -d "${GITHUB_BASE_REF-HEAD}"

.github/workflows/workflow.yml

@@ -0,0 +1,25 @@
+name: test
+on:
+  push:
+    branches:
+      - v2
+  pull_request:
+    branches:
+      - v2
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os: [ 'ubuntu-latest', 'windows-latest', 'macos-latest']
+        go: [ '1.15', '1.16' ]
+    runs-on: ${{ matrix.os }}
+    name: ${{ matrix.go }}/${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@master
+      - name: Setup go ${{ matrix.go }}
+        uses: actions/setup-go@master
+        with:
+          go-version: ${{ matrix.go }}
+      - name: Run unit tests
+        run: go test -race ./...

.golangci.toml

@@ -0,0 +1,84 @@
+[service]
+golangci-lint-version =  "1.39.0"
+
+[linters-settings.wsl]
+allow-assign-and-anything = true
+
+[linters-settings.exhaustive]
+default-signifies-exhaustive = true
+
+[linters]
+disable-all = true
+enable = [
+    "asciicheck",
+    "bodyclose",
+    "cyclop",
+    "deadcode",
+    "depguard",
+    "dogsled",
+    "dupl",
+    "durationcheck",
+    "errcheck",
+    "errorlint",
+    "exhaustive",
+    # "exhaustivestruct",
+    "exportloopref",
+    "forbidigo",
+    # "forcetypeassert",
+    "funlen",
+    "gci",
+    # "gochecknoglobals",
+    "gochecknoinits",
+    "gocognit",
+    "goconst",
+    "gocritic",
+    "gocyclo",
+    "godot",
+    "godox",
+    # "goerr113",
+    "gofmt",
+    "gofumpt",
+    "goheader",
+    "goimports",
+    "golint",
+    "gomnd",
+    # "gomoddirectives",
+    "gomodguard",
+    "goprintffuncname",
+    "gosec",
+    "gosimple",
+    "govet",
+    # "ifshort",
+    "importas",
+    "ineffassign",
+    "lll",
+    "makezero",
+    "misspell",
+    "nakedret",
+    "nestif",
+    "nilerr",
+    # "nlreturn",
+    "noctx",
+    "nolintlint",
+    "paralleltest",
+    "prealloc",
+    "predeclared",
+    "revive",
+    "rowserrcheck",
+    "sqlclosecheck",
+    "staticcheck",
+    "structcheck",
+    "stylecheck",
+    # "testpackage",
+    "thelper",
+    "tparallel",
+    "typecheck",
+    "unconvert",
+    "unparam",
+    "unused",
+    "varcheck",
+    "wastedassign",
+    "whitespace",
+    # "wrapcheck",
+    # "wsl"
+]

CONTRIBUTING.md

@@ -1,74 +1,74 @@
-## Contributing
+# Contributing
 
 Thank you for your interest in go-toml! We appreciate you considering
 contributing to go-toml!
 
-The main goal is the project is to provide an easy-to-use TOML
-implementation for Go that gets the job done and gets out of your way –
-dealing with TOML is probably not the central piece of your project.
+The main goal is the project is to provide an easy-to-use and efficient TOML
+implementation for Go that gets the job done and gets out of your way – dealing
+with TOML is probably not the central piece of your project.
 
-As the single maintainer of go-toml, time is scarce. All help, big or
-small, is more than welcomed!
+As the single maintainer of go-toml, time is scarce. All help, big or small, is
+more than welcomed!
 
-### Ask questions
+## Ask questions
 
-Any question you may have, somebody else might have it too. Always feel
-free to ask them on the [issues tracker][issues-tracker].  We will try to
-answer them as clearly and quickly as possible, time permitting.
+Any question you may have, somebody else might have it too. Always feel free to
+ask them on the [discussion board][discussions]. We will try to answer them as
+clearly and quickly as possible, time permitting.
 
 Asking questions also helps us identify areas where the documentation needs
 improvement, or new features that weren't envisioned before. Sometimes, a
-seemingly innocent question leads to the fix of a bug. Don't hesitate and
-ask away!
+seemingly innocent question leads to the fix of a bug. Don't hesitate and ask
+away!
 
-### Improve the documentation
+[discussions]: https://github.com/pelletier/go-toml/discussions
 
-The best way to share your knowledge and experience with go-toml is to
-improve the documentation. Fix a typo, clarify an interface, add an
-example, anything goes!
+## Improve the documentation
 
-The documentation is present in the [README][readme] and thorough the
-source code. On release, it gets updated on [pkg.go.dev][pkg.go.dev]. To make a
-change to the documentation, create a pull request with your proposed
-changes. For simple changes like that, the easiest way to go is probably
-the "Fork this project and edit the file" button on Github, displayed at
-the top right of the file. Unless it's a trivial change (for example a
-typo), provide a little bit of context in your pull request description or
-commit message.
+The best way to share your knowledge and experience with go-toml is to improve
+the documentation. Fix a typo, clarify an interface, add an example, anything
+goes!
 
-### Report a bug
+The documentation is present in the [README][readme] and thorough the source
+code. On release, it gets updated on [pkg.go.dev][pkg.go.dev]. To make a change
+to the documentation, create a pull request with your proposed changes. For
+simple changes like that, the easiest way to go is probably the "Fork this
+project and edit the file" button on Github, displayed at the top right of the
+file. Unless it's a trivial change (for example a typo), provide a little bit of
+context in your pull request description or commit message.
 
-Found a bug! Sorry to hear that :(. Help us and other track them down and
-fix by reporting it. [File a new bug report][bug-report] on the [issues
-tracker][issues-tracker]. The template should provide enough guidance on
-what to include. When in doubt: add more details! By reducing ambiguity and
-providing more information, it decreases back and forth and saves everyone
-time.
+## Report a bug
 
-### Code changes
+Found a bug! Sorry to hear that :(. Help us and other track them down and fix by
+reporting it. [File a new bug report][bug-report] on the [issues
+tracker][issues-tracker]. The template should provide enough guidance on what to
+include. When in doubt: add more details! By reducing ambiguity and providing
+more information, it decreases back and forth and saves everyone time.
+
+## Code changes
 
 Want to contribute a patch? Very happy to hear that!
 
 First, some high-level rules:
 
-* A short proposal with some POC code is better than a lengthy piece of
-  text with no code. Code speaks louder than words.
-* No backward-incompatible patch will be accepted unless discussed.
-  Sometimes it's hard, and Go's lack of versioning by default does not
-  help, but we try not to break people's programs unless we absolutely have
+- A short proposal with some POC code is better than a lengthy piece of text
+  with no code. Code speaks louder than words. That being said, bigger changes
+  should probably start with a [discussion][discussions].
+- No backward-incompatible patch will be accepted unless discussed. Sometimes
+  it's hard, but we try not to break people's programs unless we absolutely have
   to.
-* If you are writing a new feature or extending an existing one, make sure
-  to write some documentation.
-* Bug fixes need to be accompanied with regression tests.
-* New code needs to be tested.
-* Your commit messages need to explain why the change is needed, even if
-  already included in the PR description.
+- If you are writing a new feature or extending an existing one, make sure to
+  write some documentation.
+- Bug fixes need to be accompanied with regression tests.
+- New code needs to be tested.
+- Your commit messages need to explain why the change is needed, even if already
+  included in the PR description.
 
-It does sound like a lot, but those best practices are here to save time
-overall and continuously improve the quality of the project, which is
-something everyone benefits from.
+It does sound like a lot, but those best practices are here to save time overall
+and continuously improve the quality of the project, which is something everyone
+benefits from.
 
-#### Get started
+### Get started
 
 The fairly standard code contribution process looks like that:
 
@@ -76,42 +76,92 @@ The fairly standard code contribution process looks like that:
 2. Make your changes, commit on any branch you like.
 3. [Open up a pull request][pull-request]
 4. Review, potential ask for changes.
-5. Merge. You're in!
+5. Merge.
 
 Feel free to ask for help! You can create draft pull requests to gather
 some early feedback!
 
-#### Run the tests
+### Run the tests
 
-You can run tests for go-toml using Go's test tool: `go test ./...`.
-When creating a pull requests, all tests will be ran on Linux on a few Go
-versions (Travis CI), and on Windows using the latest Go version
-(AppVeyor).
+You can run tests for go-toml using Go's test tool: `go test -race ./...`.
 
-#### Style
+During the pull request process, all tests will be ran on Linux, Windows, and
+MacOS on the last two versions of Go.
 
-Try to look around and follow the same format and structure as the rest of
-the code. We enforce using `go fmt` on the whole code base.
+However, given GitHub's new policy to _not_ run Actions on pull requests until a
+maintainer clicks on button, it is highly recommended that you run them locally
+as you make changes.
+
+### Check coverage
+
+We use `go tool cover` to compute test coverage. Most code editors have a way to
+run and display code coverage, but at the end of the day, we do this:
+
+```
+go test -covermode=atomic -coverprofile=coverage.out
+go tool cover -func=coverage.out
+```
+
+and verify that the overall percentage of tested code does not go down. This is
+a requirement. As a rule of thumb, all lines of code touched by your changes
+should be covered. On Unix you can use `./ci.sh coverage -d v2` to check if your
+code lowers the coverage.
+
+### Verify performance
+
+Go-toml aims to stay efficient. We rely on a set of scenarios executed with Go's
+builtin benchmark systems. Because of their noisy nature, containers provided by
+Github Actions cannot be reliably used for benchmarking. As a result, you are
+responsible for checking that your changes do not incur a performance penalty.
+You can run their following to execute benchmarks:
+
+```
+go test ./... -bench=. -count=10
+```
+
+Benchmark results should be compared against each other with
+[benchstat][benchstat]. Typical flow looks like this:
+
+1. On the `v2` branch, run `go test ./... -bench=. -count 10` and save output to
+   a file (for example `old.txt`).
+2. Make some code changes.
+3. Run `go test ....` again, and save the output to an other file (for example
+   `new.txt`).
+4. Run `benchstat old.txt new.txt` to check that time/op does not go up in any
+   test.
+
+On Unix you can use `./ci.sh benchmark -d v2` to verify how your code impacts
+performance.
+
+It is highly encouraged to add the benchstat results to your pull request
+description. Pull requests that lower performance will receive more scrutiny.
+
+[benchstat]: https://pkg.go.dev/golang.org/x/perf/cmd/benchstat
+
+### Style
+
+Try to look around and follow the same format and structure as the rest of the
+code. We enforce using `go fmt` on the whole code base.
 
 ---
 
-### Maintainers-only
+## Maintainers-only
 
-#### Merge pull request
+### Merge pull request
 
 Checklist:
 
-* Passing CI.
-* Does not introduce backward-incompatible changes (unless discussed).
-* Has relevant doc changes.
-* Has relevant unit tests.
+- Passing CI.
+- Does not introduce backward-incompatible changes (unless discussed).
+- Has relevant doc changes.
+- Benchstat does not show performance regression.
 
 1. Merge using "squash and merge".
 2. Make sure to edit the commit message to keep all the useful information
    nice and clean.
 3. Make sure the commit title is clear and contains the PR number (#123).
 
-#### New release
+### New release
 
 1. Go to [releases][releases]. Click on "X commits to master since this
    release".

Dockerfile

@@ -1,11 +0,0 @@
-FROM golang:1.12-alpine3.9 as builder
-WORKDIR /go/src/github.com/pelletier/go-toml
-COPY . .
-ENV CGO_ENABLED=0
-ENV GOOS=linux
-RUN go install ./...
-
-FROM scratch
-COPY --from=builder /go/bin/tomll /usr/bin/tomll
-COPY --from=builder /go/bin/tomljson /usr/bin/tomljson
-COPY --from=builder /go/bin/jsontoml /usr/bin/jsontoml

Makefile

@@ -1,29 +0,0 @@
-export CGO_ENABLED=0
-go := go
-go.goos ?= $(shell echo `go version`|cut -f4 -d ' '|cut -d '/' -f1)
-go.goarch ?= $(shell echo `go version`|cut -f4 -d ' '|cut -d '/' -f2)
-
-out.tools := tomll tomljson jsontoml
-out.dist := $(out.tools:=_$(go.goos)_$(go.goarch).tar.xz)
-sources := $(wildcard **/*.go)
-
-
-.PHONY:
-tools: $(out.tools)
-
-$(out.tools): $(sources)
-	GOOS=$(go.goos) GOARCH=$(go.goarch) $(go) build ./cmd/$@
-
-.PHONY:
-dist: $(out.dist)
-
-$(out.dist):%_$(go.goos)_$(go.goarch).tar.xz: %
-	if [ "$(go.goos)" = "windows" ]; then \
-		tar -cJf $@ $^.exe; \
-	else \
-		tar -cJf $@ $^; \
-	fi
-
-.PHONY:
-clean:
-	rm -rf $(out.tools) $(out.dist)

PULL_REQUEST_TEMPLATE.md

@@ -1,5 +0,0 @@
-**Issue:** add link to pelletier/go-toml issue here
-
-Explanation of what this pull request does.
-
-More detailed description of the decisions being made and the reasons why (if the patch is non-trivial).

README.md

@@ -1,150 +1,351 @@
-# go-toml
+# go-toml v2
 
-Go library for the [TOML](https://toml.io/) format.
+Go library for the [TOML](https://toml.io/en/) format.
 
-This library supports TOML version
-[v1.0.0-rc.3](https://toml.io/en/v1.0.0-rc.3)
+This library supports [TOML v1.0.0](https://toml.io/en/v1.0.0).
 
-[![Go Reference](https://pkg.go.dev/badge/github.com/pelletier/go-toml.svg)](https://pkg.go.dev/github.com/pelletier/go-toml)
-[![license](https://img.shields.io/github/license/pelletier/go-toml.svg)](https://github.com/pelletier/go-toml/blob/master/LICENSE)
-[![Build Status](https://dev.azure.com/pelletierthomas/go-toml-ci/_apis/build/status/pelletier.go-toml?branchName=master)](https://dev.azure.com/pelletierthomas/go-toml-ci/_build/latest?definitionId=1&branchName=master)
-[![codecov](https://codecov.io/gh/pelletier/go-toml/branch/master/graph/badge.svg)](https://codecov.io/gh/pelletier/go-toml)
-[![Go Report Card](https://goreportcard.com/badge/github.com/pelletier/go-toml)](https://goreportcard.com/report/github.com/pelletier/go-toml)
-[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fpelletier%2Fgo-toml.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fpelletier%2Fgo-toml?ref=badge_shield)
 
-## Features
+## Development status
 
-Go-toml provides the following features for using data parsed from TOML documents:
+This is the upcoming major version of go-toml. It is currently in active
+development. As of release v2.0.0-beta.1, the library has reached feature parity
+with v1, and fixes a lot known bugs and performance issues along the way.
+
+If you do not need the advanced document editing features of v1, you are
+encouraged to try out this version.
+
+👉 [Roadmap for v2](https://github.com/pelletier/go-toml/discussions/506).
+
+
+## Documentation
+
+Full API, examples, and implementation notes are available in the Go documentation.
+
+[![Go Reference](https://pkg.go.dev/badge/github.com/pelletier/go-toml/v2.svg)](https://pkg.go.dev/github.com/pelletier/go-toml/v2)
 
-* Load TOML documents from files and string data
-* Easily navigate TOML structure using Tree
-* Marshaling and unmarshaling to and from data structures
-* Line & column position data for all parsed elements
-* [Query support similar to JSON-Path](query/)
-* Syntax errors contain line and column numbers
 
 ## Import
 
 ```go
-import "github.com/pelletier/go-toml"
+import "github.com/pelletier/go-toml/v2"
 ```
 
-## Usage example
+## Features
 
-Read a TOML document:
+### Stdlib behavior
 
-```go
-config, _ := toml.Load(`
-[postgres]
-user = "pelletier"
-password = "mypassword"`)
-// retrieve data directly
-user := config.Get("postgres.user").(string)
+As much as possible, this library is designed to behave similarly as the
+standard library's `encoding/json`.
 
-// or using an intermediate object
-postgresConfig := config.Get("postgres").(*toml.Tree)
-password := postgresConfig.Get("password").(string)
+### Performance
+
+While go-toml favors usability, it is written with performance in mind. Most
+operations should not be shockingly slow.
+
+### Strict mode
+
+`Decoder` can be set to "strict mode", which makes it error when some parts of
+the TOML document was not prevent in the target structure. This is a great way
+to check for typos. [See example in the documentation][strict].
+
+[strict]: https://pkg.go.dev/github.com/pelletier/go-toml/v2#example-Decoder.SetStrict
+
+### Contextualized errors
+
+When decoding errors occur, go-toml returns [`DecodeError`][decode-err]), which
+contains a human readable contextualized version of the error. For example:
+
+```
+2| key1 = "value1"
+3| key2 = "missing2"
+ | ~~~~ missing field
+4| key3 = "missing3"
+5| key4 = "value4"
 ```
 
-Or use Unmarshal:
+[decode-err]: https://pkg.go.dev/github.com/pelletier/go-toml/v2#DecodeError
+
+### Local date and time support
+
+TOML supports native [local date/times][ldt]. It allows to represent a given
+date, time, or date-time without relation to a timezone or offset. To support
+this use-case, go-toml provides [`LocalDate`][tld], [`LocalTime`][tlt], and
+[`LocalDateTime`][tldt]. Those types can be transformed to and from `time.Time`,
+making them convenient yet unambiguous structures for their respective TOML
+representation.
+
+[ldt]: https://toml.io/en/v1.0.0#local-date-time
+[tld]: https://pkg.go.dev/github.com/pelletier/go-toml/v2#LocalDate
+[tlt]: https://pkg.go.dev/github.com/pelletier/go-toml/v2#LocalTime
+[tldt]: https://pkg.go.dev/github.com/pelletier/go-toml/v2#LocalDateTime
+
+## Getting started
+
+Given the following struct, let's see how to read it and write it as TOML:
 
 ```go
-type Postgres struct {
-    User     string
-    Password string
-}
-type Config struct {
-    Postgres Postgres
-}
-
-doc := []byte(`
-[Postgres]
-User = "pelletier"
-Password = "mypassword"`)
-
-config := Config{}
-toml.Unmarshal(doc, &config)
-fmt.Println("user=", config.Postgres.User)
-```
-
-Or use a query:
-
-```go
-// use a query to gather elements without walking the tree
-q, _ := query.Compile("$..[user,password]")
-results := q.Execute(config)
-for ii, item := range results.Values() {
-    fmt.Printf("Query result %d: %v\n", ii, item)
+type MyConfig struct {
+      Version int
+      Name    string
+      Tags    []string
 }
 ```
 
-## Documentation
+### Unmarshaling
 
-The documentation and additional examples are available at
-[pkg.go.dev](https://pkg.go.dev/github.com/pelletier/go-toml).
+[`Unmarshal`][unmarshal] reads a TOML document and fills a Go structure with its
+content. For example:
 
-## Tools
+```go
+doc := `
+version = 2
+name = "go-toml"
+tags = ["go", "toml"]
+`
 
-Go-toml provides three handy command line tools:
+var cfg MyConfig
+err := toml.Unmarshal([]byte(doc), &cfg)
+if err != nil {
+      panic(err)
+}
+fmt.Println("version:", cfg.Version)
+fmt.Println("name:", cfg.Name)
+fmt.Println("tags:", cfg.Tags)
 
-* `tomll`: Reads TOML files and lints them.
-
-    ```
-    go install github.com/pelletier/go-toml/cmd/tomll
-    tomll --help
-    ```
-* `tomljson`: Reads a TOML file and outputs its JSON representation.
-
-    ```
-    go install github.com/pelletier/go-toml/cmd/tomljson
-    tomljson --help
-    ```
-
- * `jsontoml`: Reads a JSON file and outputs a TOML representation.
-
-    ```
-    go install github.com/pelletier/go-toml/cmd/jsontoml
-    jsontoml --help
-    ```
-
-### Docker image
-
-Those tools are also availble as a Docker image from
-[dockerhub](https://hub.docker.com/r/pelletier/go-toml). For example, to
-use `tomljson`:
-
-```
-docker run -v $PWD:/workdir pelletier/go-toml tomljson /workdir/example.toml
+// Output:
+// version: 2
+// name: go-toml
+// tags: [go toml]
 ```
 
-Only master (`latest`) and tagged versions are published to dockerhub. You
-can build your own image as usual:
+[unmarshal]: https://pkg.go.dev/github.com/pelletier/go-toml/v2#Unmarshal
 
-```
-docker build -t go-toml .
+### Marshaling
+
+[`Marshal`][marshal] is the opposite of Unmarshal: it represents a Go structure
+as a TOML document:
+
+```go
+cfg := MyConfig{
+      Version: 2,
+      Name:    "go-toml",
+      Tags:    []string{"go", "toml"},
+}
+
+b, err := toml.Marshal(cfg)
+if err != nil {
+      panic(err)
+}
+fmt.Println(string(b))
+
+// Output:
+// Version = 2
+// Name = 'go-toml'
+// Tags = ['go', 'toml']
 ```
 
-## Contribute
+[marshal]: https://pkg.go.dev/github.com/pelletier/go-toml/v2#Marshal
 
-Feel free to report bugs and patches using GitHub's pull requests system on
-[pelletier/go-toml](https://github.com/pelletier/go-toml). Any feedback would be
-much appreciated!
+## Migrating from v1
 
-### Run tests
+This section describes the differences between v1 and v2, with some pointers on
+how to get the original behavior when possible.
 
-`go test ./...`
+### Decoding / Unmarshal
 
-### Fuzzing
+#### Automatic field name guessing
 
-The script `./fuzz.sh` is available to
-run [go-fuzz](https://github.com/dvyukov/go-fuzz) on go-toml.
+When unmarshaling to a struct, if a key in the TOML document does not exactly
+match the name of a struct field or any of the `toml`-tagged field, v1 tries
+multiple variations of the key ([code][v1-keys]).
 
-## Versioning
+V2 instead does a case-insensitive matching, like `encoding/json`.
 
-Go-toml follows [Semantic Versioning](http://semver.org/). The supported version
-of [TOML](https://github.com/toml-lang/toml) is indicated at the beginning of
-this document. The last two major versions of Go are supported
-(see [Go Release Policy](https://golang.org/doc/devel/release.html#policy)).
+This could impact you if you are relying on casing to differentiate two fields,
+and one of them is a not using the `toml` struct tag. The recommended solution
+is to be specific about tag names for those fields using the `toml` struct tag.
+
+[v1-keys]: https://github.com/pelletier/go-toml/blob/a2e52561804c6cd9392ebf0048ca64fe4af67a43/marshal.go#L775-L781
+
+#### Ignore preexisting value in interface
+
+When decoding into a non-nil `interface{}`, go-toml v1 uses the type of the
+element in the interface to decode the object. For example:
+
+```go
+type inner struct {
+  B interface{}
+}
+type doc struct {
+  A interface{}
+}
+
+d := doc{
+  A: inner{
+    B: "Before",
+  },
+}
+
+data := `
+[A]                                                                                                                           
+B = "After"
+`
+
+toml.Unmarshal([]byte(data), &d)
+fmt.Printf("toml v1: %#v\n", d)
+
+// toml v1: main.doc{A:main.inner{B:"After"}}
+```
+
+In this case, field `A` is of type `interface{}`, containing a `inner` struct.
+V1 sees that type and uses it when decoding the object.
+
+When decoding an object into an `interface{}`, V2 instead disregards whatever
+value the `interface{}` may contain and replaces it with a
+`map[string]interface{}`. With the same data structure as above, here is what
+the result looks like:
+
+```go
+toml.Unmarshal([]byte(data), &d)
+fmt.Printf("toml v2: %#v\n", d)
+
+// toml v2: main.doc{A:map[string]interface {}{"B":"After"}}
+```
+
+This is to match `encoding/json`'s behavior. There is no way to make the v2
+decoder behave like v1.
+
+#### Values out of array bounds ignored
+
+When decoding into an array, v1 returns an error when the number of elements
+contained in the doc is superior to the capacity of the array. For example:
+
+```go
+type doc struct {
+  A [2]string
+}
+d := doc{}
+err := toml.Unmarshal([]byte(`A = ["one", "two", "many"]`), &d)
+fmt.Println(err)
+
+// (1, 1): unmarshal: TOML array length (3) exceeds destination array length (2)
+```
+
+In the same situation, v2 ignores the last value:
+
+```go
+err := toml.Unmarshal([]byte(`A = ["one", "two", "many"]`), &d)
+fmt.Println("err:", err, "d:", d)
+// err: <nil> d: {[one two]}
+```
+
+This is to match `encoding/json`'s behavior. There is no way to make the v2
+decoder behave like v1.
+
+#### Support for `toml.Unmarshaler` has been dropped
+
+This method was not widely used, poorly defined, and added a lot of complexity.
+A similar effect can be achieved by implementing the `encoding.TextUnmarshaler`
+interface and use strings.
+
+### Encoding / Marshal
+
+#### Default struct fields order
+
+V1 emits struct fields order alphabetically by default. V2 struct fields are
+emitted in order they are defined. For example:
+
+```go
+type S struct {
+	B string
+	A string
+}
+
+data := S{
+	B: "B",
+	A: "A",
+}
+
+b, _ := tomlv1.Marshal(data)
+fmt.Println("v1:\n" + string(b))
+
+b, _ = tomlv2.Marshal(data)
+fmt.Println("v2:\n" + string(b))
+
+// Output:
+// v1:
+// A = "A"
+// B = "B"
+
+// v2:
+// B = 'B'
+// A = 'A'
+```
+
+There is no way to make v2 encoder behave like v1. A workaround could be to
+manually sort the fields alphabetically in the struct definition.
+
+#### No indentation by default
+
+V1 automatically indents content of tables by default. V2 does not. However the
+same behavior can be obtained using [`Encoder.SetIndentTables`][sit]. For example:
+
+
+```go
+data := map[string]interface{}{
+	"table": map[string]string{
+		"key": "value",
+	},
+}
+
+b, _ := tomlv1.Marshal(data)
+fmt.Println("v1:\n" + string(b))
+
+b, _ = tomlv2.Marshal(data)
+fmt.Println("v2:\n" + string(b))
+
+buf := bytes.Buffer{}
+enc := tomlv2.NewEncoder(&buf)
+enc.SetIndentTables(true)
+enc.Encode(data)
+fmt.Println("v2 Encoder:\n" + string(buf.Bytes()))
+
+// Output:
+// v1:
+// 
+// [table]
+//   key = "value"
+// 
+// v2:
+// [table]
+// key = 'value'
+// 
+// 
+// v2 Encoder:
+// [table]
+//   key = 'value'
+```
+
+[sit]: https://pkg.go.dev/github.com/pelletier/go-toml/v2#Encoder.SetIndentTables
+
+#### Keys and strings are single quoted
+
+V1 always uses double quotes (`"`) around strings and keys that cannot be
+represented bare (unquoted). V2 uses single quotes instead by default (`'`),
+unless a character cannot be represented, then falls back to double quotes.
+
+There is no way to make v2 encoder behave like v1.
+
+#### `TextMarshaler` emits as a string, not TOML
+
+Types that implement [`encoding.TextMarshaler`][tm] can emit arbitrary TOML in
+v1. The encoder would append the result to the output directly. In v2 the result
+is wrapped in a string. As a result, this interface cannot be implemented by the
+root object.
+
+There is no way to make v2 encoder behave like v1.
+
+[tm]: https://golang.org/pkg/encoding/#TextMarshaler
 
 ## License
 

azure-pipelines.yml

@@ -1,189 +0,0 @@
-trigger:
-- master
-
-stages:
-- stage: run_checks
-  displayName: "Check"
-  dependsOn: []
-  jobs:
-  - job: fmt
-    displayName: "fmt"
-    pool:
-      vmImage: ubuntu-latest
-    steps:
-    - task: GoTool@0
-      displayName: "Install Go 1.15"
-      inputs:
-        version: "1.15"
-    - task: Go@0
-      displayName: "go fmt ./..."
-      inputs:
-        command: 'custom'
-        customCommand: 'fmt'
-        arguments: './...'
-  - job: coverage
-    displayName: "coverage"
-    condition: ne(variables['Build.SourceBranchName'], 'master')
-    pool:
-      vmImage: ubuntu-latest
-    steps:
-    - task: GoTool@0
-      displayName: "Install Go 1.15"
-      inputs:
-        version: "1.15"
-    - task: Go@0
-      displayName: "Generate coverage"
-      inputs:
-        command: 'test'
-        arguments: "-race -coverprofile=coverage.txt -covermode=atomic"
-    - task: Bash@3
-      inputs:
-        targetType: 'inline'
-        script: 'bash <(curl -s https://codecov.io/bash) -t ${CODECOV_TOKEN}'
-      env:
-        CODECOV_TOKEN: $(CODECOV_TOKEN)
-  - job: benchmark
-    displayName: "benchmark"
-    pool:
-      vmImage: ubuntu-latest
-    steps:
-    - task: GoTool@0
-      displayName: "Install Go 1.15"
-      inputs:
-        version: "1.15"
-    - script: echo "##vso[task.setvariable variable=PATH]${PATH}:/home/vsts/go/bin/"
-    - task: Bash@3
-      inputs:
-        filePath: './benchmark.sh'
-        arguments: "master $(Build.Repository.Uri)"
-
-  - job: go_unit_tests
-    displayName: "unit tests"
-    strategy:
-      matrix:
-        linux 1.15:
-          goVersion: '1.15'
-          imageName: 'ubuntu-latest'
-        mac 1.15:
-          goVersion: '1.15'
-          imageName: 'macOS-latest'
-        windows 1.15:
-          goVersion: '1.15'
-          imageName: 'windows-latest'
-        linux 1.14:
-          goVersion: '1.14'
-          imageName: 'ubuntu-latest'
-        mac 1.14:
-          goVersion: '1.14'
-          imageName: 'macOS-latest'
-        windows 1.14:
-          goVersion: '1.14'
-          imageName: 'windows-latest'
-    pool:
-      vmImage: $(imageName)
-    steps:
-    - task: GoTool@0
-      displayName: "Install Go $(goVersion)"
-      inputs:
-        version: $(goVersion)
-    - task: Go@0
-      displayName: "go test ./..."
-      inputs:
-        command: 'test'
-        arguments: './...'
-- stage: build_binaries
-  displayName: "Build binaries"
-  dependsOn: run_checks
-  jobs:
-  - job: build_binary
-    displayName: "Build binary"
-    strategy:
-      matrix:
-        linux_amd64:
-          GOOS: linux
-          GOARCH: amd64
-        darwin_amd64:
-          GOOS: darwin
-          GOARCH: amd64
-        windows_amd64:
-          GOOS: windows
-          GOARCH: amd64
-    pool:
-      vmImage: ubuntu-latest
-    steps:
-    - task: GoTool@0
-      displayName: "Install Go"
-      inputs:
-        version: 1.15
-    - task: Bash@3
-      inputs:
-        targetType: inline
-        script: "make dist"
-      env:
-        go.goos: $(GOOS)
-        go.goarch: $(GOARCH)
-    - task: CopyFiles@2
-      inputs:
-        sourceFolder: '$(Build.SourcesDirectory)'
-        contents: '*.tar.xz'
-        TargetFolder: '$(Build.ArtifactStagingDirectory)'
-    - task: PublishBuildArtifacts@1
-      inputs:
-        pathtoPublish: '$(Build.ArtifactStagingDirectory)'
-        artifactName: binaries
-- stage: build_binaries_manifest
-  displayName: "Build binaries manifest"
-  dependsOn: build_binaries
-  jobs:
-  - job: build_manifest
-    displayName: "Build binaries manifest"
-    steps:
-      - task: DownloadBuildArtifacts@0
-        inputs:
-          buildType: 'current'
-          downloadType: 'single'
-          artifactName: 'binaries'
-          downloadPath: '$(Build.SourcesDirectory)'
-      - task: Bash@3
-        inputs:
-          targetType: inline
-          script: "cd binaries && sha256sum --binary *.tar.xz | tee $(Build.ArtifactStagingDirectory)/sha256sums.txt"
-      - task: PublishBuildArtifacts@1
-        inputs:
-          pathtoPublish: '$(Build.ArtifactStagingDirectory)'
-          artifactName: manifest
-
-- stage: build_docker_image
-  displayName: "Build Docker image"
-  dependsOn: run_checks
-  jobs:
-  - job: build
-    displayName: "Build"
-    pool:
-      vmImage: ubuntu-latest
-    steps:
-    - task: Docker@2
-      inputs:
-        command: 'build'
-        Dockerfile: 'Dockerfile'
-        buildContext: '.'
-        addPipelineData: false
-
-- stage: publish_docker_image
-  displayName: "Publish Docker image"
-  dependsOn: build_docker_image
-  condition: and(succeeded(), eq(variables['Build.SourceBranchName'], 'master'))
-  jobs:
-  - job: publish
-    displayName: "Publish"
-    pool:
-      vmImage: ubuntu-latest
-    steps:
-    - task: Docker@2
-      inputs:
-        containerRegistry: 'DockerHub'
-        repository: 'pelletier/go-toml'
-        command: 'buildAndPush'
-        Dockerfile: 'Dockerfile'
-        buildContext: '.'
-        tags: 'latest'

benchmark.sh

@@ -1,35 +0,0 @@
-#!/bin/bash
-
-set -ex
-
-reference_ref=${1:-master}
-reference_git=${2:-.}
-
-if ! `hash benchstat 2>/dev/null`; then
-    echo "Installing benchstat"
-    go get golang.org/x/perf/cmd/benchstat
-fi
-
-tempdir=`mktemp -d /tmp/go-toml-benchmark-XXXXXX`
-ref_tempdir="${tempdir}/ref"
-ref_benchmark="${ref_tempdir}/benchmark-`echo -n ${reference_ref}|tr -s '/' '-'`.txt"
-local_benchmark="`pwd`/benchmark-local.txt"
-
-echo "=== ${reference_ref} (${ref_tempdir})"
-git clone ${reference_git} ${ref_tempdir} >/dev/null 2>/dev/null
-pushd ${ref_tempdir} >/dev/null
-git checkout ${reference_ref} >/dev/null 2>/dev/null
-go test -bench=. -benchmem | tee ${ref_benchmark}
-cd benchmark
-go test -bench=. -benchmem | tee -a ${ref_benchmark}
-popd >/dev/null
-
-echo ""
-echo "=== local"
-go test -bench=. -benchmem  | tee ${local_benchmark}
-cd benchmark
-go test -bench=. -benchmem | tee -a ${local_benchmark}
-
-echo ""
-echo "=== diff"
-benchstat -delta-test=none ${ref_benchmark} ${local_benchmark}

benchmark/bench_datasets_test.go

@@ -0,0 +1,81 @@
+package benchmark_test
+
+import (
+	"compress/gzip"
+	"encoding/json"
+	"io/ioutil"
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/pelletier/go-toml/v2"
+	"github.com/stretchr/testify/require"
+)
+
+var bench_inputs = []struct {
+	name    string
+	jsonLen int
+}{
+	// from https://gist.githubusercontent.com/feeeper/2197d6d734729625a037af1df14cf2aa/raw/2f22b120e476d897179be3c1e2483d18067aa7df/config.toml
+	{"config", 806507},
+
+	// converted from https://github.com/miloyip/nativejson-benchmark
+	{"canada", 2090234},
+	{"citm_catalog", 479897},
+	{"twitter", 428778},
+	{"code", 1940472},
+
+	// converted from https://raw.githubusercontent.com/mailru/easyjson/master/benchmark/example.json
+	{"example", 7779},
+}
+
+func TestUnmarshalDatasetCode(t *testing.T) {
+	for _, tc := range bench_inputs {
+		buf := fixture(t, tc.name)
+		t.Run(tc.name, func(t *testing.T) {
+			var v interface{}
+			check(t, toml.Unmarshal(buf, &v))
+
+			b, err := json.Marshal(v)
+			check(t, err)
+			require.Equal(t, len(b), tc.jsonLen)
+		})
+	}
+}
+
+func BenchmarkUnmarshalDataset(b *testing.B) {
+	for _, tc := range bench_inputs {
+		buf := fixture(b, tc.name)
+		b.Run(tc.name, func(b *testing.B) {
+			b.SetBytes(int64(len(buf)))
+			b.ReportAllocs()
+			b.ResetTimer()
+			for i := 0; i < b.N; i++ {
+				var v interface{}
+				check(b, toml.Unmarshal(buf, &v))
+			}
+		})
+	}
+}
+
+// fixture returns the uncompressed contents of path.
+func fixture(tb testing.TB, path string) []byte {
+	f, err := os.Open(filepath.Join("testdata", path+".toml.gz"))
+	check(tb, err)
+	defer f.Close()
+
+	gz, err := gzip.NewReader(f)
+	check(tb, err)
+
+	buf, err := ioutil.ReadAll(gz)
+	check(tb, err)
+
+	return buf
+}
+
+func check(tb testing.TB, err error) {
+	if err != nil {
+		tb.Helper()
+		tb.Fatal(err)
+	}
+}

benchmark/benchmark.json

@@ -1,164 +0,0 @@
-{
-    "array": {
-        "key1": [
-            1,
-            2,
-            3
-        ],
-        "key2": [
-            "red",
-            "yellow",
-            "green"
-        ],
-        "key3": [
-            [
-                1,
-                2
-            ],
-            [
-                3,
-                4,
-                5
-            ]
-        ],
-        "key4": [
-            [
-                1,
-                2
-            ],
-            [
-                "a",
-                "b",
-                "c"
-            ]
-        ],
-        "key5": [
-            1,
-            2,
-            3
-        ],
-        "key6": [
-            1,
-            2
-        ]
-    },
-    "boolean": {
-        "False": false,
-        "True": true
-    },
-    "datetime": {
-        "key1": "1979-05-27T07:32:00Z",
-        "key2": "1979-05-27T00:32:00-07:00",
-        "key3": "1979-05-27T00:32:00.999999-07:00"
-    },
-    "float": {
-        "both": {
-            "key": 6.626e-34
-        },
-        "exponent": {
-            "key1": 5e+22,
-            "key2": 1000000,
-            "key3": -0.02
-        },
-        "fractional": {
-            "key1": 1,
-            "key2": 3.1415,
-            "key3": -0.01
-        },
-        "underscores": {
-            "key1": 9224617.445991227,
-            "key2": 1e+100
-        }
-    },
-    "fruit": [{
-            "name": "apple",
-            "physical": {
-                "color": "red",
-                "shape": "round"
-            },
-            "variety": [{
-                    "name": "red delicious"
-                },
-                {
-                    "name": "granny smith"
-                }
-            ]
-        },
-        {
-            "name": "banana",
-            "variety": [{
-                "name": "plantain"
-            }]
-        }
-    ],
-    "integer": {
-        "key1": 99,
-        "key2": 42,
-        "key3": 0,
-        "key4": -17,
-        "underscores": {
-            "key1": 1000,
-            "key2": 5349221,
-            "key3": 12345
-        }
-    },
-    "products": [{
-            "name": "Hammer",
-            "sku": 738594937
-        },
-        {},
-        {
-            "color": "gray",
-            "name": "Nail",
-            "sku": 284758393
-        }
-    ],
-    "string": {
-        "basic": {
-            "basic": "I'm a string. \"You can quote me\". Name\tJosé\nLocation\tSF."
-        },
-        "literal": {
-            "multiline": {
-                "lines": "The first newline is\ntrimmed in raw strings.\n   All other whitespace\n   is preserved.\n",
-                "regex2": "I [dw]on't need \\d{2} apples"
-            },
-            "quoted": "Tom \"Dubs\" Preston-Werner",
-            "regex": "\u003c\\i\\c*\\s*\u003e",
-            "winpath": "C:\\Users\\nodejs\\templates",
-            "winpath2": "\\\\ServerX\\admin$\\system32\\"
-        },
-        "multiline": {
-            "continued": {
-                "key1": "The quick brown fox jumps over the lazy dog.",
-                "key2": "The quick brown fox jumps over the lazy dog.",
-                "key3": "The quick brown fox jumps over the lazy dog."
-            },
-            "key1": "One\nTwo",
-            "key2": "One\nTwo",
-            "key3": "One\nTwo"
-        }
-    },
-    "table": {
-        "inline": {
-            "name": {
-                "first": "Tom",
-                "last": "Preston-Werner"
-            },
-            "point": {
-                "x": 1,
-                "y": 2
-            }
-        },
-        "key": "value",
-        "subtable": {
-            "key": "another value"
-        }
-    },
-    "x": {
-        "y": {
-            "z": {
-                "w": {}
-            }
-        }
-    }
-}

benchmark/benchmark.yml

@@ -1,121 +0,0 @@
----
-array:
-  key1:
-  - 1
-  - 2
-  - 3
-  key2:
-  - red
-  - yellow
-  - green
-  key3:
-  - - 1
-    - 2
-  - - 3
-    - 4
-    - 5
-  key4:
-  - - 1
-    - 2
-  - - a
-    - b
-    - c
-  key5:
-  - 1
-  - 2
-  - 3
-  key6:
-  - 1
-  - 2
-boolean:
-  'False': false
-  'True': true
-datetime:
-  key1: '1979-05-27T07:32:00Z'
-  key2: '1979-05-27T00:32:00-07:00'
-  key3: '1979-05-27T00:32:00.999999-07:00'
-float:
-  both:
-    key: 6.626e-34
-  exponent:
-    key1: 5.0e+22
-    key2: 1000000
-    key3: -0.02
-  fractional:
-    key1: 1
-    key2: 3.1415
-    key3: -0.01
-  underscores:
-    key1: 9224617.445991227
-    key2: 1.0e+100
-fruit:
-- name: apple
-  physical:
-    color: red
-    shape: round
-  variety:
-  - name: red delicious
-  - name: granny smith
-- name: banana
-  variety:
-  - name: plantain
-integer:
-  key1: 99
-  key2: 42
-  key3: 0
-  key4: -17
-  underscores:
-    key1: 1000
-    key2: 5349221
-    key3: 12345
-products:
-- name: Hammer
-  sku: 738594937
-- {}
-- color: gray
-  name: Nail
-  sku: 284758393
-string:
-  basic:
-    basic: "I'm a string. \"You can quote me\". Name\tJosé\nLocation\tSF."
-  literal:
-    multiline:
-      lines: |
-        The first newline is
-        trimmed in raw strings.
-           All other whitespace
-           is preserved.
-      regex2: I [dw]on't need \d{2} apples
-    quoted: Tom "Dubs" Preston-Werner
-    regex: "<\\i\\c*\\s*>"
-    winpath: C:\Users\nodejs\templates
-    winpath2: "\\\\ServerX\\admin$\\system32\\"
-  multiline:
-    continued:
-      key1: The quick brown fox jumps over the lazy dog.
-      key2: The quick brown fox jumps over the lazy dog.
-      key3: The quick brown fox jumps over the lazy dog.
-    key1: |-
-      One
-      Two
-    key2: |-
-      One
-      Two
-    key3: |-
-      One
-      Two
-table:
-  inline:
-    name:
-      first: Tom
-      last: Preston-Werner
-    point:
-      x: 1
-      y: 2
-  key: value
-  subtable:
-    key: another value
-x:
-  y:
-    z:
-      w: {}

benchmark/benchmark_test.go

@@ -1,17 +1,27 @@
-package benchmark
+package benchmark_test
 
 import (
-	"bytes"
-	"encoding/json"
 	"io/ioutil"
 	"testing"
 	"time"
 
-	burntsushi "github.com/BurntSushi/toml"
-	"github.com/pelletier/go-toml"
-	"gopkg.in/yaml.v2"
+	"github.com/pelletier/go-toml/v2"
+	"github.com/stretchr/testify/require"
 )
 
+func BenchmarkUnmarshalSimple(b *testing.B) {
+	d := struct {
+		A string
+	}{}
+	doc := []byte(`A = "hello"`)
+	for i := 0; i < b.N; i++ {
+		err := toml.Unmarshal(doc, &d)
+		if err != nil {
+			panic(err)
+		}
+	}
+}
+
 type benchmarkDoc struct {
 	Table struct {
 		Key      string
@@ -118,77 +128,27 @@ type benchmarkDoc struct {
 	}
 }
 
-func BenchmarkParseToml(b *testing.B) {
-	fileBytes, err := ioutil.ReadFile("benchmark.toml")
-	if err != nil {
-		b.Fatal(err)
-	}
-	b.ResetTimer()
-	for i := 0; i < b.N; i++ {
-		_, err := toml.LoadReader(bytes.NewReader(fileBytes))
-		if err != nil {
-			b.Fatal(err)
-		}
-	}
-}
-
-func BenchmarkUnmarshalToml(b *testing.B) {
+func BenchmarkReferenceFile(b *testing.B) {
 	bytes, err := ioutil.ReadFile("benchmark.toml")
 	if err != nil {
 		b.Fatal(err)
 	}
+	b.SetBytes(int64(len(bytes)))
 	b.ReportAllocs()
 	b.ResetTimer()
 	for i := 0; i < b.N; i++ {
-		target := benchmarkDoc{}
-		err := toml.Unmarshal(bytes, &target)
+		d := benchmarkDoc{}
+		err := toml.Unmarshal(bytes, &d)
 		if err != nil {
-			b.Fatal(err)
+			panic(err)
 		}
 	}
 }
 
-func BenchmarkUnmarshalBurntSushiToml(b *testing.B) {
+func TestReferenceFile(t *testing.T) {
 	bytes, err := ioutil.ReadFile("benchmark.toml")
-	if err != nil {
-		b.Fatal(err)
-	}
-	b.ResetTimer()
-	for i := 0; i < b.N; i++ {
-		target := benchmarkDoc{}
-		err := burntsushi.Unmarshal(bytes, &target)
-		if err != nil {
-			b.Fatal(err)
-		}
-	}
-}
-
-func BenchmarkUnmarshalJson(b *testing.B) {
-	bytes, err := ioutil.ReadFile("benchmark.json")
-	if err != nil {
-		b.Fatal(err)
-	}
-	b.ResetTimer()
-	for i := 0; i < b.N; i++ {
-		target := benchmarkDoc{}
-		err := json.Unmarshal(bytes, &target)
-		if err != nil {
-			b.Fatal(err)
-		}
-	}
-}
-
-func BenchmarkUnmarshalYaml(b *testing.B) {
-	bytes, err := ioutil.ReadFile("benchmark.yml")
-	if err != nil {
-		b.Fatal(err)
-	}
-	b.ResetTimer()
-	for i := 0; i < b.N; i++ {
-		target := benchmarkDoc{}
-		err := yaml.Unmarshal(bytes, &target)
-		if err != nil {
-			b.Fatal(err)
-		}
-	}
+	require.NoError(t, err)
+	d := benchmarkDoc{}
+	err = toml.Unmarshal(bytes, &d)
+	require.NoError(t, err)
 }

benchmark/go.mod

@@ -1,11 +0,0 @@
-module github.com/pelletier/go-toml/benchmark
-
-go 1.12
-
-require (
-	github.com/BurntSushi/toml v0.3.1
-	github.com/pelletier/go-toml v0.0.0
-	gopkg.in/yaml.v2 v2.3.0
-)
-
-replace github.com/pelletier/go-toml => ../

benchmark/go.sum

@@ -1,8 +0,0 @@
-github.com/BurntSushi/toml v0.3.1 h1:WXkYYl6Yr3qBf1K79EBnL4mak0OimBfB0XUf9Vl28OQ=
-github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
-github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
-github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
-gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
-gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/yaml.v2 v2.3.0 h1:clyUAQHOM3G0M3f5vQj7LuJrETvjVot3Z5el9nffUtU=
-gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=

ci.sh

@@ -0,0 +1,162 @@
+#!/usr/bin/env bash
+
+
+stderr() {
+    echo "$@" 1>&2
+}
+
+usage() {
+    b=$(basename "$0")
+    echo $b: ERROR: "$@" 1>&2
+
+    cat 1>&2 <<EOF
+
+DESCRIPTION
+
+    $(basename "$0") is the script to run continuous integration commands for
+    go-toml on unix.
+
+    Requires Go and Git to be available in the PATH. Expects to be ran from the
+    root of go-toml's Git repository.
+
+USAGE
+
+    $b COMMAND [OPTIONS...]
+
+COMMANDS
+
+benchmark [OPTIONS...] [BRANCH]
+
+    Run benchmarks.
+
+    ARGUMENTS
+
+        BRANCH Optional. Defines which Git branch to use when running
+               benchmarks.
+
+    OPTIONS
+
+        -d      Compare benchmarks of HEAD with BRANCH using benchstats. In
+                this form the BRANCH argument is required.
+
+coverage [OPTIONS...] [BRANCH]
+
+    Generates code coverage.
+
+    ARGUMENTS
+
+        BRANCH  Optional. Defines which Git branch to use when reporting
+                coverage. Defaults to HEAD.
+
+    OPTIONS
+
+        -d      Compare coverage of HEAD with the one of BRANCH. In this form,
+                the BRANCH argument is required. Exit code is non-zero when
+                coverage percentage decreased.
+EOF
+    exit 1
+}
+
+cover() {
+    branch="${1}"
+    dir="$(mktemp -d)"
+
+    stderr "Executing coverage for ${branch} at ${dir}"
+
+    if [ "${branch}" = "HEAD" ]; then
+	    cp -r . "${dir}/"
+    else
+	    git worktree add "$dir" "$branch"
+    fi
+
+    pushd "$dir"
+    go test -covermode=atomic -coverprofile=coverage.out ./...
+    go tool cover -func=coverage.out
+    popd
+
+    if [ "${branch}" != "HEAD" ]; then
+	    git worktree remove --force "$dir"
+    fi
+}
+
+coverage() {
+    case "$1" in
+	-d)
+	    shift
+	    target="${1?Need to provide a target branch argument}"
+
+	    output_dir="$(mktemp -d)"
+	    target_out="${output_dir}/target.txt"
+	    head_out="${output_dir}/head.txt"
+	    
+	    cover "${target}" > "${target_out}"
+	    cover "HEAD" > "${head_out}"
+
+	    cat "${target_out}"
+	    cat "${head_out}"
+
+	    echo ""
+
+	    target_pct="$(cat ${target_out} |sed -E 's/.*total.*\t([0-9.]+)%/\1/;t;d')"
+	    head_pct="$(cat ${head_out} |sed -E 's/.*total.*\t([0-9.]+)%/\1/;t;d')"
+	    echo "Results: ${target} ${target_pct}% HEAD ${head_pct}%"
+
+	    delta_pct=$(echo "$head_pct - $target_pct" | bc -l)
+	    echo "Delta: ${delta_pct}"
+
+	    if [[ $delta_pct = \-* ]]; then
+		echo "Regression!";
+		return 1
+	    fi
+	    return 0
+	    ;;
+    esac
+
+    cover "${1-HEAD}"
+}
+
+bench() {
+    branch="${1}"
+    out="${2}"
+    dir="$(mktemp -d)"
+
+    stderr "Executing benchmark for ${branch} at ${dir}"
+
+    if [ "${branch}" = "HEAD" ]; then
+    	cp -r . "${dir}/"
+    else
+	    git worktree add "$dir" "$branch"
+    fi
+
+    pushd "$dir"
+    go test -bench=. -count=10 ./... | tee "${out}"
+    popd
+
+    if [ "${branch}" != "HEAD" ]; then
+	    git worktree remove --force "$dir"
+    fi
+}
+
+benchmark() {
+    case "$1" in
+    -d)
+        shift
+     	target="${1?Need to provide a target branch argument}"
+        old=`mktemp`
+        bench "${target}" "${old}"
+
+        new=`mktemp`
+        bench HEAD "${new}"
+        benchstat "${old}" "${new}"
+        return 0
+        ;;
+    esac
+
+    bench "${1-HEAD}" `mktemp`
+}
+
+case "$1" in
+    coverage) shift; coverage $@;;
+    benchmark) shift; benchmark $@;;
+    *) usage "bad argument $1";;
+esac

cmd/jsontoml/main.go

@@ -1,82 +0,0 @@
-// Jsontoml reads JSON and converts to TOML.
-//
-// Usage:
-//   cat file.toml | jsontoml > file.json
-//   jsontoml file1.toml > file.json
-package main
-
-import (
-	"encoding/json"
-	"flag"
-	"fmt"
-	"io"
-	"io/ioutil"
-	"os"
-
-	"github.com/pelletier/go-toml"
-)
-
-func main() {
-	flag.Usage = func() {
-		fmt.Fprintln(os.Stderr, "jsontoml can be used in two ways:")
-		fmt.Fprintln(os.Stderr, "Writing to STDIN and reading from STDOUT:")
-		fmt.Fprintln(os.Stderr, "")
-		fmt.Fprintln(os.Stderr, "")
-		fmt.Fprintln(os.Stderr, "Reading from a file name:")
-		fmt.Fprintln(os.Stderr, " tomljson file.toml")
-	}
-	flag.Parse()
-	os.Exit(processMain(flag.Args(), os.Stdin, os.Stdout, os.Stderr))
-}
-
-func processMain(files []string, defaultInput io.Reader, output io.Writer, errorOutput io.Writer) int {
-	// read from stdin and print to stdout
-	inputReader := defaultInput
-
-	if len(files) > 0 {
-		file, err := os.Open(files[0])
-		if err != nil {
-			printError(err, errorOutput)
-			return -1
-		}
-		inputReader = file
-		defer file.Close()
-	}
-	s, err := reader(inputReader)
-	if err != nil {
-		printError(err, errorOutput)
-		return -1
-	}
-	io.WriteString(output, s)
-	return 0
-}
-
-func printError(err error, output io.Writer) {
-	io.WriteString(output, err.Error()+"\n")
-}
-
-func reader(r io.Reader) (string, error) {
-	jsonMap := make(map[string]interface{})
-	jsonBytes, err := ioutil.ReadAll(r)
-	if err != nil {
-		return "", err
-	}
-	err = json.Unmarshal(jsonBytes, &jsonMap)
-	if err != nil {
-		return "", err
-	}
-
-	tree, err := toml.TreeFromMap(jsonMap)
-	if err != nil {
-		return "", err
-	}
-	return mapToTOML(tree)
-}
-
-func mapToTOML(t *toml.Tree) (string, error) {
-	tomlBytes, err := t.ToTomlString()
-	if err != nil {
-		return "", err
-	}
-	return string(tomlBytes[:]), nil
-}

cmd/jsontoml/main_test.go

@@ -1,92 +0,0 @@
-package main
-
-import (
-	"bytes"
-	"io/ioutil"
-	"os"
-	"runtime"
-	"strings"
-	"testing"
-)
-
-func expectBufferEquality(t *testing.T, name string, buffer *bytes.Buffer, expected string) {
-	output := buffer.String()
-	if output != expected {
-		t.Errorf("incorrect %s: \n%sexpected %s: \n%s", name, output, name, expected)
-		t.Log([]rune(output))
-		t.Log([]rune(expected))
-	}
-}
-
-func expectProcessMainResults(t *testing.T, input string, args []string, exitCode int, expectedOutput string, expectedError string) {
-	inputReader := strings.NewReader(input)
-
-	outputBuffer := new(bytes.Buffer)
-	errorBuffer := new(bytes.Buffer)
-
-	returnCode := processMain(args, inputReader, outputBuffer, errorBuffer)
-
-	expectBufferEquality(t, "output", outputBuffer, expectedOutput)
-	expectBufferEquality(t, "error", errorBuffer, expectedError)
-
-	if returnCode != exitCode {
-		t.Error("incorrect return code:", returnCode, "expected", exitCode)
-	}
-}
-
-func TestProcessMainReadFromStdin(t *testing.T) {
-	expectedOutput := `
-[mytoml]
-  a = 42.0
-`
-	input := `{
-  "mytoml": {
-    "a": 42
-  }
-}
-`
-	expectedError := ``
-	expectedExitCode := 0
-
-	expectProcessMainResults(t, input, []string{}, expectedExitCode, expectedOutput, expectedError)
-}
-
-func TestProcessMainReadFromFile(t *testing.T) {
-	input := `{
-  "mytoml": {
-    "a": 42
-  }
-}
-`
-	tmpfile, err := ioutil.TempFile("", "example.json")
-	if err != nil {
-		t.Fatal(err)
-	}
-	if _, err := tmpfile.Write([]byte(input)); err != nil {
-		t.Fatal(err)
-	}
-
-	defer os.Remove(tmpfile.Name())
-
-	expectedOutput := `
-[mytoml]
-  a = 42.0
-`
-	expectedError := ``
-	expectedExitCode := 0
-
-	expectProcessMainResults(t, ``, []string{tmpfile.Name()}, expectedExitCode, expectedOutput, expectedError)
-}
-
-func TestProcessMainReadFromMissingFile(t *testing.T) {
-	var expectedError string
-	if runtime.GOOS == "windows" {
-		expectedError = `open /this/file/does/not/exist: The system cannot find the path specified.
-`
-	} else {
-		expectedError = `open /this/file/does/not/exist: no such file or directory
-`
-	}
-
-	expectProcessMainResults(t, ``, []string{"/this/file/does/not/exist"}, -1, ``, expectedError)
-}

cmd/tomljson/main.go

@@ -1,71 +0,0 @@
-// Tomljson reads TOML and converts to JSON.
-//
-// Usage:
-//   cat file.toml | tomljson > file.json
-//   tomljson file1.toml > file.json
-package main
-
-import (
-	"encoding/json"
-	"flag"
-	"fmt"
-	"io"
-	"os"
-
-	"github.com/pelletier/go-toml"
-)
-
-func main() {
-	flag.Usage = func() {
-		fmt.Fprintln(os.Stderr, "tomljson can be used in two ways:")
-		fmt.Fprintln(os.Stderr, "Writing to STDIN and reading from STDOUT:")
-		fmt.Fprintln(os.Stderr, "  cat file.toml | tomljson > file.json")
-		fmt.Fprintln(os.Stderr, "")
-		fmt.Fprintln(os.Stderr, "Reading from a file name:")
-		fmt.Fprintln(os.Stderr, "  tomljson file.toml")
-	}
-	flag.Parse()
-	os.Exit(processMain(flag.Args(), os.Stdin, os.Stdout, os.Stderr))
-}
-
-func processMain(files []string, defaultInput io.Reader, output io.Writer, errorOutput io.Writer) int {
-	// read from stdin and print to stdout
-	inputReader := defaultInput
-
-	if len(files) > 0 {
-		var err error
-		inputReader, err = os.Open(files[0])
-		if err != nil {
-			printError(err, errorOutput)
-			return -1
-		}
-	}
-	s, err := reader(inputReader)
-	if err != nil {
-		printError(err, errorOutput)
-		return -1
-	}
-	io.WriteString(output, s+"\n")
-	return 0
-}
-
-func printError(err error, output io.Writer) {
-	io.WriteString(output, err.Error()+"\n")
-}
-
-func reader(r io.Reader) (string, error) {
-	tree, err := toml.LoadReader(r)
-	if err != nil {
-		return "", err
-	}
-	return mapToJSON(tree)
-}
-
-func mapToJSON(tree *toml.Tree) (string, error) {
-	treeMap := tree.ToMap()
-	bytes, err := json.MarshalIndent(treeMap, "", "  ")
-	if err != nil {
-		return "", err
-	}
-	return string(bytes[:]), nil
-}

cmd/tomljson/main_test.go

@@ -1,90 +0,0 @@
-package main
-
-import (
-	"bytes"
-	"io/ioutil"
-	"os"
-	"runtime"
-	"strings"
-	"testing"
-)
-
-func expectBufferEquality(t *testing.T, name string, buffer *bytes.Buffer, expected string) {
-	output := buffer.String()
-	if output != expected {
-		t.Errorf("incorrect %s:\n%s\n\nexpected %s:\n%s", name, output, name, expected)
-		t.Log([]rune(output))
-		t.Log([]rune(expected))
-	}
-}
-
-func expectProcessMainResults(t *testing.T, input string, args []string, exitCode int, expectedOutput string, expectedError string) {
-	inputReader := strings.NewReader(input)
-	outputBuffer := new(bytes.Buffer)
-	errorBuffer := new(bytes.Buffer)
-
-	returnCode := processMain(args, inputReader, outputBuffer, errorBuffer)
-
-	expectBufferEquality(t, "output", outputBuffer, expectedOutput)
-	expectBufferEquality(t, "error", errorBuffer, expectedError)
-
-	if returnCode != exitCode {
-		t.Error("incorrect return code:", returnCode, "expected", exitCode)
-	}
-}
-
-func TestProcessMainReadFromStdin(t *testing.T) {
-	input := `
-		[mytoml]
-		a = 42`
-	expectedOutput := `{
-  "mytoml": {
-    "a": 42
-  }
-}
-`
-	expectedError := ``
-	expectedExitCode := 0
-
-	expectProcessMainResults(t, input, []string{}, expectedExitCode, expectedOutput, expectedError)
-}
-
-func TestProcessMainReadFromFile(t *testing.T) {
-	input := `
-		[mytoml]
-		a = 42`
-
-	tmpfile, err := ioutil.TempFile("", "example.toml")
-	if err != nil {
-		t.Fatal(err)
-	}
-	if _, err := tmpfile.Write([]byte(input)); err != nil {
-		t.Fatal(err)
-	}
-
-	defer os.Remove(tmpfile.Name())
-
-	expectedOutput := `{
-  "mytoml": {
-    "a": 42
-  }
-}
-`
-	expectedError := ``
-	expectedExitCode := 0
-
-	expectProcessMainResults(t, ``, []string{tmpfile.Name()}, expectedExitCode, expectedOutput, expectedError)
-}
-
-func TestProcessMainReadFromMissingFile(t *testing.T) {
-	var expectedError string
-	if runtime.GOOS == "windows" {
-		expectedError = `open /this/file/does/not/exist: The system cannot find the path specified.
-`
-	} else {
-		expectedError = `open /this/file/does/not/exist: no such file or directory
-`
-	}
-
-	expectProcessMainResults(t, ``, []string{"/this/file/does/not/exist"}, -1, ``, expectedError)
-}

cmd/tomll/main.go

@@ -1,65 +0,0 @@
-// Tomll is a linter for TOML
-//
-// Usage:
-//   cat file.toml | tomll > file_linted.toml
-//   tomll file1.toml file2.toml # lint the two files in place
-package main
-
-import (
-	"flag"
-	"fmt"
-	"io"
-	"io/ioutil"
-	"os"
-
-	"github.com/pelletier/go-toml"
-)
-
-func main() {
-	flag.Usage = func() {
-		fmt.Fprintln(os.Stderr, "tomll can be used in two ways:")
-		fmt.Fprintln(os.Stderr, "Writing to STDIN and reading from STDOUT:")
-		fmt.Fprintln(os.Stderr, "  cat file.toml | tomll > file.toml")
-		fmt.Fprintln(os.Stderr, "")
-		fmt.Fprintln(os.Stderr, "Reading and updating a list of files:")
-		fmt.Fprintln(os.Stderr, "  tomll a.toml b.toml c.toml")
-		fmt.Fprintln(os.Stderr, "")
-		fmt.Fprintln(os.Stderr, "When given a list of files, tomll will modify all files in place without asking.")
-	}
-	flag.Parse()
-	// read from stdin and print to stdout
-	if flag.NArg() == 0 {
-		s, err := lintReader(os.Stdin)
-		if err != nil {
-			io.WriteString(os.Stderr, err.Error())
-			os.Exit(-1)
-		}
-		io.WriteString(os.Stdout, s)
-	} else {
-		// otherwise modify a list of files
-		for _, filename := range flag.Args() {
-			s, err := lintFile(filename)
-			if err != nil {
-				io.WriteString(os.Stderr, err.Error())
-				os.Exit(-1)
-			}
-			ioutil.WriteFile(filename, []byte(s), 0644)
-		}
-	}
-}
-
-func lintFile(filename string) (string, error) {
-	tree, err := toml.LoadFile(filename)
-	if err != nil {
-		return "", err
-	}
-	return tree.String(), nil
-}
-
-func lintReader(r io.Reader) (string, error) {
-	tree, err := toml.LoadReader(r)
-	if err != nil {
-		return "", err
-	}
-	return tree.String(), nil
-}

cmd/tomltestgen/main.go

@@ -1,219 +0,0 @@
-// Tomltestgen is a program that retrieves a given version of
-// https://github.com/BurntSushi/toml-test and generates go code for go-toml's unit tests
-// based on the test files.
-//
-// Usage: go run github.com/pelletier/go-toml/cmd/tomltestgen > toml_testgen_test.go
-package main
-
-import (
-	"archive/zip"
-	"bytes"
-	"flag"
-	"fmt"
-	"go/format"
-	"io"
-	"io/ioutil"
-	"log"
-	"net/http"
-	"os"
-	"regexp"
-	"strconv"
-	"strings"
-	"text/template"
-	"time"
-)
-
-type invalid struct {
-	Name  string
-	Input string
-}
-
-type valid struct {
-	Name    string
-	Input   string
-	JsonRef string
-}
-
-type testsCollection struct {
-	Ref       string
-	Timestamp string
-	Invalid   []invalid
-	Valid     []valid
-	Count     int
-}
-
-const srcTemplate = "// Generated by tomltestgen for toml-test ref {{.Ref}} on {{.Timestamp}}\n" +
-	"package toml\n" +
-	" import (\n" +
-	"	\"testing\"\n" +
-	")\n" +
-
-	"{{range .Invalid}}\n" +
-	"func TestInvalid{{.Name}}(t *testing.T) {\n" +
-	"	input := {{.Input|gostr}}\n" +
-	"	testgenInvalid(t, input)\n" +
-	"}\n" +
-	"{{end}}\n" +
-	"\n" +
-	"{{range .Valid}}\n" +
-	"func TestValid{{.Name}}(t *testing.T) {\n" +
-	"   input := {{.Input|gostr}}\n" +
-	"   jsonRef := {{.JsonRef|gostr}}\n" +
-	"   testgenValid(t, input, jsonRef)\n" +
-	"}\n" +
-	"{{end}}\n"
-
-func downloadTmpFile(url string) string {
-	log.Println("starting to download file from", url)
-	resp, err := http.Get(url)
-	if err != nil {
-		panic(err)
-	}
-	defer resp.Body.Close()
-
-	tmpfile, err := ioutil.TempFile("", "toml-test-*.zip")
-	if err != nil {
-		panic(err)
-	}
-	defer tmpfile.Close()
-
-	copiedLen, err := io.Copy(tmpfile, resp.Body)
-	if err != nil {
-		panic(err)
-	}
-	if resp.ContentLength > 0 && copiedLen != resp.ContentLength {
-		panic(fmt.Errorf("copied %d bytes, request body had %d", copiedLen, resp.ContentLength))
-	}
-	return tmpfile.Name()
-}
-
-func kebabToCamel(kebab string) string {
-	camel := ""
-	nextUpper := true
-	for _, c := range kebab {
-		if nextUpper {
-			camel += strings.ToUpper(string(c))
-			nextUpper = false
-		} else if c == '-' {
-			nextUpper = true
-		} else {
-			camel += string(c)
-		}
-	}
-	return camel
-}
-
-func readFileFromZip(f *zip.File) string {
-	reader, err := f.Open()
-	if err != nil {
-		panic(err)
-	}
-	defer reader.Close()
-	bytes, err := ioutil.ReadAll(reader)
-	if err != nil {
-		panic(err)
-	}
-	return string(bytes)
-}
-
-func templateGoStr(input string) string {
-	if len(input) > 0 && input[len(input)-1] == '\n' {
-		input = input[0 : len(input)-1]
-	}
-	if strings.Contains(input, "`") {
-		lines := strings.Split(input, "\n")
-		for idx, line := range lines {
-			lines[idx] = strconv.Quote(line + "\n")
-		}
-		return strings.Join(lines, " + \n")
-	}
-	return "`" + input + "`"
-}
-
-var (
-	ref = flag.String("r", "master", "git reference")
-)
-
-func usage() {
-	_, _ = fmt.Fprintf(os.Stderr, "usage: tomltestgen [flags]\n")
-	flag.PrintDefaults()
-}
-
-func main() {
-	flag.Usage = usage
-	flag.Parse()
-
-	url := "https://codeload.github.com/BurntSushi/toml-test/zip/" + *ref
-	resultFile := downloadTmpFile(url)
-	defer os.Remove(resultFile)
-	log.Println("file written to", resultFile)
-
-	zipReader, err := zip.OpenReader(resultFile)
-	if err != nil {
-		panic(err)
-	}
-	defer zipReader.Close()
-
-	collection := testsCollection{
-		Ref:       *ref,
-		Timestamp: time.Now().Format(time.RFC3339),
-	}
-
-	zipFilesMap := map[string]*zip.File{}
-
-	for _, f := range zipReader.File {
-		zipFilesMap[f.Name] = f
-	}
-
-	testFileRegexp := regexp.MustCompile(`([^/]+/tests/(valid|invalid)/(.+))\.(toml)`)
-	for _, f := range zipReader.File {
-		groups := testFileRegexp.FindStringSubmatch(f.Name)
-		if len(groups) > 0 {
-			name := kebabToCamel(groups[3])
-			testType := groups[2]
-
-			log.Printf("> [%s] %s\n", testType, name)
-
-			tomlContent := readFileFromZip(f)
-
-			switch testType {
-			case "invalid":
-				collection.Invalid = append(collection.Invalid, invalid{
-					Name:  name,
-					Input: tomlContent,
-				})
-				collection.Count++
-			case "valid":
-				baseFilePath := groups[1]
-				jsonFilePath := baseFilePath + ".json"
-				jsonContent := readFileFromZip(zipFilesMap[jsonFilePath])
-
-				collection.Valid = append(collection.Valid, valid{
-					Name:    name,
-					Input:   tomlContent,
-					JsonRef: jsonContent,
-				})
-				collection.Count++
-			default:
-				panic(fmt.Sprintf("unknown test type: %s", testType))
-			}
-		}
-	}
-
-	log.Printf("Collected %d tests from toml-test\n", collection.Count)
-
-	funcMap := template.FuncMap{
-		"gostr": templateGoStr,
-	}
-	t := template.Must(template.New("src").Funcs(funcMap).Parse(srcTemplate))
-	buf := new(bytes.Buffer)
-	err = t.Execute(buf, collection)
-	if err != nil {
-		panic(err)
-	}
-	outputBytes, err := format.Source(buf.Bytes())
-	if err != nil {
-		panic(err)
-	}
-	fmt.Println(string(outputBytes))
-}

decode.go

@@ -0,0 +1,314 @@
+package toml
+
+import (
+	"fmt"
+	"math"
+	"strconv"
+	"time"
+)
+
+func parseInteger(b []byte) (int64, error) {
+	if len(b) > 2 && b[0] == '0' {
+		switch b[1] {
+		case 'x':
+			return parseIntHex(b)
+		case 'b':
+			return parseIntBin(b)
+		case 'o':
+			return parseIntOct(b)
+		default:
+			panic(fmt.Errorf("invalid base '%c', should have been checked by scanIntOrFloat", b[1]))
+		}
+	}
+
+	return parseIntDec(b)
+}
+
+func parseLocalDate(b []byte) (LocalDate, error) {
+	// full-date      = date-fullyear "-" date-month "-" date-mday
+	// date-fullyear  = 4DIGIT
+	// date-month     = 2DIGIT  ; 01-12
+	// date-mday      = 2DIGIT  ; 01-28, 01-29, 01-30, 01-31 based on month/year
+	var date LocalDate
+
+	if len(b) != 10 || b[4] != '-' || b[7] != '-' {
+		return date, newDecodeError(b, "dates are expected to have the format YYYY-MM-DD")
+	}
+
+	date.Year = parseDecimalDigits(b[0:4])
+
+	v := parseDecimalDigits(b[5:7])
+
+	date.Month = time.Month(v)
+
+	date.Day = parseDecimalDigits(b[8:10])
+
+	return date, nil
+}
+
+func parseDecimalDigits(b []byte) int {
+	v := 0
+
+	for _, c := range b {
+		v *= 10
+		v += int(c - '0')
+	}
+
+	return v
+}
+
+func parseDateTime(b []byte) (time.Time, error) {
+	// offset-date-time = full-date time-delim full-time
+	// full-time      = partial-time time-offset
+	// time-offset    = "Z" / time-numoffset
+	// time-numoffset = ( "+" / "-" ) time-hour ":" time-minute
+
+	dt, b, err := parseLocalDateTime(b)
+	if err != nil {
+		return time.Time{}, err
+	}
+
+	var zone *time.Location
+
+	if len(b) == 0 {
+		// parser should have checked that when assigning the date time node
+		panic("date time should have a timezone")
+	}
+
+	if b[0] == 'Z' {
+		b = b[1:]
+		zone = time.UTC
+	} else {
+		const dateTimeByteLen = 6
+		if len(b) != dateTimeByteLen {
+			return time.Time{}, newDecodeError(b, "invalid date-time timezone")
+		}
+		direction := 1
+		if b[0] == '-' {
+			direction = -1
+		}
+
+		hours := digitsToInt(b[1:3])
+		minutes := digitsToInt(b[4:6])
+		seconds := direction * (hours*3600 + minutes*60)
+		zone = time.FixedZone("", seconds)
+		b = b[dateTimeByteLen:]
+	}
+
+	if len(b) > 0 {
+		return time.Time{}, newDecodeError(b, "extra bytes at the end of the timezone")
+	}
+
+	t := time.Date(
+		dt.Date.Year,
+		dt.Date.Month,
+		dt.Date.Day,
+		dt.Time.Hour,
+		dt.Time.Minute,
+		dt.Time.Second,
+		dt.Time.Nanosecond,
+		zone)
+
+	return t, nil
+}
+
+func parseLocalDateTime(b []byte) (LocalDateTime, []byte, error) {
+	var dt LocalDateTime
+
+	const localDateTimeByteMinLen = 11
+	if len(b) < localDateTimeByteMinLen {
+		return dt, nil, newDecodeError(b, "local datetimes are expected to have the format YYYY-MM-DDTHH:MM:SS[.NNNNNNNNN]")
+	}
+
+	date, err := parseLocalDate(b[:10])
+	if err != nil {
+		return dt, nil, err
+	}
+	dt.Date = date
+
+	sep := b[10]
+	if sep != 'T' && sep != ' ' {
+		return dt, nil, newDecodeError(b[10:11], "datetime separator is expected to be T or a space")
+	}
+
+	t, rest, err := parseLocalTime(b[11:])
+	if err != nil {
+		return dt, nil, err
+	}
+	dt.Time = t
+
+	return dt, rest, nil
+}
+
+// parseLocalTime is a bit different because it also returns the remaining
+// []byte that is didn't need. This is to allow parseDateTime to parse those
+// remaining bytes as a timezone.
+func parseLocalTime(b []byte) (LocalTime, []byte, error) {
+	var (
+		nspow = [10]int{0, 1e8, 1e7, 1e6, 1e5, 1e4, 1e3, 1e2, 1e1, 1e0}
+		t     LocalTime
+	)
+
+	const localTimeByteLen = 8
+	if len(b) < localTimeByteLen {
+		return t, nil, newDecodeError(b, "times are expected to have the format HH:MM:SS[.NNNNNN]")
+	}
+
+	t.Hour = parseDecimalDigits(b[0:2])
+	if b[2] != ':' {
+		return t, nil, newDecodeError(b[2:3], "expecting colon between hours and minutes")
+	}
+
+	t.Minute = parseDecimalDigits(b[3:5])
+	if b[5] != ':' {
+		return t, nil, newDecodeError(b[5:6], "expecting colon between minutes and seconds")
+	}
+
+	t.Second = parseDecimalDigits(b[6:8])
+
+	const minLengthWithFrac = 9
+	if len(b) >= minLengthWithFrac && b[minLengthWithFrac-1] == '.' {
+		frac := 0
+		digits := 0
+
+		for i, c := range b[minLengthWithFrac:] {
+			const maxFracPrecision = 9
+			if i >= maxFracPrecision {
+				return t, nil, newDecodeError(b[i:i+1], "maximum precision for date time is nanosecond")
+			}
+
+			frac *= 10
+			frac += int(c - '0')
+			digits++
+		}
+
+		t.Nanosecond = frac * nspow[digits]
+
+		return t, b[9+digits:], nil
+	}
+
+	return t, b[8:], nil
+}
+
+//nolint:cyclop
+func parseFloat(b []byte) (float64, error) {
+	if len(b) == 4 && (b[0] == '+' || b[0] == '-') && b[1] == 'n' && b[2] == 'a' && b[3] == 'n' {
+		return math.NaN(), nil
+	}
+
+	cleaned, err := checkAndRemoveUnderscores(b)
+	if err != nil {
+		return 0, err
+	}
+
+	if cleaned[0] == '.' {
+		return 0, newDecodeError(b, "float cannot start with a dot")
+	}
+
+	if cleaned[len(cleaned)-1] == '.' {
+		return 0, newDecodeError(b, "float cannot end with a dot")
+	}
+
+	f, err := strconv.ParseFloat(string(cleaned), 64)
+	if err != nil {
+		return 0, newDecodeError(b, "unable to parse float: %w", err)
+	}
+
+	return f, nil
+}
+
+func parseIntHex(b []byte) (int64, error) {
+	cleaned, err := checkAndRemoveUnderscores(b[2:])
+	if err != nil {
+		return 0, err
+	}
+
+	i, err := strconv.ParseInt(string(cleaned), 16, 64)
+	if err != nil {
+		return 0, newDecodeError(b, "couldn't parse hexadecimal number: %w", err)
+	}
+
+	return i, nil
+}
+
+func parseIntOct(b []byte) (int64, error) {
+	cleaned, err := checkAndRemoveUnderscores(b[2:])
+	if err != nil {
+		return 0, err
+	}
+
+	i, err := strconv.ParseInt(string(cleaned), 8, 64)
+	if err != nil {
+		return 0, newDecodeError(b, "couldn't parse octal number: %w", err)
+	}
+
+	return i, nil
+}
+
+func parseIntBin(b []byte) (int64, error) {
+	cleaned, err := checkAndRemoveUnderscores(b[2:])
+	if err != nil {
+		return 0, err
+	}
+
+	i, err := strconv.ParseInt(string(cleaned), 2, 64)
+	if err != nil {
+		return 0, newDecodeError(b, "couldn't parse binary number: %w", err)
+	}
+
+	return i, nil
+}
+
+func parseIntDec(b []byte) (int64, error) {
+	cleaned, err := checkAndRemoveUnderscores(b)
+	if err != nil {
+		return 0, err
+	}
+
+	i, err := strconv.ParseInt(string(cleaned), 10, 64)
+	if err != nil {
+		return 0, newDecodeError(b, "couldn't parse decimal number: %w", err)
+	}
+
+	return i, nil
+}
+
+func checkAndRemoveUnderscores(b []byte) ([]byte, error) {
+	if b[0] == '_' {
+		return nil, newDecodeError(b[0:1], "number cannot start with underscore")
+	}
+
+	if b[len(b)-1] == '_' {
+		return nil, newDecodeError(b[len(b)-1:], "number cannot end with underscore")
+	}
+
+	// fast path
+	i := 0
+	for ; i < len(b); i++ {
+		if b[i] == '_' {
+			break
+		}
+	}
+	if i == len(b) {
+		return b, nil
+	}
+
+	before := false
+	cleaned := make([]byte, i, len(b))
+	copy(cleaned, b)
+
+	for i++; i < len(b); i++ {
+		c := b[i]
+		if c == '_' {
+			if !before {
+				return nil, newDecodeError(b[i-1:i+1], "number must have at least one digit between underscores")
+			}
+			before = false
+		} else {
+			before = true
+			cleaned = append(cleaned, c)
+		}
+	}
+
+	return cleaned, nil
+}

doc.go

@@ -1,23 +1,2 @@
-// Package toml is a TOML parser and manipulation library.
-//
-// This version supports the specification as described in
-// https://github.com/toml-lang/toml/blob/master/versions/en/toml-v0.5.0.md
-//
-// Marshaling
-//
-// Go-toml can marshal and unmarshal TOML documents from and to data
-// structures.
-//
-// TOML document as a tree
-//
-// Go-toml can operate on a TOML document as a tree. Use one of the Load*
-// functions to parse TOML data and obtain a Tree instance, then one of its
-// methods to manipulate the tree.
-//
-// JSONPath-like queries
-//
-// The package github.com/pelletier/go-toml/query implements a system
-// similar to JSONPath to quickly retrieve elements of a TOML document using a
-// single expression. See the package documentation for more information.
-//
+// Package toml is a library to read and write TOML documents.
 package toml

doc_test.go

@@ -1,170 +0,0 @@
-// code examples for godoc
-
-package toml_test
-
-import (
-	"fmt"
-	"log"
-	"os"
-
-	toml "github.com/pelletier/go-toml"
-)
-
-func Example_tree() {
-	config, err := toml.LoadFile("config.toml")
-
-	if err != nil {
-		fmt.Println("Error ", err.Error())
-	} else {
-		// retrieve data directly
-		directUser := config.Get("postgres.user").(string)
-		directPassword := config.Get("postgres.password").(string)
-		fmt.Println("User is", directUser, " and password is", directPassword)
-
-		// or using an intermediate object
-		configTree := config.Get("postgres").(*toml.Tree)
-		user := configTree.Get("user").(string)
-		password := configTree.Get("password").(string)
-		fmt.Println("User is", user, " and password is", password)
-
-		// show where elements are in the file
-		fmt.Printf("User position: %v\n", configTree.GetPosition("user"))
-		fmt.Printf("Password position: %v\n", configTree.GetPosition("password"))
-	}
-}
-
-func Example_unmarshal() {
-	type Employer struct {
-		Name  string
-		Phone string
-	}
-	type Person struct {
-		Name     string
-		Age      int64
-		Employer Employer
-	}
-
-	document := []byte(`
-	name = "John"
-	age = 30
-	[employer]
-		name = "Company Inc."
-		phone = "+1 234 567 89012"
-	`)
-
-	person := Person{}
-	toml.Unmarshal(document, &person)
-	fmt.Println(person.Name, "is", person.Age, "and works at", person.Employer.Name)
-	// Output:
-	// John is 30 and works at Company Inc.
-}
-
-func ExampleMarshal() {
-	type Postgres struct {
-		User     string `toml:"user"`
-		Password string `toml:"password"`
-		Database string `toml:"db" commented:"true" comment:"not used anymore"`
-	}
-	type Config struct {
-		Postgres Postgres `toml:"postgres" comment:"Postgres configuration"`
-	}
-
-	config := Config{Postgres{User: "pelletier", Password: "mypassword", Database: "old_database"}}
-	b, err := toml.Marshal(config)
-	if err != nil {
-		log.Fatal(err)
-	}
-	fmt.Println(string(b))
-	// Output:
-	// # Postgres configuration
-	// [postgres]
-	//
-	//   # not used anymore
-	//   # db = "old_database"
-	//   password = "mypassword"
-	//   user = "pelletier"
-}
-
-func ExampleUnmarshal() {
-	type Postgres struct {
-		User     string
-		Password string
-	}
-	type Config struct {
-		Postgres Postgres
-	}
-
-	doc := []byte(`
-	[postgres]
-	user = "pelletier"
-	password = "mypassword"`)
-
-	config := Config{}
-	toml.Unmarshal(doc, &config)
-	fmt.Println("user=", config.Postgres.User)
-	// Output:
-	// user= pelletier
-}
-
-func ExampleEncoder_anonymous() {
-	type Credentials struct {
-		User     string `toml:"user"`
-		Password string `toml:"password"`
-	}
-
-	type Protocol struct {
-		Name string `toml:"name"`
-	}
-
-	type Config struct {
-		Version int `toml:"version"`
-		Credentials
-		Protocol `toml:"Protocol"`
-	}
-	config := Config{
-		Version: 2,
-		Credentials: Credentials{
-			User:     "pelletier",
-			Password: "mypassword",
-		},
-		Protocol: Protocol{
-			Name: "tcp",
-		},
-	}
-	fmt.Println("Default:")
-	fmt.Println("---------------")
-
-	def := toml.NewEncoder(os.Stdout)
-	if err := def.Encode(config); err != nil {
-		log.Fatal(err)
-	}
-
-	fmt.Println("---------------")
-	fmt.Println("With promotion:")
-	fmt.Println("---------------")
-
-	prom := toml.NewEncoder(os.Stdout).PromoteAnonymous(true)
-	if err := prom.Encode(config); err != nil {
-		log.Fatal(err)
-	}
-	// Output:
-	// Default:
-	// ---------------
-	// password = "mypassword"
-	// user = "pelletier"
-	// version = 2
-	//
-	// [Protocol]
-	//   name = "tcp"
-	// ---------------
-	// With promotion:
-	// ---------------
-	// version = 2
-	//
-	// [Credentials]
-	//   password = "mypassword"
-	//   user = "pelletier"
-	//
-	// [Protocol]
-	//   name = "tcp"
-}

errors.go

@@ -0,0 +1,260 @@
+package toml
+
+import (
+	"fmt"
+	"strconv"
+	"strings"
+
+	"github.com/pelletier/go-toml/v2/internal/unsafe"
+)
+
+// DecodeError represents an error encountered during the parsing or decoding
+// of a TOML document.
+//
+// In addition to the error message, it contains the position in the document
+// where it happened, as well as a human-readable representation that shows
+// where the error occurred in the document.
+type DecodeError struct {
+	message string
+	line    int
+	column  int
+	key     Key
+
+	human string
+}
+
+// StrictMissingError occurs in a TOML document that does not have a
+// corresponding field in the target value. It contains all the missing fields
+// in Errors.
+//
+// Emitted by Decoder when SetStrict(true) was called.
+type StrictMissingError struct {
+	// One error per field that could not be found.
+	Errors []DecodeError
+}
+
+// Error returns the canonical string for this error.
+func (s *StrictMissingError) Error() string {
+	return "strict mode: fields in the document are missing in the target struct"
+}
+
+// String returns a human readable description of all errors.
+func (s *StrictMissingError) String() string {
+	var buf strings.Builder
+
+	for i, e := range s.Errors {
+		if i > 0 {
+			buf.WriteString("\n---\n")
+		}
+
+		buf.WriteString(e.String())
+	}
+
+	return buf.String()
+}
+
+type Key []string
+
+// internal version of DecodeError that is used as the base to create a
+// DecodeError with full context.
+type decodeError struct {
+	highlight []byte
+	message   string
+	key       Key // optional
+}
+
+func (de *decodeError) Error() string {
+	return de.message
+}
+
+func newDecodeError(highlight []byte, format string, args ...interface{}) error {
+	return &decodeError{
+		highlight: highlight,
+		message:   fmt.Errorf(format, args...).Error(),
+	}
+}
+
+// Error returns the error message contained in the DecodeError.
+func (e *DecodeError) Error() string {
+	return "toml: " + e.message
+}
+
+// String returns the human-readable contextualized error. This string is multi-line.
+func (e *DecodeError) String() string {
+	return e.human
+}
+
+// Position returns the (line, column) pair indicating where the error
+// occurred in the document. Positions are 1-indexed.
+func (e *DecodeError) Position() (row int, column int) {
+	return e.line, e.column
+}
+
+// Key that was being processed when the error occurred. The key is present only
+// if this DecodeError is part of a StrictMissingError.
+func (e *DecodeError) Key() Key {
+	return e.key
+}
+
+// decodeErrorFromHighlight creates a DecodeError referencing a highlighted
+// range of bytes from document.
+//
+// highlight needs to be a sub-slice of document, or this function panics.
+//
+// The function copies all bytes used in DecodeError, so that document and
+// highlight can be freely deallocated.
+//nolint:funlen
+func wrapDecodeError(document []byte, de *decodeError) *DecodeError {
+	offset := unsafe.SubsliceOffset(document, de.highlight)
+
+	errMessage := de.Error()
+	errLine, errColumn := positionAtEnd(document[:offset])
+	before, after := linesOfContext(document, de.highlight, offset, 3)
+
+	var buf strings.Builder
+
+	maxLine := errLine + len(after) - 1
+	lineColumnWidth := len(strconv.Itoa(maxLine))
+
+	for i := len(before) - 1; i > 0; i-- {
+		line := errLine - i
+		buf.WriteString(formatLineNumber(line, lineColumnWidth))
+		buf.WriteString("|")
+
+		if len(before[i]) > 0 {
+			buf.WriteString(" ")
+			buf.Write(before[i])
+		}
+
+		buf.WriteRune('\n')
+	}
+
+	buf.WriteString(formatLineNumber(errLine, lineColumnWidth))
+	buf.WriteString("| ")
+
+	if len(before) > 0 {
+		buf.Write(before[0])
+	}
+
+	buf.Write(de.highlight)
+
+	if len(after) > 0 {
+		buf.Write(after[0])
+	}
+
+	buf.WriteRune('\n')
+	buf.WriteString(strings.Repeat(" ", lineColumnWidth))
+	buf.WriteString("| ")
+
+	if len(before) > 0 {
+		buf.WriteString(strings.Repeat(" ", len(before[0])))
+	}
+
+	buf.WriteString(strings.Repeat("~", len(de.highlight)))
+
+	if len(errMessage) > 0 {
+		buf.WriteString(" ")
+		buf.WriteString(errMessage)
+	}
+
+	for i := 1; i < len(after); i++ {
+		buf.WriteRune('\n')
+		line := errLine + i
+		buf.WriteString(formatLineNumber(line, lineColumnWidth))
+		buf.WriteString("|")
+
+		if len(after[i]) > 0 {
+			buf.WriteString(" ")
+			buf.Write(after[i])
+		}
+	}
+
+	return &DecodeError{
+		message: errMessage,
+		line:    errLine,
+		column:  errColumn,
+		key:     de.key,
+		human:   buf.String(),
+	}
+}
+
+func formatLineNumber(line int, width int) string {
+	format := "%" + strconv.Itoa(width) + "d"
+
+	return fmt.Sprintf(format, line)
+}
+
+func linesOfContext(document []byte, highlight []byte, offset int, linesAround int) ([][]byte, [][]byte) {
+	return beforeLines(document, offset, linesAround), afterLines(document, highlight, offset, linesAround)
+}
+
+func beforeLines(document []byte, offset int, linesAround int) [][]byte {
+	var beforeLines [][]byte
+
+	// Walk the document backward from the highlight to find previous lines
+	// of context.
+	rest := document[:offset]
+backward:
+	for o := len(rest) - 1; o >= 0 && len(beforeLines) <= linesAround && len(rest) > 0; {
+		switch {
+		case rest[o] == '\n':
+			// handle individual lines
+			beforeLines = append(beforeLines, rest[o+1:])
+			rest = rest[:o]
+			o = len(rest) - 1
+		case o == 0:
+			// add the first line only if it's non-empty
+			beforeLines = append(beforeLines, rest)
+
+			break backward
+		default:
+			o--
+		}
+	}
+
+	return beforeLines
+}
+
+func afterLines(document []byte, highlight []byte, offset int, linesAround int) [][]byte {
+	var afterLines [][]byte
+
+	// Walk the document forward from the highlight to find the following
+	// lines of context.
+	rest := document[offset+len(highlight):]
+forward:
+	for o := 0; o < len(rest) && len(afterLines) <= linesAround; {
+		switch {
+		case rest[o] == '\n':
+			// handle individual lines
+			afterLines = append(afterLines, rest[:o])
+			rest = rest[o+1:]
+			o = 0
+
+		case o == len(rest)-1 && o > 0:
+			// add last line only if it's non-empty
+			afterLines = append(afterLines, rest)
+
+			break forward
+		default:
+			o++
+		}
+	}
+
+	return afterLines
+}
+
+func positionAtEnd(b []byte) (row int, column int) {
+	row = 1
+	column = 1
+
+	for _, c := range b {
+		if c == '\n' {
+			row++
+			column = 1
+		} else {
+			column++
+		}
+	}
+
+	return
+}

errors_test.go

@@ -0,0 +1,221 @@
+package toml
+
+import (
+	"bytes"
+	"errors"
+	"fmt"
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+//nolint:funlen
+func TestDecodeError(t *testing.T) {
+	t.Parallel()
+
+	examples := []struct {
+		desc     string
+		doc      [3]string
+		msg      string
+		expected string
+	}{
+		{
+			desc: "no context",
+			doc:  [3]string{"", "morning", ""},
+			msg:  "this is wrong",
+			expected: `
+1| morning
+ | ~~~~~~~ this is wrong`,
+		},
+		{
+			desc: "one line",
+			doc:  [3]string{"good ", "morning", " everyone"},
+			msg:  "this is wrong",
+			expected: `
+1| good morning everyone
+ |      ~~~~~~~ this is wrong`,
+		},
+		{
+			desc: "exactly 3 lines",
+			doc: [3]string{`line1
+line2
+line3
+before `, "highlighted", ` after
+post line 1
+post line 2
+post line 3`},
+			msg: "this is wrong",
+			expected: `
+1| line1
+2| line2
+3| line3
+4| before highlighted after
+ |        ~~~~~~~~~~~ this is wrong
+5| post line 1
+6| post line 2
+7| post line 3`,
+		},
+		{
+			desc: "more than 3 lines",
+			doc: [3]string{`should not be seen1
+should not be seen2
+line1
+line2
+line3
+before `, "highlighted", ` after
+post line 1
+post line 2
+post line 3
+should not be seen3
+should not be seen4`},
+			msg: "this is wrong",
+			expected: `
+3| line1
+4| line2
+5| line3
+6| before highlighted after
+ |        ~~~~~~~~~~~ this is wrong
+7| post line 1
+8| post line 2
+9| post line 3`,
+		},
+		{
+			desc: "more than 10 total lines",
+			doc: [3]string{`should not be seen 0
+should not be seen1
+should not be seen2
+should not be seen3
+line1
+line2
+line3
+before `, "highlighted", ` after
+post line 1
+post line 2
+post line 3
+should not be seen3
+should not be seen4`},
+			msg: "this is wrong",
+			expected: `
+ 5| line1
+ 6| line2
+ 7| line3
+ 8| before highlighted after
+  |        ~~~~~~~~~~~ this is wrong
+ 9| post line 1
+10| post line 2
+11| post line 3`,
+		},
+		{
+			desc: "last line of more than 10",
+			doc: [3]string{`should not be seen
+should not be seen
+should not be seen
+should not be seen
+should not be seen
+should not be seen
+should not be seen
+line1
+line2
+line3
+before `, "highlighted", ``},
+			msg: "this is wrong",
+			expected: `
+ 8| line1
+ 9| line2
+10| line3
+11| before highlighted
+  |        ~~~~~~~~~~~ this is wrong
+`,
+		},
+		{
+			desc: "handle empty lines in the before/after blocks",
+			doc: [3]string{
+				`line1
+
+line 2
+before `, "highlighted", ` after
+line 3
+
+line 4
+line 5`,
+			},
+			expected: `1| line1
+2|
+3| line 2
+4| before highlighted after
+ |        ~~~~~~~~~~~
+5| line 3
+6|
+7| line 4`,
+		},
+	}
+
+	for _, e := range examples {
+		e := e
+		t.Run(e.desc, func(t *testing.T) {
+			t.Parallel()
+			b := bytes.Buffer{}
+			b.Write([]byte(e.doc[0]))
+			start := b.Len()
+			b.Write([]byte(e.doc[1]))
+			end := b.Len()
+			b.Write([]byte(e.doc[2]))
+			doc := b.Bytes()
+			hl := doc[start:end]
+
+			err := wrapDecodeError(doc, &decodeError{
+				highlight: hl,
+				message:   e.msg,
+			})
+
+			var derr *DecodeError
+			if !errors.As(err, &derr) {
+				t.Errorf("error not in expected format")
+
+				return
+			}
+
+			assert.Equal(t, strings.Trim(e.expected, "\n"), derr.String())
+		})
+	}
+}
+
+func TestDecodeError_Accessors(t *testing.T) {
+	t.Parallel()
+
+	e := DecodeError{
+		message: "foo",
+		line:    1,
+		column:  2,
+		key:     []string{"one", "two"},
+		human:   "bar",
+	}
+	assert.Equal(t, "toml: foo", e.Error())
+	r, c := e.Position()
+	assert.Equal(t, 1, r)
+	assert.Equal(t, 2, c)
+	assert.Equal(t, Key{"one", "two"}, e.Key())
+	assert.Equal(t, "bar", e.String())
+}
+
+func ExampleDecodeError() {
+	doc := `name = 123__456`
+
+	s := map[string]interface{}{}
+	err := Unmarshal([]byte(doc), &s)
+
+	fmt.Println(err)
+
+	//nolint:errorlint
+	de := err.(*DecodeError)
+	fmt.Println(de.String())
+
+	row, col := de.Position()
+	fmt.Println("error occurred at row", row, "column", col)
+	// Output:
+	// toml: number must have at least one digit between underscores
+	// 1| name = 123__456
+	//  |           ~~ number must have at least one digit between underscores
+	// error occurred at row 1 column 11
+}

example-crlf.toml

@@ -1,30 +0,0 @@
-# This is a TOML document. Boom.
-
-title = "TOML Example"
-
-[owner]
-name = "Tom Preston-Werner"
-organization = "GitHub"
-bio = "GitHub Cofounder & CEO\nLikes tater tots and beer."
-dob = 1979-05-27T07:32:00Z # First class dates? Why not?
-
-[database]
-server = "192.168.1.1"
-ports = [ 8001, 8001, 8002 ]
-connection_max = 5000
-enabled = true
-
-[servers]
-
-  # You can indent as you please. Tabs or spaces. TOML don't care.
-  [servers.alpha]
-  ip = "10.0.0.1"
-  dc = "eqdc10"
-
-  [servers.beta]
-  ip = "10.0.0.2"
-  dc = "eqdc10"
-
-[clients]
-data = [ ["gamma", "delta"], [1, 2] ] # just an update to make sure parsers support it
-score = 4e-08 # to make sure leading zeroes in exponent parts of floats are supported

example.toml

@@ -1,30 +0,0 @@
-# This is a TOML document. Boom.
-
-title = "TOML Example"
-
-[owner]
-name = "Tom Preston-Werner"
-organization = "GitHub"
-bio = "GitHub Cofounder & CEO\nLikes tater tots and beer."
-dob = 1979-05-27T07:32:00Z # First class dates? Why not?
-
-[database]
-server = "192.168.1.1"
-ports = [ 8001, 8001, 8002 ]
-connection_max = 5000
-enabled = true
-
-[servers]
-
-  # You can indent as you please. Tabs or spaces. TOML don't care.
-  [servers.alpha]
-  ip = "10.0.0.1"
-  dc = "eqdc10"
-
-  [servers.beta]
-  ip = "10.0.0.2"
-  dc = "eqdc10"
-
-[clients]
-data = [ ["gamma", "delta"], [1, 2] ] # just an update to make sure parsers support it
-score = 4e-08 # to make sure leading zeroes in exponent parts of floats are supported

fuzz.go

@@ -1,31 +0,0 @@
-// +build gofuzz
-
-package toml
-
-func Fuzz(data []byte) int {
-	tree, err := LoadBytes(data)
-	if err != nil {
-		if tree != nil {
-			panic("tree must be nil if there is an error")
-		}
-		return 0
-	}
-
-	str, err := tree.ToTomlString()
-	if err != nil {
-		if str != "" {
-			panic(`str must be "" if there is an error`)
-		}
-		panic(err)
-	}
-
-	tree, err = Load(str)
-	if err != nil {
-		if tree != nil {
-			panic("tree must be nil if there is an error")
-		}
-		return 0
-	}
-
-	return 1
-}

fuzz.sh

@@ -1,15 +0,0 @@
-#! /bin/sh
-set -eu
-
-go get github.com/dvyukov/go-fuzz/go-fuzz
-go get github.com/dvyukov/go-fuzz/go-fuzz-build
-
-if [ ! -e toml-fuzz.zip ]; then
-    go-fuzz-build github.com/pelletier/go-toml
-fi
-
-rm -fr fuzz
-mkdir -p fuzz/corpus
-cp *.toml fuzz/corpus
-
-go-fuzz -bin=toml-fuzz.zip -workdir=fuzz

go.mod

@@ -1,5 +1,5 @@
-module github.com/pelletier/go-toml
+module github.com/pelletier/go-toml/v2
 
-go 1.12
+go 1.15
 
-require github.com/davecgh/go-spew v1.1.1
+require github.com/stretchr/testify v1.7.0

go.sum

@@ -1,2 +1,11 @@
-github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
-github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

internal/ast/ast.go

@@ -0,0 +1,138 @@
+package ast
+
+import (
+	"fmt"
+)
+
+// Iterator starts uninitialized, you need to call Next() first.
+//
+// For example:
+//
+// it := n.Children()
+// for it.Next() {
+// 		it.Node()
+// }
+type Iterator struct {
+	started bool
+	node    Node
+}
+
+// Next moves the iterator forward and returns true if points to a node, false
+// otherwise.
+func (c *Iterator) Next() bool {
+	if !c.started {
+		c.started = true
+	} else if c.node.Valid() {
+		c.node = c.node.Next()
+	}
+	return c.node.Valid()
+}
+
+// Node returns a copy of the node pointed at by the iterator.
+func (c *Iterator) Node() Node {
+	return c.node
+}
+
+// Root contains a full AST.
+//
+// It is immutable once constructed with Builder.
+type Root struct {
+	nodes []Node
+}
+
+// Iterator over the top level nodes.
+func (r *Root) Iterator() Iterator {
+	it := Iterator{}
+	if len(r.nodes) > 0 {
+		it.node = r.nodes[0]
+	}
+	return it
+}
+
+func (r *Root) at(idx int) Node {
+	// TODO: unsafe to point to the node directly
+	return r.nodes[idx]
+}
+
+// Arrays have one child per element in the array.
+// InlineTables have one child per key-value pair in the table.
+// KeyValues have at least two children. The first one is the value. The
+// rest make a potentially dotted key.
+// Table and Array table have one child per element of the key they
+// represent (same as KeyValue, but without the last node being the value).
+// children []Node
+type Node struct {
+	Kind Kind
+	Data []byte // Raw bytes from the input
+
+	// next idx (in the root array). 0 if last of the collection.
+	next int
+	// child idx (in the root array). 0 if no child.
+	child int
+	// pointer to the root array
+	root *Root
+}
+
+// Next returns a copy of the next node, or an invalid Node if there is no
+// next node.
+func (n Node) Next() Node {
+	if n.next <= 0 {
+		return noNode
+	}
+	return n.root.at(n.next)
+}
+
+// Child returns a copy of the first child node of this node. Other children
+// can be accessed calling Next on the first child.
+// Returns an invalid Node if there is none.
+func (n Node) Child() Node {
+	if n.child <= 0 {
+		return noNode
+	}
+	return n.root.at(n.child)
+}
+
+// Valid returns true if the node's kind is set (not to Invalid).
+func (n Node) Valid() bool {
+	return n.Kind != Invalid
+}
+
+var noNode = Node{}
+
+// Key returns the child nodes making the Key on a supported node. Panics
+// otherwise.
+// They are guaranteed to be all be of the Kind Key. A simple key would return
+// just one element.
+func (n *Node) Key() Iterator {
+	switch n.Kind {
+	case KeyValue:
+		value := n.Child()
+		if !value.Valid() {
+			panic(fmt.Errorf("KeyValue should have at least two children"))
+		}
+		return Iterator{node: value.Next()}
+	case Table, ArrayTable:
+		return Iterator{node: n.Child()}
+	default:
+		panic(fmt.Errorf("Key() is not supported on a %s", n.Kind))
+	}
+}
+
+// Value returns a pointer to the value node of a KeyValue.
+// Guaranteed to be non-nil.
+// Panics if not called on a KeyValue node, or if the Children are malformed.
+func (n Node) Value() Node {
+	assertKind(KeyValue, n)
+	return n.Child()
+}
+
+// Children returns an iterator over a node's children.
+func (n Node) Children() Iterator {
+	return Iterator{node: n.Child()}
+}
+
+func assertKind(k Kind, n Node) {
+	if n.Kind != k {
+		panic(fmt.Errorf("method was expecting a %s, not a %s", k, n.Kind))
+	}
+}

internal/ast/builder.go

@@ -0,0 +1,60 @@
+package ast
+
+type Reference struct {
+	idx int
+	set bool
+}
+
+func (r Reference) Valid() bool {
+	return r.set
+}
+
+type Builder struct {
+	tree    Root
+	lastIdx int
+}
+
+func (b *Builder) Tree() *Root {
+	return &b.tree
+}
+
+func (b *Builder) NodeAt(ref Reference) Node {
+	return b.tree.at(ref.idx)
+}
+
+func (b *Builder) Reset() {
+	b.tree.nodes = b.tree.nodes[:0]
+	b.lastIdx = 0
+}
+
+func (b *Builder) Push(n Node) Reference {
+	n.root = &b.tree
+	b.lastIdx = len(b.tree.nodes)
+	b.tree.nodes = append(b.tree.nodes, n)
+	return Reference{
+		idx: b.lastIdx,
+		set: true,
+	}
+}
+
+func (b *Builder) PushAndChain(n Node) Reference {
+	n.root = &b.tree
+	newIdx := len(b.tree.nodes)
+	b.tree.nodes = append(b.tree.nodes, n)
+	if b.lastIdx >= 0 {
+		b.tree.nodes[b.lastIdx].next = newIdx
+	}
+	b.lastIdx = newIdx
+	return Reference{
+		idx: b.lastIdx,
+		set: true,
+	}
+}
+
+func (b *Builder) AttachChild(parent Reference, child Reference) {
+	b.tree.nodes[parent.idx].child = child.idx
+}
+
+func (b *Builder) Chain(from Reference, to Reference) {
+	b.tree.nodes[from.idx].next = to.idx
+}

internal/ast/kind.go

@@ -0,0 +1,69 @@
+package ast
+
+import "fmt"
+
+type Kind int
+
+const (
+	// meta
+	Invalid Kind = iota
+	Comment
+	Key
+
+	// top level structures
+	Table
+	ArrayTable
+	KeyValue
+
+	// containers values
+	Array
+	InlineTable
+
+	// values
+	String
+	Bool
+	Float
+	Integer
+	LocalDate
+	LocalDateTime
+	DateTime
+	Time
+)
+
+func (k Kind) String() string {
+	switch k {
+	case Invalid:
+		return "Invalid"
+	case Comment:
+		return "Comment"
+	case Key:
+		return "Key"
+	case Table:
+		return "Table"
+	case ArrayTable:
+		return "ArrayTable"
+	case KeyValue:
+		return "KeyValue"
+	case Array:
+		return "Array"
+	case InlineTable:
+		return "InlineTable"
+	case String:
+		return "String"
+	case Bool:
+		return "Bool"
+	case Float:
+		return "Float"
+	case Integer:
+		return "Integer"
+	case LocalDate:
+		return "LocalDate"
+	case LocalDateTime:
+		return "LocalDateTime"
+	case DateTime:
+		return "DateTime"
+	case Time:
+		return "Time"
+	}
+	panic(fmt.Errorf("Kind.String() not implemented for '%d'", k))
+}

internal/imported_tests/marshal_imported_test.go

@@ -0,0 +1,198 @@
+package imported_tests
+
+// Those tests have been imported from v1, but adjust to match the new
+// defaults of v2.
+
+import (
+	"fmt"
+	"testing"
+	"time"
+
+	"github.com/pelletier/go-toml/v2"
+	"github.com/stretchr/testify/require"
+)
+
+func TestDocMarshal(t *testing.T) {
+	type testDoc struct {
+		Title       string            `toml:"title"`
+		BasicLists  testDocBasicLists `toml:"basic_lists"`
+		SubDocPtrs  []*testSubDoc     `toml:"subdocptrs"`
+		BasicMap    map[string]string `toml:"basic_map"`
+		Subdocs     testDocSubs       `toml:"subdoc"`
+		Basics      testDocBasics     `toml:"basic"`
+		SubDocList  []testSubDoc      `toml:"subdoclist"`
+		err         int               `toml:"shouldntBeHere"`
+		unexported  int               `toml:"shouldntBeHere"`
+		Unexported2 int               `toml:"-"`
+	}
+
+	var docData = testDoc{
+		Title:       "TOML Marshal Testing",
+		unexported:  0,
+		Unexported2: 0,
+		Basics: testDocBasics{
+			Bool:       true,
+			Date:       time.Date(1979, 5, 27, 7, 32, 0, 0, time.UTC),
+			Float32:    123.4,
+			Float64:    123.456782132399,
+			Int:        5000,
+			Uint:       5001,
+			String:     &biteMe,
+			unexported: 0,
+		},
+		BasicLists: testDocBasicLists{
+			Floats: []*float32{&float1, &float2, &float3},
+			Bools:  []bool{true, false, true},
+			Dates: []time.Time{
+				time.Date(1979, 5, 27, 7, 32, 0, 0, time.UTC),
+				time.Date(1980, 5, 27, 7, 32, 0, 0, time.UTC),
+			},
+			Ints:    []int{8001, 8001, 8002},
+			Strings: []string{"One", "Two", "Three"},
+			UInts:   []uint{5002, 5003},
+		},
+		BasicMap: map[string]string{
+			"one": "one",
+			"two": "two",
+		},
+		Subdocs: testDocSubs{
+			First:  testSubDoc{"First", 0},
+			Second: &subdoc,
+		},
+		SubDocList: []testSubDoc{
+			{"List.First", 0},
+			{"List.Second", 0},
+		},
+		SubDocPtrs: []*testSubDoc{&subdoc},
+	}
+
+	marshalTestToml := `title = 'TOML Marshal Testing'
+[basic_lists]
+floats = [12.3, 45.6, 78.9]
+bools = [true, false, true]
+dates = [1979-05-27T07:32:00Z, 1980-05-27T07:32:00Z]
+ints = [8001, 8001, 8002]
+uints = [5002, 5003]
+strings = ['One', 'Two', 'Three']
+
+[[subdocptrs]]
+name = 'Second'
+
+[basic_map]
+one = 'one'
+two = 'two'
+
+[subdoc]
+[subdoc.second]
+name = 'Second'
+
+[subdoc.first]
+name = 'First'
+
+
+[basic]
+uint = 5001
+bool = true
+float = 123.4
+float64 = 123.456782132399
+int = 5000
+string = 'Bite me'
+date = 1979-05-27T07:32:00Z
+
+[[subdoclist]]
+name = 'List.First'
+[[subdoclist]]
+name = 'List.Second'
+
+`
+
+	result, err := toml.Marshal(docData)
+	require.NoError(t, err)
+	require.Equal(t, marshalTestToml, string(result))
+}
+
+func TestBasicMarshalQuotedKey(t *testing.T) {
+	result, err := toml.Marshal(quotedKeyMarshalTestData)
+	require.NoError(t, err)
+
+	expected := `'Z.string-àéù' = 'Hello'
+'Yfloat-𝟘' = 3.5
+['Xsubdoc-àéù']
+String2 = 'One'
+
+[['W.sublist-𝟘']]
+String2 = 'Two'
+[['W.sublist-𝟘']]
+String2 = 'Three'
+
+`
+
+	require.Equal(t, string(expected), string(result))
+
+}
+
+func TestEmptyMarshal(t *testing.T) {
+	type emptyMarshalTestStruct struct {
+		Title      string                  `toml:"title"`
+		Bool       bool                    `toml:"bool"`
+		Int        int                     `toml:"int"`
+		String     string                  `toml:"string"`
+		StringList []string                `toml:"stringlist"`
+		Ptr        *basicMarshalTestStruct `toml:"ptr"`
+		Map        map[string]string       `toml:"map"`
+	}
+
+	doc := emptyMarshalTestStruct{
+		Title:      "Placeholder",
+		Bool:       false,
+		Int:        0,
+		String:     "",
+		StringList: []string{},
+		Ptr:        nil,
+		Map:        map[string]string{},
+	}
+	result, err := toml.Marshal(doc)
+	require.NoError(t, err)
+
+	expected := `title = 'Placeholder'
+bool = false
+int = 0
+string = ''
+stringlist = []
+[map]
+
+`
+
+	require.Equal(t, string(expected), string(result))
+}
+
+type textMarshaler struct {
+	FirstName string
+	LastName  string
+}
+
+func (m textMarshaler) MarshalText() ([]byte, error) {
+	fullName := fmt.Sprintf("%s %s", m.FirstName, m.LastName)
+	return []byte(fullName), nil
+}
+
+func TestTextMarshaler(t *testing.T) {
+	type wrap struct {
+		TM textMarshaler
+	}
+
+	m := textMarshaler{FirstName: "Sally", LastName: "Fields"}
+
+	t.Run("at root", func(t *testing.T) {
+		_, err := toml.Marshal(m)
+		// in v2 we do not allow TextMarshaler at root
+		require.Error(t, err)
+	})
+
+	t.Run("leaf", func(t *testing.T) {
+		res, err := toml.Marshal(wrap{m})
+		require.NoError(t, err)
+
+		require.Equal(t, "TM = 'Sally Fields'\n", string(res))
+	})
+}

internal/tracker/key.go

@@ -0,0 +1,50 @@
+package tracker
+
+import (
+	"github.com/pelletier/go-toml/v2/internal/ast"
+)
+
+// KeyTracker is a tracker that keeps track of the current Key as the AST is
+// walked.
+type KeyTracker struct {
+	k []string
+}
+
+// UpdateTable sets the state of the tracker with the AST table node.
+func (t *KeyTracker) UpdateTable(node ast.Node) {
+	t.reset()
+	t.Push(node)
+}
+
+// UpdateArrayTable sets the state of the tracker with the AST array table node.
+func (t *KeyTracker) UpdateArrayTable(node ast.Node) {
+	t.reset()
+	t.Push(node)
+}
+
+// Push the given key on the stack.
+func (t *KeyTracker) Push(node ast.Node) {
+	it := node.Key()
+	for it.Next() {
+		t.k = append(t.k, string(it.Node().Data))
+	}
+}
+
+// Pop key from stack.
+func (t *KeyTracker) Pop(node ast.Node) {
+	it := node.Key()
+	for it.Next() {
+		t.k = t.k[:len(t.k)-1]
+	}
+}
+
+// Key returns the current key
+func (t *KeyTracker) Key() []string {
+	k := make([]string, len(t.k))
+	copy(k, t.k)
+	return k
+}
+
+func (t *KeyTracker) reset() {
+	t.k = t.k[:0]
+}

internal/tracker/seen.go

@@ -0,0 +1,200 @@
+package tracker
+
+import (
+	"fmt"
+
+	"github.com/pelletier/go-toml/v2/internal/ast"
+)
+
+type keyKind uint8
+
+const (
+	invalidKind keyKind = iota
+	valueKind
+	tableKind
+	arrayTableKind
+)
+
+func (k keyKind) String() string {
+	switch k {
+	case invalidKind:
+		return "invalid"
+	case valueKind:
+		return "value"
+	case tableKind:
+		return "table"
+	case arrayTableKind:
+		return "array table"
+	}
+	panic("missing keyKind string mapping")
+}
+
+// SeenTracker tracks which keys have been seen with which TOML type to flag duplicates
+// and mismatches according to the spec.
+type SeenTracker struct {
+	root    *info
+	current *info
+}
+
+type info struct {
+	parent   *info
+	kind     keyKind
+	children map[string]*info
+	explicit bool
+}
+
+func (i *info) Clear() {
+	i.children = nil
+}
+
+func (i *info) Has(k string) (*info, bool) {
+	c, ok := i.children[k]
+	return c, ok
+}
+
+func (i *info) SetKind(kind keyKind) {
+	i.kind = kind
+}
+
+func (i *info) CreateTable(k string, explicit bool) *info {
+	return i.createChild(k, tableKind, explicit)
+}
+
+func (i *info) CreateArrayTable(k string, explicit bool) *info {
+	return i.createChild(k, arrayTableKind, explicit)
+}
+
+func (i *info) createChild(k string, kind keyKind, explicit bool) *info {
+	if i.children == nil {
+		i.children = make(map[string]*info, 1)
+	}
+
+	x := &info{
+		parent:   i,
+		kind:     kind,
+		explicit: explicit,
+	}
+	i.children[k] = x
+	return x
+}
+
+// CheckExpression takes a top-level node and checks that it does not contain keys
+// that have been seen in previous calls, and validates that types are consistent.
+func (s *SeenTracker) CheckExpression(node ast.Node) error {
+	if s.root == nil {
+		s.root = &info{
+			kind: tableKind,
+		}
+		s.current = s.root
+	}
+	switch node.Kind {
+	case ast.KeyValue:
+		return s.checkKeyValue(s.current, node)
+	case ast.Table:
+		return s.checkTable(node)
+	case ast.ArrayTable:
+		return s.checkArrayTable(node)
+	default:
+		panic(fmt.Errorf("this should not be a top level node type: %s", node.Kind))
+	}
+
+}
+func (s *SeenTracker) checkTable(node ast.Node) error {
+	s.current = s.root
+
+	it := node.Key()
+	// handle the first parts of the key, excluding the last one
+	for it.Next() {
+		if !it.Node().Next().Valid() {
+			break
+		}
+
+		k := string(it.Node().Data)
+		child, found := s.current.Has(k)
+		if !found {
+			child = s.current.CreateTable(k, false)
+		}
+		s.current = child
+	}
+
+	// handle the last part of the key
+	k := string(it.Node().Data)
+
+	i, found := s.current.Has(k)
+	if found {
+		if i.kind != tableKind {
+			return fmt.Errorf("toml: key %s should be a table, not a %s", k, i.kind)
+		}
+		if i.explicit {
+			return fmt.Errorf("toml: table %s already exists", k)
+		}
+		i.explicit = true
+		s.current = i
+	} else {
+		s.current = s.current.CreateTable(k, true)
+	}
+
+	return nil
+}
+
+func (s *SeenTracker) checkArrayTable(node ast.Node) error {
+	s.current = s.root
+
+	it := node.Key()
+
+	// handle the first parts of the key, excluding the last one
+	for it.Next() {
+		if !it.Node().Next().Valid() {
+			break
+		}
+
+		k := string(it.Node().Data)
+		child, found := s.current.Has(k)
+		if !found {
+			child = s.current.CreateTable(k, false)
+		}
+		s.current = child
+	}
+
+	// handle the last part of the key
+	k := string(it.Node().Data)
+
+	info, found := s.current.Has(k)
+	if found {
+		if info.kind != arrayTableKind {
+			return fmt.Errorf("toml: key %s already exists as a %s,  but should be an array table", info.kind, k)
+		}
+		info.Clear()
+	} else {
+		info = s.current.CreateArrayTable(k, true)
+	}
+
+	s.current = info
+	return nil
+}
+
+func (s *SeenTracker) checkKeyValue(context *info, node ast.Node) error {
+	it := node.Key()
+
+	// handle the first parts of the key, excluding the last one
+	for it.Next() {
+		k := string(it.Node().Data)
+		child, found := context.Has(k)
+		if found {
+			if child.kind != tableKind {
+				return fmt.Errorf("toml: expected %s to be a table, not a %s", k, child.kind)
+			}
+		} else {
+			child = context.CreateTable(k, false)
+		}
+		context = child
+	}
+
+	if node.Value().Kind == ast.InlineTable {
+		context.SetKind(tableKind)
+	} else {
+		context.SetKind(valueKind)
+	}
+
+	return nil
+}

internal/tracker/tracker.go

@@ -0,0 +1 @@
+package tracker

internal/unsafe/unsafe.go

@@ -0,0 +1,59 @@
+package unsafe
+
+import (
+	"fmt"
+	"reflect"
+	"unsafe"
+)
+
+const maxInt = uintptr(int(^uint(0) >> 1))
+
+func SubsliceOffset(data []byte, subslice []byte) int {
+	datap := (*reflect.SliceHeader)(unsafe.Pointer(&data))
+	hlp := (*reflect.SliceHeader)(unsafe.Pointer(&subslice))
+
+	if hlp.Data < datap.Data {
+		panic(fmt.Errorf("subslice address (%d) is before data address (%d)", hlp.Data, datap.Data))
+	}
+	offset := hlp.Data - datap.Data
+
+	if offset > maxInt {
+		panic(fmt.Errorf("slice offset larger than int (%d)", offset))
+	}
+
+	intoffset := int(offset)
+
+	if intoffset > datap.Len {
+		panic(fmt.Errorf("slice offset (%d) is farther than data length (%d)", intoffset, datap.Len))
+	}
+
+	if intoffset+hlp.Len > datap.Len {
+		panic(fmt.Errorf("slice ends (%d+%d) is farther than data length (%d)", intoffset, hlp.Len, datap.Len))
+	}
+
+	return intoffset
+}
+
+func BytesRange(start []byte, end []byte) []byte {
+	if start == nil || end == nil {
+		panic("cannot call BytesRange with nil")
+	}
+	startp := (*reflect.SliceHeader)(unsafe.Pointer(&start))
+	endp := (*reflect.SliceHeader)(unsafe.Pointer(&end))
+
+	if startp.Data > endp.Data {
+		panic(fmt.Errorf("start pointer address (%d) is after end pointer address (%d)", startp.Data, endp.Data))
+	}
+
+	l := startp.Len
+	endLen := int(endp.Data-startp.Data) + endp.Len
+	if endLen > l {
+		l = endLen
+	}
+
+	if l > startp.Cap {
+		panic(fmt.Errorf("range length is larger than capacity"))
+	}
+
+	return start[:l]
+}

internal/unsafe/unsafe_test.go

@@ -0,0 +1,168 @@
+package unsafe_test
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	"github.com/pelletier/go-toml/v2/internal/unsafe"
+)
+
+func TestUnsafeSubsliceOffsetValid(t *testing.T) {
+	examples := []struct {
+		desc   string
+		test   func() ([]byte, []byte)
+		offset int
+	}{
+		{
+			desc: "simple",
+			test: func() ([]byte, []byte) {
+				data := []byte("hello")
+				return data, data[1:]
+			},
+			offset: 1,
+		},
+	}
+
+	for _, e := range examples {
+		t.Run(e.desc, func(t *testing.T) {
+			d, s := e.test()
+			offset := unsafe.SubsliceOffset(d, s)
+			assert.Equal(t, e.offset, offset)
+		})
+	}
+}
+
+func TestUnsafeSubsliceOffsetInvalid(t *testing.T) {
+	examples := []struct {
+		desc string
+		test func() ([]byte, []byte)
+	}{
+		{
+			desc: "unrelated arrays",
+			test: func() ([]byte, []byte) {
+				return []byte("one"), []byte("two")
+			},
+		},
+		{
+			desc: "slice starts before data",
+			test: func() ([]byte, []byte) {
+				full := []byte("hello world")
+				return full[5:], full[1:]
+			},
+		},
+		{
+			desc: "slice starts after data",
+			test: func() ([]byte, []byte) {
+				full := []byte("hello world")
+				return full[:3], full[5:]
+			},
+		},
+		{
+			desc: "slice ends after data",
+			test: func() ([]byte, []byte) {
+				full := []byte("hello world")
+				return full[:5], full[3:8]
+			},
+		},
+	}
+
+	for _, e := range examples {
+		t.Run(e.desc, func(t *testing.T) {
+			d, s := e.test()
+			require.Panics(t, func() {
+				unsafe.SubsliceOffset(d, s)
+			})
+		})
+	}
+}
+
+func TestUnsafeBytesRange(t *testing.T) {
+	type fn = func() ([]byte, []byte)
+	examples := []struct {
+		desc     string
+		test     fn
+		expected []byte
+	}{
+		{
+			desc: "simple",
+			test: func() ([]byte, []byte) {
+				full := []byte("hello world")
+				return full[1:3], full[6:8]
+			},
+			expected: []byte("ello wo"),
+		},
+		{
+			desc: "full",
+			test: func() ([]byte, []byte) {
+				full := []byte("hello world")
+				return full[0:1], full[len(full)-1:]
+			},
+			expected: []byte("hello world"),
+		},
+		{
+			desc: "end before start",
+			test: func() ([]byte, []byte) {
+				full := []byte("hello world")
+				return full[len(full)-1:], full[0:1]
+			},
+		},
+		{
+			desc: "nils",
+			test: func() ([]byte, []byte) {
+				return nil, nil
+			},
+		},
+		{
+			desc: "nils start",
+			test: func() ([]byte, []byte) {
+				return nil, []byte("foo")
+			},
+		},
+		{
+			desc: "nils end",
+			test: func() ([]byte, []byte) {
+				return []byte("foo"), nil
+			},
+		},
+		{
+			desc: "start is end",
+			test: func() ([]byte, []byte) {
+				full := []byte("hello world")
+				return full[1:3], full[1:3]
+			},
+			expected: []byte("el"),
+		},
+		{
+			desc: "end contained in start",
+			test: func() ([]byte, []byte) {
+				full := []byte("hello world")
+				return full[1:7], full[2:4]
+			},
+			expected: []byte("ello w"),
+		},
+		{
+			desc: "different backing arrays",
+			test: func() ([]byte, []byte) {
+				one := []byte("hello world")
+				two := []byte("hello world")
+				return one, two
+			},
+		},
+	}
+
+	for _, e := range examples {
+		t.Run(e.desc, func(t *testing.T) {
+			start, end := e.test()
+			if e.expected == nil {
+				require.Panics(t, func() {
+					unsafe.BytesRange(start, end)
+				})
+			} else {
+				res := unsafe.BytesRange(start, end)
+				require.Equal(t, e.expected, res)
+			}
+		})
+	}
+}

keysparsing.go

@@ -1,112 +0,0 @@
-// Parsing keys handling both bare and quoted keys.
-
-package toml
-
-import (
-	"errors"
-	"fmt"
-)
-
-// Convert the bare key group string to an array.
-// The input supports double quotation and single quotation,
-// but escape sequences are not supported. Lexers must unescape them beforehand.
-func parseKey(key string) ([]string, error) {
-	runes := []rune(key)
-	var groups []string
-
-	if len(key) == 0 {
-		return nil, errors.New("empty key")
-	}
-
-	idx := 0
-	for idx < len(runes) {
-		for ; idx < len(runes) && isSpace(runes[idx]); idx++ {
-			// skip leading whitespace
-		}
-		if idx >= len(runes) {
-			break
-		}
-		r := runes[idx]
-		if isValidBareChar(r) {
-			// parse bare key
-			startIdx := idx
-			endIdx := -1
-			idx++
-			for idx < len(runes) {
-				r = runes[idx]
-				if isValidBareChar(r) {
-					idx++
-				} else if r == '.' {
-					endIdx = idx
-					break
-				} else if isSpace(r) {
-					endIdx = idx
-					for ; idx < len(runes) && isSpace(runes[idx]); idx++ {
-						// skip trailing whitespace
-					}
-					if idx < len(runes) && runes[idx] != '.' {
-						return nil, fmt.Errorf("invalid key character after whitespace: %c", runes[idx])
-					}
-					break
-				} else {
-					return nil, fmt.Errorf("invalid bare key character: %c", r)
-				}
-			}
-			if endIdx == -1 {
-				endIdx = idx
-			}
-			groups = append(groups, string(runes[startIdx:endIdx]))
-		} else if r == '\'' {
-			// parse single quoted key
-			idx++
-			startIdx := idx
-			for {
-				if idx >= len(runes) {
-					return nil, fmt.Errorf("unclosed single-quoted key")
-				}
-				r = runes[idx]
-				if r == '\'' {
-					groups = append(groups, string(runes[startIdx:idx]))
-					idx++
-					break
-				}
-				idx++
-			}
-		} else if r == '"' {
-			// parse double quoted key
-			idx++
-			startIdx := idx
-			for {
-				if idx >= len(runes) {
-					return nil, fmt.Errorf("unclosed double-quoted key")
-				}
-				r = runes[idx]
-				if r == '"' {
-					groups = append(groups, string(runes[startIdx:idx]))
-					idx++
-					break
-				}
-				idx++
-			}
-		} else if r == '.' {
-			idx++
-			if idx >= len(runes) {
-				return nil, fmt.Errorf("unexpected end of key")
-			}
-			r = runes[idx]
-			if !isValidBareChar(r) && r != '\'' && r != '"' && r != ' ' {
-				return nil, fmt.Errorf("expecting key part after dot")
-			}
-		} else {
-			return nil, fmt.Errorf("invalid key character: %c", r)
-		}
-	}
-	if len(groups) == 0 {
-		return nil, fmt.Errorf("empty key")
-	}
-	return groups, nil
-}
-
-func isValidBareChar(r rune) bool {
-	return isAlphanumeric(r) || r == '-' || isDigit(r)
-}

keysparsing_test.go

@@ -1,79 +0,0 @@
-package toml
-
-import (
-	"fmt"
-	"testing"
-)
-
-func testResult(t *testing.T, key string, expected []string) {
-	parsed, err := parseKey(key)
-	t.Logf("key=%s expected=%s parsed=%s", key, expected, parsed)
-	if err != nil {
-		t.Fatal("Unexpected error:", err)
-	}
-	if len(expected) != len(parsed) {
-		t.Fatal("Expected length", len(expected), "but", len(parsed), "parsed")
-	}
-	for index, expectedKey := range expected {
-		if expectedKey != parsed[index] {
-			t.Fatal("Expected", expectedKey, "at index", index, "but found", parsed[index])
-		}
-	}
-}
-
-func testError(t *testing.T, key string, expectedError string) {
-	res, err := parseKey(key)
-	if err == nil {
-		t.Fatalf("Expected error, but successfully parsed key %s", res)
-	}
-	if fmt.Sprintf("%s", err) != expectedError {
-		t.Fatalf("Expected error \"%s\", but got \"%s\".", expectedError, err)
-	}
-}
-
-func TestBareKeyBasic(t *testing.T) {
-	testResult(t, "test", []string{"test"})
-}
-
-func TestBareKeyDotted(t *testing.T) {
-	testResult(t, "this.is.a.key", []string{"this", "is", "a", "key"})
-}
-
-func TestDottedKeyBasic(t *testing.T) {
-	testResult(t, "\"a.dotted.key\"", []string{"a.dotted.key"})
-}
-
-func TestBaseKeyPound(t *testing.T) {
-	testError(t, "hello#world", "invalid bare key character: #")
-}
-
-func TestUnclosedSingleQuotedKey(t *testing.T) {
-	testError(t, "'", "unclosed single-quoted key")
-}
-
-func TestUnclosedDoubleQuotedKey(t *testing.T) {
-	testError(t, "\"", "unclosed double-quoted key")
-}
-
-func TestInvalidStartKeyCharacter(t *testing.T) {
-	testError(t, "/", "invalid key character: /")
-}
-
-func TestInvalidSpaceInKey(t *testing.T) {
-	testError(t, "invalid key", "invalid key character after whitespace: k")
-}
-
-func TestQuotedKeys(t *testing.T) {
-	testResult(t, `hello."foo".bar`, []string{"hello", "foo", "bar"})
-	testResult(t, `"hello!"`, []string{"hello!"})
-	testResult(t, `foo."ba.r".baz`, []string{"foo", "ba.r", "baz"})
-
-	// escape sequences must not be converted
-	testResult(t, `"hello\tworld"`, []string{`hello\tworld`})
-}
-
-func TestEmptyKey(t *testing.T) {
-	testError(t, ``, "empty key")
-	testError(t, ` `, "empty key")
-	testResult(t, `""`, []string{""})
-}

localtime.go

@@ -23,6 +23,7 @@
 //
 // Because they lack location information, these types do not represent unique
 // moments or intervals of time. Use time.Time for that purpose.
+
 package toml
 
 import (
@@ -44,6 +45,7 @@ type LocalDate struct {
 func LocalDateOf(t time.Time) LocalDate {
 	var d LocalDate
 	d.Year, d.Month, d.Day = t.Date()
+
 	return d
 }
 
@@ -53,6 +55,7 @@ func ParseLocalDate(s string) (LocalDate, error) {
 	if err != nil {
 		return LocalDate{}, err
 	}
+
 	return LocalDateOf(t), nil
 }
 
@@ -92,23 +95,28 @@ func (d LocalDate) DaysSince(s LocalDate) (days int) {
 	// We convert to Unix time so we do not have to worry about leap seconds:
 	// Unix time increases by exactly 86400 seconds per day.
 	deltaUnix := d.In(time.UTC).Unix() - s.In(time.UTC).Unix()
-	return int(deltaUnix / 86400)
+
+	const secondsInADay = 86400
+
+	return int(deltaUnix / secondsInADay)
 }
 
-// Before reports whether d1 occurs before d2.
-func (d1 LocalDate) Before(d2 LocalDate) bool {
-	if d1.Year != d2.Year {
-		return d1.Year < d2.Year
+// Before reports whether d1 occurs before future date.
+func (d LocalDate) Before(future LocalDate) bool {
+	if d.Year != future.Year {
+		return d.Year < future.Year
 	}
-	if d1.Month != d2.Month {
-		return d1.Month < d2.Month
+
+	if d.Month != future.Month {
+		return d.Month < future.Month
 	}
-	return d1.Day < d2.Day
+
+	return d.Day < future.Day
 }
 
-// After reports whether d1 occurs after d2.
-func (d1 LocalDate) After(d2 LocalDate) bool {
-	return d2.Before(d1)
+// After reports whether d1 occurs after past date.
+func (d LocalDate) After(past LocalDate) bool {
+	return past.Before(d)
 }
 
 // MarshalText implements the encoding.TextMarshaler interface.
@@ -122,6 +130,7 @@ func (d LocalDate) MarshalText() ([]byte, error) {
 func (d *LocalDate) UnmarshalText(data []byte) error {
 	var err error
 	*d, err = ParseLocalDate(string(data))
+
 	return err
 }
 
@@ -145,6 +154,7 @@ func LocalTimeOf(t time.Time) LocalTime {
 	var tm LocalTime
 	tm.Hour, tm.Minute, tm.Second = t.Clock()
 	tm.Nanosecond = t.Nanosecond()
+
 	return tm
 }
 
@@ -158,6 +168,7 @@ func ParseLocalTime(s string) (LocalTime, error) {
 	if err != nil {
 		return LocalTime{}, err
 	}
+
 	return LocalTimeOf(t), nil
 }
 
@@ -169,6 +180,7 @@ func (t LocalTime) String() string {
 	if t.Nanosecond == 0 {
 		return s
 	}
+
 	return s + fmt.Sprintf(".%09d", t.Nanosecond)
 }
 
@@ -176,6 +188,7 @@ func (t LocalTime) String() string {
 func (t LocalTime) IsValid() bool {
 	// Construct a non-zero time.
 	tm := time.Date(2, 2, 2, t.Hour, t.Minute, t.Second, t.Nanosecond, time.UTC)
+
 	return LocalTimeOf(tm) == t
 }
 
@@ -190,6 +203,7 @@ func (t LocalTime) MarshalText() ([]byte, error) {
 func (t *LocalTime) UnmarshalText(data []byte) error {
 	var err error
 	*t, err = ParseLocalTime(string(data))
+
 	return err
 }
 
@@ -226,6 +240,7 @@ func ParseLocalDateTime(s string) (LocalDateTime, error) {
 			return LocalDateTime{}, err
 		}
 	}
+
 	return LocalDateTimeOf(t), nil
 }
 
@@ -253,17 +268,20 @@ func (dt LocalDateTime) IsValid() bool {
 //
 // In panics if loc is nil.
 func (dt LocalDateTime) In(loc *time.Location) time.Time {
-	return time.Date(dt.Date.Year, dt.Date.Month, dt.Date.Day, dt.Time.Hour, dt.Time.Minute, dt.Time.Second, dt.Time.Nanosecond, loc)
+	return time.Date(
+		dt.Date.Year, dt.Date.Month, dt.Date.Day,
+		dt.Time.Hour, dt.Time.Minute, dt.Time.Second, dt.Time.Nanosecond, loc,
+	)
 }
 
-// Before reports whether dt1 occurs before dt2.
-func (dt1 LocalDateTime) Before(dt2 LocalDateTime) bool {
-	return dt1.In(time.UTC).Before(dt2.In(time.UTC))
+// Before reports whether dt occurs before future.
+func (dt LocalDateTime) Before(future LocalDateTime) bool {
+	return dt.In(time.UTC).Before(future.In(time.UTC))
 }
 
-// After reports whether dt1 occurs after dt2.
-func (dt1 LocalDateTime) After(dt2 LocalDateTime) bool {
-	return dt2.Before(dt1)
+// After reports whether dt occurs after past.
+func (dt LocalDateTime) After(past LocalDateTime) bool {
+	return past.Before(dt)
 }
 
 // MarshalText implements the encoding.TextMarshaler interface.
@@ -273,9 +291,10 @@ func (dt LocalDateTime) MarshalText() ([]byte, error) {
 }
 
 // UnmarshalText implements the encoding.TextUnmarshaler interface.
-// The datetime is expected to be a string in a format accepted by ParseLocalDateTime
+// The datetime is expected to be a string in a format accepted by ParseLocalDateTime.
 func (dt *LocalDateTime) UnmarshalText(data []byte) error {
 	var err error
 	*dt, err = ParseLocalDateTime(string(data))
+
 	return err
 }

localtime_test.go

@@ -26,6 +26,8 @@ func cmpEqual(x, y interface{}) bool {
 }
 
 func TestDates(t *testing.T) {
+	t.Parallel()
+
 	for _, test := range []struct {
 		date     LocalDate
 		loc      *time.Location
@@ -54,6 +56,7 @@ func TestDates(t *testing.T) {
 		if got := test.date.String(); got != test.wantStr {
 			t.Errorf("%#v.String() = %q, want %q", test.date, got, test.wantStr)
 		}
+
 		if got := test.date.In(test.loc); !got.Equal(test.wantTime) {
 			t.Errorf("%#v.In(%v) = %v, want %v", test.date, test.loc, got, test.wantTime)
 		}
@@ -61,6 +64,8 @@ func TestDates(t *testing.T) {
 }
 
 func TestDateIsValid(t *testing.T) {
+	t.Parallel()
+
 	for _, test := range []struct {
 		date LocalDate
 		want bool
@@ -86,6 +91,10 @@ func TestDateIsValid(t *testing.T) {
 }
 
 func TestParseDate(t *testing.T) {
+	t.Parallel()
+
+	var emptyDate LocalDate
+
 	for _, test := range []struct {
 		str  string
 		want LocalDate // if empty, expect an error
@@ -93,21 +102,24 @@ func TestParseDate(t *testing.T) {
 		{"2016-01-02", LocalDate{2016, 1, 2}},
 		{"2016-12-31", LocalDate{2016, 12, 31}},
 		{"0003-02-04", LocalDate{3, 2, 4}},
-		{"999-01-26", LocalDate{}},
-		{"", LocalDate{}},
-		{"2016-01-02x", LocalDate{}},
+		{"999-01-26", emptyDate},
+		{"", emptyDate},
+		{"2016-01-02x", emptyDate},
 	} {
 		got, err := ParseLocalDate(test.str)
 		if got != test.want {
 			t.Errorf("ParseLocalDate(%q) = %+v, want %+v", test.str, got, test.want)
 		}
-		if err != nil && test.want != (LocalDate{}) {
+
+		if err != nil && test.want != (emptyDate) {
 			t.Errorf("Unexpected error %v from ParseLocalDate(%q)", err, test.str)
 		}
 	}
 }
 
 func TestDateArithmetic(t *testing.T) {
+	t.Parallel()
+
 	for _, test := range []struct {
 		desc  string
 		start LocalDate
@@ -160,6 +172,7 @@ func TestDateArithmetic(t *testing.T) {
 		if got := test.start.AddDays(test.days); got != test.end {
 			t.Errorf("[%s] %#v.AddDays(%v) = %#v, want %#v", test.desc, test.start, test.days, got, test.end)
 		}
+
 		if got := test.end.DaysSince(test.start); got != test.days {
 			t.Errorf("[%s] %#v.Sub(%#v) = %v, want %v", test.desc, test.end, test.start, got, test.days)
 		}
@@ -167,6 +180,8 @@ func TestDateArithmetic(t *testing.T) {
 }
 
 func TestDateBefore(t *testing.T) {
+	t.Parallel()
+
 	for _, test := range []struct {
 		d1, d2 LocalDate
 		want   bool
@@ -183,6 +198,8 @@ func TestDateBefore(t *testing.T) {
 }
 
 func TestDateAfter(t *testing.T) {
+	t.Parallel()
+
 	for _, test := range []struct {
 		d1, d2 LocalDate
 		want   bool
@@ -198,6 +215,8 @@ func TestDateAfter(t *testing.T) {
 }
 
 func TestTimeToString(t *testing.T) {
+	t.Parallel()
+
 	for _, test := range []struct {
 		str       string
 		time      LocalTime
@@ -212,11 +231,14 @@ func TestTimeToString(t *testing.T) {
 		gotTime, err := ParseLocalTime(test.str)
 		if err != nil {
 			t.Errorf("ParseLocalTime(%q): got error: %v", test.str, err)
+
 			continue
 		}
+
 		if gotTime != test.time {
 			t.Errorf("ParseLocalTime(%q) = %+v, want %+v", test.str, gotTime, test.time)
 		}
+
 		if test.roundTrip {
 			gotStr := test.time.String()
 			if gotStr != test.str {
@@ -227,6 +249,8 @@ func TestTimeToString(t *testing.T) {
 }
 
 func TestTimeOf(t *testing.T) {
+	t.Parallel()
+
 	for _, test := range []struct {
 		time time.Time
 		want LocalTime
@@ -241,6 +265,8 @@ func TestTimeOf(t *testing.T) {
 }
 
 func TestTimeIsValid(t *testing.T) {
+	t.Parallel()
+
 	for _, test := range []struct {
 		time LocalTime
 		want bool
@@ -265,23 +291,28 @@ func TestTimeIsValid(t *testing.T) {
 }
 
 func TestDateTimeToString(t *testing.T) {
+	t.Parallel()
+
 	for _, test := range []struct {
 		str       string
 		dateTime  LocalDateTime
 		roundTrip bool // ParseLocalDateTime(str).String() == str?
 	}{
-		{"2016-03-22T13:26:33", LocalDateTime{LocalDate{2016, 03, 22}, LocalTime{13, 26, 33, 0}}, true},
-		{"2016-03-22T13:26:33.000000600", LocalDateTime{LocalDate{2016, 03, 22}, LocalTime{13, 26, 33, 600}}, true},
-		{"2016-03-22t13:26:33", LocalDateTime{LocalDate{2016, 03, 22}, LocalTime{13, 26, 33, 0}}, false},
+		{"2016-03-22T13:26:33", LocalDateTime{LocalDate{2016, 3, 22}, LocalTime{13, 26, 33, 0}}, true},
+		{"2016-03-22T13:26:33.000000600", LocalDateTime{LocalDate{2016, 3, 22}, LocalTime{13, 26, 33, 600}}, true},
+		{"2016-03-22t13:26:33", LocalDateTime{LocalDate{2016, 3, 22}, LocalTime{13, 26, 33, 0}}, false},
 	} {
 		gotDateTime, err := ParseLocalDateTime(test.str)
 		if err != nil {
 			t.Errorf("ParseLocalDateTime(%q): got error: %v", test.str, err)
+
 			continue
 		}
+
 		if gotDateTime != test.dateTime {
 			t.Errorf("ParseLocalDateTime(%q) = %+v, want %+v", test.str, gotDateTime, test.dateTime)
 		}
+
 		if test.roundTrip {
 			gotStr := test.dateTime.String()
 			if gotStr != test.str {
@@ -292,6 +323,8 @@ func TestDateTimeToString(t *testing.T) {
 }
 
 func TestParseDateTimeErrors(t *testing.T) {
+	t.Parallel()
+
 	for _, str := range []string{
 		"",
 		"2016-03-22",           // just a date
@@ -306,14 +339,20 @@ func TestParseDateTimeErrors(t *testing.T) {
 }
 
 func TestDateTimeOf(t *testing.T) {
+	t.Parallel()
+
 	for _, test := range []struct {
 		time time.Time
 		want LocalDateTime
 	}{
-		{time.Date(2014, 8, 20, 15, 8, 43, 1, time.Local),
-			LocalDateTime{LocalDate{2014, 8, 20}, LocalTime{15, 8, 43, 1}}},
-		{time.Date(1, 1, 1, 0, 0, 0, 0, time.UTC),
-			LocalDateTime{LocalDate{1, 1, 1}, LocalTime{0, 0, 0, 0}}},
+		{
+			time.Date(2014, 8, 20, 15, 8, 43, 1, time.Local),
+			LocalDateTime{LocalDate{2014, 8, 20}, LocalTime{15, 8, 43, 1}},
+		},
+		{
+			time.Date(1, 1, 1, 0, 0, 0, 0, time.UTC),
+			LocalDateTime{LocalDate{1, 1, 1}, LocalTime{0, 0, 0, 0}},
+		},
 	} {
 		if got := LocalDateTimeOf(test.time); got != test.want {
 			t.Errorf("LocalDateTimeOf(%v) = %+v, want %+v", test.time, got, test.want)
@@ -322,6 +361,8 @@ func TestDateTimeOf(t *testing.T) {
 }
 
 func TestDateTimeIsValid(t *testing.T) {
+	t.Parallel()
+
 	// No need to be exhaustive here; it's just LocalDate.IsValid && LocalTime.IsValid.
 	for _, test := range []struct {
 		dt   LocalDateTime
@@ -339,19 +380,24 @@ func TestDateTimeIsValid(t *testing.T) {
 }
 
 func TestDateTimeIn(t *testing.T) {
+	t.Parallel()
+
 	dt := LocalDateTime{LocalDate{2016, 1, 2}, LocalTime{3, 4, 5, 6}}
-	got := dt.In(time.UTC)
+
 	want := time.Date(2016, 1, 2, 3, 4, 5, 6, time.UTC)
-	if !got.Equal(want) {
+	if got := dt.In(time.UTC); !got.Equal(want) {
 		t.Errorf("got %v, want %v", got, want)
 	}
 }
 
 func TestDateTimeBefore(t *testing.T) {
+	t.Parallel()
+
 	d1 := LocalDate{2016, 12, 31}
 	d2 := LocalDate{2017, 1, 1}
 	t1 := LocalTime{5, 6, 7, 8}
 	t2 := LocalTime{5, 6, 7, 9}
+
 	for _, test := range []struct {
 		dt1, dt2 LocalDateTime
 		want     bool
@@ -368,10 +414,13 @@ func TestDateTimeBefore(t *testing.T) {
 }
 
 func TestDateTimeAfter(t *testing.T) {
+	t.Parallel()
+
 	d1 := LocalDate{2016, 12, 31}
 	d2 := LocalDate{2017, 1, 1}
 	t1 := LocalTime{5, 6, 7, 8}
 	t2 := LocalTime{5, 6, 7, 9}
+
 	for _, test := range []struct {
 		dt1, dt2 LocalDateTime
 		want     bool
@@ -388,6 +437,8 @@ func TestDateTimeAfter(t *testing.T) {
 }
 
 func TestMarshalJSON(t *testing.T) {
+	t.Parallel()
+
 	for _, test := range []struct {
 		value interface{}
 		want  string
@@ -400,6 +451,7 @@ func TestMarshalJSON(t *testing.T) {
 		if err != nil {
 			t.Fatal(err)
 		}
+
 		if got := string(bgot); got != test.want {
 			t.Errorf("%#v: got %s, want %s", test.value, got, test.want)
 		}
@@ -407,9 +459,14 @@ func TestMarshalJSON(t *testing.T) {
 }
 
 func TestUnmarshalJSON(t *testing.T) {
-	var d LocalDate
-	var tm LocalTime
-	var dt LocalDateTime
+	t.Parallel()
+
+	var (
+		d  LocalDate
+		tm LocalTime
+		dt LocalDateTime
+	)
+
 	for _, test := range []struct {
 		data string
 		ptr  interface{}
@@ -423,12 +480,14 @@ func TestUnmarshalJSON(t *testing.T) {
 		if err := json.Unmarshal([]byte(test.data), test.ptr); err != nil {
 			t.Fatalf("%s: %v", test.data, err)
 		}
+
 		if !cmpEqual(test.ptr, test.want) {
 			t.Errorf("%s: got %#v, want %#v", test.data, test.ptr, test.want)
 		}
 	}
 
-	for _, bad := range []string{"", `""`, `"bad"`, `"1987-04-15x"`,
+	for _, bad := range []string{
+		"", `""`, `"bad"`, `"1987-04-15x"`,
 		`19870415`,     // a JSON number
 		`11987-04-15x`, // not a JSON string
 
@@ -436,9 +495,11 @@ func TestUnmarshalJSON(t *testing.T) {
 		if json.Unmarshal([]byte(bad), &d) == nil {
 			t.Errorf("%q, LocalDate: got nil, want error", bad)
 		}
+
 		if json.Unmarshal([]byte(bad), &tm) == nil {
 			t.Errorf("%q, LocalTime: got nil, want error", bad)
 		}
+
 		if json.Unmarshal([]byte(bad), &dt) == nil {
 			t.Errorf("%q, LocalDateTime: got nil, want error", bad)
 		}

marshal_OrderPreserve_test.toml

@@ -1,39 +0,0 @@
-title = "TOML Marshal Testing"
-
-[basic_lists]
-  floats = [12.3,45.6,78.9]
-  bools = [true,false,true]
-  dates = [1979-05-27T07:32:00Z,1980-05-27T07:32:00Z]
-  ints = [8001,8001,8002]
-  uints = [5002,5003]
-  strings = ["One","Two","Three"]
-
-[[subdocptrs]]
-  name = "Second"
-
-[basic_map]
-  one = "one"
-  two = "two"
-
-[subdoc]
-
-  [subdoc.second]
-    name = "Second"
-
-  [subdoc.first]
-    name = "First"
-
-[basic]
-  uint = 5001
-  bool = true
-  float = 123.4
-  float64 = 123.456782132399
-  int = 5000
-  string = "Bite me"
-  date = 1979-05-27T07:32:00Z
-
-[[subdoclist]]
-  name = "List.First"
-
-[[subdoclist]]
-  name = "List.Second"

marshal_test.toml

@@ -1,39 +0,0 @@
-title = "TOML Marshal Testing"
-
-[basic]
-  bool = true
-  date = 1979-05-27T07:32:00Z
-  float = 123.4
-  float64 = 123.456782132399
-  int = 5000
-  string = "Bite me"
-  uint = 5001
-
-[basic_lists]
-  bools = [true,false,true]
-  dates = [1979-05-27T07:32:00Z,1980-05-27T07:32:00Z]
-  floats = [12.3,45.6,78.9]
-  ints = [8001,8001,8002]
-  strings = ["One","Two","Three"]
-  uints = [5002,5003]
-
-[basic_map]
-  one = "one"
-  two = "two"
-
-[subdoc]
-
-  [subdoc.first]
-    name = "First"
-
-  [subdoc.second]
-    name = "Second"
-
-[[subdoclist]]
-  name = "List.First"
-
-[[subdoclist]]
-  name = "List.Second"
-
-[[subdocptrs]]
-  name = "Second"

marshaler.go

@@ -0,0 +1,796 @@
+package toml
+
+import (
+	"bytes"
+	"encoding"
+	"fmt"
+	"io"
+	"reflect"
+	"sort"
+	"strconv"
+	"strings"
+	"time"
+)
+
+// Marshal serializes a Go value as a TOML document.
+//
+// It is a shortcut for Encoder.Encode() with the default options.
+func Marshal(v interface{}) ([]byte, error) {
+	var buf bytes.Buffer
+	enc := NewEncoder(&buf)
+
+	err := enc.Encode(v)
+	if err != nil {
+		return nil, err
+	}
+
+	return buf.Bytes(), nil
+}
+
+// Encoder writes a TOML document to an output stream.
+type Encoder struct {
+	// output
+	w io.Writer
+
+	// global settings
+	tablesInline    bool
+	arraysMultiline bool
+	indentSymbol    string
+	indentTables    bool
+}
+
+// NewEncoder returns a new Encoder that writes to w.
+func NewEncoder(w io.Writer) *Encoder {
+	return &Encoder{
+		w:            w,
+		indentSymbol: "  ",
+	}
+}
+
+// SetTablesInline forces the encoder to emit all tables inline.
+//
+// This behavior can be controlled on an individual struct field basis with the
+// inline tag:
+//
+//   MyField `inline:"true"`
+func (enc *Encoder) SetTablesInline(inline bool) {
+	enc.tablesInline = inline
+}
+
+// SetArraysMultiline forces the encoder to emit all arrays with one element per
+// line.
+//
+// This behavior can be controlled on an individual struct field basis with the multiline tag:
+//
+//   MyField `multiline:"true"`
+func (enc *Encoder) SetArraysMultiline(multiline bool) {
+	enc.arraysMultiline = multiline
+}
+
+// SetIndentSymbol defines the string that should be used for indentation. The
+// provided string is repeated for each indentation level. Defaults to two
+// spaces.
+func (enc *Encoder) SetIndentSymbol(s string) {
+	enc.indentSymbol = s
+}
+
+// SetIndentTables forces the encoder to intent tables and array tables.
+func (enc *Encoder) SetIndentTables(indent bool) {
+	enc.indentTables = indent
+}
+
+// Encode writes a TOML representation of v to the stream.
+//
+// If v cannot be represented to TOML it returns an error.
+//
+// Encoding rules
+//
+// A top level slice containing only maps or structs is encoded as [[table
+// array]].
+//
+// All slices not matching rule 1 are encoded as [array]. As a result, any map
+// or struct they contain is encoded as an {inline table}.
+//
+// Nil interfaces and nil pointers are not supported.
+//
+// Keys in key-values always have one part.
+//
+// Intermediate tables are always printed.
+//
+// By default, strings are encoded as literal string, unless they contain either
+// a newline character or a single quote. In that case they are emitted as quoted
+// strings.
+//
+// When encoding structs, fields are encoded in order of definition, with their
+// exact name.
+//
+// Struct tags
+//
+// The following struct tags are available to tweak encoding on a per-field
+// basis:
+//
+//   toml:"foo"
+//     Changes the name of the key to use for the field to foo.
+//
+//   multiline:"true"
+//     When the field contains a string, it will be emitted as a quoted
+//     multi-line TOML string.
+//
+//   inline:"true"
+//     When the field would normally be encoded as a table, it is instead
+//     encoded as an inline table.
+func (enc *Encoder) Encode(v interface{}) error {
+	var (
+		b   []byte
+		ctx encoderCtx
+	)
+
+	ctx.inline = enc.tablesInline
+
+	if v == nil {
+		return fmt.Errorf("toml: cannot encode a nil interface")
+	}
+
+	b, err := enc.encode(b, ctx, reflect.ValueOf(v))
+	if err != nil {
+		return err
+	}
+
+	_, err = enc.w.Write(b)
+	if err != nil {
+		return fmt.Errorf("toml: cannot write: %w", err)
+	}
+
+	return nil
+}
+
+type valueOptions struct {
+	multiline bool
+}
+
+type encoderCtx struct {
+	// Current top-level key.
+	parentKey []string
+
+	// Key that should be used for a KV.
+	key string
+	// Extra flag to account for the empty string
+	hasKey bool
+
+	// Set to true to indicate that the encoder is inside a KV, so that all
+	// tables need to be inlined.
+	insideKv bool
+
+	// Set to true to skip the first table header in an array table.
+	skipTableHeader bool
+
+	// Should the next table be encoded as inline
+	inline bool
+
+	// Indentation level
+	indent int
+
+	// Options coming from struct tags
+	options valueOptions
+}
+
+func (ctx *encoderCtx) shiftKey() {
+	if ctx.hasKey {
+		ctx.parentKey = append(ctx.parentKey, ctx.key)
+		ctx.clearKey()
+	}
+}
+
+func (ctx *encoderCtx) setKey(k string) {
+	ctx.key = k
+	ctx.hasKey = true
+}
+
+func (ctx *encoderCtx) clearKey() {
+	ctx.key = ""
+	ctx.hasKey = false
+}
+
+func (ctx *encoderCtx) isRoot() bool {
+	return len(ctx.parentKey) == 0 && !ctx.hasKey
+}
+
+//nolint:cyclop,funlen
+func (enc *Encoder) encode(b []byte, ctx encoderCtx, v reflect.Value) ([]byte, error) {
+	if !v.IsZero() {
+		i, ok := v.Interface().(time.Time)
+		if ok {
+			return i.AppendFormat(b, time.RFC3339), nil
+		}
+	}
+
+	if v.Type().Implements(textMarshalerType) {
+		if ctx.isRoot() {
+			return nil, fmt.Errorf("toml: type %s implementing the TextMarshaler interface cannot be a root element", v.Type())
+		}
+
+		text, err := v.Interface().(encoding.TextMarshaler).MarshalText()
+		if err != nil {
+			return nil, err
+		}
+
+		b = enc.encodeString(b, string(text), ctx.options)
+
+		return b, nil
+	}
+
+	switch v.Kind() {
+	// containers
+	case reflect.Map:
+		return enc.encodeMap(b, ctx, v)
+	case reflect.Struct:
+		return enc.encodeStruct(b, ctx, v)
+	case reflect.Slice:
+		return enc.encodeSlice(b, ctx, v)
+	case reflect.Interface:
+		if v.IsNil() {
+			return nil, fmt.Errorf("toml: encoding a nil interface is not supported")
+		}
+
+		return enc.encode(b, ctx, v.Elem())
+	case reflect.Ptr:
+		if v.IsNil() {
+			return enc.encode(b, ctx, reflect.Zero(v.Type().Elem()))
+		}
+
+		return enc.encode(b, ctx, v.Elem())
+
+	// values
+	case reflect.String:
+		b = enc.encodeString(b, v.String(), ctx.options)
+	case reflect.Float32:
+		b = strconv.AppendFloat(b, v.Float(), 'f', -1, 32)
+	case reflect.Float64:
+		b = strconv.AppendFloat(b, v.Float(), 'f', -1, 64)
+	case reflect.Bool:
+		if v.Bool() {
+			b = append(b, "true"...)
+		} else {
+			b = append(b, "false"...)
+		}
+	case reflect.Uint64, reflect.Uint32, reflect.Uint16, reflect.Uint8, reflect.Uint:
+		b = strconv.AppendUint(b, v.Uint(), 10)
+	case reflect.Int64, reflect.Int32, reflect.Int16, reflect.Int8, reflect.Int:
+		b = strconv.AppendInt(b, v.Int(), 10)
+	default:
+		return nil, fmt.Errorf("toml: cannot encode value of type %s", v.Kind())
+	}
+
+	return b, nil
+}
+
+func isNil(v reflect.Value) bool {
+	switch v.Kind() {
+	case reflect.Ptr, reflect.Interface, reflect.Map:
+		return v.IsNil()
+	default:
+		return false
+	}
+}
+
+func (enc *Encoder) encodeKv(b []byte, ctx encoderCtx, options valueOptions, v reflect.Value) ([]byte, error) {
+	var err error
+
+	if !ctx.hasKey {
+		panic("caller of encodeKv should have set the key in the context")
+	}
+	b = enc.indent(ctx.indent, b)
+
+	b, err = enc.encodeKey(b, ctx.key)
+	if err != nil {
+		return nil, err
+	}
+
+	b = append(b, " = "...)
+
+	// create a copy of the context because the value of a KV shouldn't
+	// modify the global context.
+	subctx := ctx
+	subctx.insideKv = true
+	subctx.shiftKey()
+	subctx.options = options
+
+	b, err = enc.encode(b, subctx, v)
+	if err != nil {
+		return nil, err
+	}
+
+	return b, nil
+}
+
+const literalQuote = '\''
+
+func (enc *Encoder) encodeString(b []byte, v string, options valueOptions) []byte {
+	if needsQuoting(v) {
+		return enc.encodeQuotedString(options.multiline, b, v)
+	}
+
+	return enc.encodeLiteralString(b, v)
+}
+
+func needsQuoting(v string) bool {
+	return strings.ContainsAny(v, "'\b\f\n\r\t")
+}
+
+// caller should have checked that the string does not contain new lines or ' .
+func (enc *Encoder) encodeLiteralString(b []byte, v string) []byte {
+	b = append(b, literalQuote)
+	b = append(b, v...)
+	b = append(b, literalQuote)
+
+	return b
+}
+
+//nolint:cyclop
+func (enc *Encoder) encodeQuotedString(multiline bool, b []byte, v string) []byte {
+	stringQuote := `"`
+
+	if multiline {
+		stringQuote = `"""`
+	}
+
+	b = append(b, stringQuote...)
+	if multiline {
+		b = append(b, '\n')
+	}
+
+	const (
+		hextable = "0123456789ABCDEF"
+		// U+0000 to U+0008, U+000A to U+001F, U+007F
+		nul = 0x0
+		bs  = 0x8
+		lf  = 0xa
+		us  = 0x1f
+		del = 0x7f
+	)
+
+	for _, r := range []byte(v) {
+		switch r {
+		case '\\':
+			b = append(b, `\\`...)
+		case '"':
+			b = append(b, `\"`...)
+		case '\b':
+			b = append(b, `\b`...)
+		case '\f':
+			b = append(b, `\f`...)
+		case '\n':
+			if multiline {
+				b = append(b, r)
+			} else {
+				b = append(b, `\n`...)
+			}
+		case '\r':
+			b = append(b, `\r`...)
+		case '\t':
+			b = append(b, `\t`...)
+		default:
+			switch {
+			case r >= nul && r <= bs, r >= lf && r <= us, r == del:
+				b = append(b, `\u00`...)
+				b = append(b, hextable[r>>4])
+				b = append(b, hextable[r&0x0f])
+			default:
+				b = append(b, r)
+			}
+		}
+	}
+
+	b = append(b, stringQuote...)
+
+	return b
+}
+
+// called should have checked that the string is in A-Z / a-z / 0-9 / - / _ .
+func (enc *Encoder) encodeUnquotedKey(b []byte, v string) []byte {
+	return append(b, v...)
+}
+
+func (enc *Encoder) encodeTableHeader(ctx encoderCtx, b []byte) ([]byte, error) {
+	if len(ctx.parentKey) == 0 {
+		return b, nil
+	}
+
+	b = enc.indent(ctx.indent, b)
+
+	b = append(b, '[')
+
+	var err error
+
+	b, err = enc.encodeKey(b, ctx.parentKey[0])
+	if err != nil {
+		return nil, err
+	}
+
+	for _, k := range ctx.parentKey[1:] {
+		b = append(b, '.')
+
+		b, err = enc.encodeKey(b, k)
+		if err != nil {
+			return nil, err
+		}
+	}
+
+	b = append(b, "]\n"...)
+
+	return b, nil
+}
+
+//nolint:cyclop
+func (enc *Encoder) encodeKey(b []byte, k string) ([]byte, error) {
+	needsQuotation := false
+	cannotUseLiteral := false
+
+	for _, c := range k {
+		if (c >= 'A' && c <= 'Z') || (c >= 'a' && c <= 'z') || (c >= '0' && c <= '9') || c == '-' || c == '_' {
+			continue
+		}
+
+		if c == '\n' {
+			return nil, fmt.Errorf("toml: new line characters in keys are not supported")
+		}
+
+		if c == literalQuote {
+			cannotUseLiteral = true
+		}
+
+		needsQuotation = true
+	}
+
+	switch {
+	case cannotUseLiteral:
+		return enc.encodeQuotedString(false, b, k), nil
+	case needsQuotation:
+		return enc.encodeLiteralString(b, k), nil
+	default:
+		return enc.encodeUnquotedKey(b, k), nil
+	}
+}
+
+func (enc *Encoder) encodeMap(b []byte, ctx encoderCtx, v reflect.Value) ([]byte, error) {
+	if v.Type().Key().Kind() != reflect.String {
+		return nil, fmt.Errorf("toml: type %s is not supported as a map key", v.Type().Key().Kind())
+	}
+
+	var (
+		t                 table
+		emptyValueOptions valueOptions
+	)
+
+	iter := v.MapRange()
+	for iter.Next() {
+		k := iter.Key().String()
+		v := iter.Value()
+
+		if isNil(v) {
+			continue
+		}
+
+		if willConvertToTableOrArrayTable(ctx, v) {
+			t.pushTable(k, v, emptyValueOptions)
+		} else {
+			t.pushKV(k, v, emptyValueOptions)
+		}
+	}
+
+	sortEntriesByKey(t.kvs)
+	sortEntriesByKey(t.tables)
+
+	return enc.encodeTable(b, ctx, t)
+}
+
+func sortEntriesByKey(e []entry) {
+	sort.Slice(e, func(i, j int) bool {
+		return e[i].Key < e[j].Key
+	})
+}
+
+type entry struct {
+	Key     string
+	Value   reflect.Value
+	Options valueOptions
+}
+
+type table struct {
+	kvs    []entry
+	tables []entry
+}
+
+func (t *table) pushKV(k string, v reflect.Value, options valueOptions) {
+	t.kvs = append(t.kvs, entry{Key: k, Value: v, Options: options})
+}
+
+func (t *table) pushTable(k string, v reflect.Value, options valueOptions) {
+	t.tables = append(t.tables, entry{Key: k, Value: v, Options: options})
+}
+
+func (enc *Encoder) encodeStruct(b []byte, ctx encoderCtx, v reflect.Value) ([]byte, error) {
+	var t table
+
+	//nolint:godox
+	// TODO: cache this?
+	typ := v.Type()
+	for i := 0; i < typ.NumField(); i++ {
+		fieldType := typ.Field(i)
+
+		// only consider exported fields
+		if fieldType.PkgPath != "" {
+			continue
+		}
+
+		k, ok := fieldType.Tag.Lookup("toml")
+		if !ok {
+			k = fieldType.Name
+		}
+
+		// special field name to skip field
+		if k == "-" {
+			continue
+		}
+
+		f := v.Field(i)
+
+		if isNil(f) {
+			continue
+		}
+
+		options := valueOptions{
+			multiline: fieldBoolTag(fieldType, "multiline"),
+		}
+
+		inline := fieldBoolTag(fieldType, "inline")
+
+		if inline || !willConvertToTableOrArrayTable(ctx, f) {
+			t.pushKV(k, f, options)
+		} else {
+			t.pushTable(k, f, options)
+		}
+	}
+
+	return enc.encodeTable(b, ctx, t)
+}
+
+func fieldBoolTag(field reflect.StructField, tag string) bool {
+	x, ok := field.Tag.Lookup(tag)
+
+	return ok && x == "true"
+}
+
+//nolint:cyclop
+func (enc *Encoder) encodeTable(b []byte, ctx encoderCtx, t table) ([]byte, error) {
+	var err error
+
+	ctx.shiftKey()
+
+	if ctx.insideKv || (ctx.inline && !ctx.isRoot()) {
+		return enc.encodeTableInline(b, ctx, t)
+	}
+
+	if !ctx.skipTableHeader {
+		b, err = enc.encodeTableHeader(ctx, b)
+		if err != nil {
+			return nil, err
+		}
+
+		if enc.indentTables && len(ctx.parentKey) > 0 {
+			ctx.indent++
+		}
+	}
+	ctx.skipTableHeader = false
+
+	for _, kv := range t.kvs {
+		ctx.setKey(kv.Key)
+
+		b, err = enc.encodeKv(b, ctx, kv.Options, kv.Value)
+		if err != nil {
+			return nil, err
+		}
+
+		b = append(b, '\n')
+	}
+
+	for _, table := range t.tables {
+		ctx.setKey(table.Key)
+
+		ctx.options = table.Options
+
+		b, err = enc.encode(b, ctx, table.Value)
+		if err != nil {
+			return nil, err
+		}
+
+		b = append(b, '\n')
+	}
+
+	return b, nil
+}
+
+func (enc *Encoder) encodeTableInline(b []byte, ctx encoderCtx, t table) ([]byte, error) {
+	var err error
+
+	b = append(b, '{')
+
+	first := true
+	for _, kv := range t.kvs {
+		if first {
+			first = false
+		} else {
+			b = append(b, `, `...)
+		}
+
+		ctx.setKey(kv.Key)
+
+		b, err = enc.encodeKv(b, ctx, kv.Options, kv.Value)
+		if err != nil {
+			return nil, err
+		}
+	}
+
+	if len(t.tables) > 0 {
+		panic("inline table cannot contain nested tables, online key-values")
+	}
+
+	b = append(b, "}"...)
+
+	return b, nil
+}
+
+var textMarshalerType = reflect.TypeOf(new(encoding.TextMarshaler)).Elem()
+
+func willConvertToTable(ctx encoderCtx, v reflect.Value) bool {
+	if v.Type() == timeType || v.Type().Implements(textMarshalerType) {
+		return false
+	}
+
+	t := v.Type()
+	switch t.Kind() {
+	case reflect.Map, reflect.Struct:
+		return !ctx.inline
+	case reflect.Interface:
+		return willConvertToTable(ctx, v.Elem())
+	case reflect.Ptr:
+		if v.IsNil() {
+			return false
+		}
+
+		return willConvertToTable(ctx, v.Elem())
+	default:
+		return false
+	}
+}
+
+func willConvertToTableOrArrayTable(ctx encoderCtx, v reflect.Value) bool {
+	t := v.Type()
+
+	if t.Kind() == reflect.Interface {
+		return willConvertToTableOrArrayTable(ctx, v.Elem())
+	}
+
+	if t.Kind() == reflect.Slice {
+		if v.Len() == 0 {
+			// An empty slice should be a kv = [].
+			return false
+		}
+
+		for i := 0; i < v.Len(); i++ {
+			t := willConvertToTable(ctx, v.Index(i))
+
+			if !t {
+				return false
+			}
+		}
+
+		return true
+	}
+
+	return willConvertToTable(ctx, v)
+}
+
+func (enc *Encoder) encodeSlice(b []byte, ctx encoderCtx, v reflect.Value) ([]byte, error) {
+	if v.Len() == 0 {
+		b = append(b, "[]"...)
+
+		return b, nil
+	}
+
+	if willConvertToTableOrArrayTable(ctx, v) {
+		return enc.encodeSliceAsArrayTable(b, ctx, v)
+	}
+
+	return enc.encodeSliceAsArray(b, ctx, v)
+}
+
+// caller should have checked that v is a slice that only contains values that
+// encode into tables.
+func (enc *Encoder) encodeSliceAsArrayTable(b []byte, ctx encoderCtx, v reflect.Value) ([]byte, error) {
+	ctx.shiftKey()
+
+	var err error
+	scratch := make([]byte, 0, 64)
+	scratch = append(scratch, "[["...)
+
+	for i, k := range ctx.parentKey {
+		if i > 0 {
+			scratch = append(scratch, '.')
+		}
+
+		scratch, err = enc.encodeKey(scratch, k)
+		if err != nil {
+			return nil, err
+		}
+	}
+
+	scratch = append(scratch, "]]\n"...)
+	ctx.skipTableHeader = true
+
+	for i := 0; i < v.Len(); i++ {
+		b = append(b, scratch...)
+
+		b, err = enc.encode(b, ctx, v.Index(i))
+		if err != nil {
+			return nil, err
+		}
+	}
+
+	return b, nil
+}
+
+func (enc *Encoder) encodeSliceAsArray(b []byte, ctx encoderCtx, v reflect.Value) ([]byte, error) {
+	multiline := ctx.options.multiline || enc.arraysMultiline
+	separator := ", "
+
+	b = append(b, '[')
+
+	subCtx := ctx
+	subCtx.options = valueOptions{}
+
+	if multiline {
+		separator = ",\n"
+
+		b = append(b, '\n')
+
+		subCtx.indent++
+	}
+
+	var err error
+	first := true
+
+	for i := 0; i < v.Len(); i++ {
+		if first {
+			first = false
+		} else {
+			b = append(b, separator...)
+		}
+
+		if multiline {
+			b = enc.indent(subCtx.indent, b)
+		}
+
+		b, err = enc.encode(b, subCtx, v.Index(i))
+		if err != nil {
+			return nil, err
+		}
+	}
+
+	if multiline {
+		b = append(b, '\n')
+		b = enc.indent(ctx.indent, b)
+	}
+
+	b = append(b, ']')
+
+	return b, nil
+}
+
+func (enc *Encoder) indent(level int, b []byte) []byte {
+	for i := 0; i < level; i++ {
+		b = append(b, enc.indentSymbol...)
+	}
+
+	return b
+}

marshaler_test.go

@@ -0,0 +1,830 @@
+package toml_test
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"strings"
+	"testing"
+
+	"github.com/pelletier/go-toml/v2"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+//nolint:funlen
+func TestMarshal(t *testing.T) {
+	t.Parallel()
+
+	someInt := 42
+
+	type structInline struct {
+		A interface{} `inline:"true"`
+	}
+
+	examples := []struct {
+		desc     string
+		v        interface{}
+		expected string
+		err      bool
+	}{
+		{
+			desc: "simple map and string",
+			v: map[string]string{
+				"hello": "world",
+			},
+			expected: "hello = 'world'",
+		},
+		{
+			desc: "map with new line in key",
+			v: map[string]string{
+				"hel\nlo": "world",
+			},
+			err: true,
+		},
+		{
+			desc: `map with " in key`,
+			v: map[string]string{
+				`hel"lo`: "world",
+			},
+			expected: `'hel"lo' = 'world'`,
+		},
+		{
+			desc: "map in map and string",
+			v: map[string]map[string]string{
+				"table": {
+					"hello": "world",
+				},
+			},
+			expected: `
+[table]
+hello = 'world'`,
+		},
+		{
+			desc: "map in map in map and string",
+			v: map[string]map[string]map[string]string{
+				"this": {
+					"is": {
+						"a": "test",
+					},
+				},
+			},
+			expected: `
+[this]
+[this.is]
+a = 'test'`,
+		},
+		{
+			desc: "map in map in map and string with values",
+			v: map[string]interface{}{
+				"this": map[string]interface{}{
+					"is": map[string]string{
+						"a": "test",
+					},
+					"also": "that",
+				},
+			},
+			expected: `
+[this]
+also = 'that'
+[this.is]
+a = 'test'`,
+		},
+		{
+			desc: "simple string array",
+			v: map[string][]string{
+				"array": {"one", "two", "three"},
+			},
+			expected: `array = ['one', 'two', 'three']`,
+		},
+		{
+			desc:     "empty string array",
+			v:        map[string][]string{},
+			expected: ``,
+		},
+		{
+			desc:     "map",
+			v:        map[string][]string{},
+			expected: ``,
+		},
+		{
+			desc: "nested string arrays",
+			v: map[string][][]string{
+				"array": {{"one", "two"}, {"three"}},
+			},
+			expected: `array = [['one', 'two'], ['three']]`,
+		},
+		{
+			desc: "mixed strings and nested string arrays",
+			v: map[string][]interface{}{
+				"array": {"a string", []string{"one", "two"}, "last"},
+			},
+			expected: `array = ['a string', ['one', 'two'], 'last']`,
+		},
+		{
+			desc: "array of maps",
+			v: map[string][]map[string]string{
+				"top": {
+					{"map1.1": "v1.1"},
+					{"map2.1": "v2.1"},
+				},
+			},
+			expected: `
+[[top]]
+'map1.1' = 'v1.1'
+[[top]]
+'map2.1' = 'v2.1'
+`,
+		},
+		{
+			desc: "map with two keys",
+			v: map[string]string{
+				"key1": "value1",
+				"key2": "value2",
+			},
+			expected: `
+key1 = 'value1'
+key2 = 'value2'`,
+		},
+		{
+			desc: "simple struct",
+			v: struct {
+				A string
+			}{
+				A: "foo",
+			},
+			expected: `A = 'foo'`,
+		},
+		{
+			desc: "one level of structs within structs",
+			v: struct {
+				A interface{}
+			}{
+				A: struct {
+					K1 string
+					K2 string
+				}{
+					K1: "v1",
+					K2: "v2",
+				},
+			},
+			expected: `
+[A]
+K1 = 'v1'
+K2 = 'v2'
+`,
+		},
+		{
+			desc: "structs in array with interfaces",
+			v: map[string]interface{}{
+				"root": map[string]interface{}{
+					"nested": []interface{}{
+						map[string]interface{}{"name": "Bob"},
+						map[string]interface{}{"name": "Alice"},
+					},
+				},
+			},
+			expected: `
+[root]
+[[root.nested]]
+name = 'Bob'
+[[root.nested]]
+name = 'Alice'
+`,
+		},
+		{
+			desc: "string escapes",
+			v: map[string]interface{}{
+				"a": `'"\`,
+			},
+			expected: `a = "'\"\\"`,
+		},
+		{
+			desc: "string utf8 low",
+			v: map[string]interface{}{
+				"a": "'Ę",
+			},
+			expected: `a = "'Ę"`,
+		},
+		{
+			desc: "string utf8 low 2",
+			v: map[string]interface{}{
+				"a": "'\u10A85",
+			},
+			expected: "a = \"'\u10A85\"",
+		},
+		{
+			desc: "string utf8 low 2",
+			v: map[string]interface{}{
+				"a": "'\u10A85",
+			},
+			expected: "a = \"'\u10A85\"",
+		},
+		{
+			desc: "emoji",
+			v: map[string]interface{}{
+				"a": "'😀",
+			},
+			expected: "a = \"'😀\"",
+		},
+		{
+			desc: "control char",
+			v: map[string]interface{}{
+				"a": "'\u001A",
+			},
+			expected: `a = "'\u001A"`,
+		},
+		{
+			desc: "multi-line string",
+			v: map[string]interface{}{
+				"a": "hello\nworld",
+			},
+			expected: `a = "hello\nworld"`,
+		},
+		{
+			desc: "multi-line forced",
+			v: struct {
+				A string `multiline:"true"`
+			}{
+				A: "hello\nworld",
+			},
+			expected: `A = """
+hello
+world"""`,
+		},
+		{
+			desc: "inline field",
+			v: struct {
+				A map[string]string `inline:"true"`
+				B map[string]string
+			}{
+				A: map[string]string{
+					"isinline": "yes",
+				},
+				B: map[string]string{
+					"isinline": "no",
+				},
+			},
+			expected: `
+A = {isinline = 'yes'}
+[B]
+isinline = 'no'
+`,
+		},
+		{
+			desc: "mutiline array int",
+			v: struct {
+				A []int `multiline:"true"`
+				B []int
+			}{
+				A: []int{1, 2, 3, 4},
+				B: []int{1, 2, 3, 4},
+			},
+			expected: `
+A = [
+  1,
+  2,
+  3,
+  4
+]
+B = [1, 2, 3, 4]
+`,
+		},
+		{
+			desc: "mutiline array in array",
+			v: struct {
+				A [][]int `multiline:"true"`
+			}{
+				A: [][]int{{1, 2}, {3, 4}},
+			},
+			expected: `
+A = [
+  [1, 2],
+  [3, 4]
+]
+`,
+		},
+		{
+			desc: "nil interface not supported at root",
+			v:    nil,
+			err:  true,
+		},
+		{
+			desc: "nil interface not supported in slice",
+			v: map[string]interface{}{
+				"a": []interface{}{"a", nil, 2},
+			},
+			err: true,
+		},
+		{
+			desc: "nil pointer in slice uses zero value",
+			v: struct {
+				A []*int
+			}{
+				A: []*int{nil},
+			},
+			expected: `A = [0]`,
+		},
+		{
+			desc: "nil pointer in slice uses zero value",
+			v: struct {
+				A []*int
+			}{
+				A: []*int{nil},
+			},
+			expected: `A = [0]`,
+		},
+		{
+			desc: "pointer in slice",
+			v: struct {
+				A []*int
+			}{
+				A: []*int{&someInt},
+			},
+			expected: `A = [42]`,
+		},
+		{
+			desc: "inline table in inline table",
+			v: structInline{
+				A: structInline{
+					A: structInline{
+						A: "hello",
+					},
+				},
+			},
+			expected: `A = {A = {A = 'hello'}}`,
+		},
+		{
+			desc: "empty slice in map",
+			v: map[string][]string{
+				"a": {},
+			},
+			expected: `a = []`,
+		},
+		{
+			desc: "map in slice",
+			v: map[string][]map[string]string{
+				"a": {{"hello": "world"}},
+			},
+			expected: `
+[[a]]
+hello = 'world'`,
+		},
+		{
+			desc: "newline in map in slice",
+			v: map[string][]map[string]string{
+				"a\n": {{"hello": "world"}},
+			},
+			err: true,
+		},
+		{
+			desc: "newline in map in slice",
+			v: map[string][]map[string]*customTextMarshaler{
+				"a": {{"hello": &customTextMarshaler{1}}},
+			},
+			err: true,
+		},
+		{
+			desc: "empty slice of empty struct",
+			v: struct {
+				A []struct{}
+			}{
+				A: []struct{}{},
+			},
+			expected: `A = []`,
+		},
+		{
+			desc: "nil field is ignored",
+			v: struct {
+				A interface{}
+			}{
+				A: nil,
+			},
+			expected: ``,
+		},
+		{
+			desc: "private fields are ignored",
+			v: struct {
+				Public  string
+				private string
+			}{
+				Public:  "shown",
+				private: "hidden",
+			},
+			expected: `Public = 'shown'`,
+		},
+		{
+			desc: "fields tagged - are ignored",
+			v: struct {
+				Public  string `toml:"-"`
+				private string
+			}{
+				Public: "hidden",
+			},
+			expected: ``,
+		},
+		{
+			desc: "nil value in map is ignored",
+			v: map[string]interface{}{
+				"A": nil,
+			},
+			expected: ``,
+		},
+		{
+			desc: "new line in table key",
+			v: map[string]interface{}{
+				"hello\nworld": 42,
+			},
+			err: true,
+		},
+		{
+			desc: "new line in parent of nested table key",
+			v: map[string]interface{}{
+				"hello\nworld": map[string]interface{}{
+					"inner": 42,
+				},
+			},
+			err: true,
+		},
+		{
+			desc: "new line in nested table key",
+			v: map[string]interface{}{
+				"parent": map[string]interface{}{
+					"in\ner": map[string]interface{}{
+						"foo": 42,
+					},
+				},
+			},
+			err: true,
+		},
+		{
+			desc: "invalid map key",
+			v:    map[int]interface{}{},
+			err:  true,
+		},
+		{
+			desc: "unhandled type",
+			v: struct {
+				A chan int
+			}{
+				A: make(chan int),
+			},
+			err: true,
+		},
+		{
+			desc: "numbers",
+			v: struct {
+				A float32
+				B uint64
+				C uint32
+				D uint16
+				E uint8
+				F uint
+				G int64
+				H int32
+				I int16
+				J int8
+				K int
+			}{
+				A: 1.1,
+				B: 42,
+				C: 42,
+				D: 42,
+				E: 42,
+				F: 42,
+				G: 42,
+				H: 42,
+				I: 42,
+				J: 42,
+				K: 42,
+			},
+			expected: `
+A = 1.1
+B = 42
+C = 42
+D = 42
+E = 42
+F = 42
+G = 42
+H = 42
+I = 42
+J = 42
+K = 42`,
+		},
+	}
+
+	for _, e := range examples {
+		e := e
+		t.Run(e.desc, func(t *testing.T) {
+			t.Parallel()
+
+			b, err := toml.Marshal(e.v)
+			if e.err {
+				require.Error(t, err)
+
+				return
+			}
+
+			require.NoError(t, err)
+			equalStringsIgnoreNewlines(t, e.expected, string(b))
+
+			// make sure the output is always valid TOML
+			defaultMap := map[string]interface{}{}
+			err = toml.Unmarshal(b, &defaultMap)
+			require.NoError(t, err)
+
+			testWithAllFlags(t, func(t *testing.T, flags int) {
+				t.Helper()
+
+				var buf bytes.Buffer
+				enc := toml.NewEncoder(&buf)
+				setFlags(enc, flags)
+
+				err := enc.Encode(e.v)
+				require.NoError(t, err)
+
+				inlineMap := map[string]interface{}{}
+				err = toml.Unmarshal(buf.Bytes(), &inlineMap)
+				require.NoError(t, err)
+
+				require.Equal(t, defaultMap, inlineMap)
+			})
+		})
+	}
+}
+
+type flagsSetters []struct {
+	name string
+	f    func(enc *toml.Encoder, flag bool)
+}
+
+var allFlags = flagsSetters{
+	{"arrays-multiline", (*toml.Encoder).SetArraysMultiline},
+	{"tables-inline", (*toml.Encoder).SetTablesInline},
+	{"indent-tables", (*toml.Encoder).SetIndentTables},
+}
+
+func setFlags(enc *toml.Encoder, flags int) {
+	for i := 0; i < len(allFlags); i++ {
+		enabled := flags&1 > 0
+		allFlags[i].f(enc, enabled)
+	}
+}
+
+func testWithAllFlags(t *testing.T, testfn func(t *testing.T, flags int)) {
+	t.Helper()
+	testWithFlags(t, 0, allFlags, testfn)
+}
+
+func testWithFlags(t *testing.T, flags int, setters flagsSetters, testfn func(t *testing.T, flags int)) {
+	t.Helper()
+
+	if len(setters) == 0 {
+		testfn(t, flags)
+
+		return
+	}
+
+	s := setters[0]
+
+	for _, enabled := range []bool{false, true} {
+		name := fmt.Sprintf("%s=%t", s.name, enabled)
+		newFlags := flags << 1
+
+		if enabled {
+			newFlags++
+		}
+
+		t.Run(name, func(t *testing.T) {
+			testWithFlags(t, newFlags, setters[1:], testfn)
+		})
+	}
+}
+
+func equalStringsIgnoreNewlines(t *testing.T, expected string, actual string) {
+	t.Helper()
+	cutset := "\n"
+	assert.Equal(t, strings.Trim(expected, cutset), strings.Trim(actual, cutset))
+}
+
+//nolint:funlen
+func TestMarshalIndentTables(t *testing.T) {
+	t.Parallel()
+
+	examples := []struct {
+		desc     string
+		v        interface{}
+		expected string
+	}{
+		{
+			desc: "one kv",
+			v: map[string]interface{}{
+				"foo": "bar",
+			},
+			expected: `foo = 'bar'`,
+		},
+		{
+			desc: "one level table",
+			v: map[string]map[string]string{
+				"foo": {
+					"one": "value1",
+					"two": "value2",
+				},
+			},
+			expected: `
+[foo]
+  one = 'value1'
+  two = 'value2'
+`,
+		},
+		{
+			desc: "two levels table",
+			v: map[string]interface{}{
+				"root": "value0",
+				"level1": map[string]interface{}{
+					"one": "value1",
+					"level2": map[string]interface{}{
+						"two": "value2",
+					},
+				},
+			},
+			expected: `
+root = 'value0'
+[level1]
+  one = 'value1'
+  [level1.level2]
+    two = 'value2'
+`,
+		},
+	}
+
+	for _, e := range examples {
+		e := e
+		t.Run(e.desc, func(t *testing.T) {
+			t.Parallel()
+
+			var buf strings.Builder
+			enc := toml.NewEncoder(&buf)
+			enc.SetIndentTables(true)
+			err := enc.Encode(e.v)
+			require.NoError(t, err)
+			equalStringsIgnoreNewlines(t, e.expected, buf.String())
+		})
+	}
+}
+
+type customTextMarshaler struct {
+	value int64
+}
+
+func (c *customTextMarshaler) MarshalText() ([]byte, error) {
+	if c.value == 1 {
+		return nil, fmt.Errorf("cannot represent 1 because this is a silly test")
+	}
+	return []byte(fmt.Sprintf("::%d", c.value)), nil
+}
+
+func TestMarshalTextMarshaler_NoRoot(t *testing.T) {
+	t.Parallel()
+
+	c := customTextMarshaler{}
+	_, err := toml.Marshal(&c)
+	require.Error(t, err)
+}
+
+func TestMarshalTextMarshaler_Error(t *testing.T) {
+	t.Parallel()
+
+	m := map[string]interface{}{"a": &customTextMarshaler{value: 1}}
+	_, err := toml.Marshal(m)
+	require.Error(t, err)
+}
+
+func TestMarshalTextMarshaler_ErrorInline(t *testing.T) {
+	t.Parallel()
+
+	type s struct {
+		A map[string]interface{} `inline:"true"`
+	}
+
+	d := s{
+		A: map[string]interface{}{"a": &customTextMarshaler{value: 1}},
+	}
+
+	_, err := toml.Marshal(d)
+	require.Error(t, err)
+}
+
+func TestMarshalTextMarshaler(t *testing.T) {
+	t.Parallel()
+
+	m := map[string]interface{}{"a": &customTextMarshaler{value: 2}}
+	r, err := toml.Marshal(m)
+	require.NoError(t, err)
+	equalStringsIgnoreNewlines(t, "a = '::2'", string(r))
+}
+
+type brokenWriter struct{}
+
+func (b *brokenWriter) Write([]byte) (int, error) {
+	return 0, fmt.Errorf("dead")
+}
+
+func TestEncodeToBrokenWriter(t *testing.T) {
+	t.Parallel()
+	w := brokenWriter{}
+	enc := toml.NewEncoder(&w)
+	err := enc.Encode(map[string]string{"hello": "world"})
+	require.Error(t, err)
+}
+
+func TestEncoderSetIndentSymbol(t *testing.T) {
+	t.Parallel()
+	var w strings.Builder
+	enc := toml.NewEncoder(&w)
+	enc.SetIndentTables(true)
+	enc.SetIndentSymbol(">>>")
+	err := enc.Encode(map[string]map[string]string{"parent": {"hello": "world"}})
+	require.NoError(t, err)
+	expected := `
+[parent]
+>>>hello = 'world'`
+	equalStringsIgnoreNewlines(t, expected, w.String())
+}
+
+func TestIssue436(t *testing.T) {
+	t.Parallel()
+
+	data := []byte(`{"a": [ { "b": { "c": "d" } } ]}`)
+
+	var v interface{}
+	err := json.Unmarshal(data, &v)
+	require.NoError(t, err)
+
+	var buf bytes.Buffer
+	err = toml.NewEncoder(&buf).Encode(v)
+	require.NoError(t, err)
+
+	expected := `
+[[a]]
+[a.b]
+c = 'd'
+`
+	equalStringsIgnoreNewlines(t, expected, buf.String())
+}
+
+func TestIssue424(t *testing.T) {
+	t.Parallel()
+
+	type Message1 struct {
+		Text string
+	}
+
+	type Message2 struct {
+		Text string `multiline:"true"`
+	}
+
+	msg1 := Message1{"Hello\\World"}
+	msg2 := Message2{"Hello\\World"}
+
+	toml1, err := toml.Marshal(msg1)
+	require.NoError(t, err)
+
+	toml2, err := toml.Marshal(msg2)
+	require.NoError(t, err)
+
+	msg1parsed := Message1{}
+	err = toml.Unmarshal(toml1, &msg1parsed)
+	require.NoError(t, err)
+	require.Equal(t, msg1, msg1parsed)
+
+	msg2parsed := Message2{}
+	err = toml.Unmarshal(toml2, &msg2parsed)
+	require.NoError(t, err)
+	require.Equal(t, msg2, msg2parsed)
+}
+
+func ExampleMarshal() {
+	type MyConfig struct {
+		Version int
+		Name    string
+		Tags    []string
+	}
+
+	cfg := MyConfig{
+		Version: 2,
+		Name:    "go-toml",
+		Tags:    []string{"go", "toml"},
+	}
+
+	b, err := toml.Marshal(cfg)
+	if err != nil {
+		panic(err)
+	}
+	fmt.Println(string(b))
+
+	// Output:
+	// Version = 2
+	// Name = 'go-toml'
+	// Tags = ['go', 'toml']
+}

position.go

@@ -1,29 +0,0 @@
-// Position support for go-toml
-
-package toml
-
-import (
-	"fmt"
-)
-
-// Position of a document element within a TOML document.
-//
-// Line and Col are both 1-indexed positions for the element's line number and
-// column number, respectively.  Values of zero or less will cause Invalid(),
-// to return true.
-type Position struct {
-	Line int // line within the document
-	Col  int // column within the line
-}
-
-// String representation of the position.
-// Displays 1-indexed line and column numbers.
-func (p Position) String() string {
-	return fmt.Sprintf("(%d, %d)", p.Line, p.Col)
-}
-
-// Invalid returns whether or not the position is valid (i.e. with negative or
-// null values)
-func (p Position) Invalid() bool {
-	return p.Line <= 0 || p.Col <= 0
-}

position_test.go

@@ -1,29 +0,0 @@
-// Testing support for go-toml
-
-package toml
-
-import (
-	"testing"
-)
-
-func TestPositionString(t *testing.T) {
-	p := Position{123, 456}
-	expected := "(123, 456)"
-	value := p.String()
-
-	if value != expected {
-		t.Errorf("Expected %v, got %v instead", expected, value)
-	}
-}
-
-func TestInvalid(t *testing.T) {
-	for i, v := range []Position{
-		{0, 1234},
-		{1234, 0},
-		{0, 0},
-	} {
-		if !v.Invalid() {
-			t.Errorf("Position at %v is valid: %v", i, v)
-		}
-	}
-}

query/README.md

@@ -1,201 +0,0 @@
-# Query package
-
-## Overview
-
-Package query performs JSONPath-like queries on a TOML document.
-
-The query path implementation is based loosely on the JSONPath specification:
-http://goessner.net/articles/JsonPath/.
-
-The idea behind a query path is to allow quick access to any element, or set
-of elements within TOML document, with a single expression.
-
-```go
-result, err := query.CompileAndExecute("$.foo.bar.baz", tree)
-```
-
-This is roughly equivalent to:
-
-```go
-next := tree.Get("foo")
-if next != nil {
-    next = next.Get("bar")
-    if next != nil {
-        next = next.Get("baz")
-    }
-}
-result := next
-```
-
-err is nil if any parsing exception occurs.
-
-If no node in the tree matches the query, result will simply contain an empty list of
-items.
-
-As illustrated above, the query path is much more efficient, especially since
-the structure of the TOML file can vary. Rather than making assumptions about
-a document's structure, a query allows the programmer to make structured
-requests into the document, and get zero or more values as a result.
-
-## Query syntax
-
-The syntax of a query begins with a root token, followed by any number
-sub-expressions:
-
-```
-$
-                    Root of the TOML tree. This must always come first.
-.name
-                    Selects child of this node, where 'name' is a TOML key
-                    name.
-['name']
-                    Selects child of this node, where 'name' is a string
-                    containing a TOML key name.
-[index]
-                    Selcts child array element at 'index'.
-..expr
-                    Recursively selects all children, filtered by an a union,
-                    index, or slice expression.
-..*
-                    Recursive selection of all nodes at this point in the
-                    tree.
-.*
-                    Selects all children of the current node.
-[expr,expr]
-                    Union operator - a logical 'or' grouping of two or more
-                    sub-expressions: index, key name, or filter.
-[start:end:step]
-                    Slice operator - selects array elements from start to
-                    end-1, at the given step. All three arguments are
-                    optional.
-[?(filter)]
-                    Named filter expression - the function 'filter' is
-                    used to filter children at this node.
-```
-
-## Query Indexes And Slices
-
-Index expressions perform no bounds checking, and will contribute no
-values to the result set if the provided index or index range is invalid.
-Negative indexes represent values from the end of the array, counting backwards.
-
-```go
-// select the last index of the array named 'foo'
-query.CompileAndExecute("$.foo[-1]", tree)
-```
-
-Slice expressions are supported, by using ':' to separate a start/end index pair.
-
-```go
-// select up to the first five elements in the array
-query.CompileAndExecute("$.foo[0:5]", tree)
-```
-
-Slice expressions also allow negative indexes for the start and stop
-arguments.
-
-```go
-// select all array elements except the last one.
-query.CompileAndExecute("$.foo[0:-1]", tree)
-```
-
-Slice expressions may have an optional stride/step parameter:
-
-```go
-// select every other element
-query.CompileAndExecute("$.foo[0::2]", tree)
-```
-
-Slice start and end parameters are also optional:
-
-```go
-// these are all equivalent and select all the values in the array
-query.CompileAndExecute("$.foo[:]", tree)
-query.CompileAndExecute("$.foo[::]", tree)
-query.CompileAndExecute("$.foo[::1]", tree)
-query.CompileAndExecute("$.foo[0:]", tree)
-query.CompileAndExecute("$.foo[0::]", tree)
-query.CompileAndExecute("$.foo[0::1]", tree)
-```
-
-## Query Filters
-
-Query filters are used within a Union [,] or single Filter [] expression.
-A filter only allows nodes that qualify through to the next expression,
-and/or into the result set.
-
-```go
-// returns children of foo that are permitted by the 'bar' filter.
-query.CompileAndExecute("$.foo[?(bar)]", tree)
-```
-
-There are several filters provided with the library:
-
-```
-tree
-        Allows nodes of type Tree.
-int
-        Allows nodes of type int64.
-float
-        Allows nodes of type float64.
-string
-        Allows nodes of type string.
-time
-        Allows nodes of type time.Time.
-bool
-        Allows nodes of type bool.
-```
-
-## Query Results
-
-An executed query returns a Result object. This contains the nodes
-in the TOML tree that qualify the query expression. Position information
-is also available for each value in the set.
-
-```go
-// display the results of a query
-results := query.CompileAndExecute("$.foo.bar.baz", tree)
-for idx, value := results.Values() {
-    fmt.Println("%v: %v", results.Positions()[idx], value)
-}
-```
-
-## Compiled Queries
-
-Queries may be executed directly on a Tree object, or compiled ahead
-of time and executed discretely. The former is more convenient, but has the
-penalty of having to recompile the query expression each time.
-
-```go
-// basic query
-results := query.CompileAndExecute("$.foo.bar.baz", tree)
-
-// compiled query
-query, err := toml.Compile("$.foo.bar.baz")
-results := query.Execute(tree)
-
-// run the compiled query again on a different tree
-moreResults := query.Execute(anotherTree)
-```
-
-## User Defined Query Filters
-
-Filter expressions may also be user defined by using the SetFilter()
-function on the Query object. The function must return true/false, which
-signifies if the passed node is kept or discarded, respectively.
-
-```go
-// create a query that references a user-defined filter
-query, _ := query.Compile("$[?(bazOnly)]")
-
-// define the filter, and assign it to the query
-query.SetFilter("bazOnly", func(node interface{}) bool{
-    if tree, ok := node.(*Tree); ok {
-        return tree.Has("baz")
-    }
-    return false // reject all other node types
-})
-
-// run the query
-query.Execute(tree)
-```

query/doc.go

@@ -1,173 +0,0 @@
-// Package query performs JSONPath-like queries on a TOML document.
-//
-// The query path implementation is based loosely on the JSONPath specification:
-// http://goessner.net/articles/JsonPath/.
-//
-// The idea behind a query path is to allow quick access to any element, or set
-// of elements within TOML document, with a single expression.
-//
-//   result, err := query.CompileAndExecute("$.foo.bar.baz", tree)
-//
-// This is roughly equivalent to:
-//
-//   next := tree.Get("foo")
-//   if next != nil {
-//     next = next.Get("bar")
-//     if next != nil {
-//       next = next.Get("baz")
-//     }
-//   }
-//   result := next
-//
-// err is nil if any parsing exception occurs.
-//
-// If no node in the tree matches the query, result will simply contain an empty list of
-// items.
-//
-// As illustrated above, the query path is much more efficient, especially since
-// the structure of the TOML file can vary. Rather than making assumptions about
-// a document's structure, a query allows the programmer to make structured
-// requests into the document, and get zero or more values as a result.
-//
-// Query syntax
-//
-// The syntax of a query begins with a root token, followed by any number
-// sub-expressions:
-//
-//   $
-//                    Root of the TOML tree. This must always come first.
-//   .name
-//                    Selects child of this node, where 'name' is a TOML key
-//                    name.
-//   ['name']
-//                    Selects child of this node, where 'name' is a string
-//                    containing a TOML key name.
-//   [index]
-//                    Selcts child array element at 'index'.
-//   ..expr
-//                    Recursively selects all children, filtered by an a union,
-//                    index, or slice expression.
-//   ..*
-//                    Recursive selection of all nodes at this point in the
-//                    tree.
-//   .*
-//                    Selects all children of the current node.
-//   [expr,expr]
-//                    Union operator - a logical 'or' grouping of two or more
-//                    sub-expressions: index, key name, or filter.
-//   [start:end:step]
-//                    Slice operator - selects array elements from start to
-//                    end-1, at the given step. All three arguments are
-//                    optional.
-//   [?(filter)]
-//                    Named filter expression - the function 'filter' is
-//                    used to filter children at this node.
-//
-// Query Indexes And Slices
-//
-// Index expressions perform no bounds checking, and will contribute no
-// values to the result set if the provided index or index range is invalid.
-// Negative indexes represent values from the end of the array, counting backwards.
-//
-//   // select the last index of the array named 'foo'
-//   query.CompileAndExecute("$.foo[-1]", tree)
-//
-// Slice expressions are supported, by using ':' to separate a start/end index pair.
-//
-//   // select up to the first five elements in the array
-//   query.CompileAndExecute("$.foo[0:5]", tree)
-//
-// Slice expressions also allow negative indexes for the start and stop
-// arguments.
-//
-//   // select all array elements except the last one.
-//   query.CompileAndExecute("$.foo[0:-1]", tree)
-//
-// Slice expressions may have an optional stride/step parameter:
-//
-//   // select every other element
-//   query.CompileAndExecute("$.foo[0::2]", tree)
-//
-// Slice start and end parameters are also optional:
-//
-//   // these are all equivalent and select all the values in the array
-//   query.CompileAndExecute("$.foo[:]", tree)
-//   query.CompileAndExecute("$.foo[::]", tree)
-//   query.CompileAndExecute("$.foo[::1]", tree)
-//   query.CompileAndExecute("$.foo[0:]", tree)
-//   query.CompileAndExecute("$.foo[0::]", tree)
-//   query.CompileAndExecute("$.foo[0::1]", tree)
-//
-// Query Filters
-//
-// Query filters are used within a Union [,] or single Filter [] expression.
-// A filter only allows nodes that qualify through to the next expression,
-// and/or into the result set.
-//
-//   // returns children of foo that are permitted by the 'bar' filter.
-//   query.CompileAndExecute("$.foo[?(bar)]", tree)
-//
-// There are several filters provided with the library:
-//
-//   tree
-//          Allows nodes of type Tree.
-//   int
-//          Allows nodes of type int64.
-//   float
-//          Allows nodes of type float64.
-//   string
-//          Allows nodes of type string.
-//   time
-//          Allows nodes of type time.Time.
-//   bool
-//          Allows nodes of type bool.
-//
-// Query Results
-//
-// An executed query returns a Result object. This contains the nodes
-// in the TOML tree that qualify the query expression. Position information
-// is also available for each value in the set.
-//
-//   // display the results of a query
-//   results := query.CompileAndExecute("$.foo.bar.baz", tree)
-//   for idx, value := results.Values() {
-//       fmt.Println("%v: %v", results.Positions()[idx], value)
-//   }
-//
-// Compiled Queries
-//
-// Queries may be executed directly on a Tree object, or compiled ahead
-// of time and executed discretely. The former is more convenient, but has the
-// penalty of having to recompile the query expression each time.
-//
-//   // basic query
-//   results := query.CompileAndExecute("$.foo.bar.baz", tree)
-//
-//   // compiled query
-//   query, err := toml.Compile("$.foo.bar.baz")
-//   results := query.Execute(tree)
-//
-//   // run the compiled query again on a different tree
-//   moreResults := query.Execute(anotherTree)
-//
-// User Defined Query Filters
-//
-// Filter expressions may also be user defined by using the SetFilter()
-// function on the Query object. The function must return true/false, which
-// signifies if the passed node is kept or discarded, respectively.
-//
-//   // create a query that references a user-defined filter
-//   query, _ := query.Compile("$[?(bazOnly)]")
-//
-//   // define the filter, and assign it to the query
-//   query.SetFilter("bazOnly", func(node interface{}) bool{
-//       if tree, ok := node.(*Tree); ok {
-//           return tree.Has("baz")
-//       }
-//       return false // reject all other node types
-//   })
-//
-//   // run the query
-//   query.Execute(tree)
-//
-package query

query/lexer.go

@@ -1,357 +0,0 @@
-// TOML JSONPath lexer.
-//
-// Written using the principles developed by Rob Pike in
-// http://www.youtube.com/watch?v=HxaD_trXwRE
-
-package query
-
-import (
-	"fmt"
-	"github.com/pelletier/go-toml"
-	"strconv"
-	"strings"
-	"unicode/utf8"
-)
-
-// Lexer state function
-type queryLexStateFn func() queryLexStateFn
-
-// Lexer definition
-type queryLexer struct {
-	input      string
-	start      int
-	pos        int
-	width      int
-	tokens     chan token
-	depth      int
-	line       int
-	col        int
-	stringTerm string
-}
-
-func (l *queryLexer) run() {
-	for state := l.lexVoid; state != nil; {
-		state = state()
-	}
-	close(l.tokens)
-}
-
-func (l *queryLexer) nextStart() {
-	// iterate by runes (utf8 characters)
-	// search for newlines and advance line/col counts
-	for i := l.start; i < l.pos; {
-		r, width := utf8.DecodeRuneInString(l.input[i:])
-		if r == '\n' {
-			l.line++
-			l.col = 1
-		} else {
-			l.col++
-		}
-		i += width
-	}
-	// advance start position to next token
-	l.start = l.pos
-}
-
-func (l *queryLexer) emit(t tokenType) {
-	l.tokens <- token{
-		Position: toml.Position{Line: l.line, Col: l.col},
-		typ:      t,
-		val:      l.input[l.start:l.pos],
-	}
-	l.nextStart()
-}
-
-func (l *queryLexer) emitWithValue(t tokenType, value string) {
-	l.tokens <- token{
-		Position: toml.Position{Line: l.line, Col: l.col},
-		typ:      t,
-		val:      value,
-	}
-	l.nextStart()
-}
-
-func (l *queryLexer) next() rune {
-	if l.pos >= len(l.input) {
-		l.width = 0
-		return eof
-	}
-	var r rune
-	r, l.width = utf8.DecodeRuneInString(l.input[l.pos:])
-	l.pos += l.width
-	return r
-}
-
-func (l *queryLexer) ignore() {
-	l.nextStart()
-}
-
-func (l *queryLexer) backup() {
-	l.pos -= l.width
-}
-
-func (l *queryLexer) errorf(format string, args ...interface{}) queryLexStateFn {
-	l.tokens <- token{
-		Position: toml.Position{Line: l.line, Col: l.col},
-		typ:      tokenError,
-		val:      fmt.Sprintf(format, args...),
-	}
-	return nil
-}
-
-func (l *queryLexer) peek() rune {
-	r := l.next()
-	l.backup()
-	return r
-}
-
-func (l *queryLexer) accept(valid string) bool {
-	if strings.ContainsRune(valid, l.next()) {
-		return true
-	}
-	l.backup()
-	return false
-}
-
-func (l *queryLexer) follow(next string) bool {
-	return strings.HasPrefix(l.input[l.pos:], next)
-}
-
-func (l *queryLexer) lexVoid() queryLexStateFn {
-	for {
-		next := l.peek()
-		switch next {
-		case '$':
-			l.pos++
-			l.emit(tokenDollar)
-			continue
-		case '.':
-			if l.follow("..") {
-				l.pos += 2
-				l.emit(tokenDotDot)
-			} else {
-				l.pos++
-				l.emit(tokenDot)
-			}
-			continue
-		case '[':
-			l.pos++
-			l.emit(tokenLeftBracket)
-			continue
-		case ']':
-			l.pos++
-			l.emit(tokenRightBracket)
-			continue
-		case ',':
-			l.pos++
-			l.emit(tokenComma)
-			continue
-		case '*':
-			l.pos++
-			l.emit(tokenStar)
-			continue
-		case '(':
-			l.pos++
-			l.emit(tokenLeftParen)
-			continue
-		case ')':
-			l.pos++
-			l.emit(tokenRightParen)
-			continue
-		case '?':
-			l.pos++
-			l.emit(tokenQuestion)
-			continue
-		case ':':
-			l.pos++
-			l.emit(tokenColon)
-			continue
-		case '\'':
-			l.ignore()
-			l.stringTerm = string(next)
-			return l.lexString
-		case '"':
-			l.ignore()
-			l.stringTerm = string(next)
-			return l.lexString
-		}
-
-		if isSpace(next) {
-			l.next()
-			l.ignore()
-			continue
-		}
-
-		if isAlphanumeric(next) {
-			return l.lexKey
-		}
-
-		if next == '+' || next == '-' || isDigit(next) {
-			return l.lexNumber
-		}
-
-		if l.next() == eof {
-			break
-		}
-
-		return l.errorf("unexpected char: '%v'", next)
-	}
-	l.emit(tokenEOF)
-	return nil
-}
-
-func (l *queryLexer) lexKey() queryLexStateFn {
-	for {
-		next := l.peek()
-		if !isAlphanumeric(next) {
-			l.emit(tokenKey)
-			return l.lexVoid
-		}
-
-		if l.next() == eof {
-			break
-		}
-	}
-	l.emit(tokenEOF)
-	return nil
-}
-
-func (l *queryLexer) lexString() queryLexStateFn {
-	l.pos++
-	l.ignore()
-	growingString := ""
-
-	for {
-		if l.follow(l.stringTerm) {
-			l.emitWithValue(tokenString, growingString)
-			l.pos++
-			l.ignore()
-			return l.lexVoid
-		}
-
-		if l.follow("\\\"") {
-			l.pos++
-			growingString += "\""
-		} else if l.follow("\\'") {
-			l.pos++
-			growingString += "'"
-		} else if l.follow("\\n") {
-			l.pos++
-			growingString += "\n"
-		} else if l.follow("\\b") {
-			l.pos++
-			growingString += "\b"
-		} else if l.follow("\\f") {
-			l.pos++
-			growingString += "\f"
-		} else if l.follow("\\/") {
-			l.pos++
-			growingString += "/"
-		} else if l.follow("\\t") {
-			l.pos++
-			growingString += "\t"
-		} else if l.follow("\\r") {
-			l.pos++
-			growingString += "\r"
-		} else if l.follow("\\\\") {
-			l.pos++
-			growingString += "\\"
-		} else if l.follow("\\u") {
-			l.pos += 2
-			code := ""
-			for i := 0; i < 4; i++ {
-				c := l.peek()
-				l.pos++
-				if !isHexDigit(c) {
-					return l.errorf("unfinished unicode escape")
-				}
-				code = code + string(c)
-			}
-			l.pos--
-			intcode, err := strconv.ParseInt(code, 16, 32)
-			if err != nil {
-				return l.errorf("invalid unicode escape: \\u" + code)
-			}
-			growingString += string(rune(intcode))
-		} else if l.follow("\\U") {
-			l.pos += 2
-			code := ""
-			for i := 0; i < 8; i++ {
-				c := l.peek()
-				l.pos++
-				if !isHexDigit(c) {
-					return l.errorf("unfinished unicode escape")
-				}
-				code = code + string(c)
-			}
-			l.pos--
-			intcode, err := strconv.ParseInt(code, 16, 32)
-			if err != nil {
-				return l.errorf("invalid unicode escape: \\u" + code)
-			}
-			growingString += string(rune(intcode))
-		} else if l.follow("\\") {
-			l.pos++
-			return l.errorf("invalid escape sequence: \\" + string(l.peek()))
-		} else {
-			growingString += string(l.peek())
-		}
-
-		if l.next() == eof {
-			break
-		}
-	}
-
-	return l.errorf("unclosed string")
-}
-
-func (l *queryLexer) lexNumber() queryLexStateFn {
-	l.ignore()
-	if !l.accept("+") {
-		l.accept("-")
-	}
-	pointSeen := false
-	digitSeen := false
-	for {
-		next := l.next()
-		if next == '.' {
-			if pointSeen {
-				return l.errorf("cannot have two dots in one float")
-			}
-			if !isDigit(l.peek()) {
-				return l.errorf("float cannot end with a dot")
-			}
-			pointSeen = true
-		} else if isDigit(next) {
-			digitSeen = true
-		} else {
-			l.backup()
-			break
-		}
-		if pointSeen && !digitSeen {
-			return l.errorf("cannot start float with a dot")
-		}
-	}
-
-	if !digitSeen {
-		return l.errorf("no digit in that number")
-	}
-	if pointSeen {
-		l.emit(tokenFloat)
-	} else {
-		l.emit(tokenInteger)
-	}
-	return l.lexVoid
-}
-
-// Entry point
-func lexQuery(input string) chan token {
-	l := &queryLexer{
-		input:  input,
-		tokens: make(chan token),
-		line:   1,
-		col:    1,
-	}
-	go l.run()
-	return l.tokens
-}

query/lexer_test.go

@@ -1,179 +0,0 @@
-package query
-
-import (
-	"github.com/pelletier/go-toml"
-	"testing"
-)
-
-func testQLFlow(t *testing.T, input string, expectedFlow []token) {
-	ch := lexQuery(input)
-	for idx, expected := range expectedFlow {
-		token := <-ch
-		if token != expected {
-			t.Log("While testing #", idx, ":", input)
-			t.Log("compared (got)", token, "to (expected)", expected)
-			t.Log("\tvalue:", token.val, "<->", expected.val)
-			t.Log("\tvalue as bytes:", []byte(token.val), "<->", []byte(expected.val))
-			t.Log("\ttype:", token.typ.String(), "<->", expected.typ.String())
-			t.Log("\tline:", token.Line, "<->", expected.Line)
-			t.Log("\tcolumn:", token.Col, "<->", expected.Col)
-			t.Log("compared", token, "to", expected)
-			t.FailNow()
-		}
-	}
-
-	tok, ok := <-ch
-	if ok {
-		t.Log("channel is not closed!")
-		t.Log(len(ch)+1, "tokens remaining:")
-
-		t.Log("token ->", tok)
-		for token := range ch {
-			t.Log("token ->", token)
-		}
-		t.FailNow()
-	}
-}
-
-func TestLexSpecialChars(t *testing.T) {
-	testQLFlow(t, " .$[]..()?*", []token{
-		{toml.Position{1, 2}, tokenDot, "."},
-		{toml.Position{1, 3}, tokenDollar, "$"},
-		{toml.Position{1, 4}, tokenLeftBracket, "["},
-		{toml.Position{1, 5}, tokenRightBracket, "]"},
-		{toml.Position{1, 6}, tokenDotDot, ".."},
-		{toml.Position{1, 8}, tokenLeftParen, "("},
-		{toml.Position{1, 9}, tokenRightParen, ")"},
-		{toml.Position{1, 10}, tokenQuestion, "?"},
-		{toml.Position{1, 11}, tokenStar, "*"},
-		{toml.Position{1, 12}, tokenEOF, ""},
-	})
-}
-
-func TestLexString(t *testing.T) {
-	testQLFlow(t, "'foo\n'", []token{
-		{toml.Position{1, 2}, tokenString, "foo\n"},
-		{toml.Position{2, 2}, tokenEOF, ""},
-	})
-}
-
-func TestLexDoubleString(t *testing.T) {
-	testQLFlow(t, `"bar"`, []token{
-		{toml.Position{1, 2}, tokenString, "bar"},
-		{toml.Position{1, 6}, tokenEOF, ""},
-	})
-}
-
-func TestLexStringEscapes(t *testing.T) {
-	testQLFlow(t, `"foo \" \' \b \f \/ \t \r \\ \u03A9 \U00012345 \n bar"`, []token{
-		{toml.Position{1, 2}, tokenString, "foo \" ' \b \f / \t \r \\ \u03A9 \U00012345 \n bar"},
-		{toml.Position{1, 55}, tokenEOF, ""},
-	})
-}
-
-func TestLexStringUnfinishedUnicode4(t *testing.T) {
-	testQLFlow(t, `"\u000"`, []token{
-		{toml.Position{1, 2}, tokenError, "unfinished unicode escape"},
-	})
-}
-
-func TestLexStringUnfinishedUnicode8(t *testing.T) {
-	testQLFlow(t, `"\U0000"`, []token{
-		{toml.Position{1, 2}, tokenError, "unfinished unicode escape"},
-	})
-}
-
-func TestLexStringInvalidEscape(t *testing.T) {
-	testQLFlow(t, `"\x"`, []token{
-		{toml.Position{1, 2}, tokenError, "invalid escape sequence: \\x"},
-	})
-}
-
-func TestLexStringUnfinished(t *testing.T) {
-	testQLFlow(t, `"bar`, []token{
-		{toml.Position{1, 2}, tokenError, "unclosed string"},
-	})
-}
-
-func TestLexKey(t *testing.T) {
-	testQLFlow(t, "foo", []token{
-		{toml.Position{1, 1}, tokenKey, "foo"},
-		{toml.Position{1, 4}, tokenEOF, ""},
-	})
-}
-
-func TestLexRecurse(t *testing.T) {
-	testQLFlow(t, "$..*", []token{
-		{toml.Position{1, 1}, tokenDollar, "$"},
-		{toml.Position{1, 2}, tokenDotDot, ".."},
-		{toml.Position{1, 4}, tokenStar, "*"},
-		{toml.Position{1, 5}, tokenEOF, ""},
-	})
-}
-
-func TestLexBracketKey(t *testing.T) {
-	testQLFlow(t, "$[foo]", []token{
-		{toml.Position{1, 1}, tokenDollar, "$"},
-		{toml.Position{1, 2}, tokenLeftBracket, "["},
-		{toml.Position{1, 3}, tokenKey, "foo"},
-		{toml.Position{1, 6}, tokenRightBracket, "]"},
-		{toml.Position{1, 7}, tokenEOF, ""},
-	})
-}
-
-func TestLexSpace(t *testing.T) {
-	testQLFlow(t, "foo bar baz", []token{
-		{toml.Position{1, 1}, tokenKey, "foo"},
-		{toml.Position{1, 5}, tokenKey, "bar"},
-		{toml.Position{1, 9}, tokenKey, "baz"},
-		{toml.Position{1, 12}, tokenEOF, ""},
-	})
-}
-
-func TestLexInteger(t *testing.T) {
-	testQLFlow(t, "100 +200 -300", []token{
-		{toml.Position{1, 1}, tokenInteger, "100"},
-		{toml.Position{1, 5}, tokenInteger, "+200"},
-		{toml.Position{1, 10}, tokenInteger, "-300"},
-		{toml.Position{1, 14}, tokenEOF, ""},
-	})
-}
-
-func TestLexFloat(t *testing.T) {
-	testQLFlow(t, "100.0 +200.0 -300.0", []token{
-		{toml.Position{1, 1}, tokenFloat, "100.0"},
-		{toml.Position{1, 7}, tokenFloat, "+200.0"},
-		{toml.Position{1, 14}, tokenFloat, "-300.0"},
-		{toml.Position{1, 20}, tokenEOF, ""},
-	})
-}
-
-func TestLexFloatWithMultipleDots(t *testing.T) {
-	testQLFlow(t, "4.2.", []token{
-		{toml.Position{1, 1}, tokenError, "cannot have two dots in one float"},
-	})
-}
-
-func TestLexFloatLeadingDot(t *testing.T) {
-	testQLFlow(t, "+.1", []token{
-		{toml.Position{1, 1}, tokenError, "cannot start float with a dot"},
-	})
-}
-
-func TestLexFloatWithTrailingDot(t *testing.T) {
-	testQLFlow(t, "42.", []token{
-		{toml.Position{1, 1}, tokenError, "float cannot end with a dot"},
-	})
-}
-
-func TestLexNumberWithoutDigit(t *testing.T) {
-	testQLFlow(t, "+", []token{
-		{toml.Position{1, 1}, tokenError, "no digit in that number"},
-	})
-}
-
-func TestLexUnknown(t *testing.T) {
-	testQLFlow(t, "^", []token{
-		{toml.Position{1, 1}, tokenError, "unexpected char: '94'"},
-	})
-}

query/match.go

@@ -1,311 +0,0 @@
-package query
-
-import (
-	"fmt"
-	"reflect"
-
-	"github.com/pelletier/go-toml"
-)
-
-// base match
-type matchBase struct {
-	next pathFn
-}
-
-func (f *matchBase) setNext(next pathFn) {
-	f.next = next
-}
-
-// terminating functor - gathers results
-type terminatingFn struct {
-	// empty
-}
-
-func newTerminatingFn() *terminatingFn {
-	return &terminatingFn{}
-}
-
-func (f *terminatingFn) setNext(next pathFn) {
-	// do nothing
-}
-
-func (f *terminatingFn) call(node interface{}, ctx *queryContext) {
-	ctx.result.appendResult(node, ctx.lastPosition)
-}
-
-// match single key
-type matchKeyFn struct {
-	matchBase
-	Name string
-}
-
-func newMatchKeyFn(name string) *matchKeyFn {
-	return &matchKeyFn{Name: name}
-}
-
-func (f *matchKeyFn) call(node interface{}, ctx *queryContext) {
-	if array, ok := node.([]*toml.Tree); ok {
-		for _, tree := range array {
-			item := tree.GetPath([]string{f.Name})
-			if item != nil {
-				ctx.lastPosition = tree.GetPositionPath([]string{f.Name})
-				f.next.call(item, ctx)
-			}
-		}
-	} else if tree, ok := node.(*toml.Tree); ok {
-		item := tree.GetPath([]string{f.Name})
-		if item != nil {
-			ctx.lastPosition = tree.GetPositionPath([]string{f.Name})
-			f.next.call(item, ctx)
-		}
-	}
-}
-
-// match single index
-type matchIndexFn struct {
-	matchBase
-	Idx int
-}
-
-func newMatchIndexFn(idx int) *matchIndexFn {
-	return &matchIndexFn{Idx: idx}
-}
-
-func (f *matchIndexFn) call(node interface{}, ctx *queryContext) {
-	v := reflect.ValueOf(node)
-	if v.Kind() == reflect.Slice {
-		if v.Len() == 0 {
-			return
-		}
-
-		// Manage negative values
-		idx := f.Idx
-		if idx < 0 {
-			idx += v.Len()
-		}
-		if 0 <= idx && idx < v.Len() {
-			callNextIndexSlice(f.next, node, ctx, v.Index(idx).Interface())
-		}
-	}
-}
-
-func callNextIndexSlice(next pathFn, node interface{}, ctx *queryContext, value interface{}) {
-	if treesArray, ok := node.([]*toml.Tree); ok {
-		ctx.lastPosition = treesArray[0].Position()
-	}
-	next.call(value, ctx)
-}
-
-// filter by slicing
-type matchSliceFn struct {
-	matchBase
-	Start, End, Step *int
-}
-
-func newMatchSliceFn() *matchSliceFn {
-	return &matchSliceFn{}
-}
-
-func (f *matchSliceFn) setStart(start int) *matchSliceFn {
-	f.Start = &start
-	return f
-}
-
-func (f *matchSliceFn) setEnd(end int) *matchSliceFn {
-	f.End = &end
-	return f
-}
-
-func (f *matchSliceFn) setStep(step int) *matchSliceFn {
-	f.Step = &step
-	return f
-}
-
-func (f *matchSliceFn) call(node interface{}, ctx *queryContext) {
-	v := reflect.ValueOf(node)
-	if v.Kind() == reflect.Slice {
-		if v.Len() == 0 {
-			return
-		}
-
-		var start, end, step int
-
-		// Initialize step
-		if f.Step != nil {
-			step = *f.Step
-		} else {
-			step = 1
-		}
-
-		// Initialize start
-		if f.Start != nil {
-			start = *f.Start
-			// Manage negative values
-			if start < 0 {
-				start += v.Len()
-			}
-			// Manage out of range values
-			start = max(start, 0)
-			start = min(start, v.Len()-1)
-		} else if step > 0 {
-			start = 0
-		} else {
-			start = v.Len() - 1
-		}
-
-		// Initialize end
-		if f.End != nil {
-			end = *f.End
-			// Manage negative values
-			if end < 0 {
-				end += v.Len()
-			}
-			// Manage out of range values
-			end = max(end, -1)
-			end = min(end, v.Len())
-		} else if step > 0 {
-			end = v.Len()
-		} else {
-			end = -1
-		}
-
-		// Loop on values
-		if step > 0 {
-			for idx := start; idx < end; idx += step {
-				callNextIndexSlice(f.next, node, ctx, v.Index(idx).Interface())
-			}
-		} else {
-			for idx := start; idx > end; idx += step {
-				callNextIndexSlice(f.next, node, ctx, v.Index(idx).Interface())
-			}
-		}
-	}
-}
-
-func min(a, b int) int {
-	if a < b {
-		return a
-	}
-	return b
-}
-
-func max(a, b int) int {
-	if a > b {
-		return a
-	}
-	return b
-}
-
-// match anything
-type matchAnyFn struct {
-	matchBase
-}
-
-func newMatchAnyFn() *matchAnyFn {
-	return &matchAnyFn{}
-}
-
-func (f *matchAnyFn) call(node interface{}, ctx *queryContext) {
-	if tree, ok := node.(*toml.Tree); ok {
-		for _, k := range tree.Keys() {
-			v := tree.GetPath([]string{k})
-			ctx.lastPosition = tree.GetPositionPath([]string{k})
-			f.next.call(v, ctx)
-		}
-	}
-}
-
-// filter through union
-type matchUnionFn struct {
-	Union []pathFn
-}
-
-func (f *matchUnionFn) setNext(next pathFn) {
-	for _, fn := range f.Union {
-		fn.setNext(next)
-	}
-}
-
-func (f *matchUnionFn) call(node interface{}, ctx *queryContext) {
-	for _, fn := range f.Union {
-		fn.call(node, ctx)
-	}
-}
-
-// match every single last node in the tree
-type matchRecursiveFn struct {
-	matchBase
-}
-
-func newMatchRecursiveFn() *matchRecursiveFn {
-	return &matchRecursiveFn{}
-}
-
-func (f *matchRecursiveFn) call(node interface{}, ctx *queryContext) {
-	originalPosition := ctx.lastPosition
-	if tree, ok := node.(*toml.Tree); ok {
-		var visit func(tree *toml.Tree)
-		visit = func(tree *toml.Tree) {
-			for _, k := range tree.Keys() {
-				v := tree.GetPath([]string{k})
-				ctx.lastPosition = tree.GetPositionPath([]string{k})
-				f.next.call(v, ctx)
-				switch node := v.(type) {
-				case *toml.Tree:
-					visit(node)
-				case []*toml.Tree:
-					for _, subtree := range node {
-						visit(subtree)
-					}
-				}
-			}
-		}
-		ctx.lastPosition = originalPosition
-		f.next.call(tree, ctx)
-		visit(tree)
-	}
-}
-
-// match based on an externally provided functional filter
-type matchFilterFn struct {
-	matchBase
-	Pos  toml.Position
-	Name string
-}
-
-func newMatchFilterFn(name string, pos toml.Position) *matchFilterFn {
-	return &matchFilterFn{Name: name, Pos: pos}
-}
-
-func (f *matchFilterFn) call(node interface{}, ctx *queryContext) {
-	fn, ok := (*ctx.filters)[f.Name]
-	if !ok {
-		panic(fmt.Sprintf("%s: query context does not have filter '%s'",
-			f.Pos.String(), f.Name))
-	}
-	switch castNode := node.(type) {
-	case *toml.Tree:
-		for _, k := range castNode.Keys() {
-			v := castNode.GetPath([]string{k})
-			if fn(v) {
-				ctx.lastPosition = castNode.GetPositionPath([]string{k})
-				f.next.call(v, ctx)
-			}
-		}
-	case []*toml.Tree:
-		for _, v := range castNode {
-			if fn(v) {
-				if len(castNode) > 0 {
-					ctx.lastPosition = castNode[0].Position()
-				}
-				f.next.call(v, ctx)
-			}
-		}
-	case []interface{}:
-		for _, v := range castNode {
-			if fn(v) {
-				f.next.call(v, ctx)
-			}
-		}
-	}
-}

query/match_test.go

@@ -1,213 +0,0 @@
-package query
-
-import (
-	"fmt"
-	"strconv"
-	"testing"
-
-	"github.com/pelletier/go-toml"
-)
-
-// dump path tree to a string
-func pathString(root pathFn) string {
-	result := fmt.Sprintf("%T:", root)
-	switch fn := root.(type) {
-	case *terminatingFn:
-		result += "{}"
-	case *matchKeyFn:
-		result += fmt.Sprintf("{%s}", fn.Name)
-		result += pathString(fn.next)
-	case *matchIndexFn:
-		result += fmt.Sprintf("{%d}", fn.Idx)
-		result += pathString(fn.next)
-	case *matchSliceFn:
-		startString, endString, stepString := "nil", "nil", "nil"
-		if fn.Start != nil {
-			startString = strconv.Itoa(*fn.Start)
-		}
-		if fn.End != nil {
-			endString = strconv.Itoa(*fn.End)
-		}
-		if fn.Step != nil {
-			stepString = strconv.Itoa(*fn.Step)
-		}
-		result += fmt.Sprintf("{%s:%s:%s}", startString, endString, stepString)
-		result += pathString(fn.next)
-	case *matchAnyFn:
-		result += "{}"
-		result += pathString(fn.next)
-	case *matchUnionFn:
-		result += "{["
-		for _, v := range fn.Union {
-			result += pathString(v) + ", "
-		}
-		result += "]}"
-	case *matchRecursiveFn:
-		result += "{}"
-		result += pathString(fn.next)
-	case *matchFilterFn:
-		result += fmt.Sprintf("{%s}", fn.Name)
-		result += pathString(fn.next)
-	}
-	return result
-}
-
-func assertPathMatch(t *testing.T, path, ref *Query) bool {
-	pathStr := pathString(path.root)
-	refStr := pathString(ref.root)
-	if pathStr != refStr {
-		t.Errorf("paths do not match")
-		t.Log("test:", pathStr)
-		t.Log("ref: ", refStr)
-		return false
-	}
-	return true
-}
-
-func assertPath(t *testing.T, query string, ref *Query) {
-	path, _ := parseQuery(lexQuery(query))
-	assertPathMatch(t, path, ref)
-}
-
-func buildPath(parts ...pathFn) *Query {
-	query := newQuery()
-	for _, v := range parts {
-		query.appendPath(v)
-	}
-	return query
-}
-
-func TestPathRoot(t *testing.T) {
-	assertPath(t,
-		"$",
-		buildPath(
-		// empty
-		))
-}
-
-func TestPathKey(t *testing.T) {
-	assertPath(t,
-		"$.foo",
-		buildPath(
-			newMatchKeyFn("foo"),
-		))
-}
-
-func TestPathBracketKey(t *testing.T) {
-	assertPath(t,
-		"$[foo]",
-		buildPath(
-			newMatchKeyFn("foo"),
-		))
-}
-
-func TestPathBracketStringKey(t *testing.T) {
-	assertPath(t,
-		"$['foo']",
-		buildPath(
-			newMatchKeyFn("foo"),
-		))
-}
-
-func TestPathIndex(t *testing.T) {
-	assertPath(t,
-		"$[123]",
-		buildPath(
-			newMatchIndexFn(123),
-		))
-}
-
-func TestPathSliceStart(t *testing.T) {
-	assertPath(t,
-		"$[123:]",
-		buildPath(
-			newMatchSliceFn().setStart(123),
-		))
-}
-
-func TestPathSliceStartEnd(t *testing.T) {
-	assertPath(t,
-		"$[123:456]",
-		buildPath(
-			newMatchSliceFn().setStart(123).setEnd(456),
-		))
-}
-
-func TestPathSliceStartEndColon(t *testing.T) {
-	assertPath(t,
-		"$[123:456:]",
-		buildPath(
-			newMatchSliceFn().setStart(123).setEnd(456),
-		))
-}
-
-func TestPathSliceStartStep(t *testing.T) {
-	assertPath(t,
-		"$[123::7]",
-		buildPath(
-			newMatchSliceFn().setStart(123).setStep(7),
-		))
-}
-
-func TestPathSliceEndStep(t *testing.T) {
-	assertPath(t,
-		"$[:456:7]",
-		buildPath(
-			newMatchSliceFn().setEnd(456).setStep(7),
-		))
-}
-
-func TestPathSliceStep(t *testing.T) {
-	assertPath(t,
-		"$[::7]",
-		buildPath(
-			newMatchSliceFn().setStep(7),
-		))
-}
-
-func TestPathSliceAll(t *testing.T) {
-	assertPath(t,
-		"$[123:456:7]",
-		buildPath(
-			newMatchSliceFn().setStart(123).setEnd(456).setStep(7),
-		))
-}
-
-func TestPathAny(t *testing.T) {
-	assertPath(t,
-		"$.*",
-		buildPath(
-			newMatchAnyFn(),
-		))
-}
-
-func TestPathUnion(t *testing.T) {
-	assertPath(t,
-		"$[foo, bar, baz]",
-		buildPath(
-			&matchUnionFn{[]pathFn{
-				newMatchKeyFn("foo"),
-				newMatchKeyFn("bar"),
-				newMatchKeyFn("baz"),
-			}},
-		))
-}
-
-func TestPathRecurse(t *testing.T) {
-	assertPath(t,
-		"$..*",
-		buildPath(
-			newMatchRecursiveFn(),
-		))
-}
-
-func TestPathFilterExpr(t *testing.T) {
-	assertPath(t,
-		"$[?('foo'),?(bar)]",
-		buildPath(
-			&matchUnionFn{[]pathFn{
-				newMatchFilterFn("foo", toml.Position{}),
-				newMatchFilterFn("bar", toml.Position{}),
-			}},
-		))
-}

query/parser.go

@@ -1,278 +0,0 @@
-/*
-  Based on the "jsonpath" spec/concept.
-
-  http://goessner.net/articles/JsonPath/
-  https://code.google.com/p/json-path/
-*/
-
-package query
-
-import (
-	"fmt"
-)
-
-const maxInt = int(^uint(0) >> 1)
-
-type queryParser struct {
-	flow         chan token
-	tokensBuffer []token
-	query        *Query
-	union        []pathFn
-	err          error
-}
-
-type queryParserStateFn func() queryParserStateFn
-
-// Formats and panics an error message based on a token
-func (p *queryParser) parseError(tok *token, msg string, args ...interface{}) queryParserStateFn {
-	p.err = fmt.Errorf(tok.Position.String()+": "+msg, args...)
-	return nil // trigger parse to end
-}
-
-func (p *queryParser) run() {
-	for state := p.parseStart; state != nil; {
-		state = state()
-	}
-}
-
-func (p *queryParser) backup(tok *token) {
-	p.tokensBuffer = append(p.tokensBuffer, *tok)
-}
-
-func (p *queryParser) peek() *token {
-	if len(p.tokensBuffer) != 0 {
-		return &(p.tokensBuffer[0])
-	}
-
-	tok, ok := <-p.flow
-	if !ok {
-		return nil
-	}
-	p.backup(&tok)
-	return &tok
-}
-
-func (p *queryParser) lookahead(types ...tokenType) bool {
-	result := true
-	buffer := []token{}
-
-	for _, typ := range types {
-		tok := p.getToken()
-		if tok == nil {
-			result = false
-			break
-		}
-		buffer = append(buffer, *tok)
-		if tok.typ != typ {
-			result = false
-			break
-		}
-	}
-	// add the tokens back to the buffer, and return
-	p.tokensBuffer = append(p.tokensBuffer, buffer...)
-	return result
-}
-
-func (p *queryParser) getToken() *token {
-	if len(p.tokensBuffer) != 0 {
-		tok := p.tokensBuffer[0]
-		p.tokensBuffer = p.tokensBuffer[1:]
-		return &tok
-	}
-	tok, ok := <-p.flow
-	if !ok {
-		return nil
-	}
-	return &tok
-}
-
-func (p *queryParser) parseStart() queryParserStateFn {
-	tok := p.getToken()
-
-	if tok == nil || tok.typ == tokenEOF {
-		return nil
-	}
-
-	if tok.typ != tokenDollar {
-		return p.parseError(tok, "Expected '$' at start of expression")
-	}
-
-	return p.parseMatchExpr
-}
-
-// handle '.' prefix, '[]', and '..'
-func (p *queryParser) parseMatchExpr() queryParserStateFn {
-	tok := p.getToken()
-	switch tok.typ {
-	case tokenDotDot:
-		p.query.appendPath(&matchRecursiveFn{})
-		// nested parse for '..'
-		tok := p.getToken()
-		switch tok.typ {
-		case tokenKey:
-			p.query.appendPath(newMatchKeyFn(tok.val))
-			return p.parseMatchExpr
-		case tokenLeftBracket:
-			return p.parseBracketExpr
-		case tokenStar:
-			// do nothing - the recursive predicate is enough
-			return p.parseMatchExpr
-		}
-
-	case tokenDot:
-		// nested parse for '.'
-		tok := p.getToken()
-		switch tok.typ {
-		case tokenKey:
-			p.query.appendPath(newMatchKeyFn(tok.val))
-			return p.parseMatchExpr
-		case tokenStar:
-			p.query.appendPath(&matchAnyFn{})
-			return p.parseMatchExpr
-		}
-
-	case tokenLeftBracket:
-		return p.parseBracketExpr
-
-	case tokenEOF:
-		return nil // allow EOF at this stage
-	}
-	return p.parseError(tok, "expected match expression")
-}
-
-func (p *queryParser) parseBracketExpr() queryParserStateFn {
-	if p.lookahead(tokenInteger, tokenColon) {
-		return p.parseSliceExpr
-	}
-	if p.peek().typ == tokenColon {
-		return p.parseSliceExpr
-	}
-	return p.parseUnionExpr
-}
-
-func (p *queryParser) parseUnionExpr() queryParserStateFn {
-	var tok *token
-
-	// this state can be traversed after some sub-expressions
-	// so be careful when setting up state in the parser
-	if p.union == nil {
-		p.union = []pathFn{}
-	}
-
-loop: // labeled loop for easy breaking
-	for {
-		if len(p.union) > 0 {
-			// parse delimiter or terminator
-			tok = p.getToken()
-			switch tok.typ {
-			case tokenComma:
-				// do nothing
-			case tokenRightBracket:
-				break loop
-			default:
-				return p.parseError(tok, "expected ',' or ']', not '%s'", tok.val)
-			}
-		}
-
-		// parse sub expression
-		tok = p.getToken()
-		switch tok.typ {
-		case tokenInteger:
-			p.union = append(p.union, newMatchIndexFn(tok.Int()))
-		case tokenKey:
-			p.union = append(p.union, newMatchKeyFn(tok.val))
-		case tokenString:
-			p.union = append(p.union, newMatchKeyFn(tok.val))
-		case tokenQuestion:
-			return p.parseFilterExpr
-		default:
-			return p.parseError(tok, "expected union sub expression, not '%s', %d", tok.val, len(p.union))
-		}
-	}
-
-	// if there is only one sub-expression, use that instead
-	if len(p.union) == 1 {
-		p.query.appendPath(p.union[0])
-	} else {
-		p.query.appendPath(&matchUnionFn{p.union})
-	}
-
-	p.union = nil // clear out state
-	return p.parseMatchExpr
-}
-
-func (p *queryParser) parseSliceExpr() queryParserStateFn {
-	// init slice to grab all elements
-	var start, end, step *int = nil, nil, nil
-
-	// parse optional start
-	tok := p.getToken()
-	if tok.typ == tokenInteger {
-		v := tok.Int()
-		start = &v
-		tok = p.getToken()
-	}
-	if tok.typ != tokenColon {
-		return p.parseError(tok, "expected ':'")
-	}
-
-	// parse optional end
-	tok = p.getToken()
-	if tok.typ == tokenInteger {
-		v := tok.Int()
-		end = &v
-		tok = p.getToken()
-	}
-	if tok.typ == tokenRightBracket {
-		p.query.appendPath(&matchSliceFn{Start: start, End: end, Step: step})
-		return p.parseMatchExpr
-	}
-	if tok.typ != tokenColon {
-		return p.parseError(tok, "expected ']' or ':'")
-	}
-
-	// parse optional step
-	tok = p.getToken()
-	if tok.typ == tokenInteger {
-		v := tok.Int()
-		if v == 0 {
-			return p.parseError(tok, "step cannot be zero")
-		}
-		step = &v
-		tok = p.getToken()
-	}
-	if tok.typ != tokenRightBracket {
-		return p.parseError(tok, "expected ']'")
-	}
-
-	p.query.appendPath(&matchSliceFn{Start: start, End: end, Step: step})
-	return p.parseMatchExpr
-}
-
-func (p *queryParser) parseFilterExpr() queryParserStateFn {
-	tok := p.getToken()
-	if tok.typ != tokenLeftParen {
-		return p.parseError(tok, "expected left-parenthesis for filter expression")
-	}
-	tok = p.getToken()
-	if tok.typ != tokenKey && tok.typ != tokenString {
-		return p.parseError(tok, "expected key or string for filter function name")
-	}
-	name := tok.val
-	tok = p.getToken()
-	if tok.typ != tokenRightParen {
-		return p.parseError(tok, "expected right-parenthesis for filter expression")
-	}
-	p.union = append(p.union, newMatchFilterFn(name, tok.Position))
-	return p.parseUnionExpr
-}
-
-func parseQuery(flow chan token) (*Query, error) {
-	parser := &queryParser{
-		flow:         flow,
-		tokensBuffer: []token{},
-		query:        newQuery(),
-	}
-	parser.run()
-	return parser.query, parser.err
-}

query/parser_test.go

@@ -1,613 +0,0 @@
-package query
-
-import (
-	"fmt"
-	"io/ioutil"
-	"sort"
-	"strings"
-	"testing"
-	"time"
-
-	"github.com/pelletier/go-toml"
-)
-
-type queryTestNode struct {
-	value    interface{}
-	position toml.Position
-}
-
-func valueString(root interface{}) string {
-	result := "" //fmt.Sprintf("%T:", root)
-	switch node := root.(type) {
-	case *Result:
-		items := []string{}
-		for i, v := range node.Values() {
-			items = append(items, fmt.Sprintf("%s:%s",
-				node.Positions()[i].String(), valueString(v)))
-		}
-		sort.Strings(items)
-		result = "[" + strings.Join(items, ", ") + "]"
-	case queryTestNode:
-		result = fmt.Sprintf("%s:%s",
-			node.position.String(), valueString(node.value))
-	case []interface{}:
-		items := []string{}
-		for _, v := range node {
-			items = append(items, valueString(v))
-		}
-		sort.Strings(items)
-		result = "[" + strings.Join(items, ", ") + "]"
-	case *toml.Tree:
-		// workaround for unreliable map key ordering
-		items := []string{}
-		for _, k := range node.Keys() {
-			v := node.GetPath([]string{k})
-			items = append(items, k+":"+valueString(v))
-		}
-		sort.Strings(items)
-		result = "{" + strings.Join(items, ", ") + "}"
-	case map[string]interface{}:
-		// workaround for unreliable map key ordering
-		items := []string{}
-		for k, v := range node {
-			items = append(items, k+":"+valueString(v))
-		}
-		sort.Strings(items)
-		result = "{" + strings.Join(items, ", ") + "}"
-	case int64:
-		result += fmt.Sprintf("%d", node)
-	case string:
-		result += "'" + node + "'"
-	case float64:
-		result += fmt.Sprintf("%f", node)
-	case bool:
-		result += fmt.Sprintf("%t", node)
-	case time.Time:
-		result += fmt.Sprintf("'%v'", node)
-	}
-	return result
-}
-
-func assertValue(t *testing.T, result, ref interface{}) {
-	pathStr := valueString(result)
-	refStr := valueString(ref)
-	if pathStr != refStr {
-		t.Errorf("values do not match")
-		t.Log("test:", pathStr)
-		t.Log("ref: ", refStr)
-	}
-}
-
-func assertParseError(t *testing.T, query string, errString string) {
-	_, err := Compile(query)
-	if err == nil {
-		t.Error("error should be non-nil")
-		return
-	}
-	if err.Error() != errString {
-		t.Errorf("error does not match")
-		t.Log("test:", err.Error())
-		t.Log("ref: ", errString)
-	}
-}
-
-func assertQueryPositions(t *testing.T, tomlDoc string, query string, ref []interface{}) {
-	tree, err := toml.Load(tomlDoc)
-	if err != nil {
-		t.Errorf("Non-nil toml parse error: %v", err)
-		return
-	}
-	q, err := Compile(query)
-	if err != nil {
-		t.Error(err)
-		return
-	}
-	results := q.Execute(tree)
-	assertValue(t, results, ref)
-}
-
-func TestQueryRoot(t *testing.T) {
-	assertQueryPositions(t,
-		"a = 42",
-		"$",
-		[]interface{}{
-			queryTestNode{
-				map[string]interface{}{
-					"a": int64(42),
-				}, toml.Position{1, 1},
-			},
-		})
-}
-
-func TestQueryKey(t *testing.T) {
-	assertQueryPositions(t,
-		"[foo]\na = 42",
-		"$.foo.a",
-		[]interface{}{
-			queryTestNode{
-				int64(42), toml.Position{2, 1},
-			},
-		})
-}
-
-func TestQueryKeyString(t *testing.T) {
-	assertQueryPositions(t,
-		"[foo]\na = 42",
-		"$.foo['a']",
-		[]interface{}{
-			queryTestNode{
-				int64(42), toml.Position{2, 1},
-			},
-		})
-}
-
-func TestQueryKeyUnicodeString(t *testing.T) {
-	assertQueryPositions(t,
-		"['f𝟘.o']\na = 42",
-		"$['f𝟘.o']['a']",
-		[]interface{}{
-			queryTestNode{
-				int64(42), toml.Position{2, 1},
-			},
-		})
-}
-
-func TestQueryIndexError1(t *testing.T) {
-	assertParseError(t, "$.foo.a[5", "(1, 10): expected ',' or ']', not ''")
-}
-
-func TestQueryIndexError2(t *testing.T) {
-	assertParseError(t, "$.foo.a[]", "(1, 9): expected union sub expression, not ']', 0")
-}
-
-func TestQueryIndex(t *testing.T) {
-	assertQueryPositions(t,
-		"[foo]\na = [0,1,2,3,4,5,6,7,8,9]",
-		"$.foo.a[5]",
-		[]interface{}{
-			queryTestNode{int64(5), toml.Position{2, 1}},
-		})
-}
-
-func TestQueryIndexNegative(t *testing.T) {
-	assertQueryPositions(t,
-		"[foo]\na = [0,1,2,3,4,5,6,7,8,9]",
-		"$.foo.a[-2]",
-		[]interface{}{
-			queryTestNode{int64(8), toml.Position{2, 1}},
-		})
-}
-
-func TestQueryIndexWrong(t *testing.T) {
-	assertQueryPositions(t,
-		"[foo]\na = [0,1,2,3,4,5,6,7,8,9]",
-		"$.foo.a[99]",
-		[]interface{}{})
-}
-
-func TestQueryIndexEmpty(t *testing.T) {
-	assertQueryPositions(t,
-		"[foo]\na = []",
-		"$.foo.a[5]",
-		[]interface{}{})
-}
-
-func TestQueryIndexTree(t *testing.T) {
-	assertQueryPositions(t,
-		"[[foo]]\na = [0,1,2,3,4,5,6,7,8,9]\n[[foo]]\nb = 3",
-		"$.foo[1].b",
-		[]interface{}{
-			queryTestNode{int64(3), toml.Position{4, 1}},
-		})
-}
-
-func TestQuerySliceError1(t *testing.T) {
-	assertParseError(t, "$.foo.a[3:?]", "(1, 11): expected ']' or ':'")
-}
-
-func TestQuerySliceError2(t *testing.T) {
-	assertParseError(t, "$.foo.a[:::]", "(1, 11): expected ']'")
-}
-
-func TestQuerySliceError3(t *testing.T) {
-	assertParseError(t, "$.foo.a[::0]", "(1, 11): step cannot be zero")
-}
-
-func TestQuerySliceRange(t *testing.T) {
-	assertQueryPositions(t,
-		"[foo]\na = [0,1,2,3,4,5,6,7,8,9]",
-		"$.foo.a[:5]",
-		[]interface{}{
-			queryTestNode{int64(0), toml.Position{2, 1}},
-			queryTestNode{int64(1), toml.Position{2, 1}},
-			queryTestNode{int64(2), toml.Position{2, 1}},
-			queryTestNode{int64(3), toml.Position{2, 1}},
-			queryTestNode{int64(4), toml.Position{2, 1}},
-		})
-}
-
-func TestQuerySliceStep(t *testing.T) {
-	assertQueryPositions(t,
-		"[foo]\na = [0,1,2,3,4,5,6,7,8,9]",
-		"$.foo.a[0:5:2]",
-		[]interface{}{
-			queryTestNode{int64(0), toml.Position{2, 1}},
-			queryTestNode{int64(2), toml.Position{2, 1}},
-			queryTestNode{int64(4), toml.Position{2, 1}},
-		})
-}
-
-func TestQuerySliceStartNegative(t *testing.T) {
-	assertQueryPositions(t,
-		"[foo]\na = [0,1,2,3,4,5,6,7,8,9]",
-		"$.foo.a[-3:]",
-		[]interface{}{
-			queryTestNode{int64(7), toml.Position{2, 1}},
-			queryTestNode{int64(8), toml.Position{2, 1}},
-			queryTestNode{int64(9), toml.Position{2, 1}},
-		})
-}
-
-func TestQuerySliceEndNegative(t *testing.T) {
-	assertQueryPositions(t,
-		"[foo]\na = [0,1,2,3,4,5,6,7,8,9]",
-		"$.foo.a[:-6]",
-		[]interface{}{
-			queryTestNode{int64(0), toml.Position{2, 1}},
-			queryTestNode{int64(1), toml.Position{2, 1}},
-			queryTestNode{int64(2), toml.Position{2, 1}},
-			queryTestNode{int64(3), toml.Position{2, 1}},
-		})
-}
-
-func TestQuerySliceStepNegative(t *testing.T) {
-	assertQueryPositions(t,
-		"[foo]\na = [0,1,2,3,4,5,6,7,8,9]",
-		"$.foo.a[::-2]",
-		[]interface{}{
-			queryTestNode{int64(9), toml.Position{2, 1}},
-			queryTestNode{int64(7), toml.Position{2, 1}},
-			queryTestNode{int64(5), toml.Position{2, 1}},
-			queryTestNode{int64(3), toml.Position{2, 1}},
-			queryTestNode{int64(1), toml.Position{2, 1}},
-		})
-}
-
-func TestQuerySliceStartOverRange(t *testing.T) {
-	assertQueryPositions(t,
-		"[foo]\na = [0,1,2,3,4,5,6,7,8,9]",
-		"$.foo.a[-99:3]",
-		[]interface{}{
-			queryTestNode{int64(0), toml.Position{2, 1}},
-			queryTestNode{int64(1), toml.Position{2, 1}},
-			queryTestNode{int64(2), toml.Position{2, 1}},
-		})
-}
-
-func TestQuerySliceStartOverRangeNegative(t *testing.T) {
-	assertQueryPositions(t,
-		"[foo]\na = [0,1,2,3,4,5,6,7,8,9]",
-		"$.foo.a[99:7:-1]",
-		[]interface{}{
-			queryTestNode{int64(9), toml.Position{2, 1}},
-			queryTestNode{int64(8), toml.Position{2, 1}},
-		})
-}
-
-func TestQuerySliceEndOverRange(t *testing.T) {
-	assertQueryPositions(t,
-		"[foo]\na = [0,1,2,3,4,5,6,7,8,9]",
-		"$.foo.a[7:99]",
-		[]interface{}{
-			queryTestNode{int64(7), toml.Position{2, 1}},
-			queryTestNode{int64(8), toml.Position{2, 1}},
-			queryTestNode{int64(9), toml.Position{2, 1}},
-		})
-}
-
-func TestQuerySliceEndOverRangeNegative(t *testing.T) {
-	assertQueryPositions(t,
-		"[foo]\na = [0,1,2,3,4,5,6,7,8,9]",
-		"$.foo.a[2:-99:-1]",
-		[]interface{}{
-			queryTestNode{int64(2), toml.Position{2, 1}},
-			queryTestNode{int64(1), toml.Position{2, 1}},
-			queryTestNode{int64(0), toml.Position{2, 1}},
-		})
-}
-
-func TestQuerySliceWrongRange(t *testing.T) {
-	assertQueryPositions(t,
-		"[foo]\na = [0,1,2,3,4,5,6,7,8,9]",
-		"$.foo.a[5:3]",
-		[]interface{}{})
-}
-
-func TestQuerySliceWrongRangeNegative(t *testing.T) {
-	assertQueryPositions(t,
-		"[foo]\na = [0,1,2,3,4,5,6,7,8,9]",
-		"$.foo.a[3:5:-1]",
-		[]interface{}{})
-}
-
-func TestQuerySliceEmpty(t *testing.T) {
-	assertQueryPositions(t,
-		"[foo]\na = []",
-		"$.foo.a[5:]",
-		[]interface{}{})
-}
-
-func TestQuerySliceTree(t *testing.T) {
-	assertQueryPositions(t,
-		"[[foo]]\na='nok'\n[[foo]]\na = [0,1,2,3,4,5,6,7,8,9]\n[[foo]]\na='ok'\nb = 3",
-		"$.foo[1:].a",
-		[]interface{}{
-			queryTestNode{
-				[]interface{}{
-					int64(0), int64(1), int64(2), int64(3), int64(4),
-					int64(5), int64(6), int64(7), int64(8), int64(9)},
-				toml.Position{4, 1}},
-			queryTestNode{"ok", toml.Position{6, 1}},
-		})
-}
-
-func TestQueryAny(t *testing.T) {
-	assertQueryPositions(t,
-		"[foo.bar]\na=1\nb=2\n[foo.baz]\na=3\nb=4",
-		"$.foo.*",
-		[]interface{}{
-			queryTestNode{
-				map[string]interface{}{
-					"a": int64(1),
-					"b": int64(2),
-				}, toml.Position{1, 1},
-			},
-			queryTestNode{
-				map[string]interface{}{
-					"a": int64(3),
-					"b": int64(4),
-				}, toml.Position{4, 1},
-			},
-		})
-}
-func TestQueryUnionSimple(t *testing.T) {
-	assertQueryPositions(t,
-		"[foo.bar]\na=1\nb=2\n[baz.foo]\na=3\nb=4\n[gorf.foo]\na=5\nb=6",
-		"$.*[bar,foo]",
-		[]interface{}{
-			queryTestNode{
-				map[string]interface{}{
-					"a": int64(1),
-					"b": int64(2),
-				}, toml.Position{1, 1},
-			},
-			queryTestNode{
-				map[string]interface{}{
-					"a": int64(3),
-					"b": int64(4),
-				}, toml.Position{4, 1},
-			},
-			queryTestNode{
-				map[string]interface{}{
-					"a": int64(5),
-					"b": int64(6),
-				}, toml.Position{7, 1},
-			},
-		})
-}
-
-func TestQueryRecursionAll(t *testing.T) {
-	assertQueryPositions(t,
-		"[foo.bar]\na=1\nb=2\n[baz.foo]\na=3\nb=4\n[gorf.foo]\na=5\nb=6",
-		"$..*",
-		[]interface{}{
-			queryTestNode{
-				map[string]interface{}{
-					"foo": map[string]interface{}{
-						"bar": map[string]interface{}{
-							"a": int64(1),
-							"b": int64(2),
-						},
-					},
-					"baz": map[string]interface{}{
-						"foo": map[string]interface{}{
-							"a": int64(3),
-							"b": int64(4),
-						},
-					},
-					"gorf": map[string]interface{}{
-						"foo": map[string]interface{}{
-							"a": int64(5),
-							"b": int64(6),
-						},
-					},
-				}, toml.Position{1, 1},
-			},
-			queryTestNode{
-				map[string]interface{}{
-					"bar": map[string]interface{}{
-						"a": int64(1),
-						"b": int64(2),
-					},
-				}, toml.Position{1, 1},
-			},
-			queryTestNode{
-				map[string]interface{}{
-					"a": int64(1),
-					"b": int64(2),
-				}, toml.Position{1, 1},
-			},
-			queryTestNode{int64(1), toml.Position{2, 1}},
-			queryTestNode{int64(2), toml.Position{3, 1}},
-			queryTestNode{
-				map[string]interface{}{
-					"foo": map[string]interface{}{
-						"a": int64(3),
-						"b": int64(4),
-					},
-				}, toml.Position{4, 1},
-			},
-			queryTestNode{
-				map[string]interface{}{
-					"a": int64(3),
-					"b": int64(4),
-				}, toml.Position{4, 1},
-			},
-			queryTestNode{int64(3), toml.Position{5, 1}},
-			queryTestNode{int64(4), toml.Position{6, 1}},
-			queryTestNode{
-				map[string]interface{}{
-					"foo": map[string]interface{}{
-						"a": int64(5),
-						"b": int64(6),
-					},
-				}, toml.Position{7, 1},
-			},
-			queryTestNode{
-				map[string]interface{}{
-					"a": int64(5),
-					"b": int64(6),
-				}, toml.Position{7, 1},
-			},
-			queryTestNode{int64(5), toml.Position{8, 1}},
-			queryTestNode{int64(6), toml.Position{9, 1}},
-		})
-}
-
-func TestQueryRecursionUnionSimple(t *testing.T) {
-	assertQueryPositions(t,
-		"[foo.bar]\na=1\nb=2\n[baz.foo]\na=3\nb=4\n[gorf.foo]\na=5\nb=6",
-		"$..['foo','bar']",
-		[]interface{}{
-			queryTestNode{
-				map[string]interface{}{
-					"bar": map[string]interface{}{
-						"a": int64(1),
-						"b": int64(2),
-					},
-				}, toml.Position{1, 1},
-			},
-			queryTestNode{
-				map[string]interface{}{
-					"a": int64(3),
-					"b": int64(4),
-				}, toml.Position{4, 1},
-			},
-			queryTestNode{
-				map[string]interface{}{
-					"a": int64(1),
-					"b": int64(2),
-				}, toml.Position{1, 1},
-			},
-			queryTestNode{
-				map[string]interface{}{
-					"a": int64(5),
-					"b": int64(6),
-				}, toml.Position{7, 1},
-			},
-		})
-}
-
-func TestQueryFilterFn(t *testing.T) {
-	buff, err := ioutil.ReadFile("../example.toml")
-	if err != nil {
-		t.Error(err)
-		return
-	}
-
-	assertQueryPositions(t, string(buff),
-		"$..[?(int)]",
-		[]interface{}{
-			queryTestNode{int64(8001), toml.Position{13, 1}},
-			queryTestNode{int64(8001), toml.Position{13, 1}},
-			queryTestNode{int64(8002), toml.Position{13, 1}},
-			queryTestNode{int64(5000), toml.Position{14, 1}},
-		})
-
-	assertQueryPositions(t, string(buff),
-		"$..[?(string)]",
-		[]interface{}{
-			queryTestNode{"TOML Example", toml.Position{3, 1}},
-			queryTestNode{"Tom Preston-Werner", toml.Position{6, 1}},
-			queryTestNode{"GitHub", toml.Position{7, 1}},
-			queryTestNode{"GitHub Cofounder & CEO\nLikes tater tots and beer.", toml.Position{8, 1}},
-			queryTestNode{"192.168.1.1", toml.Position{12, 1}},
-			queryTestNode{"10.0.0.1", toml.Position{21, 3}},
-			queryTestNode{"eqdc10", toml.Position{22, 3}},
-			queryTestNode{"10.0.0.2", toml.Position{25, 3}},
-			queryTestNode{"eqdc10", toml.Position{26, 3}},
-		})
-
-	assertQueryPositions(t, string(buff),
-		"$..[?(float)]",
-		[]interface{}{
-			queryTestNode{4e-08, toml.Position{30, 1}},
-		})
-
-	tv, _ := time.Parse(time.RFC3339, "1979-05-27T07:32:00Z")
-	assertQueryPositions(t, string(buff),
-		"$..[?(tree)]",
-		[]interface{}{
-			queryTestNode{
-				map[string]interface{}{
-					"name":         "Tom Preston-Werner",
-					"organization": "GitHub",
-					"bio":          "GitHub Cofounder & CEO\nLikes tater tots and beer.",
-					"dob":          tv,
-				}, toml.Position{5, 1},
-			},
-			queryTestNode{
-				map[string]interface{}{
-					"server":         "192.168.1.1",
-					"ports":          []interface{}{int64(8001), int64(8001), int64(8002)},
-					"connection_max": int64(5000),
-					"enabled":        true,
-				}, toml.Position{11, 1},
-			},
-			queryTestNode{
-				map[string]interface{}{
-					"alpha": map[string]interface{}{
-						"ip": "10.0.0.1",
-						"dc": "eqdc10",
-					},
-					"beta": map[string]interface{}{
-						"ip": "10.0.0.2",
-						"dc": "eqdc10",
-					},
-				}, toml.Position{17, 1},
-			},
-			queryTestNode{
-				map[string]interface{}{
-					"ip": "10.0.0.1",
-					"dc": "eqdc10",
-				}, toml.Position{20, 3},
-			},
-			queryTestNode{
-				map[string]interface{}{
-					"ip": "10.0.0.2",
-					"dc": "eqdc10",
-				}, toml.Position{24, 3},
-			},
-			queryTestNode{
-				map[string]interface{}{
-					"data": []interface{}{
-						[]interface{}{"gamma", "delta"},
-						[]interface{}{int64(1), int64(2)},
-					},
-					"score": 4e-08,
-				}, toml.Position{28, 1},
-			},
-		})
-
-	assertQueryPositions(t, string(buff),
-		"$..[?(time)]",
-		[]interface{}{
-			queryTestNode{tv, toml.Position{9, 1}},
-		})
-
-	assertQueryPositions(t, string(buff),
-		"$..[?(bool)]",
-		[]interface{}{
-			queryTestNode{true, toml.Position{15, 1}},
-		})
-}

query/query.go

@@ -1,158 +0,0 @@
-package query
-
-import (
-	"time"
-
-	"github.com/pelletier/go-toml"
-)
-
-// NodeFilterFn represents a user-defined filter function, for use with
-// Query.SetFilter().
-//
-// The return value of the function must indicate if 'node' is to be included
-// at this stage of the TOML path.  Returning true will include the node, and
-// returning false will exclude it.
-//
-// NOTE: Care should be taken to write script callbacks such that they are safe
-// to use from multiple goroutines.
-type NodeFilterFn func(node interface{}) bool
-
-// Result is the result of Executing a Query.
-type Result struct {
-	items     []interface{}
-	positions []toml.Position
-}
-
-// appends a value/position pair to the result set.
-func (r *Result) appendResult(node interface{}, pos toml.Position) {
-	r.items = append(r.items, node)
-	r.positions = append(r.positions, pos)
-}
-
-// Values is a set of values within a Result.  The order of values is not
-// guaranteed to be in document order, and may be different each time a query is
-// executed.
-func (r Result) Values() []interface{} {
-	return r.items
-}
-
-// Positions is a set of positions for values within a Result.  Each index
-// in Positions() corresponds to the entry in Value() of the same index.
-func (r Result) Positions() []toml.Position {
-	return r.positions
-}
-
-// runtime context for executing query paths
-type queryContext struct {
-	result       *Result
-	filters      *map[string]NodeFilterFn
-	lastPosition toml.Position
-}
-
-// generic path functor interface
-type pathFn interface {
-	setNext(next pathFn)
-	// it is the caller's responsibility to set the ctx.lastPosition before invoking call()
-	// node can be one of: *toml.Tree, []*toml.Tree, or a scalar
-	call(node interface{}, ctx *queryContext)
-}
-
-// A Query is the representation of a compiled TOML path.  A Query is safe
-// for concurrent use by multiple goroutines.
-type Query struct {
-	root    pathFn
-	tail    pathFn
-	filters *map[string]NodeFilterFn
-}
-
-func newQuery() *Query {
-	return &Query{
-		root:    nil,
-		tail:    nil,
-		filters: &defaultFilterFunctions,
-	}
-}
-
-func (q *Query) appendPath(next pathFn) {
-	if q.root == nil {
-		q.root = next
-	} else {
-		q.tail.setNext(next)
-	}
-	q.tail = next
-	next.setNext(newTerminatingFn()) // init the next functor
-}
-
-// Compile compiles a TOML path expression. The returned Query can be used
-// to match elements within a Tree and its descendants. See Execute.
-func Compile(path string) (*Query, error) {
-	return parseQuery(lexQuery(path))
-}
-
-// Execute executes a query against a Tree, and returns the result of the query.
-func (q *Query) Execute(tree *toml.Tree) *Result {
-	result := &Result{
-		items:     []interface{}{},
-		positions: []toml.Position{},
-	}
-	if q.root == nil {
-		result.appendResult(tree, tree.GetPosition(""))
-	} else {
-		ctx := &queryContext{
-			result:  result,
-			filters: q.filters,
-		}
-		ctx.lastPosition = tree.Position()
-		q.root.call(tree, ctx)
-	}
-	return result
-}
-
-// CompileAndExecute is a shorthand for Compile(path) followed by Execute(tree).
-func CompileAndExecute(path string, tree *toml.Tree) (*Result, error) {
-	query, err := Compile(path)
-	if err != nil {
-		return nil, err
-	}
-	return query.Execute(tree), nil
-}
-
-// SetFilter sets a user-defined filter function.  These may be used inside
-// "?(..)" query expressions to filter TOML document elements within a query.
-func (q *Query) SetFilter(name string, fn NodeFilterFn) {
-	if q.filters == &defaultFilterFunctions {
-		// clone the static table
-		q.filters = &map[string]NodeFilterFn{}
-		for k, v := range defaultFilterFunctions {
-			(*q.filters)[k] = v
-		}
-	}
-	(*q.filters)[name] = fn
-}
-
-var defaultFilterFunctions = map[string]NodeFilterFn{
-	"tree": func(node interface{}) bool {
-		_, ok := node.(*toml.Tree)
-		return ok
-	},
-	"int": func(node interface{}) bool {
-		_, ok := node.(int64)
-		return ok
-	},
-	"float": func(node interface{}) bool {
-		_, ok := node.(float64)
-		return ok
-	},
-	"string": func(node interface{}) bool {
-		_, ok := node.(string)
-		return ok
-	},
-	"time": func(node interface{}) bool {
-		_, ok := node.(time.Time)
-		return ok
-	},
-	"bool": func(node interface{}) bool {
-		_, ok := node.(bool)
-		return ok
-	},
-}

query/query_test.go

@@ -1,151 +0,0 @@
-package query
-
-import (
-	"fmt"
-	"testing"
-
-	"github.com/pelletier/go-toml"
-)
-
-func assertArrayContainsInOrder(t *testing.T, array []interface{}, objects ...interface{}) {
-	if len(array) != len(objects) {
-		t.Fatalf("array contains %d objects but %d are expected", len(array), len(objects))
-	}
-
-	for i := 0; i < len(array); i++ {
-		if array[i] != objects[i] {
-			t.Fatalf("wanted '%s', have '%s'", objects[i], array[i])
-		}
-	}
-}
-
-func checkQuery(t *testing.T, tree *toml.Tree, query string, objects ...interface{}) {
-	results, err := CompileAndExecute(query, tree)
-	if err != nil {
-		t.Fatal("unexpected error:", err)
-	}
-	assertArrayContainsInOrder(t, results.Values(), objects...)
-}
-
-func TestQueryExample(t *testing.T) {
-	config, _ := toml.Load(`
-      [[book]]
-      title = "The Stand"
-      author = "Stephen King"
-      [[book]]
-      title = "For Whom the Bell Tolls"
-      author = "Ernest Hemmingway"
-      [[book]]
-      title = "Neuromancer"
-      author = "William Gibson"
-	`)
-
-	checkQuery(t, config, "$.book.author", "Stephen King", "Ernest Hemmingway", "William Gibson")
-
-	checkQuery(t, config, "$.book[0].author", "Stephen King")
-	checkQuery(t, config, "$.book[-1].author", "William Gibson")
-	checkQuery(t, config, "$.book[1:].author", "Ernest Hemmingway", "William Gibson")
-	checkQuery(t, config, "$.book[-1:].author", "William Gibson")
-	checkQuery(t, config, "$.book[::2].author", "Stephen King", "William Gibson")
-	checkQuery(t, config, "$.book[::-1].author", "William Gibson", "Ernest Hemmingway", "Stephen King")
-	checkQuery(t, config, "$.book[:].author", "Stephen King", "Ernest Hemmingway", "William Gibson")
-	checkQuery(t, config, "$.book[::].author", "Stephen King", "Ernest Hemmingway", "William Gibson")
-}
-
-func TestQueryReadmeExample(t *testing.T) {
-	config, _ := toml.Load(`
-[postgres]
-user = "pelletier"
-password = "mypassword"
-`)
-
-	checkQuery(t, config, "$..[user,password]", "pelletier", "mypassword")
-}
-
-func TestQueryPathNotPresent(t *testing.T) {
-	config, _ := toml.Load(`a = "hello"`)
-	query, err := Compile("$.foo.bar")
-	if err != nil {
-		t.Fatal("unexpected error:", err)
-	}
-	results := query.Execute(config)
-	if err != nil {
-		t.Fatalf("err should be nil. got %s instead", err)
-	}
-	if len(results.items) != 0 {
-		t.Fatalf("no items should be matched. %d matched instead", len(results.items))
-	}
-}
-
-func ExampleNodeFilterFn_filterExample() {
-	tree, _ := toml.Load(`
-      [struct_one]
-      foo = "foo"
-      bar = "bar"
-
-      [struct_two]
-      baz = "baz"
-      gorf = "gorf"
-    `)
-
-	// create a query that references a user-defined-filter
-	query, _ := Compile("$[?(bazOnly)]")
-
-	// define the filter, and assign it to the query
-	query.SetFilter("bazOnly", func(node interface{}) bool {
-		if tree, ok := node.(*toml.Tree); ok {
-			return tree.Has("baz")
-		}
-		return false // reject all other node types
-	})
-
-	// results contain only the 'struct_two' Tree
-	query.Execute(tree)
-}
-
-func ExampleQuery_queryExample() {
-	config, _ := toml.Load(`
-      [[book]]
-      title = "The Stand"
-      author = "Stephen King"
-      [[book]]
-      title = "For Whom the Bell Tolls"
-      author = "Ernest Hemmingway"
-      [[book]]
-      title = "Neuromancer"
-      author = "William Gibson"
-    `)
-
-	// find and print all the authors in the document
-	query, _ := Compile("$.book.author")
-	authors := query.Execute(config)
-	for _, name := range authors.Values() {
-		fmt.Println(name)
-	}
-}
-
-func TestTomlQuery(t *testing.T) {
-	tree, err := toml.Load("[foo.bar]\na=1\nb=2\n[baz.foo]\na=3\nb=4\n[gorf.foo]\na=5\nb=6")
-	if err != nil {
-		t.Error(err)
-		return
-	}
-	query, err := Compile("$.foo.bar")
-	if err != nil {
-		t.Error(err)
-		return
-	}
-	result := query.Execute(tree)
-	values := result.Values()
-	if len(values) != 1 {
-		t.Errorf("Expected resultset of 1, got %d instead: %v", len(values), values)
-	}
-
-	if tt, ok := values[0].(*toml.Tree); !ok {
-		t.Errorf("Expected type of Tree: %T", values[0])
-	} else if tt.Get("a") != int64(1) {
-		t.Errorf("Expected 'a' with a value 1: %v", tt.Get("a"))
-	} else if tt.Get("b") != int64(2) {
-		t.Errorf("Expected 'b' with a value 2: %v", tt.Get("b"))
-	}
-}

query/tokens.go

@@ -1,106 +0,0 @@
-package query
-
-import (
-	"fmt"
-	"strconv"
-
-	"github.com/pelletier/go-toml"
-)
-
-// Define tokens
-type tokenType int
-
-const (
-	eof = -(iota + 1)
-)
-
-const (
-	tokenError tokenType = iota
-	tokenEOF
-	tokenKey
-	tokenString
-	tokenInteger
-	tokenFloat
-	tokenLeftBracket
-	tokenRightBracket
-	tokenLeftParen
-	tokenRightParen
-	tokenComma
-	tokenColon
-	tokenDollar
-	tokenStar
-	tokenQuestion
-	tokenDot
-	tokenDotDot
-)
-
-var tokenTypeNames = []string{
-	"Error",
-	"EOF",
-	"Key",
-	"String",
-	"Integer",
-	"Float",
-	"[",
-	"]",
-	"(",
-	")",
-	",",
-	":",
-	"$",
-	"*",
-	"?",
-	".",
-	"..",
-}
-
-type token struct {
-	toml.Position
-	typ tokenType
-	val string
-}
-
-func (tt tokenType) String() string {
-	idx := int(tt)
-	if idx < len(tokenTypeNames) {
-		return tokenTypeNames[idx]
-	}
-	return "Unknown"
-}
-
-func (t token) Int() int {
-	if result, err := strconv.Atoi(t.val); err != nil {
-		panic(err)
-	} else {
-		return result
-	}
-}
-
-func (t token) String() string {
-	switch t.typ {
-	case tokenEOF:
-		return "EOF"
-	case tokenError:
-		return t.val
-	}
-
-	return fmt.Sprintf("%q", t.val)
-}
-
-func isSpace(r rune) bool {
-	return r == ' ' || r == '\t'
-}
-
-func isAlphanumeric(r rune) bool {
-	return 'a' <= r && r <= 'z' || 'A' <= r && r <= 'Z' || r == '_'
-}
-
-func isDigit(r rune) bool {
-	return '0' <= r && r <= '9'
-}
-
-func isHexDigit(r rune) bool {
-	return isDigit(r) ||
-		(r >= 'a' && r <= 'f') ||
-		(r >= 'A' && r <= 'F')
-}

scanner.go

@@ -0,0 +1,173 @@
+package toml
+
+func scanFollows(b []byte, pattern string) bool {
+	n := len(pattern)
+
+	return len(b) >= n && string(b[:n]) == pattern
+}
+
+func scanFollowsMultilineBasicStringDelimiter(b []byte) bool {
+	return scanFollows(b, `"""`)
+}
+
+func scanFollowsMultilineLiteralStringDelimiter(b []byte) bool {
+	return scanFollows(b, `'''`)
+}
+
+func scanFollowsTrue(b []byte) bool {
+	return scanFollows(b, `true`)
+}
+
+func scanFollowsFalse(b []byte) bool {
+	return scanFollows(b, `false`)
+}
+
+func scanFollowsInf(b []byte) bool {
+	return scanFollows(b, `inf`)
+}
+
+func scanFollowsNan(b []byte) bool {
+	return scanFollows(b, `nan`)
+}
+
+func scanUnquotedKey(b []byte) ([]byte, []byte) {
+	// unquoted-key = 1*( ALPHA / DIGIT / %x2D / %x5F ) ; A-Z / a-z / 0-9 / - / _
+	for i := 0; i < len(b); i++ {
+		if !isUnquotedKeyChar(b[i]) {
+			return b[:i], b[i:]
+		}
+	}
+
+	return b, b[len(b):]
+}
+
+func isUnquotedKeyChar(r byte) bool {
+	return (r >= 'A' && r <= 'Z') || (r >= 'a' && r <= 'z') || (r >= '0' && r <= '9') || r == '-' || r == '_'
+}
+
+func scanLiteralString(b []byte) ([]byte, []byte, error) {
+	// literal-string = apostrophe *literal-char apostrophe
+	// apostrophe = %x27 ; ' apostrophe
+	// literal-char = %x09 / %x20-26 / %x28-7E / non-ascii
+	for i := 1; i < len(b); i++ {
+		switch b[i] {
+		case '\'':
+			return b[:i+1], b[i+1:], nil
+		case '\n':
+			return nil, nil, newDecodeError(b[i:i+1], "literal strings cannot have new lines")
+		}
+	}
+
+	return nil, nil, newDecodeError(b[len(b):], "unterminated literal string")
+}
+
+func scanMultilineLiteralString(b []byte) ([]byte, []byte, error) {
+	// ml-literal-string = ml-literal-string-delim [ newline ] ml-literal-body
+	// ml-literal-string-delim
+	// ml-literal-string-delim = 3apostrophe
+	// ml-literal-body = *mll-content *( mll-quotes 1*mll-content ) [ mll-quotes ]
+	//
+	// mll-content = mll-char / newline
+	// mll-char = %x09 / %x20-26 / %x28-7E / non-ascii
+	// mll-quotes = 1*2apostrophe
+	for i := 3; i < len(b); i++ {
+		if b[i] == '\'' && scanFollowsMultilineLiteralStringDelimiter(b[i:]) {
+			return b[:i+3], b[i+3:], nil
+		}
+	}
+
+	return nil, nil, newDecodeError(b[len(b):], `multiline literal string not terminated by '''`)
+}
+
+func scanWindowsNewline(b []byte) ([]byte, []byte, error) {
+	const lenCRLF = 2
+	if len(b) < lenCRLF {
+		return nil, nil, newDecodeError(b, "windows new line expected")
+	}
+
+	if b[1] != '\n' {
+		return nil, nil, newDecodeError(b, `windows new line should be \r\n`)
+	}
+
+	return b[:lenCRLF], b[lenCRLF:], nil
+}
+
+func scanWhitespace(b []byte) ([]byte, []byte) {
+	for i := 0; i < len(b); i++ {
+		switch b[i] {
+		case ' ', '\t':
+			continue
+		default:
+			return b[:i], b[i:]
+		}
+	}
+
+	return b, b[len(b):]
+}
+
+//nolint:unparam
+func scanComment(b []byte) ([]byte, []byte) {
+	// comment-start-symbol = %x23 ; #
+	// non-ascii = %x80-D7FF / %xE000-10FFFF
+	// non-eol = %x09 / %x20-7F / non-ascii
+	//
+	// comment = comment-start-symbol *non-eol
+	for i := 1; i < len(b); i++ {
+		if b[i] == '\n' {
+			return b[:i], b[i:]
+		}
+	}
+
+	return b, nil
+}
+
+func scanBasicString(b []byte) ([]byte, []byte, error) {
+	// basic-string = quotation-mark *basic-char quotation-mark
+	// quotation-mark = %x22            ; "
+	// basic-char = basic-unescaped / escaped
+	// basic-unescaped = wschar / %x21 / %x23-5B / %x5D-7E / non-ascii
+	// escaped = escape escape-seq-char
+	for i := 1; i < len(b); i++ {
+		switch b[i] {
+		case '"':
+			return b[:i+1], b[i+1:], nil
+		case '\n':
+			return nil, nil, newDecodeError(b[i:i+1], "basic strings cannot have new lines")
+		case '\\':
+			if len(b) < i+2 {
+				return nil, nil, newDecodeError(b[i:i+1], "need a character after \\")
+			}
+			i++ // skip the next character
+		}
+	}
+
+	return nil, nil, newDecodeError(b[len(b):], `basic string not terminated by "`)
+}
+
+func scanMultilineBasicString(b []byte) ([]byte, []byte, error) {
+	// ml-basic-string = ml-basic-string-delim [ newline ] ml-basic-body
+	// ml-basic-string-delim
+	// ml-basic-string-delim = 3quotation-mark
+	// ml-basic-body = *mlb-content *( mlb-quotes 1*mlb-content ) [ mlb-quotes ]
+	//
+	// mlb-content = mlb-char / newline / mlb-escaped-nl
+	// mlb-char = mlb-unescaped / escaped
+	// mlb-quotes = 1*2quotation-mark
+	// mlb-unescaped = wschar / %x21 / %x23-5B / %x5D-7E / non-ascii
+	// mlb-escaped-nl = escape ws newline *( wschar / newline )
+	for i := 3; i < len(b); i++ {
+		switch b[i] {
+		case '"':
+			if scanFollowsMultilineBasicStringDelimiter(b[i:]) {
+				return b[:i+3], b[i+3:], nil
+			}
+		case '\\':
+			if len(b) < i+2 {
+				return nil, nil, newDecodeError(b[len(b):], "need a character after \\")
+			}
+			i++ // skip the next character
+		}
+	}
+
+	return nil, nil, newDecodeError(b[len(b):], `multiline basic string not terminated by """`)
+}

strict.go

@@ -0,0 +1,88 @@
+package toml
+
+import (
+	"github.com/pelletier/go-toml/v2/internal/ast"
+	"github.com/pelletier/go-toml/v2/internal/tracker"
+)
+
+type strict struct {
+	Enabled bool
+
+	// Tracks the current key being processed.
+	key tracker.KeyTracker
+
+	missing []decodeError
+}
+
+func (s *strict) EnterTable(node ast.Node) {
+	if !s.Enabled {
+		return
+	}
+
+	s.key.UpdateTable(node)
+}
+
+func (s *strict) EnterArrayTable(node ast.Node) {
+	if !s.Enabled {
+		return
+	}
+
+	s.key.UpdateArrayTable(node)
+}
+
+func (s *strict) EnterKeyValue(node ast.Node) {
+	if !s.Enabled {
+		return
+	}
+
+	s.key.Push(node)
+}
+
+func (s *strict) ExitKeyValue(node ast.Node) {
+	if !s.Enabled {
+		return
+	}
+
+	s.key.Pop(node)
+}
+
+func (s *strict) MissingTable(node ast.Node) {
+	if !s.Enabled {
+		return
+	}
+
+	s.missing = append(s.missing, decodeError{
+		highlight: keyLocation(node),
+		message:   "missing table",
+		key:       s.key.Key(),
+	})
+}
+
+func (s *strict) MissingField(node ast.Node) {
+	if !s.Enabled {
+		return
+	}
+
+	s.missing = append(s.missing, decodeError{
+		highlight: keyLocation(node),
+		message:   "missing field",
+		key:       s.key.Key(),
+	})
+}
+
+func (s *strict) Error(doc []byte) error {
+	if !s.Enabled || len(s.missing) == 0 {
+		return nil
+	}
+
+	err := &StrictMissingError{
+		Errors: make([]DecodeError, 0, len(s.missing)),
+	}
+
+	for _, derr := range s.missing {
+		derr := derr
+		err.Errors = append(err.Errors, *wrapDecodeError(doc, &derr))
+	}
+
+	return err
+}

targets.go

@@ -0,0 +1,536 @@
+package toml
+
+import (
+	"fmt"
+	"math"
+	"reflect"
+	"strings"
+	"sync"
+)
+
+type target interface {
+	// Dereferences the target.
+	get() reflect.Value
+
+	// Store a string at the target.
+	setString(v string)
+
+	// Store a boolean at the target
+	setBool(v bool)
+
+	// Store an int64 at the target
+	setInt64(v int64)
+
+	// Store a float64 at the target
+	setFloat64(v float64)
+
+	// Stores any value at the target
+	set(v reflect.Value)
+}
+
+// valueTarget just contains a reflect.Value that can be set.
+// It is used for struct fields.
+type valueTarget reflect.Value
+
+func (t valueTarget) get() reflect.Value {
+	return reflect.Value(t)
+}
+
+func (t valueTarget) set(v reflect.Value) {
+	reflect.Value(t).Set(v)
+}
+
+func (t valueTarget) setString(v string) {
+	t.get().SetString(v)
+}
+
+func (t valueTarget) setBool(v bool) {
+	t.get().SetBool(v)
+}
+
+func (t valueTarget) setInt64(v int64) {
+	t.get().SetInt(v)
+}
+
+func (t valueTarget) setFloat64(v float64) {
+	t.get().SetFloat(v)
+}
+
+// interfaceTarget wraps an other target to dereference on get.
+type interfaceTarget struct {
+	x target
+}
+
+func (t interfaceTarget) get() reflect.Value {
+	return t.x.get().Elem()
+}
+
+func (t interfaceTarget) set(v reflect.Value) {
+	t.x.set(v)
+}
+
+func (t interfaceTarget) setString(v string) {
+	panic("interface targets should always go through set")
+}
+
+func (t interfaceTarget) setBool(v bool) {
+	panic("interface targets should always go through set")
+}
+
+func (t interfaceTarget) setInt64(v int64) {
+	panic("interface targets should always go through set")
+}
+
+func (t interfaceTarget) setFloat64(v float64) {
+	panic("interface targets should always go through set")
+}
+
+// mapTarget targets a specific key of a map.
+type mapTarget struct {
+	v reflect.Value
+	k reflect.Value
+}
+
+func (t mapTarget) get() reflect.Value {
+	return t.v.MapIndex(t.k)
+}
+
+func (t mapTarget) set(v reflect.Value) {
+	t.v.SetMapIndex(t.k, v)
+}
+
+func (t mapTarget) setString(v string) {
+	t.set(reflect.ValueOf(v))
+}
+
+func (t mapTarget) setBool(v bool) {
+	t.set(reflect.ValueOf(v))
+}
+
+func (t mapTarget) setInt64(v int64) {
+	t.set(reflect.ValueOf(v))
+}
+
+func (t mapTarget) setFloat64(v float64) {
+	t.set(reflect.ValueOf(v))
+}
+
+// makes sure that the value pointed at by t is indexable (Slice, Array), or
+// dereferences to an indexable (Ptr, Interface).
+func ensureValueIndexable(t target) error {
+	f := t.get()
+
+	switch f.Type().Kind() {
+	case reflect.Slice:
+		if f.IsNil() {
+			t.set(reflect.MakeSlice(f.Type(), 0, 0))
+			return nil
+		}
+	case reflect.Interface:
+		if f.IsNil() || f.Elem().Type() != sliceInterfaceType {
+			t.set(reflect.MakeSlice(sliceInterfaceType, 0, 0))
+			return nil
+		}
+	case reflect.Ptr:
+		panic("pointer should have already been dereferenced")
+	case reflect.Array:
+		// arrays are always initialized.
+	default:
+		return fmt.Errorf("toml: cannot store array in a %s", f.Kind())
+	}
+
+	return nil
+}
+
+var (
+	sliceInterfaceType     = reflect.TypeOf([]interface{}{})
+	mapStringInterfaceType = reflect.TypeOf(map[string]interface{}{})
+)
+
+func ensureMapIfInterface(x target) {
+	v := x.get()
+
+	if v.Kind() == reflect.Interface && v.IsNil() {
+		newElement := reflect.MakeMap(mapStringInterfaceType)
+
+		x.set(newElement)
+	}
+}
+
+func setString(t target, v string) error {
+	f := t.get()
+
+	switch f.Kind() {
+	case reflect.String:
+		t.setString(v)
+	case reflect.Interface:
+		t.set(reflect.ValueOf(v))
+	default:
+		return fmt.Errorf("toml: cannot assign string to a %s", f.Kind())
+	}
+
+	return nil
+}
+
+func setBool(t target, v bool) error {
+	f := t.get()
+
+	switch f.Kind() {
+	case reflect.Bool:
+		t.setBool(v)
+	case reflect.Interface:
+		t.set(reflect.ValueOf(v))
+	default:
+		return fmt.Errorf("toml: cannot assign boolean to a %s", f.Kind())
+	}
+
+	return nil
+}
+
+const (
+	maxInt = int64(^uint(0) >> 1)
+	minInt = -maxInt - 1
+)
+
+//nolint:funlen,gocognit,cyclop
+func setInt64(t target, v int64) error {
+	f := t.get()
+
+	switch f.Kind() {
+	case reflect.Int64:
+		t.setInt64(v)
+	case reflect.Int32:
+		if v < math.MinInt32 || v > math.MaxInt32 {
+			return fmt.Errorf("toml: number %d does not fit in an int32", v)
+		}
+
+		t.set(reflect.ValueOf(int32(v)))
+		return nil
+	case reflect.Int16:
+		if v < math.MinInt16 || v > math.MaxInt16 {
+			return fmt.Errorf("toml: number %d does not fit in an int16", v)
+		}
+
+		t.set(reflect.ValueOf(int16(v)))
+	case reflect.Int8:
+		if v < math.MinInt8 || v > math.MaxInt8 {
+			return fmt.Errorf("toml: number %d does not fit in an int8", v)
+		}
+
+		t.set(reflect.ValueOf(int8(v)))
+	case reflect.Int:
+		if v < minInt || v > maxInt {
+			return fmt.Errorf("toml: number %d does not fit in an int", v)
+		}
+
+		t.set(reflect.ValueOf(int(v)))
+	case reflect.Uint64:
+		if v < 0 {
+			return fmt.Errorf("toml: negative number %d does not fit in an uint64", v)
+		}
+
+		t.set(reflect.ValueOf(uint64(v)))
+	case reflect.Uint32:
+		if v < 0 || v > math.MaxUint32 {
+			return fmt.Errorf("toml: negative number %d does not fit in an uint32", v)
+		}
+
+		t.set(reflect.ValueOf(uint32(v)))
+	case reflect.Uint16:
+		if v < 0 || v > math.MaxUint16 {
+			return fmt.Errorf("toml: negative number %d does not fit in an uint16", v)
+		}
+
+		t.set(reflect.ValueOf(uint16(v)))
+	case reflect.Uint8:
+		if v < 0 || v > math.MaxUint8 {
+			return fmt.Errorf("toml: negative number %d does not fit in an uint8", v)
+		}
+
+		t.set(reflect.ValueOf(uint8(v)))
+	case reflect.Uint:
+		if v < 0 {
+			return fmt.Errorf("toml: negative number %d does not fit in an uint", v)
+		}
+
+		t.set(reflect.ValueOf(uint(v)))
+	case reflect.Interface:
+		t.set(reflect.ValueOf(v))
+	default:
+		return fmt.Errorf("toml: integer cannot be assigned to %s", f.Kind())
+	}
+
+	return nil
+}
+
+func setFloat64(t target, v float64) error {
+	f := t.get()
+
+	switch f.Kind() {
+	case reflect.Float64:
+		t.setFloat64(v)
+	case reflect.Float32:
+		if v > math.MaxFloat32 {
+			return fmt.Errorf("toml: number %f does not fit in a float32", v)
+		}
+
+		t.set(reflect.ValueOf(float32(v)))
+	case reflect.Interface:
+		t.set(reflect.ValueOf(v))
+	default:
+		return fmt.Errorf("toml: float cannot be assigned to %s", f.Kind())
+	}
+
+	return nil
+}
+
+// Returns the element at idx of the value pointed at by target, or an error if
+// t does not point to an indexable.
+// If the target points to an Array and idx is out of bounds, it returns
+// (nil, nil) as this is not a fatal error (the unmarshaler will skip).
+func elementAt(t target, idx int) target {
+	f := t.get()
+
+	switch f.Kind() {
+	case reflect.Slice:
+		//nolint:godox
+		// TODO: use the idx function argument and avoid alloc if possible.
+		idx := f.Len()
+
+		t.set(reflect.Append(f, reflect.New(f.Type().Elem()).Elem()))
+
+		return valueTarget(t.get().Index(idx))
+	case reflect.Array:
+		if idx >= f.Len() {
+			return nil
+		}
+
+		return valueTarget(f.Index(idx))
+	case reflect.Interface:
+		// This function is called after ensureValueIndexable, so it's
+		// guaranteed that f contains an initialized slice.
+		ifaceElem := f.Elem()
+		idx := ifaceElem.Len()
+		newElem := reflect.New(ifaceElem.Type().Elem()).Elem()
+		newSlice := reflect.Append(ifaceElem, newElem)
+
+		t.set(newSlice)
+
+		return valueTarget(t.get().Elem().Index(idx))
+	default:
+		// Why ensureValueIndexable let it go through?
+		panic(fmt.Errorf("elementAt received unhandled value type: %s", f.Kind()))
+	}
+}
+
+func (d *decoder) scopeTableTarget(shouldAppend bool, t target, name string) (target, bool, error) {
+	x := t.get()
+
+	switch x.Kind() {
+	// Kinds that need to recurse
+	case reflect.Interface:
+		t := scopeInterface(shouldAppend, t)
+		return d.scopeTableTarget(shouldAppend, t, name)
+	case reflect.Ptr:
+		t := scopePtr(t)
+		return d.scopeTableTarget(shouldAppend, t, name)
+	case reflect.Slice:
+		t := scopeSlice(shouldAppend, t)
+		shouldAppend = false
+		return d.scopeTableTarget(shouldAppend, t, name)
+	case reflect.Array:
+		t, err := d.scopeArray(shouldAppend, t)
+		if err != nil {
+			return t, false, err
+		}
+		shouldAppend = false
+
+		return d.scopeTableTarget(shouldAppend, t, name)
+
+	// Terminal kinds
+	case reflect.Struct:
+		return scopeStruct(x, name)
+	case reflect.Map:
+		if x.IsNil() {
+			t.set(reflect.MakeMap(x.Type()))
+			x = t.get()
+		}
+
+		return scopeMap(x, name)
+	default:
+		panic(fmt.Sprintf("can't scope on a %s", x.Kind()))
+	}
+}
+
+func scopeInterface(shouldAppend bool, t target) target {
+	initInterface(shouldAppend, t)
+	return interfaceTarget{t}
+}
+
+func scopePtr(t target) target {
+	initPtr(t)
+	return valueTarget(t.get().Elem())
+}
+
+func initPtr(t target) {
+	x := t.get()
+	if !x.IsNil() {
+		return
+	}
+
+	t.set(reflect.New(x.Type().Elem()))
+}
+
+// initInterface makes sure that the interface pointed at by the target is not
+// nil.
+// Returns the target to the initialized value of the target.
+func initInterface(shouldAppend bool, t target) {
+	x := t.get()
+
+	if x.Kind() != reflect.Interface {
+		panic("this should only be called on interfaces")
+	}
+
+	if !x.IsNil() && (x.Elem().Type() == sliceInterfaceType || x.Elem().Type() == mapStringInterfaceType) {
+		return
+	}
+
+	var newElement reflect.Value
+	if shouldAppend {
+		newElement = reflect.MakeSlice(sliceInterfaceType, 0, 0)
+	} else {
+		newElement = reflect.MakeMap(mapStringInterfaceType)
+	}
+
+	t.set(newElement)
+}
+
+func scopeSlice(shouldAppend bool, t target) target {
+	v := t.get()
+
+	if shouldAppend {
+		newElem := reflect.New(v.Type().Elem())
+		newSlice := reflect.Append(v, newElem.Elem())
+
+		t.set(newSlice)
+
+		v = t.get()
+	}
+
+	return valueTarget(v.Index(v.Len() - 1))
+}
+
+func (d *decoder) scopeArray(shouldAppend bool, t target) (target, error) {
+	v := t.get()
+
+	idx := d.arrayIndex(shouldAppend, v)
+
+	if idx >= v.Len() {
+		return nil, fmt.Errorf("toml: impossible to insert element beyond array's size: %d", v.Len())
+	}
+
+	return valueTarget(v.Index(idx)), nil
+}
+
+func scopeMap(v reflect.Value, name string) (target, bool, error) {
+	k := reflect.ValueOf(name)
+
+	keyType := v.Type().Key()
+	if !k.Type().AssignableTo(keyType) {
+		if !k.Type().ConvertibleTo(keyType) {
+			return nil, false, fmt.Errorf("toml: cannot convert map key of type %s to expected type %s", k.Type(), keyType)
+		}
+
+		k = k.Convert(keyType)
+	}
+
+	if !v.MapIndex(k).IsValid() {
+		newElem := reflect.New(v.Type().Elem())
+		v.SetMapIndex(k, newElem.Elem())
+	}
+
+	return mapTarget{
+		v: v,
+		k: k,
+	}, true, nil
+}
+
+type fieldPathsMap = map[string][]int
+
+type fieldPathsCache struct {
+	m map[reflect.Type]fieldPathsMap
+	l sync.RWMutex
+}
+
+func (c *fieldPathsCache) get(t reflect.Type) (fieldPathsMap, bool) {
+	c.l.RLock()
+	paths, ok := c.m[t]
+	c.l.RUnlock()
+
+	return paths, ok
+}
+
+func (c *fieldPathsCache) set(t reflect.Type, m fieldPathsMap) {
+	c.l.Lock()
+	c.m[t] = m
+	c.l.Unlock()
+}
+
+var globalFieldPathsCache = fieldPathsCache{
+	m: map[reflect.Type]fieldPathsMap{},
+	l: sync.RWMutex{},
+}
+
+func scopeStruct(v reflect.Value, name string) (target, bool, error) {
+	//nolint:godox
+	// TODO: cache this, and reduce allocations
+	fieldPaths, ok := globalFieldPathsCache.get(v.Type())
+	if !ok {
+		fieldPaths = map[string][]int{}
+
+		path := make([]int, 0, 16)
+
+		var walk func(reflect.Value)
+		walk = func(v reflect.Value) {
+			t := v.Type()
+			for i := 0; i < t.NumField(); i++ {
+				l := len(path)
+				path = append(path, i)
+				f := t.Field(i)
+
+				if f.Anonymous {
+					walk(v.Field(i))
+				} else if f.PkgPath == "" {
+					// only consider exported fields
+					fieldName, ok := f.Tag.Lookup("toml")
+					if !ok {
+						fieldName = f.Name
+					}
+
+					pathCopy := make([]int, len(path))
+					copy(pathCopy, path)
+
+					fieldPaths[fieldName] = pathCopy
+					// extra copy for the case-insensitive match
+					fieldPaths[strings.ToLower(fieldName)] = pathCopy
+				}
+				path = path[:l]
+			}
+		}
+
+		walk(v)
+
+		globalFieldPathsCache.set(v.Type(), fieldPaths)
+	}
+
+	path, ok := fieldPaths[name]
+	if !ok {
+		path, ok = fieldPaths[strings.ToLower(name)]
+	}
+
+	if !ok {
+		return nil, false, nil
+	}
+
+	return valueTarget(v.FieldByIndex(path)), true, nil
+}

targets_test.go

@@ -0,0 +1,207 @@
+package toml
+
+import (
+	"reflect"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestStructTarget_Ensure(t *testing.T) {
+	t.Parallel()
+
+	examples := []struct {
+		desc  string
+		input reflect.Value
+		name  string
+		test  func(v reflect.Value, err error)
+	}{
+		{
+			desc:  "handle a nil slice of string",
+			input: reflect.ValueOf(&struct{ A []string }{}).Elem(),
+			name:  "A",
+			test: func(v reflect.Value, err error) {
+				assert.NoError(t, err)
+				assert.False(t, v.IsNil())
+			},
+		},
+		{
+			desc:  "handle an existing slice of string",
+			input: reflect.ValueOf(&struct{ A []string }{A: []string{"foo"}}).Elem(),
+			name:  "A",
+			test: func(v reflect.Value, err error) {
+				assert.NoError(t, err)
+				require.False(t, v.IsNil())
+
+				s, ok := v.Interface().([]string)
+				if !ok {
+					t.Errorf("interface %v should be castable into []string", s)
+					return
+				}
+
+				assert.Equal(t, []string{"foo"}, s)
+			},
+		},
+	}
+
+	for _, e := range examples {
+		e := e
+		t.Run(e.desc, func(t *testing.T) {
+			t.Parallel()
+
+			d := decoder{}
+			target, _, err := d.scopeTableTarget(false, valueTarget(e.input), e.name)
+			require.NoError(t, err)
+			err = ensureValueIndexable(target)
+			v := target.get()
+			e.test(v, err)
+		})
+	}
+}
+
+func TestStructTarget_SetString(t *testing.T) {
+	t.Parallel()
+
+	str := "value"
+
+	examples := []struct {
+		desc  string
+		input reflect.Value
+		name  string
+		test  func(v reflect.Value, err error)
+	}{
+		{
+			desc:  "sets a string",
+			input: reflect.ValueOf(&struct{ A string }{}).Elem(),
+			name:  "A",
+			test: func(v reflect.Value, err error) {
+				assert.NoError(t, err)
+				assert.Equal(t, str, v.String())
+			},
+		},
+		{
+			desc:  "fails on a float",
+			input: reflect.ValueOf(&struct{ A float64 }{}).Elem(),
+			name:  "A",
+			test: func(v reflect.Value, err error) {
+				assert.Error(t, err)
+			},
+		},
+		{
+			desc:  "fails on a slice",
+			input: reflect.ValueOf(&struct{ A []string }{}).Elem(),
+			name:  "A",
+			test: func(v reflect.Value, err error) {
+				assert.Error(t, err)
+			},
+		},
+	}
+
+	for _, e := range examples {
+		e := e
+		t.Run(e.desc, func(t *testing.T) {
+			t.Parallel()
+
+			d := decoder{}
+			target, _, err := d.scopeTableTarget(false, valueTarget(e.input), e.name)
+			require.NoError(t, err)
+			err = setString(target, str)
+			v := target.get()
+			e.test(v, err)
+		})
+	}
+}
+
+func TestPushNew(t *testing.T) {
+	t.Parallel()
+
+	t.Run("slice of strings", func(t *testing.T) {
+		t.Parallel()
+
+		type Doc struct {
+			A []string
+		}
+		d := Doc{}
+
+		dec := decoder{}
+		x, _, err := dec.scopeTableTarget(false, valueTarget(reflect.ValueOf(&d).Elem()), "A")
+		require.NoError(t, err)
+
+		n := elementAt(x, 0)
+		n.setString("hello")
+		require.Equal(t, []string{"hello"}, d.A)
+
+		n = elementAt(x, 1)
+		n.setString("world")
+		require.Equal(t, []string{"hello", "world"}, d.A)
+	})
+
+	t.Run("slice of interfaces", func(t *testing.T) {
+		t.Parallel()
+
+		type Doc struct {
+			A []interface{}
+		}
+		d := Doc{}
+
+		dec := decoder{}
+		x, _, err := dec.scopeTableTarget(false, valueTarget(reflect.ValueOf(&d).Elem()), "A")
+		require.NoError(t, err)
+
+		n := elementAt(x, 0)
+		require.NoError(t, setString(n, "hello"))
+		require.Equal(t, []interface{}{"hello"}, d.A)
+
+		n = elementAt(x, 1)
+		require.NoError(t, setString(n, "world"))
+		require.Equal(t, []interface{}{"hello", "world"}, d.A)
+	})
+}
+
+func TestScope_Struct(t *testing.T) {
+	t.Parallel()
+
+	examples := []struct {
+		desc  string
+		input reflect.Value
+		name  string
+		err   bool
+		found bool
+		idx   []int
+	}{
+		{
+			desc:  "simple field",
+			input: reflect.ValueOf(&struct{ A string }{}).Elem(),
+			name:  "A",
+			idx:   []int{0},
+			found: true,
+		},
+		{
+			desc:  "fails not-exported field",
+			input: reflect.ValueOf(&struct{ a string }{}).Elem(),
+			name:  "a",
+			err:   false,
+			found: false,
+		},
+	}
+
+	for _, e := range examples {
+		e := e
+		t.Run(e.desc, func(t *testing.T) {
+			t.Parallel()
+
+			dec := decoder{}
+			x, found, err := dec.scopeTableTarget(false, valueTarget(e.input), e.name)
+			assert.Equal(t, e.found, found)
+			if e.err {
+				assert.Error(t, err)
+			}
+			if found {
+				x2, ok := x.(valueTarget)
+				require.True(t, ok)
+				x2.get()
+			}
+		})
+	}
+}

token.go

@@ -1,136 +0,0 @@
-package toml
-
-import "fmt"
-
-// Define tokens
-type tokenType int
-
-const (
-	eof = -(iota + 1)
-)
-
-const (
-	tokenError tokenType = iota
-	tokenEOF
-	tokenComment
-	tokenKey
-	tokenString
-	tokenInteger
-	tokenTrue
-	tokenFalse
-	tokenFloat
-	tokenInf
-	tokenNan
-	tokenEqual
-	tokenLeftBracket
-	tokenRightBracket
-	tokenLeftCurlyBrace
-	tokenRightCurlyBrace
-	tokenLeftParen
-	tokenRightParen
-	tokenDoubleLeftBracket
-	tokenDoubleRightBracket
-	tokenLocalDate
-	tokenLocalTime
-	tokenTimeOffset
-	tokenKeyGroup
-	tokenKeyGroupArray
-	tokenComma
-	tokenColon
-	tokenDollar
-	tokenStar
-	tokenQuestion
-	tokenDot
-	tokenDotDot
-	tokenEOL
-)
-
-var tokenTypeNames = []string{
-	"Error",
-	"EOF",
-	"Comment",
-	"Key",
-	"String",
-	"Integer",
-	"True",
-	"False",
-	"Float",
-	"Inf",
-	"NaN",
-	"=",
-	"[",
-	"]",
-	"{",
-	"}",
-	"(",
-	")",
-	"]]",
-	"[[",
-	"LocalDate",
-	"LocalTime",
-	"TimeOffset",
-	"KeyGroup",
-	"KeyGroupArray",
-	",",
-	":",
-	"$",
-	"*",
-	"?",
-	".",
-	"..",
-	"EOL",
-}
-
-type token struct {
-	Position
-	typ tokenType
-	val string
-}
-
-func (tt tokenType) String() string {
-	idx := int(tt)
-	if idx < len(tokenTypeNames) {
-		return tokenTypeNames[idx]
-	}
-	return "Unknown"
-}
-
-func (t token) String() string {
-	switch t.typ {
-	case tokenEOF:
-		return "EOF"
-	case tokenError:
-		return t.val
-	}
-
-	return fmt.Sprintf("%q", t.val)
-}
-
-func isSpace(r rune) bool {
-	return r == ' ' || r == '\t'
-}
-
-func isAlphanumeric(r rune) bool {
-	return 'a' <= r && r <= 'z' || 'A' <= r && r <= 'Z' || r == '_'
-}
-
-func isKeyChar(r rune) bool {
-	// Keys start with the first character that isn't whitespace or [ and end
-	// with the last non-whitespace character before the equals sign. Keys
-	// cannot contain a # character."
-	return !(r == '\r' || r == '\n' || r == eof || r == '=')
-}
-
-func isKeyStartChar(r rune) bool {
-	return !(isSpace(r) || r == '\r' || r == '\n' || r == eof || r == '[')
-}
-
-func isDigit(r rune) bool {
-	return '0' <= r && r <= '9'
-}
-
-func isHexDigit(r rune) bool {
-	return isDigit(r) ||
-		(r >= 'a' && r <= 'f') ||
-		(r >= 'A' && r <= 'F')
-}

token_test.go

@@ -1,69 +0,0 @@
-package toml
-
-import "testing"
-
-func TestTokenStringer(t *testing.T) {
-	var tests = []struct {
-		tt     tokenType
-		expect string
-	}{
-		{tokenError, "Error"},
-		{tokenEOF, "EOF"},
-		{tokenComment, "Comment"},
-		{tokenKey, "Key"},
-		{tokenString, "String"},
-		{tokenInteger, "Integer"},
-		{tokenTrue, "True"},
-		{tokenFalse, "False"},
-		{tokenFloat, "Float"},
-		{tokenEqual, "="},
-		{tokenLeftBracket, "["},
-		{tokenRightBracket, "]"},
-		{tokenLeftCurlyBrace, "{"},
-		{tokenRightCurlyBrace, "}"},
-		{tokenLeftParen, "("},
-		{tokenRightParen, ")"},
-		{tokenDoubleLeftBracket, "]]"},
-		{tokenDoubleRightBracket, "[["},
-		{tokenLocalDate, "LocalDate"},
-		{tokenLocalTime, "LocalTime"},
-		{tokenTimeOffset, "TimeOffset"},
-		{tokenKeyGroup, "KeyGroup"},
-		{tokenKeyGroupArray, "KeyGroupArray"},
-		{tokenComma, ","},
-		{tokenColon, ":"},
-		{tokenDollar, "$"},
-		{tokenStar, "*"},
-		{tokenQuestion, "?"},
-		{tokenDot, "."},
-		{tokenDotDot, ".."},
-		{tokenEOL, "EOL"},
-		{tokenEOL + 1, "Unknown"},
-	}
-
-	for i, test := range tests {
-		got := test.tt.String()
-		if got != test.expect {
-			t.Errorf("[%d] invalid string of token type; got %q, expected %q", i, got, test.expect)
-		}
-	}
-}
-
-func TestTokenString(t *testing.T) {
-	var tests = []struct {
-		tok    token
-		expect string
-	}{
-		{token{Position{1, 1}, tokenEOF, ""}, "EOF"},
-		{token{Position{1, 1}, tokenError, "Δt"}, "Δt"},
-		{token{Position{1, 1}, tokenString, "bar"}, `"bar"`},
-		{token{Position{1, 1}, tokenString, "123456789012345"}, `"123456789012345"`},
-	}
-
-	for i, test := range tests {
-		got := test.tok.String()
-		if got != test.expect {
-			t.Errorf("[%d] invalid of string token; got %q, expected %q", i, got, test.expect)
-		}
-	}
-}

toml.abnf

@@ -0,0 +1,243 @@
+;; This document describes TOML's syntax, using the ABNF format (defined in
+;; RFC 5234 -- https://www.ietf.org/rfc/rfc5234.txt).
+;;
+;; All valid TOML documents will match this description, however certain
+;; invalid documents would need to be rejected as per the semantics described
+;; in the supporting text description.
+
+;; It is possible to try this grammar interactively, using instaparse.
+;;     http://instaparse.mojombo.com/
+;;
+;; To do so, in the lower right, click on Options and change `:input-format` to
+;; ':abnf'. Then paste this entire ABNF document into the grammar entry box
+;; (above the options). Then you can type or paste a sample TOML document into
+;; the beige box on the left. Tada!
+
+;; Overall Structure
+
+toml = expression *( newline expression )
+
+expression =  ws [ comment ]
+expression =/ ws keyval ws [ comment ]
+expression =/ ws table ws [ comment ]
+
+;; Whitespace
+
+ws = *wschar
+wschar =  %x20  ; Space
+wschar =/ %x09  ; Horizontal tab
+
+;; Newline
+
+newline =  %x0A     ; LF
+newline =/ %x0D.0A  ; CRLF
+
+;; Comment
+
+comment-start-symbol = %x23 ; #
+non-ascii = %x80-D7FF / %xE000-10FFFF
+non-eol = %x09 / %x20-7F / non-ascii
+
+comment = comment-start-symbol *non-eol
+
+;; Key-Value pairs
+
+keyval = key keyval-sep val
+
+key = simple-key / dotted-key
+simple-key = quoted-key / unquoted-key
+
+unquoted-key = 1*( ALPHA / DIGIT / %x2D / %x5F ) ; A-Z / a-z / 0-9 / - / _
+quoted-key = basic-string / literal-string
+dotted-key = simple-key 1*( dot-sep simple-key )
+
+dot-sep   = ws %x2E ws  ; . Period
+keyval-sep = ws %x3D ws ; =
+
+val = string / boolean / array / inline-table / date-time / float / integer
+
+;; String
+
+string = ml-basic-string / basic-string / ml-literal-string / literal-string
+
+;; Basic String
+
+basic-string = quotation-mark *basic-char quotation-mark
+
+quotation-mark = %x22            ; "
+
+basic-char = basic-unescaped / escaped
+basic-unescaped = wschar / %x21 / %x23-5B / %x5D-7E / non-ascii
+escaped = escape escape-seq-char
+
+escape = %x5C                   ; \
+escape-seq-char =  %x22         ; "    quotation mark  U+0022
+escape-seq-char =/ %x5C         ; \    reverse solidus U+005C
+escape-seq-char =/ %x62         ; b    backspace       U+0008
+escape-seq-char =/ %x66         ; f    form feed       U+000C
+escape-seq-char =/ %x6E         ; n    line feed       U+000A
+escape-seq-char =/ %x72         ; r    carriage return U+000D
+escape-seq-char =/ %x74         ; t    tab             U+0009
+escape-seq-char =/ %x75 4HEXDIG ; uXXXX                U+XXXX
+escape-seq-char =/ %x55 8HEXDIG ; UXXXXXXXX            U+XXXXXXXX
+
+;; Multiline Basic String
+
+ml-basic-string = ml-basic-string-delim [ newline ] ml-basic-body
+                  ml-basic-string-delim
+ml-basic-string-delim = 3quotation-mark
+ml-basic-body = *mlb-content *( mlb-quotes 1*mlb-content ) [ mlb-quotes ]
+
+mlb-content = mlb-char / newline / mlb-escaped-nl
+mlb-char = mlb-unescaped / escaped
+mlb-quotes = 1*2quotation-mark
+mlb-unescaped = wschar / %x21 / %x23-5B / %x5D-7E / non-ascii
+mlb-escaped-nl = escape ws newline *( wschar / newline )
+
+;; Literal String
+
+literal-string = apostrophe *literal-char apostrophe
+
+apostrophe = %x27 ; ' apostrophe
+
+literal-char = %x09 / %x20-26 / %x28-7E / non-ascii
+
+;; Multiline Literal String
+
+ml-literal-string = ml-literal-string-delim [ newline ] ml-literal-body
+                    ml-literal-string-delim
+ml-literal-string-delim = 3apostrophe
+ml-literal-body = *mll-content *( mll-quotes 1*mll-content ) [ mll-quotes ]
+
+mll-content = mll-char / newline
+mll-char = %x09 / %x20-26 / %x28-7E / non-ascii
+mll-quotes = 1*2apostrophe
+
+;; Integer
+
+integer = dec-int / hex-int / oct-int / bin-int
+
+minus = %x2D                       ; -
+plus = %x2B                        ; +
+underscore = %x5F                  ; _
+digit1-9 = %x31-39                 ; 1-9
+digit0-7 = %x30-37                 ; 0-7
+digit0-1 = %x30-31                 ; 0-1
+
+hex-prefix = %x30.78               ; 0x
+oct-prefix = %x30.6F               ; 0o
+bin-prefix = %x30.62               ; 0b
+
+dec-int = [ minus / plus ] unsigned-dec-int
+unsigned-dec-int = DIGIT / digit1-9 1*( DIGIT / underscore DIGIT )
+
+hex-int = hex-prefix HEXDIG *( HEXDIG / underscore HEXDIG )
+oct-int = oct-prefix digit0-7 *( digit0-7 / underscore digit0-7 )
+bin-int = bin-prefix digit0-1 *( digit0-1 / underscore digit0-1 )
+
+;; Float
+
+float = float-int-part ( exp / frac [ exp ] )
+float =/ special-float
+
+float-int-part = dec-int
+frac = decimal-point zero-prefixable-int
+decimal-point = %x2E               ; .
+zero-prefixable-int = DIGIT *( DIGIT / underscore DIGIT )
+
+exp = "e" float-exp-part
+float-exp-part = [ minus / plus ] zero-prefixable-int
+
+special-float = [ minus / plus ] ( inf / nan )
+inf = %x69.6e.66  ; inf
+nan = %x6e.61.6e  ; nan
+
+;; Boolean
+
+boolean = true / false
+
+true    = %x74.72.75.65     ; true
+false   = %x66.61.6C.73.65  ; false
+
+;; Date and Time (as defined in RFC 3339)
+
+date-time      = offset-date-time / local-date-time / local-date / local-time
+
+date-fullyear  = 4DIGIT
+date-month     = 2DIGIT  ; 01-12
+date-mday      = 2DIGIT  ; 01-28, 01-29, 01-30, 01-31 based on month/year
+time-delim     = "T" / %x20 ; T, t, or space
+time-hour      = 2DIGIT  ; 00-23
+time-minute    = 2DIGIT  ; 00-59
+time-second    = 2DIGIT  ; 00-58, 00-59, 00-60 based on leap second rules
+time-secfrac   = "." 1*DIGIT
+time-numoffset = ( "+" / "-" ) time-hour ":" time-minute
+time-offset    = "Z" / time-numoffset
+
+partial-time   = time-hour ":" time-minute ":" time-second [ time-secfrac ]
+full-date      = date-fullyear "-" date-month "-" date-mday
+full-time      = partial-time time-offset
+
+;; Offset Date-Time
+
+offset-date-time = full-date time-delim full-time
+
+;; Local Date-Time
+
+local-date-time = full-date time-delim partial-time
+
+;; Local Date
+
+local-date = full-date
+
+;; Local Time
+
+local-time = partial-time
+
+;; Array
+
+array = array-open [ array-values ] ws-comment-newline array-close
+
+array-open =  %x5B ; [
+array-close = %x5D ; ]
+
+array-values =  ws-comment-newline val ws-comment-newline array-sep array-values
+array-values =/ ws-comment-newline val ws-comment-newline [ array-sep ]
+
+array-sep = %x2C  ; , Comma
+
+ws-comment-newline = *( wschar / [ comment ] newline )
+
+;; Table
+
+table = std-table / array-table
+
+;; Standard Table
+
+std-table = std-table-open key std-table-close
+
+std-table-open  = %x5B ws     ; [ Left square bracket
+std-table-close = ws %x5D     ; ] Right square bracket
+
+;; Inline Table
+
+inline-table = inline-table-open [ inline-table-keyvals ] inline-table-close
+
+inline-table-open  = %x7B ws     ; {
+inline-table-close = ws %x7D     ; }
+inline-table-sep   = ws %x2C ws  ; , Comma
+
+inline-table-keyvals = keyval [ inline-table-sep inline-table-keyvals ]
+
+;; Array Table
+
+array-table = array-table-open key array-table-close
+
+array-table-open  = %x5B.5B ws  ; [[ Double left square bracket
+array-table-close = ws %x5D.5D  ; ]] Double right square bracket
+
+;; Built-in ABNF terms, reproduced here for clarity
+
+ALPHA = %x41-5A / %x61-7A ; A-Z / a-z
+DIGIT = %x30-39 ; 0-9
+HEXDIG = DIGIT / "A" / "B" / "C" / "D" / "E" / "F"

toml.go

@@ -1,529 +0,0 @@
-package toml
-
-import (
-	"errors"
-	"fmt"
-	"io"
-	"io/ioutil"
-	"os"
-	"runtime"
-	"strings"
-)
-
-type tomlValue struct {
-	value     interface{} // string, int64, uint64, float64, bool, time.Time, [] of any of this list
-	comment   string
-	commented bool
-	multiline bool
-	position  Position
-}
-
-// Tree is the result of the parsing of a TOML file.
-type Tree struct {
-	values    map[string]interface{} // string -> *tomlValue, *Tree, []*Tree
-	comment   string
-	commented bool
-	inline    bool
-	position  Position
-}
-
-func newTree() *Tree {
-	return newTreeWithPosition(Position{})
-}
-
-func newTreeWithPosition(pos Position) *Tree {
-	return &Tree{
-		values:   make(map[string]interface{}),
-		position: pos,
-	}
-}
-
-// TreeFromMap initializes a new Tree object using the given map.
-func TreeFromMap(m map[string]interface{}) (*Tree, error) {
-	result, err := toTree(m)
-	if err != nil {
-		return nil, err
-	}
-	return result.(*Tree), nil
-}
-
-// Position returns the position of the tree.
-func (t *Tree) Position() Position {
-	return t.position
-}
-
-// Has returns a boolean indicating if the given key exists.
-func (t *Tree) Has(key string) bool {
-	if key == "" {
-		return false
-	}
-	return t.HasPath(strings.Split(key, "."))
-}
-
-// HasPath returns true if the given path of keys exists, false otherwise.
-func (t *Tree) HasPath(keys []string) bool {
-	return t.GetPath(keys) != nil
-}
-
-// Keys returns the keys of the toplevel tree (does not recurse).
-func (t *Tree) Keys() []string {
-	keys := make([]string, len(t.values))
-	i := 0
-	for k := range t.values {
-		keys[i] = k
-		i++
-	}
-	return keys
-}
-
-// Get the value at key in the Tree.
-// Key is a dot-separated path (e.g. a.b.c) without single/double quoted strings.
-// If you need to retrieve non-bare keys, use GetPath.
-// Returns nil if the path does not exist in the tree.
-// If keys is of length zero, the current tree is returned.
-func (t *Tree) Get(key string) interface{} {
-	if key == "" {
-		return t
-	}
-	return t.GetPath(strings.Split(key, "."))
-}
-
-// GetPath returns the element in the tree indicated by 'keys'.
-// If keys is of length zero, the current tree is returned.
-func (t *Tree) GetPath(keys []string) interface{} {
-	if len(keys) == 0 {
-		return t
-	}
-	subtree := t
-	for _, intermediateKey := range keys[:len(keys)-1] {
-		value, exists := subtree.values[intermediateKey]
-		if !exists {
-			return nil
-		}
-		switch node := value.(type) {
-		case *Tree:
-			subtree = node
-		case []*Tree:
-			// go to most recent element
-			if len(node) == 0 {
-				return nil
-			}
-			subtree = node[len(node)-1]
-		default:
-			return nil // cannot navigate through other node types
-		}
-	}
-	// branch based on final node type
-	switch node := subtree.values[keys[len(keys)-1]].(type) {
-	case *tomlValue:
-		return node.value
-	default:
-		return node
-	}
-}
-
-// GetArray returns the value at key in the Tree.
-// It returns []string, []int64, etc type if key has homogeneous lists
-// Key is a dot-separated path (e.g. a.b.c) without single/double quoted strings.
-// Returns nil if the path does not exist in the tree.
-// If keys is of length zero, the current tree is returned.
-func (t *Tree) GetArray(key string) interface{} {
-	if key == "" {
-		return t
-	}
-	return t.GetArrayPath(strings.Split(key, "."))
-}
-
-// GetArrayPath returns the element in the tree indicated by 'keys'.
-// If keys is of length zero, the current tree is returned.
-func (t *Tree) GetArrayPath(keys []string) interface{} {
-	if len(keys) == 0 {
-		return t
-	}
-	subtree := t
-	for _, intermediateKey := range keys[:len(keys)-1] {
-		value, exists := subtree.values[intermediateKey]
-		if !exists {
-			return nil
-		}
-		switch node := value.(type) {
-		case *Tree:
-			subtree = node
-		case []*Tree:
-			// go to most recent element
-			if len(node) == 0 {
-				return nil
-			}
-			subtree = node[len(node)-1]
-		default:
-			return nil // cannot navigate through other node types
-		}
-	}
-	// branch based on final node type
-	switch node := subtree.values[keys[len(keys)-1]].(type) {
-	case *tomlValue:
-		switch n := node.value.(type) {
-		case []interface{}:
-			return getArray(n)
-		default:
-			return node.value
-		}
-	default:
-		return node
-	}
-}
-
-// if homogeneous array, then return slice type object over []interface{}
-func getArray(n []interface{}) interface{} {
-	var s []string
-	var i64 []int64
-	var f64 []float64
-	var bl []bool
-	for _, value := range n {
-		switch v := value.(type) {
-		case string:
-			s = append(s, v)
-		case int64:
-			i64 = append(i64, v)
-		case float64:
-			f64 = append(f64, v)
-		case bool:
-			bl = append(bl, v)
-		default:
-			return n
-		}
-	}
-	if len(s) == len(n) {
-		return s
-	} else if len(i64) == len(n) {
-		return i64
-	} else if len(f64) == len(n) {
-		return f64
-	} else if len(bl) == len(n) {
-		return bl
-	}
-	return n
-}
-
-// GetPosition returns the position of the given key.
-func (t *Tree) GetPosition(key string) Position {
-	if key == "" {
-		return t.position
-	}
-	return t.GetPositionPath(strings.Split(key, "."))
-}
-
-// SetPositionPath sets the position of element in the tree indicated by 'keys'.
-// If keys is of length zero, the current tree position is set.
-func (t *Tree) SetPositionPath(keys []string, pos Position) {
-	if len(keys) == 0 {
-		t.position = pos
-		return
-	}
-	subtree := t
-	for _, intermediateKey := range keys[:len(keys)-1] {
-		value, exists := subtree.values[intermediateKey]
-		if !exists {
-			return
-		}
-		switch node := value.(type) {
-		case *Tree:
-			subtree = node
-		case []*Tree:
-			// go to most recent element
-			if len(node) == 0 {
-				return
-			}
-			subtree = node[len(node)-1]
-		default:
-			return
-		}
-	}
-	// branch based on final node type
-	switch node := subtree.values[keys[len(keys)-1]].(type) {
-	case *tomlValue:
-		node.position = pos
-		return
-	case *Tree:
-		node.position = pos
-		return
-	case []*Tree:
-		// go to most recent element
-		if len(node) == 0 {
-			return
-		}
-		node[len(node)-1].position = pos
-		return
-	}
-}
-
-// GetPositionPath returns the element in the tree indicated by 'keys'.
-// If keys is of length zero, the current tree is returned.
-func (t *Tree) GetPositionPath(keys []string) Position {
-	if len(keys) == 0 {
-		return t.position
-	}
-	subtree := t
-	for _, intermediateKey := range keys[:len(keys)-1] {
-		value, exists := subtree.values[intermediateKey]
-		if !exists {
-			return Position{0, 0}
-		}
-		switch node := value.(type) {
-		case *Tree:
-			subtree = node
-		case []*Tree:
-			// go to most recent element
-			if len(node) == 0 {
-				return Position{0, 0}
-			}
-			subtree = node[len(node)-1]
-		default:
-			return Position{0, 0}
-		}
-	}
-	// branch based on final node type
-	switch node := subtree.values[keys[len(keys)-1]].(type) {
-	case *tomlValue:
-		return node.position
-	case *Tree:
-		return node.position
-	case []*Tree:
-		// go to most recent element
-		if len(node) == 0 {
-			return Position{0, 0}
-		}
-		return node[len(node)-1].position
-	default:
-		return Position{0, 0}
-	}
-}
-
-// GetDefault works like Get but with a default value
-func (t *Tree) GetDefault(key string, def interface{}) interface{} {
-	val := t.Get(key)
-	if val == nil {
-		return def
-	}
-	return val
-}
-
-// SetOptions arguments are supplied to the SetWithOptions and SetPathWithOptions functions to modify marshalling behaviour.
-// The default values within the struct are valid default options.
-type SetOptions struct {
-	Comment   string
-	Commented bool
-	Multiline bool
-}
-
-// SetWithOptions is the same as Set, but allows you to provide formatting
-// instructions to the key, that will be used by Marshal().
-func (t *Tree) SetWithOptions(key string, opts SetOptions, value interface{}) {
-	t.SetPathWithOptions(strings.Split(key, "."), opts, value)
-}
-
-// SetPathWithOptions is the same as SetPath, but allows you to provide
-// formatting instructions to the key, that will be reused by Marshal().
-func (t *Tree) SetPathWithOptions(keys []string, opts SetOptions, value interface{}) {
-	subtree := t
-	for i, intermediateKey := range keys[:len(keys)-1] {
-		nextTree, exists := subtree.values[intermediateKey]
-		if !exists {
-			nextTree = newTreeWithPosition(Position{Line: t.position.Line + i, Col: t.position.Col})
-			subtree.values[intermediateKey] = nextTree // add new element here
-		}
-		switch node := nextTree.(type) {
-		case *Tree:
-			subtree = node
-		case []*Tree:
-			// go to most recent element
-			if len(node) == 0 {
-				// create element if it does not exist
-				node = append(node, newTreeWithPosition(Position{Line: t.position.Line + i, Col: t.position.Col}))
-				subtree.values[intermediateKey] = node
-			}
-			subtree = node[len(node)-1]
-		}
-	}
-
-	var toInsert interface{}
-
-	switch v := value.(type) {
-	case *Tree:
-		v.comment = opts.Comment
-		v.commented = opts.Commented
-		toInsert = value
-	case []*Tree:
-		for i := range v {
-			v[i].commented = opts.Commented
-		}
-		toInsert = value
-	case *tomlValue:
-		v.comment = opts.Comment
-		v.commented = opts.Commented
-		v.multiline = opts.Multiline
-		toInsert = v
-	default:
-		toInsert = &tomlValue{value: value,
-			comment:   opts.Comment,
-			commented: opts.Commented,
-			multiline: opts.Multiline,
-			position:  Position{Line: subtree.position.Line + len(subtree.values) + 1, Col: subtree.position.Col}}
-	}
-
-	subtree.values[keys[len(keys)-1]] = toInsert
-}
-
-// Set an element in the tree.
-// Key is a dot-separated path (e.g. a.b.c).
-// Creates all necessary intermediate trees, if needed.
-func (t *Tree) Set(key string, value interface{}) {
-	t.SetWithComment(key, "", false, value)
-}
-
-// SetWithComment is the same as Set, but allows you to provide comment
-// information to the key, that will be reused by Marshal().
-func (t *Tree) SetWithComment(key string, comment string, commented bool, value interface{}) {
-	t.SetPathWithComment(strings.Split(key, "."), comment, commented, value)
-}
-
-// SetPath sets an element in the tree.
-// Keys is an array of path elements (e.g. {"a","b","c"}).
-// Creates all necessary intermediate trees, if needed.
-func (t *Tree) SetPath(keys []string, value interface{}) {
-	t.SetPathWithComment(keys, "", false, value)
-}
-
-// SetPathWithComment is the same as SetPath, but allows you to provide comment
-// information to the key, that will be reused by Marshal().
-func (t *Tree) SetPathWithComment(keys []string, comment string, commented bool, value interface{}) {
-	t.SetPathWithOptions(keys, SetOptions{Comment: comment, Commented: commented}, value)
-}
-
-// Delete removes a key from the tree.
-// Key is a dot-separated path (e.g. a.b.c).
-func (t *Tree) Delete(key string) error {
-	keys, err := parseKey(key)
-	if err != nil {
-		return err
-	}
-	return t.DeletePath(keys)
-}
-
-// DeletePath removes a key from the tree.
-// Keys is an array of path elements (e.g. {"a","b","c"}).
-func (t *Tree) DeletePath(keys []string) error {
-	keyLen := len(keys)
-	if keyLen == 1 {
-		delete(t.values, keys[0])
-		return nil
-	}
-	tree := t.GetPath(keys[:keyLen-1])
-	item := keys[keyLen-1]
-	switch node := tree.(type) {
-	case *Tree:
-		delete(node.values, item)
-		return nil
-	}
-	return errors.New("no such key to delete")
-}
-
-// createSubTree takes a tree and a key and create the necessary intermediate
-// subtrees to create a subtree at that point. In-place.
-//
-// e.g. passing a.b.c will create (assuming tree is empty) tree[a], tree[a][b]
-// and tree[a][b][c]
-//
-// Returns nil on success, error object on failure
-func (t *Tree) createSubTree(keys []string, pos Position) error {
-	subtree := t
-	for i, intermediateKey := range keys {
-		nextTree, exists := subtree.values[intermediateKey]
-		if !exists {
-			tree := newTreeWithPosition(Position{Line: t.position.Line + i, Col: t.position.Col})
-			tree.position = pos
-			tree.inline = subtree.inline
-			subtree.values[intermediateKey] = tree
-			nextTree = tree
-		}
-
-		switch node := nextTree.(type) {
-		case []*Tree:
-			subtree = node[len(node)-1]
-		case *Tree:
-			subtree = node
-		default:
-			return fmt.Errorf("unknown type for path %s (%s): %T (%#v)",
-				strings.Join(keys, "."), intermediateKey, nextTree, nextTree)
-		}
-	}
-	return nil
-}
-
-// LoadBytes creates a Tree from a []byte.
-func LoadBytes(b []byte) (tree *Tree, err error) {
-	defer func() {
-		if r := recover(); r != nil {
-			if _, ok := r.(runtime.Error); ok {
-				panic(r)
-			}
-			err = errors.New(r.(string))
-		}
-	}()
-
-	if len(b) >= 4 && (hasUTF32BigEndianBOM4(b) || hasUTF32LittleEndianBOM4(b)) {
-		b = b[4:]
-	} else if len(b) >= 3 && hasUTF8BOM3(b) {
-		b = b[3:]
-	} else if len(b) >= 2 && (hasUTF16BigEndianBOM2(b) || hasUTF16LittleEndianBOM2(b)) {
-		b = b[2:]
-	}
-
-	tree = parseToml(lexToml(b))
-	return
-}
-
-func hasUTF16BigEndianBOM2(b []byte) bool {
-	return b[0] == 0xFE && b[1] == 0xFF
-}
-
-func hasUTF16LittleEndianBOM2(b []byte) bool {
-	return b[0] == 0xFF && b[1] == 0xFE
-}
-
-func hasUTF8BOM3(b []byte) bool {
-	return b[0] == 0xEF && b[1] == 0xBB && b[2] == 0xBF
-}
-
-func hasUTF32BigEndianBOM4(b []byte) bool {
-	return b[0] == 0x00 && b[1] == 0x00 && b[2] == 0xFE && b[3] == 0xFF
-}
-
-func hasUTF32LittleEndianBOM4(b []byte) bool {
-	return b[0] == 0xFF && b[1] == 0xFE && b[2] == 0x00 && b[3] == 0x00
-}
-
-// LoadReader creates a Tree from any io.Reader.
-func LoadReader(reader io.Reader) (tree *Tree, err error) {
-	inputBytes, err := ioutil.ReadAll(reader)
-	if err != nil {
-		return
-	}
-	tree, err = LoadBytes(inputBytes)
-	return
-}
-
-// Load creates a Tree from a string.
-func Load(content string) (tree *Tree, err error) {
-	return LoadBytes([]byte(content))
-}
-
-// LoadFile creates a Tree from a file.
-func LoadFile(path string) (tree *Tree, err error) {
-	file, err := os.Open(path)
-	if err != nil {
-		return nil, err
-	}
-	defer file.Close()
-	return LoadReader(file)
-}

toml_test.go

@@ -1,261 +0,0 @@
-// Testing support for go-toml
-
-package toml
-
-import (
-	"reflect"
-	"testing"
-)
-
-func TestTomlHas(t *testing.T) {
-	tree, _ := Load(`
-		[test]
-		key = "value"
-	`)
-
-	if !tree.Has("test.key") {
-		t.Errorf("Has - expected test.key to exists")
-	}
-
-	if tree.Has("") {
-		t.Errorf("Should return false if the key is not provided")
-	}
-}
-
-func TestTomlGet(t *testing.T) {
-	tree, _ := Load(`
-		[test]
-		key = "value"
-	`)
-
-	if tree.Get("") != tree {
-		t.Errorf("Get should return the tree itself when given an empty path")
-	}
-
-	if tree.Get("test.key") != "value" {
-		t.Errorf("Get should return the value")
-	}
-	if tree.Get(`\`) != nil {
-		t.Errorf("should return nil when the key is malformed")
-	}
-}
-
-func TestTomlGetArray(t *testing.T) {
-	tree, _ := Load(`
-		[test]
-		key = ["one", "two"]
-		key2 = [true, false, false]
-		key3 = [1.5,2.5]
-	`)
-
-	if tree.GetArray("") != tree {
-		t.Errorf("GetArray should return the tree itself when given an empty path")
-	}
-
-	expect := []string{"one", "two"}
-	actual := tree.GetArray("test.key").([]string)
-	if !reflect.DeepEqual(actual, expect) {
-		t.Errorf("GetArray should return the []string value")
-	}
-
-	expect2 := []bool{true, false, false}
-	actual2 := tree.GetArray("test.key2").([]bool)
-	if !reflect.DeepEqual(actual2, expect2) {
-		t.Errorf("GetArray should return the []bool value")
-	}
-
-	expect3 := []float64{1.5, 2.5}
-	actual3 := tree.GetArray("test.key3").([]float64)
-	if !reflect.DeepEqual(actual3, expect3) {
-		t.Errorf("GetArray should return the []float64 value")
-	}
-
-	if tree.GetArray(`\`) != nil {
-		t.Errorf("should return nil when the key is malformed")
-	}
-}
-
-func TestTomlGetDefault(t *testing.T) {
-	tree, _ := Load(`
-		[test]
-		key = "value"
-	`)
-
-	if tree.GetDefault("", "hello") != tree {
-		t.Error("GetDefault should return the tree itself when given an empty path")
-	}
-
-	if tree.GetDefault("test.key", "hello") != "value" {
-		t.Error("Get should return the value")
-	}
-
-	if tree.GetDefault("whatever", "hello") != "hello" {
-		t.Error("GetDefault should return the default value if the key does not exist")
-	}
-}
-
-func TestTomlHasPath(t *testing.T) {
-	tree, _ := Load(`
-		[test]
-		key = "value"
-	`)
-
-	if !tree.HasPath([]string{"test", "key"}) {
-		t.Errorf("HasPath - expected test.key to exists")
-	}
-}
-
-func TestTomlDelete(t *testing.T) {
-	tree, _ := Load(`
-        key = "value"
-    `)
-	err := tree.Delete("key")
-	if err != nil {
-		t.Errorf("Delete - unexpected error while deleting key: %s", err.Error())
-	}
-
-	if tree.Get("key") != nil {
-		t.Errorf("Delete should have removed key but did not.")
-	}
-
-}
-
-func TestTomlDeleteUnparsableKey(t *testing.T) {
-	tree, _ := Load(`
-        key = "value"
-    `)
-	err := tree.Delete(".")
-	if err == nil {
-		t.Errorf("Delete should error")
-	}
-}
-
-func TestTomlDeleteNestedKey(t *testing.T) {
-	tree, _ := Load(`
-		[foo]
-        [foo.bar]
-        key = "value"
-    `)
-	err := tree.Delete("foo.bar.key")
-	if err != nil {
-		t.Errorf("Error while deleting nested key: %s", err.Error())
-	}
-
-	if tree.Get("key") != nil {
-		t.Errorf("Delete should have removed nested key but did not.")
-	}
-
-}
-
-func TestTomlDeleteNonexistentNestedKey(t *testing.T) {
-	tree, _ := Load(`
-		[foo]
-        [foo.bar]
-        key = "value"
-    `)
-	err := tree.Delete("foo.not.there.key")
-	if err == nil {
-		t.Errorf("Delete should have thrown an error trying to delete key in nonexistent tree")
-	}
-}
-
-func TestTomlGetPath(t *testing.T) {
-	node := newTree()
-	//TODO: set other node data
-
-	for idx, item := range []struct {
-		Path     []string
-		Expected *Tree
-	}{
-		{ // empty path test
-			[]string{},
-			node,
-		},
-	} {
-		result := node.GetPath(item.Path)
-		if result != item.Expected {
-			t.Errorf("GetPath[%d] %v - expected %v, got %v instead.", idx, item.Path, item.Expected, result)
-		}
-	}
-
-	tree, _ := Load("[foo.bar]\na=1\nb=2\n[baz.foo]\na=3\nb=4\n[gorf.foo]\na=5\nb=6")
-	if tree.GetPath([]string{"whatever"}) != nil {
-		t.Error("GetPath should return nil when the key does not exist")
-	}
-}
-
-func TestTomlGetArrayPath(t *testing.T) {
-	for idx, item := range []struct {
-		Name string
-		Path []string
-		Make func() (tree *Tree, expected interface{})
-	}{
-		{
-			Name: "empty",
-			Path: []string{},
-			Make: func() (tree *Tree, expected interface{}) {
-				tree = newTree()
-				expected = tree
-				return
-			},
-		},
-		{
-			Name: "int64",
-			Path: []string{"a"},
-			Make: func() (tree *Tree, expected interface{}) {
-				var err error
-				tree, err = Load(`a = [1,2,3]`)
-				if err != nil {
-					panic(err)
-				}
-				expected = []int64{1, 2, 3}
-				return
-			},
-		},
-	} {
-		t.Run(item.Name, func(t *testing.T) {
-			tree, expected := item.Make()
-			result := tree.GetArrayPath(item.Path)
-			if !reflect.DeepEqual(result, expected) {
-				t.Errorf("GetArrayPath[%d] %v - expected %#v, got %#v instead.", idx, item.Path, expected, result)
-			}
-		})
-	}
-
-	tree, _ := Load("[foo.bar]\na=1\nb=2\n[baz.foo]\na=3\nb=4\n[gorf.foo]\na=5\nb=6")
-	if tree.GetArrayPath([]string{"whatever"}) != nil {
-		t.Error("GetArrayPath should return nil when the key does not exist")
-	}
-
-}
-
-func TestTomlFromMap(t *testing.T) {
-	simpleMap := map[string]interface{}{"hello": 42}
-	tree, err := TreeFromMap(simpleMap)
-	if err != nil {
-		t.Fatal("unexpected error:", err)
-	}
-	if tree.Get("hello") != int64(42) {
-		t.Fatal("hello should be 42, not", tree.Get("hello"))
-	}
-}
-
-func TestLoadBytesBOM(t *testing.T) {
-	payloads := [][]byte{
-		[]byte("\xFE\xFFhello=1"),
-		[]byte("\xFF\xFEhello=1"),
-		[]byte("\xEF\xBB\xBFhello=1"),
-		[]byte("\x00\x00\xFE\xFFhello=1"),
-		[]byte("\xFF\xFE\x00\x00hello=1"),
-	}
-	for _, data := range payloads {
-		tree, err := LoadBytes(data)
-		if err != nil {
-			t.Fatal("unexpected error:", err, "for:", data)
-		}
-		v := tree.Get("hello")
-		if v != int64(1) {
-			t.Fatal("hello should be 1, not", v)
-		}
-	}
-}

toml_testgen_support_test.go

@@ -1,119 +1,152 @@
 // This is a support file for toml_testgen_test.go
-package toml
+package toml_test
 
 import (
-	"bytes"
 	"encoding/json"
 	"fmt"
-	"reflect"
+	"strconv"
 	"testing"
 	"time"
 
-	"github.com/davecgh/go-spew/spew"
+	"github.com/pelletier/go-toml/v2"
+	"github.com/stretchr/testify/require"
 )
 
 func testgenInvalid(t *testing.T, input string) {
+	t.Helper()
 	t.Logf("Input TOML:\n%s", input)
-	tree, err := Load(input)
-	if err != nil {
-		return
+
+	doc := map[string]interface{}{}
+	err := toml.Unmarshal([]byte(input), &doc)
+
+	if err == nil {
+		t.Log(json.Marshal(doc))
+		t.Fatalf("test did not fail")
 	}
-
-	typedTree := testgenTranslate(*tree)
-
-	buf := new(bytes.Buffer)
-	if err := json.NewEncoder(buf).Encode(typedTree); err != nil {
-		return
-	}
-
-	t.Fatalf("test did not fail. resulting tree:\n%s", buf.String())
 }
 
 func testgenValid(t *testing.T, input string, jsonRef string) {
+	t.Helper()
 	t.Logf("Input TOML:\n%s", input)
-	tree, err := Load(input)
+
+	doc := map[string]interface{}{}
+
+	err := toml.Unmarshal([]byte(input), &doc)
 	if err != nil {
 		t.Fatalf("failed parsing toml: %s", err)
 	}
 
-	typedTree := testgenTranslate(*tree)
+	refDoc := testgenBuildRefDoc(jsonRef)
 
-	buf := new(bytes.Buffer)
-	if err := json.NewEncoder(buf).Encode(typedTree); err != nil {
-		t.Fatalf("failed translating to JSON: %s", err)
-	}
+	require.Equal(t, refDoc, doc)
 
-	var jsonTest interface{}
-	if err := json.NewDecoder(buf).Decode(&jsonTest); err != nil {
-		t.Logf("translated JSON:\n%s", buf.String())
-		t.Fatalf("failed decoding translated JSON: %s", err)
-	}
+	out, err := toml.Marshal(doc)
+	require.NoError(t, err)
 
-	var jsonExpected interface{}
-	if err := json.NewDecoder(bytes.NewBufferString(jsonRef)).Decode(&jsonExpected); err != nil {
-		t.Logf("reference JSON:\n%s", jsonRef)
-		t.Fatalf("failed decoding reference JSON: %s", err)
-	}
+	doc2 := map[string]interface{}{}
+	err = toml.Unmarshal(out, &doc2)
+	require.NoError(t, err)
 
-	if !reflect.DeepEqual(jsonExpected, jsonTest) {
-		t.Logf("Diff:\n%s", spew.Sdump(jsonExpected, jsonTest))
-		t.Fatal("parsed TOML tree is different than expected structure")
-	}
+	require.Equal(t, refDoc, doc2)
 }
 
-func testgenTranslate(tomlData interface{}) interface{} {
-	switch orig := tomlData.(type) {
-	case map[string]interface{}:
-		typed := make(map[string]interface{}, len(orig))
-		for k, v := range orig {
-			typed[k] = testgenTranslate(v)
-		}
-		return typed
-	case *Tree:
-		return testgenTranslate(*orig)
-	case Tree:
-		keys := orig.Keys()
-		typed := make(map[string]interface{}, len(keys))
-		for _, k := range keys {
-			typed[k] = testgenTranslate(orig.GetPath([]string{k}))
-		}
-		return typed
-	case []*Tree:
-		typed := make([]map[string]interface{}, len(orig))
-		for i, v := range orig {
-			typed[i] = testgenTranslate(v).(map[string]interface{})
-		}
-		return typed
-	case []map[string]interface{}:
-		typed := make([]map[string]interface{}, len(orig))
-		for i, v := range orig {
-			typed[i] = testgenTranslate(v).(map[string]interface{})
-		}
-		return typed
-	case []interface{}:
-		typed := make([]interface{}, len(orig))
-		for i, v := range orig {
-			typed[i] = testgenTranslate(v)
-		}
-		return testgenTag("array", typed)
-	case time.Time:
-		return testgenTag("datetime", orig.Format("2006-01-02T15:04:05Z"))
-	case bool:
-		return testgenTag("bool", fmt.Sprintf("%v", orig))
-	case int64:
-		return testgenTag("integer", fmt.Sprintf("%d", orig))
-	case float64:
-		return testgenTag("float", fmt.Sprintf("%v", orig))
-	case string:
-		return testgenTag("string", orig)
+func testgenBuildRefDoc(jsonRef string) map[string]interface{} {
+	descTree := map[string]interface{}{}
+
+	err := json.Unmarshal([]byte(jsonRef), &descTree)
+	if err != nil {
+		panic(fmt.Sprintf("reference doc should be valid JSON: %s", err))
 	}
 
-	panic(fmt.Sprintf("Unknown type: %T", tomlData))
+	doc := testGenTranslateDesc(descTree)
+	if doc == nil {
+		return map[string]interface{}{}
+	}
+
+	return doc.(map[string]interface{})
 }
 
-func testgenTag(typeName string, data interface{}) map[string]interface{} {
-	return map[string]interface{}{
-		"type":  typeName,
-		"value": data,
+//nolint:funlen,gocognit,cyclop
+func testGenTranslateDesc(input interface{}) interface{} {
+	a, ok := input.([]interface{})
+	if ok {
+		xs := make([]interface{}, len(a))
+		for i, v := range a {
+			xs[i] = testGenTranslateDesc(v)
+		}
+
+		return xs
 	}
+
+	d, ok := input.(map[string]interface{})
+	if !ok {
+		panic(fmt.Sprintf("input should be valid map[string]: %v", input))
+	}
+
+	var (
+		dtype  string
+		dvalue interface{}
+	)
+
+	//nolint:nestif
+	if len(d) == 2 {
+		dtypeiface, ok := d["type"]
+		if ok {
+			dvalue, ok = d["value"]
+			if ok {
+				dtype = dtypeiface.(string)
+
+				switch dtype {
+				case "string":
+					return dvalue.(string)
+				case "float":
+					v, err := strconv.ParseFloat(dvalue.(string), 64)
+					if err != nil {
+						panic(fmt.Sprintf("invalid float '%s': %s", dvalue, err))
+					}
+
+					return v
+				case "integer":
+					v, err := strconv.ParseInt(dvalue.(string), 10, 64)
+					if err != nil {
+						panic(fmt.Sprintf("invalid int '%s': %s", dvalue, err))
+					}
+
+					return v
+				case "bool":
+					return dvalue.(string) == "true"
+				case "datetime":
+					dt, err := time.Parse("2006-01-02T15:04:05Z", dvalue.(string))
+					if err != nil {
+						panic(fmt.Sprintf("invalid datetime '%s': %s", dvalue, err))
+					}
+
+					return dt
+				case "array":
+					if dvalue == nil {
+						return nil
+					}
+
+					a := dvalue.([]interface{})
+
+					xs := make([]interface{}, len(a))
+
+					for i, v := range a {
+						xs[i] = testGenTranslateDesc(v)
+					}
+
+					return xs
+				}
+
+				panic(fmt.Sprintf("unknown type: %s", dtype))
+			}
+		}
+	}
+
+	dest := map[string]interface{}{}
+	for k, v := range d {
+		dest[k] = testGenTranslateDesc(v)
+	}
+
+	return dest
 }

toml_testgen_test.go

@@ -1,31 +1,41 @@
 // Generated by tomltestgen for toml-test ref 39e37e6 on 2019-03-19T23:58:45-07:00
-package toml
+package toml_test
 
 import (
 	"testing"
 )
 
 func TestInvalidDatetimeMalformedNoLeads(t *testing.T) {
+	t.Parallel()
+
 	input := `no-leads = 1987-7-05T17:45:00Z`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidDatetimeMalformedNoSecs(t *testing.T) {
+	t.Parallel()
+
 	input := `no-secs = 1987-07-05T17:45Z`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidDatetimeMalformedNoT(t *testing.T) {
+	t.Parallel()
+
 	input := `no-t = 1987-07-0517:45:00Z`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidDatetimeMalformedWithMilli(t *testing.T) {
+	t.Parallel()
+
 	input := `with-milli = 1987-07-5T17:45:00.12Z`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidDuplicateKeyTable(t *testing.T) {
+	t.Parallel()
+
 	input := `[fruit]
 type = "apple"
 
@@ -35,71 +45,97 @@ apple = "yes"`
 }
 
 func TestInvalidDuplicateKeys(t *testing.T) {
+	t.Parallel()
+
 	input := `dupe = false
 dupe = true`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidDuplicateTables(t *testing.T) {
+	t.Parallel()
+
 	input := `[a]
 [a]`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidEmptyImplicitTable(t *testing.T) {
+	t.Parallel()
+
 	input := `[naughty..naughty]`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidEmptyTable(t *testing.T) {
+	t.Parallel()
+
 	input := `[]`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidFloatNoLeadingZero(t *testing.T) {
+	t.Parallel()
+
 	input := `answer = .12345
 neganswer = -.12345`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidFloatNoTrailingDigits(t *testing.T) {
+	t.Parallel()
+
 	input := `answer = 1.
 neganswer = -1.`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidKeyEmpty(t *testing.T) {
+	t.Parallel()
+
 	input := ` = 1`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidKeyHash(t *testing.T) {
+	t.Parallel()
+
 	input := `a# = 1`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidKeyNewline(t *testing.T) {
+	t.Parallel()
+
 	input := `a
 = 1`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidKeyOpenBracket(t *testing.T) {
+	t.Parallel()
+
 	input := `[abc = 1`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidKeySingleOpenBracket(t *testing.T) {
+	t.Parallel()
+
 	input := `[`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidKeySpace(t *testing.T) {
+	t.Parallel()
+
 	input := `a b = 1`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidKeyStartBracket(t *testing.T) {
+	t.Parallel()
+
 	input := `[a]
 [xyz = 5
 [b]`
@@ -107,31 +143,43 @@ func TestInvalidKeyStartBracket(t *testing.T) {
 }
 
 func TestInvalidKeyTwoEquals(t *testing.T) {
+	t.Parallel()
+
 	input := `key= = 1`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidStringBadByteEscape(t *testing.T) {
+	t.Parallel()
+
 	input := `naughty = "\xAg"`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidStringBadEscape(t *testing.T) {
+	t.Parallel()
+
 	input := `invalid-escape = "This string has a bad \a escape character."`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidStringByteEscapes(t *testing.T) {
+	t.Parallel()
+
 	input := `answer = "\x33"`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidStringNoClose(t *testing.T) {
+	t.Parallel()
+
 	input := `no-ending-quote = "One time, at band camp`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidTableArrayImplicit(t *testing.T) {
+	t.Parallel()
+
 	input := "# This test is a bit tricky. It should fail because the first use of\n" +
 		"# `[[albums.songs]]` without first declaring `albums` implies that `albums`\n" +
 		"# must be a table. The alternative would be quite weird. Namely, it wouldn't\n" +
@@ -150,46 +198,62 @@ func TestInvalidTableArrayImplicit(t *testing.T) {
 }
 
 func TestInvalidTableArrayMalformedBracket(t *testing.T) {
+	t.Parallel()
+
 	input := `[[albums]
 name = "Born to Run"`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidTableArrayMalformedEmpty(t *testing.T) {
+	t.Parallel()
+
 	input := `[[]]
 name = "Born to Run"`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidTableEmpty(t *testing.T) {
+	t.Parallel()
+
 	input := `[]`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidTableNestedBracketsClose(t *testing.T) {
+	t.Parallel()
+
 	input := `[a]b]
 zyx = 42`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidTableNestedBracketsOpen(t *testing.T) {
+	t.Parallel()
+
 	input := `[a[b]
 zyx = 42`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidTableWhitespace(t *testing.T) {
+	t.Parallel()
+
 	input := `[invalid key]`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidTableWithPound(t *testing.T) {
+	t.Parallel()
+
 	input := `[key#group]
 answer = 42`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidTextAfterArrayEntries(t *testing.T) {
+	t.Parallel()
+
 	input := `array = [
   "Is there life after an array separator?", No
   "Entry"
@@ -198,21 +262,29 @@ func TestInvalidTextAfterArrayEntries(t *testing.T) {
 }
 
 func TestInvalidTextAfterInteger(t *testing.T) {
+	t.Parallel()
+
 	input := `answer = 42 the ultimate answer?`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidTextAfterString(t *testing.T) {
+	t.Parallel()
+
 	input := `string = "Is there life after strings?" No.`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidTextAfterTable(t *testing.T) {
+	t.Parallel()
+
 	input := `[error] this shouldn't be here`
 	testgenInvalid(t, input)
 }
 
 func TestInvalidTextBeforeArraySeparator(t *testing.T) {
+	t.Parallel()
+
 	input := `array = [
   "Is there life before an array separator?" No,
   "Entry"
@@ -221,6 +293,8 @@ func TestInvalidTextBeforeArraySeparator(t *testing.T) {
 }
 
 func TestInvalidTextInArray(t *testing.T) {
+	t.Parallel()
+
 	input := `array = [
   "Entry 1",
   I don't belong,
@@ -230,6 +304,8 @@ func TestInvalidTextInArray(t *testing.T) {
 }
 
 func TestValidArrayEmpty(t *testing.T) {
+	t.Parallel()
+
 	input := `thevoid = [[[[[]]]]]`
 	jsonRef := `{
     "thevoid": { "type": "array", "value": [
@@ -246,6 +322,8 @@ func TestValidArrayEmpty(t *testing.T) {
 }
 
 func TestValidArrayNospaces(t *testing.T) {
+	t.Parallel()
+
 	input := `ints = [1,2,3]`
 	jsonRef := `{
     "ints": {
@@ -261,6 +339,8 @@ func TestValidArrayNospaces(t *testing.T) {
 }
 
 func TestValidArraysHetergeneous(t *testing.T) {
+	t.Parallel()
+
 	input := `mixed = [[1, 2], ["a", "b"], [1.1, 2.1]]`
 	jsonRef := `{
     "mixed": {
@@ -285,6 +365,8 @@ func TestValidArraysHetergeneous(t *testing.T) {
 }
 
 func TestValidArraysNested(t *testing.T) {
+	t.Parallel()
+
 	input := `nest = [["a"], ["b"]]`
 	jsonRef := `{
     "nest": {
@@ -303,6 +385,8 @@ func TestValidArraysNested(t *testing.T) {
 }
 
 func TestValidArrays(t *testing.T) {
+	t.Parallel()
+
 	input := `ints = [1, 2, 3]
 floats = [1.1, 2.1, 3.1]
 strings = ["a", "b", "c"]
@@ -349,6 +433,8 @@ dates = [
 }
 
 func TestValidBool(t *testing.T) {
+	t.Parallel()
+
 	input := `t = true
 f = false`
 	jsonRef := `{
@@ -359,6 +445,8 @@ f = false`
 }
 
 func TestValidCommentsEverywhere(t *testing.T) {
+	t.Parallel()
+
 	input := `# Top comment.
   # Top comment.
 # Top comment.
@@ -368,7 +456,7 @@ func TestValidCommentsEverywhere(t *testing.T) {
 [group] # Comment
 answer = 42 # Comment
 # no-extraneous-keys-please = 999
-# Inbetween comment.
+# In between comment.
 more = [ # Comment
   # What about multiple # comments?
   # Can you handle it?
@@ -399,6 +487,8 @@ more = [ # Comment
 }
 
 func TestValidDatetime(t *testing.T) {
+	t.Parallel()
+
 	input := `bestdayever = 1987-07-05T17:45:00Z`
 	jsonRef := `{
     "bestdayever": {"type": "datetime", "value": "1987-07-05T17:45:00Z"}
@@ -407,12 +497,16 @@ func TestValidDatetime(t *testing.T) {
 }
 
 func TestValidEmpty(t *testing.T) {
+	t.Parallel()
+
 	input := ``
 	jsonRef := `{}`
 	testgenValid(t, input, jsonRef)
 }
 
 func TestValidExample(t *testing.T) {
+	t.Parallel()
+
 	input := `best-day-ever = 1987-07-05T17:45:00Z
 
 [numtheory]
@@ -436,6 +530,8 @@ perfection = [6, 28, 496]`
 }
 
 func TestValidFloat(t *testing.T) {
+	t.Parallel()
+
 	input := `pi = 3.14
 negpi = -3.14`
 	jsonRef := `{
@@ -446,6 +542,8 @@ negpi = -3.14`
 }
 
 func TestValidImplicitAndExplicitAfter(t *testing.T) {
+	t.Parallel()
+
 	input := `[a.b.c]
 answer = 42
 
@@ -465,6 +563,8 @@ better = 43`
 }
 
 func TestValidImplicitAndExplicitBefore(t *testing.T) {
+	t.Parallel()
+
 	input := `[a]
 better = 43
 
@@ -484,6 +584,8 @@ answer = 42`
 }
 
 func TestValidImplicitGroups(t *testing.T) {
+	t.Parallel()
+
 	input := `[a.b.c]
 answer = 42`
 	jsonRef := `{
@@ -499,6 +601,8 @@ answer = 42`
 }
 
 func TestValidInteger(t *testing.T) {
+	t.Parallel()
+
 	input := `answer = 42
 neganswer = -42`
 	jsonRef := `{
@@ -509,6 +613,8 @@ neganswer = -42`
 }
 
 func TestValidKeyEqualsNospace(t *testing.T) {
+	t.Parallel()
+
 	input := `answer=42`
 	jsonRef := `{
     "answer": {"type": "integer", "value": "42"}
@@ -517,6 +623,8 @@ func TestValidKeyEqualsNospace(t *testing.T) {
 }
 
 func TestValidKeySpace(t *testing.T) {
+	t.Parallel()
+
 	input := `"a b" = 1`
 	jsonRef := `{
     "a b": {"type": "integer", "value": "1"}
@@ -525,6 +633,8 @@ func TestValidKeySpace(t *testing.T) {
 }
 
 func TestValidKeySpecialChars(t *testing.T) {
+	t.Parallel()
+
 	input := "\"~!@$^&*()_+-`1234567890[]|/?><.,;:'\" = 1\n"
 	jsonRef := "{\n" +
 		"    \"~!@$^&*()_+-`1234567890[]|/?><.,;:'\": {\n" +
@@ -535,6 +645,8 @@ func TestValidKeySpecialChars(t *testing.T) {
 }
 
 func TestValidLongFloat(t *testing.T) {
+	t.Parallel()
+
 	input := `longpi = 3.141592653589793
 neglongpi = -3.141592653589793`
 	jsonRef := `{
@@ -545,6 +657,8 @@ neglongpi = -3.141592653589793`
 }
 
 func TestValidLongInteger(t *testing.T) {
+	t.Parallel()
+
 	input := `answer = 9223372036854775807
 neganswer = -9223372036854775808`
 	jsonRef := `{
@@ -555,6 +669,8 @@ neganswer = -9223372036854775808`
 }
 
 func TestValidMultilineString(t *testing.T) {
+	t.Parallel()
+
 	input := `multiline_empty_one = """"""
 multiline_empty_two = """
 """
@@ -612,6 +728,8 @@ equivalent_three = """\
 }
 
 func TestValidRawMultilineString(t *testing.T) {
+	t.Parallel()
+
 	input := `oneline = '''This string has a ' quote character.'''
 firstnl = '''
 This string has a ' quote character.'''
@@ -639,6 +757,8 @@ in it.'''`
 }
 
 func TestValidRawString(t *testing.T) {
+	t.Parallel()
+
 	input := `backspace = 'This string has a \b backspace character.'
 tab = 'This string has a \t tab character.'
 newline = 'This string has a \n new line character.'
@@ -680,6 +800,8 @@ backslash = 'This string has a \\ backslash character.'`
 }
 
 func TestValidStringEmpty(t *testing.T) {
+	t.Parallel()
+
 	input := `answer = ""`
 	jsonRef := `{
     "answer": {
@@ -691,6 +813,8 @@ func TestValidStringEmpty(t *testing.T) {
 }
 
 func TestValidStringEscapes(t *testing.T) {
+	t.Parallel()
+
 	input := `backspace = "This string has a \b backspace character."
 tab = "This string has a \t tab character."
 newline = "This string has a \n new line character."
@@ -752,6 +876,8 @@ notunicode4 = "This string does not have a unicode \\\u0075 escape."`
 }
 
 func TestValidStringSimple(t *testing.T) {
+	t.Parallel()
+
 	input := `answer = "You are not drinking enough whisky."`
 	jsonRef := `{
     "answer": {
@@ -763,6 +889,8 @@ func TestValidStringSimple(t *testing.T) {
 }
 
 func TestValidStringWithPound(t *testing.T) {
+	t.Parallel()
+
 	input := `pound = "We see no # comments here."
 poundcomment = "But there are # some comments here." # Did I # mess you up?`
 	jsonRef := `{
@@ -776,6 +904,8 @@ poundcomment = "But there are # some comments here." # Did I # mess you up?`
 }
 
 func TestValidTableArrayImplicit(t *testing.T) {
+	t.Parallel()
+
 	input := `[[albums.songs]]
 name = "Glory Days"`
 	jsonRef := `{
@@ -789,6 +919,8 @@ name = "Glory Days"`
 }
 
 func TestValidTableArrayMany(t *testing.T) {
+	t.Parallel()
+
 	input := `[[people]]
 first_name = "Bruce"
 last_name = "Springsteen"
@@ -820,6 +952,8 @@ last_name = "Seger"`
 }
 
 func TestValidTableArrayNest(t *testing.T) {
+	t.Parallel()
+
 	input := `[[albums]]
 name = "Born to Run"
 
@@ -831,7 +965,7 @@ name = "Born to Run"
 
 [[albums]]
 name = "Born in the USA"
-  
+
   [[albums.songs]]
   name = "Glory Days"
 
@@ -859,6 +993,8 @@ name = "Born in the USA"
 }
 
 func TestValidTableArrayOne(t *testing.T) {
+	t.Parallel()
+
 	input := `[[people]]
 first_name = "Bruce"
 last_name = "Springsteen"`
@@ -874,6 +1010,8 @@ last_name = "Springsteen"`
 }
 
 func TestValidTableEmpty(t *testing.T) {
+	t.Parallel()
+
 	input := `[a]`
 	jsonRef := `{
     "a": {}
@@ -882,6 +1020,8 @@ func TestValidTableEmpty(t *testing.T) {
 }
 
 func TestValidTableSubEmpty(t *testing.T) {
+	t.Parallel()
+
 	input := `[a]
 [a.b]`
 	jsonRef := `{
@@ -891,6 +1031,8 @@ func TestValidTableSubEmpty(t *testing.T) {
 }
 
 func TestValidTableWhitespace(t *testing.T) {
+	t.Parallel()
+
 	input := `["valid key"]`
 	jsonRef := `{
     "valid key": {}
@@ -899,6 +1041,8 @@ func TestValidTableWhitespace(t *testing.T) {
 }
 
 func TestValidTableWithPound(t *testing.T) {
+	t.Parallel()
+
 	input := `["key#group"]
 answer = 42`
 	jsonRef := `{
@@ -910,6 +1054,8 @@ answer = 42`
 }
 
 func TestValidUnicodeEscape(t *testing.T) {
+	t.Parallel()
+
 	input := `answer4 = "\u03B4"
 answer8 = "\U000003B4"`
 	jsonRef := `{
@@ -920,6 +1066,8 @@ answer8 = "\U000003B4"`
 }
 
 func TestValidUnicodeLiteral(t *testing.T) {
+	t.Parallel()
+
 	input := `answer = "δ"`
 	jsonRef := `{
     "answer": {"type": "string", "value": "δ"}

tomlpub.go

@@ -1,71 +0,0 @@
-package toml
-
-// PubTOMLValue wrapping tomlValue in order to access all properties from outside.
-type PubTOMLValue = tomlValue
-
-func (ptv *PubTOMLValue) Value() interface{} {
-	return ptv.value
-}
-func (ptv *PubTOMLValue) Comment() string {
-	return ptv.comment
-}
-func (ptv *PubTOMLValue) Commented() bool {
-	return ptv.commented
-}
-func (ptv *PubTOMLValue) Multiline() bool {
-	return ptv.multiline
-}
-func (ptv *PubTOMLValue) Position() Position {
-	return ptv.position
-}
-
-func (ptv *PubTOMLValue) SetValue(v interface{}) {
-	ptv.value = v
-}
-func (ptv *PubTOMLValue) SetComment(s string) {
-	ptv.comment = s
-}
-func (ptv *PubTOMLValue) SetCommented(c bool) {
-	ptv.commented = c
-}
-func (ptv *PubTOMLValue) SetMultiline(m bool) {
-	ptv.multiline = m
-}
-func (ptv *PubTOMLValue) SetPosition(p Position) {
-	ptv.position = p
-}
-
-// PubTree wrapping Tree in order to access all properties from outside.
-type PubTree = Tree
-
-func (pt *PubTree) Values() map[string]interface{} {
-	return pt.values
-}
-
-func (pt *PubTree) Comment() string {
-	return pt.comment
-}
-
-func (pt *PubTree) Commented() bool {
-	return pt.commented
-}
-
-func (pt *PubTree) Inline() bool {
-	return pt.inline
-}
-
-func (pt *PubTree) SetValues(v map[string]interface{}) {
-	pt.values = v
-}
-
-func (pt *PubTree) SetComment(c string) {
-	pt.comment = c
-}
-
-func (pt *PubTree) SetCommented(c bool) {
-	pt.commented = c
-}
-
-func (pt *PubTree) SetInline(i bool) {
-	pt.inline = i
-}

tomltree_create.go

@@ -1,155 +0,0 @@
-package toml
-
-import (
-	"fmt"
-	"reflect"
-	"time"
-)
-
-var kindToType = [reflect.String + 1]reflect.Type{
-	reflect.Bool:    reflect.TypeOf(true),
-	reflect.String:  reflect.TypeOf(""),
-	reflect.Float32: reflect.TypeOf(float64(1)),
-	reflect.Float64: reflect.TypeOf(float64(1)),
-	reflect.Int:     reflect.TypeOf(int64(1)),
-	reflect.Int8:    reflect.TypeOf(int64(1)),
-	reflect.Int16:   reflect.TypeOf(int64(1)),
-	reflect.Int32:   reflect.TypeOf(int64(1)),
-	reflect.Int64:   reflect.TypeOf(int64(1)),
-	reflect.Uint:    reflect.TypeOf(uint64(1)),
-	reflect.Uint8:   reflect.TypeOf(uint64(1)),
-	reflect.Uint16:  reflect.TypeOf(uint64(1)),
-	reflect.Uint32:  reflect.TypeOf(uint64(1)),
-	reflect.Uint64:  reflect.TypeOf(uint64(1)),
-}
-
-// typeFor returns a reflect.Type for a reflect.Kind, or nil if none is found.
-// supported values:
-// string, bool, int64, uint64, float64, time.Time, int, int8, int16, int32, uint, uint8, uint16, uint32, float32
-func typeFor(k reflect.Kind) reflect.Type {
-	if k > 0 && int(k) < len(kindToType) {
-		return kindToType[k]
-	}
-	return nil
-}
-
-func simpleValueCoercion(object interface{}) (interface{}, error) {
-	switch original := object.(type) {
-	case string, bool, int64, uint64, float64, time.Time:
-		return original, nil
-	case int:
-		return int64(original), nil
-	case int8:
-		return int64(original), nil
-	case int16:
-		return int64(original), nil
-	case int32:
-		return int64(original), nil
-	case uint:
-		return uint64(original), nil
-	case uint8:
-		return uint64(original), nil
-	case uint16:
-		return uint64(original), nil
-	case uint32:
-		return uint64(original), nil
-	case float32:
-		return float64(original), nil
-	case fmt.Stringer:
-		return original.String(), nil
-	case []interface{}:
-		value := reflect.ValueOf(original)
-		length := value.Len()
-		arrayValue := reflect.MakeSlice(value.Type(), 0, length)
-		for i := 0; i < length; i++ {
-			val := value.Index(i).Interface()
-			simpleValue, err := simpleValueCoercion(val)
-			if err != nil {
-				return nil, err
-			}
-			arrayValue = reflect.Append(arrayValue, reflect.ValueOf(simpleValue))
-		}
-		return arrayValue.Interface(), nil
-	default:
-		return nil, fmt.Errorf("cannot convert type %T to Tree", object)
-	}
-}
-
-func sliceToTree(object interface{}) (interface{}, error) {
-	// arrays are a bit tricky, since they can represent either a
-	// collection of simple values, which is represented by one
-	// *tomlValue, or an array of tables, which is represented by an
-	// array of *Tree.
-
-	// holding the assumption that this function is called from toTree only when value.Kind() is Array or Slice
-	value := reflect.ValueOf(object)
-	insideType := value.Type().Elem()
-	length := value.Len()
-	if length > 0 {
-		insideType = reflect.ValueOf(value.Index(0).Interface()).Type()
-	}
-	if insideType.Kind() == reflect.Map {
-		// this is considered as an array of tables
-		tablesArray := make([]*Tree, 0, length)
-		for i := 0; i < length; i++ {
-			table := value.Index(i)
-			tree, err := toTree(table.Interface())
-			if err != nil {
-				return nil, err
-			}
-			tablesArray = append(tablesArray, tree.(*Tree))
-		}
-		return tablesArray, nil
-	}
-
-	sliceType := typeFor(insideType.Kind())
-	if sliceType == nil {
-		sliceType = insideType
-	}
-
-	arrayValue := reflect.MakeSlice(reflect.SliceOf(sliceType), 0, length)
-
-	for i := 0; i < length; i++ {
-		val := value.Index(i).Interface()
-		simpleValue, err := simpleValueCoercion(val)
-		if err != nil {
-			return nil, err
-		}
-		arrayValue = reflect.Append(arrayValue, reflect.ValueOf(simpleValue))
-	}
-	return &tomlValue{value: arrayValue.Interface(), position: Position{}}, nil
-}
-
-func toTree(object interface{}) (interface{}, error) {
-	value := reflect.ValueOf(object)
-
-	if value.Kind() == reflect.Map {
-		values := map[string]interface{}{}
-		keys := value.MapKeys()
-		for _, key := range keys {
-			if key.Kind() != reflect.String {
-				if _, ok := key.Interface().(string); !ok {
-					return nil, fmt.Errorf("map key needs to be a string, not %T (%v)", key.Interface(), key.Kind())
-				}
-			}
-
-			v := value.MapIndex(key)
-			newValue, err := toTree(v.Interface())
-			if err != nil {
-				return nil, err
-			}
-			values[key.String()] = newValue
-		}
-		return &Tree{values: values, position: Position{}}, nil
-	}
-
-	if value.Kind() == reflect.Array || value.Kind() == reflect.Slice {
-		return sliceToTree(object)
-	}
-
-	simpleValue, err := simpleValueCoercion(object)
-	if err != nil {
-		return nil, err
-	}
-	return &tomlValue{value: simpleValue, position: Position{}}, nil
-}

tomltree_create_test.go

@@ -1,243 +0,0 @@
-package toml
-
-import (
-	"reflect"
-	"strconv"
-	"testing"
-	"time"
-)
-
-type customString string
-
-type stringer struct{}
-
-func (s stringer) String() string {
-	return "stringer"
-}
-
-func validate(t *testing.T, path string, object interface{}) {
-	switch o := object.(type) {
-	case *Tree:
-		for key, tree := range o.values {
-			validate(t, path+"."+key, tree)
-		}
-	case []*Tree:
-		for index, tree := range o {
-			validate(t, path+"."+strconv.Itoa(index), tree)
-		}
-	case *tomlValue:
-		switch o.value.(type) {
-		case int64, uint64, bool, string, float64, time.Time,
-			[]int64, []uint64, []bool, []string, []float64, []time.Time:
-		default:
-			t.Fatalf("tomlValue at key %s containing incorrect type %T", path, o.value)
-		}
-	default:
-		t.Fatalf("value at key %s is of incorrect type %T", path, object)
-	}
-	t.Logf("validation ok %s as %T", path, object)
-}
-
-func validateTree(t *testing.T, tree *Tree) {
-	validate(t, "", tree)
-}
-
-func TestTreeCreateToTree(t *testing.T) {
-	data := map[string]interface{}{
-		"a_string": "bar",
-		"an_int":   42,
-		"time":     time.Now(),
-		"int8":     int8(2),
-		"int16":    int16(2),
-		"int32":    int32(2),
-		"uint8":    uint8(2),
-		"uint16":   uint16(2),
-		"uint32":   uint32(2),
-		"float32":  float32(2),
-		"a_bool":   false,
-		"stringer": stringer{},
-		"nested": map[string]interface{}{
-			"foo": "bar",
-		},
-		"array":                 []string{"a", "b", "c"},
-		"array_uint":            []uint{uint(1), uint(2)},
-		"array_table":           []map[string]interface{}{{"sub_map": 52}},
-		"array_times":           []time.Time{time.Now(), time.Now()},
-		"map_times":             map[string]time.Time{"now": time.Now()},
-		"custom_string_map_key": map[customString]interface{}{customString("custom"): "custom"},
-	}
-	tree, err := TreeFromMap(data)
-	if err != nil {
-		t.Fatal("unexpected error:", err)
-	}
-	validateTree(t, tree)
-}
-
-func TestTreeCreateToTreeInvalidLeafType(t *testing.T) {
-	_, err := TreeFromMap(map[string]interface{}{"foo": t})
-	expected := "cannot convert type *testing.T to Tree"
-	if err.Error() != expected {
-		t.Fatalf("expected error %s, got %s", expected, err.Error())
-	}
-}
-
-func TestTreeCreateToTreeInvalidMapKeyType(t *testing.T) {
-	_, err := TreeFromMap(map[string]interface{}{"foo": map[int]interface{}{2: 1}})
-	expected := "map key needs to be a string, not int (int)"
-	if err.Error() != expected {
-		t.Fatalf("expected error %s, got %s", expected, err.Error())
-	}
-}
-
-func TestTreeCreateToTreeInvalidArrayMemberType(t *testing.T) {
-	_, err := TreeFromMap(map[string]interface{}{"foo": []*testing.T{t}})
-	expected := "cannot convert type *testing.T to Tree"
-	if err.Error() != expected {
-		t.Fatalf("expected error %s, got %s", expected, err.Error())
-	}
-}
-
-func TestTreeCreateToTreeInvalidTableGroupType(t *testing.T) {
-	_, err := TreeFromMap(map[string]interface{}{"foo": []map[string]interface{}{{"hello": t}}})
-	expected := "cannot convert type *testing.T to Tree"
-	if err.Error() != expected {
-		t.Fatalf("expected error %s, got %s", expected, err.Error())
-	}
-}
-
-func TestRoundTripArrayOfTables(t *testing.T) {
-	orig := "\n[[stuff]]\n  name = \"foo\"\n  things = [\"a\", \"b\"]\n"
-	tree, err := Load(orig)
-	if err != nil {
-		t.Fatalf("unexpected error: %s", err)
-	}
-
-	m := tree.ToMap()
-
-	tree, err = TreeFromMap(m)
-	if err != nil {
-		t.Fatalf("unexpected error: %s", err)
-	}
-	want := orig
-	got := tree.String()
-
-	if got != want {
-		t.Errorf("want:\n%s\ngot:\n%s", want, got)
-	}
-}
-
-func TestTomlSliceOfSlice(t *testing.T) {
-	tree, err := Load(` hosts=[["10.1.0.107:9092","10.1.0.107:9093", "192.168.0.40:9094"] ] `)
-	m := tree.ToMap()
-	tree, err = TreeFromMap(m)
-	if err != nil {
-		t.Error("should not error", err)
-	}
-	type Struct struct {
-		Hosts [][]string
-	}
-	var actual Struct
-	tree.Unmarshal(&actual)
-
-	expected := Struct{Hosts: [][]string{[]string{"10.1.0.107:9092", "10.1.0.107:9093", "192.168.0.40:9094"}}}
-
-	if !reflect.DeepEqual(actual, expected) {
-		t.Errorf("Bad unmarshal: expected %+v, got %+v", expected, actual)
-	}
-}
-
-func TestTomlSliceOfSliceOfSlice(t *testing.T) {
-	tree, err := Load(` hosts=[[["10.1.0.107:9092","10.1.0.107:9093", "192.168.0.40:9094"] ]] `)
-	m := tree.ToMap()
-	tree, err = TreeFromMap(m)
-	if err != nil {
-		t.Error("should not error", err)
-	}
-	type Struct struct {
-		Hosts [][][]string
-	}
-	var actual Struct
-	tree.Unmarshal(&actual)
-
-	expected := Struct{Hosts: [][][]string{[][]string{[]string{"10.1.0.107:9092", "10.1.0.107:9093", "192.168.0.40:9094"}}}}
-
-	if !reflect.DeepEqual(actual, expected) {
-		t.Errorf("Bad unmarshal: expected %+v, got %+v", expected, actual)
-	}
-}
-
-func TestTomlSliceOfSliceInt(t *testing.T) {
-	tree, err := Load(` hosts=[[1,2,3],[4,5,6] ] `)
-	m := tree.ToMap()
-	tree, err = TreeFromMap(m)
-	if err != nil {
-		t.Error("should not error", err)
-	}
-	type Struct struct {
-		Hosts [][]int
-	}
-	var actual Struct
-	err = tree.Unmarshal(&actual)
-	if err != nil {
-		t.Error("should not error", err)
-	}
-
-	expected := Struct{Hosts: [][]int{[]int{1, 2, 3}, []int{4, 5, 6}}}
-
-	if !reflect.DeepEqual(actual, expected) {
-		t.Errorf("Bad unmarshal: expected %+v, got %+v", expected, actual)
-	}
-
-}
-func TestTomlSliceOfSliceInt64(t *testing.T) {
-	tree, err := Load(` hosts=[[1,2,3],[4,5,6] ] `)
-	m := tree.ToMap()
-	tree, err = TreeFromMap(m)
-	if err != nil {
-		t.Error("should not error", err)
-	}
-	type Struct struct {
-		Hosts [][]int64
-	}
-	var actual Struct
-	err = tree.Unmarshal(&actual)
-	if err != nil {
-		t.Error("should not error", err)
-	}
-
-	expected := Struct{Hosts: [][]int64{[]int64{1, 2, 3}, []int64{4, 5, 6}}}
-
-	if !reflect.DeepEqual(actual, expected) {
-		t.Errorf("Bad unmarshal: expected %+v, got %+v", expected, actual)
-	}
-
-}
-
-func TestTomlSliceOfSliceInt64FromMap(t *testing.T) {
-	tree, err := TreeFromMap(map[string]interface{}{"hosts": [][]interface{}{[]interface{}{int32(1), int8(2), 3}}})
-	if err != nil {
-		t.Error("should not error", err)
-	}
-	type Struct struct {
-		Hosts [][]int64
-	}
-	var actual Struct
-	err = tree.Unmarshal(&actual)
-	if err != nil {
-		t.Error("should not error", err)
-	}
-
-	expected := Struct{Hosts: [][]int64{[]int64{1, 2, 3}}}
-
-	if !reflect.DeepEqual(actual, expected) {
-		t.Errorf("Bad unmarshal: expected %+v, got %+v", expected, actual)
-	}
-
-}
-func TestTomlSliceOfSliceError(t *testing.T) { // make Codecov happy
-	_, err := TreeFromMap(map[string]interface{}{"hosts": [][]interface{}{[]interface{}{1, 2, []struct{}{}}}})
-	expected := "cannot convert type []struct {} to Tree"
-	if err.Error() != expected {
-		t.Fatalf("unexpected error: %s", err)
-	}
-}

tomltree_write.go

@@ -1,535 +0,0 @@
-package toml
-
-import (
-	"bytes"
-	"fmt"
-	"io"
-	"math"
-	"math/big"
-	"reflect"
-	"sort"
-	"strconv"
-	"strings"
-	"time"
-)
-
-type valueComplexity int
-
-const (
-	valueSimple valueComplexity = iota + 1
-	valueComplex
-)
-
-type sortNode struct {
-	key        string
-	complexity valueComplexity
-}
-
-// Encodes a string to a TOML-compliant multi-line string value
-// This function is a clone of the existing encodeTomlString function, except that whitespace characters
-// are preserved. Quotation marks and backslashes are also not escaped.
-func encodeMultilineTomlString(value string, commented string) string {
-	var b bytes.Buffer
-	adjacentQuoteCount := 0
-
-	b.WriteString(commented)
-	for i, rr := range value {
-		if rr != '"' {
-			adjacentQuoteCount = 0
-		} else {
-			adjacentQuoteCount++
-		}
-		switch rr {
-		case '\b':
-			b.WriteString(`\b`)
-		case '\t':
-			b.WriteString("\t")
-		case '\n':
-			b.WriteString("\n" + commented)
-		case '\f':
-			b.WriteString(`\f`)
-		case '\r':
-			b.WriteString("\r")
-		case '"':
-			if adjacentQuoteCount >= 3 || i == len(value)-1 {
-				adjacentQuoteCount = 0
-				b.WriteString(`\"`)
-			} else {
-				b.WriteString(`"`)
-			}
-		case '\\':
-			b.WriteString(`\`)
-		default:
-			intRr := uint16(rr)
-			if intRr < 0x001F {
-				b.WriteString(fmt.Sprintf("\\u%0.4X", intRr))
-			} else {
-				b.WriteRune(rr)
-			}
-		}
-	}
-	return b.String()
-}
-
-// Encodes a string to a TOML-compliant string value
-func encodeTomlString(value string) string {
-	var b bytes.Buffer
-
-	for _, rr := range value {
-		switch rr {
-		case '\b':
-			b.WriteString(`\b`)
-		case '\t':
-			b.WriteString(`\t`)
-		case '\n':
-			b.WriteString(`\n`)
-		case '\f':
-			b.WriteString(`\f`)
-		case '\r':
-			b.WriteString(`\r`)
-		case '"':
-			b.WriteString(`\"`)
-		case '\\':
-			b.WriteString(`\\`)
-		default:
-			intRr := uint16(rr)
-			if intRr < 0x001F {
-				b.WriteString(fmt.Sprintf("\\u%0.4X", intRr))
-			} else {
-				b.WriteRune(rr)
-			}
-		}
-	}
-	return b.String()
-}
-
-func tomlTreeStringRepresentation(t *Tree, ord marshalOrder) (string, error) {
-	var orderedVals []sortNode
-	switch ord {
-	case OrderPreserve:
-		orderedVals = sortByLines(t)
-	default:
-		orderedVals = sortAlphabetical(t)
-	}
-
-	var values []string
-	for _, node := range orderedVals {
-		k := node.key
-		v := t.values[k]
-
-		repr, err := tomlValueStringRepresentation(v, "", "", ord, false)
-		if err != nil {
-			return "", err
-		}
-		values = append(values, quoteKeyIfNeeded(k)+" = "+repr)
-	}
-	return "{ " + strings.Join(values, ", ") + " }", nil
-}
-
-func tomlValueStringRepresentation(v interface{}, commented string, indent string, ord marshalOrder, arraysOneElementPerLine bool) (string, error) {
-	// this interface check is added to dereference the change made in the writeTo function.
-	// That change was made to allow this function to see formatting options.
-	tv, ok := v.(*tomlValue)
-	if ok {
-		v = tv.value
-	} else {
-		tv = &tomlValue{}
-	}
-
-	switch value := v.(type) {
-	case uint64:
-		return strconv.FormatUint(value, 10), nil
-	case int64:
-		return strconv.FormatInt(value, 10), nil
-	case float64:
-		// Default bit length is full 64
-		bits := 64
-		// Float panics if nan is used
-		if !math.IsNaN(value) {
-			// if 32 bit accuracy is enough to exactly show, use 32
-			_, acc := big.NewFloat(value).Float32()
-			if acc == big.Exact {
-				bits = 32
-			}
-		}
-		if math.Trunc(value) == value {
-			return strings.ToLower(strconv.FormatFloat(value, 'f', 1, bits)), nil
-		}
-		return strings.ToLower(strconv.FormatFloat(value, 'f', -1, bits)), nil
-	case string:
-		if tv.multiline {
-			return "\"\"\"\n" + encodeMultilineTomlString(value, commented) + "\"\"\"", nil
-		}
-		return "\"" + encodeTomlString(value) + "\"", nil
-	case []byte:
-		b, _ := v.([]byte)
-		return string(b), nil
-	case bool:
-		if value {
-			return "true", nil
-		}
-		return "false", nil
-	case time.Time:
-		return value.Format(time.RFC3339), nil
-	case LocalDate:
-		return value.String(), nil
-	case LocalDateTime:
-		return value.String(), nil
-	case LocalTime:
-		return value.String(), nil
-	case *Tree:
-		return tomlTreeStringRepresentation(value, ord)
-	case nil:
-		return "", nil
-	}
-
-	rv := reflect.ValueOf(v)
-
-	if rv.Kind() == reflect.Slice {
-		var values []string
-		for i := 0; i < rv.Len(); i++ {
-			item := rv.Index(i).Interface()
-			itemRepr, err := tomlValueStringRepresentation(item, commented, indent, ord, arraysOneElementPerLine)
-			if err != nil {
-				return "", err
-			}
-			values = append(values, itemRepr)
-		}
-		if arraysOneElementPerLine && len(values) > 1 {
-			stringBuffer := bytes.Buffer{}
-			valueIndent := indent + `  ` // TODO: move that to a shared encoder state
-
-			stringBuffer.WriteString("[\n")
-
-			for _, value := range values {
-				stringBuffer.WriteString(valueIndent)
-				stringBuffer.WriteString(commented + value)
-				stringBuffer.WriteString(`,`)
-				stringBuffer.WriteString("\n")
-			}
-
-			stringBuffer.WriteString(indent + commented + "]")
-
-			return stringBuffer.String(), nil
-		}
-		return "[" + strings.Join(values, ", ") + "]", nil
-	}
-	return "", fmt.Errorf("unsupported value type %T: %v", v, v)
-}
-
-func getTreeArrayLine(trees []*Tree) (line int) {
-	// get lowest line number that is not 0
-	for _, tv := range trees {
-		if tv.position.Line < line || line == 0 {
-			line = tv.position.Line
-		}
-	}
-	return
-}
-
-func sortByLines(t *Tree) (vals []sortNode) {
-	var (
-		line  int
-		lines []int
-		tv    *Tree
-		tom   *tomlValue
-		node  sortNode
-	)
-	vals = make([]sortNode, 0)
-	m := make(map[int]sortNode)
-
-	for k := range t.values {
-		v := t.values[k]
-		switch v.(type) {
-		case *Tree:
-			tv = v.(*Tree)
-			line = tv.position.Line
-			node = sortNode{key: k, complexity: valueComplex}
-		case []*Tree:
-			line = getTreeArrayLine(v.([]*Tree))
-			node = sortNode{key: k, complexity: valueComplex}
-		default:
-			tom = v.(*tomlValue)
-			line = tom.position.Line
-			node = sortNode{key: k, complexity: valueSimple}
-		}
-		lines = append(lines, line)
-		vals = append(vals, node)
-		m[line] = node
-	}
-	sort.Ints(lines)
-
-	for i, line := range lines {
-		vals[i] = m[line]
-	}
-
-	return vals
-}
-
-func sortAlphabetical(t *Tree) (vals []sortNode) {
-	var (
-		node     sortNode
-		simpVals []string
-		compVals []string
-	)
-	vals = make([]sortNode, 0)
-	m := make(map[string]sortNode)
-
-	for k := range t.values {
-		v := t.values[k]
-		switch v.(type) {
-		case *Tree, []*Tree:
-			node = sortNode{key: k, complexity: valueComplex}
-			compVals = append(compVals, node.key)
-		default:
-			node = sortNode{key: k, complexity: valueSimple}
-			simpVals = append(simpVals, node.key)
-		}
-		vals = append(vals, node)
-		m[node.key] = node
-	}
-
-	// Simples first to match previous implementation
-	sort.Strings(simpVals)
-	i := 0
-	for _, key := range simpVals {
-		vals[i] = m[key]
-		i++
-	}
-
-	sort.Strings(compVals)
-	for _, key := range compVals {
-		vals[i] = m[key]
-		i++
-	}
-
-	return vals
-}
-
-func (t *Tree) writeTo(w io.Writer, indent, keyspace string, bytesCount int64, arraysOneElementPerLine bool) (int64, error) {
-	return t.writeToOrdered(w, indent, keyspace, bytesCount, arraysOneElementPerLine, OrderAlphabetical, "  ", false)
-}
-
-func (t *Tree) writeToOrdered(w io.Writer, indent, keyspace string, bytesCount int64, arraysOneElementPerLine bool, ord marshalOrder, indentString string, parentCommented bool) (int64, error) {
-	var orderedVals []sortNode
-
-	switch ord {
-	case OrderPreserve:
-		orderedVals = sortByLines(t)
-	default:
-		orderedVals = sortAlphabetical(t)
-	}
-
-	for _, node := range orderedVals {
-		switch node.complexity {
-		case valueComplex:
-			k := node.key
-			v := t.values[k]
-
-			combinedKey := quoteKeyIfNeeded(k)
-			if keyspace != "" {
-				combinedKey = keyspace + "." + combinedKey
-			}
-
-			switch node := v.(type) {
-			// node has to be of those two types given how keys are sorted above
-			case *Tree:
-				tv, ok := t.values[k].(*Tree)
-				if !ok {
-					return bytesCount, fmt.Errorf("invalid value type at %s: %T", k, t.values[k])
-				}
-				if tv.comment != "" {
-					comment := strings.Replace(tv.comment, "\n", "\n"+indent+"#", -1)
-					start := "# "
-					if strings.HasPrefix(comment, "#") {
-						start = ""
-					}
-					writtenBytesCountComment, errc := writeStrings(w, "\n", indent, start, comment)
-					bytesCount += int64(writtenBytesCountComment)
-					if errc != nil {
-						return bytesCount, errc
-					}
-				}
-
-				var commented string
-				if parentCommented || t.commented || tv.commented {
-					commented = "# "
-				}
-				writtenBytesCount, err := writeStrings(w, "\n", indent, commented, "[", combinedKey, "]\n")
-				bytesCount += int64(writtenBytesCount)
-				if err != nil {
-					return bytesCount, err
-				}
-				bytesCount, err = node.writeToOrdered(w, indent+indentString, combinedKey, bytesCount, arraysOneElementPerLine, ord, indentString, parentCommented || t.commented || tv.commented)
-				if err != nil {
-					return bytesCount, err
-				}
-			case []*Tree:
-				for _, subTree := range node {
-					var commented string
-					if parentCommented || t.commented || subTree.commented {
-						commented = "# "
-					}
-					writtenBytesCount, err := writeStrings(w, "\n", indent, commented, "[[", combinedKey, "]]\n")
-					bytesCount += int64(writtenBytesCount)
-					if err != nil {
-						return bytesCount, err
-					}
-
-					bytesCount, err = subTree.writeToOrdered(w, indent+indentString, combinedKey, bytesCount, arraysOneElementPerLine, ord, indentString, parentCommented || t.commented || subTree.commented)
-					if err != nil {
-						return bytesCount, err
-					}
-				}
-			}
-		default: // Simple
-			k := node.key
-			v, ok := t.values[k].(*tomlValue)
-			if !ok {
-				return bytesCount, fmt.Errorf("invalid value type at %s: %T", k, t.values[k])
-			}
-
-			var commented string
-			if parentCommented || t.commented || v.commented {
-				commented = "# "
-			}
-			repr, err := tomlValueStringRepresentation(v, commented, indent, ord, arraysOneElementPerLine)
-			if err != nil {
-				return bytesCount, err
-			}
-
-			if v.comment != "" {
-				comment := strings.Replace(v.comment, "\n", "\n"+indent+"#", -1)
-				start := "# "
-				if strings.HasPrefix(comment, "#") {
-					start = ""
-				}
-				writtenBytesCountComment, errc := writeStrings(w, "\n", indent, start, comment, "\n")
-				bytesCount += int64(writtenBytesCountComment)
-				if errc != nil {
-					return bytesCount, errc
-				}
-			}
-
-			quotedKey := quoteKeyIfNeeded(k)
-			writtenBytesCount, err := writeStrings(w, indent, commented, quotedKey, " = ", repr, "\n")
-			bytesCount += int64(writtenBytesCount)
-			if err != nil {
-				return bytesCount, err
-			}
-		}
-	}
-
-	return bytesCount, nil
-}
-
-// quote a key if it does not fit the bare key format (A-Za-z0-9_-)
-// quoted keys use the same rules as strings
-func quoteKeyIfNeeded(k string) string {
-	// when encoding a map with the 'quoteMapKeys' option enabled, the tree will contain
-	// keys that have already been quoted.
-	// not an ideal situation, but good enough of a stop gap.
-	if len(k) >= 2 && k[0] == '"' && k[len(k)-1] == '"' {
-		return k
-	}
-	isBare := true
-	for _, r := range k {
-		if !isValidBareChar(r) {
-			isBare = false
-			break
-		}
-	}
-	if isBare {
-		return k
-	}
-	return quoteKey(k)
-}
-
-func quoteKey(k string) string {
-	return "\"" + encodeTomlString(k) + "\""
-}
-
-func writeStrings(w io.Writer, s ...string) (int, error) {
-	var n int
-	for i := range s {
-		b, err := io.WriteString(w, s[i])
-		n += b
-		if err != nil {
-			return n, err
-		}
-	}
-	return n, nil
-}
-
-// WriteTo encode the Tree as Toml and writes it to the writer w.
-// Returns the number of bytes written in case of success, or an error if anything happened.
-func (t *Tree) WriteTo(w io.Writer) (int64, error) {
-	return t.writeTo(w, "", "", 0, false)
-}
-
-// ToTomlString generates a human-readable representation of the current tree.
-// Output spans multiple lines, and is suitable for ingest by a TOML parser.
-// If the conversion cannot be performed, ToString returns a non-nil error.
-func (t *Tree) ToTomlString() (string, error) {
-	b, err := t.Marshal()
-	if err != nil {
-		return "", err
-	}
-	return string(b), nil
-}
-
-// String generates a human-readable representation of the current tree.
-// Alias of ToString. Present to implement the fmt.Stringer interface.
-func (t *Tree) String() string {
-	result, _ := t.ToTomlString()
-	return result
-}
-
-// ToMap recursively generates a representation of the tree using Go built-in structures.
-// The following types are used:
-//
-//	* bool
-//	* float64
-//	* int64
-//	* string
-//	* uint64
-//	* time.Time
-//	* map[string]interface{} (where interface{} is any of this list)
-//	* []interface{} (where interface{} is any of this list)
-func (t *Tree) ToMap() map[string]interface{} {
-	result := map[string]interface{}{}
-
-	for k, v := range t.values {
-		switch node := v.(type) {
-		case []*Tree:
-			var array []interface{}
-			for _, item := range node {
-				array = append(array, item.ToMap())
-			}
-			result[k] = array
-		case *Tree:
-			result[k] = node.ToMap()
-		case *tomlValue:
-			result[k] = tomlValueToGo(node.value)
-		}
-	}
-	return result
-}
-
-func tomlValueToGo(v interface{}) interface{} {
-	if tree, ok := v.(*Tree); ok {
-		return tree.ToMap()
-	}
-
-	rv := reflect.ValueOf(v)
-
-	if rv.Kind() != reflect.Slice {
-		return v
-	}
-	values := make([]interface{}, rv.Len())
-	for i := 0; i < rv.Len(); i++ {
-		item := rv.Index(i).Interface()
-		values[i] = tomlValueToGo(item)
-	}
-	return values
-}

tomltree_write_test.go

@@ -1,437 +0,0 @@
-package toml
-
-import (
-	"bytes"
-	"errors"
-	"fmt"
-	"reflect"
-	"strings"
-	"testing"
-	"time"
-)
-
-type failingWriter struct {
-	failAt  int
-	written int
-	buffer  bytes.Buffer
-}
-
-func (f *failingWriter) Write(p []byte) (n int, err error) {
-	count := len(p)
-	toWrite := f.failAt - (count + f.written)
-	if toWrite < 0 {
-		toWrite = 0
-	}
-	if toWrite > count {
-		f.written += count
-		f.buffer.Write(p)
-		return count, nil
-	}
-
-	f.buffer.Write(p[:toWrite])
-	f.written = f.failAt
-	return toWrite, fmt.Errorf("failingWriter failed after writing %d bytes", f.written)
-}
-
-func assertErrorString(t *testing.T, expected string, err error) {
-	expectedErr := errors.New(expected)
-	if err == nil || err.Error() != expectedErr.Error() {
-		t.Errorf("expecting error %s, but got %s instead", expected, err)
-	}
-}
-
-func TestTreeWriteToEmptyTable(t *testing.T) {
-	doc := `[[empty-tables]]
-[[empty-tables]]`
-
-	toml, err := Load(doc)
-	if err != nil {
-		t.Fatal("Unexpected Load error:", err)
-	}
-	tomlString, err := toml.ToTomlString()
-	if err != nil {
-		t.Fatal("Unexpected ToTomlString error:", err)
-	}
-
-	expected := `
-[[empty-tables]]
-
-[[empty-tables]]
-`
-
-	if tomlString != expected {
-		t.Fatalf("Expected:\n%s\nGot:\n%s", expected, tomlString)
-	}
-}
-
-func TestTreeWriteToTomlString(t *testing.T) {
-	toml, err := Load(`name = { first = "Tom", last = "Preston-Werner" }
-points = { x = 1, y = 2 }`)
-
-	if err != nil {
-		t.Fatal("Unexpected error:", err)
-	}
-
-	tomlString, _ := toml.ToTomlString()
-	reparsedTree, err := Load(tomlString)
-
-	assertTree(t, reparsedTree, err, map[string]interface{}{
-		"name": map[string]interface{}{
-			"first": "Tom",
-			"last":  "Preston-Werner",
-		},
-		"points": map[string]interface{}{
-			"x": int64(1),
-			"y": int64(2),
-		},
-	})
-}
-
-func TestTreeWriteToTomlStringSimple(t *testing.T) {
-	tree, err := Load("[foo]\n\n[[foo.bar]]\na = 42\n\n[[foo.bar]]\na = 69\n")
-	if err != nil {
-		t.Errorf("Test failed to parse: %v", err)
-		return
-	}
-	result, err := tree.ToTomlString()
-	if err != nil {
-		t.Errorf("Unexpected error: %s", err)
-	}
-	expected := "\n[foo]\n\n  [[foo.bar]]\n    a = 42\n\n  [[foo.bar]]\n    a = 69\n"
-	if result != expected {
-		t.Errorf("Expected got '%s', expected '%s'", result, expected)
-	}
-}
-
-func TestTreeWriteToTomlStringKeysOrders(t *testing.T) {
-	for i := 0; i < 100; i++ {
-		tree, _ := Load(`
-		foobar = true
-		bar = "baz"
-		foo = 1
-		[qux]
-		  foo = 1
-		  bar = "baz2"`)
-
-		stringRepr, _ := tree.ToTomlString()
-
-		t.Log("Intermediate string representation:")
-		t.Log(stringRepr)
-
-		r := strings.NewReader(stringRepr)
-		toml, err := LoadReader(r)
-
-		if err != nil {
-			t.Fatal("Unexpected error:", err)
-		}
-
-		assertTree(t, toml, err, map[string]interface{}{
-			"foobar": true,
-			"bar":    "baz",
-			"foo":    1,
-			"qux": map[string]interface{}{
-				"foo": 1,
-				"bar": "baz2",
-			},
-		})
-	}
-}
-
-func testMaps(t *testing.T, actual, expected map[string]interface{}) {
-	if !reflect.DeepEqual(actual, expected) {
-		t.Fatal("trees aren't equal.\n", "Expected:\n", expected, "\nActual:\n", actual)
-	}
-}
-
-func TestTreeWriteToMapSimple(t *testing.T) {
-	tree, _ := Load("a = 42\nb = 17")
-
-	expected := map[string]interface{}{
-		"a": int64(42),
-		"b": int64(17),
-	}
-
-	testMaps(t, tree.ToMap(), expected)
-}
-
-func TestTreeWriteToInvalidTreeSimpleValue(t *testing.T) {
-	tree := Tree{values: map[string]interface{}{"foo": int8(1)}}
-	_, err := tree.ToTomlString()
-	assertErrorString(t, "invalid value type at foo: int8", err)
-}
-
-func TestTreeWriteToInvalidTreeTomlValue(t *testing.T) {
-	tree := Tree{values: map[string]interface{}{"foo": &tomlValue{value: int8(1), comment: "", position: Position{}}}}
-	_, err := tree.ToTomlString()
-	assertErrorString(t, "unsupported value type int8: 1", err)
-}
-
-func TestTreeWriteToInvalidTreeTomlValueArray(t *testing.T) {
-	tree := Tree{values: map[string]interface{}{"foo": &tomlValue{value: int8(1), comment: "", position: Position{}}}}
-	_, err := tree.ToTomlString()
-	assertErrorString(t, "unsupported value type int8: 1", err)
-}
-
-func TestTreeWriteToFailingWriterInSimpleValue(t *testing.T) {
-	toml, _ := Load(`a = 2`)
-	writer := failingWriter{failAt: 0, written: 0}
-	_, err := toml.WriteTo(&writer)
-	assertErrorString(t, "failingWriter failed after writing 0 bytes", err)
-}
-
-func TestTreeWriteToFailingWriterInTable(t *testing.T) {
-	toml, _ := Load(`
-[b]
-a = 2`)
-	writer := failingWriter{failAt: 2, written: 0}
-	_, err := toml.WriteTo(&writer)
-	assertErrorString(t, "failingWriter failed after writing 2 bytes", err)
-
-	writer = failingWriter{failAt: 13, written: 0}
-	_, err = toml.WriteTo(&writer)
-	assertErrorString(t, "failingWriter failed after writing 13 bytes", err)
-}
-
-func TestTreeWriteToFailingWriterInArray(t *testing.T) {
-	toml, _ := Load(`
-[[b]]
-a = 2`)
-	writer := failingWriter{failAt: 2, written: 0}
-	_, err := toml.WriteTo(&writer)
-	assertErrorString(t, "failingWriter failed after writing 2 bytes", err)
-
-	writer = failingWriter{failAt: 15, written: 0}
-	_, err = toml.WriteTo(&writer)
-	assertErrorString(t, "failingWriter failed after writing 15 bytes", err)
-}
-
-func TestTreeWriteToMapExampleFile(t *testing.T) {
-	tree, _ := LoadFile("example.toml")
-	expected := map[string]interface{}{
-		"title": "TOML Example",
-		"owner": map[string]interface{}{
-			"name":         "Tom Preston-Werner",
-			"organization": "GitHub",
-			"bio":          "GitHub Cofounder & CEO\nLikes tater tots and beer.",
-			"dob":          time.Date(1979, time.May, 27, 7, 32, 0, 0, time.UTC),
-		},
-		"database": map[string]interface{}{
-			"server":         "192.168.1.1",
-			"ports":          []interface{}{int64(8001), int64(8001), int64(8002)},
-			"connection_max": int64(5000),
-			"enabled":        true,
-		},
-		"servers": map[string]interface{}{
-			"alpha": map[string]interface{}{
-				"ip": "10.0.0.1",
-				"dc": "eqdc10",
-			},
-			"beta": map[string]interface{}{
-				"ip": "10.0.0.2",
-				"dc": "eqdc10",
-			},
-		},
-		"clients": map[string]interface{}{
-			"data": []interface{}{
-				[]interface{}{"gamma", "delta"},
-				[]interface{}{int64(1), int64(2)},
-			},
-			"score": 4e-08,
-		},
-	}
-	testMaps(t, tree.ToMap(), expected)
-}
-
-func TestTreeWriteToMapWithTablesInMultipleChunks(t *testing.T) {
-	tree, _ := Load(`
-	[[menu.main]]
-        a = "menu 1"
-        b = "menu 2"
-        [[menu.main]]
-        c = "menu 3"
-        d = "menu 4"`)
-	expected := map[string]interface{}{
-		"menu": map[string]interface{}{
-			"main": []interface{}{
-				map[string]interface{}{"a": "menu 1", "b": "menu 2"},
-				map[string]interface{}{"c": "menu 3", "d": "menu 4"},
-			},
-		},
-	}
-	treeMap := tree.ToMap()
-
-	testMaps(t, treeMap, expected)
-}
-
-func TestTreeWriteToMapWithArrayOfInlineTables(t *testing.T) {
-	tree, _ := Load(`
-    	[params]
-	language_tabs = [
-    		{ key = "shell", name = "Shell" },
-    		{ key = "ruby", name = "Ruby" },
-    		{ key = "python", name = "Python" }
-	]`)
-
-	expected := map[string]interface{}{
-		"params": map[string]interface{}{
-			"language_tabs": []interface{}{
-				map[string]interface{}{
-					"key":  "shell",
-					"name": "Shell",
-				},
-				map[string]interface{}{
-					"key":  "ruby",
-					"name": "Ruby",
-				},
-				map[string]interface{}{
-					"key":  "python",
-					"name": "Python",
-				},
-			},
-		},
-	}
-
-	treeMap := tree.ToMap()
-	testMaps(t, treeMap, expected)
-}
-
-func TestTreeWriteToMapWithTableInMixedArray(t *testing.T) {
-	tree, _ := Load(`a = [
-		"foo",
-		[
-			"bar",
-			{baz = "quux"},
-		],
-		[
-			{a = "b"},
-			{c = "d"},
-		],
-	]`)
-	expected := map[string]interface{}{
-		"a": []interface{}{
-			"foo",
-			[]interface{}{
-				"bar",
-				map[string]interface{}{
-					"baz": "quux",
-				},
-			},
-			[]interface{}{
-				map[string]interface{}{
-					"a": "b",
-				},
-				map[string]interface{}{
-					"c": "d",
-				},
-			},
-		},
-	}
-	treeMap := tree.ToMap()
-
-	testMaps(t, treeMap, expected)
-}
-
-func TestTreeWriteToFloat(t *testing.T) {
-	tree, err := Load(`a = 3.0`)
-	if err != nil {
-		t.Fatal(err)
-	}
-	str, err := tree.ToTomlString()
-	if err != nil {
-		t.Fatal(err)
-	}
-	expected := `a = 3.0`
-	if strings.TrimSpace(str) != strings.TrimSpace(expected) {
-		t.Fatalf("Expected:\n%s\nGot:\n%s", expected, str)
-	}
-}
-
-func TestTreeWriteToSpecialFloat(t *testing.T) {
-	expected := `a = +inf
-b = -inf
-c = nan`
-
-	tree, err := Load(expected)
-	if err != nil {
-		t.Fatal(err)
-	}
-	str, err := tree.ToTomlString()
-	if err != nil {
-		t.Fatal(err)
-	}
-	if strings.TrimSpace(str) != strings.TrimSpace(expected) {
-		t.Fatalf("Expected:\n%s\nGot:\n%s", expected, str)
-	}
-}
-
-func TestIssue290(t *testing.T) {
-	tomlString :=
-		`[table]
-"127.0.0.1" = "value"
-"127.0.0.1:8028" = "value"
-"character encoding" = "value"
-"ʎǝʞ" = "value"`
-
-	t1, err := Load(tomlString)
-	if err != nil {
-		t.Fatal("load err:", err)
-	}
-
-	s, err := t1.ToTomlString()
-	if err != nil {
-		t.Fatal("ToTomlString err:", err)
-	}
-
-	_, err = Load(s)
-	if err != nil {
-		t.Fatal("reload err:", err)
-	}
-}
-
-func BenchmarkTreeToTomlString(b *testing.B) {
-	toml, err := Load(sampleHard)
-	if err != nil {
-		b.Fatal("Unexpected error:", err)
-	}
-
-	for i := 0; i < b.N; i++ {
-		_, err := toml.ToTomlString()
-		if err != nil {
-			b.Fatal(err)
-		}
-	}
-}
-
-var sampleHard = `# Test file for TOML
-# Only this one tries to emulate a TOML file written by a user of the kind of parser writers probably hate
-# This part you'll really hate
-
-[the]
-test_string = "You'll hate me after this - #"          # " Annoying, isn't it?
-
-    [the.hard]
-    test_array = [ "] ", " # "]      # ] There you go, parse this!
-    test_array2 = [ "Test #11 ]proved that", "Experiment #9 was a success" ]
-    # You didn't think it'd as easy as chucking out the last #, did you?
-    another_test_string = " Same thing, but with a string #"
-    harder_test_string = " And when \"'s are in the string, along with # \""   # "and comments are there too"
-    # Things will get harder
-
-        [the.hard."bit#"]
-        "what?" = "You don't think some user won't do that?"
-        multi_line_array = [
-            "]",
-            # ] Oh yes I did
-            ]
-
-# Each of the following keygroups/key value pairs should produce an error. Uncomment to them to test
-
-#[error]   if you didn't catch this, your parser is broken
-#string = "Anything other than tabs, spaces and newline after a keygroup or key value pair has ended should produce an error unless it is a comment"   like this
-#array = [
-#         "This might most likely happen in multiline arrays",
-#         Like here,
-#         "or here,
-#         and here"
-#         ]     End of array comment, forgot the #
-#number = 3.14  pi <--again forgot the #         `

unmarshaler.go

@@ -0,0 +1,593 @@
+package toml
+
+import (
+	"encoding"
+	"errors"
+	"fmt"
+	"io"
+	"io/ioutil"
+	"reflect"
+	"time"
+
+	"github.com/pelletier/go-toml/v2/internal/ast"
+	"github.com/pelletier/go-toml/v2/internal/tracker"
+	"github.com/pelletier/go-toml/v2/internal/unsafe"
+)
+
+// Unmarshal deserializes a TOML document into a Go value.
+//
+// It is a shortcut for Decoder.Decode() with the default options.
+func Unmarshal(data []byte, v interface{}) error {
+	p := parser{}
+	p.Reset(data)
+	d := decoder{}
+
+	return d.FromParser(&p, v)
+}
+
+// Decoder reads and decode a TOML document from an input stream.
+type Decoder struct {
+	// input
+	r io.Reader
+
+	// global settings
+	strict bool
+}
+
+// NewDecoder creates a new Decoder that will read from r.
+func NewDecoder(r io.Reader) *Decoder {
+	return &Decoder{r: r}
+}
+
+// SetStrict toggles decoding in stict mode.
+//
+// When the decoder is in strict mode, it will record fields from the document
+// that could not be set on the target value. In that case, the decoder returns
+// a StrictMissingError that can be used to retrieve the individual errors as
+// well as generate a human readable description of the missing fields.
+func (d *Decoder) SetStrict(strict bool) {
+	d.strict = strict
+}
+
+// Decode the whole content of r into v.
+//
+// By default, values in the document that don't exist in the target Go value
+// are ignored. See Decoder.SetStrict() to change this behavior.
+//
+// When a TOML local date, time, or date-time is decoded into a time.Time, its
+// value is represented in time.Local timezone. Otherwise the approriate Local*
+// structure is used.
+//
+// Empty tables decoded in an interface{} create an empty initialized
+// map[string]interface{}.
+//
+// Types implementing the encoding.TextUnmarshaler interface are decoded from a
+// TOML string.
+//
+// When decoding a number, go-toml will return an error if the number is out of
+// bounds for the target type (which includes negative numbers when decoding
+// into an unsigned int).
+//
+// Type mapping
+//
+// List of supported TOML types and their associated accepted Go types:
+//
+//   String           -> string
+//   Integer          -> uint*, int*, depending on size
+//   Float            -> float*, depending on size
+//   Boolean          -> bool
+//   Offset Date-Time -> time.Time
+//   Local Date-time  -> LocalDateTime, time.Time
+//   Local Date       -> LocalDate, time.Time
+//   Local Time       -> LocalTime, time.Time
+//   Array            -> slice and array, depending on elements types
+//   Table            -> map and struct
+//   Inline Table     -> same as Table
+//   Array of Tables  -> same as Array and Table
+func (d *Decoder) Decode(v interface{}) error {
+	b, err := ioutil.ReadAll(d.r)
+	if err != nil {
+		return fmt.Errorf("toml: %w", err)
+	}
+
+	p := parser{}
+	p.Reset(b)
+	dec := decoder{
+		strict: strict{
+			Enabled: d.strict,
+		},
+	}
+
+	return dec.FromParser(&p, v)
+}
+
+type decoder struct {
+	// Tracks position in Go arrays.
+	arrayIndexes map[reflect.Value]int
+
+	// Tracks keys that have been seen, with which type.
+	seen tracker.SeenTracker
+
+	// Strict mode
+	strict strict
+}
+
+func (d *decoder) arrayIndex(shouldAppend bool, v reflect.Value) int {
+	if d.arrayIndexes == nil {
+		d.arrayIndexes = make(map[reflect.Value]int, 1)
+	}
+
+	idx, ok := d.arrayIndexes[v]
+
+	if !ok {
+		d.arrayIndexes[v] = 0
+	} else if shouldAppend {
+		idx++
+		d.arrayIndexes[v] = idx
+	}
+
+	return idx
+}
+
+func (d *decoder) FromParser(p *parser, v interface{}) error {
+	err := d.fromParser(p, v)
+	if err == nil {
+		return d.strict.Error(p.data)
+	}
+
+	var e *decodeError
+	if errors.As(err, &e) {
+		return wrapDecodeError(p.data, e)
+	}
+
+	return err
+}
+
+func keyLocation(node ast.Node) []byte {
+	k := node.Key()
+
+	hasOne := k.Next()
+	if !hasOne {
+		panic("should not be called with empty key")
+	}
+
+	start := k.Node().Data
+	end := k.Node().Data
+
+	for k.Next() {
+		end = k.Node().Data
+	}
+
+	return unsafe.BytesRange(start, end)
+}
+
+//nolint:funlen,cyclop
+func (d *decoder) fromParser(p *parser, v interface{}) error {
+	r := reflect.ValueOf(v)
+	if r.Kind() != reflect.Ptr {
+		return fmt.Errorf("toml: decoding can only be performed into a pointer, not %s", r.Kind())
+	}
+
+	if r.IsNil() {
+		return fmt.Errorf("toml: decoding pointer target cannot be nil")
+	}
+
+	var (
+		skipUntilTable bool
+		root           target = valueTarget(r.Elem())
+	)
+
+	current := root
+
+	for p.NextExpression() {
+		node := p.Expression()
+
+		if node.Kind == ast.KeyValue && skipUntilTable {
+			continue
+		}
+
+		err := d.seen.CheckExpression(node)
+		if err != nil {
+			return err
+		}
+
+		var found bool
+
+		switch node.Kind {
+		case ast.KeyValue:
+			err = d.unmarshalKeyValue(current, node)
+			found = true
+		case ast.Table:
+			d.strict.EnterTable(node)
+
+			current, found, err = d.scopeWithKey(root, node.Key())
+			if err == nil && found {
+				// In case this table points to an interface,
+				// make sure it at least holds something that
+				// looks like a table. Otherwise the information
+				// of a table is lost, and marshal cannot do the
+				// round trip.
+				ensureMapIfInterface(current)
+			}
+		case ast.ArrayTable:
+			d.strict.EnterArrayTable(node)
+			current, found, err = d.scopeWithArrayTable(root, node.Key())
+		default:
+			panic(fmt.Sprintf("this should not be a top level node type: %s", node.Kind))
+		}
+
+		if err != nil {
+			return err
+		}
+
+		if !found {
+			skipUntilTable = true
+
+			d.strict.MissingTable(node)
+		}
+	}
+
+	return p.Error()
+}
+
+// scopeWithKey performs target scoping when unmarshaling an ast.KeyValue node.
+//
+// The goal is to hop from target to target recursively using the names in key.
+// Parts of the key should be used to resolve field names for structs, and as
+// keys when targeting maps.
+//
+// When encountering slices, it should always use its last element, and error
+// if the slice does not have any.
+func (d *decoder) scopeWithKey(x target, key ast.Iterator) (target, bool, error) {
+	var (
+		err   error
+		found bool
+	)
+
+	for key.Next() {
+		n := key.Node()
+
+		x, found, err = d.scopeTableTarget(false, x, string(n.Data))
+		if err != nil || !found {
+			return nil, found, err
+		}
+	}
+
+	return x, true, nil
+}
+
+//nolint:cyclop
+// scopeWithArrayTable performs target scoping when unmarshaling an
+// ast.ArrayTable node.
+//
+// It is the same as scopeWithKey, but when scoping the last part of the key
+// it creates a new element in the array instead of using the last one.
+func (d *decoder) scopeWithArrayTable(x target, key ast.Iterator) (target, bool, error) {
+	var (
+		err   error
+		found bool
+	)
+
+	for key.Next() {
+		n := key.Node()
+		if !n.Next().Valid() { // want to stop at one before last
+			break
+		}
+
+		x, found, err = d.scopeTableTarget(false, x, string(n.Data))
+		if err != nil || !found {
+			return nil, found, err
+		}
+	}
+
+	n := key.Node()
+
+	x, found, err = d.scopeTableTarget(false, x, string(n.Data))
+	if err != nil || !found {
+		return x, found, err
+	}
+
+	v := x.get()
+
+	if v.Kind() == reflect.Ptr {
+		x = scopePtr(x)
+		v = x.get()
+	}
+
+	if v.Kind() == reflect.Interface {
+		x = scopeInterface(true, x)
+		v = x.get()
+	}
+
+	switch v.Kind() {
+	case reflect.Slice:
+		x = scopeSlice(true, x)
+	case reflect.Array:
+		x, err = d.scopeArray(true, x)
+	default:
+	}
+
+	return x, found, err
+}
+
+func (d *decoder) unmarshalKeyValue(x target, node ast.Node) error {
+	assertNode(ast.KeyValue, node)
+
+	d.strict.EnterKeyValue(node)
+	defer d.strict.ExitKeyValue(node)
+
+	x, found, err := d.scopeWithKey(x, node.Key())
+	if err != nil {
+		return err
+	}
+
+	// A struct in the path was not found. Skip this value.
+	if !found {
+		d.strict.MissingField(node)
+
+		return nil
+	}
+
+	return d.unmarshalValue(x, node.Value())
+}
+
+var textUnmarshalerType = reflect.TypeOf(new(encoding.TextUnmarshaler)).Elem()
+
+func tryTextUnmarshaler(x target, node ast.Node) (bool, error) {
+	v := x.get()
+
+	if v.Kind() != reflect.Struct {
+		return false, nil
+	}
+
+	// Special case for time, because we allow to unmarshal to it from
+	// different kind of AST nodes.
+	if v.Type() == timeType {
+		return false, nil
+	}
+
+	if v.Type().Implements(textUnmarshalerType) {
+		err := v.Interface().(encoding.TextUnmarshaler).UnmarshalText(node.Data)
+		if err != nil {
+			return false, newDecodeError(node.Data, "error calling UnmarshalText: %w", err)
+		}
+
+		return true, nil
+	}
+
+	if v.CanAddr() && v.Addr().Type().Implements(textUnmarshalerType) {
+		err := v.Addr().Interface().(encoding.TextUnmarshaler).UnmarshalText(node.Data)
+		if err != nil {
+			return false, newDecodeError(node.Data, "error calling UnmarshalText: %w", err)
+		}
+
+		return true, nil
+	}
+
+	return false, nil
+}
+
+//nolint:cyclop
+func (d *decoder) unmarshalValue(x target, node ast.Node) error {
+	v := x.get()
+
+	if v.Kind() == reflect.Ptr {
+		if !v.Elem().IsValid() {
+			x.set(reflect.New(v.Type().Elem()))
+			v = x.get()
+		}
+
+		return d.unmarshalValue(valueTarget(v.Elem()), node)
+	}
+
+	ok, err := tryTextUnmarshaler(x, node)
+	if ok {
+		return err
+	}
+
+	switch node.Kind {
+	case ast.String:
+		return unmarshalString(x, node)
+	case ast.Bool:
+		return unmarshalBool(x, node)
+	case ast.Integer:
+		return unmarshalInteger(x, node)
+	case ast.Float:
+		return unmarshalFloat(x, node)
+	case ast.Array:
+		return d.unmarshalArray(x, node)
+	case ast.InlineTable:
+		return d.unmarshalInlineTable(x, node)
+	case ast.LocalDateTime:
+		return unmarshalLocalDateTime(x, node)
+	case ast.DateTime:
+		return unmarshalDateTime(x, node)
+	case ast.LocalDate:
+		return unmarshalLocalDate(x, node)
+	default:
+		panic(fmt.Sprintf("unhandled node kind %s", node.Kind))
+	}
+}
+
+func unmarshalLocalDate(x target, node ast.Node) error {
+	assertNode(ast.LocalDate, node)
+
+	v, err := parseLocalDate(node.Data)
+	if err != nil {
+		return err
+	}
+
+	setDate(x, v)
+
+	return nil
+}
+
+func unmarshalLocalDateTime(x target, node ast.Node) error {
+	assertNode(ast.LocalDateTime, node)
+
+	v, rest, err := parseLocalDateTime(node.Data)
+	if err != nil {
+		return err
+	}
+
+	if len(rest) > 0 {
+		return newDecodeError(rest, "extra characters at the end of a local date time")
+	}
+
+	setLocalDateTime(x, v)
+
+	return nil
+}
+
+func unmarshalDateTime(x target, node ast.Node) error {
+	assertNode(ast.DateTime, node)
+
+	v, err := parseDateTime(node.Data)
+	if err != nil {
+		return err
+	}
+
+	setDateTime(x, v)
+
+	return nil
+}
+
+func setLocalDateTime(x target, v LocalDateTime) {
+	if x.get().Type() == timeType {
+		cast := v.In(time.Local)
+
+		setDateTime(x, cast)
+		return
+	}
+
+	x.set(reflect.ValueOf(v))
+}
+
+func setDateTime(x target, v time.Time) {
+	x.set(reflect.ValueOf(v))
+}
+
+var timeType = reflect.TypeOf(time.Time{})
+
+func setDate(x target, v LocalDate) {
+	if x.get().Type() == timeType {
+		cast := v.In(time.Local)
+
+		setDateTime(x, cast)
+		return
+	}
+
+	x.set(reflect.ValueOf(v))
+}
+
+func unmarshalString(x target, node ast.Node) error {
+	assertNode(ast.String, node)
+
+	return setString(x, string(node.Data))
+}
+
+func unmarshalBool(x target, node ast.Node) error {
+	assertNode(ast.Bool, node)
+	v := node.Data[0] == 't'
+
+	return setBool(x, v)
+}
+
+func unmarshalInteger(x target, node ast.Node) error {
+	assertNode(ast.Integer, node)
+
+	v, err := parseInteger(node.Data)
+	if err != nil {
+		return err
+	}
+
+	return setInt64(x, v)
+}
+
+func unmarshalFloat(x target, node ast.Node) error {
+	assertNode(ast.Float, node)
+
+	v, err := parseFloat(node.Data)
+	if err != nil {
+		return err
+	}
+
+	return setFloat64(x, v)
+}
+
+func (d *decoder) unmarshalInlineTable(x target, node ast.Node) error {
+	assertNode(ast.InlineTable, node)
+
+	ensureMapIfInterface(x)
+
+	it := node.Children()
+	for it.Next() {
+		n := it.Node()
+
+		err := d.unmarshalKeyValue(x, n)
+		if err != nil {
+			return err
+		}
+	}
+
+	return nil
+}
+
+func (d *decoder) unmarshalArray(x target, node ast.Node) error {
+	assertNode(ast.Array, node)
+
+	err := ensureValueIndexable(x)
+	if err != nil {
+		return err
+	}
+
+	// Special work around when unmarshaling into an array.
+	// If the array is not addressable, for example when stored as a value in a
+	// map, calling elementAt in the inner function would fail.
+	// Instead, we allocate a new array that will be filled then inserted into
+	// the container.
+	// This problem does not exist with slices because they are addressable.
+	// There may be a better way of doing this, but it is not obvious to me
+	// with the target system.
+	if x.get().Kind() == reflect.Array {
+		container := x
+		newArrayPtr := reflect.New(x.get().Type())
+		x = valueTarget(newArrayPtr.Elem())
+		defer func() {
+			container.set(newArrayPtr.Elem())
+		}()
+	}
+
+	return d.unmarshalArrayInner(x, node)
+}
+
+func (d *decoder) unmarshalArrayInner(x target, node ast.Node) error {
+	idx := 0
+
+	it := node.Children()
+	for it.Next() {
+		n := it.Node()
+
+		v := elementAt(x, idx)
+
+		if v == nil {
+			// when we go out of bound for an array just stop processing it to
+			// mimic encoding/json
+			break
+		}
+
+		err := d.unmarshalValue(v, n)
+		if err != nil {
+			return err
+		}
+
+		idx++
+	}
+	return nil
+}
+
+func assertNode(expected ast.Kind, node ast.Node) {
+	if node.Kind != expected {
+		panic(fmt.Sprintf("expected node of kind %s, not %s", expected, node.Kind))
+	}
+}