validation-sets 1.0.0 → 1.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+rdoc

data/README.rdoc

@@ -0,0 +1,59 @@
+= Validation Sets
+
+A Rails plugin to bundle validations in sets. You can turn entire sets of validations on or off on
+an instance. This allows you to use different sets of validations for various user roles in the
+application, or for different stages in the lifetime of the model.
+
+  validation_set_for(:activation) do |set|
+    set.validates_presence_of :fullname, :username, :email
+    set.validate :password_should_fit_requirements
+  end
+
+
+== The Case of the Organization
+
+Let's assume we have an organization in our application. The organization represents a company
+using the application. Administrators add these organizations, but often they don't have all the
+information about the company yet. It's up to the contact at the organization to complete it.
+
+  class Organization < ActiveRecord::Base
+    validates_presence_of :name
+    
+    validation_set_for(:contact) do |set|
+      set.validates_presence_of :address, :zipcode, :city
+    end
+  end
+
+Now we can have two controllers, one of the administrator and one for the contact. For the
+administrator we don't run any validations except on name so she can choose to fill out any
+of the field.
+
+  class Administrator::OrganizationsController < ActionController::Base
+    allow_access :administrator
+    
+    def create
+      @organization = Organization.new(params[:organization])
+      if @organization.save
+        redirect_to [:administrator, @organization]
+      else
+        render :new
+      end
+    end
+  end
+
+For the contact we turn on the extra set of validations for the contact so all the fields
+need to be filled out.
+
+  class Contact::OrganizationsController < ActionController::Base
+    allow_access(:contact) { @organization = @authenticated.organization }
+    
+    def update
+      @organization.attributes = params[:organization].slice(:address, :zipcode, :city)
+      @organization.use_validation_set(:contact)
+      if @organization.save
+        redirect_to [:contact, @organization]
+      else
+        render :edit
+      end
+    end
+  end

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/lib/validation_sets/validation_set.rb

@@ -1,22 +1,28 @@
 module ValidationSets
+  # A ValidationSet instance is used to redirect the original validation methods (validate,
+  # validate_on_create, and validate_on_update) to the callback chain for the set.
   class ValidationSet
     def initialize(model, label)
       @model = model
       @label = label
     end
     
+    # Adds a validation method or proc that always runs
     def validate(*params, &block)
       send(validation_set_method(:save, @label), *params, &block)
     end
     
+    # Adds a validation method or proc that runs on create
     def validate_on_create(*params, &block)
       send(validation_set_method(:create, @label), *params, &block)
     end
     
+    # Adds a validation method or proc that runs on update
     def validate_on_update(*params, &block)
       send(validation_set_method(:update, @label), *params, &block)
     end
     
+    # Forwards all other methods (ie. validates_presence_of) to the model class.
     def method_missing(method, *attributes, &block)
       @model.send(method, *attributes, &block)
     end

data/lib/validation_sets.rb

@@ -1,8 +1,11 @@
 module ValidationSets
   autoload :ValidationSet, 'validation_sets/validation_set'
   
+  # Used to set the current validation set during definition of the model
   attr_accessor :current_validation_set
   
+  # Returns the name of the validation callback method for a save method and the label of a
+  # validation set.
   def validation_set_method(on, label)
     case on
       when :save   then "validate_#{label}_set".to_sym
@@ -11,6 +14,7 @@ module ValidationSets
     end
   end
   
+  # Returns the name of the validation callback method for a save method.
   def validation_method(on)
     if current_validation_set
       validation_set_method(on, current_validation_set)
@@ -19,6 +23,20 @@ module ValidationSets
     end
   end
   
+  # Returns true if the validation set is defined on this class
+  def validation_set_defined?(set)
+    [:save, :create, :update].any? do |on|
+      respond_to?(validation_set_method(on, set))
+    end
+  end
+  
+  # Add a validation set to the model.
+  #
+  #   class Account < ActiveRecord::Base
+  #     validation_set_for(:activation) do |set|
+  #       set.validates_presence_of :username
+  #     end
+  #   end
   def validation_set_for(label, &block)
     [:save, :create, :update].each do |save_method|
       callback_chain = validation_method(save_method)
@@ -41,15 +59,29 @@ module ValidationSets
   module InstanceMethods
     attr_reader :_validation_set
     
+    # Set the active validation set on the model. After calling this both the global as well as
+    # the validations defined in the set will run.
+    #
+    # Raises an exception when asked to use an unknown validation set.
+    #
+    # Example:
+    #
+    #   account = Account.new
+    #   account.use_validation_set(:admin) # Turns on the :admin validation set
+    #   account.use_validation_set(nil)    # Turns off all validation sets
     def use_validation_set(set)
-      @_validation_set = set
+      if self.class.validation_set_defined?(set)
+        @_validation_set = set
+      else
+        raise ArgumentError, "There is no validation set `#{set}'"
+      end
     end
   end
 end
 
-class ActiveRecord::Base
-  class << self
-    include ValidationSets
+module ActiveRecord #:nodoc:
+  class Base #:nodoc:
+    extend ValidationSets
+    include ValidationSets::InstanceMethods
   end
-  include ValidationSets::InstanceMethods
 end

data/test/validation_sets_test.rb

@@ -88,6 +88,13 @@ class ValidationSetsTest < ActiveSupport::TestCase
     assert account.save
   end
   
+  test "an exception is raised when trying to activate an unknown validation set" do
+    account = Account.new
+    assert_raises(ArgumentError) do
+      account.use_validation_set(:unknown)
+    end
+  end
+  
   def setup
     ValidationSetsTests::Initializer.setup_database
   end

data/validation-sets.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{validation-sets}
-  s.version = "1.0.0"
+  s.version = "1.1.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.date = %q{2010-08-05}
   s.description = %q{A Rails plugin that adds validation sets to Active Record.}
   s.email = %q{manfred@fngtps.com}
   s.extra_rdoc_files = [
@@ -17,7 +17,8 @@ Gem::Specification.new do |s|
      "README.rdoc"
   ]
   s.files = [
-    ".kick",
+    ".gitignore",
+     ".kick",
      "LICENSE",
      "README.rdoc",
      "Rakefile",
@@ -33,7 +34,7 @@ Gem::Specification.new do |s|
   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.rubygems_version = %q{1.3.7}
   s.summary = %q{A Rails plugin that adds validation sets to Active Record.}
   s.test_files = [
     "test/test_helper.rb",
@@ -45,7 +46,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
     else
     end
   else

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: validation-sets
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  hash: 19
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Manfred Stienstra
@@ -9,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-26 00:00:00 +01:00
+date: 2010-08-05 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -23,6 +29,7 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
+- .gitignore
 - .kick
 - LICENSE
 - README.rdoc
@@ -45,21 +52,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A Rails plugin that adds validation sets to Active Record.