env_parser 1.3.3 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dffb38fe58381e11c8b63aebe34fccaec31e4c59c5a1c61274824e0c09aaf9e3
-  data.tar.gz: '088dfcdefdcc661b1d344526da81007e6bfa274b93b0b512807705543f9591c2'
+  metadata.gz: 897f5a82aae1f8d7c418937e61f72669eba8d846c5ee282bffd7f4ee72970f96
+  data.tar.gz: 6b90041b9ea794d896c9f603e8117377482fdaecb682cda49a925fd9dbdc22a9
 SHA512:
-  metadata.gz: 0cbf4b4148bf9c4040358d7bd90d4f722fee975f6966f459026e53d7d5692e7f8167fd99fa67c0c97bfa590e0d5753e32021db3cd496d4c0a5ee5bb3865131a5
-  data.tar.gz: 1a268110295c48d65a186e6113ef174d5aa51f7491f6c88f41f38ac7d9243fc794cc499e933b51010c3e3773fcca6225ab3cffede4a46a28c9ba66317e85ccc7
+  metadata.gz: cc132c2bdb3feffef9f294dae4ae929533e65da860e93b360290e655625011640f773f02596cfda8570e87e95877bc5a3c814cc8b23f43078bcf0b99dea4cdf9
+  data.tar.gz: c5d8ff0e7378ff6c94f104bcf1d35ec71ab4952b7fd3826854818b7d01f6a45f000697b5dcc173babcafa073dc6eb25def9721df60210b47be4afc936e4eebfe

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    env_parser (1.3.2)
+    env_parser (1.6.0)
       activesupport (>= 6.1.0, < 7.1)
-      chronic
-      chronic_duration
+      chronic (~> 0)
+      chronic_duration (~> 0)
 
 GEM
   remote: https://rubygems.org/
@@ -29,7 +29,6 @@ GEM
     parser (3.1.3.0)
       ast (~> 2.4.1)
     rainbow (3.1.1)
-    rake (13.0.6)
     regexp_parser (2.6.1)
     rexml (3.2.5)
     rspec (3.12.0)
@@ -73,7 +72,6 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2)
   env_parser!
-  rake
   rspec (~> 3)
   rspec_junit_formatter
   rubocop

data/README.md

@@ -1,5 +1,5 @@
 [![Gem Version](https://img.shields.io/github/v/release/nestor-custodio/env_parser?color=green&label=gem%20version)](https://rubygems.org/gems/env_parser)
-[![MIT License](https://img.shields.io/github/license/nestor-custodio/env_parser)](https://github.com/nestor-custodio/env_parser/blob/main/LICENSE.txt)
+[![MIT License](https://img.shields.io/github/license/nestor-custodio/env_parser)](https://tldrlegal.com/license/mit-license)
 
 
 # EnvParser
@@ -16,13 +16,13 @@ Things can get out of control pretty fast, especially as the number of environme
 - If your project uses [Bundler](https://github.com/bundler/bundler):
   - Add one of the following to your application's Gemfile:
     ```ruby
-    ## For on-demand usage ...
-    ##
+    # For on-demand usage ...
+    #
     gem 'env_parser'
 
-    ## To automatically register ENV
-    ## constants per ".env_parser.yml" ...
-    ##
+    # To automatically register ENV
+    # constants per ".env_parser.yml" ...
+    #
     gem 'env_parser', require: 'env_parser/autoregister'
     ```
   - And then run a:
@@ -39,33 +39,33 @@ Things can get out of control pretty fast, especially as the number of environme
 ## Syntax Cheat Sheet
 
 ```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: ->(value) { … }  ## ➜ optional; may also be given as a block
+                as: …                          # ➜ required
+                if_unset: …                    # ➜ optional; default value
+                from_set: …                    # ➜ optional; an Array or Range
+                validated_by: ->(value) { … }  # ➜ optional; may also be given as a block
 
-## Parse an ENV value and register it as a constant:
-##
+# Parse an ENV value and register it as a constant:
+#
 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: ->(value) { … }  ## ➜ optional; may also be given as a block
-
-## Registers all ENV variables as spec'ed in ".env_parser.yml":
-##
-EnvParser.autoregister  ## Note this is automatically called if your
-                        ## Gemfile included the "env_parser" gem with
-                        ## the "require: 'env_parser/autoregister'" option.
-
-## Lets you call "parse" and "register" on ENV itself:
-##
-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: ->(value) { … }  # ➜ optional; may also be given as a block
+
+# Registers all ENV variables as spec'ed in ".env_parser.yml":
+#
+EnvParser.autoregister  # Note this is automatically called if your
+                        # Gemfile included the "env_parser" gem with
+                        # the "require: 'env_parser/autoregister'" option.
+
+# Lets you call "parse" and "register" on ENV itself:
+#
+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
 ```
 
 
@@ -78,9 +78,9 @@ EnvParser.add_env_bindings  ## ENV.parse will now be a proxy for EnvParser.parse
   At its core, EnvParser is a straight-forward parser for string values (since that's all `ENV` ever gives you), allowing you to read a given string **_as_** a variety of types.
 
   ```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
   ```
 
@@ -91,9 +91,9 @@ EnvParser.add_env_bindings  ## ENV.parse will now be a proxy for EnvParser.parse
   EnvParser is all about ~~simplification~~ ~~less typing~~ *laziness*. If you pass in a symbol instead of a string, EnvParser will look to `ENV` and use the value from the corresponding (string) key.
 
   ```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
   ```
@@ -103,20 +103,20 @@ EnvParser.add_env_bindings  ## ENV.parse will now be a proxy for EnvParser.parse
   The `EnvParser.register` method lets you "promote" `ENV` variables into their own constants, already parsed into the correct type.
 
   ```ruby
-  ENV['API_KEY']  ## => 'unbreakable p4$$w0rd'
+  ENV['API_KEY']  # => 'unbreakable p4$$w0rd'
 
   EnvParser.register :API_KEY, as: :string
-  API_KEY  ## => 'unbreakable p4$$w0rd'
+  API_KEY  # => 'unbreakable p4$$w0rd'
   ```
 
   By default, `EnvParser.register` will create the requested constant within the Kernel module (making it available everywhere), but you can specify any class or module you like.
 
   ```ruby
-  ENV['BEST_VIDEO']  ## => 'https://youtu.be/L_jWHffIx5E'
+  ENV['BEST_VIDEO']  # => 'https://youtu.be/L_jWHffIx5E'
 
   EnvParser.register :BEST_VIDEO, as: :string, within: URI
-  URI::BEST_VIDEO  ## => 'https://youtu.be/L_jWHffIx5E'
-  BEST_VIDEO  ## => raises NameError
+  URI::BEST_VIDEO  # => 'https://youtu.be/L_jWHffIx5E'
+  BEST_VIDEO  # => raises NameError
   ```
 
   You can also register multiple constants with a single call, which is a bit cleaner.
@@ -126,7 +126,7 @@ EnvParser.add_env_bindings  ## ENV.parse will now be a proxy for EnvParser.parse
   EnvParser.register :PASSWORD, as: :string
   EnvParser.register :MOCK_API, as: :boolean, within: MyClassOrModule }
 
-  ## ... is equivalent to ... ##
+  # ... is equivalent to ... #
 
   EnvParser.register USERNAME: { as: :string                           },
                      PASSWORD: { as: :string                           },
@@ -138,31 +138,31 @@ EnvParser.add_env_bindings  ## ENV.parse will now be a proxy for EnvParser.parse
   Calling `EnvParser.add_env_bindings` binds proxy `parse` and `register` methods onto `ENV`. With these bindings in place, you can call `parse` or `register` on `ENV` itself, which is more legible and feels more straight-forward.
 
   ```ruby
-  ENV['SHORT_PI']  ## => '3.1415926'
-  ENV['BETTER_PI']  ## => '["flaky crust", "strawberry filling"]'
+  ENV['SHORT_PI']  # => '3.1415926'
+  ENV['BETTER_PI']  # => '["flaky crust", "strawberry filling"]'
 
-  ## Bind the proxy methods.
-  ##
+  # Bind the proxy methods.
+  #
   EnvParser.add_env_bindings
 
-  ENV.parse :SHORT_PI, as: :float  ## => 3.1415926
-  ENV.register :BETTER_PI, as: :array  ## Your constant is set!
+  ENV.parse :SHORT_PI, as: :float  # => 3.1415926
+  ENV.register :BETTER_PI, as: :array  # Your constant is set!
   ```
 
   Note that the proxy `ENV.parse` method will (naturally) *always* interpret the value given as an `ENV` key (converting it to a string, if necessary), which is slightly different from the original `EnvParser.parse` method.
 
   ```ruby
-  ENV['SHORT_PI']  ## => '3.1415926'
+  ENV['SHORT_PI']  # => '3.1415926'
 
-  EnvParser.parse 'SHORT_PI', as: :float  ## => 'SHORT_PI' as a float: 0.0
-  EnvParser.parse :SHORT_PI , as: :float  ## => ENV['SHORT_PI'] as a float: 3.1415926
+  EnvParser.parse 'SHORT_PI', as: :float  # => 'SHORT_PI' as a float: 0.0
+  EnvParser.parse :SHORT_PI , as: :float  # => ENV['SHORT_PI'] as a float: 3.1415926
 
-  ## Bind the proxy methods.
-  ##
+  # Bind the proxy methods.
+  #
   EnvParser.add_env_bindings
 
-  ENV.parse 'SHORT_PI', as: :float  ## => ENV['SHORT_PI'] as a float: 3.1415926
-  ENV.parse :SHORT_PI , as: :float  ## => ENV['SHORT_PI'] as a float: 3.1415926
+  ENV.parse 'SHORT_PI', as: :float  # => ENV['SHORT_PI'] as a float: 3.1415926
+  ENV.parse :SHORT_PI , as: :float  # => ENV['SHORT_PI'] as a float: 3.1415926
   ```
 
   Note also that the `ENV.parse` and `ENV.register` binding is done safely and without polluting the method space for other objects.
@@ -177,14 +177,14 @@ EnvParser.add_env_bindings  ## ENV.parse will now be a proxy for EnvParser.parse
   If the `ENV` variable you want is unset (`nil`) or blank (`''`), the return value is a sensible default for the given **_as_** type: 0 or 0.0 for numbers, an empty string/array/hash, etc. Sometimes you want a non-trivial default, however. The **_if_unset_** option lets you specify a default that better meets your needs.
 
   ```ruby
-  ENV.parse :MISSING_VAR, as: :integer  ## => 0
-  ENV.parse :MISSING_VAR, as: :integer, if_unset: 250  ## => 250
+  ENV.parse :MISSING_VAR, as: :integer  # => 0
+  ENV.parse :MISSING_VAR, as: :integer, if_unset: 250  # => 250
   ```
 
   Note these default values are used as-is with no type conversion, so exercise caution.
 
   ```ruby
-  ENV.parse :MISSING_VAR, as: :integer, if_unset: 'Careful!'  ## => 'Careful!' (NOT AN INTEGER)
+  ENV.parse :MISSING_VAR, as: :integer, if_unset: 'Careful!'  # => 'Careful!' (NOT AN INTEGER)
   ```
 
 - **Selecting From A Set**
@@ -195,9 +195,9 @@ EnvParser.add_env_bindings  ## ENV.parse will now be a proxy for EnvParser.parse
   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
 
-  ## And if the value is not in the allowed set ...
-  ##
-  ENV.parse :TWELVE, as: :integer, from_set: (1..5)  ## => raises EnvParser::ValueNotAllowedError
+  # And if the value is not in the allowed set ...
+  #
+  ENV.parse :TWELVE, as: :integer, from_set: (1..5)  # => raises EnvParser::ValueNotAllowedError
   ```
 
 - **Custom Validation Of Parsed Values**
@@ -205,12 +205,12 @@ EnvParser.add_env_bindings  ## ENV.parse will now be a proxy for EnvParser.parse
   You can write your own, more complex validations by passing in a **_validated_by_** lambda or an equivalent block. The lambda/block should take one value and return true if the given value passes the custom validation.
 
   ```ruby
-  ## Via a "validated_by" lambda ...
-  ##
+  # Via a "validated_by" lambda ...
+  #
   ENV.parse :MUST_BE_LOWERCASE, as: :string, validated_by: ->(value) { value == value.downcase }
 
-  ## ... or with a block!
-  ##
+  # ... or with a block!
+  #
   ENV.parse(:MUST_BE_LOWERCASE, as: :string) { |value| value == value.downcase }
   ENV.parse(:CONNECTION_RETRIES, as: :integer, &:positive?)
   ```
@@ -269,7 +269,7 @@ EnvParser.add_env_bindings  ## ENV.parse will now be a proxy for EnvParser.parse
   EnvParser.register :PASSWORD, as: :string
   EnvParser.register :MOCK_API, as: :boolean, within: MyClassOrModule }
 
-  ## ... is equivalent to ... ##
+  # ... is equivalent to ... #
 
   EnvParser.register USERNAME: { as: :string                           },
                      PASSWORD: { as: :string                           },

data/docs/EnvParser/AutoregisterFileNotFound.html

@@ -133,7 +133,7 @@ feature).</p>
 </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/EnvParser/Error.html

@@ -128,7 +128,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/docs/EnvParser/TypeAlreadyDefinedError.html

@@ -132,7 +132,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/docs/EnvParser/Types/BaseTypes.html

@@ -169,7 +169,7 @@ valid, parseable JSON).</p>
 </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/EnvParser/Types/ChronologyTypes.html

@@ -150,7 +150,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/docs/EnvParser/Types/InternetTypes.html

@@ -129,6 +129,18 @@
         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>
 
@@ -150,7 +162,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/docs/EnvParser/Types.html

@@ -118,7 +118,7 @@ Exists only for documentation’s sake.</p>
 </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/EnvParser/UnknownTypeError.html

@@ -132,7 +132,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/docs/EnvParser/UnparseableAutoregisterSpec.html

@@ -133,7 +133,7 @@ feature).</p>
 </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/EnvParser/ValueNotAllowedError.html

@@ -134,7 +134,7 @@ check.</p>
 </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/EnvParser/ValueNotConvertibleError.html

@@ -132,7 +132,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>