parametron 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c2c555f4c77e6938803fc5b9831d8bd311084d2
-  data.tar.gz: 5889c94d61d3e643d14c39b26a2183641c69e0ed
+  metadata.gz: ead50f33629a792269e16c9daf73a101bf8abfe5
+  data.tar.gz: 9e3b6a0e03cb2888e34b14b5fbfd3d885f29d907
 SHA512:
-  metadata.gz: c9d9b8ab542d19b2a39a9d8e67864c2bce0c863e4ee6205885f3c0ee7fb51209826ac1686d9743cb09f25513d120e2f97e9b3ff6b7f93e532cafd79f7b8b8263
-  data.tar.gz: ba6a86a480b8f002965c9693513b2b5918d215774b46ff49c206209d1c960bc0555196d5d0f6c599d84d6524e5801e30c5032afc23495855a40b0c90c0b6345e
+  metadata.gz: cedeb7a75197ff92e15528204dd57535b86f0882d457e7fb7059d6ca614b6f2e8594121ae14addd9b1a580005270544c5623f134433c6ca8cae31c2dda96fdb9
+  data.tar.gz: 35708d414d02d7a497a482979db61aebaa89c05a37708a33550ac192bec40ece64d7194ffcf28ff657b43246acd17990873769aef9a8e1c351feeb26b44e2dd6

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+0.3.0 / 2014-07-30
+==================
+ * Implement casting input parameter

data/README.md

@@ -1,6 +1,6 @@
 # Parametron
 
-This simple library implements DSL for validating method input parameters
+This simple library implements DSL for validating and type casting input parameters for method.
 
 ## Installation
 

data/lib/parametron.rb

@@ -27,13 +27,32 @@ module Parametron
       original = instance_method(name.to_sym)
       remove_method(name.to_sym)
       define_method(name) do |params={}|
-        new_params = _rename_params!(_validate!(_set_defaults!(params)))
+        new_params = _rename_params!(_cast!(_validate!(_set_defaults!(params))))
         original.bind(self).call(new_params)
       end
     end
   end
 
   private
+  def _cast!(params)
+    new_par = params.dup
+    _validators_list.each do |v|
+      next unless v.cast
+      key = v.name.to_sym
+      val = new_par[key]
+      next if val.nil? and not v.required?
+      new_par[key] =
+        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)
+        else
+          raise MalformedParams.new("Unknown cast type: '#{v.cast.inspect}'")
+        end
+    end
+    new_par
+  end
+
   def _rename_params!(params)
     new_par = params.dup
     _validators_list.each do |v|

data/lib/parametron/params_validator.rb

@@ -13,22 +13,27 @@ class Parametron::ParamsValidator
     default   = opts.delete(:default)
     validator = opts.delete(:validator)
     as        = opts.delete(:as)
+    cast      = opts.delete(:cast)
+
     raise Parametron::ErrorMethodParams.new("Not available param: #{opts.inspect}") unless opts.empty?
-    self.optional_vals << OptionalParameter.new(name.to_s, default, validator, as)
+    self.optional_vals << OptionalParameter.new(name.to_s, default, validator, as, cast)
   end
 
   def required(name, opts={})
     default   = opts.delete(:default)
     validator = opts.delete(:validator)
     as        = opts.delete(:as)
+    cast      = opts.delete(:cast)
+
     raise Parametron::ErrorMethodParams.new("Not available param: #{opts.inspect}") unless opts.empty?
-    self.required_vals << RequiredParameter.new(name.to_s, default, validator, as)
+    self.required_vals << RequiredParameter.new(name.to_s, default, validator, as, cast)
   end
 
   def validate!(obj, params)
     obj.validation_error_cause = []
     normalized_param_keys = params.keys.map(&:to_s).sort
     exceed_params = normalized_param_keys - valid_keys
+
     if exceed_params.any?
       exceed_params.each do |par|
         obj.validation_error_cause << [par, params[par.to_sym]]
@@ -72,10 +77,10 @@ class Parametron::ParamsValidator
     self.required_vals.map{|x| x.name.to_s}.sort
   end
 
-  class GenericParameter < Struct.new(:name, :default, :validator, :as)
-    def initialize(name, default, validator, as)
+  class GenericParameter < Struct.new(:name, :default, :validator, :as, :cast)
+    def initialize(name, default, validator, as, cast)
       super
-      unless as.nil? || String===as || Symbol===as
+      unless as.nil? || String === as || Symbol === as
         raise ArgumentError.new("Parameter :as should be either String or Symbol!")
       end
     end
