parametric 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e111716f0cd0f60d10a0354e70ac7ecfea42634
-  data.tar.gz: 2012ce66941c5a24f4bf8b3f2dc7e7ceab86311a
+  metadata.gz: 4d80f56c0ada8312a25dfcc6ed080b0295f17cfa
+  data.tar.gz: 7940d26ce661dfdd7ead181f77ead1979d62413b
 SHA512:
-  metadata.gz: f146875b9b83e0b8e85cc89ff04dc817e731653bbda09d0a54c85db1957ef68b6b0007e52a9cda1a704069d9438a4d0b205acc6ce12ef62429f1ab316c4ad800
-  data.tar.gz: d52634e2b6526a3c81ecef0126a6558351beb030b49f28ae6c07861d2d389d777cbbbfc710f6d32ebf55f9fe6f55b8d9fe8b7fb18b697363f20b7b49c828f767
+  metadata.gz: 6ae1bfae9b04299ee38aff8f5be88a15dd505a6a69fd162c2be0ee261d789a2d55795603f7536d9de30df08b5548423cfbeb2db8f05cc0ce64dbc584392d46c3
+  data.tar.gz: effe305919dab6e2c4d47636b2711e1ec4600532b3f1429fecfa85234f32a50894cbde7d58334a04de3724759f4948918225ca3c139e9864e3ed0c81fb3275bb

data/README.md

@@ -124,6 +124,23 @@ search = OrdersSearch.new
 search.params[:status] # => ['closed']
 ```
 
+### :nullable fields
+
+In same cases you won't want Parametric to provide nil or empty keys for attributes missing from the input. For example when missing keys has special meaning in your application.
+
+In those cases you can add the `:nullable` option to said param definitions:
+
+```ruby
+class OrdersSearch
+  include Parametric::Params
+  param :query, 'Search query. optional', nullable: true
+  param :tags, 'Tags', multiple: true
+end
+
+search = OrdersSearch.new({})
+search.params # {tags: []}
+```
+
 ## `available_params`
 
 `#available_params` returns the subset of keys that were populated (including defaults). Useful for building query strings.
@@ -172,6 +189,7 @@ search.available_params[:name] # => 'Mr. Ismael'
 
 The `Parametric::TypedParams` module includes extra DSL methods to coerce values to standard Ruby types.
 
+```ruby
 class UsersSearch
   include Parametric::TypedParams
   integer :age, 'User age'
@@ -180,6 +198,7 @@ class UsersSearch
   # you can still use :coerce
   param :name, 'User name', coerce: lambda{|name| "Mr. #{name}"}
 end
+```
 
 ## Parametric::Hash
 

data/lib/parametric/params.rb

@@ -1,4 +1,5 @@
 require 'ostruct'
+require 'support/class_attribute'
 module Parametric
 
   class ParamsHash < Hash
@@ -13,6 +14,8 @@ module Parametric
 
     def self.included(base)
       base.send(:attr_reader, :params)
+      base.class_attribute :_allowed_params
+      base._allowed_params = {}
       base.extend DSL
     end
 
@@ -42,7 +45,9 @@ 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)
+        has_key = raw_params.respond_to?(:has_key?) && raw_params.has_key?(key)
+        value = has_key ? raw_params[key] : []
+        policy = Policies::Policy.new(value, 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]
@@ -50,13 +55,19 @@ module Parametric
         policy = policy.wrap(Policies::MatchPolicy)    if options[:match]
         policy = policy.wrap(Policies::DefaultPolicy)  if options.has_key?(:default)
         policy = policy.wrap(Policies::SinglePolicy)   unless options[:multiple]
-        memo[key] = policy.value
+        memo[key] = policy.value unless options[:nullable] && !has_key
       end
     end
 
     module DSL
-      def _allowed_params
-        @allowed_params ||= {}
+
+      # When subclasses params definitions
+      # we want to copy parent class definitions
+      # so changes in the child class
+      # don't mutate the parent definitions
+      #
+      def inherited(subclass)
+        subclass._allowed_params = self._allowed_params.dup
       end
 
       def param(field_name, label = '', opts = {}, &block)
@@ -72,4 +83,4 @@ module Parametric
 
   end
 
-end
+end

data/lib/parametric/policies.rb

@@ -38,7 +38,7 @@ module Parametric
 
     class NestedPolicy < Policy
       def value
-        decorated.value.map do |v|
+        decorated.value.find_all{|v| v.respond_to?(:has_key?)}.map do |v|
           options[:nested].new(v)
         end
       end
@@ -81,4 +81,4 @@ module Parametric
     end
 
   end
-end
+end

data/lib/parametric/version.rb

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

data/lib/support/class_attribute.rb

@@ -0,0 +1,68 @@
+begin
+  require 'active_support/core_ext/class/attribute'
+rescue LoadError
+  module Kernel
+    # Returns the object's singleton class.
+    def singleton_class
+      class << self
+        self
+      end
+    end unless respond_to?(:singleton_class) # exists in 1.9.2
+
+    # class_eval on an object acts like singleton_class.class_eval.
+    def class_eval(*args, &block)
+      singleton_class.class_eval(*args, &block)
+    end
+  end
+
+  class Module
+    def remove_possible_method(method)
+      if method_defined?(method) || private_method_defined?(method)
+        remove_method(method)
+      end
+    rescue NameError
+      # If the requested method is defined on a superclass or included module,
+      # method_defined? returns true but remove_method throws a NameError.
+      # Ignore this.
+    end
+
+    def redefine_method(method, &block)
+      remove_possible_method(method)
+      define_method(method, &block)
+    end
+  end
+
+  class Class
+    def class_attribute(*attrs)
+      attrs.each do |name|
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def self.#{name}() nil end
+          def self.#{name}?() !!#{name} end
+
+          def self.#{name}=(val)
+            singleton_class.class_eval do
+              remove_possible_method(:#{name})
+              define_method(:#{name}) { val }
+            end
+
+            if singleton_class?
+              class_eval do
+                remove_possible_method(:#{name})
+                def #{name}
+                  defined?(@#{name}) ? @#{name} : singleton_class.#{name}
+                end
+              end
+            end
+            val
+          end
+        RUBY
+
+      end
+    end
+
+    private
+    def singleton_class?
+      ancestors.first != self
+    end
+  end
+end

data/spec/parametric_spec.rb

@@ -89,6 +89,10 @@ describe Parametric do
     it 'does not accept single option if not in declared options' do
       klass.new(country: 'USA').params[:country].should be_nil
     end
+
+    it 'does not include parameters marked as :nullable' do
+      klass.new.params.has_key?(:nullable).should be_false
+    end
   end
 
   describe 'TypedParams' do
@@ -103,11 +107,25 @@ describe Parametric do
         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'
+        param :nullable, 'nullable param', nullable: true
       end
     end
 
     let(:subject) { klass.new(foo: 'bar', per_page: '20', status: 'four') }
     it_should_behave_like 'a configurable params object'
+
+    it 'does not break when value is nil' do
+      klass = Class.new do
+        include Parametric::TypedParams
+        array :friends, 'friends', nullable: true do
+          string :name, 'Name'
+        end
+      end
+      klass.new(friends: nil).params[:friends].should == []
+      klass.new(friends: []).params[:friends].should == []
+      klass.new(friends: [{name: 'foo'}]).params[:friends].first[:name].should == 'foo'
+      klass.new.params.has_key?(:friends).should be_false
+    end
   end
 
   describe Parametric::Params do
@@ -124,6 +142,7 @@ describe Parametric do
         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
+        param :nullable, 'nullable param', nullable: true
       end
     end
 
@@ -132,6 +151,12 @@ describe Parametric do
       it_should_behave_like 'a configurable params object'
     end
 
+    describe 'subclassing' do
+      let(:subclass){ Class.new(klass) }
+      let(:subject){ subclass.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') }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parametric
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Ismael Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-19 00:00:00.000000000 Z
+date: 2014-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,6 +74,7 @@ files:
 - lib/parametric/typed_params.rb
 - lib/parametric/utils.rb
 - lib/parametric/version.rb
+- lib/support/class_attribute.rb
 - parametric.gemspec
 - spec/nested_params_spec.rb
 - spec/parametric_spec.rb