env_parser 0.8.0 → 1.3.1

data/lib/env_parser/autoregister.rb

@@ -0,0 +1,3 @@
+require 'env_parser'
+
+EnvParser.autoregister

data/lib/env_parser/errors.rb

@@ -0,0 +1,40 @@
+class EnvParser
+  ## Base error class for EnvParser.
+  ##
+  class Error < ::StandardError
+  end
+
+  ## 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.
+  ##
+  class UnknownTypeError < Error
+  end
+
+  ## 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.
+  ##
+  class ValueNotAllowedError < Error
+  end
+
+  ## 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).
+  ##
+  class UnparseableAutoregisterSpec < Error
+  end
+end

data/lib/env_parser/types.rb

@@ -0,0 +1,3 @@
+## 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/types/base_types.rb

@@ -1,39 +1,112 @@
 require 'env_parser'
 
-EnvParser.define_type(:string, if_unset: '') do |value|
-  value
-end
+## 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).
+  ##
+  module BaseTypes
+    EnvParser.define_type(:string, if_unset: '') do |value|
+      value
+    end
 
-EnvParser.define_type(:symbol, if_unset: :'', &:to_sym)
+    EnvParser.define_type(:symbol, if_unset: :'', &:to_sym)
 
-EnvParser.define_type(:boolean, if_unset: false) do |value|
-  case value
-  when '', '0', 'f', 'false' then false
-  else true
-  end
-end
+    EnvParser.define_type(:boolean, if_unset: false) do |value|
+      case value
+      when '', '0', 'f', 'false' then false
+      else true
+      end
+    end
 
-EnvParser.define_type(:integer, aliases: %i[int], if_unset: 0, &:to_i)
+    EnvParser.define_type(:integer, aliases: %i[int], if_unset: 0, &:to_i)
 
-EnvParser.define_type(:float, aliases: %i[decimal number], if_unset: 0.0, &:to_f)
+    EnvParser.define_type(:float, aliases: %i[decimal number], if_unset: 0.0, &:to_f)
 
-EnvParser.define_type(:json, if_unset: nil) do |value|
-  require 'json'
+    EnvParser.define_type(:json, if_unset: nil) do |value|
+      require 'json'
 
-  decoded_json = JSON.parse(value, quirks_mode: true)
-  { decoded_json: decoded_json }.with_indifferent_access[:decoded_json]
-end
+      decoded_json = JSON.parse(value, quirks_mode: true)
+      { decoded_json: decoded_json }.with_indifferent_access[:decoded_json]
+    end
 
-EnvParser.define_type(:array, if_unset: []) do |value|
-  decoded_json = EnvParser.parse(value, as: :json)
-  raise(ArgumentError, 'non-array value') unless decoded_json.is_a? Array
+    EnvParser.define_type(:array, if_unset: []) do |value|
+      decoded_json = EnvParser.parse(value, as: :json)
+      raise(EnvParser::ValueNotConvertibleError, 'non-array value') unless decoded_json.is_a? Array
 
-  decoded_json
-end
+      decoded_json
+    end
 
-EnvParser.define_type(:hash, if_unset: {}) do |value|
-  decoded_json = EnvParser.parse(value, as: :json)
-  raise(ArgumentError, 'non-hash value') unless decoded_json.is_a? Hash
+    EnvParser.define_type(:hash, if_unset: {}) do |value|
+      decoded_json = EnvParser.parse(value, as: :json)
+      raise(EnvParser::ValueNotConvertibleError, 'non-hash value') unless decoded_json.is_a? Hash
 
-  decoded_json
+      decoded_json
+    end
+  end
 end

data/lib/env_parser/types/chronology_types.rb

@@ -0,0 +1,104 @@
+require 'env_parser'
+
+## 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>
+  ##
+  module ChronologyTypes
+    EnvParser.define_type(:date, if_unset: nil) do |value|
+      require 'chronic'
+
+      begin
+        value = Chronic.parse value, guess: :begin
+        raise StandardError unless value.is_a? Time
+      rescue StandardError
+        raise EnvParser::ValueNotConvertibleError, 'non-date value'
+      end
+
+      value.to_date
+    end
+
+    EnvParser.define_type(:time, aliases: :datetime, if_unset: nil) do |value|
+      require 'chronic'
+
+      begin
+        value = Chronic.parse value, guess: :begin
+        raise StandardError unless value.is_a? Time
+      rescue StandardError
+        raise EnvParser::ValueNotConvertibleError, 'non-time value'
+      end
+
+      value
+    end
+
+    EnvParser.define_type(:duration, if_unset: nil) do |value|
+      require 'chronic_duration'
+
+      begin
+        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
+        value = value.delete 'PT' if value =~ iso_period
+
+        value = ChronicDuration.parse value, keep_zero: true
+      rescue StandardError
+        raise EnvParser::ValueNotConvertibleError, 'non-duration value'
+      ensure
+        ChronicDuration.raise_exceptions = original_raise_setting
+      end
+
+      value
+    end
+  end
+end

