hash_params 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18b9b33c318505732f31be28490a86c21f71fbb8
-  data.tar.gz: 85bea6b4b4586a471628133ca29f3fafdd184b78
+  metadata.gz: 7fda373b2a97192b7d68af0c8a2f581b60e1206b
+  data.tar.gz: 851b0042442ab3a3558f7b1a7d409889eae54574
 SHA512:
-  metadata.gz: 6cb584ef9c38be540b5f63183f44d265f58f4d7d9b9517da8aa4e5372114b54d3afa97ebbddce2e309b81feb9fa95cbf97a18b73dbb85928a52c80269b048a2a
-  data.tar.gz: dcabb95cc3e9b7e8e46672a3e5c2693b5bac428e14c09c65de93cc6c2af2ad51531d9f3f0f8f89a894daf97d30db16de7b8e7c456f6ae837bf1341916bebeb33
+  metadata.gz: 1ca9a5e181d26357087e3ec00a4453fde04216caa890a01eff2588ff04661bfdb6deca1ca1d8b74bc02b6888fa2c2461da0621937548ae243b6d8c8233bec557
+  data.tar.gz: c54fd364b0353c0d577d7bb7a5fd90763b9b1bbcfa258bc79709ec7c9fcc0dd59807cfa8745f620cdbacd59f0f87e97711a6de906eef27ca2f30759d155dc664

data/Gemfile.lock

@@ -1,28 +1,28 @@
 PATH
   remote: .
   specs:
-    hash_params (2.0.0)
+    hash_params (2.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.0)
     docile (1.1.5)
+    json (1.8.3)
     method_source (0.8.2)
-    minitest (5.5.1)
+    minitest (5.8.3)
     minitest-spec (0.0.2.1)
       minitest (>= 3.0)
-    multi_json (1.11.0)
-    pry (0.10.1)
+    pry (0.10.3)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    rake (10.4.2)
-    simplecov (0.9.2)
+    rake (10.5.0)
+    simplecov (0.11.1)
       docile (~> 1.1.0)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.9.0)