@@ -91,9 +96,15 @@ class Parametron::ParamsValidator
   end
 
   class OptionalParameter < GenericParameter
+    def required?
+      false
+    end
   end
 
   class RequiredParameter < GenericParameter
+    def required?
+      true
+    end
   end
 
 

data/lib/parametron/version.rb

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

data/parametron.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Parametron::VERSION
   spec.authors       = ["Yury Batenko"]
   spec.email         = ["jurbat@gmail.com"]
-  spec.description   = %q{DSL for method arguments validation}
-  spec.summary       = %q{DSL for method arguments validation}
+  spec.description   = %q{DSL for method arguments validation and casting}
+  spec.summary       = %q{DSL for method arguments validation and casting}
   spec.homepage      = "http://github.com/svenyurgensson/parametron"
   spec.license       = "MIT"
 

data/spec/casting_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+describe Parametron, "Casting" do
+
+  context 'accepts and provide casting input values' do
+    it 'knows cast parameter' do
+      expect do
+        class Victim
+          include Parametron
+          params_for(:fetch) do
+            required :year,  validator: /\d+/, cast: Float
+          end
+          def fetch(params); params; end
+        end
+      end.not_to raise_error
+    end
+
+    it 'cast input value to Integer' do
+      class VictimI
+        include Parametron
+        params_for(:fetch) do
+          required :year,  validator: /\d+/, cast: Integer
+        end
+        def fetch(params); params; end
+      end
+
+      v = VictimI.new
+      expect do
+        v.fetch(year: '1974')
+      end.not_to raise_error
+      res = v.fetch(year: '1974')
+      res[:year].should == 1974
+    end
+
+    it 'cast input value to Float' do
+      class VictimF
+        include Parametron
+        params_for(:fetch) do
+          required :weight,  validator: /\A[.\d]+\z/, cast: Float
+        end
+        def fetch(params); params; end
+      end
+
+      v = VictimF.new
+      expect do
+        v.fetch(weight: '94.55')
+      end.not_to raise_error
+      res = v.fetch(weight: '94.55')
+      res[:weight].should == 94.55
+    end
+
+
+    it 'cast input value using proc' do
+      class VictimP
+        include Parametron
+        params_for(:fetch) do
+          required :name,  cast: -> n { n.upcase }
+        end
+        def fetch(params); params; end
+      end
+
+      res = VictimP.new.fetch(name: 'use proc')
+      res[:name].should == "USE PROC"
+    end
+
+    context "when params cannot be casted to given class" do
+      it 'raises exception when not Integer' do
+        class Victim3
+          include Parametron
+          params_for(:fetch) do
+            required :year, cast: Integer
+          end
+          def fetch(params); params; end
+        end
+
+        expect do
+          Victim3.new.fetch(year: 'Not Year')
+        end.to raise_error
+      end
+
+
+
+    end
+
+    it 'not raises exception on casting when parameter not required' do
+        class VictimNotStrict
+          include Parametron
+          params_for(:fetch) do
+            optional :year, cast: Integer
+          end
+          def fetch(params); params; end
+        end
+
+        expect do
+          VictimNotStrict.new.fetch()
+        end.not_to raise_error
+      end
+
+
+
+  end
+
+end

data/spec/parametron_spec.rb

@@ -125,14 +125,14 @@ describe Parametron do
     end
 
     it 'reject unexpected params' do
-      class Victim
+      class VictimUP
         include Parametron
         params_for(:fetch) do
           optional :city, default: 'Krasnoyarsk'
         end
         def fetch(params);  params ; end
       end
-      v = Victim.new
+      v = VictimUP.new
       expect do
         v.fetch({'_'=>'Not needed'})
       end.not_to raise_error

metadata

@@ -1,67 +1,68 @@
 --- !ruby/object:Gem::Specification
 name: parametron
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Yury Batenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-27 00:00:00.000000000 Z
+date: 2014-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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: rspec
   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'
-description: DSL for method arguments validation
+description: DSL for method arguments validation and casting
 email:
 - jurbat@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -70,6 +71,7 @@ files:
 - lib/parametron/params_validator.rb
 - lib/parametron/version.rb
 - parametron.gemspec
+- spec/casting_spec.rb
 - spec/parametron_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/svenyurgensson/parametron
@@ -82,20 +84,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: DSL for method arguments validation
+summary: DSL for method arguments validation and casting
 test_files:
+- spec/casting_spec.rb
 - spec/parametron_spec.rb
 - spec/spec_helper.rb