loadout 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b53dcf7016fe7d052fa02cfa1b4f7afba43f1deb7fc3bb4dcd0a87d065394174
+  data.tar.gz: 656914809769c23d3d4822aca33eb8e276c8cfbda0bf409aa64d9ea87c3223df
+SHA512:
+  metadata.gz: ab1768597fa1d238cdfb15f36c3358dec842d4a8f045e1b0d87ff3ce71a50984ffb53ce8364d6ab432a53e6028e3e0f8d0693325e3094fcacd6a1912c027eb5c
+  data.tar.gz: 5b8ca42f8a44182e9007c3372f9ac470d0abd632d202dd54da71f22bf909a6b00def14b97c13d6d917b308c6123fde5bfd959b8d9226a953e6ae911f57df037c

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.0.7

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-08-11
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Max Chernyak
+
+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,227 @@
+# Loadout
+
+Rails vanilla config is good enough, but tends to get messy. This gem provides a few helpers to
+
+- Reduce repetition
+- Raise error when required ENV vars or credentials are unset
+- Parse reasonable ENV values into booleans, integers, floats, and arrays
+
+## Synopsis
+
+```ruby
+Rails.application.configure do
+  extend Loadout::Helpers
+
+  config.some_secret = cred(:secret) { 'default' }
+  config.value_from_env_or_cred = env.cred(:key_name)
+
+  prefix(:service) do
+    config.x.service.optional_string = env.cred(:api_key) { 'default_key' }
+    config.x.service.required_string = env.cred(:api_secret)
+
+    config.x.service.optional_bool   = bool.env(:bool_flag) { false }
+    config.x.service.number          = int.env.cred(:number) { nil }
+    config.x.service.float           = float.env.cred(:number)
+    config.x.service.array           = list.env(:comma_list)
+  end
+end
+```
+
+## Installation
+
+Note: this gem requires Ruby 3.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add loadout
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install loadout
+
+## Usage
+
+1. Include helpers into your `config/application.rb` and `config/environments/*.rb`:
+
+    ```ruby
+    extend Loadout::Helpers
+    ```
+
+    This should be done in each file where you'd like to use loadout.
+
+2. Grab a value from credentials:
+
+    ```ruby
+    config.key = cred(:key_name)
+    ```
+
+3. Or from ENV:
+
+    ```ruby
+    config.key = env(:key_name)
+    ```
+
+4. Or whichever one is found first:
+
+    ```ruby
+    config.key = env.cred(:key_name)
+    ```
+
+5. Or the other way around:
+
+    ```ruby
+    config.key = cred.env(:key_name)
+    ```
+
+6. If it's a nested credential value, you can supply multiple keys:
+
+    ```ruby
+    # Look up service.key_name in credentials
+    config.key = cred(:service, :key_name)
+    ```
+
+7. It will do the right thing if you also add env:
+
+    ```ruby
+    # Look up service.key_name in credentials, or SERVICE_KEY_NAME in ENV
+    config.key = cred.env(:service, :key_name)
+    ```
+
+8. Parse ENV value into a boolean:
+
+    ```ruby
+    # Valid true strings: 1/y/yes/t/true
+    # Valid false strings: "" or 0/n/no/f/false
+    # (case insensitive)
+    #
+    # Any other string will raise an error.
+    config.some_flag = bool.cred.env(:key_name)
+    ```
+
+    Note: because credentials come from YAML, they don't need to be parsed. Only ENV values are parsed.
+
+9. Integers and floats are also supported:
+
+    ```ruby
+    config.some_int   = int.cred.env(:int_key_name)
+    config.some_float = float.cred.env(:float_key_name)
+    ```
+
+10. Lists are supported too:
+
+    ```ruby
+    # Parses strings like "foo, bar, baz", "foo|bar|baz", "foo bar baz" into ['foo', 'bar', 'baz']
+    config.some_list = list.cred.env(:key_name)
+    ```
+
+11. You can set your own list separator (string or regex):
+
+    ```ruby
+    # Parses 'foo0bar0baz' as ['foo', 'bar', 'baz']
+    config.some_list = list('0').env(:key_name)
+    ```
+
+12. Use a block at the end to specify a default value:
+
+    ```ruby
+    config.some_list = list.cred.env(:key_name) { ['default'] }
+    ```
+
+13. Use prefix to avoid repeating the same nesting:
+
+    ```ruby
+    prefix(:service) do
+      config.x.service.api_key    = env(:api_key)    # Looks up "SERVICE_API_KEY"
+      config.x.service.api_secret = env(:api_secret) # Looks up "SERVICE_API_SECRET"
+    end
+    ```
+
+    Note that left hand side is unaffected. Only loadout helpers get auto-prefixed.
+
+14. If you'd like a way to shorten the left hand side too, you can assign the whole group as a hash or OrderedOptions (this is not a loadout feature, just something you can do with Rails):
+
+    ```ruby
+    prefix(:service) do
+      config.x.service = ActiveSupport::OrderedOptions[
+        api_key:    env(:api_key),
+        api_secret: env(:api_secret)
+      ]
+    end
+    ```
+
+15. Since `prefix` returns the block's result, you can rewrite the above as follows: 
+
+    ```ruby
+    config.x.service = prefix(:service) {
+      ActiveSupport::OrderedOptions[
+        api_key:    env(:api_key),
+        api_secret: env(:api_secret)
+      ]
+    }
+    ```
+
+16. `prefix` lets you supply a default to the whole block:
+
+    ```ruby
+    prefix(:service, default: -> { 'SECRET' }) do
+      config.x.service.api_key    = env(:api_key)    # falls back to 'SECRET'
+      config.x.service.api_secret = env(:api_secret) # falls back to 'SECRET'
+    end
+    ```
+
+## Advanced configuration
+
+### I don't like all these helpers polluting my config!
+
+Instead of `extend Loadout::Helpers` you can `extend Loadout` to include one proxy method `loadout`. Now all helpers live in one place.
+
+```ruby
+Rails.application.configure do
+  extend Loadout
+
+  config.some_key = loadout.cred.env(:some_key)
+end
+```
+
+Feel free to alias it to something shorter if you'd like:
+
+```ruby
+Rails.application.configure do
+  extend Loadout
+  alias l loadout
+
+  config.some_key = l.cred.env(:some_key)
+end
+```
+
+### Credentials and ENV
+
+By default loadout will look into `credentials` and `ENV` in your config's context. If your credentials are called something else, or you want to supply an alternative source of ENV, you can configure it like so:
+
+```ruby
+Rails.application.configure do
+  extend Loadout::Helpers
+  loadout creds: alt_credentials, env: alt_env
+
+  # Now loadout will use alt_credentials and alt_env to look up values.
+end
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/loadout. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/loadout/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Loadout project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/loadout/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create
+
+task default: :test

data/lib/loadout/version.rb

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

data/lib/loadout.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require_relative 'loadout/version'
+require 'set'
+
+module Loadout
+  NONE = BasicObject.new
+  DEFAULT_LIST_SEP = /\s*[\s[[:punct:]]]+\s*/
+
+  ConfigError = Class.new(ArgumentError)
+  MissingConfigError = Class.new(ConfigError)
+  InvalidConfigError = Class.new(ConfigError)
+
+  def loadout(env: nil, creds: nil)
+    @loadout ||= Loadout::Config.new(env || ENV, creds || credentials)
+  end
+
+  module Helpers
+    def loadout(env: nil, creds: nil)
+      @loadout ||= Loadout::Config.new(env || ENV, creds || credentials)
+    end
+
+    def cred(*a, **k, &b)   = loadout.cred(*a, **k, &b)
+    def env(*a, **k, &b)    = loadout.env(*a, **k, &b)
+    def prefix(*a, **k, &b) = loadout.prefix(*a, **k, &b)
+
+    def bool(*a, **k, &b)  = loadout.bool(*a, **k, &b)
+    def int(*a, **k, &b)   = loadout.int(*a, **k, &b)
+    def float(*a, **k, &b) = loadout.float(*a, **k, &b)
+    def list(*a, **k, &b)  = loadout.list(*a, **k, &b)
+  end
+
+  class Config
+    protected attr_writer :type
+    protected attr_reader :lookup_stack
+
+    def initialize(env, creds)
+      @env = env
+      @creds = creds
+      @type = nil
+      @prefix_stack = []
+      @lookup_stack = Set[]
+      @prefix_default = NONE
+    end
+
+    def env(*keys, &default)
+      return dup.tap { _1.lookup_stack << :env } if keys.empty?
+      @lookup_stack << :env
+      lookup(keys, &default)
+    end
+
+    def cred(*keys, &default)
+      return dup.tap { _1.lookup_stack << :cred } if keys.empty?
+      @lookup_stack << :cred
+      lookup(keys, &default)
+    end
+
+    def prefix(*keys, default: NONE)
+      @prefix_default = default unless default.equal?(NONE)
+      @prefix_stack.push(keys)
+      yield.tap { @prefix_stack.pop }
+    end
+
+    def bool                         = dup.tap { _1.type = :bool }
+    def int                          = dup.tap { _1.type = :int }
+    def float                        = dup.tap { _1.type = :float }
+    def list(sep = DEFAULT_LIST_SEP) = dup.tap { _1.type = [:list, sep] }
+
+    def initialize_dup(other)
+      @creds          = other.instance_variable_get(:@creds)
+      @type           = other.instance_variable_get(:@type).dup
+      @prefix_stack   = other.instance_variable_get(:@prefix_stack).dup
+      @lookup_stack   = other.instance_variable_get(:@lookup_stack).dup
+
+      unless other.instance_variable_get(:@prefix_default).equal?(NONE)
+        @prefix_default = other.instance_variable_get(:@prefix_default).dup
+      end
+
+      super
+    end
+
+    private
+
+    def lookup(keys)
+      value = NONE
+      keys = @prefix_stack.flatten + keys
+
+      @lookup_stack.each do |source|
+        value =
+          case source
+          when :cred; lookup_cred(keys)
+          when :env;  lookup_env(keys)
+          end
+
+        return value unless value.equal?(NONE)
+      end
+
+      return yield if block_given?
+      return @prefix_default.call unless @prefix_default.equal?(NONE)
+      raise_missing(keys)
+    ensure
+      @lookup_stack.clear
+    end
+
+    def lookup_cred(keys)
+      return @creds[keys[0]] if keys.one? && @creds.has_key?(keys[0])
+      return NONE if keys.one?
+      hash = @creds.dig(*keys[..-2])
+      hash&.has_key?(keys.last) ? hash[keys.last] : NONE
+    end
+
+    def lookup_env(keys)
+      env_key = keys.join('_').upcase
+      @env.has_key?(env_key) ? coerce(env_key, @env[env_key]) : NONE
+    end
+
+    def coerce(key, value)
+      case @type
+      in :bool
+        value = value.to_s
+        return false if value == ''
+        return false if %w[0 n no f false].include?(value.downcase)
+        return true  if %w[1 y yes t true].include?(value.downcase)
+        raise_invalid :bool, key, value
+      in :int; enhance_exception(:int, key, value) { Integer(value) }
+      in :float; enhance_exception(:float, key, value) { Float(value) }
+      in :list, sep; value.split(sep)
+      else; value
+      end
+    end
+
+    def enhance_exception(type, key, val)
+      yield
+    rescue ArgumentError
+      raise_invalid(type, key, val)
+    end
+
+    def raise_missing(keys)
+      src = []
+      val = []
+
+      @lookup_stack.each do |source|
+        case source
+        when :cred
+          src << "credential"
+          val << keys.join('.')
+        when :env
+          src << "environment variable"
+          val << keys.join('_').upcase
+        end
+      end
+
+      msg = src.zip(val).map { |s, v| "#{s} (#{v})" }.join(' or ')
+      raise MissingConfigError, "required #{msg} is not set"
+    end
+
+    def raise_invalid(type, key, val)
+      raise InvalidConfigError, "invalid value for #{type} (`#{val}`) in #{key}"
+    end
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: loadout
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Max Chernyak
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-11 00:00:00.000000000 Z
+dependencies: []
+description: A few helpers to make vanilla Rails configuration neater.
+email:
+- hello@max.engineer
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".tool-versions"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/loadout.rb
+- lib/loadout/version.rb
+homepage: https://github.com/maxim/loadout
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/maxim/loadout
+  source_code_uri: https://github.com/maxim/loadout
+  changelog_uri: https://github.com/maxim/loadout/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key:
+specification_version: 4
+summary: Rails configuration helpers
+test_files: []