env_parser 1.6.0 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4106f96ced2bcf4948b4547012b017e8632bf43450e86d9639eaf54aa9802ffb
-  data.tar.gz: c6e54495905a39126f320226a118b6c83405860a8ec502e7711e28ed9ad57de9
+  metadata.gz: 49fc4d98baf7f0810b2004cbdbe8fbf36005687424f0cc004d24b62c79d2b45e
+  data.tar.gz: c2f88238cdb5ec67ddaadc263c7f292ba5865e9420b9077b7b34fdb2d656e42a
 SHA512:
-  metadata.gz: 2fb35a0bee0ec626b5c070e426cd5214ce42e9be4eef861ce922c9ee0366c75dbddfcf9b352ca5c5d5806cd0e35ed25575181e35babf56b4b748260133215d46
-  data.tar.gz: ddc6daa85de95c97f2a914f8ff563c9e6fd128f14ca8566a2af153458a6d782fe73831b60d34b503e7beee00285d069354a216ef5b1b261a5a4072d5fa7930ed
+  metadata.gz: 695f1b93430886690218f21350b736df06ca5898cc6b73e91203c364bb015952bf58c9b8b5554a124a69e3667581a68d62a841d0cecc8b1c4df9065b86d13b05
+  data.tar.gz: f3b240045d7ae612414caad94602642d5b25d1297680befcc9315edfb998d1712a77b9fbc65dfd774190dcffb599251bf30c4d7309b2f2f7fcf842c189bd5cbb

data/.circleci/config.yml

@@ -2,12 +2,12 @@
 #
 # Check https://circleci.com/docs/2.0/language-ruby/ for more details
 #
-version: 2
+version: 2.1
 jobs:
   build:
     docker:
       # specify the version you desire here
-       - image: cimg/ruby:3.0
+       - image: cimg/ruby:3.4
 
       # Specify service dependencies here if necessary
       # CircleCI maintains a library of pre-built images
@@ -34,7 +34,7 @@ jobs:
       - run:
           name: install dependencies
           command: |
-            bundle install --jobs=4 --retry=3 --path vendor/bundle
+            bundle install --jobs=$(nproc) --retry=3 --path vendor/bundle
 
       - save_cache:
           paths:

data/.ruby-version

@@ -1 +1 @@
-3.0
+3.4

data/Gemfile.lock

@@ -1,71 +1,92 @@
 PATH
   remote: .
   specs:
-    env_parser (1.3.3)
-      activesupport (>= 6.1.0, < 7.1)
-      chronic
-      chronic_duration
+    env_parser (1.6.1)
+      activesupport (>= 6.1.0, < 9)
+      chronic (~> 0)
+      chronic_duration (~> 0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+    activesupport (8.0.2)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    ast (2.4.2)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    ast (2.4.3)
+    base64 (0.3.0)
+    benchmark (0.4.1)
+    bigdecimal (3.2.2)
     chronic (0.10.2)
     chronic_duration (0.10.6)
       numerizer (~> 0.1.1)
-    concurrent-ruby (1.1.10)
-    diff-lcs (1.5.0)
-    i18n (1.12.0)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.3)
+    diff-lcs (1.6.2)
+    drb (2.2.3)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    json (2.6.3)
-    minitest (5.16.3)
+    json (2.12.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    minitest (5.25.5)
     numerizer (0.1.1)
-    parallel (1.22.1)
-    parser (3.1.3.0)
+    parallel (1.27.0)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.6.1)
-    rexml (3.2.5)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.0)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.1)
+    regexp_parser (2.10.0)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.4)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.4)
     rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.41.1)
+    rubocop (1.76.1)
       json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.23.0, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.45.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.24.0)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
-    tzinfo (2.0.5)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.45.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.3.0)
-    webrick (1.7.0)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    uri (1.0.3)
+    yard (0.9.37)
 
 PLATFORMS
   ruby
@@ -73,7 +94,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
@@ -41,19 +41,20 @@ Things can get out of control pretty fast, especially as the number of environme
 ```ruby
 # 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
+EnvParser.parse env_key_as_a_symbol,
+                as: …,                         # ➜ required; Symbol
+                if_unset: …,                   # ➜ optional; default value (of any type)
+                from_set: …,                   # ➜ optional; Array or Range
                 validated_by: ->(value) { … }  # ➜ optional; may also be given as a block
 
 # 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
+EnvParser.register env_key_as_a_symbol,
+                   as: …,                         # ➜ required; Symbol
+                   named: …,                      # ➜ optional; String or Symbol; available only if `within` is also given
+                   within: …,                     # ➜ optional; Class or Module
+                   if_unset: …,                   # ➜ optional; default value (of any type)
+                   from_set: …,                   # ➜ optional; 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":
@@ -119,6 +120,18 @@ EnvParser.add_env_bindings  # ENV.parse will now be a proxy for EnvParser.parse
   BEST_VIDEO  # => raises NameError
   ```
 
