Compare commits
53 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 068279f13b | |||
| b9edbeb611 | |||
| a97c9317d4 | |||
| 3229a0abfb | |||
| 3f5d8a6b06 | |||
| 146f70ea8a | |||
| e83cf535f5 | |||
| c3ba3ef97a | |||
| 7ee3c8ff25 | |||
| 1e85aa6d78 | |||
| 46fa3225e2 | |||
| 4d51831dab | |||
| 5a1a96cb2d | |||
| ea9040ae83 | |||
| 2373685f1e | |||
| f1391952d4 | |||
| 4a73a200ed | |||
| 4807229e94 | |||
| d8ddc00c61 | |||
| 82f8dad811 | |||
| 75db1016e8 | |||
| de6d715bd2 | |||
| 3ab2fc2b87 | |||
| 1b1dd3d6d5 | |||
| 128b7a8bfb | |||
| 892df5c28e | |||
| d58eb50ebf | |||
| 535fc65c5f | |||
| f158d7d278 | |||
| 5fd6e9cce0 | |||
| 8ce5c3d78f | |||
| 177b4a5e53 | |||
| 5cbdea6192 | |||
| 696dd25c17 | |||
| facb2b13e8 | |||
| 8bbb519477 | |||
| b37e11d74d | |||
| 6cd86876b8 | |||
| f53bc740c1 | |||
| 9bf9be681e | |||
| c862c344b3 | |||
| 0d20a84523 | |||
| 3990899d7e | |||
| 4c7a337083 | |||
| bbaae540ce | |||
| ede6445608 | |||
| b226db6a29 | |||
| d8997efb5a | |||
| 79e78b234c | |||
| 1b5a25c0ef | |||
| 8eae15b2ee | |||
| 2b3de620e8 | |||
| 8645d6376b |
@@ -2,6 +2,7 @@ changelog:
|
|||||||
exclude:
|
exclude:
|
||||||
labels:
|
labels:
|
||||||
- build
|
- build
|
||||||
|
- testing
|
||||||
categories:
|
categories:
|
||||||
- title: What's new
|
- title: What's new
|
||||||
labels:
|
labels:
|
||||||
|
|||||||
@@ -15,6 +15,6 @@ jobs:
|
|||||||
- name: Setup go
|
- name: Setup go
|
||||||
uses: actions/setup-go@master
|
uses: actions/setup-go@master
|
||||||
with:
|
with:
|
||||||
go-version: 1.16
|
go-version: 1.18
|
||||||
- name: Run tests with coverage
|
- name: Run tests with coverage
|
||||||
run: ./ci.sh coverage -d "${GITHUB_BASE_REF-HEAD}"
|
run: ./ci.sh coverage -d "${GITHUB_BASE_REF-HEAD}"
|
||||||
|
|||||||
@@ -0,0 +1,39 @@
|
|||||||
|
name: release
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- "v2.*"
|
||||||
|
workflow_call:
|
||||||
|
inputs:
|
||||||
|
args:
|
||||||
|
description: "Extra arguments to pass goreleaser"
|
||||||
|
default: ""
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
release:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
- name: Set up Go
|
||||||
|
uses: actions/setup-go@v2
|
||||||
|
with:
|
||||||
|
go-version: 1.18
|
||||||
|
- name: Login to GitHub Container Registry
|
||||||
|
uses: docker/login-action@v1
|
||||||
|
with:
|
||||||
|
registry: ghcr.io
|
||||||
|
username: ${{ github.actor }}
|
||||||
|
password: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
- name: Run GoReleaser
|
||||||
|
uses: goreleaser/goreleaser-action@v2
|
||||||
|
with:
|
||||||
|
distribution: goreleaser
|
||||||
|
version: latest
|
||||||
|
args: release ${{ inputs.args }} --rm-dist
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
@@ -12,14 +12,21 @@ jobs:
|
|||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
os: [ 'ubuntu-latest', 'windows-latest', 'macos-latest']
|
os: [ 'ubuntu-latest', 'windows-latest', 'macos-latest']
|
||||||
go: [ '1.16', '1.17' ]
|
go: [ '1.17', '1.18' ]
|
||||||
runs-on: ${{ matrix.os }}
|
runs-on: ${{ matrix.os }}
|
||||||
name: ${{ matrix.go }}/${{ matrix.os }}
|
name: ${{ matrix.go }}/${{ matrix.os }}
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@master
|
- uses: actions/checkout@master
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
- name: Setup go ${{ matrix.go }}
|
- name: Setup go ${{ matrix.go }}
|
||||||
uses: actions/setup-go@master
|
uses: actions/setup-go@master
|
||||||
with:
|
with:
|
||||||
go-version: ${{ matrix.go }}
|
go-version: ${{ matrix.go }}
|
||||||
- name: Run unit tests
|
- name: Run unit tests
|
||||||
run: go test -race ./...
|
run: go test -race ./...
|
||||||
|
release-check:
|
||||||
|
if: ${{ github.ref != 'refs/heads/v2' }}
|
||||||
|
uses: pelletier/go-toml/.github/workflows/release.yml@v2
|
||||||
|
with:
|
||||||
|
args: --snapshot
|
||||||
|
|||||||
@@ -3,3 +3,4 @@ fuzz/
|
|||||||
cmd/tomll/tomll
|
cmd/tomll/tomll
|
||||||
cmd/tomljson/tomljson
|
cmd/tomljson/tomljson
|
||||||
cmd/tomltestgen/tomltestgen
|
cmd/tomltestgen/tomltestgen
|
||||||
|
dist
|
||||||
@@ -0,0 +1,111 @@
|
|||||||
|
before:
|
||||||
|
hooks:
|
||||||
|
- go mod tidy
|
||||||
|
- go fmt ./...
|
||||||
|
- go test ./...
|
||||||
|
builds:
|
||||||
|
- id: tomll
|
||||||
|
main: ./cmd/tomll
|
||||||
|
binary: tomll
|
||||||
|
env:
|
||||||
|
- CGO_ENABLED=0
|
||||||
|
flags:
|
||||||
|
- -trimpath
|
||||||
|
ldflags:
|
||||||
|
- -X main.version={{.Version}} -X main.commit={{.Commit}} -X main.date={{.CommitDate}}
|
||||||
|
mod_timestamp: '{{ .CommitTimestamp }}'
|
||||||
|
targets:
|
||||||
|
- linux_amd64
|
||||||
|
- windows_amd64
|
||||||
|
- darwin_amd64
|
||||||
|
- darwin_arm64
|
||||||
|
- id: tomljson
|
||||||
|
main: ./cmd/tomljson
|
||||||
|
binary: tomljson
|
||||||
|
env:
|
||||||
|
- CGO_ENABLED=0
|
||||||
|
flags:
|
||||||
|
- -trimpath
|
||||||
|
ldflags:
|
||||||
|
- -X main.version={{.Version}} -X main.commit={{.Commit}} -X main.date={{.CommitDate}}
|
||||||
|
mod_timestamp: '{{ .CommitTimestamp }}'
|
||||||
|
targets:
|
||||||
|
- linux_amd64
|
||||||
|
- windows_amd64
|
||||||
|
- darwin_amd64
|
||||||
|
- darwin_arm64
|
||||||
|
- id: jsontoml
|
||||||
|
main: ./cmd/jsontoml
|
||||||
|
binary: jsontoml
|
||||||
|
env:
|
||||||
|
- CGO_ENABLED=0
|
||||||
|
flags:
|
||||||
|
- -trimpath
|
||||||
|
ldflags:
|
||||||
|
- -X main.version={{.Version}} -X main.commit={{.Commit}} -X main.date={{.CommitDate}}
|
||||||
|
mod_timestamp: '{{ .CommitTimestamp }}'
|
||||||
|
targets:
|
||||||
|
- linux_amd64
|
||||||
|
- windows_amd64
|
||||||
|
- darwin_amd64
|
||||||
|
- darwin_arm64
|
||||||
|
universal_binaries:
|
||||||
|
- id: tomll
|
||||||
|
replace: true
|
||||||
|
name_template: tomll
|
||||||
|
- id: tomljson
|
||||||
|
replace: true
|
||||||
|
name_template: tomljson
|
||||||
|
- id: jsontoml
|
||||||
|
replace: true
|
||||||
|
name_template: jsontoml
|
||||||
|
archives:
|
||||||
|
- id: jsontoml
|
||||||
|
format: tar.xz
|
||||||
|
builds:
|
||||||
|
- jsontoml
|
||||||
|
files:
|
||||||
|
- none*
|
||||||
|
name_template: "{{ .Binary }}_{{.Version}}_{{ .Os }}_{{ .Arch }}"
|
||||||
|
- id: tomljson
|
||||||
|
format: tar.xz
|
||||||
|
builds:
|
||||||
|
- tomljson
|
||||||
|
files:
|
||||||
|
- none*
|
||||||
|
name_template: "{{ .Binary }}_{{.Version}}_{{ .Os }}_{{ .Arch }}"
|
||||||
|
- id: tomll
|
||||||
|
format: tar.xz
|
||||||
|
builds:
|
||||||
|
- tomll
|
||||||
|
files:
|
||||||
|
- none*
|
||||||
|
name_template: "{{ .Binary }}_{{.Version}}_{{ .Os }}_{{ .Arch }}"
|
||||||
|
dockers:
|
||||||
|
- id: tools
|
||||||
|
goos: linux
|
||||||
|
goarch: amd64
|
||||||
|
ids:
|
||||||
|
- jsontoml
|
||||||
|
- tomljson
|
||||||
|
- tomll
|
||||||
|
image_templates:
|
||||||
|
- "ghcr.io/pelletier/go-toml:latest"
|
||||||
|
- "ghcr.io/pelletier/go-toml:{{ .Tag }}"
|
||||||
|
- "ghcr.io/pelletier/go-toml:v{{ .Major }}"
|
||||||
|
skip_push: false
|
||||||
|
checksum:
|
||||||
|
name_template: 'sha256sums.txt'
|
||||||
|
snapshot:
|
||||||
|
name_template: "{{ incpatch .Version }}-next"
|
||||||
|
release:
|
||||||
|
github:
|
||||||
|
owner: pelletier
|
||||||
|
name: go-toml
|
||||||
|
draft: true
|
||||||
|
prerelease: auto
|
||||||
|
mode: replace
|
||||||
|
changelog:
|
||||||
|
use: github-native
|
||||||
|
announce:
|
||||||
|
skip: true
|
||||||
+23
-9
@@ -155,6 +155,8 @@ Checklist:
|
|||||||
- Does not introduce backward-incompatible changes (unless discussed).
|
- Does not introduce backward-incompatible changes (unless discussed).
|
||||||
- Has relevant doc changes.
|
- Has relevant doc changes.
|
||||||
- Benchstat does not show performance regression.
|
- Benchstat does not show performance regression.
|
||||||
|
- Pull request is [labeled appropriately][pr-labels].
|
||||||
|
- Title will be understandable in the changelog.
|
||||||
|
|
||||||
1. Merge using "squash and merge".
|
1. Merge using "squash and merge".
|
||||||
2. Make sure to edit the commit message to keep all the useful information
|
2. Make sure to edit the commit message to keep all the useful information
|
||||||
@@ -163,13 +165,25 @@ Checklist:
|
|||||||
|
|
||||||
### New release
|
### New release
|
||||||
|
|
||||||
1. Go to [releases][releases]. Click on "X commits to master since this
|
1. Decide on the next version number. Use semver.
|
||||||
release".
|
2. Generate release notes using [`gh`][gh]. Example:
|
||||||
2. Make note of all the changes. Look for backward incompatible changes,
|
```
|
||||||
new features, and bug fixes.
|
$ gh api -X POST \
|
||||||
3. Pick the new version using the above and semver.
|
-F tag_name='v2.0.0-beta.5' \
|
||||||
4. Create a [new release][new-release].
|
-F target_commitish='v2' \
|
||||||
5. Follow the same format as [1.1.0][release-110].
|
-F previous_tag_name='v2.0.0-beta.4' \
|
||||||
|
--jq '.body' \
|
||||||
|
repos/pelletier/go-toml/releases/generate-notes
|
||||||
|
```
|
||||||
|
3. Look for "Other changes". That would indicate a pull request not labeled
|
||||||
|
properly. Tweak labels and pull request titles until changelog looks good for
|
||||||
|
users.
|
||||||
|
4. [Draft new release][new-release].
|
||||||
|
5. Fill tag and target with the same value used to generate the changelog.
|
||||||
|
6. Set title to the new tag value.
|
||||||
|
7. Paste the generated changelog.
|
||||||
|
8. Check "create discussion", in the "Releases" category.
|
||||||
|
9. Check pre-release if new version is an alpha or beta.
|
||||||
|
|
||||||
[issues-tracker]: https://github.com/pelletier/go-toml/issues
|
[issues-tracker]: https://github.com/pelletier/go-toml/issues
|
||||||
[bug-report]: https://github.com/pelletier/go-toml/issues/new?template=bug_report.md
|
[bug-report]: https://github.com/pelletier/go-toml/issues/new?template=bug_report.md
|
||||||
@@ -177,6 +191,6 @@ Checklist:
|
|||||||
[readme]: ./README.md
|
[readme]: ./README.md
|
||||||
[fork]: https://help.github.com/articles/fork-a-repo
|
[fork]: https://help.github.com/articles/fork-a-repo
|
||||||
[pull-request]: https://help.github.com/en/articles/creating-a-pull-request
|
[pull-request]: https://help.github.com/en/articles/creating-a-pull-request
|
||||||
[releases]: https://github.com/pelletier/go-toml/releases
|
|
||||||
[new-release]: https://github.com/pelletier/go-toml/releases/new
|
[new-release]: https://github.com/pelletier/go-toml/releases/new
|
||||||
[release-110]: https://github.com/pelletier/go-toml/releases/tag/v1.1.0
|
[gh]: https://github.com/cli/cli
|
||||||
|
[pr-labels]: https://github.com/pelletier/go-toml/blob/v2/.github/release.yml
|
||||||
|
|||||||
@@ -0,0 +1,5 @@
|
|||||||
|
FROM scratch
|
||||||
|
ENV PATH "$PATH:/bin"
|
||||||
|
COPY tomll /bin/tomll
|
||||||
|
COPY tomljson /bin/tomljson
|
||||||
|
COPY jsontoml /bin/jsontoml
|
||||||
@@ -21,7 +21,8 @@ encouraged to try out this version.
|
|||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
Full API, examples, and implementation notes are available in the Go documentation.
|
Full API, examples, and implementation notes are available in the Go
|
||||||
|
documentation.
|
||||||
|
|
||||||
[](https://pkg.go.dev/github.com/pelletier/go-toml/v2)
|
[](https://pkg.go.dev/github.com/pelletier/go-toml/v2)
|
||||||
|
|
||||||
@@ -51,12 +52,13 @@ operations should not be shockingly slow. See [benchmarks](#benchmarks).
|
|||||||
the TOML document was not prevent in the target structure. This is a great way
|
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].
|
to check for typos. [See example in the documentation][strict].
|
||||||
|
|
||||||
[strict]: https://pkg.go.dev/github.com/pelletier/go-toml/v2#example-Decoder.SetStrict
|
[strict]: https://pkg.go.dev/github.com/pelletier/go-toml/v2#example-Decoder.DisallowUnknownFields
|
||||||
|
|
||||||
### Contextualized errors
|
### Contextualized errors
|
||||||
|
|
||||||
When decoding errors occur, go-toml returns [`DecodeError`][decode-err]), which
|
When most decoding errors occur, go-toml returns [`DecodeError`][decode-err]),
|
||||||
contains a human readable contextualized version of the error. For example:
|
which contains a human readable contextualized version of the error. For
|
||||||
|
example:
|
||||||
|
|
||||||
```
|
```
|
||||||
2| key1 = "value1"
|
2| key1 = "value1"
|
||||||
@@ -206,6 +208,44 @@ In case of trouble: [Go Modules FAQ][mod-faq].
|
|||||||
|
|
||||||
[mod-faq]: https://github.com/golang/go/wiki/Modules#why-does-installing-a-tool-via-go-get-fail-with-error-cannot-find-main-module
|
[mod-faq]: https://github.com/golang/go/wiki/Modules#why-does-installing-a-tool-via-go-get-fail-with-error-cannot-find-main-module
|
||||||
|
|
||||||
|
## Tools
|
||||||
|
|
||||||
|
Go-toml provides three handy command line tools:
|
||||||
|
|
||||||
|
* `tomljson`: Reads a TOML file and outputs its JSON representation.
|
||||||
|
|
||||||
|
```
|
||||||
|
$ go install github.com/pelletier/go-toml/v2/cmd/tomljson@latest
|
||||||
|
$ tomljson --help
|
||||||
|
```
|
||||||
|
|
||||||
|
* `jsontoml`: Reads a JSON file and outputs a TOML representation.
|
||||||
|
|
||||||
|
```
|
||||||
|
$ go install github.com/pelletier/go-toml/v2/cmd/jsontoml@latest
|
||||||
|
$ jsontoml --help
|
||||||
|
```
|
||||||
|
|
||||||
|
* `tomll`: Lints and reformats a TOML file.
|
||||||
|
|
||||||
|
```
|
||||||
|
$ go install github.com/pelletier/go-toml/v2/cmd/tomll@latest
|
||||||
|
$ tomll --help
|
||||||
|
```
|
||||||
|
|
||||||
|
### Docker image
|
||||||
|
|
||||||
|
Those tools are also available as a [Docker image][docker]. For example, to use
|
||||||
|
`tomljson`:
|
||||||
|
|
||||||
|
```
|
||||||
|
docker run -i ghcr.io/pelletier/go-toml:v2 tomljson < example.toml
|
||||||
|
```
|
||||||
|
|
||||||
|
Multiple versions are availble on [ghcr.io][docker].
|
||||||
|
|
||||||
|
[docker]: https://github.com/pelletier/go-toml/pkgs/container/go-toml
|
||||||
|
|
||||||
## Migrating from v1
|
## Migrating from v1
|
||||||
|
|
||||||
This section describes the differences between v1 and v2, with some pointers on
|
This section describes the differences between v1 and v2, with some pointers on
|
||||||
@@ -324,6 +364,29 @@ The recommended replacement is pre-filling the struct before unmarshaling.
|
|||||||
|
|
||||||
[go-defaults]: https://github.com/mcuadros/go-defaults
|
[go-defaults]: https://github.com/mcuadros/go-defaults
|
||||||
|
|
||||||
|
#### `toml.Tree` replacement
|
||||||
|
|
||||||
|
This structure was the initial attempt at providing a document model for
|
||||||
|
go-toml. It allows manipulating the structure of any document, encoding and
|
||||||
|
decoding from their TOML representation. While a more robust feature was
|
||||||
|
initially planned in go-toml v2, this has been ultimately [removed from
|
||||||
|
scope][nodoc] of this library, with no plan to add it back at the moment. The
|
||||||
|
closest equivalent at the moment would be to unmarshal into an `interface{}` and
|
||||||
|
use type assertions and/or reflection to manipulate the arbitrary
|
||||||
|
structure. However this would fall short of providing all of the TOML features
|
||||||
|
such as adding comments and be specific about whitespace.
|
||||||
|
|
||||||
|
|
||||||
|
#### `toml.Position` are not retrievable anymore
|
||||||
|
|
||||||
|
The API for retrieving the position (line, column) of a specific TOML element do
|
||||||
|
not exist anymore. This was done to minimize the amount of concepts introduced
|
||||||
|
by the library (query path), and avoid the performance hit related to storing
|
||||||
|
positions in the absence of a document model, for a feature that seemed to have
|
||||||
|
little use. Errors however have gained more detailed position
|
||||||
|
information. Position retrieval seems better fitted for a document model, which
|
||||||
|
has been [removed from the scope][nodoc] of go-toml v2 at the moment.
|
||||||
|
|
||||||
### Encoding / Marshal
|
### Encoding / Marshal
|
||||||
|
|
||||||
#### Default struct fields order
|
#### Default struct fields order
|
||||||
@@ -359,7 +422,8 @@ fmt.Println("v2:\n" + string(b))
|
|||||||
```
|
```
|
||||||
|
|
||||||
There is no way to make v2 encoder behave like v1. A workaround could be to
|
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.
|
manually sort the fields alphabetically in the struct definition, or generate
|
||||||
|
struct types using `reflect.StructOf`.
|
||||||
|
|
||||||
#### No indentation by default
|
#### No indentation by default
|
||||||
|
|
||||||
@@ -407,7 +471,9 @@ fmt.Println("v2 Encoder:\n" + string(buf.Bytes()))
|
|||||||
|
|
||||||
V1 always uses double quotes (`"`) around strings and keys that cannot be
|
V1 always uses double quotes (`"`) around strings and keys that cannot be
|
||||||
represented bare (unquoted). V2 uses single quotes instead by default (`'`),
|
represented bare (unquoted). V2 uses single quotes instead by default (`'`),
|
||||||
unless a character cannot be represented, then falls back to double quotes.
|
unless a character cannot be represented, then falls back to double quotes. As a
|
||||||
|
result of this change, `Encoder.QuoteMapKeys` has been removed, as it is not
|
||||||
|
useful anymore.
|
||||||
|
|
||||||
There is no way to make v2 encoder behave like v1.
|
There is no way to make v2 encoder behave like v1.
|
||||||
|
|
||||||
@@ -422,6 +488,69 @@ There is no way to make v2 encoder behave like v1.
|
|||||||
|
|
||||||
[tm]: https://golang.org/pkg/encoding/#TextMarshaler
|
[tm]: https://golang.org/pkg/encoding/#TextMarshaler
|
||||||
|
|
||||||
|
#### `Encoder.CompactComments` has been removed
|
||||||
|
|
||||||
|
Emitting compact comments is now the default behavior of go-toml. This option
|
||||||
|
is not necessary anymore.
|
||||||
|
|
||||||
|
#### Struct tags have been merged
|
||||||
|
|
||||||
|
V1 used to provide multiple struct tags: `comment`, `commented`, `multiline`,
|
||||||
|
`toml`, and `omitempty`. To behave more like the standard library, v2 has merged
|
||||||
|
`toml`, `multiline`, and `omitempty`. For example:
|
||||||
|
|
||||||
|
```go
|
||||||
|
type doc struct {
|
||||||
|
// v1
|
||||||
|
F string `toml:"field" multiline:"true" omitempty:"true"`
|
||||||
|
// v2
|
||||||
|
F string `toml:"field,multiline,omitempty"`
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Has a result, the `Encoder.SetTag*` methods have been removed, as there is just
|
||||||
|
one tag now.
|
||||||
|
|
||||||
|
|
||||||
|
#### `commented` tag has been removed
|
||||||
|
|
||||||
|
There is no replacement for the `commented` tag. This feature would be better
|
||||||
|
suited in a proper document model for go-toml v2, which has been [cut from
|
||||||
|
scope][nodoc] at the moment.
|
||||||
|
|
||||||
|
#### `Encoder.ArraysWithOneElementPerLine` has been renamed
|
||||||
|
|
||||||
|
The new name is `Encoder.SetArraysMultiline`. The behavior should be the same.
|
||||||
|
|
||||||
|
#### `Encoder.Indentation` has been renamed
|
||||||
|
|
||||||
|
The new name is `Encoder.SetIndentSymbol`. The behavior should be the same.
|
||||||
|
|
||||||
|
|
||||||
|
#### Embedded structs behave like stdlib
|
||||||
|
|
||||||
|
V1 defaults to merging embedded struct fields into the embedding struct. This
|
||||||
|
behavior was unexpected because it does not follow the standard library. To
|
||||||
|
avoid breaking backward compatibility, the `Encoder.PromoteAnonymous` method was
|
||||||
|
added to make the encoder behave correctly. Given backward compatibility is not
|
||||||
|
a problem anymore, v2 does the right thing by default: it follows the behavior
|
||||||
|
of `encoding/json`. `Encoder.PromoteAnonymous` has been removed.
|
||||||
|
|
||||||
|
[nodoc]: https://github.com/pelletier/go-toml/discussions/506#discussioncomment-1526038
|
||||||
|
|
||||||
|
### `query`
|
||||||
|
|
||||||
|
go-toml v1 provided the [`go-toml/query`][query] package. It allowed to run
|
||||||
|
JSONPath-style queries on TOML files. This feature is not available in v2. For a
|
||||||
|
replacement, check out [dasel][dasel].
|
||||||
|
|
||||||
|
This package has been removed because it was essentially not supported anymore
|
||||||
|
(last commit May 2020), increased the complexity of the code base, and more
|
||||||
|
complete solutions exist out there.
|
||||||
|
|
||||||
|
[query]: https://github.com/pelletier/go-toml/tree/f99d6bbca119636aeafcf351ee52b3d202782627/query
|
||||||
|
[dasel]: https://github.com/TomWright/dasel
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
The MIT License (MIT). Read [LICENSE](LICENSE).
|
The MIT License (MIT). Read [LICENSE](LICENSE).
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ import (
|
|||||||
"os"
|
"os"
|
||||||
"path"
|
"path"
|
||||||
|
|
||||||
"github.com/pelletier/go-toml/v2/testsuite"
|
"github.com/pelletier/go-toml/v2/internal/testsuite"
|
||||||
)
|
)
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
|
|||||||
@@ -0,0 +1,55 @@
|
|||||||
|
// Package jsontoml is a program that converts JSON to TOML.
|
||||||
|
//
|
||||||
|
// Usage
|
||||||
|
//
|
||||||
|
// Reading from stdin:
|
||||||
|
//
|
||||||
|
// cat file.json | jsontoml > file.toml
|
||||||
|
//
|
||||||
|
// Reading from a file:
|
||||||
|
//
|
||||||
|
// jsontoml file.json > file.toml
|
||||||
|
//
|
||||||
|
// Installation
|
||||||
|
//
|
||||||
|
// Using Go:
|
||||||
|
//
|
||||||
|
// go install github.com/pelletier/go-toml/v2/cmd/jsontoml@latest
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"io"
|
||||||
|
|
||||||
|
"github.com/pelletier/go-toml/v2"
|
||||||
|
"github.com/pelletier/go-toml/v2/internal/cli"
|
||||||
|
)
|
||||||
|
|
||||||
|
const usage = `jsontoml can be used in two ways:
|
||||||
|
Reading from stdin:
|
||||||
|
cat file.json | jsontoml > file.toml
|
||||||
|
|
||||||
|
Reading from a file:
|
||||||
|
jsontoml file.json > file.toml
|
||||||
|
`
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
p := cli.Program{
|
||||||
|
Usage: usage,
|
||||||
|
Fn: convert,
|
||||||
|
}
|
||||||
|
p.Execute()
|
||||||
|
}
|
||||||
|
|
||||||
|
func convert(r io.Reader, w io.Writer) error {
|
||||||
|
var v interface{}
|
||||||
|
|
||||||
|
d := json.NewDecoder(r)
|
||||||
|
err := d.Decode(&v)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
e := toml.NewEncoder(w)
|
||||||
|
return e.Encode(v)
|
||||||
|
}
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestConvert(t *testing.T) {
|
||||||
|
examples := []struct {
|
||||||
|
name string
|
||||||
|
input string
|
||||||
|
expected string
|
||||||
|
errors bool
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "valid json",
|
||||||
|
input: `
|
||||||
|
{
|
||||||
|
"mytoml": {
|
||||||
|
"a": 42
|
||||||
|
}
|
||||||
|
}`,
|
||||||
|
expected: `[mytoml]
|
||||||
|
a = 42.0
|
||||||
|
|
||||||
|
`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "invalid json",
|
||||||
|
input: `{ foo`,
|
||||||
|
errors: true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, e := range examples {
|
||||||
|
b := new(bytes.Buffer)
|
||||||
|
err := convert(strings.NewReader(e.input), b)
|
||||||
|
if e.errors {
|
||||||
|
require.Error(t, err)
|
||||||
|
} else {
|
||||||
|
assert.NoError(t, err)
|
||||||
|
assert.Equal(t, e.expected, b.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,63 @@
|
|||||||
|
// Package tomljson is a program that converts TOML to JSON.
|
||||||
|
//
|
||||||
|
// Usage
|
||||||
|
//
|
||||||
|
// Reading from stdin:
|
||||||
|
//
|
||||||
|
// cat file.toml | tomljson > file.json
|
||||||
|
//
|
||||||
|
// Reading from a file:
|
||||||
|
//
|
||||||
|
// tomljson file.toml > file.json
|
||||||
|
//
|
||||||
|
// Installation
|
||||||
|
//
|
||||||
|
// Using Go:
|
||||||
|
//
|
||||||
|
// go install github.com/pelletier/go-toml/v2/cmd/tomljson@latest
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
|
||||||
|
"github.com/pelletier/go-toml/v2"
|
||||||
|
"github.com/pelletier/go-toml/v2/internal/cli"
|
||||||
|
)
|
||||||
|
|
||||||
|
const usage = `tomljson can be used in two ways:
|
||||||
|
Reading from stdin:
|
||||||
|
cat file.toml | tomljson > file.json
|
||||||
|
|
||||||
|
Reading from a file:
|
||||||
|
tomljson file.toml > file.json
|
||||||
|
`
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
p := cli.Program{
|
||||||
|
Usage: usage,
|
||||||
|
Fn: convert,
|
||||||
|
}
|
||||||
|
p.Execute()
|
||||||
|
}
|
||||||
|
|
||||||
|
func convert(r io.Reader, w io.Writer) error {
|
||||||
|
var v interface{}
|
||||||
|
|
||||||
|
d := toml.NewDecoder(r)
|
||||||
|
err := d.Decode(&v)
|
||||||
|
if err != nil {
|
||||||
|
var derr *toml.DecodeError
|
||||||
|
if errors.As(err, &derr) {
|
||||||
|
row, col := derr.Position()
|
||||||
|
return fmt.Errorf("%s\nerror occurred at row %d column %d", derr.String(), row, col)
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
e := json.NewEncoder(w)
|
||||||
|
e.SetIndent("", " ")
|
||||||
|
return e.Encode(v)
|
||||||
|
}
|
||||||
@@ -0,0 +1,61 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestConvert(t *testing.T) {
|
||||||
|
examples := []struct {
|
||||||
|
name string
|
||||||
|
input io.Reader
|
||||||
|
expected string
|
||||||
|
errors bool
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "valid toml",
|
||||||
|
input: strings.NewReader(`
|
||||||
|
[mytoml]
|
||||||
|
a = 42`),
|
||||||
|
expected: `{
|
||||||
|
"mytoml": {
|
||||||
|
"a": 42
|
||||||
|
}
|
||||||
|
}
|
||||||
|
`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "invalid toml",
|
||||||
|
input: strings.NewReader(`bad = []]`),
|
||||||
|
errors: true,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "bad reader",
|
||||||
|
input: &badReader{},
|
||||||
|
errors: true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, e := range examples {
|
||||||
|
b := new(bytes.Buffer)
|
||||||
|
err := convert(e.input, b)
|
||||||
|
if e.errors {
|
||||||
|
require.Error(t, err)
|
||||||
|
} else {
|
||||||
|
assert.NoError(t, err)
|
||||||
|
assert.Equal(t, e.expected, b.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type badReader struct{}
|
||||||
|
|
||||||
|
func (r *badReader) Read([]byte) (int, error) {
|
||||||
|
return 0, fmt.Errorf("reader failed on purpose")
|
||||||
|
}
|
||||||
@@ -0,0 +1,58 @@
|
|||||||
|
// Package tomll is a linter program for TOML.
|
||||||
|
//
|
||||||
|
// Usage
|
||||||
|
//
|
||||||
|
// Reading from stdin, writing to stdout:
|
||||||
|
//
|
||||||
|
// cat file.toml | tomll
|
||||||
|
//
|
||||||
|
// Reading and updating a list of files in place:
|
||||||
|
//
|
||||||
|
// tomll a.toml b.toml c.toml
|
||||||
|
//
|
||||||
|
// Installation
|
||||||
|
//
|
||||||
|
// Using Go:
|
||||||
|
//
|
||||||
|
// go install github.com/pelletier/go-toml/v2/cmd/tomll@latest
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"io"
|
||||||
|
|
||||||
|
"github.com/pelletier/go-toml/v2"
|
||||||
|
"github.com/pelletier/go-toml/v2/internal/cli"
|
||||||
|
)
|
||||||
|
|
||||||
|
const usage = `tomll can be used in two ways:
|
||||||
|
|
||||||
|
Reading from stdin, writing to stdout:
|
||||||
|
cat file.toml | tomll > file.toml
|
||||||
|
|
||||||
|
Reading and updating a list of files in place:
|
||||||
|
tomll a.toml b.toml c.toml
|
||||||
|
|
||||||
|
When given a list of files, tomll will modify all files in place without asking.
|
||||||
|
`
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
p := cli.Program{
|
||||||
|
Usage: usage,
|
||||||
|
Fn: convert,
|
||||||
|
Inplace: true,
|
||||||
|
}
|
||||||
|
p.Execute()
|
||||||
|
}
|
||||||
|
|
||||||
|
func convert(r io.Reader, w io.Writer) error {
|
||||||
|
var v interface{}
|
||||||
|
|
||||||
|
d := toml.NewDecoder(r)
|
||||||
|
err := d.Decode(&v)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
e := toml.NewEncoder(w)
|
||||||
|
return e.Encode(v)
|
||||||
|
}
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestConvert(t *testing.T) {
|
||||||
|
examples := []struct {
|
||||||
|
name string
|
||||||
|
input string
|
||||||
|
expected string
|
||||||
|
errors bool
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "valid toml",
|
||||||
|
input: `
|
||||||
|
mytoml.a = 42.0
|
||||||
|
`,
|
||||||
|
expected: `[mytoml]
|
||||||
|
a = 42.0
|
||||||
|
|
||||||
|
`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "invalid toml",
|
||||||
|
input: `[what`,
|
||||||
|
errors: true,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, e := range examples {
|
||||||
|
b := new(bytes.Buffer)
|
||||||
|
err := convert(strings.NewReader(e.input), b)
|
||||||
|
if e.errors {
|
||||||
|
require.Error(t, err)
|
||||||
|
} else {
|
||||||
|
assert.NoError(t, err)
|
||||||
|
assert.Equal(t, e.expected, b.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -99,13 +99,36 @@ func parseDateTime(b []byte) (time.Time, error) {
|
|||||||
if len(b) != dateTimeByteLen {
|
if len(b) != dateTimeByteLen {
|
||||||
return time.Time{}, newDecodeError(b, "invalid date-time timezone")
|
return time.Time{}, newDecodeError(b, "invalid date-time timezone")
|
||||||
}
|
}
|
||||||
direction := 1
|
var direction int
|
||||||
if b[0] == '-' {
|
switch b[0] {
|
||||||
|
case '-':
|
||||||
direction = -1
|
direction = -1
|
||||||
|
case '+':
|
||||||
|
direction = +1
|
||||||
|
default:
|
||||||
|
return time.Time{}, newDecodeError(b[:1], "invalid timezone offset character")
|
||||||
|
}
|
||||||
|
|
||||||
|
if b[3] != ':' {
|
||||||
|
return time.Time{}, newDecodeError(b[3:4], "expected a : separator")
|
||||||
|
}
|
||||||
|
|
||||||
|
hours, err := parseDecimalDigits(b[1:3])
|
||||||
|
if err != nil {
|
||||||
|
return time.Time{}, err
|
||||||
|
}
|
||||||
|
if hours > 23 {
|
||||||
|
return time.Time{}, newDecodeError(b[:1], "invalid timezone offset hours")
|
||||||
|
}
|
||||||
|
|
||||||
|
minutes, err := parseDecimalDigits(b[4:6])
|
||||||
|
if err != nil {
|
||||||
|
return time.Time{}, err
|
||||||
|
}
|
||||||
|
if minutes > 59 {
|
||||||
|
return time.Time{}, newDecodeError(b[:1], "invalid timezone offset minutes")
|
||||||
}
|
}
|
||||||
|
|
||||||
hours := digitsToInt(b[1:3])
|
|
||||||
minutes := digitsToInt(b[4:6])
|
|
||||||
seconds := direction * (hours*3600 + minutes*60)
|
seconds := direction * (hours*3600 + minutes*60)
|
||||||
zone = time.FixedZone("", seconds)
|
zone = time.FixedZone("", seconds)
|
||||||
b = b[dateTimeByteLen:]
|
b = b[dateTimeByteLen:]
|
||||||
@@ -201,45 +224,53 @@ func parseLocalTime(b []byte) (LocalTime, []byte, error) {
|
|||||||
return t, nil, err
|
return t, nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
if t.Second > 59 {
|
if t.Second > 60 {
|
||||||
return t, nil, newDecodeError(b[3:5], "seconds cannot be greater 59")
|
return t, nil, newDecodeError(b[6:8], "seconds cannot be greater 60")
|
||||||
}
|
}
|
||||||
|
|
||||||
const minLengthWithFrac = 9
|
b = b[8:]
|
||||||
if len(b) >= minLengthWithFrac && b[minLengthWithFrac-1] == '.' {
|
|
||||||
|
if len(b) >= 1 && b[0] == '.' {
|
||||||
frac := 0
|
frac := 0
|
||||||
|
precision := 0
|
||||||
digits := 0
|
digits := 0
|
||||||
|
|
||||||
for i, c := range b[minLengthWithFrac:] {
|
for i, c := range b[1:] {
|
||||||
if !isDigit(c) {
|
if !isDigit(c) {
|
||||||
if i == 0 {
|
if i == 0 {
|
||||||
return t, nil, newDecodeError(b[i:i+1], "need at least one digit after fraction point")
|
return t, nil, newDecodeError(b[0:1], "need at least one digit after fraction point")
|
||||||
}
|
}
|
||||||
|
|
||||||
break
|
break
|
||||||
}
|
}
|
||||||
|
digits++
|
||||||
|
|
||||||
const maxFracPrecision = 9
|
const maxFracPrecision = 9
|
||||||
if i >= maxFracPrecision {
|
if i >= maxFracPrecision {
|
||||||
return t, nil, newDecodeError(b[i:i+1], "maximum precision for date time is nanosecond")
|
// go-toml allows decoding fractional seconds
|
||||||
|
// beyond the supported precision of 9
|
||||||
|
// digits. It truncates the fractional component
|
||||||
|
// to the supported precision and ignores the
|
||||||
|
// remaining digits.
|
||||||
|
//
|
||||||
|
// https://github.com/pelletier/go-toml/discussions/707
|
||||||
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
frac *= 10
|
frac *= 10
|
||||||
frac += int(c - '0')
|
frac += int(c - '0')
|
||||||
digits++
|
precision++
|
||||||
}
|
}
|
||||||
|
|
||||||
if digits == 0 {
|
if precision == 0 {
|
||||||
return t, nil, newDecodeError(b[minLengthWithFrac-1:minLengthWithFrac], "nanoseconds need at least one digit")
|
return t, nil, newDecodeError(b[:1], "nanoseconds need at least one digit")
|
||||||
}
|
}
|
||||||
|
|
||||||
t.Nanosecond = frac * nspow[digits]
|
t.Nanosecond = frac * nspow[precision]
|
||||||
t.Precision = digits
|
t.Precision = precision
|
||||||
|
|
||||||
return t, b[9+digits:], nil
|
return t, b[1+digits:], nil
|
||||||
}
|
}
|
||||||
|
return t, b, nil
|
||||||
return t, b[8:], nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
//nolint:cyclop
|
//nolint:cyclop
|
||||||
@@ -278,10 +309,10 @@ func parseFloat(b []byte) (float64, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
start := 0
|
start := 0
|
||||||
if b[0] == '+' || b[0] == '-' {
|
if cleaned[0] == '+' || cleaned[0] == '-' {
|
||||||
start = 1
|
start = 1
|
||||||
}
|
}
|
||||||
if b[start] == '0' && isDigit(b[start+1]) {
|
if cleaned[start] == '0' && isDigit(cleaned[start+1]) {
|
||||||
return 0, newDecodeError(b, "float integer part cannot have leading zeroes")
|
return 0, newDecodeError(b, "float integer part cannot have leading zeroes")
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -364,8 +395,17 @@ func parseIntDec(b []byte) (int64, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func checkAndRemoveUnderscoresIntegers(b []byte) ([]byte, error) {
|
func checkAndRemoveUnderscoresIntegers(b []byte) ([]byte, error) {
|
||||||
if b[0] == '_' {
|
start := 0
|
||||||
return nil, newDecodeError(b[0:1], "number cannot start with underscore")
|
if b[start] == '+' || b[start] == '-' {
|
||||||
|
start++
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(b) == start {
|
||||||
|
return b, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if b[start] == '_' {
|
||||||
|
return nil, newDecodeError(b[start:start+1], "number cannot start with underscore")
|
||||||
}
|
}
|
||||||
|
|
||||||
if b[len(b)-1] == '_' {
|
if b[len(b)-1] == '_' {
|
||||||
@@ -438,6 +478,10 @@ func checkAndRemoveUnderscoresFloats(b []byte) ([]byte, error) {
|
|||||||
return nil, newDecodeError(b[i+1:i+2], "cannot have underscore before exponent")
|
return nil, newDecodeError(b[i+1:i+2], "cannot have underscore before exponent")
|
||||||
}
|
}
|
||||||
before = false
|
before = false
|
||||||
|
case '+', '-':
|
||||||
|
// signed exponents
|
||||||
|
cleaned = append(cleaned, c)
|
||||||
|
before = false
|
||||||
case 'e', 'E':
|
case 'e', 'E':
|
||||||
if i < len(b)-1 && b[i+1] == '_' {
|
if i < len(b)-1 && b[i+1] == '_' {
|
||||||
return nil, newDecodeError(b[i+1:i+2], "cannot have underscore after exponent")
|
return nil, newDecodeError(b[i+1:i+2], "cannot have underscore after exponent")
|
||||||
@@ -462,7 +506,7 @@ func checkAndRemoveUnderscoresFloats(b []byte) ([]byte, error) {
|
|||||||
|
|
||||||
// isValidDate checks if a provided date is a date that exists.
|
// isValidDate checks if a provided date is a date that exists.
|
||||||
func isValidDate(year int, month int, day int) bool {
|
func isValidDate(year int, month int, day int) bool {
|
||||||
return day <= daysIn(month, year)
|
return month > 0 && month < 13 && day > 0 && day <= daysIn(month, year)
|
||||||
}
|
}
|
||||||
|
|
||||||
// daysBefore[m] counts the number of days in a non-leap year
|
// daysBefore[m] counts the number of days in a non-leap year
|
||||||
|
|||||||
@@ -27,7 +27,7 @@ type DecodeError struct {
|
|||||||
// corresponding field in the target value. It contains all the missing fields
|
// corresponding field in the target value. It contains all the missing fields
|
||||||
// in Errors.
|
// in Errors.
|
||||||
//
|
//
|
||||||
// Emitted by Decoder when SetStrict(true) was called.
|
// Emitted by Decoder when DisallowUnknownFields() was called.
|
||||||
type StrictMissingError struct {
|
type StrictMissingError struct {
|
||||||
// One error per field that could not be found.
|
// One error per field that could not be found.
|
||||||
Errors []DecodeError
|
Errors []DecodeError
|
||||||
|
|||||||
+6
-6
@@ -212,12 +212,12 @@ func ExampleDecodeError() {
|
|||||||
|
|
||||||
fmt.Println(err)
|
fmt.Println(err)
|
||||||
|
|
||||||
//nolint:errorlint
|
var derr *DecodeError
|
||||||
de := err.(*DecodeError)
|
if errors.As(err, &derr) {
|
||||||
fmt.Println(de.String())
|
fmt.Println(derr.String())
|
||||||
|
row, col := derr.Position()
|
||||||
row, col := de.Position()
|
fmt.Println("error occurred at row", row, "column", col)
|
||||||
fmt.Println("error occurred at row", row, "column", col)
|
}
|
||||||
// Output:
|
// Output:
|
||||||
// toml: number must have at least one digit between underscores
|
// toml: number must have at least one digit between underscores
|
||||||
// 1| name = 123__456
|
// 1| name = 123__456
|
||||||
|
|||||||
@@ -2,5 +2,4 @@ module github.com/pelletier/go-toml/v2
|
|||||||
|
|
||||||
go 1.16
|
go 1.16
|
||||||
|
|
||||||
// latest (v1.7.0) doesn't have the fix for time.Time
|
require github.com/stretchr/testify v1.7.1
|
||||||
require github.com/stretchr/testify v1.7.1-0.20210427113832-6241f9ab9942
|
|
||||||
|
|||||||
@@ -3,8 +3,8 @@ github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSs
|
|||||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
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/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/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||||
github.com/stretchr/testify v1.7.1-0.20210427113832-6241f9ab9942 h1:t0lM6y/M5IiUZyvbBTcngso8SZEZICH7is9B6g/obVU=
|
github.com/stretchr/testify v1.7.1 h1:5TQK59W5E3v0r2duFAb7P95B6hEeOyEnHRa8MjYSMTY=
|
||||||
github.com/stretchr/testify v1.7.1-0.20210427113832-6241f9ab9942/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
github.com/stretchr/testify v1.7.1/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 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
|
||||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
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 h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
|
||||||
|
|||||||
+24
-25
@@ -20,8 +20,8 @@ type Iterator struct {
|
|||||||
node *Node
|
node *Node
|
||||||
}
|
}
|
||||||
|
|
||||||
// Next moves the iterator forward and returns true if points to a node, false
|
// Next moves the iterator forward and returns true if points to a
|
||||||
// otherwise.
|
// node, false otherwise.
|
||||||
func (c *Iterator) Next() bool {
|
func (c *Iterator) Next() bool {
|
||||||
if !c.started {
|
if !c.started {
|
||||||
c.started = true
|
c.started = true
|
||||||
@@ -31,8 +31,8 @@ func (c *Iterator) Next() bool {
|
|||||||
return c.node.Valid()
|
return c.node.Valid()
|
||||||
}
|
}
|
||||||
|
|
||||||
// IsLast returns true if the current node of the iterator is the last one.
|
// IsLast returns true if the current node of the iterator is the last
|
||||||
// Subsequent call to Next() will return false.
|
// one. Subsequent call to Next() will return false.
|
||||||
func (c *Iterator) IsLast() bool {
|
func (c *Iterator) IsLast() bool {
|
||||||
return c.node.next == 0
|
return c.node.next == 0
|
||||||
}
|
}
|
||||||
@@ -62,20 +62,20 @@ func (r *Root) at(idx Reference) *Node {
|
|||||||
return &r.nodes[idx]
|
return &r.nodes[idx]
|
||||||
}
|
}
|
||||||
|
|
||||||
// Arrays have one child per element in the array.
|
// Arrays have one child per element in the array. InlineTables have
|
||||||
// InlineTables have one child per key-value pair in the table.
|
// one child per key-value pair in the table. KeyValues have at least
|
||||||
// KeyValues have at least two children. The first one is the value. The
|
// two children. The first one is the value. The rest make a
|
||||||
// rest make a potentially dotted key.
|
// potentially dotted key. Table and Array table have one child per
|
||||||
// Table and Array table have one child per element of the key they
|
// element of the key they represent (same as KeyValue, but without
|
||||||
// represent (same as KeyValue, but without the last node being the value).
|
// the last node being the value).
|
||||||
// children []Node
|
|
||||||
type Node struct {
|
type Node struct {
|
||||||
Kind Kind
|
Kind Kind
|
||||||
Raw Range // Raw bytes from the input.
|
Raw Range // Raw bytes from the input.
|
||||||
Data []byte // Node value (could be either allocated or referencing the input).
|
Data []byte // Node value (either allocated or referencing the input).
|
||||||
|
|
||||||
// References to other nodes, as offsets in the backing array from this
|
// References to other nodes, as offsets in the backing array
|
||||||
// node. References can go backward, so those can be negative.
|
// from this node. References can go backward, so those can be
|
||||||
|
// negative.
|
||||||
next int // 0 if last element
|
next int // 0 if last element
|
||||||
child int // 0 if no child
|
child int // 0 if no child
|
||||||
}
|
}
|
||||||
@@ -85,8 +85,8 @@ type Range struct {
|
|||||||
Length uint32
|
Length uint32
|
||||||
}
|
}
|
||||||
|
|
||||||
// Next returns a copy of the next node, or an invalid Node if there is no
|
// Next returns a copy of the next node, or an invalid Node if there
|
||||||
// next node.
|
// is no next node.
|
||||||
func (n *Node) Next() *Node {
|
func (n *Node) Next() *Node {
|
||||||
if n.next == 0 {
|
if n.next == 0 {
|
||||||
return nil
|
return nil
|
||||||
@@ -96,9 +96,9 @@ func (n *Node) Next() *Node {
|
|||||||
return (*Node)(danger.Stride(ptr, size, n.next))
|
return (*Node)(danger.Stride(ptr, size, n.next))
|
||||||
}
|
}
|
||||||
|
|
||||||
// Child returns a copy of the first child node of this node. Other children
|
// Child returns a copy of the first child node of this node. Other
|
||||||
// can be accessed calling Next on the first child.
|
// children can be accessed calling Next on the first child. Returns
|
||||||
// Returns an invalid Node if there is none.
|
// an invalid Node if there is none.
|
||||||
func (n *Node) Child() *Node {
|
func (n *Node) Child() *Node {
|
||||||
if n.child == 0 {
|
if n.child == 0 {
|
||||||
return nil
|
return nil
|
||||||
@@ -113,10 +113,9 @@ func (n *Node) Valid() bool {
|
|||||||
return n != nil
|
return n != nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// Key returns the child nodes making the Key on a supported node. Panics
|
// Key returns the child nodes making the Key on a supported
|
||||||
// otherwise.
|
// node. Panics otherwise. They are guaranteed to be all be of the
|
||||||
// They are guaranteed to be all be of the Kind Key. A simple key would return
|
// Kind Key. A simple key would return just one element.
|
||||||
// just one element.
|
|
||||||
func (n *Node) Key() Iterator {
|
func (n *Node) Key() Iterator {
|
||||||
switch n.Kind {
|
switch n.Kind {
|
||||||
case KeyValue:
|
case KeyValue:
|
||||||
@@ -133,8 +132,8 @@ func (n *Node) Key() Iterator {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Value returns a pointer to the value node of a KeyValue.
|
// Value returns a pointer to the value node of a KeyValue.
|
||||||
// Guaranteed to be non-nil.
|
// Guaranteed to be non-nil. Panics if not called on a KeyValue node,
|
||||||
// Panics if not called on a KeyValue node, or if the Children are malformed.
|
// or if the Children are malformed.
|
||||||
func (n *Node) Value() *Node {
|
func (n *Node) Value() *Node {
|
||||||
return n.Child()
|
return n.Child()
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,76 @@
|
|||||||
|
package cli
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"flag"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"io/ioutil"
|
||||||
|
"os"
|
||||||
|
)
|
||||||
|
|
||||||
|
type ConvertFn func(r io.Reader, w io.Writer) error
|
||||||
|
|
||||||
|
type Program struct {
|
||||||
|
Usage string
|
||||||
|
Fn ConvertFn
|
||||||
|
// Inplace allows the command to take more than one file as argument and
|
||||||
|
// perform convertion in place on each provided file.
|
||||||
|
Inplace bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *Program) Execute() {
|
||||||
|
flag.Usage = func() { fmt.Fprintf(os.Stderr, p.Usage) }
|
||||||
|
flag.Parse()
|
||||||
|
os.Exit(p.main(flag.Args(), os.Stdin, os.Stdout, os.Stderr))
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *Program) main(files []string, input io.Reader, output, error io.Writer) int {
|
||||||
|
err := p.run(files, input, output)
|
||||||
|
if err != nil {
|
||||||
|
fmt.Fprintln(error, err.Error())
|
||||||
|
return -1
|
||||||
|
}
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *Program) run(files []string, input io.Reader, output io.Writer) error {
|
||||||
|
if len(files) > 0 {
|
||||||
|
if p.Inplace {
|
||||||
|
return p.runAllFilesInPlace(files)
|
||||||
|
}
|
||||||
|
f, err := os.Open(files[0])
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
defer f.Close()
|
||||||
|
input = f
|
||||||
|
}
|
||||||
|
return p.Fn(input, output)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *Program) runAllFilesInPlace(files []string) error {
|
||||||
|
for _, path := range files {
|
||||||
|
err := p.runFileInPlace(path)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *Program) runFileInPlace(path string) error {
|
||||||
|
in, err := ioutil.ReadFile(path)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
out := new(bytes.Buffer)
|
||||||
|
|
||||||
|
err = p.Fn(bytes.NewReader(in), out)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
return ioutil.WriteFile(path, out.Bytes(), 0600)
|
||||||
|
}
|
||||||
@@ -0,0 +1,156 @@
|
|||||||
|
package cli
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"io/ioutil"
|
||||||
|
"os"
|
||||||
|
"path"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"github.com/stretchr/testify/require"
|
||||||
|
)
|
||||||
|
|
||||||
|
func processMain(args []string, input io.Reader, stdout, stderr io.Writer, f ConvertFn) int {
|
||||||
|
p := Program{Fn: f}
|
||||||
|
return p.main(args, input, stdout, stderr)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProcessMainStdin(t *testing.T) {
|
||||||
|
stdout := new(bytes.Buffer)
|
||||||
|
stderr := new(bytes.Buffer)
|
||||||
|
input := strings.NewReader("this is the input")
|
||||||
|
|
||||||
|
exit := processMain([]string{}, input, stdout, stderr, func(r io.Reader, w io.Writer) error {
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.Equal(t, 0, exit)
|
||||||
|
assert.Empty(t, stdout.String())
|
||||||
|
assert.Empty(t, stderr.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProcessMainStdinErr(t *testing.T) {
|
||||||
|
stdout := new(bytes.Buffer)
|
||||||
|
stderr := new(bytes.Buffer)
|
||||||
|
input := strings.NewReader("this is the input")
|
||||||
|
|
||||||
|
exit := processMain([]string{}, input, stdout, stderr, func(r io.Reader, w io.Writer) error {
|
||||||
|
return fmt.Errorf("something bad")
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.Equal(t, -1, exit)
|
||||||
|
assert.Empty(t, stdout.String())
|
||||||
|
assert.NotEmpty(t, stderr.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProcessMainFileExists(t *testing.T) {
|
||||||
|
tmpfile, err := ioutil.TempFile("", "example")
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer os.Remove(tmpfile.Name())
|
||||||
|
_, err = tmpfile.Write([]byte(`some data`))
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
stdout := new(bytes.Buffer)
|
||||||
|
stderr := new(bytes.Buffer)
|
||||||
|
|
||||||
|
exit := processMain([]string{tmpfile.Name()}, nil, stdout, stderr, func(r io.Reader, w io.Writer) error {
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.Equal(t, 0, exit)
|
||||||
|
assert.Empty(t, stdout.String())
|
||||||
|
assert.Empty(t, stderr.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProcessMainFileDoesNotExist(t *testing.T) {
|
||||||
|
stdout := new(bytes.Buffer)
|
||||||
|
stderr := new(bytes.Buffer)
|
||||||
|
|
||||||
|
exit := processMain([]string{"/lets/hope/this/does/not/exist"}, nil, stdout, stderr, func(r io.Reader, w io.Writer) error {
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
|
||||||
|
assert.Equal(t, -1, exit)
|
||||||
|
assert.Empty(t, stdout.String())
|
||||||
|
assert.NotEmpty(t, stderr.String())
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProcessMainFilesInPlace(t *testing.T) {
|
||||||
|
dir, err := ioutil.TempDir("", "")
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer os.RemoveAll(dir)
|
||||||
|
|
||||||
|
path1 := path.Join(dir, "file1")
|
||||||
|
path2 := path.Join(dir, "file2")
|
||||||
|
|
||||||
|
err = ioutil.WriteFile(path1, []byte("content 1"), 0600)
|
||||||
|
require.NoError(t, err)
|
||||||
|
err = ioutil.WriteFile(path2, []byte("content 2"), 0600)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
p := Program{
|
||||||
|
Fn: dummyFileFn,
|
||||||
|
Inplace: true,
|
||||||
|
}
|
||||||
|
|
||||||
|
exit := p.main([]string{path1, path2}, os.Stdin, os.Stdout, os.Stderr)
|
||||||
|
|
||||||
|
require.Equal(t, 0, exit)
|
||||||
|
|
||||||
|
v1, err := ioutil.ReadFile(path1)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Equal(t, "1", string(v1))
|
||||||
|
|
||||||
|
v2, err := ioutil.ReadFile(path2)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Equal(t, "2", string(v2))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProcessMainFilesInPlaceErrRead(t *testing.T) {
|
||||||
|
p := Program{
|
||||||
|
Fn: dummyFileFn,
|
||||||
|
Inplace: true,
|
||||||
|
}
|
||||||
|
|
||||||
|
exit := p.main([]string{"/this/path/is/invalid"}, os.Stdin, os.Stdout, os.Stderr)
|
||||||
|
|
||||||
|
require.Equal(t, -1, exit)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestProcessMainFilesInPlaceFailFn(t *testing.T) {
|
||||||
|
dir, err := ioutil.TempDir("", "")
|
||||||
|
require.NoError(t, err)
|
||||||
|
defer os.RemoveAll(dir)
|
||||||
|
|
||||||
|
path1 := path.Join(dir, "file1")
|
||||||
|
|
||||||
|
err = ioutil.WriteFile(path1, []byte("content 1"), 0600)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
p := Program{
|
||||||
|
Fn: func(io.Reader, io.Writer) error { return fmt.Errorf("oh no") },
|
||||||
|
Inplace: true,
|
||||||
|
}
|
||||||
|
|
||||||
|
exit := p.main([]string{path1}, os.Stdin, os.Stdout, os.Stderr)
|
||||||
|
|
||||||
|
require.Equal(t, -1, exit)
|
||||||
|
|
||||||
|
v1, err := ioutil.ReadFile(path1)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Equal(t, "content 1", string(v1))
|
||||||
|
}
|
||||||
|
|
||||||
|
func dummyFileFn(r io.Reader, w io.Writer) error {
|
||||||
|
b, err := ioutil.ReadAll(r)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
v := strings.SplitN(string(b), " ", 2)[1]
|
||||||
|
_, err = w.Write([]byte(v))
|
||||||
|
return err
|
||||||
|
}
|
||||||
@@ -457,35 +457,6 @@ func TestEmptytomlUnmarshal(t *testing.T) {
|
|||||||
assert.Equal(t, emptyTestData, result)
|
assert.Equal(t, emptyTestData, result)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestEmptyUnmarshalOmit(t *testing.T) {
|
|
||||||
t.Skipf("Have not figured yet if omitempty is a good idea")
|
|
||||||
|
|
||||||
type emptyMarshalTestStruct2 struct {
|
|
||||||
Title string `toml:"title"`
|
|
||||||
Bool bool `toml:"bool,omitempty"`
|
|
||||||
Int int `toml:"int, omitempty"`
|
|
||||||
String string `toml:"string,omitempty "`
|
|
||||||
StringList []string `toml:"stringlist,omitempty"`
|
|
||||||
Ptr *basicMarshalTestStruct `toml:"ptr,omitempty"`
|
|
||||||
Map map[string]string `toml:"map,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
emptyTestData2 := emptyMarshalTestStruct2{
|
|
||||||
Title: "Placeholder",
|
|
||||||
Bool: false,
|
|
||||||
Int: 0,
|
|
||||||
String: "",
|
|
||||||
StringList: []string{},
|
|
||||||
Ptr: nil,
|
|
||||||
Map: map[string]string{},
|
|
||||||
}
|
|
||||||
|
|
||||||
result := emptyMarshalTestStruct2{}
|
|
||||||
err := toml.Unmarshal(emptyTestToml, &result)
|
|
||||||
require.NoError(t, err)
|
|
||||||
assert.Equal(t, emptyTestData2, result)
|
|
||||||
}
|
|
||||||
|
|
||||||
type pointerMarshalTestStruct struct {
|
type pointerMarshalTestStruct struct {
|
||||||
Str *string
|
Str *string
|
||||||
List *[]string
|
List *[]string
|
||||||
@@ -956,6 +927,29 @@ func TestUnmarshalMapWithTypedKey(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestUnmarshalTypeTableHeader(t *testing.T) {
|
||||||
|
testToml := []byte(`
|
||||||
|
[test]
|
||||||
|
a = 1
|
||||||
|
`)
|
||||||
|
|
||||||
|
type header string
|
||||||
|
var result map[header]map[string]int
|
||||||
|
err := toml.Unmarshal(testToml, &result)
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("Received unexpected error: %s", err)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
expected := map[header]map[string]int{
|
||||||
|
"test": map[string]int{"a": 1},
|
||||||
|
}
|
||||||
|
|
||||||
|
if !reflect.DeepEqual(result, expected) {
|
||||||
|
t.Errorf("Bad unmarshal: expected %v, got %v", expected, result)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestUnmarshalNonPointer(t *testing.T) {
|
func TestUnmarshalNonPointer(t *testing.T) {
|
||||||
a := 1
|
a := 1
|
||||||
err := toml.Unmarshal([]byte{}, a)
|
err := toml.Unmarshal([]byte{}, a)
|
||||||
@@ -1954,7 +1948,7 @@ func decoder(doc string) *toml.Decoder {
|
|||||||
|
|
||||||
func strictDecoder(doc string) *toml.Decoder {
|
func strictDecoder(doc string) *toml.Decoder {
|
||||||
d := decoder(doc)
|
d := decoder(doc)
|
||||||
d.SetStrict(true)
|
d.DisallowUnknownFields()
|
||||||
return d
|
return d
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+117
-70
@@ -3,6 +3,7 @@ package tracker
|
|||||||
import (
|
import (
|
||||||
"bytes"
|
"bytes"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"sync"
|
||||||
|
|
||||||
"github.com/pelletier/go-toml/v2/internal/ast"
|
"github.com/pelletier/go-toml/v2/internal/ast"
|
||||||
)
|
)
|
||||||
@@ -54,69 +55,103 @@ func (k keyKind) String() string {
|
|||||||
type SeenTracker struct {
|
type SeenTracker struct {
|
||||||
entries []entry
|
entries []entry
|
||||||
currentIdx int
|
currentIdx int
|
||||||
nextID int
|
}
|
||||||
|
|
||||||
|
var pool sync.Pool
|
||||||
|
|
||||||
|
func (s *SeenTracker) reset() {
|
||||||
|
// Always contains a root element at index 0.
|
||||||
|
s.currentIdx = 0
|
||||||
|
if len(s.entries) == 0 {
|
||||||
|
s.entries = make([]entry, 1, 2)
|
||||||
|
} else {
|
||||||
|
s.entries = s.entries[:1]
|
||||||
|
}
|
||||||
|
s.entries[0].child = -1
|
||||||
|
s.entries[0].next = -1
|
||||||
}
|
}
|
||||||
|
|
||||||
type entry struct {
|
type entry struct {
|
||||||
id int
|
// Use -1 to indicate no child or no sibling.
|
||||||
parent int
|
child int
|
||||||
|
next int
|
||||||
|
|
||||||
name []byte
|
name []byte
|
||||||
kind keyKind
|
kind keyKind
|
||||||
explicit bool
|
explicit bool
|
||||||
}
|
}
|
||||||
|
|
||||||
// Remove all descendants of node at position idx.
|
// Find the index of the child of parentIdx with key k. Returns -1 if
|
||||||
func (s *SeenTracker) clear(idx int) {
|
// it does not exist.
|
||||||
p := s.entries[idx].id
|
func (s *SeenTracker) find(parentIdx int, k []byte) int {
|
||||||
rest := clear(p, s.entries[idx+1:])
|
for i := s.entries[parentIdx].child; i >= 0; i = s.entries[i].next {
|
||||||
s.entries = s.entries[:idx+1+len(rest)]
|
if bytes.Equal(s.entries[i].name, k) {
|
||||||
}
|
return i
|
||||||
|
|
||||||
func clear(parentID int, entries []entry) []entry {
|
|
||||||
for i := 0; i < len(entries); {
|
|
||||||
if entries[i].parent == parentID {
|
|
||||||
id := entries[i].id
|
|
||||||
copy(entries[i:], entries[i+1:])
|
|
||||||
entries = entries[:len(entries)-1]
|
|
||||||
rest := clear(id, entries[i:])
|
|
||||||
entries = entries[:i+len(rest)]
|
|
||||||
} else {
|
|
||||||
i++
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return entries
|
return -1
|
||||||
|
}
|
||||||
|
|
||||||
|
// Remove all descendants of node at position idx.
|
||||||
|
func (s *SeenTracker) clear(idx int) {
|
||||||
|
if idx >= len(s.entries) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
for i := s.entries[idx].child; i >= 0; {
|
||||||
|
next := s.entries[i].next
|
||||||
|
n := s.entries[0].next
|
||||||
|
s.entries[0].next = i
|
||||||
|
s.entries[i].next = n
|
||||||
|
s.entries[i].name = nil
|
||||||
|
s.clear(i)
|
||||||
|
i = next
|
||||||
|
}
|
||||||
|
|
||||||
|
s.entries[idx].child = -1
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *SeenTracker) create(parentIdx int, name []byte, kind keyKind, explicit bool) int {
|
func (s *SeenTracker) create(parentIdx int, name []byte, kind keyKind, explicit bool) int {
|
||||||
parentID := s.id(parentIdx)
|
e := entry{
|
||||||
|
child: -1,
|
||||||
|
next: s.entries[parentIdx].child,
|
||||||
|
|
||||||
idx := len(s.entries)
|
|
||||||
s.entries = append(s.entries, entry{
|
|
||||||
id: s.nextID,
|
|
||||||
parent: parentID,
|
|
||||||
name: name,
|
name: name,
|
||||||
kind: kind,
|
kind: kind,
|
||||||
explicit: explicit,
|
explicit: explicit,
|
||||||
})
|
}
|
||||||
s.nextID++
|
var idx int
|
||||||
|
if s.entries[0].next >= 0 {
|
||||||
|
idx = s.entries[0].next
|
||||||
|
s.entries[0].next = s.entries[idx].next
|
||||||
|
s.entries[idx] = e
|
||||||
|
} else {
|
||||||
|
idx = len(s.entries)
|
||||||
|
s.entries = append(s.entries, e)
|
||||||
|
}
|
||||||
|
|
||||||
|
s.entries[parentIdx].child = idx
|
||||||
|
|
||||||
return idx
|
return idx
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (s *SeenTracker) setExplicitFlag(parentIdx int) {
|
||||||
|
for i := s.entries[parentIdx].child; i >= 0; i = s.entries[i].next {
|
||||||
|
s.entries[i].explicit = true
|
||||||
|
s.setExplicitFlag(i)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// CheckExpression takes a top-level node and checks that it does not contain
|
// 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
|
// keys that have been seen in previous calls, and validates that types are
|
||||||
// consistent.
|
// consistent.
|
||||||
func (s *SeenTracker) CheckExpression(node *ast.Node) error {
|
func (s *SeenTracker) CheckExpression(node *ast.Node) error {
|
||||||
if s.entries == nil {
|
if s.entries == nil {
|
||||||
// Skip ID = 0 to remove the confusion between nodes whose
|
s.reset()
|
||||||
// parent has id 0 and root nodes (parent id is 0 because it's
|
|
||||||
// the zero value).
|
|
||||||
s.nextID = 1
|
|
||||||
// Start unscoped, so idx is negative.
|
|
||||||
s.currentIdx = -1
|
|
||||||
}
|
}
|
||||||
switch node.Kind {
|
switch node.Kind {
|
||||||
case ast.KeyValue:
|
case ast.KeyValue:
|
||||||
return s.checkKeyValue(s.currentIdx, node)
|
return s.checkKeyValue(node)
|
||||||
case ast.Table:
|
case ast.Table:
|
||||||
return s.checkTable(node)
|
return s.checkTable(node)
|
||||||
case ast.ArrayTable:
|
case ast.ArrayTable:
|
||||||
@@ -127,9 +162,13 @@ func (s *SeenTracker) CheckExpression(node *ast.Node) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (s *SeenTracker) checkTable(node *ast.Node) error {
|
func (s *SeenTracker) checkTable(node *ast.Node) error {
|
||||||
|
if s.currentIdx >= 0 {
|
||||||
|
s.setExplicitFlag(s.currentIdx)
|
||||||
|
}
|
||||||
|
|
||||||
it := node.Key()
|
it := node.Key()
|
||||||
|
|
||||||
parentIdx := -1
|
parentIdx := 0
|
||||||
|
|
||||||
// This code is duplicated in checkArrayTable. This is because factoring
|
// This code is duplicated in checkArrayTable. This is because factoring
|
||||||
// it in a function requires to copy the iterator, or allocate it to the
|
// it in a function requires to copy the iterator, or allocate it to the
|
||||||
@@ -145,6 +184,11 @@ func (s *SeenTracker) checkTable(node *ast.Node) error {
|
|||||||
|
|
||||||
if idx < 0 {
|
if idx < 0 {
|
||||||
idx = s.create(parentIdx, k, tableKind, false)
|
idx = s.create(parentIdx, k, tableKind, false)
|
||||||
|
} else {
|
||||||
|
entry := s.entries[idx]
|
||||||
|
if entry.kind == valueKind {
|
||||||
|
return fmt.Errorf("toml: expected %s to be a table, not a %s", string(k), entry.kind)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
parentIdx = idx
|
parentIdx = idx
|
||||||
}
|
}
|
||||||
@@ -171,9 +215,13 @@ func (s *SeenTracker) checkTable(node *ast.Node) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (s *SeenTracker) checkArrayTable(node *ast.Node) error {
|
func (s *SeenTracker) checkArrayTable(node *ast.Node) error {
|
||||||
|
if s.currentIdx >= 0 {
|
||||||
|
s.setExplicitFlag(s.currentIdx)
|
||||||
|
}
|
||||||
|
|
||||||
it := node.Key()
|
it := node.Key()
|
||||||
|
|
||||||
parentIdx := -1
|
parentIdx := 0
|
||||||
|
|
||||||
for it.Next() {
|
for it.Next() {
|
||||||
if it.IsLast() {
|
if it.IsLast() {
|
||||||
@@ -186,7 +234,13 @@ func (s *SeenTracker) checkArrayTable(node *ast.Node) error {
|
|||||||
|
|
||||||
if idx < 0 {
|
if idx < 0 {
|
||||||
idx = s.create(parentIdx, k, tableKind, false)
|
idx = s.create(parentIdx, k, tableKind, false)
|
||||||
|
} else {
|
||||||
|
entry := s.entries[idx]
|
||||||
|
if entry.kind == valueKind {
|
||||||
|
return fmt.Errorf("toml: expected %s to be a table, not a %s", string(k), entry.kind)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
parentIdx = idx
|
parentIdx = idx
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -208,7 +262,8 @@ func (s *SeenTracker) checkArrayTable(node *ast.Node) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *SeenTracker) checkKeyValue(parentIdx int, node *ast.Node) error {
|
func (s *SeenTracker) checkKeyValue(node *ast.Node) error {
|
||||||
|
parentIdx := s.currentIdx
|
||||||
it := node.Key()
|
it := node.Key()
|
||||||
|
|
||||||
for it.Next() {
|
for it.Next() {
|
||||||
@@ -238,67 +293,59 @@ func (s *SeenTracker) checkKeyValue(parentIdx int, node *ast.Node) error {
|
|||||||
|
|
||||||
switch value.Kind {
|
switch value.Kind {
|
||||||
case ast.InlineTable:
|
case ast.InlineTable:
|
||||||
return s.checkInlineTable(parentIdx, value)
|
return s.checkInlineTable(value)
|
||||||
case ast.Array:
|
case ast.Array:
|
||||||
return s.checkArray(parentIdx, value)
|
return s.checkArray(value)
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *SeenTracker) checkArray(parentIdx int, node *ast.Node) error {
|
func (s *SeenTracker) checkArray(node *ast.Node) error {
|
||||||
set := false
|
|
||||||
it := node.Children()
|
it := node.Children()
|
||||||
for it.Next() {
|
for it.Next() {
|
||||||
if set {
|
|
||||||
s.clear(parentIdx)
|
|
||||||
}
|
|
||||||
n := it.Node()
|
n := it.Node()
|
||||||
switch n.Kind {
|
switch n.Kind {
|
||||||
case ast.InlineTable:
|
case ast.InlineTable:
|
||||||
err := s.checkInlineTable(parentIdx, n)
|
err := s.checkInlineTable(n)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
set = true
|
|
||||||
case ast.Array:
|
case ast.Array:
|
||||||
err := s.checkArray(parentIdx, n)
|
err := s.checkArray(n)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
set = true
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *SeenTracker) checkInlineTable(parentIdx int, node *ast.Node) error {
|
func (s *SeenTracker) checkInlineTable(node *ast.Node) error {
|
||||||
|
if pool.New == nil {
|
||||||
|
pool.New = func() interface{} {
|
||||||
|
return &SeenTracker{}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
s = pool.Get().(*SeenTracker)
|
||||||
|
s.reset()
|
||||||
|
|
||||||
it := node.Children()
|
it := node.Children()
|
||||||
for it.Next() {
|
for it.Next() {
|
||||||
n := it.Node()
|
n := it.Node()
|
||||||
err := s.checkKeyValue(parentIdx, n)
|
err := s.checkKeyValue(n)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// As inline tables are self-contained, the tracker does not
|
||||||
|
// need to retain the details of what they contain. The
|
||||||
|
// keyValue element that creates the inline table is kept to
|
||||||
|
// mark the presence of the inline table and prevent
|
||||||
|
// redefinition of its keys: check* functions cannot walk into
|
||||||
|
// a value.
|
||||||
|
pool.Put(s)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *SeenTracker) id(idx int) int {
|
|
||||||
if idx >= 0 {
|
|
||||||
return s.entries[idx].id
|
|
||||||
}
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *SeenTracker) find(parentIdx int, k []byte) int {
|
|
||||||
parentID := s.id(parentIdx)
|
|
||||||
|
|
||||||
for i := parentIdx + 1; i < len(s.entries); i++ {
|
|
||||||
if s.entries[i].parent == parentID && bytes.Equal(s.entries[i].name, k) {
|
|
||||||
return i
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return -1
|
|
||||||
}
|
|
||||||
|
|||||||
+156
-34
@@ -11,6 +11,7 @@ import (
|
|||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
"unicode"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Marshal serializes a Go value as a TOML document.
|
// Marshal serializes a Go value as a TOML document.
|
||||||
@@ -103,27 +104,31 @@ func (enc *Encoder) SetIndentTables(indent bool) *Encoder {
|
|||||||
// Intermediate tables are always printed.
|
// Intermediate tables are always printed.
|
||||||
//
|
//
|
||||||
// By default, strings are encoded as literal string, unless they contain either
|
// 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
|
// a newline character or a single quote. In that case they are emitted as
|
||||||
// strings.
|
// quoted strings.
|
||||||
//
|
//
|
||||||
// When encoding structs, fields are encoded in order of definition, with their
|
// When encoding structs, fields are encoded in order of definition, with their
|
||||||
// exact name.
|
// exact name.
|
||||||
//
|
//
|
||||||
// Struct tags
|
// Struct tags
|
||||||
//
|
//
|
||||||
// The following struct tags are available to tweak encoding on a per-field
|
// The encoding of each public struct field can be customized by the format
|
||||||
// basis:
|
// string in the "toml" key of the struct field's tag. This follows
|
||||||
|
// encoding/json's convention. The format string starts with the name of the
|
||||||
|
// field, optionally followed by a comma-separated list of options. The name may
|
||||||
|
// be empty in order to provide options without overriding the default name.
|
||||||
//
|
//
|
||||||
// toml:"foo"
|
// The "multiline" option emits strings as quoted multi-line TOML strings. It
|
||||||
// Changes the name of the key to use for the field to foo.
|
// has no effect on fields that would not be encoded as strings.
|
||||||
//
|
//
|
||||||
// multiline:"true"
|
// The "inline" option turns fields that would be emitted as tables into inline
|
||||||
// When the field contains a string, it will be emitted as a quoted
|
// tables instead. It has no effect on other fields.
|
||||||
// multi-line TOML string.
|
|
||||||
//
|
//
|
||||||
// inline:"true"
|
// The "omitempty" option prevents empty values or groups from being emitted.
|
||||||
// When the field would normally be encoded as a table, it is instead
|
//
|
||||||
// encoded as an inline table.
|
// In addition to the "toml" tag struct tag, a "comment" tag can be used to emit
|
||||||
|
// a TOML comment before the value being annotated. Comments are ignored inside
|
||||||
|
// inline tables.
|
||||||
func (enc *Encoder) Encode(v interface{}) error {
|
func (enc *Encoder) Encode(v interface{}) error {
|
||||||
var (
|
var (
|
||||||
b []byte
|
b []byte
|
||||||
@@ -151,6 +156,8 @@ func (enc *Encoder) Encode(v interface{}) error {
|
|||||||
|
|
||||||
type valueOptions struct {
|
type valueOptions struct {
|
||||||
multiline bool
|
multiline bool
|
||||||
|
omitempty bool
|
||||||
|
comment string
|
||||||
}
|
}
|
||||||
|
|
||||||
type encoderCtx struct {
|
type encoderCtx struct {
|
||||||
@@ -200,7 +207,6 @@ func (ctx *encoderCtx) isRoot() bool {
|
|||||||
return len(ctx.parentKey) == 0 && !ctx.hasKey
|
return len(ctx.parentKey) == 0 && !ctx.hasKey
|
||||||
}
|
}
|
||||||
|
|
||||||
//nolint:cyclop,funlen
|
|
||||||
func (enc *Encoder) encode(b []byte, ctx encoderCtx, v reflect.Value) ([]byte, error) {
|
func (enc *Encoder) encode(b []byte, ctx encoderCtx, v reflect.Value) ([]byte, error) {
|
||||||
if !v.IsZero() {
|
if !v.IsZero() {
|
||||||
i, ok := v.Interface().(time.Time)
|
i, ok := v.Interface().(time.Time)
|
||||||
@@ -209,7 +215,12 @@ func (enc *Encoder) encode(b []byte, ctx encoderCtx, v reflect.Value) ([]byte, e
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if v.Type().Implements(textMarshalerType) {
|
hasTextMarshaler := v.Type().Implements(textMarshalerType)
|
||||||
|
if hasTextMarshaler || (v.CanAddr() && reflect.PtrTo(v.Type()).Implements(textMarshalerType)) {
|
||||||
|
if !hasTextMarshaler {
|
||||||
|
v = v.Addr()
|
||||||
|
}
|
||||||
|
|
||||||
if ctx.isRoot() {
|
if ctx.isRoot() {
|
||||||
return nil, fmt.Errorf("toml: type %s implementing the TextMarshaler interface cannot be a root element", v.Type())
|
return nil, fmt.Errorf("toml: type %s implementing the TextMarshaler interface cannot be a root element", v.Type())
|
||||||
}
|
}
|
||||||
@@ -292,6 +303,15 @@ func (enc *Encoder) encodeKv(b []byte, ctx encoderCtx, options valueOptions, v r
|
|||||||
if !ctx.hasKey {
|
if !ctx.hasKey {
|
||||||
panic("caller of encodeKv should have set the key in the context")
|
panic("caller of encodeKv should have set the key in the context")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (ctx.options.omitempty || options.omitempty) && isEmptyValue(v) {
|
||||||
|
return b, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
if !ctx.inline {
|
||||||
|
b = enc.encodeComment(ctx.indent, options.comment, b)
|
||||||
|
}
|
||||||
|
|
||||||
b = enc.indent(ctx.indent, b)
|
b = enc.indent(ctx.indent, b)
|
||||||
|
|
||||||
b, err = enc.encodeKey(b, ctx.key)
|
b, err = enc.encodeKey(b, ctx.key)
|
||||||
@@ -316,6 +336,24 @@ func (enc *Encoder) encodeKv(b []byte, ctx encoderCtx, options valueOptions, v r
|
|||||||
return b, nil
|
return b, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func isEmptyValue(v reflect.Value) bool {
|
||||||
|
switch v.Kind() {
|
||||||
|
case reflect.Array, reflect.Map, reflect.Slice, reflect.String:
|
||||||
|
return v.Len() == 0
|
||||||
|
case reflect.Bool:
|
||||||
|
return !v.Bool()
|
||||||
|
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
|
||||||
|
return v.Int() == 0
|
||||||
|
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uintptr:
|
||||||
|
return v.Uint() == 0
|
||||||
|
case reflect.Float32, reflect.Float64:
|
||||||
|
return v.Float() == 0
|
||||||
|
case reflect.Interface, reflect.Ptr:
|
||||||
|
return v.IsNil()
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
const literalQuote = '\''
|
const literalQuote = '\''
|
||||||
|
|
||||||
func (enc *Encoder) encodeString(b []byte, v string, options valueOptions) []byte {
|
func (enc *Encoder) encodeString(b []byte, v string, options valueOptions) []byte {
|
||||||
@@ -409,6 +447,8 @@ func (enc *Encoder) encodeTableHeader(ctx encoderCtx, b []byte) ([]byte, error)
|
|||||||
return b, nil
|
return b, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
b = enc.encodeComment(ctx.indent, ctx.options.comment, b)
|
||||||
|
|
||||||
b = enc.indent(ctx.indent, b)
|
b = enc.indent(ctx.indent, b)
|
||||||
|
|
||||||
b = append(b, '[')
|
b = append(b, '[')
|
||||||
@@ -515,18 +555,26 @@ type table struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (t *table) pushKV(k string, v reflect.Value, options valueOptions) {
|
func (t *table) pushKV(k string, v reflect.Value, options valueOptions) {
|
||||||
|
for _, e := range t.kvs {
|
||||||
|
if e.Key == k {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
t.kvs = append(t.kvs, entry{Key: k, Value: v, Options: options})
|
t.kvs = append(t.kvs, entry{Key: k, Value: v, Options: options})
|
||||||
}
|
}
|
||||||
|
|
||||||
func (t *table) pushTable(k string, v reflect.Value, options valueOptions) {
|
func (t *table) pushTable(k string, v reflect.Value, options valueOptions) {
|
||||||
|
for _, e := range t.tables {
|
||||||
|
if e.Key == k {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
t.tables = append(t.tables, entry{Key: k, Value: v, Options: options})
|
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) {
|
func walkStruct(ctx encoderCtx, t *table, v reflect.Value) {
|
||||||
var t table
|
// TODO: cache this
|
||||||
|
|
||||||
//nolint:godox
|
|
||||||
// TODO: cache this?
|
|
||||||
typ := v.Type()
|
typ := v.Type()
|
||||||
for i := 0; i < typ.NumField(); i++ {
|
for i := 0; i < typ.NumField(); i++ {
|
||||||
fieldType := typ.Field(i)
|
fieldType := typ.Field(i)
|
||||||
@@ -536,45 +584,119 @@ func (enc *Encoder) encodeStruct(b []byte, ctx encoderCtx, v reflect.Value) ([]b
|
|||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
k, ok := fieldType.Tag.Lookup("toml")
|
tag := fieldType.Tag.Get("toml")
|
||||||
if !ok {
|
|
||||||
k = fieldType.Name
|
|
||||||
}
|
|
||||||
|
|
||||||
// special field name to skip field
|
// special field name to skip field
|
||||||
if k == "-" {
|
if tag == "-" {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
|
k, opts := parseTag(tag)
|
||||||
|
if !isValidName(k) {
|
||||||
|
k = ""
|
||||||
|
}
|
||||||
|
|
||||||
f := v.Field(i)
|
f := v.Field(i)
|
||||||
|
|
||||||
|
if k == "" {
|
||||||
|
if fieldType.Anonymous {
|
||||||
|
walkStruct(ctx, t, f)
|
||||||
|
continue
|
||||||
|
} else {
|
||||||
|
k = fieldType.Name
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
if isNil(f) {
|
if isNil(f) {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
options := valueOptions{
|
options := valueOptions{
|
||||||
multiline: fieldBoolTag(fieldType, "multiline"),
|
multiline: opts.multiline,
|
||||||
|
omitempty: opts.omitempty,
|
||||||
|
comment: fieldType.Tag.Get("comment"),
|
||||||
}
|
}
|
||||||
|
|
||||||
inline := fieldBoolTag(fieldType, "inline")
|
if opts.inline || !willConvertToTableOrArrayTable(ctx, f) {
|
||||||
|
|
||||||
if inline || !willConvertToTableOrArrayTable(ctx, f) {
|
|
||||||
t.pushKV(k, f, options)
|
t.pushKV(k, f, options)
|
||||||
} else {
|
} else {
|
||||||
t.pushTable(k, f, options)
|
t.pushTable(k, f, options)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func (enc *Encoder) encodeStruct(b []byte, ctx encoderCtx, v reflect.Value) ([]byte, error) {
|
||||||
|
var t table
|
||||||
|
|
||||||
|
walkStruct(ctx, &t, v)
|
||||||
|
|
||||||
return enc.encodeTable(b, ctx, t)
|
return enc.encodeTable(b, ctx, t)
|
||||||
}
|
}
|
||||||
|
|
||||||
func fieldBoolTag(field reflect.StructField, tag string) bool {
|
func (enc *Encoder) encodeComment(indent int, comment string, b []byte) []byte {
|
||||||
x, ok := field.Tag.Lookup(tag)
|
if comment != "" {
|
||||||
|
b = enc.indent(indent, b)
|
||||||
return ok && x == "true"
|
b = append(b, "# "...)
|
||||||
|
b = append(b, comment...)
|
||||||
|
b = append(b, '\n')
|
||||||
|
}
|
||||||
|
return b
|
||||||
|
}
|
||||||
|
|
||||||
|
func isValidName(s string) bool {
|
||||||
|
if s == "" {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
for _, c := range s {
|
||||||
|
switch {
|
||||||
|
case strings.ContainsRune("!#$%&()*+-./:;<=>?@[]^_{|}~ ", c):
|
||||||
|
// Backslash and quote chars are reserved, but
|
||||||
|
// otherwise any punctuation chars are allowed
|
||||||
|
// in a tag name.
|
||||||
|
case !unicode.IsLetter(c) && !unicode.IsDigit(c):
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
type tagOptions struct {
|
||||||
|
multiline bool
|
||||||
|
inline bool
|
||||||
|
omitempty bool
|
||||||
|
}
|
||||||
|
|
||||||
|
func parseTag(tag string) (string, tagOptions) {
|
||||||
|
opts := tagOptions{}
|
||||||
|
|
||||||
|
idx := strings.Index(tag, ",")
|
||||||
|
if idx == -1 {
|
||||||
|
return tag, opts
|
||||||
|
}
|
||||||
|
|
||||||
|
raw := tag[idx+1:]
|
||||||
|
tag = string(tag[:idx])
|
||||||
|
for raw != "" {
|
||||||
|
var o string
|
||||||
|
i := strings.Index(raw, ",")
|
||||||
|
if i >= 0 {
|
||||||
|
o, raw = raw[:i], raw[i+1:]
|
||||||
|
} else {
|
||||||
|
o, raw = raw, ""
|
||||||
|
}
|
||||||
|
switch o {
|
||||||
|
case "multiline":
|
||||||
|
opts.multiline = true
|
||||||
|
case "inline":
|
||||||
|
opts.inline = true
|
||||||
|
case "omitempty":
|
||||||
|
opts.omitempty = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return tag, opts
|
||||||
}
|
}
|
||||||
|
|
||||||
//nolint:cyclop
|
|
||||||
func (enc *Encoder) encodeTable(b []byte, ctx encoderCtx, t table) ([]byte, error) {
|
func (enc *Encoder) encodeTable(b []byte, ctx encoderCtx, t table) ([]byte, error) {
|
||||||
var err error
|
var err error
|
||||||
|
|
||||||
@@ -657,7 +779,7 @@ func willConvertToTable(ctx encoderCtx, v reflect.Value) bool {
|
|||||||
if !v.IsValid() {
|
if !v.IsValid() {
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
if v.Type() == timeType || v.Type().Implements(textMarshalerType) {
|
if v.Type() == timeType || v.Type().Implements(textMarshalerType) || (v.Kind() != reflect.Ptr && v.CanAddr() && reflect.PtrTo(v.Type()).Implements(textMarshalerType)) {
|
||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+222
-32
@@ -4,20 +4,27 @@ import (
|
|||||||
"bytes"
|
"bytes"
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"math/big"
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
"github.com/pelletier/go-toml/v2"
|
"github.com/pelletier/go-toml/v2"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
)
|
)
|
||||||
|
|
||||||
//nolint:funlen
|
|
||||||
func TestMarshal(t *testing.T) {
|
func TestMarshal(t *testing.T) {
|
||||||
someInt := 42
|
someInt := 42
|
||||||
|
|
||||||
type structInline struct {
|
type structInline struct {
|
||||||
A interface{} `inline:"true"`
|
A interface{} `toml:",inline"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type comments struct {
|
||||||
|
One int
|
||||||
|
Two int `comment:"Before kv"`
|
||||||
|
Three []int `comment:"Before array"`
|
||||||
}
|
}
|
||||||
|
|
||||||
examples := []struct {
|
examples := []struct {
|
||||||
@@ -193,9 +200,9 @@ name = 'Alice'
|
|||||||
{
|
{
|
||||||
desc: "string escapes",
|
desc: "string escapes",
|
||||||
v: map[string]interface{}{
|
v: map[string]interface{}{
|
||||||
"a": `'"\`,
|
"a": "'\b\f\r\t\"\\",
|
||||||
},
|
},
|
||||||
expected: `a = "'\"\\"`,
|
expected: `a = "'\b\f\r\t\"\\"`,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
desc: "string utf8 low",
|
desc: "string utf8 low",
|
||||||
@@ -242,7 +249,7 @@ name = 'Alice'
|
|||||||
{
|
{
|
||||||
desc: "multi-line forced",
|
desc: "multi-line forced",
|
||||||
v: struct {
|
v: struct {
|
||||||
A string `multiline:"true"`
|
A string `toml:",multiline"`
|
||||||
}{
|
}{
|
||||||
A: "hello\nworld",
|
A: "hello\nworld",
|
||||||
},
|
},
|
||||||
@@ -253,7 +260,7 @@ world"""`,
|
|||||||
{
|
{
|
||||||
desc: "inline field",
|
desc: "inline field",
|
||||||
v: struct {
|
v: struct {
|
||||||
A map[string]string `inline:"true"`
|
A map[string]string `toml:",inline"`
|
||||||
B map[string]string
|
B map[string]string
|
||||||
}{
|
}{
|
||||||
A: map[string]string{
|
A: map[string]string{
|
||||||
@@ -272,7 +279,7 @@ isinline = 'no'
|
|||||||
{
|
{
|
||||||
desc: "mutiline array int",
|
desc: "mutiline array int",
|
||||||
v: struct {
|
v: struct {
|
||||||
A []int `multiline:"true"`
|
A []int `toml:",multiline"`
|
||||||
B []int
|
B []int
|
||||||
}{
|
}{
|
||||||
A: []int{1, 2, 3, 4},
|
A: []int{1, 2, 3, 4},
|
||||||
@@ -291,7 +298,7 @@ B = [1, 2, 3, 4]
|
|||||||
{
|
{
|
||||||
desc: "mutiline array in array",
|
desc: "mutiline array in array",
|
||||||
v: struct {
|
v: struct {
|
||||||
A [][]int `multiline:"true"`
|
A [][]int `toml:",multiline"`
|
||||||
}{
|
}{
|
||||||
A: [][]int{{1, 2}, {3, 4}},
|
A: [][]int{{1, 2}, {3, 4}},
|
||||||
},
|
},
|
||||||
@@ -469,6 +476,28 @@ hello = 'world'`,
|
|||||||
},
|
},
|
||||||
err: true,
|
err: true,
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
desc: "time",
|
||||||
|
v: struct {
|
||||||
|
T time.Time
|
||||||
|
}{
|
||||||
|
T: time.Time{},
|
||||||
|
},
|
||||||
|
expected: `T = '0001-01-01T00:00:00Z'`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "bool",
|
||||||
|
v: struct {
|
||||||
|
A bool
|
||||||
|
B bool
|
||||||
|
}{
|
||||||
|
A: false,
|
||||||
|
B: true,
|
||||||
|
},
|
||||||
|
expected: `
|
||||||
|
A = false
|
||||||
|
B = true`,
|
||||||
|
},
|
||||||
{
|
{
|
||||||
desc: "numbers",
|
desc: "numbers",
|
||||||
v: struct {
|
v: struct {
|
||||||
@@ -483,6 +512,7 @@ hello = 'world'`,
|
|||||||
I int16
|
I int16
|
||||||
J int8
|
J int8
|
||||||
K int
|
K int
|
||||||
|
L float64
|
||||||
}{
|
}{
|
||||||
A: 1.1,
|
A: 1.1,
|
||||||
B: 42,
|
B: 42,
|
||||||
@@ -495,6 +525,7 @@ hello = 'world'`,
|
|||||||
I: 42,
|
I: 42,
|
||||||
J: 42,
|
J: 42,
|
||||||
K: 42,
|
K: 42,
|
||||||
|
L: 2.2,
|
||||||
},
|
},
|
||||||
expected: `
|
expected: `
|
||||||
A = 1.1
|
A = 1.1
|
||||||
@@ -507,7 +538,29 @@ G = 42
|
|||||||
H = 42
|
H = 42
|
||||||
I = 42
|
I = 42
|
||||||
J = 42
|
J = 42
|
||||||
K = 42`,
|
K = 42
|
||||||
|
L = 2.2`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "comments",
|
||||||
|
v: struct {
|
||||||
|
Table comments `comment:"Before table"`
|
||||||
|
}{
|
||||||
|
Table: comments{
|
||||||
|
One: 1,
|
||||||
|
Two: 2,
|
||||||
|
Three: []int{1, 2, 3},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
expected: `
|
||||||
|
# Before table
|
||||||
|
[Table]
|
||||||
|
One = 1
|
||||||
|
# Before kv
|
||||||
|
Two = 2
|
||||||
|
# Before array
|
||||||
|
Three = [1, 2, 3]
|
||||||
|
`,
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -734,6 +787,60 @@ func TestEncoderSetIndentSymbol(t *testing.T) {
|
|||||||
equalStringsIgnoreNewlines(t, expected, w.String())
|
equalStringsIgnoreNewlines(t, expected, w.String())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestEncoderOmitempty(t *testing.T) {
|
||||||
|
type doc struct {
|
||||||
|
String string `toml:",omitempty,multiline"`
|
||||||
|
Bool bool `toml:",omitempty,multiline"`
|
||||||
|
Int int `toml:",omitempty,multiline"`
|
||||||
|
Int8 int8 `toml:",omitempty,multiline"`
|
||||||
|
Int16 int16 `toml:",omitempty,multiline"`
|
||||||
|
Int32 int32 `toml:",omitempty,multiline"`
|
||||||
|
Int64 int64 `toml:",omitempty,multiline"`
|
||||||
|
Uint uint `toml:",omitempty,multiline"`
|
||||||
|
Uint8 uint8 `toml:",omitempty,multiline"`
|
||||||
|
Uint16 uint16 `toml:",omitempty,multiline"`
|
||||||
|
Uint32 uint32 `toml:",omitempty,multiline"`
|
||||||
|
Uint64 uint64 `toml:",omitempty,multiline"`
|
||||||
|
Float32 float32 `toml:",omitempty,multiline"`
|
||||||
|
Float64 float64 `toml:",omitempty,multiline"`
|
||||||
|
MapNil map[string]string `toml:",omitempty,multiline"`
|
||||||
|
Slice []string `toml:",omitempty,multiline"`
|
||||||
|
Ptr *string `toml:",omitempty,multiline"`
|
||||||
|
Iface interface{} `toml:",omitempty,multiline"`
|
||||||
|
Struct struct{} `toml:",omitempty,multiline"`
|
||||||
|
}
|
||||||
|
|
||||||
|
d := doc{}
|
||||||
|
|
||||||
|
b, err := toml.Marshal(d)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
expected := `[Struct]`
|
||||||
|
|
||||||
|
equalStringsIgnoreNewlines(t, expected, string(b))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestEncoderTagFieldName(t *testing.T) {
|
||||||
|
type doc struct {
|
||||||
|
String string `toml:"hello"`
|
||||||
|
OkSym string `toml:"#"`
|
||||||
|
Bad string `toml:"\"`
|
||||||
|
}
|
||||||
|
|
||||||
|
d := doc{String: "world"}
|
||||||
|
|
||||||
|
b, err := toml.Marshal(d)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
expected := `
|
||||||
|
hello = 'world'
|
||||||
|
'#' = ''
|
||||||
|
Bad = ''
|
||||||
|
`
|
||||||
|
|
||||||
|
equalStringsIgnoreNewlines(t, expected, string(b))
|
||||||
|
}
|
||||||
|
|
||||||
func TestIssue436(t *testing.T) {
|
func TestIssue436(t *testing.T) {
|
||||||
data := []byte(`{"a": [ { "b": { "c": "d" } } ]}`)
|
data := []byte(`{"a": [ { "b": { "c": "d" } } ]}`)
|
||||||
|
|
||||||
@@ -798,6 +905,112 @@ func TestIssue590(t *testing.T) {
|
|||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestIssue571(t *testing.T) {
|
||||||
|
type Foo struct {
|
||||||
|
Float32 float32
|
||||||
|
Float64 float64
|
||||||
|
}
|
||||||
|
|
||||||
|
const closeEnough = 1e-9
|
||||||
|
|
||||||
|
foo := Foo{
|
||||||
|
Float32: 42,
|
||||||
|
Float64: 43,
|
||||||
|
}
|
||||||
|
b, err := toml.Marshal(foo)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
var foo2 Foo
|
||||||
|
err = toml.Unmarshal(b, &foo2)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
assert.InDelta(t, 42, foo2.Float32, closeEnough)
|
||||||
|
assert.InDelta(t, 43, foo2.Float64, closeEnough)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIssue678(t *testing.T) {
|
||||||
|
type Config struct {
|
||||||
|
BigInt big.Int
|
||||||
|
}
|
||||||
|
|
||||||
|
cfg := &Config{
|
||||||
|
BigInt: *big.NewInt(123),
|
||||||
|
}
|
||||||
|
|
||||||
|
out, err := toml.Marshal(cfg)
|
||||||
|
require.NoError(t, err)
|
||||||
|
equalStringsIgnoreNewlines(t, "BigInt = '123'", string(out))
|
||||||
|
|
||||||
|
cfg2 := &Config{}
|
||||||
|
err = toml.Unmarshal(out, cfg2)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Equal(t, cfg, cfg2)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMarshalNestedAnonymousStructs(t *testing.T) {
|
||||||
|
type Embedded struct {
|
||||||
|
Value string `toml:"value" json:"value"`
|
||||||
|
Top struct {
|
||||||
|
Value string `toml:"value" json:"value"`
|
||||||
|
} `toml:"top" json:"top"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type Named struct {
|
||||||
|
Value string `toml:"value" json:"value"`
|
||||||
|
}
|
||||||
|
|
||||||
|
var doc struct {
|
||||||
|
Embedded
|
||||||
|
Named `toml:"named" json:"named"`
|
||||||
|
Anonymous struct {
|
||||||
|
Value string `toml:"value" json:"value"`
|
||||||
|
} `toml:"anonymous" json:"anonymous"`
|
||||||
|
}
|
||||||
|
|
||||||
|
expected := `value = ''
|
||||||
|
[top]
|
||||||
|
value = ''
|
||||||
|
|
||||||
|
[named]
|
||||||
|
value = ''
|
||||||
|
|
||||||
|
[anonymous]
|
||||||
|
value = ''
|
||||||
|
|
||||||
|
`
|
||||||
|
|
||||||
|
result, err := toml.Marshal(doc)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Equal(t, expected, string(result))
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestMarshalNestedAnonymousStructs_DuplicateField(t *testing.T) {
|
||||||
|
type Embedded struct {
|
||||||
|
Value string `toml:"value" json:"value"`
|
||||||
|
Top struct {
|
||||||
|
Value string `toml:"value" json:"value"`
|
||||||
|
} `toml:"top" json:"top"`
|
||||||
|
}
|
||||||
|
|
||||||
|
var doc struct {
|
||||||
|
Value string `toml:"value" json:"value"`
|
||||||
|
Embedded
|
||||||
|
}
|
||||||
|
doc.Embedded.Value = "shadowed"
|
||||||
|
doc.Value = "shadows"
|
||||||
|
|
||||||
|
expected := `value = 'shadows'
|
||||||
|
[top]
|
||||||
|
value = ''
|
||||||
|
|
||||||
|
`
|
||||||
|
|
||||||
|
result, err := toml.Marshal(doc)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Equal(t, expected, string(result))
|
||||||
|
}
|
||||||
|
|
||||||
func ExampleMarshal() {
|
func ExampleMarshal() {
|
||||||
type MyConfig struct {
|
type MyConfig struct {
|
||||||
Version int
|
Version int
|
||||||
@@ -822,26 +1035,3 @@ func ExampleMarshal() {
|
|||||||
// Name = 'go-toml'
|
// Name = 'go-toml'
|
||||||
// Tags = ['go', 'toml']
|
// Tags = ['go', 'toml']
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIssue571(t *testing.T) {
|
|
||||||
type Foo struct {
|
|
||||||
Float32 float32
|
|
||||||
Float64 float64
|
|
||||||
}
|
|
||||||
|
|
||||||
const closeEnough = 1e-9
|
|
||||||
|
|
||||||
foo := Foo{
|
|
||||||
Float32: 42,
|
|
||||||
Float64: 43,
|
|
||||||
}
|
|
||||||
b, err := toml.Marshal(foo)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
var foo2 Foo
|
|
||||||
err = toml.Unmarshal(b, &foo2)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
assert.InDelta(t, 42, foo2.Float32, closeEnough)
|
|
||||||
assert.InDelta(t, 43, foo2.Float64, closeEnough)
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -578,6 +578,10 @@ func (p *parser) parseMultilineBasicString(b []byte) ([]byte, []byte, []byte, er
|
|||||||
switch token[i+j] {
|
switch token[i+j] {
|
||||||
case ' ', '\t':
|
case ' ', '\t':
|
||||||
continue
|
continue
|
||||||
|
case '\r':
|
||||||
|
if token[i+j+1] == '\n' {
|
||||||
|
continue
|
||||||
|
}
|
||||||
case '\n':
|
case '\n':
|
||||||
isLastNonWhitespaceOnLine = true
|
isLastNonWhitespaceOnLine = true
|
||||||
}
|
}
|
||||||
@@ -689,6 +693,10 @@ func (p *parser) parseKey(b []byte) (ast.Reference, []byte, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (p *parser) parseSimpleKey(b []byte) (raw, key, rest []byte, err error) {
|
func (p *parser) parseSimpleKey(b []byte) (raw, key, rest []byte, err error) {
|
||||||
|
if len(b) == 0 {
|
||||||
|
return nil, nil, nil, newDecodeError(b, "expected key but found none")
|
||||||
|
}
|
||||||
|
|
||||||
// simple-key = quoted-key / unquoted-key
|
// simple-key = quoted-key / unquoted-key
|
||||||
// unquoted-key = 1*( ALPHA / DIGIT / %x2D / %x5F ) ; A-Z / a-z / 0-9 / - / _
|
// unquoted-key = 1*( ALPHA / DIGIT / %x2D / %x5F ) ; A-Z / a-z / 0-9 / - / _
|
||||||
// quoted-key = basic-string / literal-string
|
// quoted-key = basic-string / literal-string
|
||||||
@@ -862,7 +870,6 @@ func (p *parser) parseIntOrFloatOrDateTime(b []byte) (ast.Reference, []byte, err
|
|||||||
return p.scanIntOrFloat(b)
|
return p.scanIntOrFloat(b)
|
||||||
}
|
}
|
||||||
|
|
||||||
//nolint:gomnd
|
|
||||||
if len(b) < 3 {
|
if len(b) < 3 {
|
||||||
return p.scanIntOrFloat(b)
|
return p.scanIntOrFloat(b)
|
||||||
}
|
}
|
||||||
@@ -887,18 +894,6 @@ func (p *parser) parseIntOrFloatOrDateTime(b []byte) (ast.Reference, []byte, err
|
|||||||
return p.scanIntOrFloat(b)
|
return p.scanIntOrFloat(b)
|
||||||
}
|
}
|
||||||
|
|
||||||
func digitsToInt(b []byte) int {
|
|
||||||
x := 0
|
|
||||||
|
|
||||||
for _, d := range b {
|
|
||||||
x *= 10
|
|
||||||
x += int(d - '0')
|
|
||||||
}
|
|
||||||
|
|
||||||
return x
|
|
||||||
}
|
|
||||||
|
|
||||||
//nolint:gocognit,cyclop
|
|
||||||
func (p *parser) scanDateTime(b []byte) (ast.Reference, []byte, error) {
|
func (p *parser) scanDateTime(b []byte) (ast.Reference, []byte, error) {
|
||||||
// scans for contiguous characters in [0-9T:Z.+-], and up to one space if
|
// scans for contiguous characters in [0-9T:Z.+-], and up to one space if
|
||||||
// followed by a digit.
|
// followed by a digit.
|
||||||
|
|||||||
+39
-19
@@ -53,7 +53,7 @@ func scanLiteralString(b []byte) ([]byte, []byte, error) {
|
|||||||
switch b[i] {
|
switch b[i] {
|
||||||
case '\'':
|
case '\'':
|
||||||
return b[:i+1], b[i+1:], nil
|
return b[:i+1], b[i+1:], nil
|
||||||
case '\n':
|
case '\n', '\r':
|
||||||
return nil, nil, newDecodeError(b[i:i+1], "literal strings cannot have new lines")
|
return nil, nil, newDecodeError(b[i:i+1], "literal strings cannot have new lines")
|
||||||
}
|
}
|
||||||
size := utf8ValidNext(b[i:])
|
size := utf8ValidNext(b[i:])
|
||||||
@@ -76,30 +76,42 @@ func scanMultilineLiteralString(b []byte) ([]byte, []byte, error) {
|
|||||||
// mll-char = %x09 / %x20-26 / %x28-7E / non-ascii
|
// mll-char = %x09 / %x20-26 / %x28-7E / non-ascii
|
||||||
// mll-quotes = 1*2apostrophe
|
// mll-quotes = 1*2apostrophe
|
||||||
for i := 3; i < len(b); {
|
for i := 3; i < len(b); {
|
||||||
if scanFollowsMultilineLiteralStringDelimiter(b[i:]) {
|
switch b[i] {
|
||||||
i += 3
|
case '\'':
|
||||||
|
if scanFollowsMultilineLiteralStringDelimiter(b[i:]) {
|
||||||
|
i += 3
|
||||||
|
|
||||||
// At that point we found 3 apostrophe, and i is the
|
// At that point we found 3 apostrophe, and i is the
|
||||||
// index of the byte after the third one. The scanner
|
// index of the byte after the third one. The scanner
|
||||||
// needs to be eager, because there can be an extra 2
|
// needs to be eager, because there can be an extra 2
|
||||||
// apostrophe that can be accepted at the end of the
|
// apostrophe that can be accepted at the end of the
|
||||||
// string.
|
// string.
|
||||||
|
|
||||||
|
if i >= len(b) || b[i] != '\'' {
|
||||||
|
return b[:i], b[i:], nil
|
||||||
|
}
|
||||||
|
i++
|
||||||
|
|
||||||
|
if i >= len(b) || b[i] != '\'' {
|
||||||
|
return b[:i], b[i:], nil
|
||||||
|
}
|
||||||
|
i++
|
||||||
|
|
||||||
|
if i < len(b) && b[i] == '\'' {
|
||||||
|
return nil, nil, newDecodeError(b[i-3:i+1], "''' not allowed in multiline literal string")
|
||||||
|
}
|
||||||
|
|
||||||
if i >= len(b) || b[i] != '\'' {
|
|
||||||
return b[:i], b[i:], nil
|
return b[:i], b[i:], nil
|
||||||
}
|
}
|
||||||
i++
|
case '\r':
|
||||||
|
if len(b) < i+2 {
|
||||||
if i >= len(b) || b[i] != '\'' {
|
return nil, nil, newDecodeError(b[len(b):], `need a \n after \r`)
|
||||||
return b[:i], b[i:], nil
|
|
||||||
}
|
}
|
||||||
i++
|
if b[i+1] != '\n' {
|
||||||
|
return nil, nil, newDecodeError(b[i:i+2], `need a \n after \r`)
|
||||||
if i < len(b) && b[i] == '\'' {
|
|
||||||
return nil, nil, newDecodeError(b[i-3:i+1], "''' not allowed in multiline literal string")
|
|
||||||
}
|
}
|
||||||
|
i += 2 // skip the \n
|
||||||
return b[:i], b[i:], nil
|
continue
|
||||||
}
|
}
|
||||||
size := utf8ValidNext(b[i:])
|
size := utf8ValidNext(b[i:])
|
||||||
if size == 0 {
|
if size == 0 {
|
||||||
@@ -242,6 +254,14 @@ func scanMultilineBasicString(b []byte) ([]byte, bool, []byte, error) {
|
|||||||
}
|
}
|
||||||
escaped = true
|
escaped = true
|
||||||
i++ // skip the next character
|
i++ // skip the next character
|
||||||
|
case '\r':
|
||||||
|
if len(b) < i+2 {
|
||||||
|
return nil, escaped, nil, newDecodeError(b[len(b):], `need a \n after \r`)
|
||||||
|
}
|
||||||
|
if b[i+1] != '\n' {
|
||||||
|
return nil, escaped, nil, newDecodeError(b[i:i+2], `need a \n after \r`)
|
||||||
|
}
|
||||||
|
i++ // skip the \n
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/pelletier/go-toml/v2"
|
"github.com/pelletier/go-toml/v2"
|
||||||
"github.com/pelletier/go-toml/v2/testsuite"
|
"github.com/pelletier/go-toml/v2/internal/testsuite"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
+126
-25
@@ -1,4 +1,4 @@
|
|||||||
// Generated by tomltestgen for toml-test ref master on 2021-11-08T22:33:24-05:00
|
// Generated by tomltestgen for toml-test ref master on 2021-12-31T17:10:15-05:00
|
||||||
package toml_test
|
package toml_test
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -70,6 +70,16 @@ func TestTOMLTest_Invalid_Bool_WrongCaseTrue(t *testing.T) {
|
|||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Control_BareNull(t *testing.T) {
|
||||||
|
input := "bare-null = \"some value\" \x00\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Control_CommentCr(t *testing.T) {
|
||||||
|
input := "comment-cr = \"Carriage return in comment\" # \ra=1\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Control_CommentDel(t *testing.T) {
|
func TestTOMLTest_Invalid_Control_CommentDel(t *testing.T) {
|
||||||
input := "comment-del = \"0x7f\" # \u007f\n"
|
input := "comment-del = \"0x7f\" # \u007f\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
@@ -175,33 +185,73 @@ func TestTOMLTest_Invalid_Control_StringUs(t *testing.T) {
|
|||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Datetime_ImpossibleDate(t *testing.T) {
|
func TestTOMLTest_Invalid_Datetime_HourOver(t *testing.T) {
|
||||||
input := "d = 2006-01-50T00:00:00Z\n"
|
input := "# time-hour = 2DIGIT ; 00-23\nd = 2006-01-01T24:00:00-00:00\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Datetime_MdayOver(t *testing.T) {
|
||||||
|
input := "# date-mday = 2DIGIT ; 01-28, 01-29, 01-30, 01-31 based on\n# ; month/year\nd = 2006-01-32T00:00:00-00:00\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Datetime_MdayUnder(t *testing.T) {
|
||||||
|
input := "# date-mday = 2DIGIT ; 01-28, 01-29, 01-30, 01-31 based on\n# ; month/year\nd = 2006-01-00T00:00:00-00:00\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Datetime_MinuteOver(t *testing.T) {
|
||||||
|
input := "# time-minute = 2DIGIT ; 00-59\nd = 2006-01-01T00:60:00-00:00\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Datetime_MonthOver(t *testing.T) {
|
||||||
|
input := "# date-month = 2DIGIT ; 01-12\nd = 2006-13-01T00:00:00-00:00\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Datetime_MonthUnder(t *testing.T) {
|
||||||
|
input := "# date-month = 2DIGIT ; 01-12\nd = 2007-00-01T00:00:00-00:00\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Datetime_NoLeadsWithMilli(t *testing.T) {
|
func TestTOMLTest_Invalid_Datetime_NoLeadsWithMilli(t *testing.T) {
|
||||||
input := "with-milli = 1987-07-5T17:45:00.12Z\n"
|
input := "# Day \"5\" instead of \"05\"; the leading zero is required.\nwith-milli = 1987-07-5T17:45:00.12Z\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Datetime_NoLeads(t *testing.T) {
|
func TestTOMLTest_Invalid_Datetime_NoLeads(t *testing.T) {
|
||||||
input := "no-leads = 1987-7-05T17:45:00Z\n"
|
input := "# Month \"7\" instead of \"07\"; the leading zero is required.\nno-leads = 1987-7-05T17:45:00Z\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Datetime_NoSecs(t *testing.T) {
|
func TestTOMLTest_Invalid_Datetime_NoSecs(t *testing.T) {
|
||||||
input := "no-secs = 1987-07-05T17:45Z\n"
|
input := "# No seconds in time.\nno-secs = 1987-07-05T17:45Z\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Datetime_NoT(t *testing.T) {
|
func TestTOMLTest_Invalid_Datetime_NoT(t *testing.T) {
|
||||||
input := "no-t = 1987-07-0517:45:00Z\n"
|
input := "# No \"t\" or \"T\" between the date and time.\nno-t = 1987-07-0517:45:00Z\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Datetime_SecondOver(t *testing.T) {
|
||||||
|
input := "# time-second = 2DIGIT ; 00-58, 00-59, 00-60 based on leap second\n# ; rules\nd = 2006-01-01T00:00:61-00:00\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Datetime_TimeNoLeads2(t *testing.T) {
|
||||||
|
input := "# Leading 0 is always required.\nd = 01:32:0\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Datetime_TimeNoLeads(t *testing.T) {
|
||||||
|
input := "# Leading 0 is always required.\nd = 1:32:00\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Datetime_TrailingT(t *testing.T) {
|
func TestTOMLTest_Invalid_Datetime_TrailingT(t *testing.T) {
|
||||||
input := "d = 2006-01-30T\n"
|
input := "# Date cannot end with trailing T\nd = 2006-01-30T\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -435,6 +485,11 @@ func TestTOMLTest_Invalid_InlineTable_NoComma(t *testing.T) {
|
|||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_InlineTable_Overwrite(t *testing.T) {
|
||||||
|
input := "a.b=0\n# Since table \"a\" is already defined, it can't be replaced by an inline table.\na={}\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_InlineTable_TrailingComma(t *testing.T) {
|
func TestTOMLTest_Invalid_InlineTable_TrailingComma(t *testing.T) {
|
||||||
input := "# A terminating comma (also called trailing comma) is not permitted after the\n# last key/value pair in an inline table\nabc = { abc = 123, }\n"
|
input := "# A terminating comma (also called trailing comma) is not permitted after the\n# last key/value pair in an inline table\nabc = { abc = 123, }\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
@@ -515,6 +570,11 @@ func TestTOMLTest_Invalid_Integer_LeadingZero2(t *testing.T) {
|
|||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Integer_LeadingZero3(t *testing.T) {
|
||||||
|
input := "leading-zero-3 = 0_0\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Integer_LeadingZeroSign1(t *testing.T) {
|
func TestTOMLTest_Invalid_Integer_LeadingZeroSign1(t *testing.T) {
|
||||||
input := "leading-zero-sign-1 = -01\n"
|
input := "leading-zero-sign-1 = -01\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
@@ -525,6 +585,11 @@ func TestTOMLTest_Invalid_Integer_LeadingZeroSign2(t *testing.T) {
|
|||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Integer_LeadingZeroSign3(t *testing.T) {
|
||||||
|
input := "leading-zero-sign-3 = +0_1\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Integer_NegativeBin(t *testing.T) {
|
func TestTOMLTest_Invalid_Integer_NegativeBin(t *testing.T) {
|
||||||
input := "negative-bin = -0b11010110\n"
|
input := "negative-bin = -0b11010110\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
@@ -730,11 +795,16 @@ func TestTOMLTest_Invalid_String_BadConcat(t *testing.T) {
|
|||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_String_BadEscape(t *testing.T) {
|
func TestTOMLTest_Invalid_String_BadEscape1(t *testing.T) {
|
||||||
input := "invalid-escape = \"This string has a bad \\a escape character.\"\n"
|
input := "invalid-escape = \"This string has a bad \\a escape character.\"\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_String_BadEscape2(t *testing.T) {
|
||||||
|
input := "invalid-escape = \"This string has a bad \\ escape character.\"\n\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_String_BadMultiline(t *testing.T) {
|
func TestTOMLTest_Invalid_String_BadMultiline(t *testing.T) {
|
||||||
input := "multi = \"first line\nsecond line\"\n"
|
input := "multi = \"first line\nsecond line\"\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
@@ -805,6 +875,21 @@ func TestTOMLTest_Invalid_String_MissingQuotes(t *testing.T) {
|
|||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_String_MultilineBadEscape1(t *testing.T) {
|
||||||
|
input := "k = \"\"\"t\\a\"\"\"\n\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_String_MultilineBadEscape2(t *testing.T) {
|
||||||
|
input := "# \\<Space> is not a valid escape.\nk = \"\"\"t\\ t\"\"\"\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_String_MultilineBadEscape3(t *testing.T) {
|
||||||
|
input := "# \\<Space> is not a valid escape.\nk = \"\"\"t\\ \"\"\"\n\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_String_MultilineEscapeSpace(t *testing.T) {
|
func TestTOMLTest_Invalid_String_MultilineEscapeSpace(t *testing.T) {
|
||||||
input := "a = \"\"\"\n foo \\ \\n\n bar\"\"\"\n"
|
input := "a = \"\"\"\n foo \\ \\n\n bar\"\"\"\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
@@ -845,6 +930,16 @@ func TestTOMLTest_Invalid_String_WrongClose(t *testing.T) {
|
|||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Table_AppendWithDottedKeys1(t *testing.T) {
|
||||||
|
input := "# First a.b.c defines a table: a.b.c = {z=9}\n#\n# Then we define a.b.c.t = \"str\" to add a str to the above table, making it:\n#\n# a.b.c = {z=9, t=\"...\"}\n#\n# While this makes sense, logically, it was decided this is not valid TOML as\n# it's too confusing/convoluted.\n# \n# See: https://github.com/toml-lang/toml/issues/846\n# https://github.com/toml-lang/toml/pull/859\n\n[a.b.c]\n z = 9\n\n[a]\n b.c.t = \"Using dotted keys to add to [a.b.c] after explicitly defining it above is not allowed\"\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Table_AppendWithDottedKeys2(t *testing.T) {
|
||||||
|
input := "# This is the same issue as in injection-1.toml, except that nests one level\n# deeper. See that file for a more complete description.\n\n[a.b.c.d]\n z = 9\n\n[a]\n b.c.d.k.t = \"Using dotted keys to add to [a.b.c.d] after explicitly defining it above is not allowed\"\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Table_ArrayEmpty(t *testing.T) {
|
func TestTOMLTest_Invalid_Table_ArrayEmpty(t *testing.T) {
|
||||||
input := "[[]]\nname = \"Born to Run\"\n"
|
input := "[[]]\nname = \"Born to Run\"\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
@@ -860,6 +955,16 @@ func TestTOMLTest_Invalid_Table_ArrayMissingBracket(t *testing.T) {
|
|||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Table_DuplicateKeyDottedTable(t *testing.T) {
|
||||||
|
input := "[fruit]\napple.color = \"red\"\n\n[fruit.apple] # INVALID\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Invalid_Table_DuplicateKeyDottedTable2(t *testing.T) {
|
||||||
|
input := "[fruit]\napple.taste.sweet = true\n\n[fruit.apple.taste] # INVALID\n"
|
||||||
|
testgenInvalid(t, input)
|
||||||
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Table_DuplicateKeyTable(t *testing.T) {
|
func TestTOMLTest_Invalid_Table_DuplicateKeyTable(t *testing.T) {
|
||||||
input := "[fruit]\ntype = \"apple\"\n\n[fruit.type]\napple = \"yes\"\n"
|
input := "[fruit]\ntype = \"apple\"\n\n[fruit.type]\napple = \"yes\"\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
@@ -895,16 +1000,6 @@ func TestTOMLTest_Invalid_Table_EqualsSign(t *testing.T) {
|
|||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Table_Injection1(t *testing.T) {
|
|
||||||
input := "[a.b.c]\n z = 9\n[a]\n b.c.t = \"Using dotted keys to add to [a.b.c] after explicitly defining it above is not allowed\"\n \n# see https://github.com/toml-lang/toml/issues/846\n"
|
|
||||||
testgenInvalid(t, input)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Table_Injection2(t *testing.T) {
|
|
||||||
input := "[a.b.c.d]\n z = 9\n[a]\n b.c.d.k.t = \"Using dotted keys to add to [a.b.c.d] after explicitly defining it above is not allowed\"\n \n# see https://github.com/toml-lang/toml/issues/846\n"
|
|
||||||
testgenInvalid(t, input)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestTOMLTest_Invalid_Table_Llbrace(t *testing.T) {
|
func TestTOMLTest_Invalid_Table_Llbrace(t *testing.T) {
|
||||||
input := "[ [table]]\n"
|
input := "[ [table]]\n"
|
||||||
testgenInvalid(t, input)
|
testgenInvalid(t, input)
|
||||||
@@ -1071,8 +1166,14 @@ func TestTOMLTest_Valid_Comment_AtEof2(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Valid_Comment_Everywhere(t *testing.T) {
|
func TestTOMLTest_Valid_Comment_Everywhere(t *testing.T) {
|
||||||
input := "# Top comment.\n # Top comment.\n# Top comment.\n\n# [no-extraneous-groups-please]\n\n[group] # Comment\nanswer = 42 # Comment\n# no-extraneous-keys-please = 999\n# Inbetween comment.\nmore = [ # Comment\n # What about multiple # comments?\n # Can you handle it?\n #\n # Evil.\n# Evil.\n 42, 42, # Comments within arrays are fun.\n # What about multiple # comments?\n # Can you handle it?\n #\n # Evil.\n# Evil.\n# ] Did I fool you?\n] # Hopefully not.\n\n# Make sure the space between the datetime and \"#\" isn't lexed.\nd = 1979-05-27T07:32:12-07:00 # c\n"
|
input := "# Top comment.\n # Top comment.\n# Top comment.\n\n# [no-extraneous-groups-please]\n\n[group] # Comment\nanswer = 42 # Comment\n# no-extraneous-keys-please = 999\n# Inbetween comment.\nmore = [ # Comment\n # What about multiple # comments?\n # Can you handle it?\n #\n # Evil.\n# Evil.\n 42, 42, # Comments within arrays are fun.\n # What about multiple # comments?\n # Can you handle it?\n #\n # Evil.\n# Evil.\n# ] Did I fool you?\n] # Hopefully not.\n\n# Make sure the space between the datetime and \"#\" isn't lexed.\ndt = 1979-05-27T07:32:12-07:00 # c\nd = 1979-05-27 # Comment\n"
|
||||||
jsonRef := "{\n \"group\": {\n \"answer\": {\n \"type\": \"integer\",\n \"value\": \"42\"\n },\n \"d\": {\n \"type\": \"datetime\",\n \"value\": \"1979-05-27T07:32:12-07:00\"\n },\n \"more\": [\n {\n \"type\": \"integer\",\n \"value\": \"42\"\n },\n {\n \"type\": \"integer\",\n \"value\": \"42\"\n }\n ]\n }\n}\n"
|
jsonRef := "{\n \"group\": {\n \"answer\": {\n \"type\": \"integer\",\n \"value\": \"42\"\n },\n \"dt\": {\n \"type\": \"datetime\",\n \"value\": \"1979-05-27T07:32:12-07:00\"\n },\n \"d\": {\n \"type\": \"date-local\",\n \"value\": \"1979-05-27\"\n },\n \"more\": [\n {\n \"type\": \"integer\",\n \"value\": \"42\"\n },\n {\n \"type\": \"integer\",\n \"value\": \"42\"\n }\n ]\n }\n}\n"
|
||||||
|
testgenValid(t, input, jsonRef)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTOMLTest_Valid_Comment_Noeol(t *testing.T) {
|
||||||
|
input := "# single comment without any eol characters"
|
||||||
|
jsonRef := "{}\n"
|
||||||
testgenValid(t, input, jsonRef)
|
testgenValid(t, input, jsonRef)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1107,8 +1208,8 @@ func TestTOMLTest_Valid_Datetime_Local(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Valid_Datetime_Milliseconds(t *testing.T) {
|
func TestTOMLTest_Valid_Datetime_Milliseconds(t *testing.T) {
|
||||||
input := "utc1 = 1987-07-05T17:45:56.123456Z\nutc2 = 1987-07-05T17:45:56.6Z\nwita1 = 1987-07-05T17:45:56.123456+08:00\nwita2 = 1987-07-05T17:45:56.6+08:00\n"
|
input := "utc1 = 1987-07-05T17:45:56.1234Z\nutc2 = 1987-07-05T17:45:56.6Z\nwita1 = 1987-07-05T17:45:56.1234+08:00\nwita2 = 1987-07-05T17:45:56.6+08:00\n"
|
||||||
jsonRef := "{\n \"utc1\": {\n \"type\": \"datetime\",\n \"value\": \"1987-07-05T17:45:56.123456Z\"\n },\n \"utc2\": {\n \"type\": \"datetime\",\n \"value\": \"1987-07-05T17:45:56.600000Z\"\n },\n \"wita1\": {\n \"type\": \"datetime\",\n \"value\": \"1987-07-05T17:45:56.123456+08:00\"\n },\n \"wita2\": {\n \"type\": \"datetime\",\n \"value\": \"1987-07-05T17:45:56.600000+08:00\"\n }\n}\n"
|
jsonRef := "{\n \"utc1\": {\n \"type\": \"datetime\",\n \"value\": \"1987-07-05T17:45:56.1234Z\"\n },\n \"utc2\": {\n \"type\": \"datetime\",\n \"value\": \"1987-07-05T17:45:56.6000Z\"\n },\n \"wita1\": {\n \"type\": \"datetime\",\n \"value\": \"1987-07-05T17:45:56.1234+08:00\"\n },\n \"wita2\": {\n \"type\": \"datetime\",\n \"value\": \"1987-07-05T17:45:56.6000+08:00\"\n }\n}\n"
|
||||||
testgenValid(t, input, jsonRef)
|
testgenValid(t, input, jsonRef)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1395,7 +1496,7 @@ func TestTOMLTest_Valid_String_MultilineQuotes(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Valid_String_Multiline(t *testing.T) {
|
func TestTOMLTest_Valid_String_Multiline(t *testing.T) {
|
||||||
input := "# NOTE: this file includes some literal tab characters.\n\nmultiline_empty_one = \"\"\"\"\"\"\nmultiline_empty_two = \"\"\"\n\"\"\"\nmultiline_empty_three = \"\"\"\\\n \"\"\"\nmultiline_empty_four = \"\"\"\\\n \\\n \\ \n \"\"\"\n\nequivalent_one = \"The quick brown fox jumps over the lazy dog.\"\nequivalent_two = \"\"\"\nThe quick brown \\\n\n\n fox jumps over \\\n the lazy dog.\"\"\"\n\nequivalent_three = \"\"\"\\\n The quick brown \\\n fox jumps over \\\n the lazy dog.\\\n \"\"\"\n\nwhitespace-after-bs = \"\"\"\\\n The quick brown \\\n fox jumps over \\ \n the lazy dog.\\\t\n \"\"\"\n\nno-space = \"\"\"a\\\n b\"\"\"\n\nkeep-ws-before = \"\"\"a \t\\\n b\"\"\"\n\nescape-bs-1 = \"\"\"a \\\\\nb\"\"\"\n\nescape-bs-2 = \"\"\"a \\\\\\\nb\"\"\"\n\nescape-bs-3 = \"\"\"a \\\\\\\\\n b\"\"\"\n"
|
input := "# NOTE: this file includes some literal tab characters.\n\nmultiline_empty_one = \"\"\"\"\"\"\n\n# A newline immediately following the opening delimiter will be trimmed.\nmultiline_empty_two = \"\"\"\n\"\"\"\n\n# \\ at the end of line trims newlines as well; note that last \\ is followed by\n# two spaces, which are ignored.\nmultiline_empty_three = \"\"\"\\\n \"\"\"\nmultiline_empty_four = \"\"\"\\\n \\\n \\ \n \"\"\"\n\nequivalent_one = \"The quick brown fox jumps over the lazy dog.\"\nequivalent_two = \"\"\"\nThe quick brown \\\n\n\n fox jumps over \\\n the lazy dog.\"\"\"\n\nequivalent_three = \"\"\"\\\n The quick brown \\\n fox jumps over \\\n the lazy dog.\\\n \"\"\"\n\nwhitespace-after-bs = \"\"\"\\\n The quick brown \\\n fox jumps over \\ \n the lazy dog.\\\t\n \"\"\"\n\nno-space = \"\"\"a\\\n b\"\"\"\n\n# Has tab character.\nkeep-ws-before = \"\"\"a \t\\\n b\"\"\"\n\nescape-bs-1 = \"\"\"a \\\\\nb\"\"\"\n\nescape-bs-2 = \"\"\"a \\\\\\\nb\"\"\"\n\nescape-bs-3 = \"\"\"a \\\\\\\\\n b\"\"\"\n"
|
||||||
jsonRef := "{\n \"equivalent_one\": {\n \"type\": \"string\",\n \"value\": \"The quick brown fox jumps over the lazy dog.\"\n },\n \"equivalent_three\": {\n \"type\": \"string\",\n \"value\": \"The quick brown fox jumps over the lazy dog.\"\n },\n \"equivalent_two\": {\n \"type\": \"string\",\n \"value\": \"The quick brown fox jumps over the lazy dog.\"\n },\n \"escape-bs-1\": {\n \"type\": \"string\",\n \"value\": \"a \\\\\\nb\"\n },\n \"escape-bs-2\": {\n \"type\": \"string\",\n \"value\": \"a \\\\b\"\n },\n \"escape-bs-3\": {\n \"type\": \"string\",\n \"value\": \"a \\\\\\\\\\n b\"\n },\n \"keep-ws-before\": {\n \"type\": \"string\",\n \"value\": \"a \\tb\"\n },\n \"multiline_empty_four\": {\n \"type\": \"string\",\n \"value\": \"\"\n },\n \"multiline_empty_one\": {\n \"type\": \"string\",\n \"value\": \"\"\n },\n \"multiline_empty_three\": {\n \"type\": \"string\",\n \"value\": \"\"\n },\n \"multiline_empty_two\": {\n \"type\": \"string\",\n \"value\": \"\"\n },\n \"no-space\": {\n \"type\": \"string\",\n \"value\": \"ab\"\n },\n \"whitespace-after-bs\": {\n \"type\": \"string\",\n \"value\": \"The quick brown fox jumps over the lazy dog.\"\n }\n}\n"
|
jsonRef := "{\n \"equivalent_one\": {\n \"type\": \"string\",\n \"value\": \"The quick brown fox jumps over the lazy dog.\"\n },\n \"equivalent_three\": {\n \"type\": \"string\",\n \"value\": \"The quick brown fox jumps over the lazy dog.\"\n },\n \"equivalent_two\": {\n \"type\": \"string\",\n \"value\": \"The quick brown fox jumps over the lazy dog.\"\n },\n \"escape-bs-1\": {\n \"type\": \"string\",\n \"value\": \"a \\\\\\nb\"\n },\n \"escape-bs-2\": {\n \"type\": \"string\",\n \"value\": \"a \\\\b\"\n },\n \"escape-bs-3\": {\n \"type\": \"string\",\n \"value\": \"a \\\\\\\\\\n b\"\n },\n \"keep-ws-before\": {\n \"type\": \"string\",\n \"value\": \"a \\tb\"\n },\n \"multiline_empty_four\": {\n \"type\": \"string\",\n \"value\": \"\"\n },\n \"multiline_empty_one\": {\n \"type\": \"string\",\n \"value\": \"\"\n },\n \"multiline_empty_three\": {\n \"type\": \"string\",\n \"value\": \"\"\n },\n \"multiline_empty_two\": {\n \"type\": \"string\",\n \"value\": \"\"\n },\n \"no-space\": {\n \"type\": \"string\",\n \"value\": \"ab\"\n },\n \"whitespace-after-bs\": {\n \"type\": \"string\",\n \"value\": \"The quick brown fox jumps over the lazy dog.\"\n }\n}\n"
|
||||||
testgenValid(t, input, jsonRef)
|
testgenValid(t, input, jsonRef)
|
||||||
}
|
}
|
||||||
@@ -1407,7 +1508,7 @@ func TestTOMLTest_Valid_String_Nl(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func TestTOMLTest_Valid_String_RawMultiline(t *testing.T) {
|
func TestTOMLTest_Valid_String_RawMultiline(t *testing.T) {
|
||||||
input := "oneline = '''This string has a ' quote character.'''\nfirstnl = '''\nThis string has a ' quote character.'''\nmultiline = '''\nThis string\nhas ' a quote character\nand more than\none newline\nin it.'''\n"
|
input := "# Single ' should be allowed.\noneline = '''This string has a ' quote character.'''\n\n# A newline immediately following the opening delimiter will be trimmed.\nfirstnl = '''\nThis string has a ' quote character.'''\n\n# All other whitespace and newline characters remain intact.\nmultiline = '''\nThis string\nhas ' a quote character\nand more than\none newline\nin it.'''\n"
|
||||||
jsonRef := "{\n \"firstnl\": {\n \"type\": \"string\",\n \"value\": \"This string has a ' quote character.\"\n },\n \"multiline\": {\n \"type\": \"string\",\n \"value\": \"This string\\nhas ' a quote character\\nand more than\\none newline\\nin it.\"\n },\n \"oneline\": {\n \"type\": \"string\",\n \"value\": \"This string has a ' quote character.\"\n }\n}\n"
|
jsonRef := "{\n \"firstnl\": {\n \"type\": \"string\",\n \"value\": \"This string has a ' quote character.\"\n },\n \"multiline\": {\n \"type\": \"string\",\n \"value\": \"This string\\nhas ' a quote character\\nand more than\\none newline\\nin it.\"\n },\n \"oneline\": {\n \"type\": \"string\",\n \"value\": \"This string has a ' quote character.\"\n }\n}\n"
|
||||||
testgenValid(t, input, jsonRef)
|
testgenValid(t, input, jsonRef)
|
||||||
}
|
}
|
||||||
|
|||||||
+74
-26
@@ -42,25 +42,27 @@ func NewDecoder(r io.Reader) *Decoder {
|
|||||||
return &Decoder{r: r}
|
return &Decoder{r: r}
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetStrict toggles decoding in stict mode.
|
// DisallowUnknownFields causes the Decoder to return an error when the
|
||||||
|
// destination is a struct and the input contains a key that does not match a
|
||||||
|
// non-ignored field.
|
||||||
//
|
//
|
||||||
// When the decoder is in strict mode, it will record fields from the document
|
// In that case, the Decoder returns a StrictMissingError that can be used to
|
||||||
// that could not be set on the target value. In that case, the decoder returns
|
// retrieve the individual errors as well as generate a human readable
|
||||||
// a StrictMissingError that can be used to retrieve the individual errors as
|
// description of the missing fields.
|
||||||
// well as generate a human readable description of the missing fields.
|
func (d *Decoder) DisallowUnknownFields() *Decoder {
|
||||||
func (d *Decoder) SetStrict(strict bool) *Decoder {
|
d.strict = true
|
||||||
d.strict = strict
|
|
||||||
return d
|
return d
|
||||||
}
|
}
|
||||||
|
|
||||||
// Decode the whole content of r into v.
|
// Decode the whole content of r into v.
|
||||||
//
|
//
|
||||||
// By default, values in the document that don't exist in the target Go value
|
// By default, values in the document that don't exist in the target Go value
|
||||||
// are ignored. See Decoder.SetStrict() to change this behavior.
|
// are ignored. See Decoder.DisallowUnknownFields() to change this behavior.
|
||||||
//
|
//
|
||||||
// When a TOML local date, time, or date-time is decoded into a time.Time, its
|
// 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*
|
// value is represented in time.Local timezone. Otherwise the approriate Local*
|
||||||
// structure is used.
|
// structure is used. For time values, precision up to the nanosecond is
|
||||||
|
// supported by truncating extra digits.
|
||||||
//
|
//
|
||||||
// Empty tables decoded in an interface{} create an empty initialized
|
// Empty tables decoded in an interface{} create an empty initialized
|
||||||
// map[string]interface{}.
|
// map[string]interface{}.
|
||||||
@@ -72,6 +74,11 @@ func (d *Decoder) SetStrict(strict bool) *Decoder {
|
|||||||
// bounds for the target type (which includes negative numbers when decoding
|
// bounds for the target type (which includes negative numbers when decoding
|
||||||
// into an unsigned int).
|
// into an unsigned int).
|
||||||
//
|
//
|
||||||
|
// If an error occurs while decoding the content of the document, this function
|
||||||
|
// returns a toml.DecodeError, providing context about the issue. When using
|
||||||
|
// strict mode and a field is missing, a `toml.StrictMissingError` is
|
||||||
|
// returned. In any other case, this function returns a standard Go error.
|
||||||
|
//
|
||||||
// Type mapping
|
// Type mapping
|
||||||
//
|
//
|
||||||
// List of supported TOML types and their associated accepted Go types:
|
// List of supported TOML types and their associated accepted Go types:
|
||||||
@@ -131,6 +138,23 @@ type decoder struct {
|
|||||||
|
|
||||||
// Strict mode
|
// Strict mode
|
||||||
strict strict
|
strict strict
|
||||||
|
|
||||||
|
// Current context for the error.
|
||||||
|
errorContext *errorContext
|
||||||
|
}
|
||||||
|
|
||||||
|
type errorContext struct {
|
||||||
|
Struct reflect.Type
|
||||||
|
Field []int
|
||||||
|
}
|
||||||
|
|
||||||
|
func (d *decoder) typeMismatchError(toml string, target reflect.Type) error {
|
||||||
|
if d.errorContext != nil && d.errorContext.Struct != nil {
|
||||||
|
ctx := d.errorContext
|
||||||
|
f := ctx.Struct.FieldByIndex(ctx.Field)
|
||||||
|
return fmt.Errorf("toml: cannot decode TOML %s into struct field %s.%s of type %s", toml, ctx.Struct, f.Name, f.Type)
|
||||||
|
}
|
||||||
|
return fmt.Errorf("toml: cannot decode TOML %s into a Go value of type %s", toml, target)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (d *decoder) expr() *ast.Node {
|
func (d *decoder) expr() *ast.Node {
|
||||||
@@ -345,7 +369,9 @@ func (d *decoder) handleArrayTableCollection(key ast.Iterator, v reflect.Value)
|
|||||||
if err != nil {
|
if err != nil {
|
||||||
return reflect.Value{}, err
|
return reflect.Value{}, err
|
||||||
}
|
}
|
||||||
v.Elem().Set(elem)
|
if elem.IsValid() {
|
||||||
|
v.Elem().Set(elem)
|
||||||
|
}
|
||||||
|
|
||||||
return v, nil
|
return v, nil
|
||||||
case reflect.Slice:
|
case reflect.Slice:
|
||||||
@@ -386,9 +412,10 @@ func (d *decoder) handleKeyPart(key ast.Iterator, v reflect.Value, nextFn handle
|
|||||||
elem = v.Elem()
|
elem = v.Elem()
|
||||||
return d.handleKeyPart(key, elem, nextFn, makeFn)
|
return d.handleKeyPart(key, elem, nextFn, makeFn)
|
||||||
case reflect.Map:
|
case reflect.Map:
|
||||||
|
vt := v.Type()
|
||||||
|
|
||||||
// Create the key for the map element. For now assume it's a string.
|
// Create the key for the map element. Convert to key type.
|
||||||
mk := reflect.ValueOf(string(key.Node().Data))
|
mk := reflect.ValueOf(string(key.Node().Data)).Convert(vt.Key())
|
||||||
|
|
||||||
// If the map does not exist, create it.
|
// If the map does not exist, create it.
|
||||||
if v.IsNil() {
|
if v.IsNil() {
|
||||||
@@ -405,7 +432,6 @@ func (d *decoder) handleKeyPart(key ast.Iterator, v reflect.Value, nextFn handle
|
|||||||
// map[string]interface{} or a []interface{} depending on whether
|
// map[string]interface{} or a []interface{} depending on whether
|
||||||
// this is the last part of the array table key.
|
// this is the last part of the array table key.
|
||||||
|
|
||||||
vt := v.Type()
|
|
||||||
t := vt.Elem()
|
t := vt.Elem()
|
||||||
if t.Kind() == reflect.Interface {
|
if t.Kind() == reflect.Interface {
|
||||||
mv = makeFn()
|
mv = makeFn()
|
||||||
@@ -442,12 +468,20 @@ func (d *decoder) handleKeyPart(key ast.Iterator, v reflect.Value, nextFn handle
|
|||||||
v.SetMapIndex(mk, mv)
|
v.SetMapIndex(mk, mv)
|
||||||
}
|
}
|
||||||
case reflect.Struct:
|
case reflect.Struct:
|
||||||
f, found := structField(v, string(key.Node().Data))
|
path, found := structFieldPath(v, string(key.Node().Data))
|
||||||
if !found {
|
if !found {
|
||||||
d.skipUntilTable = true
|
d.skipUntilTable = true
|
||||||
return reflect.Value{}, nil
|
return reflect.Value{}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if d.errorContext == nil {
|
||||||
|
d.errorContext = new(errorContext)
|
||||||
|
}
|
||||||
|
t := v.Type()
|
||||||
|
d.errorContext.Struct = t
|
||||||
|
d.errorContext.Field = path
|
||||||
|
|
||||||
|
f := v.FieldByIndex(path)
|
||||||
x, err := nextFn(key, f)
|
x, err := nextFn(key, f)
|
||||||
if err != nil || d.skipUntilTable {
|
if err != nil || d.skipUntilTable {
|
||||||
return reflect.Value{}, err
|
return reflect.Value{}, err
|
||||||
@@ -455,6 +489,8 @@ func (d *decoder) handleKeyPart(key ast.Iterator, v reflect.Value, nextFn handle
|
|||||||
if x.IsValid() {
|
if x.IsValid() {
|
||||||
f.Set(x)
|
f.Set(x)
|
||||||
}
|
}
|
||||||
|
d.errorContext.Field = nil
|
||||||
|
d.errorContext.Struct = nil
|
||||||
case reflect.Interface:
|
case reflect.Interface:
|
||||||
if v.Elem().IsValid() {
|
if v.Elem().IsValid() {
|
||||||
v = v.Elem()
|
v = v.Elem()
|
||||||
@@ -655,7 +691,7 @@ func (d *decoder) unmarshalArray(array *ast.Node, v reflect.Value) error {
|
|||||||
default:
|
default:
|
||||||
// TODO: use newDecodeError, but first the parser needs to fill
|
// TODO: use newDecodeError, but first the parser needs to fill
|
||||||
// array.Data.
|
// array.Data.
|
||||||
return fmt.Errorf("toml: cannot store array in Go type %s", v.Kind())
|
return d.typeMismatchError("array", v.Type())
|
||||||
}
|
}
|
||||||
|
|
||||||
elemType := v.Type().Elem()
|
elemType := v.Type().Elem()
|
||||||
@@ -902,7 +938,7 @@ func (d *decoder) unmarshalInteger(value *ast.Node, v reflect.Value) error {
|
|||||||
case reflect.Interface:
|
case reflect.Interface:
|
||||||
r = reflect.ValueOf(i)
|
r = reflect.ValueOf(i)
|
||||||
default:
|
default:
|
||||||
return fmt.Errorf("toml: cannot store TOML integer into a Go %s", v.Kind())
|
return d.typeMismatchError("integer", v.Type())
|
||||||
}
|
}
|
||||||
|
|
||||||
if !r.Type().AssignableTo(v.Type()) {
|
if !r.Type().AssignableTo(v.Type()) {
|
||||||
@@ -1005,12 +1041,20 @@ func (d *decoder) handleKeyValuePart(key ast.Iterator, value *ast.Node, v reflec
|
|||||||
v.SetMapIndex(mk, mv)
|
v.SetMapIndex(mk, mv)
|
||||||
}
|
}
|
||||||
case reflect.Struct:
|
case reflect.Struct:
|
||||||
f, found := structField(v, string(key.Node().Data))
|
path, found := structFieldPath(v, string(key.Node().Data))
|
||||||
if !found {
|
if !found {
|
||||||
d.skipUntilTable = true
|
d.skipUntilTable = true
|
||||||
break
|
break
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if d.errorContext == nil {
|
||||||
|
d.errorContext = new(errorContext)
|
||||||
|
}
|
||||||
|
t := v.Type()
|
||||||
|
d.errorContext.Struct = t
|
||||||
|
d.errorContext.Field = path
|
||||||
|
|
||||||
|
f := v.FieldByIndex(path)
|
||||||
x, err := d.handleKeyValueInner(key, value, f)
|
x, err := d.handleKeyValueInner(key, value, f)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return reflect.Value{}, err
|
return reflect.Value{}, err
|
||||||
@@ -1019,6 +1063,8 @@ func (d *decoder) handleKeyValuePart(key ast.Iterator, value *ast.Node, v reflec
|
|||||||
if x.IsValid() {
|
if x.IsValid() {
|
||||||
f.Set(x)
|
f.Set(x)
|
||||||
}
|
}
|
||||||
|
d.errorContext.Struct = nil
|
||||||
|
d.errorContext.Field = nil
|
||||||
case reflect.Interface:
|
case reflect.Interface:
|
||||||
v = v.Elem()
|
v = v.Elem()
|
||||||
|
|
||||||
@@ -1076,7 +1122,7 @@ type fieldPathsMap = map[string][]int
|
|||||||
|
|
||||||
var globalFieldPathsCache atomic.Value // map[danger.TypeID]fieldPathsMap
|
var globalFieldPathsCache atomic.Value // map[danger.TypeID]fieldPathsMap
|
||||||
|
|
||||||
func structField(v reflect.Value, name string) (reflect.Value, bool) {
|
func structFieldPath(v reflect.Value, name string) ([]int, bool) {
|
||||||
t := v.Type()
|
t := v.Type()
|
||||||
|
|
||||||
cache, _ := globalFieldPathsCache.Load().(map[danger.TypeID]fieldPathsMap)
|
cache, _ := globalFieldPathsCache.Load().(map[danger.TypeID]fieldPathsMap)
|
||||||
@@ -1103,12 +1149,7 @@ func structField(v reflect.Value, name string) (reflect.Value, bool) {
|
|||||||
if !ok {
|
if !ok {
|
||||||
path, ok = fieldPaths[strings.ToLower(name)]
|
path, ok = fieldPaths[strings.ToLower(name)]
|
||||||
}
|
}
|
||||||
|
return path, ok
|
||||||
if !ok {
|
|
||||||
return reflect.Value{}, false
|
|
||||||
}
|
|
||||||
|
|
||||||
return v.FieldByIndex(path), true
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func forEachField(t reflect.Type, path []int, do func(name string, path []int)) {
|
func forEachField(t reflect.Type, path []int, do func(name string, path []int)) {
|
||||||
@@ -1129,8 +1170,15 @@ func forEachField(t reflect.Type, path []int, do func(name string, path []int))
|
|||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
name, ok := f.Tag.Lookup("toml")
|
name := f.Tag.Get("toml")
|
||||||
if !ok {
|
if name == "-" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if i := strings.IndexByte(name, ','); i >= 0 {
|
||||||
|
name = name[:i]
|
||||||
|
}
|
||||||
|
if name == "" {
|
||||||
name = f.Name
|
name = f.Name
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+270
-18
@@ -16,7 +16,7 @@ import (
|
|||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
)
|
)
|
||||||
|
|
||||||
func ExampleDecoder_SetStrict() {
|
func ExampleDecoder_DisallowUnknownFields() {
|
||||||
type S struct {
|
type S struct {
|
||||||
Key1 string
|
Key1 string
|
||||||
Key3 string
|
Key3 string
|
||||||
@@ -28,7 +28,7 @@ key3 = "value3"
|
|||||||
`
|
`
|
||||||
r := strings.NewReader(doc)
|
r := strings.NewReader(doc)
|
||||||
d := toml.NewDecoder(r)
|
d := toml.NewDecoder(r)
|
||||||
d.SetStrict(true)
|
d.DisallowUnknownFields()
|
||||||
s := S{}
|
s := S{}
|
||||||
err := d.Decode(&s)
|
err := d.Decode(&s)
|
||||||
|
|
||||||
@@ -279,6 +279,11 @@ func TestUnmarshal_Floats(t *testing.T) {
|
|||||||
input: `1.0_e2`,
|
input: `1.0_e2`,
|
||||||
err: true,
|
err: true,
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
desc: "leading zero in positive float",
|
||||||
|
input: `+0_0.0`,
|
||||||
|
err: true,
|
||||||
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
type doc struct {
|
type doc struct {
|
||||||
@@ -571,7 +576,7 @@ func TestUnmarshal(t *testing.T) {
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
desc: "multiline basic string with windows newline",
|
desc: "multiline basic string with windows newline",
|
||||||
input: "A = \"\"\"\r\nTest\"\"\"",
|
input: "A = \"\"\"\r\nTe\r\nst\"\"\"",
|
||||||
gen: func() test {
|
gen: func() test {
|
||||||
type doc struct {
|
type doc struct {
|
||||||
A string
|
A string
|
||||||
@@ -579,7 +584,7 @@ func TestUnmarshal(t *testing.T) {
|
|||||||
|
|
||||||
return test{
|
return test{
|
||||||
target: &doc{},
|
target: &doc{},
|
||||||
expected: &doc{A: "Test"},
|
expected: &doc{A: "Te\r\nst"},
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@@ -664,6 +669,36 @@ func TestUnmarshal(t *testing.T) {
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
desc: "long string array into []string",
|
||||||
|
input: `A = ["0","1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17"]`,
|
||||||
|
gen: func() test {
|
||||||
|
type doc struct {
|
||||||
|
A []string
|
||||||
|
}
|
||||||
|
|
||||||
|
return test{
|
||||||
|
target: &doc{},
|
||||||
|
expected: &doc{A: []string{"0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17"}},
|
||||||
|
}
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "long string array into []interface{}",
|
||||||
|
input: `A = ["0","1","2","3","4","5","6","7","8","9","10","11","12","13","14",
|
||||||
|
"15","16","17"]`,
|
||||||
|
gen: func() test {
|
||||||
|
type doc struct {
|
||||||
|
A []interface{}
|
||||||
|
}
|
||||||
|
|
||||||
|
return test{
|
||||||
|
target: &doc{},
|
||||||
|
expected: &doc{A: []interface{}{"0", "1", "2", "3", "4", "5", "6",
|
||||||
|
"7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17"}},
|
||||||
|
}
|
||||||
|
},
|
||||||
|
},
|
||||||
{
|
{
|
||||||
desc: "standard table",
|
desc: "standard table",
|
||||||
input: `[A]
|
input: `[A]
|
||||||
@@ -1760,6 +1795,20 @@ func TestUnmarshalOverflows(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestUnmarshalErrors(t *testing.T) {
|
||||||
|
type mystruct struct {
|
||||||
|
Bar string
|
||||||
|
}
|
||||||
|
|
||||||
|
data := `bar = 42`
|
||||||
|
|
||||||
|
s := mystruct{}
|
||||||
|
err := toml.Unmarshal([]byte(data), &s)
|
||||||
|
require.Error(t, err)
|
||||||
|
|
||||||
|
require.Equal(t, "toml: cannot decode TOML integer into struct field toml_test.mystruct.Bar of type string", err.Error())
|
||||||
|
}
|
||||||
|
|
||||||
func TestUnmarshalInvalidTarget(t *testing.T) {
|
func TestUnmarshalInvalidTarget(t *testing.T) {
|
||||||
x := "foo"
|
x := "foo"
|
||||||
err := toml.Unmarshal([]byte{}, x)
|
err := toml.Unmarshal([]byte{}, x)
|
||||||
@@ -1857,7 +1906,7 @@ bar = 42
|
|||||||
t.Run("strict", func(t *testing.T) {
|
t.Run("strict", func(t *testing.T) {
|
||||||
r := strings.NewReader(e.input)
|
r := strings.NewReader(e.input)
|
||||||
d := toml.NewDecoder(r)
|
d := toml.NewDecoder(r)
|
||||||
d.SetStrict(true)
|
d.DisallowUnknownFields()
|
||||||
x := e.target
|
x := e.target
|
||||||
if x == nil {
|
if x == nil {
|
||||||
x = &struct{}{}
|
x = &struct{}{}
|
||||||
@@ -1875,7 +1924,6 @@ bar = 42
|
|||||||
t.Run("default", func(t *testing.T) {
|
t.Run("default", func(t *testing.T) {
|
||||||
r := strings.NewReader(e.input)
|
r := strings.NewReader(e.input)
|
||||||
d := toml.NewDecoder(r)
|
d := toml.NewDecoder(r)
|
||||||
d.SetStrict(false)
|
|
||||||
x := e.target
|
x := e.target
|
||||||
if x == nil {
|
if x == nil {
|
||||||
x = &struct{}{}
|
x = &struct{}{}
|
||||||
@@ -2085,7 +2133,7 @@ xz_hash = "1a48f723fea1f17d786ce6eadd9d00914d38062d28fd9c455ed3c3801905b388"
|
|||||||
|
|
||||||
expected := doc{
|
expected := doc{
|
||||||
Pkg: map[string]pkg{
|
Pkg: map[string]pkg{
|
||||||
"cargo": pkg{
|
"cargo": {
|
||||||
Target: map[string]target{
|
Target: map[string]target{
|
||||||
"aarch64-apple-darwin": {
|
"aarch64-apple-darwin": {
|
||||||
XZ_URL: "https://static.rust-lang.org/dist/2021-07-29/cargo-1.54.0-aarch64-apple-darwin.tar.xz",
|
XZ_URL: "https://static.rust-lang.org/dist/2021-07-29/cargo-1.54.0-aarch64-apple-darwin.tar.xz",
|
||||||
@@ -2190,7 +2238,119 @@ func TestIssue666(t *testing.T) {
|
|||||||
require.Error(t, err)
|
require.Error(t, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
//nolint:funlen
|
func TestIssue677(t *testing.T) {
|
||||||
|
doc := `
|
||||||
|
[Build]
|
||||||
|
Name = "publication build"
|
||||||
|
|
||||||
|
[[Build.Dependencies]]
|
||||||
|
Name = "command"
|
||||||
|
Program = "hugo"
|
||||||
|
`
|
||||||
|
|
||||||
|
type _tomlJob struct {
|
||||||
|
Dependencies []map[string]interface{}
|
||||||
|
}
|
||||||
|
|
||||||
|
type tomlParser struct {
|
||||||
|
Build *_tomlJob
|
||||||
|
}
|
||||||
|
|
||||||
|
p := tomlParser{}
|
||||||
|
|
||||||
|
err := toml.Unmarshal([]byte(doc), &p)
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
expected := tomlParser{
|
||||||
|
Build: &_tomlJob{
|
||||||
|
Dependencies: []map[string]interface{}{
|
||||||
|
{
|
||||||
|
"Name": "command",
|
||||||
|
"Program": "hugo",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
require.Equal(t, expected, p)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIssue701(t *testing.T) {
|
||||||
|
// Expected behavior:
|
||||||
|
// Return an error since a cannot be modified. From the TOML spec:
|
||||||
|
//
|
||||||
|
// > Inline tables are fully self-contained and define all
|
||||||
|
// keys and sub-tables within them. Keys and sub-tables cannot
|
||||||
|
// be added outside the braces.
|
||||||
|
|
||||||
|
docs := []string{
|
||||||
|
`
|
||||||
|
a={}
|
||||||
|
[a.b]
|
||||||
|
z=0
|
||||||
|
`,
|
||||||
|
`
|
||||||
|
a={}
|
||||||
|
[[a.b]]
|
||||||
|
z=0
|
||||||
|
`,
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, doc := range docs {
|
||||||
|
var v interface{}
|
||||||
|
err := toml.Unmarshal([]byte(doc), &v)
|
||||||
|
assert.Error(t, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIssue703(t *testing.T) {
|
||||||
|
var v interface{}
|
||||||
|
err := toml.Unmarshal([]byte("[a]\nx.y=0\n[a.x]"), &v)
|
||||||
|
require.Error(t, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIssue708(t *testing.T) {
|
||||||
|
v := map[string]string{}
|
||||||
|
err := toml.Unmarshal([]byte("0=\"\"\"\\\r\n\"\"\""), &v)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Equal(t, map[string]string{"0": ""}, v)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIssue710(t *testing.T) {
|
||||||
|
v := map[string]toml.LocalTime{}
|
||||||
|
err := toml.Unmarshal([]byte(`0=00:00:00.0000000000`), &v)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Equal(t, map[string]toml.LocalTime{"0": {Precision: 9}}, v)
|
||||||
|
v1 := map[string]toml.LocalTime{}
|
||||||
|
err = toml.Unmarshal([]byte(`0=00:00:00.0000000001`), &v1)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Equal(t, map[string]toml.LocalTime{"0": {Precision: 9}}, v1)
|
||||||
|
v2 := map[string]toml.LocalTime{}
|
||||||
|
err = toml.Unmarshal([]byte(`0=00:00:00.1111111119`), &v2)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Equal(t, map[string]toml.LocalTime{"0": {Nanosecond: 111111111, Precision: 9}}, v2)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIssue715(t *testing.T) {
|
||||||
|
var v interface{}
|
||||||
|
err := toml.Unmarshal([]byte("0=+"), &v)
|
||||||
|
require.Error(t, err)
|
||||||
|
|
||||||
|
err = toml.Unmarshal([]byte("0=-"), &v)
|
||||||
|
require.Error(t, err)
|
||||||
|
|
||||||
|
err = toml.Unmarshal([]byte("0=+A"), &v)
|
||||||
|
require.Error(t, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIssue714(t *testing.T) {
|
||||||
|
var v interface{}
|
||||||
|
err := toml.Unmarshal([]byte("0."), &v)
|
||||||
|
require.Error(t, err)
|
||||||
|
|
||||||
|
err = toml.Unmarshal([]byte("0={0=0,"), &v)
|
||||||
|
require.Error(t, err)
|
||||||
|
}
|
||||||
|
|
||||||
func TestUnmarshalDecodeErrors(t *testing.T) {
|
func TestUnmarshalDecodeErrors(t *testing.T) {
|
||||||
examples := []struct {
|
examples := []struct {
|
||||||
desc string
|
desc string
|
||||||
@@ -2205,18 +2365,10 @@ func TestUnmarshalDecodeErrors(t *testing.T) {
|
|||||||
desc: "local time with fractional",
|
desc: "local time with fractional",
|
||||||
data: `a = 11:22:33.x`,
|
data: `a = 11:22:33.x`,
|
||||||
},
|
},
|
||||||
{
|
|
||||||
desc: "local time frac precision too large",
|
|
||||||
data: `a = 2021-05-09T11:22:33.99999999999`,
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
desc: "wrong time offset separator",
|
desc: "wrong time offset separator",
|
||||||
data: `a = 1979-05-27T00:32:00.-07:00`,
|
data: `a = 1979-05-27T00:32:00.-07:00`,
|
||||||
},
|
},
|
||||||
{
|
|
||||||
desc: "missing fractional with tz",
|
|
||||||
data: `a = 2021-05-09T11:22:33.99999999999`,
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
desc: "wrong time offset separator",
|
desc: "wrong time offset separator",
|
||||||
data: `a = 1979-05-27T00:32:00Z07:00`,
|
data: `a = 1979-05-27T00:32:00Z07:00`,
|
||||||
@@ -2226,9 +2378,25 @@ func TestUnmarshalDecodeErrors(t *testing.T) {
|
|||||||
data: `flt8 = 224_617.445_991__228`,
|
data: `flt8 = 224_617.445_991__228`,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
desc: "float with double _",
|
desc: "float with double .",
|
||||||
data: `flt8 = 1..2`,
|
data: `flt8 = 1..2`,
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
desc: "number with plus sign and leading underscore",
|
||||||
|
data: `a = +_0`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "number with negative sign and leading underscore",
|
||||||
|
data: `a = -_0`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "exponent with plus sign and leading underscore",
|
||||||
|
data: `a = 0e+_0`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: "exponent with negative sign and leading underscore",
|
||||||
|
data: `a = 0e-_0`,
|
||||||
|
},
|
||||||
{
|
{
|
||||||
desc: "int with wrong base",
|
desc: "int with wrong base",
|
||||||
data: `a = 0f2`,
|
data: `a = 0f2`,
|
||||||
@@ -2336,7 +2504,7 @@ world'`,
|
|||||||
{
|
{
|
||||||
desc: "invalid seconds value",
|
desc: "invalid seconds value",
|
||||||
data: `a=1979-05-27T12:45:99`,
|
data: `a=1979-05-27T12:45:99`,
|
||||||
msg: `seconds cannot be greater 59`,
|
msg: `seconds cannot be greater 60`,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
desc: `binary with invalid digit`,
|
desc: `binary with invalid digit`,
|
||||||
@@ -2540,14 +2708,70 @@ world'`,
|
|||||||
desc: `invalid month`,
|
desc: `invalid month`,
|
||||||
data: `a=2021-0--29`,
|
data: `a=2021-0--29`,
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
desc: `zero is an invalid day`,
|
||||||
|
data: `a=2021-11-00`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: `zero is an invalid month`,
|
||||||
|
data: `a=2021-00-11`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: `invalid number of seconds digits with trailing digit`,
|
||||||
|
data: `a=0000-01-01 00:00:000000Z3`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: `invalid zone offset hours`,
|
||||||
|
data: `a=0000-01-01 00:00:00+24:00`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: `invalid zone offset minutes`,
|
||||||
|
data: `a=0000-01-01 00:00:00+00:60`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: `invalid character in zone offset hours`,
|
||||||
|
data: `a=0000-01-01 00:00:00+0Z:00`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: `invalid character in zone offset minutes`,
|
||||||
|
data: `a=0000-01-01 00:00:00+00:0Z`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: `invalid number of seconds`,
|
||||||
|
data: `a=0000-01-01 00:00:00+27000`,
|
||||||
|
},
|
||||||
{
|
{
|
||||||
desc: `carriage return inside basic key`,
|
desc: `carriage return inside basic key`,
|
||||||
data: "\"\r\"=42",
|
data: "\"\r\"=42",
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
desc: `carriage return inside literal key`,
|
||||||
|
data: "'\r'=42",
|
||||||
|
},
|
||||||
{
|
{
|
||||||
desc: `carriage return inside basic string`,
|
desc: `carriage return inside basic string`,
|
||||||
data: "A = \"\r\"",
|
data: "A = \"\r\"",
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
desc: `carriage return inside basic multiline string`,
|
||||||
|
data: "a=\"\"\"\r\"\"\"",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: `carriage return at the trail of basic multiline string`,
|
||||||
|
data: "a=\"\"\"\r",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: `carriage return inside literal string`,
|
||||||
|
data: "A = '\r'",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: `carriage return inside multiline literal string`,
|
||||||
|
data: "a='''\r'''",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
desc: `carriage return at trail of multiline literal string`,
|
||||||
|
data: "a='''\r",
|
||||||
|
},
|
||||||
{
|
{
|
||||||
desc: `carriage return in comment`,
|
desc: `carriage return in comment`,
|
||||||
data: "# this is a test\ra=1",
|
data: "# this is a test\ra=1",
|
||||||
@@ -2578,6 +2802,34 @@ world'`,
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestUnmarshalTags(t *testing.T) {
|
||||||
|
type doc struct {
|
||||||
|
Dash string `toml:"-,"`
|
||||||
|
Ignore string `toml:"-"`
|
||||||
|
A string `toml:"hello"`
|
||||||
|
B string `toml:"comma,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
data := `
|
||||||
|
'-' = "dash"
|
||||||
|
Ignore = 'me'
|
||||||
|
hello = 'content'
|
||||||
|
comma = 'ok'
|
||||||
|
`
|
||||||
|
|
||||||
|
d := doc{}
|
||||||
|
expected := doc{
|
||||||
|
Dash: "dash",
|
||||||
|
Ignore: "",
|
||||||
|
A: "content",
|
||||||
|
B: "ok",
|
||||||
|
}
|
||||||
|
|
||||||
|
err := toml.Unmarshal([]byte(data), &d)
|
||||||
|
require.NoError(t, err)
|
||||||
|
require.Equal(t, expected, d)
|
||||||
|
}
|
||||||
|
|
||||||
func TestASCIIControlCharacters(t *testing.T) {
|
func TestASCIIControlCharacters(t *testing.T) {
|
||||||
invalidCharacters := []byte{0x7F}
|
invalidCharacters := []byte{0x7F}
|
||||||
for c := byte(0x0); c <= 0x08; c++ {
|
for c := byte(0x0); c <= 0x08; c++ {
|
||||||
|
|||||||
Reference in New Issue
Block a user