Merge pull request #6 from urfave/cli-v3-integration

Integrate with urfave/cli/v3 APIs

.github/workflows/main.yml

@@ -10,11 +10,13 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        go: [1.18.x, 1.19.x]
+        go: [1.18.x, 1.19.x, 1.20.x]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/setup-go@v3
+      - uses: actions/setup-go@v4
         with:
           go-version: ${{ matrix.go }}
       - uses: actions/checkout@v3
-      - run: go test -v ./...
+        with:
+          fetch-depth: 0
+      - run: make

.gitignore

@@ -0,0 +1,10 @@
+*.coverprofile
+*.exe
+*.orig
+.*envrc
+.envrc
+.idea
+/.local/
+/site/
+coverage.txt
+vendor

.testdata/alt-config.json

@@ -0,0 +1,6 @@
+{
+  "greet": {
+    "name": "Berry",
+    "enthusiasm": "eleven"
+  }
+}

.testdata/alt-config.toml

@@ -0,0 +1,3 @@
+[greet]
+name = "Berry"
+enthusiasm = "eleven"

.testdata/alt-config.yaml

@@ -0,0 +1,3 @@
+greet:
+  name: Berry
+  enthusiasm: eleven

.testdata/config.json

@@ -0,0 +1,5 @@
+{
+  "greet": {
+	"enthusiasm": 9001
+  }
+}

.testdata/config.toml

@@ -0,0 +1,2 @@
+[greet]
+enthusiasm = 9001

.testdata/config.yaml

@@ -0,0 +1,2 @@
+greet:
+  enthusiasm: 9001

.testdata/test_alt_config.json

@@ -0,0 +1,8 @@
+{
+  "water_fountain": {
+    "water": true
+  },
+  "phone_booth": {
+    "phone": false
+  }
+}

.testdata/test_alt_config.toml

@@ -0,0 +1,5 @@
+[water_fountain]
+water = true
+
+[phone_booth]
+phone = false

.testdata/test_alt_config.yaml

@@ -0,0 +1,4 @@
+water_fountain:
+  water: true
+phone_booth:
+  phone: false

.testdata/test_config.json

@@ -0,0 +1,8 @@
+{
+  "water_fountain": {
+    "water": false
+  },
+  "woodstock": {
+    "wood": false
+  }
+}

.testdata/test_config.toml

@@ -0,0 +1,5 @@
+[water_fountain]
+water = false
+
+[woodstock]
+wood = false

.testdata/test_config.yaml

@@ -0,0 +1,4 @@
+water_fountain:
+  water: false
+woodstock:
+  wood: false

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 urfave contributors
+Copyright (c) 2023 urfave contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -0,0 +1,14 @@
+.PHONY: all
+all: vet test show-cover
+
+.PHONY: vet
+vet:
+	go vet -v ./...
+
+.PHONY: test
+test:
+	go test -v -cover -coverprofile=coverage.txt ./...
+
+.PHONY: show-cover
+show-cover:
+	go tool cover -func=coverage.txt

README.md

@@ -1,3 +1,11 @@
-# cli-altsrc
+# Welcome to urfave/cli-altsrc/v3
 
-Configuration source integration library for urfave/cli
+[![Run Tests](https://github.com/urfave/cli-altsrc/actions/workflows/main.yml/badge.svg)](https://github.com/urfave/cli-altsrc/actions/workflows/main.yml)
+[![Go Reference](https://pkg.go.dev/badge/github.com/urfave/cli-altsrc/v3.svg)](https://pkg.go.dev/github.com/urfave/cli-altsrc/v3)
+[![Go Report Card](https://goreportcard.com/badge/github.com/urfave/cli-altsrc/v3)](https://goreportcard.com/report/github.com/urfave/cli-altsrc/v3)
+
+urfave/cli-altsrc/v3 is an extended value source integration library for [urfave/cli/v3] with support for JSON,
+YAML, and TOML. The primary reason for this to be a separate library is that third-party libraries are used for these
+features which are otherwise not used throughout [urfave/cli/v3].
+
+[urfave/cli/v3]: github.com/urfave/cli

altsrc.go

@@ -0,0 +1,106 @@
+package altsrc
+
+import (
+	"errors"
+	"fmt"
+	"io"
+	"net/http"
+	"net/url"
+	"os"
+	"runtime"
+	"strings"
+)
+
+var (
+	Err = errors.New("urfave/cli-altsrc error")
+
+	isTracingOn = os.Getenv("URFAVE_CLI_TRACING") == "on"
+)
+
+func tracef(format string, a ...any) {
+	if !isTracingOn {
+		return
+	}
+
+	if !strings.HasSuffix(format, "\n") {
+		format = format + "\n"
+	}
+
+	pc, file, line, _ := runtime.Caller(1)
+	cf := runtime.FuncForPC(pc)
+
+	fmt.Fprintf(
+		os.Stderr,
+		strings.Join([]string{
+			"## URFAVE CLI TRACE ",
+			file,
+			":",
+			fmt.Sprintf("%v", line),
+			" ",
+			fmt.Sprintf("(%s)", cf.Name()),
+			" ",
+			format,
+		}, ""),
+		a...,
+	)
+}
+
+func readURI(uriString string) ([]byte, error) {
+	u, err := url.Parse(uriString)
+	if err != nil {
+		return nil, err
+	}
+
+	if u.Host != "" { // i have a host, now do i support the scheme?
+		switch u.Scheme {
+		case "http", "https":
+			res, err := http.Get(uriString)
+			if err != nil {
+				return nil, err
+			}
+			return io.ReadAll(res.Body)
+		default:
+			return nil, fmt.Errorf("%[1]w: scheme of %[2]q is unsupported", Err, uriString)
+		}
+	} else if u.Path != "" ||
+		(runtime.GOOS == "windows" && strings.Contains(u.String(), "\\")) {
+		if _, notFoundFileErr := os.Stat(uriString); notFoundFileErr != nil {
+			return nil, fmt.Errorf("%[1]w: cannot read from %[2]q because it does not exist", Err, uriString)
+		}
+		return os.ReadFile(uriString)
+	}
+
+	return nil, fmt.Errorf("%[1]w: unable to determine how to load from %[2]q", Err, uriString)
+}
+
+// nestedVal checks if the name has '.' delimiters.
+// If so, it tries to traverse the tree by the '.' delimited sections to find
+// a nested value for the key.
+func nestedVal(name string, tree map[any]any) (any, bool) {
+	if sections := strings.Split(name, "."); len(sections) > 1 {
+		node := tree
+		for _, section := range sections[:len(sections)-1] {
+			child, ok := node[section]
+			if !ok {
+				return nil, false
+			}
+
+			switch child := child.(type) {
+			case map[string]any:
+				node = make(map[any]any, len(child))
+				for k, v := range child {
+					node[k] = v
+				}
+			case map[any]any:
+				node = child
+			default:
+				return nil, false
+			}
+		}
+		if val, ok := node[sections[len(sections)-1]]; ok {
+			return val, true
+		}
+	}
+
+	return nil, false
+}

altsrc_test.go

@@ -0,0 +1,17 @@
+package altsrc
+
+import (
+	"context"
+	"time"
+
+	"github.com/urfave/cli-altsrc/v3/internal"
+)
+
+var (
+	testdataDir = func() string {
+		ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
+		defer cancel()
+
+		return internal.MustTestdataDir(ctx)
+	}()
+)