nero 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3da331b2512fc63cf1a9258991a33dda876e8b0aed2445bca34ed207f8cfc1fb
-  data.tar.gz: 79c6afff69d21841b247de206f7b3f6482bf74496ad91c4986528fd0620e6551
+  metadata.gz: 9822fcc078e4b2c0e9f049da7cf6f37a98a5b9cf607434057f266a393154296e
+  data.tar.gz: b71a5be94f469b564e3a80c80a0545246afbc053f619201f8a0c6c0923a776a4
 SHA512:
-  metadata.gz: e80cb4098d709df1231e7ee1cfc077be097517709ffabee489cdce8bc9da30aac7e6f89157823c147e691042945c9da806f337f1ca64ab90dc376d390f46d0b9
-  data.tar.gz: 7637f0ae5983c3902a04092c2d1cf3ed9aacb0ae036f73d7c1067f7677a8c175ffe4c4826c972cb129c47cfe37517115e0bd51f81c1f6b4f132a8946b4311a3e
+  metadata.gz: 863f2c0fbeb21286a0d0f51219e07351a93489688eb7c49be5c1c720a3e414d8e43129e2c0e4d23c6e44213e8547a03c28df128210026414e9e3e209bb7ef472
+  data.tar.gz: c431e49a4d5d422b554a891973c0e24b7c1810dd922492d56b39ca6157dc70e3110114d7474d0d2ed3b5076f2bea63d8493b2cd9db64c3354ea051022f8887cb

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "psych-3" do
+  gem "psych", "< 4"
+end
+
+appraise "psych-4" do
+  gem "psych", "< 5"
+end

data/CHANGELOG.md

@@ -1,4 +1,18 @@
 ## [Unreleased]
+...
+
+## [0.4.0] - 2025-02-15
+
+- Add `!ref`-tag:
+  ```ruby
+  Nero.load(<<~YAML)
+    min_threads: !env [MIN_THREADS, !ref [max_threads]]
+    max_threads: 5
+  end
+  # => {min_threads: 5, max_threads: 5}
+  ```
+- Support Psych v3  
+  ...so it can used with Rails v6
 
 ## [0.3.0] - 2025-02-02
 

data/README.md

@@ -2,33 +2,33 @@
 
 [![Gem Version](https://badge.fury.io/rb/nero.svg)](https://badge.fury.io/rb/nero)
 
-Nero is a RubyGem that offers predefined tags and allows you to effortlessly create custom ones for YAML configuration files.
+Nero is a RubyGem that offers declarative YAML-tags to simplify config files, e.g. for requiring and coercion of env-vars.  
+Additionally, it allows you to create your own.
 
-E.g. instead of having the following settings file in your Rails project:
+**Sample:**
 
 ```yaml
 development:
-  secret: <%= ENV.fetch("SECRET", "dummy") %>
-  # custom logic how to get a boolean...
-  debug?: <%= ENV["DEBUG"] == "true" %>
-production:
-  # any ENV.fetch in this section would hamper local development...
-  secret: <%= ENV["SECRET"] %>
-  # custom coercion logic
-  max_threads: <%= ENV.fetch("MAX_THREADS", 5).to_i %>
-```
-
-...turn it into this:
-```yaml
-development:
+  # env-var with default value
   secret: !env [SECRET, "dummy"]
+  # optional env-var with coercion
   debug?: !env/bool? DEBUG
 production:
-  # required _only_ when loading production
+  # required env-var (only when getting the production-root)
   secret: !env SECRET
+  # int coercion
   max_threads: !env/integer [MAX_THREADS, 5]
+  # something custom
+  cache_ttl: !duration [2, hours]
 ```
 
+## Highlights
+
+* 💎 declarative YAML-tags for e.g. requiring and coercing env-vars
+* 🛠️ add custom tags
+* 🛤️ `Rails.application.config_for` stand-in
+* ♻️ Zeitwerk-only dependency
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -128,12 +128,37 @@ The following tags are provided:
     - smtps://%s:%s@smtp.gmail.com
     - !env SMTP_USER
     - !env SMTP_PASS
-  # using references
+  
+  # pass it a map (including a key 'fmt') to use references
   smtp_url: !str/format
     fmt: smtps://%<user>s:%<pass>s@smtp.gmail.com
     user: !env SMTP_USER
     pass: !env SMTP_PASS
   ```
+- `!ref`  
+  Include values from elsewhere:
+  ```yaml
+  # simple
+  min_threads: !env [MIN_THREADS, !ref [max_threads]]
+  max_threads: 5
+  
+  # oauth_callback -refs-> base.url -refs-> base.host
+  base:
+    host: !env [HOST]
+    url: !str/format ['https://%s', !ref[base, host]]
+  oauth_callback: !str/format
+    - '%s/oauth/callback'
+    - !ref[base, url]
+
+  # refs are resolved within the tree of the selected root.
+  # The following config won't work when doing `Nero.load_config(:app, root: :prod)`
+  dev:
+    max_threads: 5
+  prod:
+    max_threads: !env[MAX_THREADS, !ref[dev, max_threads]]
+  ```
+  NOTE future version should raise properly over ref-ing a non-existing path.
+  
 
 Add one yourself:
 ```ruby
@@ -152,6 +177,11 @@ Nero.configure do |nero|
     #
     # Find the value in the respective attribute, e.g. `coder.scalar`:
     coder.scalar.upcase
+
+    # NOTE when needing just one argument, supporting both scalar and seq allows for chaining:
+    # a: !my/inc 4 # scalar suffices
+    # ...but when chaining, a seq is required:
+    # a: !my/inc [!my/square 2]
   end
 
   # Other configuration options:

data/gemfiles/psych_3.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "standard", "~> 1.3"
+gem "psych", "< 4"
+
+gemspec path: "../"

data/gemfiles/psych_4.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "standard", "~> 1.3"
+gem "psych", "< 5"
+
+gemspec path: "../"

data/lib/nero/version.rb

@@ -3,5 +3,5 @@
 module Nero
   # NOTE this is written upon release via:
   # $ rake gem:build[version=0.3.0]
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/nero.rb

@@ -45,7 +45,7 @@ module Nero
 
     def resolve(ctx)
       resolve_nested!(ctx)
-      ctx[:tags][@coder.tag].call(@coder)
+      ctx[:tags][@coder.tag].call(@coder, ctx)
     end
 
     def resolve_nested!(ctx)
@@ -75,8 +75,23 @@ module Nero
     yield configuration if block_given?
   end
 
+  # helpers for configuration
+  # module TagHelpers
+  #  def to_boolean(s)
+  #  end
+  # end
+
   def self.add_default_tags!
+    # extend TagHelpers
+
     configure do |config|
+      config.add_tag("ref") do |coder, ctx|
+        # validate: non-empty coder.seq, only strs, path must exists in ctx[:config]
+
+        path = coder.seq.map(&:to_sym)
+        deep_resolve(ctx[:config].dig(*path), **ctx)
+      end
+
       config.add_tag("env/integer") do |coder|
         Integer(env_fetch(*(coder.scalar || coder.seq), all_optional: "999"))
       end
@@ -175,13 +190,14 @@ module Nero
     aliases: true
   }
 
-  def self.load_config(file, root: nil)
+  def self.load_config(file, root: nil, env: nil)
+    root ||= env
     add_tags!
 
     file = resolve_file(file)
 
     if file.exist?
-      process_yaml(YAML.load_file(file, **@yaml_options), root:)
+      process_yaml(yaml_load_file(file, @yaml_options), root:)
     else
       raise "Can't find file #{file}"
     end
@@ -197,10 +213,11 @@ module Nero
   end
   private_class_method :resolve_file
 
-  def self.load(raw, root: nil)
+  def self.load(raw, root: nil, env: nil)
+    root ||= env
     add_tags!
 
-    process_yaml(YAML.load(raw, **@yaml_options), root:)
+    process_yaml(yaml_load(raw, @yaml_options), root:)
   end
 
   def self.process_yaml(yaml, root: nil)
@@ -208,10 +225,28 @@ module Nero
       root ? _1[root.to_sym] : _1
     end
 
-    deep_resolve(unresolved, tags: configuration.tags)
+    deep_resolve(unresolved, tags: configuration.tags, config: unresolved)
   end
   private_class_method :process_yaml
 
+  def self.yaml_load_file(file, opts = {})
+    if Psych::VERSION < "4"
+      YAML.load_file(file)
+    else
+      YAML.load_file(file, **opts)
+    end
+  end
+  private_class_method :yaml_load_file
+
+  def self.yaml_load(file, opts = {})
+    if Psych::VERSION < "4"
+      YAML.load(file)
+    else
+      YAML.load(file, **opts)
+    end
+  end
+  private_class_method :yaml_load
+
   def self.add_tags!
     configuration.tags.keys.each do
       YAML.add_tag(_1, TagResolver)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: nero
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Gert Goet
 bindir: exe
 cert_chain: []
-date: 2025-02-02 00:00:00.000000000 Z
+date: 2025-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -23,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   Some convenient YAML-tags...
   - to get environment values: env, env?, env/integer, env/integer?, env/bool, env/bool?.
@@ -39,10 +53,13 @@ files:
 - ".envrc"
 - ".rspec"
 - ".standard.yml"
+- Appraisals
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
 - Rakefile
+- gemfiles/psych_3.gemfile
+- gemfiles/psych_4.gemfile
 - lib/nero.rb
 - lib/nero/util.rb
 - lib/nero/version.rb