validate 1.2.1 → 1.3

data/lib/validate/parser.rb

@@ -26,13 +26,24 @@ module Validate
   end
 
 
+  # CompiledValidations is a struct that represents a set of compiled
+  # validations + options, eg. whether to allow extra keys.
+  #
+  class CompiledValidations < Struct.new(:validations, :allow_keys); end
+
+
   class BlockParsingContext
 
     def initialize
+      @allow_keys = :any
       @validations = []
     end
 
-    attr_reader :validations
+    # Returns a CompiledValidations struct.
+    #
+    def validations
+      CompiledValidations.new(@validations, @allow_keys)
+    end
 
     def method_missing(method, *args, &block)
       raise NoMethodError.new("No method #{method} to call in the context of a validation block.") unless method.to_s =~ /^validates/
@@ -51,12 +62,12 @@ module Validate
 
     # `when` is a special case, its syntax is as follows:
     #
-    #   when -> { ... } do
+    #   run_when -> { ... } do
     #     # validations go here
     #   end
     #
     def run_when(condition, &block)
-      validations = Parser.parse(&block)
+      validations = Parser.parse(&block).validations
       validations.map do |v|
         v[:opts] ||= {}
         v[:opts][:when] = condition
@@ -64,6 +75,19 @@ module Validate
       end
       @validations += validations
     end
+
+    # `allow_keys` is another special case, which can be used like this:
+    #
+    #   allow_keys :any
+    #   allow_keys :valid
+    #   allow_keys %w(one two three)
+    #
+    # Defaults to :any, if not specified.
+    #
+    def allow_keys(keys)
+      @allow_keys = keys
+    end
+
   end
 end
 

data/lib/validate/validations.rb

@@ -19,7 +19,8 @@ module Validate
     #
     fails_because_key 'failed to match a custom validation.'
     def validates(obj, field, opts, validator)
-      true == obj[field].instance_exec(&opts[:with])
+      args = [obj, field].first(opts[:with].arity)
+      true == obj[field].instance_exec(*args, &opts[:with])
     end
 
     # Validates that a field exists.
@@ -64,7 +65,7 @@ module Validate
     #
     #   validates_value_of :field, is: 'something'
     #
-    fails_because_key { "was not of in #{opts[:is].inspect}." }
+    fails_because_key { "was not #{opts[:is].inspect}." }
     def validates_value_of(obj, field, opts, validator)
       obj.include?(field) && obj[field] == opts[:is]
     end

data/lib/validate/validator.rb

@@ -5,11 +5,16 @@ module Validate
   #
   class Validator
 
-    def initialize(validations)
-      @validations = validations
+    def initialize(compiled_validations)
+      @validations = compiled_validations.validations
+      @allow_keys = compiled_validations.allow_keys
     end
 
+    # TODO: this method could use some cleaning up...
+    #
     def validates?(context)
+      context_hash = context.to_hash
+
       @failures = @validations
         .map do |v|
           # destructure fields
@@ -32,14 +37,24 @@ module Validate
           validator = if v[:validations]
             Validator.new(v[:validations])
           end
-          success = ValidationMethods.new.send(v[:name], context.to_hash, v[:fields], v[:opts], validator)
+          success = ValidationMethods.new.send(v[:name], context_hash, v[:fields], v[:opts], validator)
           unless success
             reason = v[:reason].is_a?(Proc) ?
-              ValidationMethods::ArgumentFailureBlockScope.new(context.to_hash, v[:fields], v[:opts], validator).instance_exec(&v[:reason]) :
+              ValidationMethods::ArgumentFailureBlockScope.new(context_hash, v[:fields], v[:opts], validator).instance_exec(&v[:reason]) :
               v[:reason]
             {v[:fields] => reason}
           end
         end.select {|v| !v.nil? } # discard successes
+
+      if @allow_keys != :any
+        allow_keys = if @allow_keys == :valid 
+          @validations.map {|v| v[:fields]}.flatten
+        else
+          @allow_keys
+        end
+        @failures.push(*(context_hash.keys - allow_keys).map {|k| {k => 'is not a valid key.'} })
+      end
+
       @failures.count == 0
     end
 

data/lib/validate/version.rb

@@ -1,4 +1,4 @@
 
 module Validate
-  VERSION = '1.2.1'
+  VERSION = '1.3'
 end

data/spec/validate_spec.rb

@@ -248,11 +248,21 @@ describe Validate do
       test = TestClass.new(field: {test: :val})
       test.validates?.should == true
     end
-    
+
     it 'fails' do
       test = TestClass.new(field: {test: nil})
       test.validates?.should == false
     end
+
+    it 'passes arguments' do
+      class TestClass < BaseTestClass
+        validations do
+          validates :field, with: ->(o,k) { o[k] == :val }
+        end
+      end
+      test = TestClass.new(field: :val)
+      test.validates?.should == true
+    end
   end
 
   context 'validates_inclusion_of' do
@@ -544,6 +554,57 @@ describe Validate do
       hash.failures.should == []
     end
   end
-end
 
 
+  context 'when allow_keys' do
+
+    context 'is `:valid`' do
+
+      before do
+        class TestClass < BaseTestClass
+          validations do
+            allow_keys :valid
+            validates_type_of 'one', 'two', when: :is_set, is: Symbol
+          end
+        end
+      end
+
+      it 'should validate an object' do
+        test = TestClass.new({'one' => :hello})
+        test.validates?.should == true
+      end
+
+      it 'should not validate an invalid object' do
+        test = TestClass.new({'one' => :hello, 'three' => :hello})
+        test.validates?.should == false
+        test.failures.should == [{'three' => 'is not a valid key.'}]
+      end
+
+    end
+
+    context 'is an array' do
+
+      before do
+        class TestClass < BaseTestClass
+          validations do
+            allow_keys %w(one two)
+          end
+        end
+      end
+
+      it 'should validate an object' do
+        test = TestClass.new({'two' => :hello})
+        test.validates?.should == true
+      end
+
+      it 'should not validate an invalid object' do
+        test = TestClass.new({'one' => :hello, 'three' => :hello})
+        test.validates?.should == false
+        test.failures.should == [{'three' => 'is not a valid key.'}]
+      end
+
+    end
+  end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: validate
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: '1.3'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-02 00:00:00.000000000 Z
+date: 2013-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec