validation_group 0.1.3

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+pkg
+rdoc
+coverage
+*.log

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,33 @@
+ValidationGroup
+===============
+
+When doing multipage forms that spread a models fields over several pages, validation becomes more difficult.  We would like to validate each step of the form, however, the rails validation run validation on all the fields.  This plugin enables you to define validation groups with certain fields, and then only run validation on those groups.
+
+Version:  Rails 3.  To use on Rails 2.x versions, use forked copy from https://github.com/jeffp/validationgroup
+
+To install:
+
+  Add to your Gemfile:  
+
+    gem 'validation_group', :git=>'git://github.com/akira/validationgroup.git'
+
+Example
+=======
+
+class User < ActiveRecord::Base
+  validates_presence_of :name, :description, :address, :email
+  
+  validation_group :step1, :fields=>[:name, :description]
+  validation_group :step2, :fields=>[:address]     
+end
+
+This will run validation on :step1 fields
+@user = User.new
+@user.enable_validation_group :step1
+@user.valid?
+
+You can later disable validation groups by calling:
+@user.disable_validation_group
+
+
+Copyright (c) 2007 Alex Kira, released under the MIT license

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rake'
+require 'rake/testtask'
+require 'rubygems/package_task'
+require 'rdoc/task'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'validation_group'
+  s.version = '0.1.3'
+  s.platform = Gem::Platform::RUBY
+  s.description = 'Validation groups for ActiveRecord'
+  s.summary = 'Validation groups for ActiveRecord'
+  
+  s.files = FileList['{lib,test,tasks}/**/*'] + %w(CHANGELOG.rdoc init.rb install.rb uninstall.rb MIT-LICENSE Rakefile README .gitignore) - FileList['**/*.log']
+  s.require_path = 'lib'
+  s.has_rdoc = true
+  s.test_files = Dir['test/*_test.rb']
+  
+  s.author = 'Alex Kira'
+  s.email = ''
+  s.homepage = 'http://github.com/akira/validationgroup/tree/master'
+end
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the validation_group plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the validation_group plugin.'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ValidationGroup'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README', 'CHANGELOG.rdoc', 'MIT-LICENSE')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Generate a gemspec file.'
+task :gemspec do
+  File.open("#{spec.name}.gemspec", 'w') do |f|
+    f.write spec.to_ruby
+  end
+end
+ 
+Gem::PackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+Dir['tasks/**/*.rake'].each {|rake| load rake}

data/init.rb

@@ -0,0 +1,2 @@
+require 'validation_group'
+

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/validation_group.rb

@@ -0,0 +1,122 @@
+module ValidationGroup
+  module ActiveRecord
+    module ActsMethods # extends ActiveRecord::Base
+      def self.extended(base)
+        # Add class accessor which is shared between all models and stores
+        # validation groups defined for each model
+        base.class_eval do
+          cattr_accessor :validation_group_classes
+          self.validation_group_classes = {}
+					
+          def self.validation_group_order; @validation_group_order; end
+          def self.validation_groups(all_classes = false)
+            return (self.validation_group_classes[self] || {}) unless all_classes
+            klasses = ValidationGroup::Util.current_and_ancestors(self).reverse
+            returning Hash.new do |hash|
+              klasses.each do |klass|
+                hash.merge! self.validation_group_classes[klass]
+              end
+            end
+          end
+        end
+      end
+
+      def validation_group(name, options={})
+        self_groups = (self.validation_group_classes[self] ||= {})
+        self_groups[name.to_sym] = options[:fields] || []
+        # jeffp: capture the declaration order for this class only (no
+        # superclasses)
+        @validation_group_order ||= []
+        @validation_group_order << name.to_sym
+
+        unless included_modules.include?(InstanceMethods)
+          # jeffp: added reader for current_validation_fields
+          attr_reader :current_validation_group, :current_validation_fields
+          include InstanceMethods
+          # jeffp: add valid?(group = nil), see definition below
+          alias_method_chain :valid?, :validation_group
+        end
+      end
+    end
+
+    module InstanceMethods # included in every model which calls validation_group
+			
+      def enable_validation_group(group)
+        # Check if given validation group is defined for current class or one of
+        # its ancestors
+        group_classes = self.class.validation_group_classes
+        found = ValidationGroup::Util.current_and_ancestors(self.class).
+          find do |klass|
+          group_classes[klass] && group_classes[klass].include?(group)
+        end
+        if found
+          @current_validation_group = group
+          # jeffp: capture current fields for performance optimization
+          @current_validation_fields = group_classes[found][group]
+        else
+          raise ArgumentError, "No validation group of name :#{group}"
+        end
+      end
+
+      def disable_validation_group
+        @current_validation_group = nil
+        # jeffp: delete fields
+        @current_validation_fields = nil
+      end
+			
+      # jeffp: optimizer for someone writing custom :validate method -- no need
+      # to validate fields outside the current validation group note: could also
+      # use in validation modules to improve performance
+      def should_validate?(attribute)
+	!self.validation_group_enabled? || (@current_validation_fields && @current_validation_fields.include?(attribute.to_sym))
+      end
+
+      def validation_group_enabled?
+        respond_to?(:current_validation_group) && !current_validation_group.nil?
+      end
+			
+      # eliminates need to use :enable_validation_group before :valid? call --
+      # nice
+      def valid_with_validation_group?(group=nil)
+        self.enable_validation_group(group) if group
+        valid_without_validation_group?
+      end
+    end
+
+    module Errors # included in ActiveRecord::Errors
+      def add_with_validation_group(attribute,
+          msg = nil, *args,
+          &block)
+        # jeffp: setting @current_validation_fields and use of should_validate? optimizes code
+        add_error = @base.respond_to?(:should_validate?) ? @base.should_validate?(attribute.to_sym) : true
+        add_without_validation_group(attribute, msg, *args, &block) if add_error
+      end
+			
+      def self.included(base) #:nodoc:
+        base.class_eval do
+          alias_method_chain :add, :validation_group
+        end
+      end
+    end
+  end
+
+  module Util
+    # Return array consisting of current and its superclasses down to and
+    # including base_class.
+    def self.current_and_ancestors(current)
+      [].tap do |klasses|
+        klasses << current
+        root = current.base_class
+        until current == root
+          current = current.superclass
+          klasses << current
+        end
+      end
+    end
+  end
+end
+
+# jeffp:  moved from init.rb for gemification purposes -- 
+# require 'validation_group' loads everything now, init.rb requires 'validation_group' only
+ActiveRecord::Base.send(:extend, ValidationGroup::ActiveRecord::ActsMethods)
+ActiveModel::Errors.send :include, ValidationGroup::ActiveRecord::Errors

