env_parser 1.3.3 → 1.6.1

data/docs/index.html

@@ -76,13 +76,13 @@
       <li>
         <p>Add one of the following to your application’s Gemfile:
 ```ruby
-## For on-demand usage …
-##
+# For on-demand usage …
+#
 gem ‘env_parser’</p>
 
-        <h2 id="to-automatically-register-env">To automatically register ENV</h2>
-        <p>## constants per “.env_parser.yml” …
-##
+        <h1 id="to-automatically-register-env">To automatically register ENV</h1>
+        <p># constants per “.env_parser.yml” …
+#
 gem ‘env_parser’, require: ‘env_parser/autoregister’
 ```</p>
       </li>
@@ -103,33 +103,33 @@ $ gem install env_parser
 <h2 id="syntax-cheat-sheet">Syntax Cheat Sheet</h2>
 
 <p>```ruby
-## Returns an ENV value parsed “as” a specific type:
-##
+# Returns an ENV value parsed “as” a specific type:
+#
 EnvParser.parse env_key_as_a_symbol
-                as: …                          ## ➜ required
-                if_unset: …                    ## ➜ optional; default value
-                from_set: …                    ## ➜ optional; an Array or Range
-                validated_by: -&gt;(value) { … }  ## ➜ optional; may also be given as a block</p>
+                as: …                          # ➜ required
+                if_unset: …                    # ➜ optional; default value
+                from_set: …                    # ➜ optional; an Array or Range
+                validated_by: -&gt;(value) { … }  # ➜ optional; may also be given as a block</p>
 
-<h2 id="parse-an-env-value-and-register-it-as-a-constant">Parse an ENV value and register it as a constant:</h2>
-<p>##
+<h1 id="parse-an-env-value-and-register-it-as-a-constant">Parse an ENV value and register it as a constant:</h1>
+<p>#
 EnvParser.register env_key_as_a_symbol
-                   as: …                          ## ➜ required
-                   within: …                      ## ➜ optional; Class or Module
-                   if_unset: …                    ## ➜ optional; default value
-                   from_set: …                    ## ➜ optional; an Array or Range
-                   validated_by: -&gt;(value) { … }  ## ➜ optional; may also be given as a block</p>
-
-<h2 id="registers-all-env-variables-as-speced-in-envparseryml">Registers all ENV variables as spec’ed in “.env_parser.yml”:</h2>
-<p>##
-EnvParser.autoregister  ## Note this is automatically called if your
-                        ## Gemfile included the “env_parser” gem with
-                        ## the “require: ‘env_parser/autoregister’” option.</p>
-
-<h2 id="lets-you-call-parse-and-register-on-env-itself">Lets you call “parse” and “register” on ENV itself:</h2>
-<p>##
-EnvParser.add_env_bindings  ## ENV.parse will now be a proxy for EnvParser.parse
-                            ## and ENV.register will now be a proxy for EnvParser.register
+                   as: …                          # ➜ required
+                   within: …                      # ➜ optional; Class or Module
+                   if_unset: …                    # ➜ optional; default value
+                   from_set: …                    # ➜ optional; an Array or Range
+                   validated_by: -&gt;(value) { … }  # ➜ optional; may also be given as a block</p>
+
+<h1 id="registers-all-env-variables-as-speced-in-envparseryml">Registers all ENV variables as spec’ed in “.env_parser.yml”:</h1>
+<p>#
+EnvParser.autoregister  # Note this is automatically called if your
+                        # Gemfile included the “env_parser” gem with
+                        # the “require: ‘env_parser/autoregister’” option.</p>
+
+<h1 id="lets-you-call-parse-and-register-on-env-itself">Lets you call “parse” and “register” on ENV itself:</h1>
+<p>#
+EnvParser.add_env_bindings  # ENV.parse will now be a proxy for EnvParser.parse
+                            # and ENV.register will now be a proxy for EnvParser.register
 ```</p>
 
 <h2 id="extended-how-to-use">Extended How-To-Use</h2>
@@ -143,9 +143,9 @@ EnvParser.add_env_bindings  ## ENV.parse will now be a proxy for EnvParser.parse
     <p>At its core, EnvParser is a straight-forward parser for string values (since that’s all <code>ENV</code> ever gives you), allowing you to read a given string <strong><em>as</em></strong> a variety of types.</p>
 
     <p><code>ruby
-## Returns ENV['TIMEOUT_MS'] as an Integer,
-## or a sensible default (0) if ENV['TIMEOUT_MS'] is unset.
-##
+# Returns ENV['TIMEOUT_MS'] as an Integer,
+# or a sensible default (0) if ENV['TIMEOUT_MS'] is unset.
+#
 timeout_ms = EnvParser.parse ENV['TIMEOUT_MS'], as: :integer
 </code></p>
 
@@ -157,9 +157,9 @@ timeout_ms = EnvParser.parse ENV['TIMEOUT_MS'], as: :integer
     <p>EnvParser is all about ~~simplification~~ ~~less typing~~ <em>laziness</em>. If you pass in a symbol instead of a string, EnvParser will look to <code>ENV</code> and use the value from the corresponding (string) key.</p>
 
     <p><code>ruby
-## YAY, LESS TYPING!  😃
-## These two are the same:
-##
+# YAY, LESS TYPING!  😃
+# These two are the same:
+#
 more_typing = EnvParser.parse ENV['TIMEOUT_MS'], as: :integer
 less_typing = EnvParser.parse :TIMEOUT_MS, as: :integer
 </code></p>
@@ -170,20 +170,20 @@ less_typing = EnvParser.parse :TIMEOUT_MS, as: :integer
     <p>The <code>EnvParser.register</code> method lets you “promote” <code>ENV</code> variables into their own constants, already parsed into the correct type.</p>
 
     <p>```ruby
-ENV[‘API_KEY’]  ## =&gt; ‘unbreakable p4$$w0rd’</p>
+ENV[‘API_KEY’]  # =&gt; ‘unbreakable p4$$w0rd’</p>
 
     <p>EnvParser.register :API_KEY, as: :string
-API_KEY  ## =&gt; ‘unbreakable p4$$w0rd’
+API_KEY  # =&gt; ‘unbreakable p4$$w0rd’
 ```</p>
 
     <p>By default, <code>EnvParser.register</code> will create the requested constant within the Kernel module (making it available everywhere), but you can specify any class or module you like.</p>
 
     <p>```ruby
-ENV[‘BEST_VIDEO’]  ## =&gt; ‘https://youtu.be/L_jWHffIx5E’</p>
+ENV[‘BEST_VIDEO’]  # =&gt; ‘https://youtu.be/L_jWHffIx5E’</p>
 
     <p>EnvParser.register :BEST_VIDEO, as: :string, within: URI
-URI::BEST_VIDEO  ## =&gt; ‘https://youtu.be/L_jWHffIx5E’
-BEST_VIDEO  ## =&gt; raises NameError
+URI::BEST_VIDEO  # =&gt; ‘https://youtu.be/L_jWHffIx5E’
+BEST_VIDEO  # =&gt; raises NameError
 ```</p>
 
     <p>You can also register multiple constants with a single call, which is a bit cleaner.</p>
@@ -193,7 +193,7 @@ EnvParser.register :USERNAME, as: :string
 EnvParser.register :PASSWORD, as: :string
 EnvParser.register :MOCK_API, as: :boolean, within: MyClassOrModule }</p>
 
-    <h2 id="is-equivalent-to-">… is equivalent to …</h2>
+    <h1 id="is-equivalent-to-">… is equivalent to …</h1>
 
     <p>EnvParser.register USERNAME: { as: :string                           },
                    PASSWORD: { as: :string                           },
