env_parser 1.2.0 → 1.3.0

data/docs/method_list.html

@@ -54,13 +54,21 @@
 
   <li class="even ">
     <div class="item">
-      <span class='object_link'><a href="EnvParser.html#define_type-class_method" title="EnvParser.define_type (method)">define_type</a></span>
+      <span class='object_link'><a href="EnvParser.html#autoregister-class_method" title="EnvParser.autoregister (method)">autoregister</a></span>
       <small>EnvParser</small>
     </div>
   </li>
   
 
   <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="EnvParser.html#define_type-class_method" title="EnvParser.define_type (method)">define_type</a></span>
+      <small>EnvParser</small>
+    </div>
+  </li>
+  
+
+  <li class="even ">
     <div class="item">
       <span class='object_link'><a href="top-level-namespace.html#filename-instance_method" title="#filename (method)">#filename</a></span>
       <small>Top Level Namespace</small>
@@ -68,7 +76,7 @@
   </li>
   
 
-  <li class="even ">
+  <li class="odd ">
     <div class="item">
       <span class='object_link'><a href="EnvParser.html#parse-class_method" title="EnvParser.parse (method)">parse</a></span>
       <small>EnvParser</small>
@@ -76,7 +84,7 @@
   </li>
   
 
-  <li class="odd ">
+  <li class="even ">
     <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

@@ -178,7 +178,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Oct 21 00:33:12 2019 by
+  Generated on Sun Nov  3 21:30:37 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>

data/env_parser.gemspec

@@ -24,6 +24,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec_junit_formatter'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'yard'
 
   spec.add_dependency 'activesupport', '>= 5.0.0'
   spec.add_dependency 'chronic'

data/lib/env_parser.rb

@@ -1,10 +1,15 @@
 require 'env_parser/errors'
 require 'env_parser/version'
 require 'active_support/all'
+require 'psych'
 
 ## The EnvParser class simplifies parsing of environment variables as different data types.
 ##
 class EnvParser
+  ## The default filename to use for {.autoregister} requests.
+  ##
+  AUTOREGISTER_FILE = '.env_parser.yml'.freeze
+
   class << self
     ## Defines a new type for use as the "as" option on a subsequent {.parse} or {.register} call.
     ##
@@ -189,9 +194,7 @@ class EnvParser
         name = name.to_s
       end
 
-      unless from.is_a? Hash
-        raise ArgumentError, "invalid `from` parameter: #{from.class}"
-      end
+      raise ArgumentError, "invalid `from` parameter: #{from.class}" unless from.is_a? Hash
 
       unless within.is_a?(Module) || within.is_a?(Class)
         raise ArgumentError, "invalid `within` parameter: #{within.inspect}"
@@ -227,6 +230,47 @@ class EnvParser
       ENV
     end
 
+    ## Reads an "autoregister" file and registers the ENV constants defined therein.
+    ##
+    ## The "autoregister" file is read, parsed as YAML, sanitized for use as a parameter to
+    ## {.register_all}, and then passed along for processing. The return value from that
+    ## {.register_all} call is passed through.
+    ##
+    ## @param filename [String]
+    ##   A path for the autoregister file to parse and process. Defaults to
+    ##   {EnvParser::AUTOREGISTER_FILE} if unset.
+    ##
+    ## @return [Hash]
+    ##   The return value from the {.register_all} call that handles the actual registration.
+    ##
+    ## @raise [EnvParser::AutoregisterFileNotFound, EnvParser::UnparseableAutoregisterSpec]
+    ##
+    def autoregister(filename = nil)
+      filename ||= AUTOREGISTER_FILE
+      autoregister_spec = Psych.load_file(filename)
+
+      autoregister_spec.deep_symbolize_keys!
+      autoregister_spec.transform_values! do |spec|
+        sanitized = spec.slice(:as, :within, :if_unset, :from_set)
+        sanitized[:as] = sanitized[:as].to_sym if sanitized.key? :as
+        sanitized[:within] = sanitized[:within].constantize if sanitized.key? :within
+
+        sanitized
+      end
+
+      register_all autoregister_spec
+
+    ## Psych raises an Errno::ENOENT on file-not-found.
+    ##
+    rescue Errno::ENOENT
+      raise EnvParser::AutoregisterFileNotFound, %(file not found: "#{filename}")
+
+    ## Psych raises a Psych::SyntaxError on unparseable YAML.
+    ##
+    rescue Psych::SyntaxError => e
+      raise EnvParser::UnparseableAutoregisterSpec, "malformed YAML in spec file: #{e.message}"
+    end
+
     private
 
     ## Class instance variable for storing known type data.

data/lib/env_parser/autoregister.rb

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

data/lib/env_parser/errors.rb

@@ -25,4 +25,16 @@ class EnvParser
   ##
   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/chronology_types.rb

@@ -88,7 +88,7 @@ module EnvParser::Types
         ## 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*$}
+        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 Metrics/LineLength
         value = value.delete 'PT' if value =~ iso_period
 
         value = ChronicDuration.parse value, keep_zero: true

data/lib/env_parser/types/internet_types.rb

@@ -79,7 +79,7 @@ module EnvParser::Types
     EnvParser.define_type(:network_port, aliases: :port, if_unset: nil) do |value|
       begin
         Integer(value)
-      rescue
+      rescue ArgumentError
         raise(EnvParser::ValueNotConvertibleError, 'non-numeric value')
       end
 
@@ -90,7 +90,7 @@ module EnvParser::Types
     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
+      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 Metrics/LineLength
       raise(EnvParser::ValueNotConvertibleError, 'not an email') unless value.match?(simple_email)
 
       value

data/lib/env_parser/version.rb

@@ -1,3 +1,3 @@
 class EnvParser
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: env_parser
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Nestor Custodio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-21 00:00:00.000000000 Z
+date: 2019-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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
@@ -130,6 +158,7 @@ files:
 - bin/console
 - bin/setup
 - docs/EnvParser.html
+- docs/EnvParser/AutoregisterFileNotFound.html
 - docs/EnvParser/Error.html
 - docs/EnvParser/TypeAlreadyDefined.html
 - docs/EnvParser/TypeAlreadyDefinedError.html
@@ -138,6 +167,7 @@ files:
 - 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
@@ -162,6 +192,7 @@ 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