parametric 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  metadata.gz: ea2ea42f0944e44e3fa09a487428f6b8cd6ef61f
-  data.tar.gz: 5e058214303cc07ac28f93924529efe8b88875fc
-SHA512: 
-  metadata.gz: e418038925d9b0e9c302cfd616b8148dd855377aaf1fa3d69ec7cb9f821add9c6e649bb096bb539fb581b4c2fcb6ca2b51ea23fc953530930daa71cdb754d184
-  data.tar.gz: 6efb123579da71f5195f3a36f5a02a0747193c55a60217c2061afc3186367cfe28bf5798c09ba11da82335b05a9e2cd83b2434964457685e9c3e905df621d45a
+---
+SHA1:
+  metadata.gz: 2e111716f0cd0f60d10a0354e70ac7ecfea42634
+  data.tar.gz: 2012ce66941c5a24f4bf8b3f2dc7e7ceab86311a
+SHA512:
+  metadata.gz: f146875b9b83e0b8e85cc89ff04dc817e731653bbda09d0a54c85db1957ef68b6b0007e52a9cda1a704069d9438a4d0b205acc6ce12ef62429f1ab316c4ad800
+  data.tar.gz: d52634e2b6526a3c81ecef0126a6558351beb030b49f28ae6c07861d2d389d777cbbbfc710f6d32ebf55f9fe6f55b8d9fe8b7fb18b697363f20b7b49c828f767

data/README.md

@@ -57,7 +57,7 @@ class OrdersSearch
 
   def results
     query = Order.sort(params[:sort])
-    query = query.where(["code LIKE ? OR user_name ?", params[:q]]) if params[:q]
+    query = query.where(["code LIKE ? OR user_name LIKE ?", params[:q]]) if params[:q]
     query = query.where(status: params[:status]) if params[:status].any?
     query = query.paginate(page: params[:page], per_page: params[:per_page])
   end
@@ -151,6 +151,36 @@ order_search.schema[:status].multiple # => true
 order_search.schema[:status].default # => 'closed'
 ```
 
+## Coercing values
+
+Param definitions take an optional `:coerce` option with a symbol or proc to coerce resulting values.
+
+```ruby
+class UsersSearch
+  include Parametric::Params
+  param :age, 'User age', coerce: :to_i
+  param :name, 'User name', coerce: lambda{|name| "Mr. #{name}"}
+end
+
+search = UsersSearch.new(age: '36', name: 'Ismael')
+
+search.available_params[:age] # => 36
+search.available_params[:name] # => 'Mr. Ismael'
+```
+
+### Parametric::TypedParams
+
+The `Parametric::TypedParams` module includes extra DSL methods to coerce values to standard Ruby types.
+
+class UsersSearch
+  include Parametric::TypedParams
+  integer :age, 'User age'
+  array :accounts
+  string :country_code
+  # you can still use :coerce
+  param :name, 'User name', coerce: lambda{|name| "Mr. #{name}"}
+end
+
 ## Parametric::Hash
 
 The alternative `Parametric::Hash` class makes your objects quack like a hash, instead of exposing the `#params` object directly.
@@ -158,9 +188,9 @@ The alternative `Parametric::Hash` class makes your objects quack like a hash, i
 ```ruby
 class OrdersParams < Parametric::Hash
   param :q, 'Full text search query'
-  param :page, 'Page number', default: 1
-  param :per_page, 'Items per page', default: 30
-  param :status, 'Order status', options: ['checkout', 'pending', 'closed', 'shipped'], multiple: true
+  integer :page, 'Page number', default: 1
+  integer :per_page, 'Items per page', default: 30
+  array :status, 'Order status', options: ['checkout', 'pending', 'closed', 'shipped']
 end
 ```
 

data/lib/parametric/hash.rb

@@ -1,7 +1,7 @@
 require 'forwardable'
 module Parametric
   class Hash
-    include Params
+    include TypedParams
     include Enumerable
     extend ::Forwardable
     def_delegators(:params,

data/lib/parametric/params.rb

@@ -43,6 +43,7 @@ module Parametric
     def _reduce(raw_params)
       self.class._allowed_params.each_with_object(ParamsHash.new) do |(key,options),memo|
         policy = Policies::Policy.new((raw_params.has_key?(key) ? raw_params[key] : []), options)
+        policy = policy.wrap(Policies::CoercePolicy)   if options[:coerce]
         policy = policy.wrap(Policies::NestedPolicy)   if options[:nested]
         policy = policy.wrap(Policies::MultiplePolicy) if options[:multiple]
         policy = policy.wrap(Policies::OptionsPolicy)  if options[:options]

data/lib/parametric/policies.rb

@@ -44,6 +44,20 @@ module Parametric
       end
     end
 
+    class CoercePolicy < Policy
+      def value
+        decorated.value.map do |v|
+          if options[:coerce].is_a?(Symbol) && v.respond_to?(options[:coerce])
+            v.send(options[:coerce])
+          elsif options[:coerce].respond_to?(:call)
+            options[:coerce].call v
+          else
+            v
+          end
+        end
+      end
+    end
+
     class SinglePolicy < Policy
       def value
         decorated.value.first

data/lib/parametric/typed_params.rb

@@ -0,0 +1,23 @@
+require 'parametric/params'
+module Parametric
+  module TypedParams
+    def self.included(base)
+      base.send(:include, Params)
+      base.extend DSL
+    end
+
+    module DSL
+      def integer(field_name, label = '', opts = {}, &block)
+        param(field_name, label, opts.merge(coerce: :to_i), &block)
+      end
+
+      def string(field_name, label = '', opts = {}, &block)
+        param(field_name, label, opts.merge(coerce: :to_s), &block)
+      end
+
+      def array(field_name, label = '', opts = {}, &block)
+        param(field_name, label, opts.merge(multiple: true), &block)
+      end
+    end
+  end
+end

data/lib/parametric/version.rb

@@ -1,3 +1,3 @@
 module Parametric
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/parametric.rb

@@ -6,4 +6,5 @@ require "parametric/utils"
 require "parametric/version"
 require "parametric/policies"
 require "parametric/params"
+require "parametric/typed_params"
 require "parametric/hash"

data/parametric.gemspec

@@ -20,5 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", '2.14.1'
 end

data/spec/parametric_spec.rb

@@ -5,103 +5,133 @@ describe Parametric do
     Parametric::VERSION.should_not be_nil
   end
 
-  describe Parametric::Params do
+  shared_examples 'a configurable params object' do
+    it 'ignores undeclared fields' do
+      subject.params.has_key?(:foo).should be_false
+    end
 
-    let(:klass) do
-      Class.new do
-        include Parametric::Params
-        param :name, 'User name'
-        param :page, 'page number', default: 1
-        param :per_page, 'items per page', default: 50
-        param :status, 'status', options: ['one', 'two', 'three'], multiple: true
-        param :piped_status, 'status with pipes', multiple: true, separator: '|'
-        param :country, 'country', options: ['UK', 'CL', 'JPN']
-        param :email, 'email', match: /\w+@\w+\.\w+/
-        param :emails, 'emails', match: /\w+@\w+\.\w+/, multiple: true, default: 'default@email.com'
-        param :available, 'available', default: true
-      end
+    it 'sets passed values' do
+      subject.params[:per_page].should == 20
     end
 
-    describe '#params' do
-      let(:subject) { klass.new(foo: 'bar', per_page: 20, status: 'four') }
+    it 'uses defaults if no value passed' do
+      subject.params[:page].should == 1
+    end
 
-      it 'ignores undeclared fields' do
-        subject.params.has_key?(:foo).should be_false
-      end
+    it 'does not set value if outside of declared options' do
+      subject.params[:status].should == []
+    end
 
-      it 'sets passed values' do
-        subject.params[:per_page].should == 20
-      end
+    it 'does not set value if it does not :match' do
+      klass.new(email: 'my@email').params[:email].should be_nil
+    end
 
-      it 'uses defaults if no value passed' do
-        subject.params[:page].should == 1
-      end
+    it 'does set value if it does :match' do
+      klass.new(email: 'my@email.com').params[:email].should == 'my@email.com'
+    end
 
-      it 'does not set value if outside of declared options' do
-        subject.params[:status].should == []
-      end
+    it 'only sets value for :multiple values that :match' do
+      klass.new(emails: 'my@email,your,her@email.com').params[:emails].should == ['her@email.com']
+    end
 
-      it 'does not set value if it does not :match' do
-        klass.new(email: 'my@email').params[:email].should be_nil
-      end
+    it 'returns :default wrapped in array if :multiple' do
+      klass.new().params[:emails].should == ['default@email.com']
+    end
 
-      it 'defaults work for false values' do
-        klass.new(email: 'my@email').params[:email].should be_nil
-      end
+    it 'turns :multiple comma-separated values into arrays' do
+      klass.new(status: 'one,three').params[:status].should == ['one', 'three']
+    end
 
-      it 'does set value if it does :match' do
-        klass.new(available: false).params[:available].should be_false
-      end
+    it 'does set value if it does :match' do
+      klass.new(email: 'my@email.com').params[:email].should == 'my@email.com'
+    end
 
-      it 'only sets value for :multiple values that :match' do
-        klass.new(emails: 'my@email,your,her@email.com').params[:emails].should == ['her@email.com']
-      end
+    it ':multiple values can be arrays' do
+      klass.new(status: ['one','three']).params[:status].should == ['one', 'three']
+    end
 
-      it 'returns :default wrapped in array if :multiple' do
-        klass.new().params[:emails].should == ['default@email.com']
-      end
+    it 'defaults work for false values' do
+      klass.new(email: 'my@email').params[:email].should be_nil
+    end
 
-      it 'turns :multiple comma-separated values into arrays' do
-        klass.new(status: 'one,three').params[:status].should == ['one', 'three']
-      end
+    it 'does set value if it does :match' do
+      klass.new(available: false).params[:available].should be_false
+    end
 
-      it ':multiple values can be arrays' do
-        klass.new(status: ['one','three']).params[:status].should == ['one', 'three']
-      end
+    it 'turns :multiple separated values with custom separator into arrays' do
+      klass.new(piped_status: 'one|three').params[:piped_status].should == ['one', 'three']
+    end
 
-      it 'turns :multiple separated values with custom separator into arrays' do
-        klass.new(piped_status: 'one|three').params[:piped_status].should == ['one', 'three']
-      end
+    it 'does not turn non-multiple comma-separated values into arrays' do
+      klass.new(name: 'foo,bar').params[:name].should == 'foo,bar'
+    end
 
-      it 'does not turn non-multiple comma-separated values into arrays' do
-        klass.new(name: 'foo,bar').params[:name].should == 'foo,bar'
-      end
+    it 'filters out undeclared options' do
+      klass.new(status: 'one,three,fourteen').params[:status].should == ['one', 'three']
+    end
 
-      it 'filters out undeclared options' do
-        klass.new(status: 'one,three,fourteen').params[:status].should == ['one', 'three']
-      end
+    it 'defaults empty multiple options to empty array' do
+      klass.new().params[:status].should == []
+    end
 
-      it 'defaults empty multiple options to empty array' do
-        klass.new().params[:status].should == []
-      end
+    it 'wraps single multiple options in array' do
+      klass.new(status: 'one').params[:status].should == ['one']
+    end
 
-      it 'wraps single multiple options in array' do
-        klass.new(status: 'one').params[:status].should == ['one']
-      end
+    it 'does not accept comma-separated values outside of options unless :multiple == true' do
+      klass.new(country: 'UK,CL').params[:country].should be_nil
+    end
 
-      it 'does not accept comma-separated values outside of options unless :multiple == true' do
-        klass.new(country: 'UK,CL').params[:country].should be_nil
-      end
+    it 'does accept single option' do
+      klass.new(country: 'UK').params[:country].should == 'UK'
+    end
 
-      it 'does accept single option' do
-        klass.new(country: 'UK').params[:country].should == 'UK'
+    it 'does not accept single option if not in declared options' do
+      klass.new(country: 'USA').params[:country].should be_nil
+    end
+  end
+
+  describe 'TypedParams' do
+    let(:klass) do
+      Class.new do
+        include Parametric::TypedParams
+        string :name, 'User name'
+        integer :page, 'page number', default: 1
+        integer :per_page, 'items per page', default: 50
+        array :status, 'status', options: ['one', 'two', 'three']
+        array :piped_status, 'status with pipes', separator: '|'
+        string :country, 'country', options: ['UK', 'CL', 'JPN']
+        string :email, 'email', match: /\w+@\w+\.\w+/
+        array :emails, 'emails', match: /\w+@\w+\.\w+/, default: 'default@email.com'
       end
+    end
+
+    let(:subject) { klass.new(foo: 'bar', per_page: '20', status: 'four') }
+    it_should_behave_like 'a configurable params object'
+  end
+
+  describe Parametric::Params do
 
-      it 'does not accept single option if not in declared options' do
-        klass.new(country: 'USA').params[:country].should be_nil
+    let(:klass) do
+      Class.new do
+        include Parametric::Params
+        param :name, 'User name'
+        param :page, 'page number', default: 1, coerce: :to_i
+        param :per_page, 'items per page', default: 50, coerce: lambda{|value| value.to_i}
+        param :status, 'status', options: ['one', 'two', 'three'], multiple: true
+        param :piped_status, 'status with pipes', multiple: true, separator: '|'
+        param :country, 'country', options: ['UK', 'CL', 'JPN']
+        param :email, 'email', match: /\w+@\w+\.\w+/
+        param :emails, 'emails', match: /\w+@\w+\.\w+/, multiple: true, default: 'default@email.com'
+        param :available, 'available', default: true
       end
     end
 
+    describe '#params' do
+      let(:subject) { klass.new(foo: 'bar', per_page: 20, status: 'four') }
+      it_should_behave_like 'a configurable params object'
+    end
+
     describe '#available_params' do
       let(:subject) { klass.new(foo: 'bar', name: 'lala', per_page: 20, status: 'four', emails: 'one@email.com,two@email.com') }
 
@@ -113,6 +143,16 @@ describe Parametric do
         subject.available_params[:page].should == 1
       end
 
+      describe ':coerce option' do
+        it 'accepts method_name as a symbol' do
+          klass.new(page: '10').available_params[:page].should == 10
+        end
+
+        it 'accepts a proc' do
+          klass.new(per_page: '10').available_params[:per_page].should == 10
+        end
+      end
+
       describe '#flat' do
         it 'joins values back' do
           subject.available_params.flat[:emails].should == 'one@email.com,two@email.com'
@@ -163,8 +203,8 @@ describe Parametric do
   describe Parametric::Hash do
     let(:klass) do
       Class.new(Parametric::Hash) do
-        param :name, 'User name'
-        param :page, 'page number', default: 1
+        string :name, 'User name'
+        integer :page, 'page number', default: 1
         param :per_page, 'items per page', default: 50
       end
     end

metadata

@@ -1,55 +1,65 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: parametric
-version: !ruby/object:Gem::Version 
-  version: 0.0.3
+version: !ruby/object:Gem::Version
+  version: 0.0.4
 platform: ruby
-authors: 
+authors:
 - Ismael Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-04-03 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.5"
+      - !ruby/object:Gem::Version
+        version: '1.5'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - &id003 
-      - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id003
+  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: 2.14.1
   type: :development
-  version_requirements: *id004
-description: Useful for modelling search or form objects, white-listed query parameters and safe parameter defaults.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+description: Useful for modelling search or form objects, white-listed query parameters
+  and safe parameter defaults.
+email:
 - ismaelct@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - .travis.yml
@@ -61,37 +71,39 @@ files:
 - lib/parametric/hash.rb
 - lib/parametric/params.rb
 - lib/parametric/policies.rb
+- lib/parametric/typed_params.rb
 - lib/parametric/utils.rb
 - lib/parametric/version.rb
 - parametric.gemspec
 - spec/nested_params_spec.rb
 - spec/parametric_spec.rb
 - spec/spec_helper.rb
-homepage: ""
-licenses: 
+homepage: ''
+licenses:
 - MIT
 metadata: {}
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id003
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id003
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: DSL for declaring allowed parameters with options, regexp patern and default values.
-test_files: 
+summary: DSL for declaring allowed parameters with options, regexp patern and default
+  values.
+test_files:
 - spec/nested_params_spec.rb
 - spec/parametric_spec.rb
 - spec/spec_helper.rb
-has_rdoc: