env_parser 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 824a4026a34c07f38be413d43c95c1a58b65794f
-  data.tar.gz: 4a94816516c1925f887aaba58ff670af1189b3f8
+  metadata.gz: 1074b534666060176bf44c5b5d96c91ebf87f13e
+  data.tar.gz: a4bbaf7ec568cf6fb1a3c8adb75b0ba36e0abfcc
 SHA512:
-  metadata.gz: 9ed47eb04f852943956de4fb37cf0a866c0ad9647405734e572c9994f2ff800cb18f57423a7db90766583eeaffd7394d61b5a5b5996d9a9833eec1cb2c54cb1f
-  data.tar.gz: 1e0cbd84c815baf0d9359825279379b8abdc61e8aebadc7aadbb7739bad1e14b335822fec2217ad7fb3c80832a62e562dc9276fa255c6c8e695f43641c7d3756
+  metadata.gz: '0778ff18e226b11676ac3ef7b2c0d4ec939ce6ca5a272e5d2ddbfc29827ff29bb1fe96d5028190fa4deec42858a1235de02ca783fa04902c4eca140e62d0ff12'
+  data.tar.gz: 4e11313dca4ee78652b0dbe34af9d47b8bf7a61aa5ed7ebc7d119d8ada62a5b2d4d977caf194e6f88f0d4591e2fc902eaed9bd6ea665faa12fcfc07347cb69ee

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    env_parser (0.5.0)
+    env_parser (0.6.0)
       activesupport (>= 5.0.0)
 
 GEM

data/README.md

@@ -24,9 +24,9 @@ Or install it yourself as:
     $ gem install env_parser
 
 
-## Usage
+## Using EnvParser
 
-#### Basic EnvParser usage:
+#### Basic Usage
 
 ```ruby
 ## Returns ENV['TIMEOUT_MS'] as an Integer.
@@ -93,7 +93,7 @@ The named `:as` parameter is required. Allowed values are:
 Note JSON is parsed using *quirks-mode* (meaning 'true', '25', and 'null' are all considered valid, parseable JSON).
 
 
-#### Setting non-trivial defaults:
+#### Setting Non-Trivial Defaults
 
 ```ruby
 ## If the ENV variable you want is unset (nil) or blank (''),
@@ -110,7 +110,7 @@ EnvParser.parse :MISSING_ENV_VARIABLE, as: :integer, if_unset: 'Whoops!' ## => '
 ```
 
 
-#### Validation of parsed ENV values:
+#### Validating Parsed ENV Values
 
 ```ruby
 ## Sometimes setting the type alone is a bit too open-ended.
@@ -124,7 +124,8 @@ EnvParser.parse :SOME_CUSTOM_NETWORK_PORT, as: :integer, from_set: (1..65535), i
 EnvParser.parse :NEGATIVE_NUMBER, as: :integer, from_set: (1..5) ## => raises EnvParser::ValueNotAllowed
 ```
 
-#### Turning ENV values into constants:
+
+#### Setting Constants From ENV Values
 
 ```ruby
 ## Global constants...
@@ -139,17 +140,14 @@ ENV['ULTIMATE_LINK'] ## => 'https://youtu.be/L_jWHffIx5E' (Set elsewhere, like a
 EnvParser.register :ULTIMATE_LINK, as: :string, within: URI
 URI::ULTIMATE_LINK ## => 'https://youtu.be/L_jWHffIx5E' (You know you want to check it out!)
 ULTIMATE_LINK ## => raises NameError (the un-namespaced constant is only in scope within the URI module)
-```
 
-#### Quickly registering multiple ENV-derived constants:
 
-```ruby
 ## You can also set multiple constants in one call, which is considerably cleaner to read:
 ##
 EnvParser.register :A, as: :string
 EnvParser.register :B, as: :integer, if_unset: 25
 EnvParser.register :C, as: :boolean, if_unset: true
-##
+
 ## ... is equivalent to ...
 ##
 EnvParser.register(
@@ -159,6 +157,23 @@ EnvParser.register(
 )
 ```
 
+
+#### Binding EnvParser Proxies Onto ENV
+
+```ruby
+## To allow for even cleaner usage, you can bind proxy "parse" and "register" methods onto ENV.
+## This is done cleanly and without polluting the method space for any other objects.
+##
+EnvParser.add_env_bindings ## Sets up the proxy methods.
+
+## Now you can call "parse" and "register" on ENV itself. Note that ENV's proxy "parse" method will
+## attempt to interpret any value given as an ENV key (converting to a String, if necessary).
+##
+ENV['SHORT_PI'] ## => '3.1415926'
+ENV.parse :SHORT_PI, as: :float ## => 3.1415926
+ENV.register :SHORT_PI, as: :float ## Your constant is set, my man!
+```
+
 ---
 
 [Consult the repo docs](http://nestor-custodio.github.io/env_parser) for the full EnvParser documentation.
@@ -167,7 +182,6 @@ EnvParser.register(
 ## Feature Roadmap / Future Development
 
 Additional features/options coming in the future:
-- A means to **optionally** bind `#parse`, `#regiter`, and `#register_all` methods onto `ENV`. Because `ENV.parse ...` reads better than `EnvParser.parse ...`.
 - A `validator` option that lets you pass in a validator lambda/block for things more complex than what a simple `from_set` can enforce.
 - A means to register validation blocks as new "as" types. This will allow for custom "as" types like `:url`, `:email`, etc.
 - ... ?

data/docs/EnvParser/ValueNotAllowed.html

@@ -126,7 +126,7 @@ option.</p>
 </div>
 
       <div id="footer">
-  Generated on Sun Dec  3 14:43:03 2017 by
+  Generated on Sun Dec  3 16:33:44 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.11 (ruby-2.4.2).
 </div>

data/docs/EnvParser.html

@@ -130,7 +130,7 @@ different data types.</p>
       <dt id="VERSION-constant" class="">VERSION =
         
       </dt>
-      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.5.0</span><span class='tstring_end'>&#39;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.6.0</span><span class='tstring_end'>&#39;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
     
   </dl>
 
@@ -151,6 +151,31 @@ different data types.</p>
         <li class="public ">
   <span class="summary_signature">
     
+      <a href="#add_env_bindings-class_method" title="add_env_bindings (class method)">.<strong>add_env_bindings</strong>  &#x21d2; ENV </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Creates ENV bindings for EnvParser.parse and EnvParser.register proxy
+methods.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
       <a href="#parse-class_method" title="parse (class method)">.<strong>parse</strong>(value, options = {})  &#x21d2; Object </a>
     
 
@@ -207,7 +232,92 @@ requested context.</p>
 
     
       <div class="method_details first">
-  <h3 class="signature first" id="parse-class_method">
+  <h3 class="signature first" id="add_env_bindings-class_method">
+  
+    .<strong>add_env_bindings</strong>  &#x21d2; <tt>ENV</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Creates ENV bindings for EnvParser.parse and EnvParser.register proxy
+methods.</p>
+
+<p>The sole difference between these proxy methods and their EnvParser
+counterparts is that ENV.parse will interpret any value given as an ENV key
+(as a String), not the given value itself. i.e. ENV.parse(&#39;XYZ&#39;, …)
+is equivalent to <a href="'XYZ'">EnvParser.parse(ENV</a>, …)</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>ENV</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>This generates no usable value, so we may as well return ENV for chaining?</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+160
+161
+162
+163
+164
+165
+166
+167
+168
+169
+170
+171
+172</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/env_parser.rb', line 160</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_add_env_bindings'>add_env_bindings</span>
+  <span class='const'>ENV</span><span class='period'>.</span><span class='id identifier rubyid_instance_eval'>instance_eval</span> <span class='kw'>do</span>
+    <span class='kw'>def</span> <span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
+      <span class='const'><span class='object_link'><a href="" title="EnvParser (class)">EnvParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse'><span class='object_link'><a href="#parse-class_method" title="EnvParser.parse (method)">parse</a></span></span><span class='lparen'>(</span><span class='kw'>self</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
+    <span class='kw'>end</span>
+
+    <span class='kw'>def</span> <span class='id identifier rubyid_register'>register</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
+      <span class='const'><span class='object_link'><a href="" title="EnvParser (class)">EnvParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_register'><span class='object_link'><a href="#register-class_method" title="EnvParser.register (method)">register</a></span></span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
+    <span class='kw'>end</span>
+  <span class='kw'>end</span>
+
+  <span class='const'>ENV</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="parse-class_method">
   
     .<strong>parse</strong>(value, options = {})  &#x21d2; <tt>Object</tt> 
   
@@ -450,8 +560,8 @@ the same keys as those in the “from” Hash and each value being the
   ## ... is equivalent to ...
 
   EnvParser.register(
-    A: { from: ENV, as: :integer }
-    B: { from: other_hash, as: :string, if_unset: &#39;none&#39; }
+    A: { from: one_hash, as: :integer }
+    B: { from: another_hash, as: :string, if_unset: &#39;none&#39; }
   )
 </code></pre>
 
@@ -670,7 +780,7 @@ Kernel (making it a global constant).</p>
 </div>
 
       <div id="footer">
-  Generated on Sun Dec  3 14:43:03 2017 by
+  Generated on Sun Dec  3 16:33:44 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.11 (ruby-2.4.2).
 </div>

data/docs/_index.html

@@ -112,7 +112,7 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Dec  3 14:43:03 2017 by
+  Generated on Sun Dec  3 16:33:43 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.11 (ruby-2.4.2).
 </div>

data/docs/file.README.html

@@ -91,9 +91,9 @@ simple.</p>
 
 <pre class="code ruby"><code class="ruby">$ gem install env_parser</code></pre>
 
-<h2 id="label-Usage">Usage</h2>
+<h2 id="label-Using+EnvParser">Using EnvParser</h2>
 
-<h4 id="label-Basic+EnvParser+usage-3A">Basic EnvParser usage:</h4>
+<h4 id="label-Basic+Usage">Basic Usage</h4>
 
 <pre class="code ruby"><code class="ruby"><span class='comment'>## Returns ENV[&#39;TIMEOUT_MS&#39;] as an Integer.
 </span><span class='comment'>## Yields 0 if ENV[&#39;TIMEOUT_MS&#39;] is unset or nil.
@@ -155,7 +155,7 @@ simple.</p>
 <p>Note JSON is parsed using <em>quirks-mode</em> (meaning &#39;true&#39;,
 &#39;25&#39;, and &#39;null&#39; are all considered valid, parseable JSON).</p>
 
-<h4 id="label-Setting+non-trivial+defaults-3A">Setting non-trivial defaults:</h4>
+<h4 id="label-Setting+Non-Trivial+Defaults">Setting Non-Trivial Defaults</h4>
 
 <pre class="code ruby"><code class="ruby"><span class='comment'>## If the ENV variable you want is unset (nil) or blank (&#39;&#39;),
 </span><span class='comment'>## the return value is a sensible default for the given &quot;as&quot; type
@@ -170,7 +170,7 @@ simple.</p>
 </span><span class='const'><span class='object_link'><a href="EnvParser.html" title="EnvParser (class)">EnvParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse'><span class='object_link'><a href="EnvParser.html#parse-class_method" title="EnvParser.parse (method)">parse</a></span></span> <span class='symbol'>:MISSING_ENV_VARIABLE</span><span class='comma'>,</span> <span class='label'>as:</span> <span class='symbol'>:integer</span><span class='comma'>,</span> <span class='label'>if_unset:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Whoops!</span><span class='tstring_end'>&#39;</span></span> <span class='comment'>## =&gt; &#39;Whoops!&#39;
 </span></code></pre>
 
-<h4 id="label-Validation+of+parsed+ENV+values-3A">Validation of parsed ENV values:</h4>
+<h4 id="label-Validating+Parsed+ENV+Values">Validating Parsed ENV Values</h4>
 
 <pre class="code ruby"><code class="ruby"><span class='comment'>## Sometimes setting the type alone is a bit too open-ended.
 </span><span class='comment'>## The &quot;from_set&quot; option lets you restrict the set of allowed values.
@@ -183,7 +183,7 @@ simple.</p>
 </span><span class='const'><span class='object_link'><a href="EnvParser.html" title="EnvParser (class)">EnvParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse'><span class='object_link'><a href="EnvParser.html#parse-class_method" title="EnvParser.parse (method)">parse</a></span></span> <span class='symbol'>:NEGATIVE_NUMBER</span><span class='comma'>,</span> <span class='label'>as:</span> <span class='symbol'>:integer</span><span class='comma'>,</span> <span class='label'>from_set:</span> <span class='lparen'>(</span><span class='int'>1</span><span class='op'>..</span><span class='int'>5</span><span class='rparen'>)</span> <span class='comment'>## =&gt; raises EnvParser::ValueNotAllowed
 </span></code></pre>
 
-<h4 id="label-Turning+ENV+values+into+constants-3A">Turning ENV values into constants:</h4>
+<h4 id="label-Setting+Constants+From+ENV+Values">Setting Constants From ENV Values</h4>
 
 <pre class="code ruby"><code class="ruby"><span class='comment'>## Global constants...
 </span><span class='comment'>##
@@ -197,17 +197,15 @@ simple.</p>
 </span><span class='const'><span class='object_link'><a href="EnvParser.html" title="EnvParser (class)">EnvParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_register'><span class='object_link'><a href="EnvParser.html#register-class_method" title="EnvParser.register (method)">register</a></span></span> <span class='symbol'>:ULTIMATE_LINK</span><span class='comma'>,</span> <span class='label'>as:</span> <span class='symbol'>:string</span><span class='comma'>,</span> <span class='label'>within:</span> <span class='const'>URI</span>
 <span class='const'>URI</span><span class='op'>::</span><span class='const'>ULTIMATE_LINK</span> <span class='comment'>## =&gt; &#39;https://youtu.be/L_jWHffIx5E&#39; (You know you want to check it out!)
 </span><span class='const'>ULTIMATE_LINK</span> <span class='comment'>## =&gt; raises NameError (the un-namespaced constant is only in scope within the URI module)
-</span></code></pre>
-
-<h4 id="label-Quickly+registering+multiple+ENV-derived+constants-3A">Quickly registering multiple ENV-derived constants:</h4>
+</span>
 
-<pre class="code ruby"><code class="ruby"><span class='comment'>## You can also set multiple constants in one call, which is considerably cleaner to read:
+<span class='comment'>## You can also set multiple constants in one call, which is considerably cleaner to read:
 </span><span class='comment'>##
 </span><span class='const'><span class='object_link'><a href="EnvParser.html" title="EnvParser (class)">EnvParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_register'><span class='object_link'><a href="EnvParser.html#register-class_method" title="EnvParser.register (method)">register</a></span></span> <span class='symbol'>:A</span><span class='comma'>,</span> <span class='label'>as:</span> <span class='symbol'>:string</span>
 <span class='const'><span class='object_link'><a href="EnvParser.html" title="EnvParser (class)">EnvParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_register'><span class='object_link'><a href="EnvParser.html#register-class_method" title="EnvParser.register (method)">register</a></span></span> <span class='symbol'>:B</span><span class='comma'>,</span> <span class='label'>as:</span> <span class='symbol'>:integer</span><span class='comma'>,</span> <span class='label'>if_unset:</span> <span class='int'>25</span>
 <span class='const'><span class='object_link'><a href="EnvParser.html" title="EnvParser (class)">EnvParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_register'><span class='object_link'><a href="EnvParser.html#register-class_method" title="EnvParser.register (method)">register</a></span></span> <span class='symbol'>:C</span><span class='comma'>,</span> <span class='label'>as:</span> <span class='symbol'>:boolean</span><span class='comma'>,</span> <span class='label'>if_unset:</span> <span class='kw'>true</span>
-<span class='comment'>##
-</span><span class='comment'>## ... is equivalent to ...
+
+<span class='comment'>## ... is equivalent to ...
 </span><span class='comment'>##
 </span><span class='const'><span class='object_link'><a href="EnvParser.html" title="EnvParser (class)">EnvParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_register'><span class='object_link'><a href="EnvParser.html#register-class_method" title="EnvParser.register (method)">register</a></span></span><span class='lparen'>(</span>
   <span class='label'>A:</span> <span class='lbrace'>{</span> <span class='label'>as:</span> <span class='symbol'>:string</span> <span class='rbrace'>}</span><span class='comma'>,</span>
@@ -215,6 +213,21 @@ simple.</p>
   <span class='label'>C:</span> <span class='lbrace'>{</span> <span class='label'>as:</span> <span class='symbol'>:boolean</span><span class='comma'>,</span> <span class='label'>if_unset:</span> <span class='kw'>true</span> <span class='rbrace'>}</span>
 <span class='rparen'>)</span>
 </code></pre>
+
+<h4 id="label-Binding+EnvParser+Proxies+Onto+ENV">Binding EnvParser Proxies Onto ENV</h4>
+
+<pre class="code ruby"><code class="ruby"><span class='comment'>## To allow for even cleaner usage, you can bind proxy &quot;parse&quot; and &quot;register&quot; methods onto ENV.
+</span><span class='comment'>## This is done cleanly and without polluting the method space for any other objects.
+</span><span class='comment'>##
+</span><span class='const'><span class='object_link'><a href="EnvParser.html" title="EnvParser (class)">EnvParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_add_env_bindings'><span class='object_link'><a href="EnvParser.html#add_env_bindings-class_method" title="EnvParser.add_env_bindings (method)">add_env_bindings</a></span></span> <span class='comment'>## Sets up the proxy methods.
+</span>
+<span class='comment'>## Now you can call &quot;parse&quot; and &quot;register&quot; on ENV itself. Note that ENV&#39;s proxy &quot;parse&quot; method will
+</span><span class='comment'>## attempt to interpret any value given as an ENV key (converting to a String, if necessary).
+</span><span class='comment'>##
+</span><span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>SHORT_PI</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='comment'>## =&gt; &#39;3.1415926&#39;
+</span><span class='const'>ENV</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span> <span class='symbol'>:SHORT_PI</span><span class='comma'>,</span> <span class='label'>as:</span> <span class='symbol'>:float</span> <span class='comment'>## =&gt; 3.1415926
+</span><span class='const'>ENV</span><span class='period'>.</span><span class='id identifier rubyid_register'>register</span> <span class='symbol'>:SHORT_PI</span><span class='comma'>,</span> <span class='label'>as:</span> <span class='symbol'>:float</span> <span class='comment'>## Your constant is set, my man!
+</span></code></pre>
 <hr>
 
 <p><a href="http://nestor-custodio.github.io/env_parser">Consult the repo
@@ -222,15 +235,12 @@ docs</a> for the full EnvParser documentation.</p>
 
 <h2 id="label-Feature+Roadmap+-2F+Future+Development">Feature Roadmap / Future Development</h2>
 
-<p>Additional features/options coming in the future: - A means to
-<strong>optionally</strong> bind <code>#parse</code>,
-<code>#regiter</code>, and <code>#register_all</code> methods onto
-<code>ENV</code>. Because <code>ENV.parse ...</code> reads better than
-<code>EnvParser.parse ...</code>. - A <code>validator</code> option that
-lets you pass in a validator lambda/block for things more complex than what
-a simple <code>from_set</code> can enforce. - A means to register
-validation blocks as new “as” types. This will allow for custom “as” types
-like <code>:url</code>, <code>:email</code>, etc. - … ?</p>
+<p>Additional features/options coming in the future: - A
+<code>validator</code> option that lets you pass in a validator
+lambda/block for things more complex than what a simple
+<code>from_set</code> can enforce. - A means to register validation blocks
+as new “as” types. This will allow for custom “as” types like
+<code>:url</code>, <code>:email</code>, etc. - … ?</p>
 
 <h2 id="label-Contribution+-2F+Development">Contribution / Development</h2>
 
@@ -261,7 +271,7 @@ href="https://opensource.org/licenses/MIT">MIT License</a>.</p>
 </div></div>
 
       <div id="footer">
-  Generated on Sun Dec  3 14:43:03 2017 by
+  Generated on Sun Dec  3 16:33:43 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.11 (ruby-2.4.2).
 </div>

data/docs/index.html

@@ -91,9 +91,9 @@ simple.</p>
 
 <pre class="code ruby"><code class="ruby">$ gem install env_parser</code></pre>
 
-<h2 id="label-Usage">Usage</h2>
+<h2 id="label-Using+EnvParser">Using EnvParser</h2>
 
-<h4 id="label-Basic+EnvParser+usage-3A">Basic EnvParser usage:</h4>
+<h4 id="label-Basic+Usage">Basic Usage</h4>
 
 <pre class="code ruby"><code class="ruby"><span class='comment'>## Returns ENV[&#39;TIMEOUT_MS&#39;] as an Integer.
 </span><span class='comment'>## Yields 0 if ENV[&#39;TIMEOUT_MS&#39;] is unset or nil.
@@ -155,7 +155,7 @@ simple.</p>
 <p>Note JSON is parsed using <em>quirks-mode</em> (meaning &#39;true&#39;,
 &#39;25&#39;, and &#39;null&#39; are all considered valid, parseable JSON).</p>
 
-<h4 id="label-Setting+non-trivial+defaults-3A">Setting non-trivial defaults:</h4>
+<h4 id="label-Setting+Non-Trivial+Defaults">Setting Non-Trivial Defaults</h4>
 
 <pre class="code ruby"><code class="ruby"><span class='comment'>## If the ENV variable you want is unset (nil) or blank (&#39;&#39;),
 </span><span class='comment'>## the return value is a sensible default for the given &quot;as&quot; type
@@ -170,7 +170,7 @@ simple.</p>
 </span><span class='const'><span class='object_link'><a href="EnvParser.html" title="EnvParser (class)">EnvParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse'><span class='object_link'><a href="EnvParser.html#parse-class_method" title="EnvParser.parse (method)">parse</a></span></span> <span class='symbol'>:MISSING_ENV_VARIABLE</span><span class='comma'>,</span> <span class='label'>as:</span> <span class='symbol'>:integer</span><span class='comma'>,</span> <span class='label'>if_unset:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Whoops!</span><span class='tstring_end'>&#39;</span></span> <span class='comment'>## =&gt; &#39;Whoops!&#39;
 </span></code></pre>
 
-<h4 id="label-Validation+of+parsed+ENV+values-3A">Validation of parsed ENV values:</h4>
+<h4 id="label-Validating+Parsed+ENV+Values">Validating Parsed ENV Values</h4>
 
 <pre class="code ruby"><code class="ruby"><span class='comment'>## Sometimes setting the type alone is a bit too open-ended.
 </span><span class='comment'>## The &quot;from_set&quot; option lets you restrict the set of allowed values.
@@ -183,7 +183,7 @@ simple.</p>
 </span><span class='const'><span class='object_link'><a href="EnvParser.html" title="EnvParser (class)">EnvParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_parse'><span class='object_link'><a href="EnvParser.html#parse-class_method" title="EnvParser.parse (method)">parse</a></span></span> <span class='symbol'>:NEGATIVE_NUMBER</span><span class='comma'>,</span> <span class='label'>as:</span> <span class='symbol'>:integer</span><span class='comma'>,</span> <span class='label'>from_set:</span> <span class='lparen'>(</span><span class='int'>1</span><span class='op'>..</span><span class='int'>5</span><span class='rparen'>)</span> <span class='comment'>## =&gt; raises EnvParser::ValueNotAllowed
 </span></code></pre>
 
-<h4 id="label-Turning+ENV+values+into+constants-3A">Turning ENV values into constants:</h4>
+<h4 id="label-Setting+Constants+From+ENV+Values">Setting Constants From ENV Values</h4>
 
 <pre class="code ruby"><code class="ruby"><span class='comment'>## Global constants...
 </span><span class='comment'>##
@@ -197,17 +197,15 @@ simple.</p>
 </span><span class='const'><span class='object_link'><a href="EnvParser.html" title="EnvParser (class)">EnvParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_register'><span class='object_link'><a href="EnvParser.html#register-class_method" title="EnvParser.register (method)">register</a></span></span> <span class='symbol'>:ULTIMATE_LINK</span><span class='comma'>,</span> <span class='label'>as:</span> <span class='symbol'>:string</span><span class='comma'>,</span> <span class='label'>within:</span> <span class='const'>URI</span>
 <span class='const'>URI</span><span class='op'>::</span><span class='const'>ULTIMATE_LINK</span> <span class='comment'>## =&gt; &#39;https://youtu.be/L_jWHffIx5E&#39; (You know you want to check it out!)
 </span><span class='const'>ULTIMATE_LINK</span> <span class='comment'>## =&gt; raises NameError (the un-namespaced constant is only in scope within the URI module)
-</span></code></pre>
-
-<h4 id="label-Quickly+registering+multiple+ENV-derived+constants-3A">Quickly registering multiple ENV-derived constants:</h4>
+</span>
 
-<pre class="code ruby"><code class="ruby"><span class='comment'>## You can also set multiple constants in one call, which is considerably cleaner to read:
+<span class='comment'>## You can also set multiple constants in one call, which is considerably cleaner to read:
 </span><span class='comment'>##
 </span><span class='const'><span class='object_link'><a href="EnvParser.html" title="EnvParser (class)">EnvParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_register'><span class='object_link'><a href="EnvParser.html#register-class_method" title="EnvParser.register (method)">register</a></span></span> <span class='symbol'>:A</span><span class='comma'>,</span> <span class='label'>as:</span> <span class='symbol'>:string</span>
 <span class='const'><span class='object_link'><a href="EnvParser.html" title="EnvParser (class)">EnvParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_register'><span class='object_link'><a href="EnvParser.html#register-class_method" title="EnvParser.register (method)">register</a></span></span> <span class='symbol'>:B</span><span class='comma'>,</span> <span class='label'>as:</span> <span class='symbol'>:integer</span><span class='comma'>,</span> <span class='label'>if_unset:</span> <span class='int'>25</span>
 <span class='const'><span class='object_link'><a href="EnvParser.html" title="EnvParser (class)">EnvParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_register'><span class='object_link'><a href="EnvParser.html#register-class_method" title="EnvParser.register (method)">register</a></span></span> <span class='symbol'>:C</span><span class='comma'>,</span> <span class='label'>as:</span> <span class='symbol'>:boolean</span><span class='comma'>,</span> <span class='label'>if_unset:</span> <span class='kw'>true</span>
-<span class='comment'>##
-</span><span class='comment'>## ... is equivalent to ...
+
+<span class='comment'>## ... is equivalent to ...
 </span><span class='comment'>##
 </span><span class='const'><span class='object_link'><a href="EnvParser.html" title="EnvParser (class)">EnvParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_register'><span class='object_link'><a href="EnvParser.html#register-class_method" title="EnvParser.register (method)">register</a></span></span><span class='lparen'>(</span>
   <span class='label'>A:</span> <span class='lbrace'>{</span> <span class='label'>as:</span> <span class='symbol'>:string</span> <span class='rbrace'>}</span><span class='comma'>,</span>
@@ -215,6 +213,21 @@ simple.</p>
   <span class='label'>C:</span> <span class='lbrace'>{</span> <span class='label'>as:</span> <span class='symbol'>:boolean</span><span class='comma'>,</span> <span class='label'>if_unset:</span> <span class='kw'>true</span> <span class='rbrace'>}</span>
 <span class='rparen'>)</span>
 </code></pre>
+
+<h4 id="label-Binding+EnvParser+Proxies+Onto+ENV">Binding EnvParser Proxies Onto ENV</h4>
+
+<pre class="code ruby"><code class="ruby"><span class='comment'>## To allow for even cleaner usage, you can bind proxy &quot;parse&quot; and &quot;register&quot; methods onto ENV.
+</span><span class='comment'>## This is done cleanly and without polluting the method space for any other objects.
+</span><span class='comment'>##
+</span><span class='const'><span class='object_link'><a href="EnvParser.html" title="EnvParser (class)">EnvParser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_add_env_bindings'><span class='object_link'><a href="EnvParser.html#add_env_bindings-class_method" title="EnvParser.add_env_bindings (method)">add_env_bindings</a></span></span> <span class='comment'>## Sets up the proxy methods.
+</span>
+<span class='comment'>## Now you can call &quot;parse&quot; and &quot;register&quot; on ENV itself. Note that ENV&#39;s proxy &quot;parse&quot; method will
+</span><span class='comment'>## attempt to interpret any value given as an ENV key (converting to a String, if necessary).
+</span><span class='comment'>##
+</span><span class='const'>ENV</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>SHORT_PI</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='comment'>## =&gt; &#39;3.1415926&#39;
+</span><span class='const'>ENV</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span> <span class='symbol'>:SHORT_PI</span><span class='comma'>,</span> <span class='label'>as:</span> <span class='symbol'>:float</span> <span class='comment'>## =&gt; 3.1415926
+</span><span class='const'>ENV</span><span class='period'>.</span><span class='id identifier rubyid_register'>register</span> <span class='symbol'>:SHORT_PI</span><span class='comma'>,</span> <span class='label'>as:</span> <span class='symbol'>:float</span> <span class='comment'>## Your constant is set, my man!
+</span></code></pre>
 <hr>
 
 <p><a href="http://nestor-custodio.github.io/env_parser">Consult the repo
@@ -222,15 +235,12 @@ docs</a> for the full EnvParser documentation.</p>
 
 <h2 id="label-Feature+Roadmap+-2F+Future+Development">Feature Roadmap / Future Development</h2>
 
-<p>Additional features/options coming in the future: - A means to
-<strong>optionally</strong> bind <code>#parse</code>,
-<code>#regiter</code>, and <code>#register_all</code> methods onto
-<code>ENV</code>. Because <code>ENV.parse ...</code> reads better than
-<code>EnvParser.parse ...</code>. - A <code>validator</code> option that
-lets you pass in a validator lambda/block for things more complex than what
-a simple <code>from_set</code> can enforce. - A means to register
-validation blocks as new “as” types. This will allow for custom “as” types
-like <code>:url</code>, <code>:email</code>, etc. - … ?</p>
+<p>Additional features/options coming in the future: - A
+<code>validator</code> option that lets you pass in a validator
+lambda/block for things more complex than what a simple
+<code>from_set</code> can enforce. - A means to register validation blocks
+as new “as” types. This will allow for custom “as” types like
+<code>:url</code>, <code>:email</code>, etc. - … ?</p>
 
 <h2 id="label-Contribution+-2F+Development">Contribution / Development</h2>
 
@@ -261,7 +271,7 @@ href="https://opensource.org/licenses/MIT">MIT License</a>.</p>
 </div></div>
 
       <div id="footer">
-  Generated on Sun Dec  3 14:43:03 2017 by
+  Generated on Sun Dec  3 16:33:43 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.11 (ruby-2.4.2).
 </div>

data/docs/method_list.html

@@ -46,13 +46,21 @@
 
   <li class="odd ">
     <div class="item">
-      <span class='object_link'><a href="EnvParser.html#parse-class_method" title="EnvParser.parse (method)">parse</a></span>
+      <span class='object_link'><a href="EnvParser.html#add_env_bindings-class_method" title="EnvParser.add_env_bindings (method)">add_env_bindings</a></span>
       <small>EnvParser</small>
     </div>
   </li>
   
 
   <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="EnvParser.html#parse-class_method" title="EnvParser.parse (method)">parse</a></span>
+      <small>EnvParser</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="EnvParser.html#register-class_method" title="EnvParser.register (method)">register</a></span>
       <small>EnvParser</small>

data/docs/top-level-namespace.html

@@ -100,7 +100,7 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Dec  3 14:43:03 2017 by
+  Generated on Sun Dec  3 16:33:43 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.11 (ruby-2.4.2).
 </div>

data/lib/env_parser/version.rb

@@ -1,3 +1,3 @@
 class EnvParser
-  VERSION = '0.5.0'.freeze
+  VERSION = '0.6.0'.freeze
 end

data/lib/env_parser.rb

@@ -89,8 +89,8 @@ class EnvParser
     ##   ## ... is equivalent to ...
     ##
     ##   EnvParser.register(
-    ##     A: { from: ENV, as: :integer }
-    ##     B: { from: other_hash, as: :string, if_unset: 'none' }
+    ##     A: { from: one_hash, as: :integer }
+    ##     B: { from: another_hash, as: :string, if_unset: 'none' }
     ##   )
     ## </pre>
     ##
@@ -148,6 +148,29 @@ class EnvParser
       value
     end
 
+    ## Creates ENV bindings for EnvParser.parse and EnvParser.register proxy methods.
+    ##
+    ## The sole difference between these proxy methods and their EnvParser counterparts is that
+    ## ENV.parse will interpret any value given as an ENV key (as a String), not the given value
+    ## itself.  i.e. ENV.parse('XYZ', ...) is equivalent to EnvParser.parse(ENV['XYZ'], ...)
+    ##
+    ## @return [ENV]
+    ##   This generates no usable value, so we may as well return ENV for chaining?
+    ##
+    def add_env_bindings
+      ENV.instance_eval do
+        def parse(name, options = {})
+          EnvParser.parse(self[name.to_s], options)
+        end
+
+        def register(*args)
+          EnvParser.register(*args)
+        end
+      end
+
+      ENV
+    end
+
     private
 
     def parse_string(value)
@@ -206,6 +229,9 @@ class EnvParser
     ##
     ## @param set [Array, Range]
     ##
+    ## @return [nil]
+    ##   This generates no usable value.
+    ##
     ## @raise [ArgumentError, EnvParser::ValueNotAllowed]
     ##
     def check_for_set_inclusion(value, set: nil)
@@ -218,6 +244,8 @@ class EnvParser
       end
 
       raise ValueNotAllowed, 'parsed value not in allowed list/range' unless set.include?(value)
+
+      nil
     end
 
     ## Receives a list of "register" calls to make, as a Hash keyed with variable names and the

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: env_parser
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Nestor Custodio