feat: ffhujson

Signed-off-by: jolheiser <john.olheiser@gmail.com>

LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ff_map.go

@@ -0,0 +1,64 @@
+// This is taken from https://github.com/peterbourgon/ff/blob/e267c41b1d149b5151fb637d65f53b6e833448fd/internal/traverse_map.go
+package ffhujson
+
+import (
+	"encoding/json"
+	"fmt"
+	"strconv"
+)
+
+// traverseMap recursively walks the given map, calling set for each value. If the
+// value is a slice, set is called for each element of the slice. The keys of
+// nested maps are joined with the given delimiter.
+func traverseMap(m map[string]any, delimiter string, set func(name, value string) error) error {
+	return traverse("", m, delimiter, set)
+}
+
+func traverse(key string, val any, delimiter string, set func(name, value string) error) error {
+	switch v := val.(type) {
+	case string:
+		return set(key, v)
+	case json.Number:
+		return set(key, v.String())
+	case uint64:
+		return set(key, strconv.FormatUint(v, 10))
+	case int:
+		return set(key, strconv.Itoa(v))
+	case int64:
+		return set(key, strconv.FormatInt(v, 10))
+	case float64:
+		return set(key, strconv.FormatFloat(v, 'g', -1, 64))
+	case bool:
+		return set(key, strconv.FormatBool(v))
+	case nil:
+		return set(key, "")
+	case []any:
+		for _, v := range v {
+			if err := traverse(key, v, delimiter, set); err != nil {
+				return err
+			}
+		}
+	case map[string]any:
+		for k, v := range v {
+			if key != "" {
+				k = key + delimiter + k
+			}
+			if err := traverse(k, v, delimiter, set); err != nil {
+				return err
+			}
+		}
+	case map[any]any:
+		for k, v := range v {
+			ks := fmt.Sprint(k)
+			if key != "" {
+				ks = key + delimiter + ks
+			}
+			if err := traverse(ks, v, delimiter, set); err != nil {
+				return err
+			}
+		}
+	default:
+		return fmt.Errorf("couldn't convert %q (type %T) to string", val, val)
+	}
+	return nil
+}

ffhujson.go

@@ -0,0 +1,71 @@
+package ffhujson
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"io"
+
+	"github.com/tailscale/hujson"
+)
+
+// Parser is a helper function that uses a default ParseConfig.
+func Parser(r io.Reader, set func(name, value string) error) error {
+	return (&ParseConfig{}).Parse(r, set)
+}
+
+// ParseConfig collects parameters for the  config file parser.
+type ParseConfig struct {
+	// Delimiter is used when concatenating nested node keys into a flag name.
+	// The default delimiter is ".".
+	Delimiter string
+}
+
+// Parse a  document from the provided io.Reader, using the provided set
+// function to set flag values. Flag names are derived from the node names and
+// their key/value pairs.
+func (pc *ParseConfig) Parse(r io.Reader, set func(name, value string) error) error {
+	if pc.Delimiter == "" {
+		pc.Delimiter = "."
+	}
+
+	data, err := io.ReadAll(r)
+	if err != nil {
+		return err
+	}
+
+	data, err = hujson.Standardize(data)
+	if err != nil {
+		return err
+	}
+
+	d := json.NewDecoder(bytes.NewBuffer(data))
+	d.UseNumber() // required for stringifying values
+
+	var m map[string]interface{}
+	if err := d.Decode(&m); err != nil {
+		return ParseError{Inner: err}
+	}
+
+	if err := traverseMap(m, pc.Delimiter, set); err != nil {
+		return ParseError{Inner: err}
+	}
+
+	return nil
+}
+
+// ParseError wraps all errors originating from the Parser.
+type ParseError struct {
+	Inner error
+}
+
+// Error implenents the error interface.
+func (e ParseError) Error() string {
+	return fmt.Sprintf("error parsing  config: %v", e.Inner)
+}
+
+// Unwrap implements the errors.Wrapper interface, allowing errors.Is and
+// errors.As to work with ParseErrors.
+func (e ParseError) Unwrap() error {
+	return e.Inner
+}

