env_parser 1.3.1 → 1.3.2

data/docs/top-level-namespace.html

@@ -6,7 +6,7 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.9.26
+    &mdash; Documentation by YARD 0.9.28
   
 </title>
 
@@ -95,92 +95,14 @@
 
 
 
-  
-    <h2>
-      Instance Method Summary
-      <small><a href="#" class="summary_toggle">collapse</a></small>
-    </h2>
-
-    <ul class="summary">
-      
-        <li class="public ">
-  <span class="summary_signature">
-    
-      <a href="top-level-namespace.html#filename-instance_method" title="#filename (instance method)">#<strong>filename</strong>  &#x21d2; Object </a>
-    
-
-    
-  </span>
-  
-  
-  
-  
-  
-  
-  
-
-  
-    <span class="summary_desc"><div class='inline'>
-<p>Load all files listed in “/lib/env_parser/types”.</p>
-</div></span>
-  
-</li>
-
-      
-    </ul>
-  
-
-
 
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-
-    
-      <div class="method_details first">
-  <h3 class="signature first" id="filename-instance_method">
-  
-    #<strong>filename</strong>  &#x21d2; <tt>Object</tt> 
-  
-
-  
-
-  
-</h3><div class="docstring">
-  <div class="discussion">
-    
-<p>Load all files listed in “/lib/env_parser/types”.</p>
-
-
-  </div>
-</div>
-<div class="tags">
-  
-
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-
-
-3</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/env_parser/types.rb', line 3</span>
-
-<span class='const'>Dir</span><span class='period'>.</span><span class='id identifier rubyid_glob'>glob</span><span class='lparen'>(</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='id identifier rubyid___dir__'>__dir__</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>types</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>*.rb</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_filename'>filename</span><span class='op'>|</span> <span class='id identifier rubyid_require_relative'>require_relative</span> <span class='id identifier rubyid_filename'>filename</span> <span class='rbrace'>}</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-    
-  </div>
 
 </div>
 
       <div id="footer">
-  Generated on Sat Jan  2 17:31:17 2021 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-2.7.2).
+  Generated on Sun Dec 25 19:19:23 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>
 
     </div>

data/env_parser.gemspec

@@ -1,9 +1,10 @@
-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'env_parser/version'
 
 Gem::Specification.new do |spec|
+  spec.required_ruby_version = '~> 3.0'
+
   spec.name          = 'env_parser'
   spec.version       = EnvParser::VERSION
   spec.authors       = ['Nestor Custodio']
@@ -13,21 +14,20 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/nestor-custodio/env_parser'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |filename| filename.start_with? 'test/' }
+  spec.executables   = []
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rspec_junit_formatter'
-  spec.add_development_dependency 'rubocop', '1.7'
-  spec.add_development_dependency 'yard'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
-  spec.add_dependency 'activesupport', '>= 5.0.0'
+  spec.add_dependency 'activesupport', '>= 6.1.0'
   spec.add_dependency 'chronic'
   spec.add_dependency 'chronic_duration'
+
+  spec.add_development_dependency 'bundler', '~> 2'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'rspec_junit_formatter'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'yard'
 end

data/lib/env_parser/errors.rb

@@ -1,40 +1,40 @@
 class EnvParser
-  ## Base error class for EnvParser.
-  ##
+  # Base error class for EnvParser.
+  #
   class Error < ::StandardError
   end
 
-  ## Error class used to indicate a type has already been defined.
-  ##
+  # Error class used to indicate a type has already been defined.
+  #
   class TypeAlreadyDefinedError < Error
   end
 
-  ## Error class used to indicate the requested "as" type has not been defined.
-  ##
+  # Error class used to indicate the requested "as" type has not been defined.
+  #
   class UnknownTypeError < Error
   end
 
-  ## Error class used to indicate value given is not convertible to the requested type.
-  ##
+  # Error class used to indicate value given is not convertible to the requested type.
+  #
   class ValueNotConvertibleError < Error
   end
 
-  ## Error class used to indicate parsed values that do not pass user-validation, either by not
-  ## being part of the given "from_set" list, or by failing the "validated_by" Proc or yield-block
-  ## check.
-  ##
+  # Error class used to indicate parsed values that do not pass user-validation, either by not
+  # being part of the given "from_set" list, or by failing the "validated_by" Proc or yield-block
+  # check.
+  #
   class ValueNotAllowedError < Error
   end
 
-  ## Error class used to indicate a missing auto-registration spec file (used by the "autoregister"
-  ## feature).
-  ##
+  # Error class used to indicate a missing auto-registration spec file (used by the "autoregister"
+  # feature).
+  #
   class AutoregisterFileNotFound < Error
   end
 
-  ## Error class used to indicate an unparseable auto-registration spec (used by the "autoregister"
-  ## feature).
-  ##
+  # Error class used to indicate an unparseable auto-registration spec (used by the "autoregister"
+  # feature).
+  #
   class UnparseableAutoregisterSpec < Error
   end
 end

data/lib/env_parser/types/base_types.rb

@@ -1,75 +1,75 @@
 require 'env_parser'
 
-## The parent module for all EnvParser type definition modules.
-## Exists only for documentation's sake.
-##
+# The parent module for all EnvParser type definition modules.
+# Exists only for documentation's sake.
+#
 module EnvParser::Types
-  ## Defines types for primitive classes, adding the following:
-  ##
-  ## <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>
-  ##
-  ## Note JSON is parsed using *quirks-mode* (meaning 'true', '25', and 'null' are all considered
-  ## valid, parseable JSON).
-  ##
+  # Defines types for primitive classes, adding the following:
+  #
+  # <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>
+  #
+  # Note JSON is parsed using *quirks-mode* (meaning 'true', '25', and 'null' are all considered
+  # valid, parseable JSON).
+  #
   module BaseTypes
     EnvParser.define_type(:string, if_unset: '') do |value|
       value

data/lib/env_parser/types/chronology_types.rb

@@ -1,56 +1,56 @@
 require 'env_parser'
 
-## The parent module for all EnvParser type definition modules.
-## Exists only for documentation's sake.
-##
+# The parent module for all EnvParser type definition modules.
+# Exists only for documentation's sake.
+#
 module EnvParser::Types
-  ## Defines types for date/time-related values, adding the following:
-  ##
-  ## <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>
-  ##
+  # Defines types for date/time-related values, adding the following:
+  #
+  # <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>
+  #
   module ChronologyTypes
     EnvParser.define_type(:date, if_unset: nil) do |value|
       require 'chronic'
@@ -85,10 +85,10 @@ module EnvParser::Types
         original_raise_setting = ChronicDuration.raise_exceptions
         ChronicDuration.raise_exceptions = true
 
-        ## With `raise_exceptions` set, ChronicDuration will fail on the "P" and "T" in ISO8601
-        ## periods, so we have to check for and remove them.
-        ##
-        iso_period = %r{^\s*P(?:[0-9.]Y)?(?:[0-9.]M)?(?:[0-9.]W)?(?:[0-9.]D)?(?:T(?:[0-9.]H)?(?:[0-9.]M)?(?:[0-9.]S)?)?\s*$} ## rubocop:disable Layout/LineLength
+        # With `raise_exceptions` set, ChronicDuration will fail on the "P" and "T" in ISO8601
+        # periods, so we have to check for and remove them.
+        #
+        iso_period = %r{^\s*P(?:[0-9.]Y)?(?:[0-9.]M)?(?:[0-9.]W)?(?:[0-9.]D)?(?:T(?:[0-9.]H)?(?:[0-9.]M)?(?:[0-9.]S)?)?\s*$}
         value = value.delete 'PT' if value =~ iso_period
 
         value = ChronicDuration.parse value, keep_zero: true

data/lib/env_parser/types/internet_types.rb

@@ -1,56 +1,56 @@
 require 'env_parser'
 
-## The parent module for all EnvParser type definition modules.
-## Exists only for documentation's sake.
-##
+# The parent module for all EnvParser type definition modules.
+# Exists only for documentation's sake.
+#
 module EnvParser::Types
-  ## Defines types for internet-related values, adding the following:
-  ##
-  ## <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>
-  ##
+  # Defines types for internet-related values, adding the following:
+  #
+  # <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>
+  #
   module InternetTypes
     EnvParser.define_type(:ipv4_address, if_unset: nil) do |value|
       begin

data/lib/env_parser/types.rb

@@ -1,3 +1,3 @@
-## Load all files listed in "/lib/env_parser/types".
-##
+# Load all files listed in "/lib/env_parser/types".
+#
 Dir.glob(File.join(__dir__, 'types', '*.rb')).each { |filename| require_relative filename }

data/lib/env_parser/version.rb

@@ -1,3 +1,3 @@
 class EnvParser
-  VERSION = '1.3.1'.freeze
+  VERSION = '1.3.2'.freeze
 end