chore(release): v0.0.3 (#5)

chore(release): 0.0.3

Co-authored-by: cuddle-please <bot@cuddle.sh>
Reviewed-on: https://git.front.kjuulh.io/kjuulh/yourconfig/pulls/5

CHANGELOG.md

@@ -6,6 +6,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.3] - 2025-07-23
+
+### Added
+- handle errors via. required (tests)
+- only error on non required values
+
+## [0.0.2] - 2025-07-22
+
+### Added
+- add a global handler for getting items
+- rename tag
+
+### Other
+- Configure Renovate (#2)
+  Add renovate.json
+
 ## [0.0.1] - 2025-07-21
 
 ### Added

config.go

@@ -1,9 +1,9 @@
 package yourconfig
 
 import (
+	"context"
 	"errors"
 	"fmt"
-	"os"
 	"reflect"
 	"strconv"
 	"strings"
@@ -11,8 +11,17 @@ import (
 	"github.com/ettle/strcase"
 )
 
+func MustLoadContext[T any](ctx context.Context) T {
+	output, err := LoadContext[T](ctx)
+	if err != nil {
+		panic(fmt.Sprintf("must load: %s", err.Error()))
+	}
+
+	return output
+}
+
 func MustLoad[T any]() T {
-	output, err := Load[T]()
+	output, err := LoadContext[T](context.Background())
 	if err != nil {
 		panic(fmt.Sprintf("must load: %s", err.Error()))
 	}
@@ -21,6 +30,10 @@ func MustLoad[T any]() T {
 }
 
 func Load[T any]() (T, error) {
+	return LoadContext[T](context.Background())
+}
+
+func LoadContext[T any](ctx context.Context) (T, error) {
 	var cfg T
 
 	v := reflect.ValueOf(&cfg).Elem()
@@ -31,7 +44,7 @@ func Load[T any]() (T, error) {
 OUTER:
 	for i := 0; i < t.NumField(); i++ {
 		field := t.Field(i)
-		tagStr := field.Tag.Get("conf")
+		tagStr := field.Tag.Get("cfg")
 		if tagStr == "" {
 			continue
 		}
@@ -80,7 +93,11 @@ OUTER:
 			}
 		}
 
-		valueStr := os.Getenv(tag.Env)
+		valueStr, err := defaultLogger.Load().Get(ctx, tag.Env)
+		if err != nil && tag.Required {
+			errs = append(errs, fmt.Errorf("field: %s failed to load: %w", field.Name, err))
+			continue OUTER
+		}
 		if valueStr == "" && tag.Required {
 			errs = append(errs, fmt.Errorf("field: %s (env=%s) is not set and is required", field.Name, tag.Env))
 			continue OUTER

config_test.go

@@ -24,7 +24,7 @@ func TestLoad(t *testing.T) {
 
 	t.Run("default tag, nothing set, no env set", func(t *testing.T) {
 		type Config struct {
-			SomeItem      string `conf:""`
+			SomeItem      string `cfg:""`
 			someOtherItem string
 			someBool      bool
 		}
@@ -37,7 +37,7 @@ func TestLoad(t *testing.T) {
 
 	t.Run("default tag (required=true), nothing set, no env set, err", func(t *testing.T) {
 		type Config struct {
-			SomeItem      string `conf:"required:true"`
+			SomeItem      string `cfg:"required:true"`
 			someOtherItem string
 			someBool      bool
 		}
@@ -51,7 +51,7 @@ func TestLoad(t *testing.T) {
 
 	t.Run("default tag (required=false), nothing set, no env set no error", func(t *testing.T) {
 		type Config struct {
-			SomeItem      string `conf:"required:false"`
+			SomeItem      string `cfg:"required:false"`
 			someOtherItem string
 			someBool      bool
 		}
@@ -64,7 +64,7 @@ func TestLoad(t *testing.T) {
 
 	t.Run("env tag nothing set, no env set, no error", func(t *testing.T) {
 		type Config struct {
-			SomeItem      string `conf:"SOME_ITEM"`
+			SomeItem      string `cfg:"SOME_ITEM"`
 			someOtherItem string
 			someBool      bool
 		}
@@ -77,7 +77,7 @@ func TestLoad(t *testing.T) {
 
 	t.Run("default tag (required=true), nothing set, no env set, err", func(t *testing.T) {
 		type Config struct {
-			SomeItem      string `conf:"SOME_ITEM,required:true"`
+			SomeItem      string `cfg:"SOME_ITEM,required:true"`
 			someOtherItem string
 			someBool      bool
 		}
@@ -91,7 +91,7 @@ func TestLoad(t *testing.T) {
 
 	t.Run("default tag (required), nothing set, no env set, err", func(t *testing.T) {
 		type Config struct {
-			SomeItem      string `conf:"SOME_ITEM,required"`
+			SomeItem      string `cfg:"SOME_ITEM,required"`
 			someOtherItem string
 			someBool      bool
 		}
@@ -106,7 +106,7 @@ func TestLoad(t *testing.T) {
 	t.Run("default tag private, trying to set, err", func(t *testing.T) {
 		type Config struct {
 			SomeItem      string
-			someOtherItem string `conf:"required:true"`
+			someOtherItem string `cfg:"required:true"`
 			someBool      bool
 		}
 
@@ -121,7 +121,7 @@ func TestLoad(t *testing.T) {
 
 	t.Run("env tag and env set, no error", func(t *testing.T) {
 		type Config struct {
-			SomeItem      string `conf:"required:true"`
+			SomeItem      string `cfg:"required:true"`
 			someOtherItem string
 			someBool      bool
 		}
@@ -136,7 +136,7 @@ func TestLoad(t *testing.T) {
 
 	t.Run("env tag (different name) and env set, no error", func(t *testing.T) {
 		type Config struct {
-			SomeItem      string `conf:"DIFFERENT_NAME,required:true"`
+			SomeItem      string `cfg:"DIFFERENT_NAME,required:true"`
 			someOtherItem string
 			someBool      bool
 		}
@@ -151,8 +151,8 @@ func TestLoad(t *testing.T) {
 
 	t.Run("multiple env tag and env set, no error", func(t *testing.T) {
 		type Config struct {
-			SomeItem      string `conf:"required:true"`
-			SomeOtherItem string `conf:"required:true"`
+			SomeItem      string `cfg:"required:true"`
+			SomeOtherItem string `cfg:"required:true"`
 			someBool      bool
 		}
 
@@ -165,4 +165,36 @@ func TestLoad(t *testing.T) {
 		assert.Equal(t, "some-item", val.SomeItem)
 		assert.Equal(t, "some-other-item", val.SomeOtherItem)
 	})
+
+	t.Run("required true, error returned", func(t *testing.T) {
+		type Config struct {
+			SomeItem      string
+			SomeOtherItem string `cfg:"required:true"`
+			someBool      bool
+		}
+
+		t.Setenv("SOME_OTHER_ITEM", "")
+
+		val, err := yourconfig.Load[Config]()
+		require.Error(t, err)
+		require.Zero(t, val)
+
+		assert.Equal(t, "config failed: field: SomeOtherItem (env=SOME_OTHER_ITEM) is not set and is required", err.Error())
+	})
+
+	t.Run("required false, no error returned", func(t *testing.T) {
+		type Config struct {
+			SomeItem      string
+			SomeOtherItem string `cfg:"required:false"`
+			someBool      bool
+		}
+
+		t.Setenv("SOME_OTHER_ITEM", "")
+
+		val, err := yourconfig.Load[Config]()
+		require.NoError(t, err)
+
+		assert.Zero(t, val)
+	})
+
 }

provider.go

@@ -0,0 +1,56 @@
+package yourconfig
+
+import (
+	"context"
+	"os"
+	"sync/atomic"
+)
+
+var defaultLogger atomic.Pointer[Provider]
+
+func init() {
+	defaultLogger.Store(newProvider())
+}
+
+func SetDefault(provider *Provider) {
+	defaultLogger.Store(provider)
+}
+
+func Default() *Provider {
+	return defaultLogger.Load()
+}
+
+type Handler interface {
+	Get(ctx context.Context, key string) (string, error)
+}
+
+type Provider struct {
+	handler Handler
+}
+
+func (p *Provider) Get(ctx context.Context, key string) (string, error) {
+	return p.handler.Get(ctx, key)
+}
+
+func newProvider() *Provider {
+	return &Provider{
+		handler: defaultHandler(),
+	}
+}
+
+func New(handler Handler) *Provider {
+	return &Provider{
+		handler: handler,
+	}
+}
+
+type envHandler struct{}
+
+func (e *envHandler) Get(ctx context.Context, key string) (string, error) {
+	val := os.Getenv(key)
+	return val, nil
+}
+
+func defaultHandler() Handler {
+	return &envHandler{}
+}

renovate.json

@@ -0,0 +1,3 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json"
+}