env_parser 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 996c5fec8869ff3a8103aba00de5f1a24e342b49
-  data.tar.gz: 31edfa384c9241b835856b3e80424c202c0b5a84
+  metadata.gz: 9709d56b0998b3cddaed366bbcbeec3c58a1eabf
+  data.tar.gz: 8d6566e451cfb918e26fd686582bb3dc2f106a8e
 SHA512:
-  metadata.gz: 1a60f7d00a885caa1ccc91adb3beaed8bcc010262e7d5c82b9524979e6919d7ffe8aea5ceed53407388b62f09c7d4d684a2bd259c84cce7e3ba0da7cdd711623
-  data.tar.gz: e1d19bce6fd537377c1a71458021883870ab3051869a4b410bbf1e1edf1fa3044cc736ebd86af62eb025098c284b3c7e87c33222c23fcfb6ba32538fdd3c5eed
+  metadata.gz: 7618c2104a3e48b625c9e6f9999fd1fb7308434b7c83b66c4f8880f1be369ecd4a96d1c9a4caba2bbcba50323e9f6aaefb2cfd7592a3664c61dacc165e03ba93
+  data.tar.gz: b4f4c4333d98ba7a20c9aa876fc649e66a127f6784b3bc770079f365c5def4ef70bcaae006cf21ca1d0beac09c5f20089f66123640386636d90fb24fefbff433

data/docs/EnvParser.html

@@ -141,7 +141,7 @@ different data types.</p>
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#parse-class_method" title="parse (class method)">.<strong>parse</strong>(value, as: nil)  &#x21d2; Object </a>
+      <a href="#parse-class_method" title="parse (class method)">.<strong>parse</strong>(value, options = {})  &#x21d2; Object </a>
     
 
     
@@ -174,7 +174,7 @@ different data types.</p>
       <div class="method_details first">
   <h3 class="signature first" id="parse-class_method">
   
-    .<strong>parse</strong>(value, as: nil)  &#x21d2; <tt>Object</tt> 
+    .<strong>parse</strong>(value, options = {})  &#x21d2; <tt>Object</tt> 
   
 
   
@@ -212,15 +212,40 @@ be used.</p>
   
     <li>
       
-        <span class='name'>:as</span>
+        <span class='name'>options</span>
       
       
-        <span class='type'>(<tt>Symbol</tt>)</span>
+        <span class='type'>(<tt>Hash</tt>)</span>
       
       
+        <em class="default">(defaults to: <tt>{}</tt>)</em>
+      
       
         &mdash;
         <div class='inline'>
+<p>a customizable set of options</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+  
+    
+    
+    
+    
+    <p class="tag_title">Options Hash (<tt>options</tt>):</p>
+    <ul class="option">
+      
+        <li>
+          <span class="name">as</span>
+          <span class="type">(<tt>Symbol</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
 <p>The expected return type. A best-effort attempt is made to convert the
 source String to the requested type. Valid “as” types are:</p>
 <ul><li>
@@ -241,10 +266,28 @@ source String to the requested type. Valid “as” types are:</p>
 <p><code>:hash</code></p>
 </li></ul>
 </div>
+          
+        </li>
       
-    </li>
+        <li>
+          <span class="name">if_unset</span>
+          <span class="type">(<tt>Object</tt>)</span>
+          <span class="default">
+            
+          </span>
+          
+            &mdash; <div class='inline'>
+<p>Specifies the default value to return if the given “value” is either nil or
+an empty String (&#39;&#39;). Any “if_unset” value given will be returned
+as-is, with no type conversion or other change having been made. If
+unspecified, the “default” value for nil/&#39;&#39; input will depend on
+the “as” type.</p>
+</div>
+          
+        </li>
+      
+    </ul>
   
-</ul>
 
 
 </div><table class="source_code">
@@ -253,13 +296,6 @@ source String to the requested type. Valid “as” types are:</p>
       <pre class="lines">
 
 
-26
-27
-28
-29
-30
-31
-32
 33
 34
 35
@@ -271,19 +307,30 @@ source String to the requested type. Valid “as” types are:</p>
 41
 42
 43
-44</pre>
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/env_parser.rb', line 26</span>
+      <pre class="code"><span class="info file"># File 'lib/env_parser.rb', line 33</span>
 
-<span class='kw'>def</span> <span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='label'>as:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</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='id identifier rubyid_value'>value</span> <span class='op'>=</span> <span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Symbol</span>
             <span class='const'>ENV</span><span class='lbracket'>[</span><span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rbracket'>]</span>
           <span class='kw'>else</span>
             <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
           <span class='kw'>end</span>
 
-  <span class='kw'>case</span> <span class='id identifier rubyid_as'>as</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
+  <span class='kw'>return</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:if_unset</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='symbol'>:if_unset</span><span class='rparen'>)</span>
+
+  <span class='kw'>case</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:as</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span>
   <span class='kw'>when</span> <span class='symbol'>:string</span> <span class='kw'>then</span> <span class='id identifier rubyid_parse_string'>parse_string</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
   <span class='kw'>when</span> <span class='symbol'>:symbol</span> <span class='kw'>then</span> <span class='id identifier rubyid_parse_symbol'>parse_symbol</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
   <span class='kw'>when</span> <span class='symbol'>:boolean</span> <span class='kw'>then</span> <span class='id identifier rubyid_parse_boolean'>parse_boolean</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
@@ -292,7 +339,7 @@ source String to the requested type. Valid “as” types are:</p>
   <span class='kw'>when</span> <span class='symbol'>:json</span> <span class='kw'>then</span> <span class='id identifier rubyid_parse_json'>parse_json</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
   <span class='kw'>when</span> <span class='symbol'>:array</span> <span class='kw'>then</span> <span class='id identifier rubyid_parse_array'>parse_array</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
   <span class='kw'>when</span> <span class='symbol'>:hash</span> <span class='kw'>then</span> <span class='id identifier rubyid_parse_hash'>parse_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
-  <span class='kw'>else</span> <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>invalid `as` parameter: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_as'>as</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
+  <span class='kw'>else</span> <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>invalid `as` parameter: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:as</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
   <span class='kw'>end</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -305,7 +352,7 @@ source String to the requested type. Valid “as” types are:</p>
 </div>
 
       <div id="footer">
-  Generated on Mon Nov 27 21:58:12 2017 by
+  Generated on Wed Nov 29 06:44:05 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

@@ -97,7 +97,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Nov 27 21:58:11 2017 by
+  Generated on Wed Nov 29 06:44:04 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

@@ -172,7 +172,7 @@ href="https://opensource.org/licenses/MIT">MIT License</a>.</p>
 </div></div>
 
       <div id="footer">
-  Generated on Mon Nov 27 21:58:12 2017 by
+  Generated on Wed Nov 29 06:44:05 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

@@ -172,7 +172,7 @@ href="https://opensource.org/licenses/MIT">MIT License</a>.</p>
 </div></div>
 
       <div id="footer">
-  Generated on Mon Nov 27 21:58:11 2017 by
+  Generated on Wed Nov 29 06:44:05 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/top-level-namespace.html

@@ -100,7 +100,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Nov 27 21:58:12 2017 by
+  Generated on Wed Nov 29 06:44:05 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.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/env_parser.rb

@@ -1,4 +1,5 @@
 require 'env_parser/version'
+require 'active_support/all'
 
 ## The EnvParser class simplifies parsing of environment variables as different data types.
 ##
@@ -10,7 +11,7 @@ class EnvParser
     ##   The value to parse/interpret. If a String is given, the value will be used as-is. If a
     ##   Symbol is given, the ENV value for the matching string key will be used.
     ##
-    ## @param :as [Symbol]
+    ## @option options as [Symbol]
     ##   The expected return type. A best-effort attempt is made to convert the source String to the
     ##   requested type. Valid "as" types are:
     ##
@@ -23,14 +24,22 @@ class EnvParser
     ##   - `:array`
     ##   - `:hash`
     ##
-    def parse(value, as: nil)
+    ## @option options if_unset
+    ##   Specifies the default value to return if the given "value" is either nil or an empty String
+    ##   (''). Any "if_unset" value given will be returned as-is, with no type conversion or other
+    ##   change having been made.  If unspecified, the "default" value for nil/'' input will depend
+    ##   on the "as" type.
+    ##
+    def parse(value, options = {})
       value = if value.is_a? Symbol
                 ENV[value.to_s]
               else
                 value.to_s
               end
 
-      case as.to_sym
+      return options[:if_unset] if value.blank? && options.key?(:if_unset)
+
+      case options[:as].to_sym
       when :string then parse_string(value)
       when :symbol then parse_symbol(value)
       when :boolean then parse_boolean(value)
@@ -39,7 +48,7 @@ class EnvParser
       when :json then parse_json(value)
       when :array then parse_array(value)
       when :hash then parse_hash(value)
-      else raise ArgumentError, "invalid `as` parameter: #{as.inspect}"
+      else raise ArgumentError, "invalid `as` parameter: #{options[:as].inspect}"
       end
     end
 
@@ -70,16 +79,15 @@ class EnvParser
 
     def parse_json(value)
       require 'json'
-      require 'active_support/all'
 
-      return nil if value.nil? || (value == '')
+      return nil if value.blank?
 
       decoded_json = JSON.parse(value, quirks_mode: true)
       { decoded_json: decoded_json }.with_indifferent_access[:decoded_json]
     end
 
     def parse_array(value)
-      return [] if value.nil? || (value == '')
+      return [] if value.blank?
 
       decoded_json = parse_json(value)
       raise(ArgumentError, 'non-array value') unless decoded_json.is_a? Array
@@ -88,7 +96,7 @@ class EnvParser
     end
 
     def parse_hash(value)
-      return {} if value.nil? || (value == '')
+      return {} if value.blank?
 
       decoded_json = parse_json(value)
       raise(ArgumentError, 'non-hash value') unless decoded_json.is_a? Hash

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: env_parser
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nestor Custodio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-28 00:00:00.000000000 Z
+date: 2017-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler