loadout 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b53dcf7016fe7d052fa02cfa1b4f7afba43f1deb7fc3bb4dcd0a87d065394174
-  data.tar.gz: 656914809769c23d3d4822aca33eb8e276c8cfbda0bf409aa64d9ea87c3223df
+  metadata.gz: 6c35aa7a1b51f1a26726c71f263a05e57c3014944d54446e405aea8132885245
+  data.tar.gz: c69c4f2297f31499db694247daf03428666b31b1d728ff77638ef2d2dac46d36
 SHA512:
-  metadata.gz: ab1768597fa1d238cdfb15f36c3358dec842d4a8f045e1b0d87ff3ce71a50984ffb53ce8364d6ab432a53e6028e3e0f8d0693325e3094fcacd6a1912c027eb5c
-  data.tar.gz: 5b8ca42f8a44182e9007c3372f9ac470d0abd632d202dd54da71f22bf909a6b00def14b97c13d6d917b308c6123fde5bfd959b8d9226a953e6ae911f57df037c
+  metadata.gz: 68cd692af87709c29bcd547119b0930fae89f28e02f79b37b25babf6214823c07ed5f7edf4e4dd02bb480b815f660558b79fb9271a379258f3b54a4cdc0f3dbf
+  data.tar.gz: f9c5abe54da9dfc8fcd9e7e978fb0a90f38bd4a3b6cba675022fb93ee5f32239d84e87bcb1195202b7b691d8ab071e116991d620f09bd162736c38fe2d3c8b1c

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [0.2.0] - 2024-08-11
+
+- Always convert ENV values to string
+- Consider "" an invalid ENV value for list
+- Minor internal refactors
+
 ## [0.1.0] - 2024-08-11
 
 - Initial release

data/README.md

@@ -55,18 +55,36 @@ If bundler is not being used to manage dependencies, install the gem by executin
     config.key = cred(:key_name)
     ```
 
+    If you don't set this credential, you will get an error:
+
+    ```ruby
+    Loadout::MissingConfigError: required credential (key_name) is not set
+    ```
+
 3. Or from ENV:
 
     ```ruby
     config.key = env(:key_name)
     ```
 
-4. Or whichever one is found first:
+    If you don't set this env, you will get an error:
+
+    ```ruby
+    Loadout::MissingConfigError: required environment variable (KEY_NAME) is not set
+    ```
+
+4. Look up ENV, then credentials, then fail:
 
     ```ruby
     config.key = env.cred(:key_name)
     ```
 
+    If neither are set, you will get an error:
+
+    ```ruby
+    Loadout::MissingConfigError: required environment variable (KEY_NAME) or credential (key_name) is not set
+    ```
+
 5. Or the other way around:
 
     ```ruby
@@ -98,6 +116,12 @@ If bundler is not being used to manage dependencies, install the gem by executin
     config.some_flag = bool.cred.env(:key_name)
     ```
 
+    If you set an invalid value, you will get an error:
+
+    ```ruby
+    Loadout::InvalidConfigError: invalid value for bool (`value`) in 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:
@@ -117,7 +141,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 11. You can set your own list separator (string or regex):
 
     ```ruby
-    # Parses 'foo0bar0baz' as ['foo', 'bar', 'baz']
+    # Parses 'foo0bar0baz' into ['foo', 'bar', 'baz']
     config.some_list = list('0').env(:key_name)
     ```
 

data/lib/loadout/version.rb

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

data/lib/loadout.rb

@@ -32,26 +32,26 @@ module Loadout
 
   class Config
     protected attr_writer :type
-    protected attr_reader :lookup_stack
+    protected attr_reader :lookup_list
 
     def initialize(env, creds)
       @env = env
       @creds = creds
       @type = nil
       @prefix_stack = []
-      @lookup_stack = Set[]
+      @lookup_list = Set[]
       @prefix_default = NONE
     end
 
     def env(*keys, &default)
-      return dup.tap { _1.lookup_stack << :env } if keys.empty?
-      @lookup_stack << :env
+      return dup.tap { _1.lookup_list << :env } if keys.empty?
+      @lookup_list << :env
       lookup(keys, &default)
     end
 
     def cred(*keys, &default)
-      return dup.tap { _1.lookup_stack << :cred } if keys.empty?
-      @lookup_stack << :cred
+      return dup.tap { _1.lookup_list << :cred } if keys.empty?
+      @lookup_list << :cred
       lookup(keys, &default)
     end
 
@@ -67,10 +67,9 @@ module Loadout
     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
+      @type         = other.instance_variable_get(:@type).dup
+      @prefix_stack = other.instance_variable_get(:@prefix_stack).dup
+      @lookup_list  = other.instance_variable_get(:@lookup_list).dup
 
       unless other.instance_variable_get(:@prefix_default).equal?(NONE)
         @prefix_default = other.instance_variable_get(:@prefix_default).dup
@@ -85,7 +84,7 @@ module Loadout
       value = NONE
       keys = @prefix_stack.flatten + keys
 
-      @lookup_stack.each do |source|
+      @lookup_list.each do |source|
         value =
           case source
           when :cred; lookup_cred(keys)
@@ -99,7 +98,7 @@ module Loadout
       return @prefix_default.call unless @prefix_default.equal?(NONE)
       raise_missing(keys)
     ensure
-      @lookup_stack.clear
+      @lookup_list.clear
     end
 
     def lookup_cred(keys)
@@ -116,41 +115,51 @@ module Loadout
 
     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)
+      in :bool;      parse_bool(key, value)
+      in :int;       parse_int(key, value)
+      in :float;     parse_float(key, value)
+      in :list, sep; parse_list(key, value, sep)
       else; value
       end
     end
 
-    def enhance_exception(type, key, val)
-      yield
+    def parse_bool(key, value)
+      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
+    end
+
+    def parse_int(key, val)
+      Integer(val.to_s)
     rescue ArgumentError
-      raise_invalid(type, key, val)
+      raise_invalid :int, key, val
+    end
+
+    def parse_float(key, val)
+      Float(val.to_s)
+    rescue ArgumentError
+      raise_invalid :float, key, val
+    end
+
+    def parse_list(key, val, sep)
+      val = val.to_s
+      raise_invalid(:list, key, val) if val == ''
+      val.split(sep)
     end
 
     def raise_missing(keys)
-      src = []
-      val = []
+      pairs = []
 
-      @lookup_stack.each do |source|
+      @lookup_list.each do |source|
         case source
-        when :cred
-          src << "credential"
-          val << keys.join('.')
-        when :env
-          src << "environment variable"
-          val << keys.join('_').upcase
+        when :cred; pairs << ["credential", keys.join('.')]
+        when :env;  pairs << ["environment variable", keys.join('_').upcase]
         end
       end
 
-      msg = src.zip(val).map { |s, v| "#{s} (#{v})" }.join(' or ')
+      msg = pairs.map { |s, v| "#{s} (#{v})" }.join(' or ')
       raise MissingConfigError, "required #{msg} is not set"
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loadout
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Max Chernyak
@@ -48,7 +48,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: Rails configuration helpers