nero 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6da9456128ceb0fd0eda54c862c013035f17306b8bb08d39ce56dd79407711a2
+  data.tar.gz: 3640f4c3c54ff2ebee72698906287a5284a5194a40e30e1e6309d1f48b18d517
+SHA512:
+  metadata.gz: d811147b8d78530b57babe751d7b9d95626d0ba691fbbe9baf4acc53dbb515a13520799b60ab5244ebec3bc373c7acd6b0969b821847e97edfe54d6eddc3fa2d
+  data.tar.gz: fc47ca669383bc056b6a6788fba0cc7079ef790371227f2054e3a2b9a0033c3ee4b5ee63efb7666a9fb92487426765435ea3e672069744951d7afe194da4b7fc

data/.envrc

@@ -0,0 +1 @@
+PATH_add bin

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-01-24
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Gert Goet
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,104 @@
+# Nero
+
+Have some convenient tags in YAML config files:
+
+```yaml
+development:
+  # required value from ENV
+  github_token: !env GH_TOKEN
+
+  # optional
+  sentry_dsn: !env? SENTRY_DSN
+
+  # env-value coerced to integer with default value
+  port: !env/integer [PORT, 3000]
+
+  # combining tags
+  assets_folder: !path
+    - !env PROJECT_ROOT
+    - public/upload/assets
+
+  option: !env/integer? PORT
+
+  # Allows for: config[:log].debug?
+  log: !str/inquirer
+    - !env LOG_LEVEL
+
+  payment_url: !uri
+    - https://
+    - !env STRIP_HOST
+    - /payment/setup
+
+  url: !str/format
+    - https://%s%s
+    - !env HOST
+    - /login
+
+  debug: !env/bool [DEBUG, false]
+
+production:
+  # this won't raise an error when absent when selecting
+  # :development as
+  secret: !env SECRET
+```
+
+Add one yourself:
+```ruby
+Nero.configure do
+  add_resolver("foo") do |coder|
+    # coder.type is one of :scalar, :seq or :map
+    # e.g. respective YAML:
+    # ---
+    # !foo bar
+    # ---
+    # !foo
+    #   - bar
+    # ---
+    # !foo
+    #   bar: baz
+    #
+    # Find the value in the respective attribute, e.g. `coder.scalar`:
+    coder.scalar.upcase
+  end
+end
+```
+
+
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/nero`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/eval/nero.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/nero/util.rb

@@ -0,0 +1,29 @@
+module Nero
+  module Util
+    extend self
+
+    def deep_symbolize_keys(object)
+      case object
+      when Hash
+        object.each_with_object({}) do |(key, value), result|
+          result[key.to_sym] = deep_symbolize_keys(value)
+        end
+      when Array
+        object.map { |e| deep_symbolize_keys(e) }
+      else
+        object
+      end
+    end
+
+    def deep_transform_values(object, &block)
+      case object
+      when Hash
+        object.transform_values { |value| deep_transform_values(value, &block) }
+      when Array
+        object.map { |e| deep_transform_values(e, &block) }
+      else
+        yield(object)
+      end
+    end
+  end
+end

data/lib/nero/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Nero
+  VERSION = "0.1.0"
+end

data/lib/nero.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+require "uri" # why needed?
+
+# TODO fail on unknown tag
+# TODO show missing env's at once
+module Nero
+  class Error < StandardError; end
+
+  module Resolvable
+    def try_resolve(ctx, object)
+      if object.respond_to?(:resolve)
+        object.resolve(ctx)
+      else
+        object
+      end
+    end
+
+    def gen_resolve_tryer(ctx)
+      method(:try_resolve).curry.call(ctx)
+    end
+
+    def deep_resolve(object, **ctx)
+      Util.deep_transform_values(object, &gen_resolve_tryer(ctx))
+    end
+  end
+  extend Resolvable
+  private_class_method :try_resolve, :gen_resolve_tryer, :deep_resolve
+
+  class TagResolver
+    include Resolvable
+
+    def init_with(coder)
+      @coder = coder
+    end
+
+    def resolve(ctx)
+      resolve_nested!(ctx)
+      ctx[:resolvers][@coder.tag].call(@coder)
+    end
+
+    def resolve_nested!(ctx)
+      case @coder.type
+      when :seq
+        @coder.seq.map!(&gen_resolve_tryer(ctx))
+      when :map
+        @coder.map = deep_resolve(@coder.map, **ctx)
+      end
+    end
+  end
+
+  def self.add_resolver(name, &block)
+    (@resolvers ||= {})["!#{name}"] = block
+  end
+
+  add_resolver("env/integer") do |coder|
+    Integer(ENV.fetch(*(coder.scalar || coder.seq)))
+  end
+
+  add_resolver("env/integer?") do |coder|
+    Integer(ENV[coder.scalar]) if ENV[coder.scalar]
+  end
+
+  add_resolver("env/bool") do |coder|
+    re_true = /y|Y|yes|Yes|YES|true|True|TRUE|on|On|ON/
+    re_false = /n|N|no|No|NO|false|False|FALSE|off|Off|OFF/
+
+    coerce = ->(s) do
+      case s
+      when TrueClass, FalseClass then s
+      when re_true then true
+      when re_false then false
+      else
+        raise "bool value should be one of y(es)/n(o), on/off, true/false (got #{s.inspect})"
+      end
+    end
+
+    coerce[ENV.fetch(*(coder.scalar || coder.seq))]
+  end
+
+  add_resolver("env/bool?") do |coder|
+    re_true = /y|Y|yes|Yes|YES|true|True|TRUE|on|On|ON/
+    re_false = /n|N|no|No|NO|false|False|FALSE|off|Off|OFF/
+
+    coerce = ->(s) do
+      case s
+      when TrueClass, FalseClass then s
+      when re_true then true
+      when re_false then false
+      else
+        raise "bool value should be one of y(es)/n(o), on/off, true/false (got #{s.inspect})"
+      end
+    end
+
+    ENV[coder.scalar] ? coerce[ENV[coder.scalar]] : false
+  end
+
+  add_resolver("env") do |coder|
+    ENV.fetch(*(coder.scalar || coder.seq))
+  end
+
+  add_resolver("env?") do |coder|
+    fetch_args = coder.scalar ? [coder.scalar, nil] : coder.seq
+    ENV.fetch(*fetch_args)
+  end
+
+  add_resolver("path") do |coder|
+    Pathname.new(coder.scalar || coder.seq.join("/"))
+  end
+
+  add_resolver("uri") do |coder|
+    URI(coder.scalar || coder.seq.join)
+  end
+
+  add_resolver("str/format") do |coder|
+    case coder.type
+    when :seq
+      sprintf(*coder.seq)
+    when :map
+      m = Util.deep_symbolize_keys(coder.map)
+      fmt = m.delete(:fmt)
+      sprintf(fmt, m)
+    else
+      coder.scalar
+    end
+  end
+
+  def self.load_config(file, root: nil)
+    add_tags!
+
+    if file.exist?
+      unresolved = Util.deep_symbolize_keys(YAML.load_file(file,
+        permitted_classes: [Symbol, TagResolver], aliases: true)).then do
+        root ? _1[root] : _1
+      end
+
+      deep_resolve(unresolved, resolvers: @resolvers)
+    else
+      raise "Can't find file #{file}"
+    end
+  end
+
+  def self.add_tags!
+    @resolvers.keys.each do
+      YAML.add_tag(_1, TagResolver)
+    end
+  end
+  private_class_method :add_tags!
+end
+
+loader.eager_load if ENV.key?("CI")

data/sig/nero.rbs

@@ -0,0 +1,4 @@
+module Nero
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: nero
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gert Goet
+bindir: exe
+cert_chain: []
+date: 2025-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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?.
+  - to create a Pathname (!path) or URI (!uri)
+  - format a string: !str/format
+
+  See README for examples.
+email:
+- gert@thinkcreate.dk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".envrc"
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nero.rb
+- lib/nero/util.rb
+- lib/nero/version.rb
+- sig/nero.rbs
+homepage: https://github.com/eval/nero
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/eval/nero
+  source_code_uri: https://github.com/eval/nero
+  changelog_uri: https://github.com/eval/nero/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.3
+specification_version: 4
+summary: Convenience YAML-tags
+test_files: []