+  `EnvParser.register`'s **_within_** option also allows for specifying what you would like the registered constant to be **_named_**, since related ENV variables will tend to have redundant names once namespaced within a single class or module. Note that `named` is only available when used alongside `within`, as it exists solely as a namespacing aid; registering ENV variables as *global* constants with different names would be a debugging nightmare.
+
+  ```ruby
+  ENV['CUSTOM_CLIENT_DEFAULT_HOSTNAME']  # => 'localhost'
+  ENV['CUSTOM_CLIENT_DEFAULT_PORT'    ]  # => '3000'
+
+  EnvParser.register :CUSTOM_CLIENT_DEFAULT_HOSTNAME, as: :string , named: :DEFAULT_HOSTNAME, within: CustomClient
+  EnvParser.register :CUSTOM_CLIENT_DEFAULT_PORT    , as: :integer, named: :DEFAULT_PORT    , within: CustomClient
+  CustomClient::DEFAULT_HOSTNAME  # => 'localhost'
+  CustomClient::DEFAULT_PORT      # => 3000
+  ```
+
   You can also register multiple constants with a single call, which is a bit cleaner.
 
   ```ruby
@@ -181,7 +194,7 @@ EnvParser.add_env_bindings  # ENV.parse will now be a proxy for EnvParser.parse
   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.
+  Note these default values are used as-is, with no type conversion (because sometimes you just want `nil` 🤷), so exercise caution.
 
   ```ruby
   ENV.parse :MISSING_VAR, as: :integer, if_unset: 'Careful!'  # => 'Careful!' (NOT AN INTEGER)
@@ -202,7 +215,7 @@ EnvParser.add_env_bindings  # ENV.parse will now be a proxy for EnvParser.parse
 
 - **Custom Validation Of Parsed Values**
 
-  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.
+  You can write your own, more complex validations by passing in a **_validated_by_** lambda or an equivalent block. The lambda/block should expect one value (of the requested **_as_** type) and return true if the given value passes the custom validation.
 
   ```ruby
   # Via a "validated_by" lambda ...
@@ -250,7 +263,7 @@ EnvParser.add_env_bindings  # ENV.parse will now be a proxy for EnvParser.parse
 
 - **The `autoregister` Call**
 
-  Consolidating all of your `EnvParser.register` calls into a single place only makes sense. A single `EnvParser.autoregister` call take a filename to read and process as a series of constant registration requests. If no filename is given, the default `".env_parser.yml"` is assumed.
+  Consolidating all of your `EnvParser.register` calls into a single place only makes sense. A single `EnvParser.autoregister` call takes a filename to read and process as a series of constant registration requests. If no filename is given, the default `".env_parser.yml"` is assumed.
 
   You'll normally want to call `EnvParser.autoregister` as early in your application as possible. For Rails applications (and other frameworks that call `require 'bundler/setup'`), requiring the EnvParser gem via ...
 
@@ -292,7 +305,7 @@ EnvParser.add_env_bindings  # ENV.parse will now be a proxy for EnvParser.parse
     within: MyClassOrModule
   ```
 
-  Because no Ruby *statements* can be safely represented via YAML, the set of `EnvParser.register` options available via autoregistration is limited to **_as_**, **_within_**, **_if_unset_**, and **_from_set_**. As an additional restriction, **_from_set_** (if given) must be an array, as ranges cannot be represented in YAML.
+  Because no Ruby *statements* can be safely represented via YAML, the set of `EnvParser.register` options available via autoregistration is limited to **_as_**, **_named_**, **_within_**, **_if_unset_**, and **_from_set_**. As an additional restriction, **_from_set_** (if given) must be an array, as ranges cannot be represented in YAML.
 
 
 ## Feature Roadmap / Future Development

data/docs/EnvParser/AutoregisterFileNotFound.html

@@ -6,7 +6,7 @@
 <title>
   Exception: EnvParser::AutoregisterFileNotFound
   
-    &mdash; Documentation by YARD 0.9.28
+    &mdash; Documentation by YARD 0.9.37
   
 </title>
 
@@ -133,9 +133,9 @@ feature).</p>
 </div>
 
       <div id="footer">
-  Generated on Sun Dec 25 21:11:48 2022 by
+  Generated on Mon Jun  9 14:00:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.28 (ruby-3.0.4).
+  0.9.37 (ruby-3.4.2).
 </div>
 
     </div>

data/docs/EnvParser/Error.html

@@ -6,7 +6,7 @@
 <title>
   Exception: EnvParser::Error
   
-    &mdash; Documentation by YARD 0.9.28
+    &mdash; Documentation by YARD 0.9.37
   
 </title>
 
@@ -128,9 +128,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Dec 25 21:11:48 2022 by
+  Generated on Mon Jun  9 14:00:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.28 (ruby-3.0.4).
+  0.9.37 (ruby-3.4.2).
 </div>
 
     </div>

data/docs/EnvParser/TypeAlreadyDefinedError.html

@@ -6,7 +6,7 @@
 <title>
   Exception: EnvParser::TypeAlreadyDefinedError
   
-    &mdash; Documentation by YARD 0.9.28
+    &mdash; Documentation by YARD 0.9.37
   
 </title>
 
@@ -132,9 +132,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Dec 25 21:11:48 2022 by
+  Generated on Mon Jun  9 14:00:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.28 (ruby-3.0.4).
+  0.9.37 (ruby-3.4.2).
 </div>
 
     </div>

data/docs/EnvParser/Types/BaseTypes.html

@@ -6,7 +6,7 @@
 <title>
   Module: EnvParser::Types::BaseTypes
   
-    &mdash; Documentation by YARD 0.9.28
+    &mdash; Documentation by YARD 0.9.37
   
 </title>
 
@@ -169,9 +169,9 @@ valid, parseable JSON).</p>
 </div>
 
       <div id="footer">
-  Generated on Sun Dec 25 21:11:48 2022 by
+  Generated on Mon Jun  9 14:00:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.28 (ruby-3.0.4).
+  0.9.37 (ruby-3.4.2).
 </div>
 
     </div>

data/docs/EnvParser/Types/ChronologyTypes.html

@@ -6,7 +6,7 @@
 <title>
   Module: EnvParser::Types::ChronologyTypes
   
-    &mdash; Documentation by YARD 0.9.28
+    &mdash; Documentation by YARD 0.9.37
   
 </title>
 
@@ -150,9 +150,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Dec 25 21:11:48 2022 by
+  Generated on Mon Jun  9 14:00:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.28 (ruby-3.0.4).
+  0.9.37 (ruby-3.4.2).
 </div>
 
     </div>

data/docs/EnvParser/Types/InternetTypes.html

@@ -6,7 +6,7 @@
 <title>
   Module: EnvParser::Types::InternetTypes
   
-    &mdash; Documentation by YARD 0.9.28
+    &mdash; Documentation by YARD 0.9.37
   
 </title>
 
@@ -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,9 +162,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Dec 25 21:11:48 2022 by
+  Generated on Mon Jun  9 14:00:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.28 (ruby-3.0.4).
+  0.9.37 (ruby-3.4.2).
 </div>
 
     </div>

data/docs/EnvParser/Types.html

@@ -6,7 +6,7 @@
 <title>
   Module: EnvParser::Types
   
-    &mdash; Documentation by YARD 0.9.28
+    &mdash; Documentation by YARD 0.9.37
   
 </title>
 
@@ -118,9 +118,9 @@ Exists only for documentation’s sake.</p>
 </div>
 
       <div id="footer">
-  Generated on Sun Dec 25 21:11:48 2022 by
+  Generated on Mon Jun  9 14:00:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.28 (ruby-3.0.4).
+  0.9.37 (ruby-3.4.2).
 </div>
 
     </div>

data/docs/EnvParser/UnknownTypeError.html

@@ -6,7 +6,7 @@
 <title>
   Exception: EnvParser::UnknownTypeError
   
-    &mdash; Documentation by YARD 0.9.28
+    &mdash; Documentation by YARD 0.9.37
   
 </title>
 
@@ -132,9 +132,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Dec 25 21:11:48 2022 by
+  Generated on Mon Jun  9 14:00:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.28 (ruby-3.0.4).
+  0.9.37 (ruby-3.4.2).
 </div>
 
     </div>

data/docs/EnvParser/UnparseableAutoregisterSpec.html

@@ -6,7 +6,7 @@
 <title>
   Exception: EnvParser::UnparseableAutoregisterSpec
   
-    &mdash; Documentation by YARD 0.9.28
+    &mdash; Documentation by YARD 0.9.37
   
 </title>
 
@@ -133,9 +133,9 @@ feature).</p>
 </div>
 
       <div id="footer">
-  Generated on Sun Dec 25 21:11:48 2022 by
+  Generated on Mon Jun  9 14:00:26 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.28 (ruby-3.0.4).
+  0.9.37 (ruby-3.4.2).
 </div>
 
     </div>

data/docs/EnvParser/ValueNotAllowedError.html

@@ -6,7 +6,7 @@
 <title>
   Exception: EnvParser::ValueNotAllowedError
   
-    &mdash; Documentation by YARD 0.9.28
+    &mdash; Documentation by YARD 0.9.37
   
 </title>
 
@@ -134,9 +134,9 @@ check.</p>
 </div>
 
       <div id="footer">
-  Generated on Sun Dec 25 21:11:48 2022 by
+  Generated on Mon Jun  9 14:00:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.28 (ruby-3.0.4).
+  0.9.37 (ruby-3.4.2).
 </div>
 
     </div>

data/docs/EnvParser/ValueNotConvertibleError.html

@@ -6,7 +6,7 @@
 <title>
   Exception: EnvParser::ValueNotConvertibleError
   
-    &mdash; Documentation by YARD 0.9.28
+    &mdash; Documentation by YARD 0.9.37
   
 </title>
 
@@ -132,9 +132,9 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Dec 25 21:11:48 2022 by
+  Generated on Mon Jun  9 14:00:25 2025 by
   <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.28 (ruby-3.0.4).
+  0.9.37 (ruby-3.4.2).
 </div>
 
     </div>