validation-sets 1.0.0

data/.kick

@@ -0,0 +1 @@
+recipe :ruby

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Fingertips, Manfred Stienstra <manfred@fngtps.com>
+
+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/Rakefile

@@ -0,0 +1,35 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Validation Sets'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "validation-sets"
+    s.summary = s.description = "A Rails plugin that adds validation sets to Active Record."
+    s.homepage = "http://fingertips.github.com"
+    s.email = "manfred@fngtps.com"
+    s.authors = ["Manfred Stienstra"]
+  end
+rescue LoadError
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/validation_sets.rb

@@ -0,0 +1,55 @@
+module ValidationSets
+  autoload :ValidationSet, 'validation_sets/validation_set'
+  
+  attr_accessor :current_validation_set
+  
+  def validation_set_method(on, label)
+    case on
+      when :save   then "validate_#{label}_set".to_sym
+      when :create then "validate_on_create_#{label}_set".to_sym
+      when :update then "validate_on_update_#{label}_set".to_sym
+    end
+  end
+  
+  def validation_method(on)
+    if current_validation_set
+      validation_set_method(on, current_validation_set)
+    else
+      super
+    end
+  end
+  
+  def validation_set_for(label, &block)
+    [:save, :create, :update].each do |save_method|
+      callback_chain = validation_method(save_method)
+      callback_chain_for_set = validation_set_method(save_method, label)
+      unless respond_to?(callback_chain_for_set)
+        define_callbacks(callback_chain_for_set)
+        define_method(callback_chain_for_set) { run_callbacks(callback_chain_for_set) }
+        send(callback_chain, callback_chain_for_set, :if => Proc.new { |r| label.to_sym == r._validation_set })
+      end
+    end
+    
+    validation_set = ValidationSet.new(self, label)
+    
+    before = current_validation_set
+    self.current_validation_set = label.to_sym
+    block.call(validation_set)
+    self.current_validation_set = before
+  end
+  
+  module InstanceMethods
+    attr_reader :_validation_set
+    
+    def use_validation_set(set)
+      @_validation_set = set
+    end
+  end
+end
+
+class ActiveRecord::Base
+  class << self
+    include ValidationSets
+  end
+  include ValidationSets::InstanceMethods
+end

data/lib/validation_sets/validation_set.rb

@@ -0,0 +1,24 @@
+module ValidationSets
+  class ValidationSet
+    def initialize(model, label)
+      @model = model
+      @label = label
+    end
+    
+    def validate(*params, &block)
+      send(validation_set_method(:save, @label), *params, &block)
+    end
+    
+    def validate_on_create(*params, &block)
+      send(validation_set_method(:create, @label), *params, &block)
+    end
+    
+    def validate_on_update(*params, &block)
+      send(validation_set_method(:update, @label), *params, &block)
+    end
+    
+    def method_missing(method, *attributes, &block)
+      @model.send(method, *attributes, &block)
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'validation_sets'

data/test/test_helper.rb

@@ -0,0 +1,64 @@
+module ValidationSetsTests
+  module Initializer
+    VENDOR_RAILS = File.expand_path('../../../../../vendor/rails', __FILE__)
+    OTHER_RAILS = File.expand_path('../../../rails', __FILE__)
+    PLUGIN_ROOT = File.expand_path('../../', __FILE__)
+    
+    def self.rails_directory
+      if File.exist?(VENDOR_RAILS)
+        VENDOR_RAILS
+      elsif File.exist?(OTHER_RAILS)
+        OTHER_RAILS
+      end
+    end
+    
+    def self.load_dependencies
+      if rails_directory
+        $:.unshift(File.join(rails_directory, 'activesupport', 'lib'))
+        $:.unshift(File.join(rails_directory, 'activerecord', 'lib'))
+      else
+        require 'rubygems' rescue LoadError
+      end
+      
+      require 'test/unit'
+      
+      require 'active_support'
+      require 'active_support/test_case'
+      require 'active_record'
+      require 'active_record/test_case'
+      require 'active_record/base' # this is needed because of dependency hell
+      
+      $:.unshift File.expand_path('../../lib', __FILE__)
+      require File.join(PLUGIN_ROOT, 'rails', 'init')
+    end
+    
+    def self.configure_database
+      ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+      ActiveRecord::Migration.verbose = false
+    end
+    
+    def self.setup_database
+      ActiveRecord::Schema.define(:version => 1) do
+        create_table :accounts do |t|
+          t.column :fullname, :string
+          t.column :email, :string
+          t.column :username, :string
+          t.column :password, :string
+        end
+      end
+    end
+    
+    def self.teardown_database
+      ActiveRecord::Base.connection.tables.each do |table|
+        ActiveRecord::Base.connection.drop_table(table)
+      end
+    end
+    
+    def self.start
+      load_dependencies
+      configure_database
+    end
+  end
+end
+
+ValidationSetsTests::Initializer.start

data/test/validation_sets/validation_set_test.rb

@@ -0,0 +1,9 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+class ValidationSetTest < ActiveSupport::TestCase
+  test "forwards missing methods to the model" do
+    model = 'Model'
+    validation_set = ValidationSets::ValidationSet.new(model, :admin)
+    assert_equal 5, validation_set.length
+  end
+end

data/test/validation_sets_test.rb

@@ -0,0 +1,98 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class Account < ActiveRecord::Base
+  attr_accessor :current_password
+  
+  private
+  
+  def password_should_match_management_requirements
+    if password.blank?
+      errors.add(:password, "can't be blank")
+    elsif password !~ /\d/
+      errors.add(:password, "should contain at least one number")
+    end
+  end
+  
+  def password_should_match_current
+    if send(:attribute_was, 'password') != current_password
+      errors.add(:current_password, "is wrong")
+    end
+  end
+  
+  validates_presence_of :fullname
+  
+  # Admins create accounts with a blank username and password
+  validation_set_for(:admin) do |set|
+    set.validates_presence_of :email, :on => :create
+  end
+  
+  # Members are force to choose a username and password during activation
+  validation_set_for(:activation) do |set|
+    set.validates_presence_of :email
+    set.validates_presence_of :username
+    set.validate :password_should_match_management_requirements
+  end
+  
+  # Members need to set the current password when updating their account after activation
+  validation_set_for(:member) do |set|
+    set.validates_presence_of :email
+    set.validates_presence_of :username
+    set.validate :password_should_match_management_requirements
+    set.validate :password_should_match_current
+  end
+end
+
+class ValidationSetsTest < ActiveSupport::TestCase
+  
+  test "global validation should always run" do
+    account = Account.new
+    assert !account.valid?
+    assert account.errors.on(:fullname)
+    
+    account.fullname = "Patricia Herder"
+    assert account.valid?
+    assert account.errors.empty?
+  end
+  
+  test "a validation set runs when it's active" do
+    account = Account.new
+    account.use_validation_set(:activation)
+    assert !account.valid?
+    assert account.errors.on(:email)
+    assert account.errors.on(:username)
+    assert account.errors.on(:password)
+    
+    account.fullname = "Patricia Herder"
+    account.email = 'patricia@example.com'
+    account.username = 'patricia'
+    account.password = 'secret1'
+    assert account.valid?
+    assert account.errors.empty?
+  end
+  
+  test "a validation in a validation set runs a the correct time" do
+    account = Account.new
+    account.use_validation_set(:admin)
+    assert !account.valid?
+    assert account.errors.on(:fullname)
+    assert account.errors.on(:email)
+    
+    account.fullname = "Patricia Herder"
+    account.email = 'patricia@example.com'
+    assert account.valid?
+    assert account.errors.empty?
+    
+    assert account.save
+    
+    account.email = nil
+    assert account.save
+  end
+  
+  def setup
+    ValidationSetsTests::Initializer.setup_database
+  end
+  
+  def teardown
+    ValidationSetsTests::Initializer.teardown_database
+  end
+end

data/validation-sets.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{validation-sets}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Manfred Stienstra"]
+  s.date = %q{2010-03-26}
+  s.description = %q{A Rails plugin that adds validation sets to Active Record.}
+  s.email = %q{manfred@fngtps.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".kick",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/validation_sets.rb",
+     "lib/validation_sets/validation_set.rb",
+     "rails/init.rb",
+     "test/test_helper.rb",
+     "test/validation_sets/validation_set_test.rb",
+     "test/validation_sets_test.rb",
+     "validation-sets.gemspec"
+  ]
+  s.homepage = %q{http://fingertips.github.com}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A Rails plugin that adds validation sets to Active Record.}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/validation_sets/validation_set_test.rb",
+     "test/validation_sets_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: validation-sets
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Manfred Stienstra
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-26 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: A Rails plugin that adds validation sets to Active Record.
+email: manfred@fngtps.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .kick
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/validation_sets.rb
+- lib/validation_sets/validation_set.rb
+- rails/init.rb
+- test/test_helper.rb
+- test/validation_sets/validation_set_test.rb
+- test/validation_sets_test.rb
+- validation-sets.gemspec
+has_rdoc: true
+homepage: http://fingertips.github.com
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Rails plugin that adds validation sets to Active Record.
+test_files: 
+- test/test_helper.rb
+- test/validation_sets/validation_set_test.rb
+- test/validation_sets_test.rb