-    simplecov-html (0.9.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
     slop (3.6.0)
 
 PLATFORMS
@@ -35,3 +35,6 @@ DEPENDENCIES
   pry
   rake
   simplecov
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -1,4 +1,5 @@
 # hash-params
+#
 _Lightweight Parameter Validation & Type Coercion_
 
 This is a variation of the sinatra-param gem  https://github.com/mattt/sinatra-param
@@ -8,217 +9,153 @@ with the sinatra specific things taken out and slight modifications to make it m
 
  See the spec down the page for usage scenarios
 
-## Validations
-
-- Validations are passed as a hash.
-- You can validate either individual values or hashes.
-- Hashes can be validated recursively
-- You can call the coersion methods separately if you wish
-- If you don't pass in any validations you'll get the same hash back unless you set the strict option (see below)
-
-## Coercions
-
- By declaring parameter types, incoming parameters will automatically be coerced into an object of that type.
-
- - `String`
- - `Integer`
- - `Float`
- - `Array` _("1,2,3,4,5")_
- - `Hash` _(key1:value1,key2:value2)_
- - `Date`, `Time`, & `DateTime`
- - `:boolean` _("1/0", "true/false", "t/f", "yes/no", "y/n")_
-
-
- Note that the `Hash` and `Array` coercions are not deep (only one level).  The internal elements are not validated or coerced, everything is returned as a string.
-
- Since Ruby doesn't have a Boolean type use the symbol :boolean.  This will attempt to cast the commonly used values to either true or false (`TrueClass` or `FalseClass`)
-
- You can also use anything that will respond to `to_proc` such as `:to_i`, `:downcase`, etc.  It's up to you to make sure the value will obey the method
-
-
-## Validation Options (Only applies to validating hashes and yaml files)
-
- You can pass in the following options along with your validations
-
-- `strict`: Defaults to true. Only the elements mentioned in the validation will be returned. If set to false all elements will be returned by the validated values will replace the originals
-- `make_methods`: If passed the returned hash will have methods defined for each key in the new hash.  This will allow you access the values using standard dot notation.
-- `raise_errors`: Defaults to true. All errors will be collected during processing and raised just once.  If you set this to false no error will be raised, you can check the ```hash.valid?``` method or the ```hash.errors``` collection
-
 
 ## Yaml files
 
-   ```validate_yaml_file``` and ```validate_default_yaml_files``` methods are provided for convenience.
-
-   ```validate_yaml_file``` works exactly like ```validate_hash``` but takes a file name instead of a hash
-
-   ```validate_default_file_names``` scours various directories for yaml files and intelligently merges them together before validation.  See the source code for the standard paths and file name patterns.
-
-
+This gem also provides a YamlParams object which scours the disk for likely config files, intelligently parses and merges them
+   and passes them into the HashParams for validation 
+ 
+ The common way to use it is 
+ ```ruby
+ YamlParams.autoconfig
+ ```
+ 
    You can specify the following in the options hash they will all have sensible defaults except the ```app_name```
 
    - app_name
    - env
    - roots
-   - file_separator
-   - file_extension
-
+   - files
+   
+   roots and files specified will be added to the default list but with higher priority.
+   
 ## Example
 
 ``` ruby
-describe HashParams do
-  let (:sample_hash) {
-
-    h= {
-        ignored:          "this will be ignored because it's not mentioned",
-        to_be_renamed:    :to_be_renamed,
-        integer_coercion: "1",
-        bad_number:       '1aaa2',
-        array_with_delim: '1|2|3',
-        hash_as_string:   "{a => 1,b => 2,c => d}",
-        proc_validation:  "is_this_valid?",
-        some_number:      122,
-        some_string:      'this is a test string',
-        is_true:          'true',
-        is_false:         'f',
-        recursive:        {}
-    }
-
-  }
-  let (:validations) {
-    v={
-        doesnt_exist:            {required: true},
-        to_be_renamed:           {as: :renamed},
-        no_value:                {default: 1},
-        #proc default relying on previously set value
-        proc_default:            {default: lambda { |o| 1 * 5 }},
-        integer_coercion:        {coerce: Integer},
-        #chained coersions of various types
-        bad_number:              {coerce: [lambda { |o| o.gsub('a', '') }, :to_i, Float]},
-        #arrays and hashes
-        array_with_delim:        {coerce: Array, delimiter: '|'},
-        hash_as_string:          {coerce: Hash, delimiter: ',', separator: '=>'},
-        proc_validation:         {validate: lambda { |v| v == 'Failed_proc_validation' }},
-        #validations
-        some_number:             {min: 120, max: 500, in: (100..200), is: 122},
-        some_string:             {min_length: 21, max_length: 30, format: /^t.*g$/},
-        #combinations
-        missing_with_validation: {coerce: Integer, :default => 60 * 60, :validate => lambda { |v| v >= 60 * 60 }},
-        is_true:                 {coerce: :boolean},
-        is_false:                {coerce: :boolean},
-        #recursive}
-        recursive:               {
-            wasnt_here_before: {default: true}
-        }
-    }
-  }
-  let (:r) {
-    HashParams.validate_hash(sample_hash, validations, {raise_errors: false})
-  }
-
+require_relative 'spec_helper'
 
-  it 'does amazing things' do
-
-    (r.valid?).must_equal false
-
-    r[:ignored].must_be_nil
-    r[:no_value].must_equal 1
-    r[:proc_default].must_equal 5
-    r[:to_be_renamed].must_equal :to_be_renamed
-    r[:integer_coercion].must_equal 1
-    r[:bad_number].must_equal 12.0
-
-    r[:array_with_delim].must_equal ["1", "2", "3"]
-    r[:hash_as_string].must_equal ({"a" => "1", "b" => "2", "c" => "d"})
-    r[:missing_with_validation].must_equal 60 * 60
-    r[:is_true].must_equal true
-    r[:is_false].must_equal false
-
-    #recursive checking
-    r[:recursive][:wasnt_here_before].must_equal true
-
-
-    #failed items don't show up
-    r.errors.size.must_equal 2
-    r[:doesnt_exist].must_be_nil
-    r[:proc_validation].must_be_nil
-    r.errors[:doesnt_exist].must_equal 'Required Parameter missing and has no default specified'
-    r.errors[:proc_validation].must_equal 'is_this_valid? failed validation using proc'
-
-  end
-
-  it 'injects methods into returned hash' do
-
-    #set strict to false so all keys will pass trough
-    hash={will_be_injected: 12345}
-    opts={make_methods: true, strict: false}
-
-    r=HashParams.validate_hash(hash, {}, opts)
-    r[:will_be_injected].must_equal 12345
-    r.will_be_injected.must_equal 12345
-  end
-
-end
 
 describe HashParams do
-  let(:v) { HashParams}
+  let(:v) { HashParams }
 
   it 'raises error if required and missing' do
     proc {
-      v.validate(nil, required: true)
-    }.must_raise HashParams::ValidationError
+      v.validate(nil, nil, required: true)
+    }.must_raise HashParams::Validator::ValidationError
   end
+  
   it 'runs multiple coersions' do
-    v.validate('1aaa2', coerce: [lambda { |o| o.gsub('a', '') }, :to_i, Float]).must_equal 12.0
+    v.validate('1aaa2', Float, coerce: [lambda { |o| o.gsub('a', '') }, :to_i]).must_equal(12.0)
   end
 
   it 'defaults missing values' do
-    v.validate(nil, default: 1).must_equal 1
-    v.validate(nil, default: lambda { |o| 2 * 5 }).must_equal 10
+    v.validate(nil, Integer, default: 1).must_equal(1)
+    v.validate(nil, Integer, default: lambda { 2 * 5 }).must_equal(10)
   end
 
-  it 'applies defaults before other actions' do
-    v.validate(nil, coerce: Integer, :default => 60 * 60, :validate => lambda { |v| v >= 60 * 60 }).must_equal 60 * 60
+  it 'validates with lambdas' do
+    v.validate(nil, Integer, :validate => lambda { |v| v = 60 * 60 }).must_equal(60 * 60)
   end
 
   it 'validates with procs' do
-    proc {
-      v.validate('is_this_valid?') do |v|
-        v == 'Failed_proc_validation'
-      end
-    }.must_raise HashParams::ValidationError
+    v.validate('is_this_valid?', String) do |v|
+      v = 'Validated with Proc'
+    end.must_equal('Validated with Proc')
   end
 
   it 'verifies numbers with common params' do
-    v.validate(122, min: 120, max: 500, in: (100..200), is: 122).must_equal 122
+    v.validate(122, Integer, min: 120, max: 500, in: (100..200), is: 122).must_equal(122)
   end
+
   it 'verifies strings with common params' do
-    v.validate('this is a test string', min_length: 21, max_length: 30, format: /^t.*g$/).must_equal 'this is a test string'
+    v.validate('this is a test string', String, min_length: 21, max_length: 30, format: /^t.*g$/).must_equal 'this is a test string'
   end
 
   it 'coerces true' do
-    v.coerce('t', :boolean).must_equal true
-    v.coerce('true', :boolean).must_equal true
-    v.coerce('yes', :boolean).must_equal true
-    v.coerce('1',:boolean).must_equal true
-    v.coerce(1,:boolean).must_equal true
+    v.validate('t', :boolean).must_equal true
+    v.validate('true', :boolean).must_equal true
+    v.validate('yes', :boolean).must_equal true
+    v.validate('1', :boolean).must_equal true
+    v.validate(1, :boolean).must_equal true
   end
+
   it 'coerces false' do
-    v.coerce('f', :boolean).must_equal false
-    v.coerce('false', :boolean).must_equal false
-    v.coerce('no', :boolean).must_equal false
-    v.coerce('0',:boolean).must_equal false
-    v.coerce(0,:boolean).must_equal false
+    v.validate('f', :boolean).must_equal false
+    v.validate('false', :boolean).must_equal false
+    v.validate('no', :boolean).must_equal false
+    v.validate('0', :boolean).must_equal false
+    v.validate(0, :boolean).must_equal false
   end
+
+
   it 'coerces array' do
-   v.coerce('1|2|3', Array, delimiter: '|').must_equal ["1", "2", "3"]
+    v.validate('1|2|3', Array, delimiter: '|').must_equal ["1", "2", "3"]
   end
+
   it 'coerces hash' do
-    v.coerce('{a => 1,b => 2,c => d}', Hash, delimiter: ',', separator: '=>').must_equal({"a" => "1", "b" => "2", "c" => "d"})
+    v.validate('{a => 1,b => 2,c => d}', Hash, delimiter: ',', separator: '=>').must_equal({"a" => "1", "b" => "2", "c" => "d"})
   end
 
+  it 'validates a hash using a block' do
+    h = {
+        ignored:           "this will be ignored because it's not mentioned",
+        to_be_renamed:     :renamed_value,
+        'integer_coercion': "1",
+        proc_validation:   "is_this_valid?",
+        recursive:         {}
+    }
+    r = v.validate(h, Hash, symbolize_keys: true) do
+      key :doesnt_exist, nil, required: true
+      key :to_be_renamed, Symbol, as: :renamed
+      #Default Lambdas take no parameters
+      key :proc_default, Integer, default: lambda { 1 * 5 }
+      key :proc_validation, String, validate: lambda { |v| v = 'Validated in proc' }
+      #recursive
+      key :recursive, Hash do
+        key :wasnt_here_before, :boolean, default: true
+      end
+    end
 
-end
+    (r.valid?).must_equal false
+    r[:ignored].must_be_nil
+    # r[:proc_default].must_equal 5
+    r[:renamed].must_equal :renamed_value
+    #recursive checking
+    r[:recursive][:wasnt_here_before].must_equal true
 
+    #failed items don't show up
+    r[:doesnt_exist].must_be_nil
+    r[:proc_validation].must_equal 'Validated in proc'
+
+    r.validation_errors.size.must_equal 1
+    r.validation_errors[0].must_equal "Error processing key 'doesnt_exist': Required Parameter missing and has no default specified"
+
+  end
+
+  it 'validates variables in the local binding' do
+
+    x='10'
+    y='this is a test string'
+    z={}
+    will_be_int='100'
+
+    HashParams.with_binding do
+      var :x, Integer, min: 10, max: 100
+      var :y, String, min_length: 21, max_length: 30, format: /^t.*g$/
+      var :z, Hash, raise_errors: true, symbolize_keys: true, make_methods: true do
+        key :blah, String, default: 1
+      end
+      var :will_be_int, :to_i
+    end
+    x.must_equal 10
+    y.must_equal 'this is a test string'
+    z[:blah].must_equal '1'
+    z.blah.must_equal '1'
+    will_be_int.must_equal 100
+  end
+
+
+end
 
 
 ```

data/lib/hash_params/hash_validator.rb

@@ -33,19 +33,26 @@ module HashParams
 
       @incoming = h
       @outgoing = HPHash.new
-      @options  = options
+      @options = options
 
       if block_given?
         instance_eval(&Proc.new)
       else
         #no proc was given this means just pass the hash back as is
-        @outgoing = @incoming
+        if @options.empty?
+          @outgoing = @incoming
+        else
+          h.each do |k, v|
+            key k, v.class, @options
+          end
+        end
+
       end
       @outgoing
     end
 
     def key(hash_key, type, opts={})
-      value     = @incoming[hash_key] || @incoming[hash_key.to_s]
+      value = @incoming[hash_key] || @incoming[hash_key.to_s]
       # if a block is given to the param then it's a recursive call
       # recursive calls can only be done with a hash
       new_value = if value.is_a?(Hash)
@@ -58,7 +65,7 @@ module HashParams
                   else
                     HashParams.validate value, type, opts
                   end
-      hash_key  = opts[:as] if opts[:as]
+      hash_key = opts[:as] if opts[:as]
       @outgoing.set_key_value(hash_key, new_value, @options[:symbolize_keys], @options[:make_methods])
       new_value
     rescue => e
@@ -66,6 +73,7 @@ module HashParams
       raise e if @options[:raise_errors]
       nil
     end
+
     alias_method :param, :key
   end
 end

data/lib/hash_params.rb

@@ -8,7 +8,7 @@ require_relative 'hash_params/binding_validator'
 
 module HashParams
   ENVIRONMENT =  ENV['HASH_PARAMS_ENV'] || (defined?(Rails) && Rails.env) || ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
-  VERSION = '2.0.1'
+  VERSION = '2.0.2'
   extend HashParams::Validator
 end
 

data/spec/hash_params_spec.rb

@@ -9,6 +9,7 @@ describe HashParams do
       v.validate(nil, nil, required: true)
     }.must_raise HashParams::Validator::ValidationError
   end
