parametron 0.3.0 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ead50f33629a792269e16c9daf73a101bf8abfe5
-  data.tar.gz: 9e3b6a0e03cb2888e34b14b5fbfd3d885f29d907
+  metadata.gz: 7dcdccf1f3be6a66dcc1d9e908438f12e3455727
+  data.tar.gz: 18a54b7cbabf0e427e35b889643a9014133d84d4
 SHA512:
-  metadata.gz: cedeb7a75197ff92e15528204dd57535b86f0882d457e7fb7059d6ca614b6f2e8594121ae14addd9b1a580005270544c5623f134433c6ca8cae31c2dda96fdb9
-  data.tar.gz: 35708d414d02d7a497a482979db61aebaa89c05a37708a33550ac192bec40ece64d7194ffcf28ff657b43246acd17990873769aef9a8e1c351feeb26b44e2dd6
+  metadata.gz: beba071b20a06987b53f225baa2c93d6699e6494209002810d036d65de832d88082ed9dcb3081bfc22e68a5bfcc795d2f14e04f86180a493864bbc64226ee8dc
+  data.tar.gz: a4ab379a513fc033c48f342f254f34b8b67c8b376ba6e2da4628089e3d6ea3e2b0ce915282464fc14043561be27745c9164a703d358f1c7fdb1f01a4c7da865b

data/.ruby-gemset

@@ -0,0 +1 @@
+parametron

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.2

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
 rvm:
   - 1.9.3
-  - 2.0.0
+  - 2.0.0
+  - 2.2.0
+  - 2.3.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+0.3.5 / 2015-12-29
+==================
+ * Implement call cast lambda with parameters
+
 0.3.0 / 2014-07-30
 ==================
  * Implement casting input parameter

data/README.md

@@ -1,45 +1,134 @@
 # Parametron
 
