env_parser 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9267e9a3c9e84f53fe028aa4eaecefd43559b67
-  data.tar.gz: efb184bc36af4c482ee88d721d5dc281b0e20ad3
+  metadata.gz: f97bc0fe59df6a385baed458ea66fba04b2e79ac
+  data.tar.gz: 76f851cd5748a48f37e6de45c5cbcd30c6830838
 SHA512:
-  metadata.gz: 1158be532e36463128f3c97d78186d7b2d4601315e53cb9b2d2ce21fb779f617ec44cb34a375af9c95b31ee426a8ac3a8d8491cf44442b3fab42883d3e67662e
-  data.tar.gz: b59a03c76c0988f5545e88338de325e8d1eded9b9a87a691e28768b6c94e3ef9da5bbc906787eb045dbb9fde01535086a65ae3f0988a0af405eaa3e64fbfe802
+  metadata.gz: 5730a3a7cc72e96ac94117b554262e59532c3c1f4486e3c1f526f5088ffe1ce5fb32289377ba54541669e428c9739cd64aafb33f1960e1d44de408832ed06e09
+  data.tar.gz: 8bae60dfa56d806266331d755a96d8f98c095990671d84312564ac1af5e73935d5a5bda83257255061549ca24e9c840a9ab395281d641367bff8c1d4c617947b

data/Gemfile.lock

@@ -1,22 +1,28 @@
 PATH
   remote: .
   specs:
-    env_parser (1.1.0)
+    env_parser (1.2.0)
       activesupport (>= 5.0.0)