data/tasks/validation_group_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :validation_group do
+#   # Task goes here
+# end

data/test/database.yml

@@ -0,0 +1,18 @@
+sqlite:
+  :adapter: sqlite
+  :dbfile: validation_group_plugin.sqlite.db
+sqlite3:
+  :adapter: sqlite3
+  :dbfile: validation_group_plugin.sqlite3.db
+postgresql:
+  :adapter: postgresql
+  :username: postgres
+  :password: postgres
+  :database: validation_group_plugin_test
+  :min_messages: ERROR
+mysql:
+  :adapter: mysql
+  :host: localhost
+  :username: root
+  :password:
+  :database: validation_group_plugin_test

data/test/schema.rb

@@ -0,0 +1,12 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :validation_group_models, :force => true do |t|
+    t.column :name,        :string, :limit => 255
+    t.column :description,    :string, :limit => 255
+    t.column :address,    :string, :limit => 255    
+    t.column :email,    :string, :limit => 255    
+  end
+  
+  create_table :plain_models, :force => true do |t|
+    t.column :name,        :string, :limit => 255
+  end  
+end

data/test/test_helper.rb

@@ -0,0 +1,54 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+
+gem 'activerecord', ENV['AR_VERSION'] ? "=#{ENV['AR_VERSION']}" : '>=2.1.0'
+require 'active_record'
+require 'test/unit'
+require 'validation_group'
+
+# jeffp: removed fixture loading code - unnecessary 
+# jeffp: removed environment.rb reference for gemification purposes 
+# jeffp: added code to test in sqlite memory database - speedy tests
+
+db_adapter = ENV['DB'] || begin
+  require 'rubygems'
+  require 'sqlite'
+  'sqlite'
+rescue MissingSourceFile
+  begin
+    require 'sqlite3'
+    'sqlite3'
+  rescue MissingSourceFile
+  end
+end
+
+if db_adapter.nil?
+  raise "No DB Adapter selected. Pass the DB= to pick one, or install Sqlite or Sqlite3."
+end
+
+ActiveRecord::Base.establish_connection({'adapter' => db_adapter, 'database' => ':memory:'})
+#ActiveRecord::Base.logger = Logger.new("#{File.dirname(__FILE__)}/active_record.log")
+
+connection = ActiveRecord::Base.connection
+connection.create_table(:validation_group_models, :force=>true) do |t|
+  t.string :name
+  t.string :description
+  t.string :address
+  t.string :email
+end
+connection.create_table(:validation_group_models, :force=>true) do |t|
+  t.string :name
+  t.string :description
+  t.string :address
+  t.string :email
+end
+connection.create_table(:plain_models, :force=>true) do |t|
+  t.string :name
+end
+
+class User < ActiveRecord::Base
+  validation_group :step1, :fields=>[:first_name, :last_name]
+  validation_group :step2, :fields=>[:username]
+end
+ 

data/test/validation_group_test.rb

@@ -0,0 +1,140 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
+
+class ValidationGroupModel < ActiveRecord::Base
+  validates_presence_of :name, :description, :address, :email
+  
+  validation_group :step1, :fields=>[:name, :description]
+  validation_group :step2, :fields=>[:address]     
+end
+
+class PlainModel < ActiveRecord::Base
+  validates_presence_of :name
+end
+
+class ValidationGroupTest < Test::Unit::TestCase
+  def test_validation_group_names_appear_in_order
+    order = ValidationGroupModel.validation_group_order
+    assert_not_nil order
+    assert_equal 2, order.size
+    assert_equal :step1, order[0]
+    assert_equal :step2, order[1]
+  end
+	
+  def test_validation_group_fields_for_names
+    names = ValidationGroupModel.validation_group_order
+    groups = ValidationGroupModel.validation_groups
+    assert_not_nil groups
+    fields = groups[names[0]]
+    assert_equal 2, fields.size
+    assert fields.include?(:name)
+    assert fields.include?(:description)
+    fields = groups[names[1]]
+    assert_equal 1, fields.size
+    assert fields.include?(:address)
+  end
+	
+  def test_validation_no_groups_fail
+    @model = ValidationGroupModel.new
+    assert !@model.valid?
+    assert_equal 4, @model.errors.size    
+  end
+  
+  def test_validation_group1_fail
+    @model = ValidationGroupModel.new
+    @model.enable_validation_group :step1
+    assert !@model.valid?
+    assert_equal 2, @model.errors.size    
+  end
+
+  def test_validation_group1_add_error
+    @model = ValidationGroupModel.new(:name=>"Name", :description=>"Description")
+    @model.enable_validation_group :step1
+    @model.errors.add(:name, "Name is invalid")
+    assert !@model.errors.blank?
+  end
+
+  def test_validation_group1_add_error_empty_msg
+    @model = ValidationGroupModel.new(:name=>"Name", :description=>"Description")
+    @model.enable_validation_group :step1
+    @model.errors.add(:name)
+    assert !@model.errors.blank?
+  end
+
+  def test_validation_group1_pass
+    @model = ValidationGroupModel.new(:name=>"Name", :description=>"Description")
+    @model.enable_validation_group :step1
+    assert @model.valid?
+    assert_equal 0, @model.errors.size    
+    @model.save!
+  end
+  
+  def test_validation_group2_fail
+    @model = ValidationGroupModel.new
+    @model.enable_validation_group :step2
+    assert !@model.valid?
+    assert_equal 1, @model.errors.size
+  end
+
+  def test_validation_clear_group_fail
+    @model = ValidationGroupModel.new
+    @model.enable_validation_group :step1
+    assert !@model.valid?
+    assert_equal 2, @model.errors.size        
+    @model.disable_validation_group
+    assert !@model.valid?
+    assert_equal 4, @model.errors.size    
+  end  
+  
+  def test_validation_group_invalid
+    @model = ValidationGroupModel.new
+    assert_raise ArgumentError do 
+      @model.enable_validation_group :invalid
+    end    
+  end    
+	
+  def test_should_validate_no_groups
+    @model = ValidationGroupModel.new
+    assert @model.should_validate?(:name)
+    assert @model.should_validate?(:description)
+    assert @model.should_validate?(:address)
+    assert @model.should_validate?(:email)
+  end
+	
+  def test_should_validate_group1
+    @model = ValidationGroupModel.new
+    @model.enable_validation_group(:step1)
+    assert @model.should_validate?(:name)
+    assert @model.should_validate?(:description)
+    assert !@model.should_validate?(:address)
+    assert !@model.should_validate?(:email)
+  end
+
+  def test_valid_query_sets_current
+    @model = ValidationGroupModel.new
+    @model.valid?(:step2)
+    assert_equal :step2, @model.current_validation_group
+    @model.valid?(:step1)
+    assert_equal :step1, @model.current_validation_group
+  end
+	
+  def test_valid_group1_fails
+    @model = ValidationGroupModel.new
+    assert !@model.valid?(:step1)
+  end
+	
+  def test_valid_group1_passes_and_group2_fails_then_passes
+    @model = ValidationGroupModel.new
+    @model.name = 'MyModel'
+    @model.description = 'My model'
+    assert @model.valid?(:step1)
+    assert !@model.valid?(:step2)
+    @model.address = 'uri:my_model'
+    assert @model.valid?
+  end
+  
+  def test_validation_for_models_without_validation_group
+    @model = PlainModel.new
+    assert !@model.valid?
+    assert_equal 1, @model.errors.size
+  end  	
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: validation_group
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.3
+platform: ruby
+authors: 
+- Alex Kira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-06 00:00:00 Z
+dependencies: []
+
+description: Validation groups for ActiveRecord
+email: ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/validation_group.rb
+- test/database.yml
+- test/schema.rb
+- test/test_helper.rb
+- test/validation_group_test.rb
+- tasks/validation_group_tasks.rake
+- CHANGELOG.rdoc
+- init.rb
+- install.rb
+- uninstall.rb
+- MIT-LICENSE
+- Rakefile
+- README
+- .gitignore
+homepage: http://github.com/akira/validationgroup/tree/master
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Validation groups for ActiveRecord
+test_files: 
+- test/validation_group_test.rb