+[![Code Climate](https://codeclimate.com/github/svenyurgensson/parametron/badges/gpa.svg)](https://codeclimate.com/github/svenyurgensson/parametron)
+[![Test Coverage](https://codeclimate.com/github/svenyurgensson/parametron/badges/coverage.svg)](https://codeclimate.com/github/svenyurgensson/parametron/coverage)
+
 This simple library implements DSL for validating and type casting input parameters for method.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'parametron'
+    gem 'parametron', '>= 0.3'
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it as:
 
     $ gem install parametron
 
 ## Usage
 
 ```ruby
-
     class VictimStrict
-        include Parametron
+        include Parametron # <- should be at the top of class/module
 
         params_for(:fetch, strict: true) do
           required :city,   validator: /\w+/
           required :year,   validator: /\d{4}/
-          optional :title,  validator: ->(str){ str != "Moscow" }
+          optional :title,  validator: ->(str){ str != "Moscow" }, cast: ->(str){ str.upase }
           optional :number, validator: /\d+/, default: 42
           optional :gears,  default: ->(obj){ choose_by(obj) }
           optional :weel_d, as: :weel_diameter
+          optional :load,   cast: Float
         end
 
         def fetch params
-          # .. do something useful
+          # .. do something useful with params
         end
       end
 ```
 
-See `spec/parametron_spec` how this library suppossed to work.
-All hackers do this and you should too!
+The main aim of this small gem is to implement base AOP (aspect oriented programming) to separate validation, conversion and setting defaults for methods from real businnes logic which should be the only body of that method without validators, convertors, default setters overhead.
+
+In order to get this functionality you only need to include `Parametron` module into top of your class and after that describe desired incoming parameters for method.
+
+```ruby
+    class Example
+        include Parametron # <- should be at the top of class/module
+
+        params_for(:fetch) do
+            ...
+        end
+    end
+```
+
+Class method `params_for` accepts one or two arguments: first is symbolized name of method of interest and second one (optional) is hash of two options:
+
+* `strict` which is defaultly set to `false`
+* `reject` which is defaultly set to `false` too
+
+`strict` when set to `true` means that when you call your method and try to send unknown (not described) key - it raise error `Parametron::ExcessParameter`
+`reject` when set to `true` reject undescribed keys from method arguments
+
+```ruby
+    class ExampleStrict
+        include Parametron # <- should be at the top of class/module
+
+        params_for(:fetch, strict: true) do
+            optional :one
+        end
+
+        def fetch par
+        end
+    end
+
+    ex = ExampleStrict.new.fetch({unexpected: 'argument'})
+    # => raises Parametron::ExcessParameter
+```
+
+```ruby
+    class ExampleReject
+        include Parametron # <- should be at the top of class/module
+
+        params_for(:fetch, reject: true) do
+            optional :one
+        end
+
+        def fetch par
+          par
+        end
+    end
+
+    ex = ExampleReject.new.fetch({one: '1', unexpected: 'argument'})
+    p ex
+    # => {one: '1'}
+```
+
+Method `params_for` should provide description block where you describe required and optional parameters for given method:
+
+```ruby
+    params_for(:fetch) do
+      required :city,   validator: /\w+/
+      required :year,   validator: /\d{4}/
+      optional :title,  validator: ->(str){ str != "Moscow" }, cast: ->(str){ str.upase }
+      optional :number, validator: /\d+/, default: 42
+      optional :gears,  default: ->(obj){ choose_by(obj) }
+      optional :weel_d, as: :weel_diameter
+      optional :load,   cast: Float
+    end
+```
+
+When parameter is `required` it must present in argument hash.
+Instead, parameter described as `optional` might present but don't must.
+
+All of that parameter descriptors can have such refinements:
+
+* `validator` with `Regexp` or `proc` predicat to be sure that input parameter is valid
+* `cast` which could be one of: `Integer`, `Float`, `proc` to convert input parameter
+* `default` to set input parameter to its default value in case if it not presents
+* `as` to rename input parameter name to new one
+
+
+When `cast` options is a lambda/proc you could have current input hash and (if need)
+original input hash. It is depends of arity of lambda you provide.
+If your `cast` lambda arity is 1 then it receive current value to cast; when its arity is 2
+then it receive |current_value, current_casted_parameters| and when its arity is 3
+it will get |current_value, current_casted_parameters, original_params|
+This could be handy when you want to have access to other parameters from input hash already
+casted.
 
 
 ## Contributing

data/lib/parametron.rb

@@ -25,7 +25,9 @@ module Parametron
       return if name != @_method_name or instance_variable_get(:"@_METHOD_#{name}_WRAPPED")
       instance_variable_set(:"@_METHOD_#{name}_WRAPPED", true)
       original = instance_method(name.to_sym)
+
       remove_method(name.to_sym)
+
       define_method(name) do |params={}|
         new_params = _rename_params!(_cast!(_validate!(_set_defaults!(params))))
         original.bind(self).call(new_params)
@@ -45,7 +47,13 @@ module Parametron
         case
         when v.cast.to_s == "Integer" then Integer(val)
         when v.cast.to_s == "Float"   then Float(val)
-        when Proc === v.cast          then v.cast.call(val)
+        when Proc === v.cast
+          case v.cast.arity
+          when 0 then v.cast.call()
+          when 1 then v.cast.call(val)
+          when 2 then v.cast.call(val, new_par)
+          else v.cast.call(val, new_par, params)
+          end
         else
           raise MalformedParams.new("Unknown cast type: '#{v.cast.inspect}'")
         end

data/lib/parametron/version.rb

@@ -1,3 +1,3 @@
 module Parametron
-  VERSION = "0.3.0"
+  VERSION = "0.3.4"
 end

data/spec/casting_spec.rb

@@ -63,6 +63,21 @@ describe Parametron, "Casting" do
       res[:name].should == "USE PROC"
     end
 
+    it 'cast input value using proc and have access to already casted params' do
+      class VictimDoubleCast
+        include Parametron
+        params_for(:fetch) do
+          required :year,  cast: -> x { Integer(x) + 12 }
+          required :name,  cast: -> n, c { n.upcase + " #{c[:year]}"  }
+        end
+        def fetch(params); params; end
+      end
+
+      res = VictimDoubleCast.new.fetch(year: '1976', name: 'use proc')
+      res[:name].should == "USE PROC 1988"
+    end
+
+
     context "when params cannot be casted to given class" do
       it 'raises exception when not Integer' do
         class Victim3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parametron
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.4
 platform: ruby
 authors:
 - Yury Batenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-30 00:00:00.000000000 Z
+date: 2015-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,6 +61,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -94,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: DSL for method arguments validation and casting