ffhujson_test.go

@@ -0,0 +1,56 @@
+package ffhujson_test
+
+import (
+	"io"
+	"testing"
+	"time"
+
+	"github.com/peterbourgon/ff/v3"
+	"github.com/peterbourgon/ff/v3/fftest"
+	"go.jolheiser.com/ffhujson"
+)
+
+func TestJSONParser(t *testing.T) {
+	t.Parallel()
+
+	for _, testcase := range []struct {
+		name string
+		args []string
+		file string
+		want fftest.Vars
+	}{
+		{
+			name: "empty input",
+			args: []string{},
+			file: "testdata/empty.json",
+			want: fftest.Vars{WantParseErrorIs: io.ErrUnexpectedEOF},
+		},
+		{
+			name: "basic KV pairs",
+			args: []string{},
+			file: "testdata/basic.json",
+			want: fftest.Vars{S: "s", I: 10, B: true, D: 5 * time.Second},
+		},
+		{
+			name: "value arrays",
+			args: []string{},
+			file: "testdata/value_arrays.json",
+			want: fftest.Vars{S: "bb", I: 12, B: true, D: 5 * time.Second, X: []string{"a", "B", "👍"}},
+		},
+		{
+			name: "bad JSON file",
+			args: []string{},
+			file: "testdata/bad.json",
+			want: fftest.Vars{WantParseErrorIs: io.ErrUnexpectedEOF},
+		},
+	} {
+		t.Run(testcase.name, func(t *testing.T) {
+			fs, vars := fftest.Pair()
+			vars.ParseError = ff.Parse(fs, testcase.args,
+				ff.WithConfigFile(testcase.file),
+				ff.WithConfigFileParser(ffhujson.Parser),
+			)
+			fftest.Compare(t, &testcase.want, vars)
+		})
+	}
+}

go.mod

@@ -0,0 +1,8 @@
+module go.jolheiser.com/ffhujson
+
+go 1.22.3
+
+require (
+	github.com/peterbourgon/ff/v3 v3.4.0
+	github.com/tailscale/hujson v0.0.0-20221223112325-20486734a56a
+)

go.sum

@@ -0,0 +1,6 @@
+github.com/google/go-cmp v0.5.8 h1:e6P7q2lk1O+qJJb4BtCQXlK8vWEO8V1ZeuEdJNOqZyg=
+github.com/google/go-cmp v0.5.8/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/peterbourgon/ff/v3 v3.4.0 h1:QBvM/rizZM1cB0p0lGMdmR7HxZeI/ZrBWB4DqLkMUBc=
+github.com/peterbourgon/ff/v3 v3.4.0/go.mod h1:zjJVUhx+twciwfDl0zBcFzl4dW8axCRyXE/eKY9RztQ=
+github.com/tailscale/hujson v0.0.0-20221223112325-20486734a56a h1:SJy1Pu0eH1C29XwJucQo73FrleVK6t4kYz4NVhp34Yw=
+github.com/tailscale/hujson v0.0.0-20221223112325-20486734a56a/go.mod h1:DFSS3NAGHthKo1gTlmEcSBiZrRJXi28rLNd/1udP1c8=

testdata/bad.json

@@ -0,0 +1 @@
+{

testdata/basic.json

@@ -0,0 +1,6 @@
+{
+    "s": "s",
+    "i": 10,
+    "b": true,
+    "d": "5s"
+}

testdata/value_arrays.json

@@ -0,0 +1,7 @@
+{
+    "s": ["a", "bb"],
+    "i":["10","11","12"],
+    "b": [ false, true ],
+    "d": ["10m", "5s"],
+    "x": ["a" , "B", "👍"]
+}