data/lib/env_parser/types/internet_types.rb

@@ -0,0 +1,99 @@
+require 'env_parser'
+
+## 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>
+  ##
+  module InternetTypes
+    EnvParser.define_type(:ipv4_address, if_unset: nil) do |value|
+      begin
+        require 'socket'
+        address = Addrinfo.getaddrinfo(value, nil, Socket::AF_INET, nil, Socket::IPPROTO_TCP).first
+        raise StandardError unless address.ipv4?
+      rescue StandardError
+        raise EnvParser::ValueNotConvertibleError, 'non-ip value'
+      end
+
+      address.ip_address
+    end
+
+    EnvParser.define_type(:ipv6_address, if_unset: nil) do |value|
+      begin
+        require 'socket'
+        address = Addrinfo.getaddrinfo(value, nil, Socket::AF_INET6, nil, Socket::IPPROTO_TCP).first
+        raise StandardError unless address.ipv6?
+      rescue StandardError
+        raise EnvParser::ValueNotConvertibleError, 'non-ip value'
+      end
+
+      address.ip_address
+    end
+
+    EnvParser.define_type(:network_port, aliases: :port, if_unset: nil) do |value|
+      begin
+        Integer(value)
+      rescue ArgumentError
+        raise(EnvParser::ValueNotConvertibleError, 'non-numeric value')
+      end
+
+      value = value.to_i
+      raise(EnvParser::ValueNotAllowedError, 'value out of range') unless (0..65535).cover?(value)
+
+      value
+    end
+
+    EnvParser.define_type(:email_address, if_unset: nil) do |value|
+      simple_email = %r[^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$]i ## rubocop:disable Layout/LineLength
+      raise(EnvParser::ValueNotConvertibleError, 'not an email') unless value.match?(simple_email)
+
+      value
+    end
+  end
+end

data/lib/env_parser/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: env_parser
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Nestor Custodio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-25 00:00:00.000000000 Z
+date: 2021-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +108,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: chronic_duration
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - sakimorix@gmail.com
@@ -102,9 +158,24 @@ files:
 - bin/console
 - bin/setup
 - docs/EnvParser.html
+- docs/EnvParser/AutoregisterFileNotFound.html
 - docs/EnvParser/Error.html
 - docs/EnvParser/TypeAlreadyDefined.html
+- docs/EnvParser/TypeAlreadyDefinedError.html
+- docs/EnvParser/Types.html
+- docs/EnvParser/Types/BaseTypes.html
+- docs/EnvParser/Types/ChronologyTypes.html
+- docs/EnvParser/Types/InternetTypes.html
+- docs/EnvParser/UnknownTypeError.html
+- docs/EnvParser/UnparseableAutoregisterSpec.html
 - docs/EnvParser/ValueNotAllowed.html
+- docs/EnvParser/ValueNotAllowedError.html
+- docs/EnvParser/ValueNotConvertibleError.html
+- docs/EnvParserTypes.html
+- docs/EnvParserTypes/BaseTypes.html
+- docs/EnvParserTypes/ChronologyTypes.html
+- docs/EnvParserTypes/InternetTypes.html
+- docs/EnvParserTypes/TimeTypes.html
 - docs/_index.html
 - docs/class_list.html
 - docs/css/common.css
@@ -121,7 +192,12 @@ files:
 - docs/top-level-namespace.html
 - env_parser.gemspec
 - lib/env_parser.rb
+- lib/env_parser/autoregister.rb
+- lib/env_parser/errors.rb
+- lib/env_parser/types.rb
 - lib/env_parser/types/base_types.rb
+- lib/env_parser/types/chronology_types.rb
+- lib/env_parser/types/internet_types.rb
 - lib/env_parser/version.rb
 homepage: https://github.com/nestor-custodio/env_parser
 licenses:
@@ -142,8 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A tool for painless parsing and validation of environment variables.