+      chronic
+      chronic_duration
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.4)
+    activesupport (5.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    concurrent-ruby (1.0.5)
+    chronic (0.10.2)
+    chronic_duration (0.10.6)
+      numerizer (~> 0.1.1)
+    concurrent-ruby (1.1.5)
     diff-lcs (1.3)
-    i18n (0.9.1)
+    i18n (1.7.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.10.1)
+    minitest (5.12.2)
+    numerizer (0.1.1)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -34,7 +40,7 @@ GEM
     rspec_junit_formatter (0.3.0)
       rspec-core (>= 2, < 4, != 2.12.0)
     thread_safe (0.3.6)
-    tzinfo (1.2.4)
+    tzinfo (1.2.5)
       thread_safe (~> 0.1)
 
 PLATFORMS

data/README.md

@@ -146,7 +146,7 @@ EnvParser.parse :SOME_CUSTOM_NETWORK_PORT, as: :integer, from_set: (1..65535), i
 
 ## And if the value is not allowed...
 
-EnvParser.parse :NEGATIVE_NUMBER, as: :integer, from_set: (1..5)  ## => raises EnvParser::ValueNotAllowed
+EnvParser.parse :NEGATIVE_NUMBER, as: :integer, from_set: (1..5)  ## => raises EnvParser::ValueNotAllowedError
 
 
 
@@ -159,7 +159,7 @@ EnvParser.parse :MUST_BE_LOWERCASE, as: :string, validated_by: ->(value) { value
 ## ... but a block will also do the trick!
 
 EnvParser.parse(:MUST_BE_LOWERCASE, as: :string) { |value| value == value.downcase }
-EnvParser.parse(:CONNECTION_RETRIES, as: :integer, &:nonzero?)
+EnvParser.parse(:CONNECTION_RETRIES, as: :integer, &:positive?)
 ```
 
 ---
@@ -209,6 +209,7 @@ b = EnvParser.parse :B, as: :my_special_type_of_number
 
 Additional features/options coming in the future:
 
+- Allow for a ".env_parser" file where you can easily type-check and/or register (as constants) any ENV variables you like.
 - Continue to round out the "as" type selection as ideas come to mind, suggestions are made, and pull requests are submitted.
 
 

data/docs/EnvParser/Error.html

@@ -6,7 +6,7 @@
 <title>
   Exception: EnvParser::Error
   
-    &mdash; Documentation by YARD 0.9.11
+    &mdash; Documentation by YARD 0.9.20
   
 </title>
 
@@ -129,9 +129,9 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Dec 25 23:01:10 2017 by
+  Generated on Mon Oct 21 00:33:12 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.11 (ruby-2.4.2).
+  0.9.20 (ruby-2.4.2).
 </div>
 
     </div>

data/docs/EnvParser/TypeAlreadyDefinedError.html

@@ -6,7 +6,7 @@
 <title>
   Exception: EnvParser::TypeAlreadyDefinedError
   
-    &mdash; Documentation by YARD 0.9.11
+    &mdash; Documentation by YARD 0.9.20
   
 </title>
 
@@ -133,9 +133,9 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Dec 25 23:01:10 2017 by
+  Generated on Mon Oct 21 00:33:12 2019 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.11 (ruby-2.4.2).
+  0.9.20 (ruby-2.4.2).
 </div>
 
     </div>

data/docs/EnvParser/Types/BaseTypes.html

@@ -0,0 +1,178 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: EnvParser::Types::BaseTypes
+  
+    &mdash; Documentation by YARD 0.9.20
+  
+</title>
+
+  <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  pathId = "EnvParser::Types::BaseTypes";
+  relpath = '../../';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="../../_index.html">Index (B)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../EnvParser.html" title="EnvParser (class)">EnvParser</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Types.html" title="EnvParser::Types (module)">Types</a></span></span>
+     &raquo; 
+    <span class="title">BaseTypes</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../../class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Module: EnvParser::Types::BaseTypes
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/env_parser/types/base_types.rb</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>Defines types for primitive classes, adding the following:</p>
+<table>
+  <tbody>
+    <tr>
+      <th><code>:as</code> value</th>
+      <th>type returned</th>
+      <th>default</th>
+      <th>notes</th>
+    </tr>
+  </tbody>
+  <tbody>
+    <tr>
+      <td>:string</td>
+      <td>String</td>
+      <td><code>''</code></td>
+      <td></td>
+    </tr>
+    <tr>
+      <td>:symbol</td>
+      <td>Symbol</td>
+      <td><code>:''</code></td>
+      <td></td>
+    </tr>
+    <tr>
+      <td>:boolean</td>
+      <td>TrueValue / FalseValue</td>
+      <td><code>false</code></td>
+      <td></td>
+    </tr>
+    <tr>
+      <td>:int / :integer</td>
+      <td>Integer</td>
+      <td><code>0</code></td>
+      <td></td>
+    </tr>
+    <tr>
+      <td>:float / :decimal / :number</td>
+      <td>Float</td>
+      <td><code>0.0</code></td>
+      <td></td>
+    </tr>
+    <tr>
+      <td>:json</td>
+      <td>&lt; depends on JSON given &gt;</td>
+      <td><code>nil</code></td>
+      <td></td>
+    </tr>
+    <tr>
+      <td>:array</td>
+      <td>Array</td>
+      <td><code>[]</code></td>
+      <td></td>
+    </tr>
+    <tr>
+      <td>:hash</td>
+      <td>Hash</td>
+      <td><code>{}</code></td>
+      <td></td>
+    </tr>
+  </tbody>
+</table>
+<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>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+
+
+
+
+
+
+
+
+</div>
+
+      <div id="footer">
+  Generated on Mon Oct 21 00:33:12 2019 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.20 (ruby-2.4.2).
+</div>
+
+    </div>
+  </body>
+</html>

data/docs/EnvParser/Types/ChronologyTypes.html

@@ -0,0 +1,159 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: EnvParser::Types::ChronologyTypes
+  
+    &mdash; Documentation by YARD 0.9.20
+  
+</title>
+
+  <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  pathId = "EnvParser::Types::ChronologyTypes";
+  relpath = '../../';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="../../_index.html">Index (C)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../EnvParser.html" title="EnvParser (class)">EnvParser</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Types.html" title="EnvParser::Types (module)">Types</a></span></span>
+     &raquo; 
+    <span class="title">ChronologyTypes</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../../class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Module: EnvParser::Types::ChronologyTypes
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/env_parser/types/chronology_types.rb</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>Defines types for date/time-related values, adding the following:</p>
+<table>
+  <tbody>
+    <tr>
+      <th><code>:as</code> value</th>
+      <th>type returned</th>
+      <th>default</th>
+      <th>notes</th>
+    </tr>
+  </tbody>
+  <tbody>
+    <tr>
+      <td>:date</td>
+      <td>Date</td>
+      <td><code>nil</code></td>
+      <td>
+        A natural language or ISO8601-parseable date.
+        <br />
+        Actual interpretation of the value is handled by the *chronic* gem.
+      </td>
+    </tr>
+    <tr>
+      <td>:time / :datetime</td>
+      <td>Time</td>
+      <td><code>nil</code></td>
+      <td>
+        A natural language or ISO8601-parseable date and time.
+        <br />
+        Actual interpretation of the value is handled by the *chronic* gem.
+      </td>
+    </tr>
+    <tr>
+      <td>:duration</td>
+      <td>Numeric</td>
+      <td><code>nil</code></td>
+      <td>
+        A natural language or ISO8601-parseable period.
+        <br />
+        Value returned is the number of seconds in the given period.
+        <br />
+        Actual interpretation of the value is handled by the *chronic_duration* gem.
+      </td>
+    </tr>
+  </tbody>
+</table>
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+
+
+
+
+
+
+
+
+</div>
+
+      <div id="footer">
+  Generated on Mon Oct 21 00:33:12 2019 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.20 (ruby-2.4.2).
+</div>
+
+    </div>
+  </body>
+</html>

data/docs/EnvParser/Types/InternetTypes.html

@@ -0,0 +1,159 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: EnvParser::Types::InternetTypes
+  
+    &mdash; Documentation by YARD 0.9.20
+  
+</title>
+
+  <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  pathId = "EnvParser::Types::InternetTypes";
+  relpath = '../../';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="../../_index.html">Index (I)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../EnvParser.html" title="EnvParser (class)">EnvParser</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Types.html" title="EnvParser::Types (module)">Types</a></span></span>
+     &raquo; 
+    <span class="title">InternetTypes</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../../class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Module: EnvParser::Types::InternetTypes
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/env_parser/types/internet_types.rb</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>Defines types for internet-related values, adding the following:</p>
+<table>
+  <tbody>
+    <tr>
+      <th><code>:as</code> value</th>
+      <th>type returned</th>
+      <th>default</th>
+      <th>notes</th>
+    </tr>
+  </tbody>
+  <tbody>
+    <tr>
+      <td>:ipv4_address</td>
+      <td>String</td>
+      <td><code>nil</code></td>
+      <td>
+        An IPv4 address in 4-octet dot-decimal notation,
+        <br />
+        with no CIDR or subnet suffix (e.g. <code>'192.168.0.1'</code>).
+      </td>
+    </tr>
+    <tr>
+      <td>:ipv6_address</td>
+      <td>String</td>
+      <td><code>nil</code></td>
+      <td>An IPv6 address, in RFC5952 format.</td>
+    </tr>
+    <tr>
+      <td>:network_port / :port</td>
+      <td>Integer</td>
+      <td><code>nil</code></td>
+      <td></td>
+    </tr>
+    <tr>
+      <td>:email_address</td>
+      <td>String</td>
+      <td><code>nil</code></td>
+      <td>
+        A "simple" email address, containing only a username and a domain.
+        <br />
+        Note this does not guarantee RFC5322-conformity.
+      </td>
+    </tr>
+  </tbody>
+</table>
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+
+
+
+
+
+
+
+
+</div>
+
+      <div id="footer">
+  Generated on Mon Oct 21 00:33:12 2019 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.20 (ruby-2.4.2).
+</div>
+
+    </div>
+  </body>
+</html>