validate 1.0.3 → 1.1

data/lib/validate/kongo.rb

@@ -1,5 +1,3 @@
-
-
 require 'kongo'
 require 'validate'
 
@@ -18,6 +16,16 @@ module Kongo
       model = ::Kongo::Model.new(hash, coll)
       model.validates?
     end
+
+    # Returns any failures on `hash` if it were to be inserted.
+    #
+    def validation_failures(hash)
+      hash = hash.dup
+      hash['_id'] = BSON::ObjectId.new unless hash.include?('_id')
+      model = ::Kongo::Model.new(hash, coll)
+      model.validates?
+      model.failures
+    end
   end
 
   class Model

data/lib/validate/parser.rb

@@ -32,7 +32,7 @@ module Validate
 
     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/
-      raise NoMethodError.new("Undefined validation method: #{method}...") unless ValidationMethods.respond_to?(method)
+      raise NoMethodError.new("Undefined validation method: #{method}...") unless ValidationMethods.new.respond_to?(method)
       opts = args.pop if args.last.is_a?(::Hash)
       children = if block
         BlockParsingContext.parse(&block)

data/lib/validate/validations/meta.rb

@@ -0,0 +1,34 @@
+
+# This is the sillyness required to implement the DSL for the validations file.
+#
+# Metaprogramming woooooo, though!
+#
+module Validate
+  class ValidationMethods
+
+    def self.method_added(name)
+      return unless @next_reason
+      reason = @next_reason
+      @next_reason = nil
+
+      (@reasons ||= {})[name.to_s] = reason
+    end
+
+    def self.reason(name)
+      reason = (@reasons || {})[name.to_s] || "did not validate."
+    end
+
+    private
+    def self.fails_because_key(reason = nil, &block)
+      raise ArgumentError.new('Must provide either a reason string or block.') unless reason || block
+      @next_reason = reason || block
+    end
+
+    class ArgumentFailureBlockScope
+      def initialize(obj, field, opts, validator)
+        @obj, @field, @opts, @validator = obj, field, opts, validator
+      end
+      attr_reader :obj, :field, :opts, :validator 
+    end
+  end
+end

data/lib/validate/validations.rb

@@ -1,4 +1,5 @@
 
+require 'validate/validations/meta'
 module Validate
 
   # Every validation method has four arguments:
@@ -8,7 +9,7 @@ module Validate
   #   opts:       the options for the validation
   #   validator:  a Validator object that can be used for children
   #
-  module ValidationMethods
+  class ValidationMethods
 
     # Validate a field by executing a block in the context of the field.
     #
@@ -16,7 +17,8 @@ module Validate
     #
     #   validates :type, with: -> { is_a?(String) && self =~ /^a/ }
     #
-    def self.validates(obj, field, opts, validator)
+    fails_because_key 'failed to match a custom validation.'
+    def validates(obj, field, opts, validator)
       true == obj[field].instance_exec(&opts[:with])
     end
 
@@ -26,7 +28,8 @@ module Validate
     #
     #   validates_presence_of :field
     #
-    def self.validates_presence_of(obj, field, opts, validator)
+    fails_because_key 'was not present.'
+    def validates_presence_of(obj, field, opts, validator)
       obj.include?(field)
     end
 
@@ -34,7 +37,8 @@ module Validate
     #
     #   validates_type_of :name, is: String
     #
-    def self.validates_type_of(obj, field, opts, validator)
+    fails_because_key { "was not of type #{opts[:is]}." }
+    def validates_type_of(obj, field, opts, validator)
       obj.include?(field) && obj[field].is_a?(opts[:is])
     end
 
@@ -42,7 +46,7 @@ module Validate
     #
     #   validates_inclusion_of :type, in: %w(paid free)
     #
-    def self.validates_inclusion_of(obj, field, opts, validator)
+    def validates_inclusion_of(obj, field, opts, validator)
       opts[:in].include?(obj[field])
     end
 
@@ -50,7 +54,7 @@ module Validate
     #
     #   validates_numericality_of :amount
     #
-    def self.validates_numericality_of(obj, field, opts, validator)
+    def validates_numericality_of(obj, field, opts, validator)
       obj[field].is_a?(Numeric)
     end
 
@@ -58,7 +62,7 @@ module Validate
     #
     #   validates_value_of :field, is: 'something'
     #
-    def self.validates_value_of(obj, field, opts, validator)
+    def validates_value_of(obj, field, opts, validator)
       obj.include?(field) && obj[field] == opts[:is]
     end
 
@@ -69,7 +73,7 @@ module Validate
     #     validates_numericality_of :amount
     #   end
     #
-    def self.validates_child_hash(obj, field, opts, validator)
+    def validates_child_hash(obj, field, opts, validator)
       return false unless obj[field].respond_to?(:to_hash)
       hash = obj[field].to_hash
       validator.validates?(hash)
@@ -85,7 +89,7 @@ module Validate
     #     validates_type_of :self, is: String
     #   end
     #
-    def self.validates_array(obj, field, opts, validator)
+    def validates_array(obj, field, opts, validator)
       return false unless obj[field].respond_to?(:to_a)
       array = obj[field].to_a
       array.map do |e|
@@ -97,7 +101,7 @@ module Validate
     #
     #  validates_regex :field, matches: /^hello/
     #
-    def self.validates_regex(obj, field, opts, validator)
+    def validates_regex(obj, field, opts, validator)
       return false unless obj[field].respond_to?(:=~)
       0 == (obj[field] =~ opts[:matches])
     end

data/lib/validate/validator.rb

@@ -10,7 +10,7 @@ module Validate
     end
 
     def validates?(context)
-      bool = @validations
+      @failures = @validations
         .map do |v|
           # destructure fields
           v[:fields].map {|f| v.merge(fields: f) }
@@ -23,16 +23,28 @@ module Validate
           when_opt = -> { self.to_hash.include?(v[:fields]) } if when_opt == :is_set
           !when_opt.is_a?(Proc) || context.instance_exec(&when_opt)
         end
+        .map do |v|
+          # fetch reasons
+          {reason: (v[:opts] || {})[:reason] || ValidationMethods.reason(v[:name])}.merge(v)
+        end
         .map do |v|
           # lastly, execute validation
           validator = if v[:validations]
             Validator.new(v[:validations])
           end
-          ValidationMethods.send(v[:name], context.to_hash, v[:fields], v[:opts], validator)
-        end
-        .reduce {|a,b| a && b }
-        # return the result as a boolean
-      bool.nil? ? true : bool
+          success = ValidationMethods.new.send(v[:name], context.to_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]) :
+              v[:reason]
+            {v[:fields] => reason}
+          end
+        end.select {|v| !v.nil? } # discard successes
+      @failures.count == 0
+    end
+
+    def failures
+      @failures || []
     end
   end
 

data/lib/validate/version.rb

@@ -1,4 +1,4 @@
 
 module Validate
-  VERSION = '1.0.3'
+  VERSION = '1.1'
 end

data/lib/validate.rb

@@ -24,7 +24,13 @@ module Validate
   # May throw a nil NoMethodError if validations are not defined properly.
   #
   def validates?
-    self.class.validations.validates?(self)
+    @validator = self.class.validations.dup
+    @validator.validates?(self)
+  end
+
+  def failures
+    return [] unless @validator
+    @validator.failures
   end
 
 end

data/spec/validate_spec.rb

@@ -40,6 +40,54 @@ describe Validate do
 
   end
 
+  context 'single failure' do
+
+    before do
+      class TestClass < BaseTestClass
+        validations do
+          validates_presence_of 'name'
+        end
+      end
+    end
+
+    it 'should have no failures before running the test' do
+      test = TestClass.new({"not_name" => :hello})
+      test.failures.should == []
+    end
+
+    it 'should have the correct failure array' do
+      test = TestClass.new({"not_name" => :hello})
+      test.validates?.should == false
+      test.failures.should == [{'name'=>'was not present.'}]
+    end
+
+    it 'should have an empty failure array when test succeeds' do
+      test = TestClass.new({"name" => :hello})
+      test.validates?.should == true
+      test.failures.should == []
+    end
+
+  end
+
+  context 'multiple failures' do
+
+    before do
+      class TestClass < BaseTestClass
+        validations do
+          validates_presence_of 'name', reason: -> { 'MUST BE HERE' } # lambda here helps test two things at once
+          validates_type_of :something, is: String
+        end
+      end
+    end
+
+    it 'should have the correct failure array' do
+      test = TestClass.new({"not_name" => :hello})
+      test.validates?.should == false
+      test.failures.should == [{'name'=>'MUST BE HERE'}, {:something=>'was not of type String.'}]
+    end
+
+  end
+
   context 'multiple fields' do
 
     before do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: validate
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: '1.1'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-16 00:00:00.000000000 Z
+date: 2013-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -43,6 +43,7 @@ files:
 - lib/validate/kongo.rb
 - lib/validate/parser.rb
 - lib/validate/validations.rb
+- lib/validate/validations/meta.rb
 - lib/validate/validator.rb
 - lib/validate/version.rb
 - spec/validate_spec.rb