Merge pull request #47 from BoRuDar/v5

V5

Author: BoRuDar

.github/workflows/codeql-analysis.yml

@@ -38,7 +38,6 @@ jobs:
         # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
         # queries: security-extended,security-and-quality
 
-        
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild

.github/workflows/linter.yml

@@ -18,13 +18,13 @@ jobs:
 
       - uses: actions/setup-go@v5
         with:
-          go-version: '1.21'
+          go-version: '1.22'
           cache: false
 
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v4
         with:
-          version: v1.56.2
+          version: v1.62.2
           install-mode: "goinstall"
           only-new-issues: false
           skip-cache: true

.github/workflows/test.yml

@@ -4,10 +4,10 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - name: Set up Go 1.18
-        uses: actions/setup-go@v4
+      - name: Set up Go 1.22
+        uses: actions/setup-go@v5
         with:
-          go-version: 1.18
+          go-version: 1.22
         id: go
 
       - name: Check out code into the Go module directory

.golangci.yml

@@ -1,7 +1,7 @@
 run:
   timeout: 1m
   tests: true
-  go: '1.18'
+  go: '1.22'
   show-stats: true
 
 linters:
@@ -15,9 +15,8 @@ linters:
 #    - bodyclose
 #    - containedctx
 #    - contextcheck
-#    - copyloopvar
+    - copyloopvar
 #    - cyclop
-    - deadcode
 #    - decorder
 #    - depguard
 #    - dogsled
@@ -32,7 +31,7 @@ linters:
 #    - exhaustive
     - exhaustivestruct
     - exhaustruct
-#    - exportloopref
+    - exportloopref
 #    - forbidigo
 #    - forcetypeassert
     - funlen
@@ -48,7 +47,7 @@ linters:
 #    - gocyclo
     - godot
 #    - godox
-    - goerr113
+    - err113
 #    - gofmt
 #    - gofumpt
 #    - goheader
@@ -118,7 +117,7 @@ linters:
     - unparam
 #    - unused
 #    - usestdlibvars
-    - varcheck
+#    - varcheck
     - varnamelen
 #    - wastedassign
 #    - whitespace

Makefile

@@ -10,7 +10,7 @@ coverage: test
 
 .PHONY: tools
 tools:
-	go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.56.2
+	go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.62.2
 
 linter:
 	golangci-lint run ./...

README.md

@@ -38,81 +38,69 @@ Available features:
 
 
 # Quick start
-Import path `github.com/BoRuDar/configuration/v4`
+Import path `github.com/BoRuDar/configuration/v5`
 ```go
-	// defining a struct
-cfg := struct {
+// defining a struct
+type Conf struct {
     Name     string `flag:"name"`
     LastName string `default:"defaultLastName"`
-    Age      byte   `env:"AGE_ENV"    default:"-1"`
+    Age      byte   `env:"AGE_ENV"               default:"-1"`
     BoolPtr  *bool  `default:"false"`
-    
-    ObjPtr *struct {
+    ObjPtr   *struct {
         F32       float32       `default:"32"`
         StrPtr    *string       `default:"str_ptr_test"`
-        HundredMS time.Duration `default:"100ms"`
+        HundredMS time.Duration `default:"100ms"` // nolint:stylecheck
     }
-
     Obj struct {
         IntPtr     *int16   `default:"123"`
         Beta       int      `file_json:"inside.beta"   default:"24"`
         StrSlice   []string `default:"one;two"`
         IntSlice   []int64  `default:"3; 4"`
-        unexported string   `xml:"ignored"`
+        unexported string   // ignored
     }
-}{}
-
-configurator := configuration.New(
-    &cfg,
-    // order of execution will be preserved: 
-    configuration.NewFlagProvider(),             // 1st
-    configuration.NewEnvProvider(),              // 2nd 
-    configuration.NewJSONFileProvider(fileName), // 3rd 
-    configuration.NewDefaultProvider(),          // 4th
-)
+    URLs   []*string `default:"http://localhost:3000;1.2.3.4:8080"`
+    HostIP ipTest    `default:"127.0.0.3"`
+}
 
-if err := configurator.InitValues(); err != nil {
-    log.Fatalf("unexpected error: ", err)
+cfg, err := New[Conf](  // specify the [T] of the structure to be returned
+    // order of execution will be preserved:
+    NewFlagProvider(),             // 1st
+    NewEnvProvider(),              // 2nd
+    NewJSONFileProvider(fileName), // 3rd
+    NewDefaultProvider(),          // 4th
+)
+if err != nil {
+    t.Fatalf("unexpected error: %v", err)
 }
 ```
 
 If you need only ENV variables and default values you can use a shorter form:
 ```go
-err := configuration.FromEnvAndDefault(&cfg)
+cfg, err := configuration.FromEnvAndDefault[T]()
 ```
 
 
 # Providers
 You can specify one or more providers. They will be executed in order of definition:
 ```go
 []Provider{
-    NewFlagProvider(&cfg), // 1
+    NewFlagProvider(),     // 1
     NewEnvProvider(),      // 2
     NewDefaultProvider(),  // 3
 } 
 ```
-If provider set value successfully next ones will not be executed (if flag provider from the sample above found a value env and default providers are skipped). 
-The value of first successfully executed provider will be set.
-If none of providers found value - an application will be terminated.
-This behavior can be changed with `configurator.OnFailFnOpt` option:
-```go
-err := configuration.New(
-    &cfg,
-    configuration.NewEnvProvider(),
-    configuration.NewDefaultProvider()).
-    SetOptions(
-        configuration.OnFailFnOpt(func(err error) {
-            log.Println(err)
-        }),
-    ).InitValues()
-```
+**IMPORTANT:** If provider sets value successfully next ones will **NOT** be executed 
+(if flag provider from the sample above finds the value - then the env and default providers are skipped). 
+The value of the first successfully executed provider will be set.
+If none of providers can set value - an error will be returned.
 
 
 ### Custom provider
-You can define a custom provider which should satisfy next interface:
+You can define a custom provider which should satisfy this interface:
 ```go
 type Provider interface {
     Name() string
+    Tag() string
     Init(ptr any) error
     Provide(field reflect.StructField, v reflect.Value) error
 }
@@ -127,6 +115,7 @@ struct {
     // ...
 }
 ```
+So `Name` will be set to "defaultName".
 
 
 ### Env provider
@@ -138,24 +127,26 @@ struct {
     // ...
 }
 ```
-Name inside tag `env:"<name>"` must be unique for each field. Only UPPER register for ENV vars is accepted:
+Name inside tag `env:"<name>"` must be unique for each field. 
+Only strings in **UPPER** register for ENV vars are accepted:
 ```bash
 bad_env_var_name=bad
+Also_Bad_Env_Var_Name=bad
 GOOD_ENV_VAR_NAME=good
 ```
 
 
 ### Flag provider
-Looks for `flag` tag and tries to set value from the command line flag `-first_name`
+Looks for `flag` tag and tries to set the value from the command line flag `-first_name`
 ```go
 struct {
     // ...
     Name     string `flag:"first_name|default_value|Description"`
     // ...
 }
 ```
-Name inside tag `flag:"<name>"` must be unique for each field. `default_value` and `description` sections are `optional` and can be omitted.
-`NewFlagProvider(&cfg)` expects a pointer to the same object for initialization.
+Name inside tag `flag:"<name>"` must be unique for each field.
+`default_value` and `description` sections are `optional` and may be omitted.
 
 *Note*: if program is executed with `-help` or `-h` flag you will see all available flags with description:
 ```bash
@@ -164,7 +155,7 @@ Flags:
 ``` 
 And program execution will be terminated.
 #### Options for _NewFlagProvider_
-* WithFlagSet - sets a custom FlagSet
+* `WithFlagSet(s FlagSet)`  - sets a custom `FlagSet`
 
 
 ### JSON File provider