@@ -206,31 +206,31 @@ EnvParser.register :MOCK_API, as: :boolean, within: MyClassOrModule }</p>
     <p>Calling <code>EnvParser.add_env_bindings</code> binds proxy <code>parse</code> and <code>register</code> methods onto <code>ENV</code>. With these bindings in place, you can call <code>parse</code> or <code>register</code> on <code>ENV</code> itself, which is more legible and feels more straight-forward.</p>
 
     <p>```ruby
-ENV[‘SHORT_PI’]  ## =&gt; ‘3.1415926’
-ENV[‘BETTER_PI’]  ## =&gt; ‘[“flaky crust”, “strawberry filling”]’</p>
+ENV[‘SHORT_PI’]  # =&gt; ‘3.1415926’
+ENV[‘BETTER_PI’]  # =&gt; ‘[“flaky crust”, “strawberry filling”]’</p>
 
-    <h2 id="bind-the-proxy-methods">Bind the proxy methods.</h2>
-    <p>##
+    <h1 id="bind-the-proxy-methods">Bind the proxy methods.</h1>
+    <p>#
 EnvParser.add_env_bindings</p>
 
-    <p>ENV.parse :SHORT_PI, as: :float  ## =&gt; 3.1415926
-ENV.register :BETTER_PI, as: :array  ## Your constant is set!
+    <p>ENV.parse :SHORT_PI, as: :float  # =&gt; 3.1415926
+ENV.register :BETTER_PI, as: :array  # Your constant is set!
 ```</p>
 
     <p>Note that the proxy <code>ENV.parse</code> method will (naturally) <em>always</em> interpret the value given as an <code>ENV</code> key (converting it to a string, if necessary), which is slightly different from the original <code>EnvParser.parse</code> method.</p>
 
     <p>```ruby
-ENV[‘SHORT_PI’]  ## =&gt; ‘3.1415926’</p>
+ENV[‘SHORT_PI’]  # =&gt; ‘3.1415926’</p>
 
-    <p>EnvParser.parse ‘SHORT_PI’, as: :float  ## =&gt; ‘SHORT_PI’ as a float: 0.0
-EnvParser.parse :SHORT_PI , as: :float  ## =&gt; ENV[‘SHORT_PI’] as a float: 3.1415926</p>
+    <p>EnvParser.parse ‘SHORT_PI’, as: :float  # =&gt; ‘SHORT_PI’ as a float: 0.0
+EnvParser.parse :SHORT_PI , as: :float  # =&gt; ENV[‘SHORT_PI’] as a float: 3.1415926</p>
 
-    <h2 id="bind-the-proxy-methods-1">Bind the proxy methods.</h2>
-    <p>##
+    <h1 id="bind-the-proxy-methods-1">Bind the proxy methods.</h1>
+    <p>#
 EnvParser.add_env_bindings</p>
 
-    <p>ENV.parse ‘SHORT_PI’, as: :float  ## =&gt; ENV[‘SHORT_PI’] as a float: 3.1415926
-ENV.parse :SHORT_PI , as: :float  ## =&gt; ENV[‘SHORT_PI’] as a float: 3.1415926
+    <p>ENV.parse ‘SHORT_PI’, as: :float  # =&gt; ENV[‘SHORT_PI’] as a float: 3.1415926
+ENV.parse :SHORT_PI , as: :float  # =&gt; ENV[‘SHORT_PI’] as a float: 3.1415926
 ```</p>
 
     <p>Note also that the <code>ENV.parse</code> and <code>ENV.register</code> binding is done safely and without polluting the method space for other objects.</p>
@@ -248,14 +248,14 @@ ENV.parse :SHORT_PI , as: :float  ## =&gt; ENV[‘SHORT_PI’] as a float: 3.141
     <p>If the <code>ENV</code> variable you want is unset (<code>nil</code>) or blank (<code>''</code>), the return value is a sensible default for the given <strong><em>as</em></strong> type: 0 or 0.0 for numbers, an empty string/array/hash, etc. Sometimes you want a non-trivial default, however. The <strong><em>if_unset</em></strong> option lets you specify a default that better meets your needs.</p>
 
     <p><code>ruby
-ENV.parse :MISSING_VAR, as: :integer  ## =&gt; 0
-ENV.parse :MISSING_VAR, as: :integer, if_unset: 250  ## =&gt; 250
+ENV.parse :MISSING_VAR, as: :integer  # =&gt; 0
+ENV.parse :MISSING_VAR, as: :integer, if_unset: 250  # =&gt; 250
 </code></p>
 
     <p>Note these default values are used as-is with no type conversion, so exercise caution.</p>
 
     <p><code>ruby
-ENV.parse :MISSING_VAR, as: :integer, if_unset: 'Careful!'  ## =&gt; 'Careful!' (NOT AN INTEGER)
+ENV.parse :MISSING_VAR, as: :integer, if_unset: 'Careful!'  # =&gt; 'Careful!' (NOT AN INTEGER)
 </code></p>
   </li>
   <li>
@@ -267,9 +267,9 @@ ENV.parse :MISSING_VAR, as: :integer, if_unset: 'Careful!'  ## =&gt; 'Careful!'
 ENV.parse :API_TO_USE, as: :symbol, from_set: %i[internal external]
 ENV.parse :NETWORK_PORT, as: :integer, from_set: (1..65535), if_unset: 80</p>
 
-    <h2 id="and-if-the-value-is-not-in-the-allowed-set-">And if the value is not in the allowed set …</h2>
-    <p>##
-ENV.parse :TWELVE, as: :integer, from_set: (1..5)  ## =&gt; raises EnvParser::ValueNotAllowedError
+    <h1 id="and-if-the-value-is-not-in-the-allowed-set-">And if the value is not in the allowed set …</h1>
+    <p>#
+ENV.parse :TWELVE, as: :integer, from_set: (1..5)  # =&gt; raises EnvParser::ValueNotAllowedError
 ```</p>
   </li>
   <li>
@@ -278,12 +278,12 @@ ENV.parse :TWELVE, as: :integer, from_set: (1..5)  ## =&gt; raises EnvParser::Va
     <p>You can write your own, more complex validations by passing in a <strong><em>validated_by</em></strong> lambda or an equivalent block. The lambda/block should take one value and return true if the given value passes the custom validation.</p>
 
     <p>```ruby
-## Via a “validated_by” lambda …
-##
+# Via a “validated_by” lambda …
+#
 ENV.parse :MUST_BE_LOWERCASE, as: :string, validated_by: -&gt;(value) { value == value.downcase }</p>
 
-    <h2 id="or-with-a-block">… or with a block!</h2>
-    <p>##
+    <h1 id="or-with-a-block">… or with a block!</h1>
+    <p>#
 ENV.parse(:MUST_BE_LOWERCASE, as: :string) { |value| value == value.downcase }
 ENV.parse(:CONNECTION_RETRIES, as: :integer, &amp;:positive?)
 ```</p>
@@ -347,7 +347,7 @@ EnvParser.register :USERNAME, as: :string
 EnvParser.register :PASSWORD, as: :string
 EnvParser.register :MOCK_API, as: :boolean, within: MyClassOrModule }</p>
 
-    <h2 id="is-equivalent-to--1">… is equivalent to …</h2>
+    <h1 id="is-equivalent-to--1">… is equivalent to …</h1>
 
     <p>EnvParser.register USERNAME: { as: :string                           },
                    PASSWORD: { as: :string                           },
@@ -396,7 +396,7 @@ USERNAME:
 </div></div>
 
       <div id="footer">
-  Generated on Sun Dec 25 21:09:36 2022 by
+  Generated on Fri Dec 30 17:49:58 2022 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.28 (ruby-3.0.4).
 </div>

data/docs/top-level-namespace.html

@@ -100,7 +100,7 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Dec 25 21:09:36 2022 by
+  Generated on Fri Dec 30 17:49:58 2022 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.28 (ruby-3.0.4).
 </div>

data/env_parser.gemspec

@@ -21,11 +21,10 @@ Gem::Specification.new do |spec|
   spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.add_dependency 'activesupport', ['>= 6.1.0', '< 7.1']
-  spec.add_dependency 'chronic'
-  spec.add_dependency 'chronic_duration'
+  spec.add_dependency 'chronic', '~> 0'
+  spec.add_dependency 'chronic_duration', '~> 0'
 
   spec.add_development_dependency 'bundler', '~> 2'
-  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '~> 3'
   spec.add_development_dependency 'rspec_junit_formatter'
   spec.add_development_dependency 'rubocop'

data/lib/env_parser/types/internet_types.rb

@@ -48,6 +48,18 @@ module EnvParser::Types
   #         Note this does not guarantee RFC5322-conformity.
   #       </td>
   #     </tr>
+  #     <tr>
+  #       <td>:version / :semver</td>
+  #       <td>MatchData</td>
+  #       <td><code>nil</code></td>
+  #       <td>
+  #         The resulting MatchData has named captures for "major", "minor", "patch", "prerelease", and "buildmetadata".
+  #         <br />
+  #         The Regex used for generating this MatchData is available at: https://regex101.com/r/Ly7O1x/3/
+  #         <br />
+  #         See https://semver.org for additional info.
+  #       </td>
+  #     </tr>
   #   </tbody>
   # </table>
   #
@@ -95,5 +107,15 @@ module EnvParser::Types
 
       value
     end
+
+    EnvParser.define_type(:version, aliases: :semver, if_unset: nil) do |value|
+      # We're using the official semver.org-provided regex.
+      semver = %r{^(?<major>0|[1-9]\d*)\.(?<minor>0|[1-9]\d*)\.(?<patch>0|[1-9]\d*)(?:-(?<prerelease>(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+(?<buildmetadata>[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$} ## rubocop:disable Layout/LineLength
+
+      match_data = value.match(semver)
+      raise(EnvParser::ValueNotConvertibleError, 'not a semver-compliant value') unless match_data
+
+      match_data
+    end
   end
 end

data/lib/env_parser/version.rb

@@ -1,3 +1,3 @@
 class EnvParser
-  VERSION = '1.3.3'.freeze
+  VERSION = '1.6.1'.freeze
 end

data/lib/env_parser.rb

@@ -132,12 +132,12 @@ class EnvParser
     # variable names and whose values are the options set for each variable's {.register} call.
     #
     # <pre>
-    #   ## Example shortcut usage:
+    #   # Example shortcut usage:
     #
     #   EnvParser.register :A, from: one_hash, as: :integer
     #   EnvParser.register :B, from: another_hash, as: :string, if_unset: 'none'
     #
-    #   ## ... is equivalent to ...
+    #   # ... is equivalent to ...
     #
     #   EnvParser.register(
     #     A: { from: one_hash, as: :integer }
@@ -152,6 +152,19 @@ class EnvParser
     # @option options [Hash] from (ENV)
     #   The source Hash from which to pull the value referenced by the "name" key.
     #
+    # @option options [Symbol] named
+    #   The name the constant should be given. Valid only when a "within" value is *explicitly*
+    #   given. This allows for decoupling ENV variable names from the constant name defined
+    #   within its target class or module, allowing for the ENV variables to be namespaced in
+    #   some way.
+    #
+    #   <pre>
+    #     EnvParser.register(
+    #       CUSTOM_CLIENT_DEFAULT_HOSTNAME: { as: :string, named: :DEFAULT_HOSTNAME, within: CustomClient },
+    #       CUSTOM_CLIENT_DEFAULT_PORT: { as: :integer, named: :DEFAULT_PORT, within: CustomClient }
+    #     )
+    #   </pre>
+    #
     # @option options [Module, Class] within (Kernel)
     #   The module or class in which the constant should be created. Creates global constants by
     #   default.
@@ -185,6 +198,9 @@ class EnvParser
       from = options.fetch(:from, ENV)
       within = options.fetch(:within, Kernel)
 
+      named = name
+      named = options.fetch(:named, name) if options.key? :within
+
       # ENV *seems* like a Hash and it does *some* Hash-y things, but it is NOT a Hash and that can
       # bite you in some cases. Making sure we're working with a straight-up Hash saves a lot of
       # sanity checks later on. This is also a good place to make sure we're working with a String
@@ -199,7 +215,7 @@ class EnvParser
 
       value = from[name]
       value = parse(value, options, &validation_block)
-      within.const_set(name.upcase.to_sym, value.dup.freeze)
+      within.const_set(named.upcase.to_sym, value.dup.freeze)
 
       value
     end
@@ -248,7 +264,7 @@ class EnvParser
 
       autoregister_spec.deep_symbolize_keys!
       autoregister_spec.transform_values! do |spec|
-        sanitized = spec.slice(:as, :within, :if_unset, :from_set)
+        sanitized = spec.slice(:as, :named, :within, :if_unset, :from_set)
         sanitized[:as] = sanitized[:as].to_sym if sanitized.key? :as
         sanitized[:within] = sanitized[:within].constantize if sanitized.key? :within
 

data/spec/env_parser/types/internet_types_spec.rb

@@ -42,4 +42,54 @@ RSpec.describe EnvParser::Types::InternetTypes do
 
     expect { EnvParser.parse('not an email address', as: :email_address) }.to raise_error(EnvParser::ValueNotConvertibleError)
   end
+
+  it 'can parse version numbers' do
+    %i[version semver].each do |type|
+      expect(EnvParser.parse(nil, as: type)).to eq(nil)
+      expect(EnvParser.parse('', as: type)).to eq(nil)
+
+      # Our list of valid version strings is a subset of those in the official semver.org-provided regex suite.
+      # rubocop:disable Layout
+      #
+      valid_version_strings = {
+        '0.0.4'                 => { major: '0' , minor: '0', patch: '4', prerelease: nil           , buildmetadata: nil          },
+        '1.2.3'                 => { major: '1' , minor: '2', patch: '3', prerelease: nil           , buildmetadata: nil          },
+        '1.1.2-prerelease+meta' => { major: '1' , minor: '1', patch: '2', prerelease: 'prerelease'  , buildmetadata: 'meta'       },
+        '1.1.2+meta'            => { major: '1' , minor: '1', patch: '2', prerelease: nil           , buildmetadata: 'meta'       },
+        '1.1.2+meta-valid'      => { major: '1' , minor: '1', patch: '2', prerelease: nil           , buildmetadata: 'meta-valid' },
+        '1.0.0-alpha'           => { major: '1' , minor: '0', patch: '0', prerelease: 'alpha'       , buildmetadata: nil          },
+        '1.0.0-beta'            => { major: '1' , minor: '0', patch: '0', prerelease: 'beta'        , buildmetadata: nil          },
+        '1.0.0-alpha.beta'      => { major: '1' , minor: '0', patch: '0', prerelease: 'alpha.beta'  , buildmetadata: nil          },
+        '1.0.0-alpha.beta.1'    => { major: '1' , minor: '0', patch: '0', prerelease: 'alpha.beta.1', buildmetadata: nil          },
+        '1.0.0-alpha.1'         => { major: '1' , minor: '0', patch: '0', prerelease: 'alpha.1'     , buildmetadata: nil          },
+        '1.0.0-alpha0.valid'    => { major: '1' , minor: '0', patch: '0', prerelease: 'alpha0.valid', buildmetadata: nil          },
+        '1.0.0-alpha.0valid'    => { major: '1' , minor: '0', patch: '0', prerelease: 'alpha.0valid', buildmetadata: nil          },
+        '1.0.0-rc.1+build.1'    => { major: '1' , minor: '0', patch: '0', prerelease: 'rc.1'        , buildmetadata: 'build.1'    },
+        '2.0.0-rc.1+build.123'  => { major: '2' , minor: '0', patch: '0', prerelease: 'rc.1'        , buildmetadata: 'build.123'  },
+        '1.2.3-beta'            => { major: '1' , minor: '2', patch: '3', prerelease: 'beta'        , buildmetadata: nil          },
+        '10.2.3-DEV-SNAPSHOT'   => { major: '10', minor: '2', patch: '3', prerelease: 'DEV-SNAPSHOT', buildmetadata: nil          },
+        '1.2.3-SNAPSHOT-123'    => { major: '1' , minor: '2', patch: '3', prerelease: 'SNAPSHOT-123', buildmetadata: nil          },
+        '2.0.0+build.1848'      => { major: '2' , minor: '0', patch: '0', prerelease: nil           , buildmetadata: 'build.1848' },
+        '2.0.1-alpha.1227'      => { major: '2' , minor: '0', patch: '1', prerelease: 'alpha.1227'  , buildmetadata: nil          },
+        '1.0.0-alpha+beta'      => { major: '1' , minor: '0', patch: '0', prerelease: 'alpha'       , buildmetadata: 'beta'       },
+        '1.0.0-0A.is.legal'     => { major: '1' , minor: '0', patch: '0', prerelease: '0A.is.legal' , buildmetadata: nil          }
+      }
+      # rubocop:enable Layout
+
+      valid_version_strings.each do |version, expected_matches|
+        parsed_value = EnvParser.parse(version, as: type)
+
+        expect(parsed_value).to_not eq(nil)
+        expected_matches.each { |match_name, expected_value| expect(parsed_value[match_name]).to eq(expected_value) }
+      end
+
+      # Our list of invalid version strings is a subset of those in the official semver.org-provided regex suite.
+      #
+      invalid_version_strings = ['1', '1.2', '1.2.3-0123', '1.2.3-0123.0123', '1.1.2+.123', '+invalid', '-invalid', '-invalid+invalid',
+                                 '-invalid.01', 'alpha', 'alpha.1', 'alpha+beta', '1.0.0-alpha..', '1.0.0-alpha..1', '01.1.1', '1.01.1',
+                                 '1.1.01', '1.2.3.DEV', '1.2-SNAPSHOT', '+justmeta', '9.8.7+meta+meta', '9.8.7-whatever+meta+meta']
+
+      invalid_version_strings.each { |version| expect { EnvParser.parse(version, as: type) }.to raise_error(EnvParser::ValueNotConvertibleError) }
+    end
+  end
 end

data/spec/env_parser_spec.rb

@@ -60,9 +60,16 @@ RSpec.describe EnvParser do
     end
 
     it 'creates module constants' do
-      source_hash = { XYZ: '456' }
-      EnvParser.register(:XYZ, from: source_hash, as: :integer, within: Sample)
-      expect(Sample::XYZ).to eq(456)
+      source_hash = { DEF: '456' }
+      EnvParser.register(:DEF, from: source_hash, as: :integer, within: Sample)
+      expect(Sample::DEF).to eq(456)
+    end
+
+    it 'creates named module constants' do
+      source_hash = { GHI: '789' }
+      EnvParser.register(:GHI, from: source_hash, as: :integer, named: :JKL, within: Sample)
+      expect { Sample::GHI }.to raise_error(NameError)
+      expect(Sample::JKL).to eq(789)
     end
 
     it 'will accept a hash keyed by variable names' do
@@ -117,6 +124,13 @@ RSpec.describe EnvParser do
         expect(Sample::WXYZ).to eq(5678)
       end
 
+      it 'creates module constants' do
+        ENV['ORIGINAL_NAME'] = '9999'
+        ENV.register(:ORIGINAL_NAME, as: :integer, named: :DIFFERENT_NAME, within: Sample)
+        expect { Sample::ORIGINAL_NAME }.to raise_error(NameError)
+        expect(Sample::DIFFERENT_NAME).to eq(9999)
+      end
+
       it 'will accept a hash keyed by variable names' do
         ENV['FIFTH'] = 'fifth'
         ENV['SIXTH'] = '99'
@@ -156,6 +170,11 @@ RSpec.describe EnvParser do
           CLASS_CONSTANT:
             as: :string
             within: String
+
+          NAMED_CLASS_CONSTANT:
+            as: :string
+            named: :OTHER_CLASS_CONSTANT
+            within: String
         YAML
 
         file.path
@@ -164,11 +183,14 @@ RSpec.describe EnvParser do
       ENV['SOME_INT'] = '99'
       ENV['SOME_STRING'] = 'twelve'
       ENV['CLASS_CONSTANT'] = 'tricky'
+      ENV['NAMED_CLASS_CONSTANT'] = 'quizzical'
       EnvParser.autoregister filename
 
       expect(SOME_INT).to eq(99)
       expect(SOME_STRING).to eq('twelve')
       expect(String::CLASS_CONSTANT).to eq('tricky')
+      expect { String::NAMED_CLASS_CONSTANT }.to raise_error(NameError)
+      expect(String::OTHER_CLASS_CONSTANT).to eq('quizzical')
     end
 
     it 'properly handles file-not-found' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: env_parser
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.6.1
 platform: ruby
 authors:
 - Nestor Custodio
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-26 00:00:00.000000000 Z
+date: 2023-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -34,28 +34,28 @@ dependencies:
   name: chronic
   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'
 - !ruby/object:Gem::Dependency
   name: chronic_duration
   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'
 - !ruby/object:Gem::Dependency
@@ -72,20 +72,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
-- !ruby/object:Gem::Dependency
-  name: rake
-  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'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement