hash_params 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9139c3fc879993adc169ef1d17d5c5041e9485ee
+  data.tar.gz: 7d1b1803fa43616a4c413b4b0712d1a2e6d435ba
+SHA512:
+  metadata.gz: e4cc43d988d6884e450e80829a67feb2eeb19cc48a9b3bb71dff91dde41e2db68db625ed68b05a9ec3234a496bad7c6d7164426061df2c1d8da4d26e2bb6ee7b
+  data.tar.gz: 103591043e96fae420e6c5457fdf91e519633bf27b3ab9025a2ff4372adb09c445ec8060ad87f70ac023c78a5462a419c3d83dc67a752abac2ae065d6cd785b5

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    hash_params (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    docile (1.1.5)
+    method_source (0.8.2)
+    minitest (5.4.1)
+    minitest-spec (0.0.2.1)
+      minitest (>= 3.0)
+    multi_json (1.10.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.3.2)
+    simplecov (0.9.0)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hash_params!
+  minitest
+  minitest-spec
+  pry
+  rake
+  simplecov

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Tim Uckun
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,174 @@
+# hash-params
+_Lightweight Parameter Validation & Type Coercion_
+
+This is a variation of the sinatra-param gem  https://github.com/mattt/sinatra-param
+with the sinatra specific things taken out and slight modifications to make it more useful for generic applications.
+
+**`hash-params` allows you to declare, validate, and transform endpoint parameters as you would in frameworks like [ActiveModel](http://rubydoc.info/gems/activemodel/3.2.3/frames) or [DataMapper](http://datamapper.org/). but in a lighterweight fashion**
+
+
+## Example
+
+``` ruby
+describe HashParams do
+
+  let (:r) {
+    HashParams.new(
+        {
+            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',
+        }
+    ) do
+      param :doesnt_exist, required: true
+      param :to_be_renamed, as: :renamed
+      param :no_value, default: 1
+      #proc default relying on previously set value
+      param :proc_default, default: lambda { |o| o[:no_value] * 5 }
+      param :integer_coercion, coerce: Integer
+      #chained coersions of various types
+      param :bad_number, coerce: [lambda { |o| o.gsub('a', '') }, :to_i, Float]
+      #arrays and hashes
+      param :array_with_delim, coerce: Array, delimiter: '|'
+      param :hash_as_string, coerce: Hash, delimiter: ',', separator: '=>'
+      param :proc_validation, validate: lambda { |v| v == 'Failed_proc_validation' }
+      #validations
+      param :some_number, min: 120, max: 500, in: (100..200), is: 122
+      param :some_string, min_length: 21, max_length: 30, format: /^t.*g$/
+      #combinations
+      param :missing_with_validation, coerce: Integer, :default => 60 * 60, :validate => lambda { |v| v >= 60 * 60 }
+      param :is_true, coerce: :boolean
+      param :is_false, coerce: :boolean
+    end
+  }
+
+
+  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[:renamed].must_equal :to_be_renamed
+    r[:integer_coercion].must_equal 1
+    r[:bad_number].must_equal 12.0
+    #no deep coersion
+    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
+
+    #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[0].must_equal 'Parameter doesnt_exist is required and missing'
+    r.errors[1].must_equal 'is_this_valid? failed validation using proc'
+
+  end
+
+  it 'injects into current class' do
+    r = HashParams.new({will_be_injected: 12345}, self) do
+      param :will_be_injected
+    end
+    r[:will_be_injected].must_equal 12345
+    @will_be_injected.must_equal 12345
+    will_be_injected.must_equal 12345
+  end
+
+end
+
+
+```
+
+
+### Defaults
+
+Passing a `default` option will provide a default value for a parameter if none is passed.  A `default` can defined as either a default or as a `Proc`:
+
+```ruby
+param :attribution, String, default: "©"
+param :year, Integer, default: lambda { Time.now.year }
+```
+
+
+### 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`
+
+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`)
+- `:boolean` _("1/0", "true/false", "t/f", "yes/no", "y/n")_
+
+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
+
+
+### Validations
+
+Encapsulate business logic in a consistent way with validations. If a parameter does not satisfy a particular condition the parameter is not added to the result and an entry is made into the errors collection.
+
+- `required`
+- `blank`
+- `is`
+- `in`, `within`, `range`
+- `min` / `max`
+- `format`
+
+**Only valid entries are returned, all others are ignored**
+
+
+### Exceptions and Validation Failures
+
+All recorded validation errors, coercion errors, and exceptions are in the errors collection of the returned object. You can also call the valid? method to check to see if everything went OK.
+
+```ruby
+p = HashParams.new({a: :b}) do 
+      param :a
+    end
+
+p.errors.inspect unless p.valid?
+```
+
+### Injection into classes
+
+You can if you choose inject all passing variables (but not valid? or errors collection) into a given class.  The injection is done via  `attr_accessor` The values are injected into the singleton so no need to worry about polluting other objects.
+
+```ruby
+it 'injects into current class' do
+    r = HashParams.new({will_be_injected: 12345}, self) do
+      param :will_be_injected
+    end
+    r[:will_be_injected].must_equal 12345
+    @will_be_injected.must_equal 12345
+    will_be_injected.must_equal 12345
+  end
+```
+
+
+## Contact
+
+Tim Uckun
+
+- http://github.com/timuckun
+- http://twitter.com/timuckun
+- tim@uckun.com
+
+## License
+
+hash-parameters is available under the MIT license. See the LICENSE file for more info.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler"
+Bundler.setup
+
+specfile='hash-params.gemspec'
+gemspec = eval(File.read(specfile))
+
+task :build => "#{gemspec.full_name}.gem"
+
+file "#{gemspec.full_name}.gem" => gemspec.files + [specfile] do
+  system "gem build #{specfile}"
+end