validation-scopes 0.0.3 → 0.4.0

data/Gemfile

@@ -3,5 +3,6 @@ source "http://rubygems.org"
 gemspec
 
 group :test do
+  gem "activemodel"
   gem "rspec"
 end

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    validation-scopes (0.0.1)
+    validation-scopes (0.0.3)
       activemodel
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.0.4)
-      activesupport (= 3.0.4)
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
       builder (~> 2.1.2)
       i18n (~> 0.4)
-    activesupport (3.0.4)
+    activesupport (3.0.5)
     builder (2.1.2)
     diff-lcs (1.1.2)
     i18n (0.5.0)
@@ -28,5 +28,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  activemodel
   rspec
   validation-scopes!

data/README.md

@@ -1,23 +1,27 @@
 # Validation Scopes
 
-Validation Scopes allows you to group validations together that share the same conditions. It depends on ActiveModel. Example:
+Validation Scopes allows you to remove duplication in validations by grouping validations that share the same conditions. It works the same way as ActiveSupport's OptionMerger does, except instead of replacing duplicate keys it groups them into an array. This is so that nested if conditions work inside ActiveModel validations. Example, with result shown in comments:
 
     class Car < ActiveRecord::Base
-      validation_scope :if => Proc.new { |u| u.step == 2 } do
-        validates_presence_of :variant
-        validates_presence_of :body
+      validation_scope :if => Proc.new { |u| u.step == 2 } do |v|
+        v.validates_presence_of :variant # , :if => Proc.new { |u| u.step == 2 }
+        v.validation_scope :if => :something? do |s|
+          s.validates_presence_of :body # , :if => [Proc.new { |u| u.step == 2 }, :something?]
+        end
       end
       
-      validation_scope :if => Proc.new { |u| i.step == 3 } do
-        validates_inclusion_of :outstanding_finance, :in => [true, false], :if => Proc.new { |u| u.finance == true }
+      validation_scope :if => Proc.new { |u| u.step == 3 } do |v|
+        v.validates_inclusion_of :outstanding_finance, :in => [true, false], :if => Proc.new { |u| u.finance == true }
         # Duplicate keys are turned into arrays
-        # In this case InclusionValidator would get an array containing both Procs in the :if attribute
+        # :if => [Proc.new { |u| u.finance == true }, Proc.new { |u| i.step == 3 }]
         
-        validate do
+        v.validate do # v.validate :if => Proc.new { |u| u.step == 3 }
           errors.add(:weight, "Must be greater than 0") unless !@weight.nil? && @weight > 0
         end
       end
     end
+
+The options passed into the validation_scope method will usually be either :if or :unless, but any are accepted and they are passed onto the individual validators.
     
 # Installation
 

data/lib/validation_scopes.rb

@@ -1,54 +1,59 @@
 require 'active_support/concern'
-require 'active_model'
 
 module ValidationScopes
   extend ActiveSupport::Concern
   
-  module ClassMethods
+  class OptionMerger
+    instance_methods.each do |method|
+      undef_method(method) if method !~ /^(__|instance_eval|class|object_id)/
+    end
 
-    def validation_scope(options, &block)
-      @_in_validation_scope = true
-      @_validation_scope_options = options
-      block.call
-      @_validation_scope_options = nil
-      @_in_validation_scope = false
-      @_handled_by_with = false
+    def initialize(context, options)
+      @context, @options = context, options
     end
     
-    def validates_with(*args, &block)
-      if @_in_validation_scope
-        merge_args(args)
-        @_handled_by_with = true
-      end
-      super(*args, &block)
+    def validation_scope(options)
+      yield OptionMerger.new(@context, merge_options(@options, options))
     end
-    
-    def validate(*args, &block)
-      if @_in_validation_scope & !@_handled_by_with
-        merge_args(args)
+
+    private
+      def method_missing(method, *arguments, &block)
+        arguments << if arguments.last.respond_to?(:to_hash)
+          merge_options(@options, arguments.pop)
+        else
+          @options.dup
+        end
+        @context.__send__(method, *arguments, &block)
       end
-      super(*args, &block)
-    end
-    
-    protected
-    
-    def merge_args(args)
-      if args.empty?
-        args << @_validation_scope_options.dup
-      elsif args.last.is_a?(Hash) && args.last.extractable_options?
-        options = args.extract_options!
-        options = options.dup
-        @_validation_scope_options.each_key do |key|
-          if options[key].nil?
-            options[key] = @_validation_scope_options[key]
+      
+      def merge_options(options_b, options_a)
+        return options_b.dup if options_a.nil?
+        options_a = options_a.dup
+        options_b.each_pair do |key, value|
+          if options_a[key].nil?
+            options_a[key] = value
           else
-            options[key] = Array.wrap(options[key])
-            options[key] << @_validation_scope_options[key]
+            options_a[key] = Array.wrap(options_a[key]) unless options_a[key].is_a?(Array)
+            if value.is_a?(Array)
+              value.each do |v|
+                options_a[key] << v
+              end
+            else
+              options_a[key] << value
+            end
           end
         end
-        args << options
+        options_a
       end
+  end
+  
+  module ClassMethods
+
+    def validation_scope(options, &block)
+      raise "Deprecated. See readme for new usage. https://github.com/stevehodgkiss/validation-scopes" if block.arity == 0
+      yield OptionMerger.new(self, options)
     end
+    
   end
 end
 

data/spec/validation_scopes_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'active_model'
 
 class TestUser
   include ActiveModel::Validations
@@ -13,32 +14,113 @@ class TestUser
   def step_2?
     step == 2
   end
+  
+  protected
+  
+  def self.method_with_options(options)
+    options
+  end
 end
 
-class TestValidator < ActiveModel::EachValidator
-  attr_accessor :options
+describe ValidationScopes do
+  
+  before do
+    TestClass = Class.new do
+      include ValidationScopes
+      
+      def self.method_with_options(options)
+        options
+      end
+      
+      def self.method_with_multiple_options(*options)
+        options
+      end
+    end
+  end
   
-  def initialize(options)
-    @options = options
-    super(options)
+  it "merges method no options" do
+    TestClass.class_eval do
+      validation_scope :if => 1 do |v|
+        v.method_with_options.should == {:if => 1}
+      end
+    end
   end
   
-  def validate(record)
-    
+  it "merges method with options" do
+    TestClass.class_eval do
+      validation_scope :if => 1 do |v|
+        v.method_with_options(:if => 2).should == {:if => [2, 1]}
+      end
+    end
+  end
+  
+  it "merges with multiple options" do
+    TestClass.class_eval do
+      validation_scope :if => 1 do |v|
+        v.method_with_multiple_options(:name, :if => 2).should == [:name, {:if => [2, 1]}]
+      end
+    end
+  end
+  
+  it "merges nested scope with no method options" do
+    TestClass.class_eval do
+      validation_scope :if => 1 do |v|
+        v.validation_scope :if => 2 do |s|
+          s.method_with_options.should == {:if => [2, 1]}
+        end
+      end
+    end
+  end
+  
+  it "merges nested scope with method options" do
+    TestClass.class_eval do
+      validation_scope :if => 1 do |v|
+        v.validation_scope :if => 2 do |s|
+          s.method_with_options(:if => 3, :unless => 6).should == {:if => [3, 2, 1], :unless => 6}
+        end
+      end
+    end
+  end
+  
+  it "merges deep nested scope with method options" do
+    TestClass.class_eval do
+      validation_scope :if => 1 do |v|
+        v.validation_scope :if => 2 do |s|
+          s.validation_scope :unless => 6 do |u|
+            u.method_with_options(:if => 3).should == {:if => [3, 2, 1], :unless => 6}
+          end
+        end
+      end
+    end
+  end
+  
+  it "fails if called without a block parameter" do
+    expect {
+      TestClass.class_eval do
+        validation_scope :if => 1 do
+        
+        end
+      end
+    }.to raise_error
   end
+  
+  after { Object.send(:remove_const, :TestClass) }
 end
 
-describe ".validation_scope" do
+describe ValidationScopes, "with AM" do
   
   context "validates_with" do
     before do
       User = Class.new(TestUser) do
         validates_presence_of :address
-        validation_scope :if => :step_2? do
-          validates_presence_of :name
+        validation_scope :if => :step_2? do |v|
+          v.validates_presence_of :name
         end
-        validation_scope :if => Proc.new { |u| u.step == 3 } do
-          validates_inclusion_of :eye_colour, :in => ["blue", "brown"], :if => Proc.new { |u| !u.age.nil? && u.age > 20 }
+        validation_scope :if => Proc.new { |u| u.step == 3 } do |v|
+          v.validation_scope :if => Proc.new { |u| !u.height.nil? && u.height > 6 } do |h|
+            h.validates_presence_of :weight
+          end
+          v.validates_inclusion_of :eye_colour, :in => ["blue", "brown"], :if => Proc.new { |u| !u.age.nil? && u.age > 20 }
         end
       end
       @user = User.new
@@ -47,76 +129,43 @@ describe ".validation_scope" do
     end
     
     it "should only validate name when on step 2" do
-      @user.name = nil
-      @user.should be_valid
-      @user.step = 2
-      @user.should be_invalid
-      @user.name = "Steve"
-      @user.should be_valid
+      @user.tap do |u|
+        u.name = nil
+        u.should be_valid
+        u.step = 2
+        u.should be_invalid
+        u.name = "Steve"
+        u.should be_valid
+      end
     end
     
     it "only validates eye colour when on step 3 and age is above 20" do
-      @user.eye_colour = nil
-      @user.should be_valid
-      @user.age = 20
-      @user.step = 3
-      @user.eye_colour = "red"
-      @user.should be_valid
-      @user.age = 21
-      @user.should be_invalid
-      @user.eye_colour = "blue"
-      @user.should be_valid
-    end
-    
-    it "calls validates_with with merged scope options" do
-      presence_validator = User.validators_on(:name).first
-      presence_validator.options.should eq({:if => :step_2?})
-    end
-  end
-  
-  context "validate method" do
-    before do
-      User = Class.new(TestUser) do
-        validation_scope :unless => :step_2? do
-          validate do
-            errors.add(:weight, "Must be greater than 0") unless !@weight.nil? && @weight > 0
-          end
-        end
+      @user.tap do |u|
+        u.eye_colour = "red"
+        u.should be_valid
+        u.age = 20
+        u.step = 3
+        u.should be_valid
+        u.age = 21
+        u.valid?
+        u.should be_invalid
+        u.eye_colour = "blue"
+        u.should be_valid
       end
     end
     
-    it "should only validate weight on step 2" do
-      user = User.new
-      user.weight = 0
-      user.should be_invalid
-      user.weight = 1
-      user.should be_valid
-      
-      user.step = 2
-      user.weight = 0
-      user.should be_valid
-    end
-  end
-  
-  context "custom validators" do
-    before do
-      User = Class.new(TestUser) do
-        validation_scope :unless => :step_2?, :some_config_var => 5 do
-          validates_with TestValidator, {:attributes => [:name], :some_config_var => 6}
-        end
+    it "allows nesting of scopes" do
+      @user.tap do |u|
+        u.weight = nil
+        u.should be_valid
+        u.height = 7
+        u.should be_valid
+        u.step = 3
+        u.should be_invalid
+        u.errors[:weight].should be
       end
-      @validator = User.validators_on(:name).first
-    end
-    
-    it "passes the options in" do
-      @validator.options[:unless].should eq(:step_2?)
-      @validator.options[:some_config_var].should be
-    end
-    
-    it "turns the duplicate options into an array" do
-      @validator.options[:some_config_var].should eq([6, 5])
     end
   end
   
-  after { Object.send(:remove_const, :User) if defined?(User) }
+  after { Object.send(:remove_const, :User) }
 end

data/validation-scopes.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "validation-scopes"
-  s.version     = "0.0.3"
+  s.version     = "0.4.0"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Steve Hodgkiss"]
   s.email       = ["steve@hodgkiss.me.uk"]

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: validation-scopes
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 3
-  version: 0.0.3
+  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors: 
 - Steve Hodgkiss
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-14 00:00:00 +00:00
+date: 2011-03-03 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,8 +21,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -67,21 +61,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: validation-scopes
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Scope ActiveModel validations