+
   it 'runs multiple coersions' do
     v.validate('1aaa2', Float, coerce: [lambda { |o| o.gsub('a', '') }, :to_i]).must_equal(12.0)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash_params
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Tim Uckun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-19 00:00:00.000000000 Z
+date: 2016-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -93,66 +93,12 @@ files:
 - "./LICENSE"
 - "./README.md"
 - "./Rakefile"
-- "./coverage/assets/0.8.0/application.css"
-- "./coverage/assets/0.8.0/application.js"
-- "./coverage/assets/0.8.0/colorbox/border.png"
-- "./coverage/assets/0.8.0/colorbox/controls.png"
-- "./coverage/assets/0.8.0/colorbox/loading.gif"
-- "./coverage/assets/0.8.0/colorbox/loading_background.png"
-- "./coverage/assets/0.8.0/favicon_green.png"
-- "./coverage/assets/0.8.0/favicon_red.png"
-- "./coverage/assets/0.8.0/favicon_yellow.png"
-- "./coverage/assets/0.8.0/loading.gif"
-- "./coverage/assets/0.8.0/magnify.png"
-- "./coverage/assets/0.8.0/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png"
-- "./coverage/assets/0.8.0/smoothness/images/ui-bg_flat_75_ffffff_40x100.png"
-- "./coverage/assets/0.8.0/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png"
-- "./coverage/assets/0.8.0/smoothness/images/ui-bg_glass_65_ffffff_1x400.png"
-- "./coverage/assets/0.8.0/smoothness/images/ui-bg_glass_75_dadada_1x400.png"
-- "./coverage/assets/0.8.0/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png"
-- "./coverage/assets/0.8.0/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png"
-- "./coverage/assets/0.8.0/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png"
-- "./coverage/assets/0.8.0/smoothness/images/ui-icons_222222_256x240.png"
-- "./coverage/assets/0.8.0/smoothness/images/ui-icons_2e83ff_256x240.png"
-- "./coverage/assets/0.8.0/smoothness/images/ui-icons_454545_256x240.png"
-- "./coverage/assets/0.8.0/smoothness/images/ui-icons_888888_256x240.png"
-- "./coverage/assets/0.8.0/smoothness/images/ui-icons_cd0a0a_256x240.png"
-- "./coverage/assets/0.9.0/application.css"
-- "./coverage/assets/0.9.0/application.js"
-- "./coverage/assets/0.9.0/colorbox/border.png"
-- "./coverage/assets/0.9.0/colorbox/controls.png"
-- "./coverage/assets/0.9.0/colorbox/loading.gif"
-- "./coverage/assets/0.9.0/colorbox/loading_background.png"
-- "./coverage/assets/0.9.0/favicon_green.png"
-- "./coverage/assets/0.9.0/favicon_red.png"
-- "./coverage/assets/0.9.0/favicon_yellow.png"
-- "./coverage/assets/0.9.0/loading.gif"
-- "./coverage/assets/0.9.0/magnify.png"
-- "./coverage/assets/0.9.0/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png"
-- "./coverage/assets/0.9.0/smoothness/images/ui-bg_flat_75_ffffff_40x100.png"
-- "./coverage/assets/0.9.0/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png"
-- "./coverage/assets/0.9.0/smoothness/images/ui-bg_glass_65_ffffff_1x400.png"
-- "./coverage/assets/0.9.0/smoothness/images/ui-bg_glass_75_dadada_1x400.png"
-- "./coverage/assets/0.9.0/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png"
-- "./coverage/assets/0.9.0/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png"
-- "./coverage/assets/0.9.0/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png"
-- "./coverage/assets/0.9.0/smoothness/images/ui-icons_222222_256x240.png"
-- "./coverage/assets/0.9.0/smoothness/images/ui-icons_2e83ff_256x240.png"
-- "./coverage/assets/0.9.0/smoothness/images/ui-icons_454545_256x240.png"
-- "./coverage/assets/0.9.0/smoothness/images/ui-icons_888888_256x240.png"
-- "./coverage/assets/0.9.0/smoothness/images/ui-icons_cd0a0a_256x240.png"
-- "./coverage/index.html"
 - "./hash_params.gemspec"
 - "./lib/hash_params.rb"
 - "./lib/hash_params/binding_validator.rb"
 - "./lib/hash_params/hash_validator.rb"
 - "./lib/hash_params/validator.rb"
 - "./lib/hash_params/yaml_params.rb"
-- "./tmp/hash_params.rb"
-- "./tmp/hash_params_spec.rb"
-- "./tmp/module_spec.rb"
-- "./tmp/var_spec.rb"
-- "./tmp/yaml_params.rb"
 - spec/hash_params_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/timuckun/hash_params
@@ -175,11 +121,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Parameter Validation & Type Coercion for parameters passed in as a Hash..
 test_files:
 - spec/hash_params_spec.rb
 - spec/spec_helper.rb
-has_rdoc: