0
@@ -1,13 +1,98 @@
0
 When
0
 ====
0
 
0
-Introduction goes here.
0
+When adds :if and :unless conditions to ActiveRecord callbacks 
0
+and validations. It works exactly the way as the current implementation 
0
+of validates_acceptance_of.
0
 
0
+It works on all 14 callbacks:
0
+
0
+before_validation
0
+before_validation_on_create
0
+after_validation
0
+after_validation_on_create
0
+before_save
0
+before_create
0
+before_update
0
+after_create
0
+after_update
0
+after_save
0
+before_destroy
0
+after_destroy
0
+after_initialize
0
+after_find
0
+
0
+and 3 validations:
0
+
0
+validate
0
+validate_on_create
0
+validate_on_update
0
+
0
+It works when :if or :unless is passed symbols, lambdas, and strings.
0
+They should return or evaluate to a true or false value.
0
 
0
 Example
0
 =======
0
 
0
-Example goes here.
0
+class Address < ActiveRecord::Base
0
+  before_save :geolocate
0
+
0
+  def geolocate
0
+    if self.complete?
0
+      ...
0
+    end
0
+  end
0
+
0
+  def complete?
0
+    street? && city? && state? && zip?
0
+  end
0
+end
0
+
0
+In this case, we want to find the latitude and longitude of an address only if 
0
+the address is complete.
0
+
0
+Wrapping the entirety of a callback method with conditional logic is bad form.
0
+The callback should execute WHEN the model's life cycle reaches its 
0
+"before_save" point and WHEN its address is "complete."
0
+
0
+With When, the WHEN responsibility is moved to where it belongs:
0
+as part of the callback.
0
+
0
+class Address < ActiveRecord::Base
0
+  before_save :geolocate, :if => :complete?
0
+
0
+  def geolocate
0
+    ...
0
+  end
0
+
0
+  def complete?
0
+    street? && city? && state? && zip?
0
+  end
0
+end
0
+
0
+The callback's single responsibility is to execute code WHEN certain conditions are met.
0
+The geolocate method's single responsibility is to ... geolocate.
0
+
0
+More Examples
0
+=============
0
+
0
+after_update :send_notifications, :unless => lambda {|record| record.minor_change?}
0
+
0
+after_initialize :capitalize_title, :if => :new_record?
0
+
0
+before_create %{self.password = password.to_sha1},
0
+  :unless => lambda {|user| user.password_confirmation.blank?}
0
+
0
+before_create :unless => lambda {|user| user.password_confirmation.blank?} do |record|
0
+  record.password = record.password.to_sha1
0
+end
0
+
0
+before_create PasswordEncryptor, :unless => lambda {|user| user.password_confirmation.blank?}
0
+class PasswordEncryptor
0
+  def self.before_create(record)
0
+    record.password = record.password.to_sha1
0
+  end
0
+end
0
 
0
 
0
-Copyright (c) 2008 [name of plugin creator], released under the MIT license
0
+Copyright (c) 2008 Jared Carroll, released under the MIT license

0
@@ -15,7 +15,7 @@ end
0
 desc 'Generate documentation for the when plugin.'
0
 Rake::RDocTask.new(:rdoc) do |rdoc|
0
   rdoc.rdoc_dir = 'rdoc'
0
-  rdoc.title    = 'When'
0
+  rdoc.title    = 'ARCallbackConditions'
0
   rdoc.options << '--line-numbers' << '--inline-source'
0
   rdoc.rdoc_files.include('README')
0
   rdoc.rdoc_files.include('lib/**/*.rb')

0
@@ -1,8 +1,1440 @@
0
-require 'test/unit'
0
+require File.join(File.dirname(__FILE__), 'test_helper')
0
+require File.join(File.dirname(__FILE__), 'fixtures', 'company')
0
 
0
 class WhenTest < Test::Unit::TestCase
0
-  # Replace this with your real tests.
0
-  def test_this_plugin
0
-    flunk
0
+
0
+  def test_should_set_its_attribute_1_if_its_before_create_if_with_proc_condition_when_sent_save_on_initial_creation
0
+    company = Company.new :attribute_1 => 'before_create_if_with_proc_condition'
0
+
0
+    assert company.save_without_validation
0
+    assert_equal 'attribute_1', company.attribute_1
0
+
0
+    company = Company.new
0
+
0
+    assert company.save_without_validation
0
+    assert_nil company.attribute_1
0
+  end
0
+
0
+  def test_should_set_its_attribute_2_unless_its_before_create_unless_with_proc_condition_when_sent_save_on_initial_creation
0
+    company = Company.new :attribute_2 => 'before_create_unless_with_proc_condition'
0
+
0
+    assert company.save_without_validation
0
+    assert_equal 'before_create_unless_with_proc_condition', company.attribute_2
0
+
0
+    company = Company.new
0
+
0
+    assert company.save_without_validation
0
+    assert_equal 'attribute_2', company.attribute_2
0
+  end
0
+
0
+  def test_should_set_its_attribute_3_if_its_after_create_if_with_proc_condition_when_sent_save_on_initial_creation
0
+    company = Company.new :attribute_3 => 'after_create_if_with_proc_condition'
0
+
0
+    assert company.save_without_validation
0
+    assert_equal 'attribute_3', company.attribute_3
0
+
0
+    company = Company.new
0
+
0
+    assert company.save_without_validation
0
+    assert_nil company.attribute_3
0
+  end
0
+
0
+  def test_should_set_its_attribute_4_unless_its_after_create_unless_with_proc_condition_when_sent_save_on_initial_creation
0
+    company = Company.new :attribute_4 => 'after_create_unless_with_proc_condition'
0
+
0
+    assert company.save_without_validation
0
+    assert_equal 'after_create_unless_with_proc_condition', company.attribute_4
0
+
0
+    company = Company.new
0
+
0
+    assert company.save_without_validation
0
+    assert_equal 'attribute_4', company.attribute_4
0
+  end
0
+
0
+  def test_should_set_its_attribute_5_if_its_before_save_if_with_proc_condition_when_sent_save
0
+    company = Company.new :attribute_5 => 'before_save_if_with_proc_condition'
0
+
0
+    assert company.save_without_validation
0
+    assert_equal 'attribute_5', company.attribute_5
0
+
0
+    company = Company.new
0
+
0
+    assert company.save_without_validation
0
+    assert_nil company.attribute_5
0
+
0
+    company.attribute_5 = 'before_save_if_with_proc_condition'
0
+
0
+    assert company.save_without_validation
0
+    assert_equal 'attribute_5', company.attribute_5
0
+  end
0
+
0
+  def test_should_set_its_attribute_6_unless_its_before_save_unless_with_proc_condition_when_sent_save
0
+    company = Company.new :attribute_6 => 'before_save_unless_with_proc_condition'
0
+
0
+    assert company.save_without_validation
0
+    assert_equal 'before_save_unless_with_proc_condition', company.attribute_6
0
+    assert company.save_without_validation
0
+    assert_equal 'before_save_unless_with_proc_condition', company.attribute_6
0
+
0
+    company = Company.new
0
+
0
+    assert company.save_without_validation
0
+    assert_equal 'attribute_6', company.attribute_6
0
+
0
+    company.attribute_6 = ''
0
+
0
+    assert company.save_without_validation
0
+    assert_equal 'attribute_6', company.attribute_6
0
+  end
0
+
0
+  def test_should_set_its_attribute_7_if_its_after_save_if_with_proc_condition_when_sent_save
0
+    company = Company.new :attribute_7 => 'after_save_if_with_proc_condition'
0
+
0
+    assert company.save_without_validation
0
+    assert_equal 'attribute_7', company.attribute_7
0
+
0
+    company = Company.new
0
+
0
+    assert company.save_without_validation
0
+    assert_nil company.attribute_7
0
+
0
+    company.attribute_7 = 'after_save_if_with_proc_condition'
0
+
0
+    assert company.save_without_validation
0
+    assert_equal 'attribute_7', company.attribute_7
0
+  end
0
+
0
+  def test_should_set_its_attribute_8_unless_its_after_save_unless_with_proc_condition_when_sent_save
0
+    company = Company.new :attribute_8 => 'after_save_unless_with_proc_condition'
0
+
0
+    assert company.save_without_validation
0
+    assert_equal 'after_save_unless_with_proc_condition', company.attribute_8
0
+    assert company.save_without_validation
0
+    assert_equal 'after_save_unless_with_proc_condition', company.attribute_8
0
+
0
+    company = Company.new
0
+
0
+    assert company.save_without_validation
0
+    assert_equal 'attribute_8', company.attribute_8
0
+
0
+    company.attribute_8 = ''
0
+
0
+    assert company.save_without_validation
0
+    assert_equal 'attribute_8', company.attribute_8
0
+  end
0
+
0
+  def test_should_set_its_attribute_9_if_its_before_destroy_if_with_proc_condition_when_sent_destroy
0
+    company = Company.new
0
+
0
+    assert company.save_without_validation
0
+    assert_nil company.attribute_9
0
+
0
+    company.attribute_9 = 'before_destroy_if_with_proc_condition'
0
+    assert company.destroy
0
+    assert_equal 'attribute_9', company.attribute_9
0
+
0
+    company = Company.new
0
+
0
+    assert company.save_without_validation
0
+    assert company.destroy
0
+    assert_nil company.attribute_9
0
+  end
0
+
0
+  def test_should_set_its_attribute_10_unless_its_before_destroy_unless_with_proc_condition_when_sent_destroy
0
+    company = Company.new :attribute_10 => 'before_destroy_unless_with_proc_condition'
0
+
0
+    assert company.save_without_validation
0
+    assert company.destroy
0
+    assert_equal 'before_destroy_unless_with_proc_condition', company.attribute_10
0
+
0
+    company = Company.new
0
+
0
+    assert company.save_without_validation
0
+    assert_nil company.attribute_10
0
+    assert company.destroy
0
+    assert_equal 'attribute_10', company.attribute_10
0
+  end
0
+
0
+  def test_should_set_its_attribute_11_if_its_after_destroy_if_with_proc_condition_when_sent_destroy
0
+    company = Company.new
0
+
0
+    assert company.save_without_validation
0
+    assert_nil company.attribute_11
0
+
0
+    company.attribute_11 = 'after_destroy_if_with_proc_condition'
0
+    assert company.destroy
0
+    assert_equal 'attribute_11', company.attribute_11
0
+
0
+    company = Company.new
0
+
0
+    assert company.save_without_validation
0
+    assert company.destroy
0
+    assert_nil company.attribute_11
0
+  end
0
+
0
+  def test_should_set_its_attribute_12_unless_its_after_destroy_unless_with_proc_condition_when_sent_destroy
0
+    company = Company.new :attribute_12 => 'after_destroy_unless_with_proc_condition'
0
+
0
+    assert company.save_without_validation
0
+    assert company.destroy
0
+    assert_equal 'after_destroy_unless_with_proc_condition', company.attribute_12
0
+
0
+    company = Company.new
0
+
0
+    assert company.save_without_validation
0
+    assert_nil company.attribute_12
0
+    assert company.destroy
0
+    assert_equal 'attribute_12', company.attribute_12
0
+  end
0
+
0
+  def test_should_set_its_attribute_13_if_its_before_update_if_with_proc_condition_when_sent_save_on_an_update
0
+    company = Company.new
0
+
0
+    assert company.save_without_validation
0
+    assert_nil company.attribute_13