preferences 0.0.1

data/test/factory.rb

@@ -0,0 +1,45 @@
+module Factory
+  # Build actions for the class
+  def self.build(klass, &block)
+    name = klass.to_s.underscore
+    define_method("#{name}_attributes", block)
+    
+    module_eval <<-end_eval
+      def valid_#{name}_attributes(attributes = {})
+        #{name}_attributes(attributes)
+        attributes
+      end
+      
+      def new_#{name}(attributes = {})
+        #{klass}.new(valid_#{name}_attributes(attributes))
+      end
+      
+      def create_#{name}(*args)
+        record = new_#{name}(*args)
+        record.save!
+        record.reload
+        record
+      end
+    end_eval
+  end
+  
+  build Car do |attributes|
+    attributes.reverse_merge!(
+      :name => 'Porsche'
+    )
+  end
+  
+  build Preference do |attributes|
+    attributes[:owner] = create_user unless attributes.include?(:owner)
+    attributes.reverse_merge!(
+      :attribute => 'notifications',
+      :value => false
+    )
+  end
+  
+  build User do |attributes|
+    attributes.reverse_merge!(
+      :login => 'admin'
+    )
+  end
+end

data/test/functional/preferences_test.rb

@@ -0,0 +1,259 @@
+require "#{File.dirname(__FILE__)}/../test_helper"
+
+class PreferencesTest < Test::Unit::TestCase
+  def setup
+    @user = User.new
+  end
+  
+  def test_should_raise_exception_if_invalid_options_specified
+    assert_raise(ArgumentError) {User.preference :notifications, :invalid => true}
+    assert_raise(ArgumentError) {User.preference :notifications, :boolean, :invalid => true}
+  end
+  
+  def test_should_create_prefers_query_method
+    assert @user.respond_to?(:prefers_notifications?)
+  end
+  
+  def test_should_create_prefers_writer
+    assert @user.respond_to?(:prefers_notifications=)
+  end
+  
+  def test_should_create_preferred_reader
+    assert @user.respond_to?(:preferred_notifications)
+  end
+  
+  def test_should_create_preferred_writer
+    assert @user.respond_to?(:preferred_notifications=)
+  end
+  
+  def test_should_create_preference_definitions
+    assert User.respond_to?(:preference_definitions)
+  end
+  
+  def test_should_include_new_definitions_in_preference_definitions
+    definition = User.preference :notifications
+    assert_equal definition, User.preference_definitions['notifications']
+  end
+end
+
+class UserByDefaultTest < Test::Unit::TestCase
+  def setup
+    @user = User.new
+  end
+  
+  def test_should_not_prefer_hot_salsa
+    assert_nil @user.preferred_hot_salsa
+  end
+  
+  def test_should_prefer_dark_chocolate
+    assert_equal true, @user.preferred_dark_chocolate
+  end
+  
+  def test_should_not_have_a_preferred_color
+    assert_nil @user.preferred_color
+  end
+  
+  def test_should_not_have_a_preferred_car
+    assert_nil @user.preferred_car
+  end
+  
+  def test_should_have_a_preferred_language
+    assert_equal 'English', @user.preferred_language
+  end
+end
+
+class UserTest < Test::Unit::TestCase
+  def setup
+    @user = new_user
+  end
+  
+  def test_should_be_able_to_change_hot_salsa_preference
+    @user.prefers_hot_salsa = false
+    assert_equal false, @user.prefers_hot_salsa?
+    
+    @user.prefers_hot_salsa = true
+    assert_equal true, @user.prefers_hot_salsa?
+  end
+  
+  def test_should_be_able_to_change_dark_chocolate_preference
+    @user.prefers_dark_chocolate = false
+    assert_equal false, @user.prefers_dark_chocolate?
+    
+    @user.prefers_dark_chocolate = true
+    assert_equal true, @user.prefers_dark_chocolate?
+  end
+  
+  def test_should_be_able_to_change_color_preference
+    @user.preferred_color = 'blue'
+    assert_equal 'blue', @user.preferred_color
+  end
+  
+  def test_should_be_able_to_change_car_preference
+    @user.preferred_car = 1
+    assert_equal 1, @user.preferred_car
+  end
+  
+  def test_should_be_able_to_change_language_preference
+    @user.preferred_language = 'Latin'
+    assert_equal 'Latin', @user.preferred_language
+  end
+  
+  def test_should_be_able_to_use_generic_prefers_query_method
+    @user.prefers_hot_salsa = true
+    assert @user.prefers?(:hot_salsa)
+  end
+  
+  def test_should_be_able_to_use_generic_preferred_method
+    @user.preferred_color = 'blue'
+    assert_equal 'blue', @user.preferred(:color)
+  end
+  
+  def test_should_be_able_to_use_generic_set_preference_method
+    @user.set_preference(:color, 'blue')
+    assert_equal 'blue', @user.preferred(:color)
+  end
+  
+  def test_should_still_be_new_record_after_changing_preference
+    @user.preferred_color = 'blue'
+    assert @user.new_record?
+    assert @user.preferences.empty?
+  end
+end
+
+class UserAfterBeingCreatedTest < Test::Unit::TestCase
+  def setup
+    @user = create_user
+  end
+  
+  def test_should_not_have_any_preferences
+    assert @user.preferences.empty?
+  end
+end
+
+class UserWithoutPreferencesTest < Test::Unit::TestCase
+  def setup
+    @user = create_user
+  end
+  
+  def test_should_not_prefer_hot_salsa
+    assert_nil @user.preferred_hot_salsa
+  end
+  
+  def test_should_prefer_dark_chocolate
+    assert_equal true, @user.preferred_dark_chocolate
+  end
+  
+  def test_should_not_have_a_preferred_color
+    assert_nil @user.preferred_color
+  end
+  
+  def test_should_not_have_a_preferred_car
+    assert_nil @user.preferred_car
+  end
+  
+  def test_should_have_a_preferred_language
+    assert_equal 'English', @user.preferred_language
+  end
+  
+  def test_should_not_save_record_after_changing_preference
+    @user.preferred_language = 'Latin'
+    
+    user = User.find(@user.id)
+    assert_equal 'English', user.preferred_language
+    assert user.preferences.empty?
+  end
+end
+
+class UserWithPreferencesTest < Test::Unit::TestCase
+  def setup
+    @user = create_user
+    @user.preferred_language = 'Latin'
+    @user.save!
+  end
+  
+  def test_should_have_preferences
+    assert_equal 1, @user.preferences.size
+  end
+  
+  def test_should_not_remove_preference_if_set_to_default
+    @user.preferred_language = 'English'
+    @user.save!
+    @user.reload
+    assert_equal 1, @user.preferences.size
+  end
+  
+  def test_should_not_remove_preference_if_set_to_nil
+    @user.preferred_language = nil
+    @user.save!
+    @user.reload
+    assert_equal 1, @user.preferences.size
+  end
+  
+  def test_should_not_save_preference_if_model_is_not_saved
+    @user.preferred_language = 'English'
+    
+    user = User.find(@user.id)
+    assert_equal 'Latin', user.preferred_language
+  end
+  
+  def test_should_modify_existing_preferences_when_saved
+    @user.preferred_language = 'Spanish'
+    assert @user.save
+    
+    @user.reload
+    assert_equal 'Spanish', @user.preferred_language
+    assert_equal 1, @user.preferences.size
+  end
+  
+  def test_should_add_new_preferences_when_saved
+    @user.preferred_color = 'blue'
+    assert @user.save
+    
+    @user.reload
+    assert_equal 'blue', @user.preferred_color
+    assert_equal 2, @user.preferences.size
+  end
+end
+
+class UserWithPreferencesForOtherModelsTest < Test::Unit::TestCase
+  def setup
+    @car = create_car
+    
+    @user = create_user
+    @user.preferred_color = 'red', {:for => @car}
+    @user.save!
+  end
+  
+  def test_should_have_preferences
+    assert_equal 1, @user.preferences.size
+  end
+  
+  def test_should_not_have_preference_without_preferenced_record
+    assert_nil @user.preferred_color
+  end
+  
+  def test_should_have_preference_with_preferenced_record
+    assert_equal 'red', @user.preferred_color(:for => @car)
+  end
+  
+  def test_should_modify_existing_preferences_when_saved
+    @user.preferred_color = 'blue', {:for => @car}
+    assert @user.save
+    
+    @user.reload
+    assert_equal 'blue', @user.preferred_color(:for => @car)
+    assert_equal 1, @user.preferences.size
+  end
+  
+  def test_should_be_able_to_differentiate_between_preferenced_records
+    @different_car = create_car
+    
+    @user.preferred_color = 'blue', {:for => @different_car}
+    assert @user.save
+    
+    @user.reload
+    assert_equal 'red', @user.preferred_color(:for => @car)
+    assert_equal 'blue', @user.preferred_color(:for => @different_car)
+    assert_equal 2, @user.preferences.size
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+# Load the plugin testing framework
+$:.unshift("#{File.dirname(__FILE__)}/../../plugin_test_helper/lib")
+require 'rubygems'
+require 'plugin_test_helper'
+
+# Run the migrations
+ActiveRecord::Migrator.migrate("#{RAILS_ROOT}/db/migrate")
+
+# Mixin the factory helper
+require File.expand_path("#{File.dirname(__FILE__)}/factory")
+class Test::Unit::TestCase #:nodoc:
+  include Factory
+end

data/test/unit/preference_definition_test.rb

@@ -0,0 +1,185 @@
+require "#{File.dirname(__FILE__)}/../test_helper"
+
+class PreferenceDefinitionByDefaultTest < Test::Unit::TestCase
+  def setup
+    @definition = PluginAWeek::Preferences::PreferenceDefinition.new(:notifications)
+  end
+  
+  def test_should_have_an_attribute
+    assert_equal 'notifications', @definition.attribute
+  end
+  
+  def test_should_not_have_a_default_value
+    assert_nil @definition.default_value
+  end
+  
+  def test_should_type_cast_values_as_booleans
+    assert_equal nil, @definition.type_cast(nil)
+    assert_equal true, @definition.type_cast(true)
+    assert_equal false, @definition.type_cast(false)
+    assert_equal false, @definition.type_cast(0)
+    assert_equal true, @definition.type_cast(1)
+  end
+end
+
+class PreferenceDefinitionTest < Test::Unit::TestCase
+  def test_should_raise_exception_if_invalid_option_specified
+    assert_raise(ArgumentError) {PluginAWeek::Preferences::PreferenceDefinition.new(:notifications, :invalid => true)}
+  end
+end
+
+class PreferenceDefinitionWithDefaultValueTest < Test::Unit::TestCase
+  def setup
+    @definition = PluginAWeek::Preferences::PreferenceDefinition.new(:notifications, :boolean, :default => 1)
+  end
+  
+  def test_should_type_cast_default_values
+    assert_equal true, @definition.default_value
+  end
+end
+
+class PreferenceDefinitionWithAnyTypeTest < Test::Unit::TestCase
+  def setup
+    @definition = PluginAWeek::Preferences::PreferenceDefinition.new(:notifications, :any)
+  end
+  
+  def test_should_not_type_cast
+    assert_equal nil, @definition.type_cast(nil)
+    assert_equal 0, @definition.type_cast(0)
+    assert_equal 1, @definition.type_cast(1)
+    assert_equal false, @definition.type_cast(false)
+    assert_equal true, @definition.type_cast(true)
+    assert_equal '', @definition.type_cast('')
+  end
+  
+  def test_should_query_false_if_value_is_nil
+    assert_equal false, @definition.query(nil)
+  end
+  
+  def test_should_query_true_if_value_is_zero
+    assert_equal true, @definition.query(0)
+  end
+  
+  def test_should_query_true_if_value_is_not_zero
+    assert_equal true, @definition.query(1)
+    assert_equal true, @definition.query(-1)
+  end
+  
+  def test_should_query_false_if_value_is_blank
+    assert_equal false, @definition.query('')
+  end
+  
+  def test_should_query_true_if_value_is_not_blank
+    assert_equal true, @definition.query('hello')
+  end
+end
+
+class PreferenceDefinitionWithBooleanTypeTest < Test::Unit::TestCase
+  def setup
+    @definition = PluginAWeek::Preferences::PreferenceDefinition.new(:notifications)
+  end
+  
+  def test_should_not_type_cast_if_value_is_nil
+    assert_equal nil, @definition.type_cast(nil)
+  end
+  
+  def test_should_type_cast_to_false_if_value_is_zero
+    assert_equal false, @definition.type_cast(0)
+  end
+  
+  def test_should_type_cast_to_true_if_value_is_not_zero
+    assert_equal true, @definition.type_cast(1)
+  end
+  
+  def test_should_type_cast_to_true_if_value_is_true_string
+    assert_equal true, @definition.type_cast('true')
+  end
+  
+  def test_should_type_cast_to_false_if_value_is_not_true_string
+    assert_equal false, @definition.type_cast('')
+  end
+  
+  def test_should_query_false_if_value_is_nil
+    assert_equal false, @definition.query(nil)
+  end
+  
+  def test_should_query_true_if_value_is_one
+    assert_equal true, @definition.query(1)
+  end
+  
+  def test_should_query_false_if_value_not_one
+    assert_equal false, @definition.query(0)
+  end
+  
+  def test_should_query_true_if_value_is_true_string
+    assert_equal true, @definition.query('true')
+  end
+  
+  def test_should_query_false_if_value_is_not_true_string
+    assert_equal false, @definition.query('')
+  end
+end
+
+class PreferenceDefinitionWithNumericTypeTest < Test::Unit::TestCase
+  def setup
+    @definition = PluginAWeek::Preferences::PreferenceDefinition.new(:notifications, :integer)
+  end
+  
+  def test_should_type_cast_true_to_integer
+    assert_equal 1, @definition.type_cast(true)
+  end
+  
+  def test_should_type_cast_false_to_integer
+    assert_equal 0, @definition.type_cast(false)
+  end
+  
+  def test_should_type_cast_string_to_integer
+    assert_equal 0, @definition.type_cast('hello')
+  end
+  
+  def test_should_query_false_if_value_is_nil
+    assert_equal false, @definition.query(nil)
+  end
+  
+  def test_should_query_true_if_value_is_one
+    assert_equal true, @definition.query(1)
+  end
+  
+  def test_should_query_false_if_value_is_zero
+    assert_equal false, @definition.query(0)
+  end
+end
+
+class PreferenceDefinitionWithStringTypeTest < Test::Unit::TestCase
+  def setup
+    @definition = PluginAWeek::Preferences::PreferenceDefinition.new(:notifications, :string)
+  end
+  
+  def test_should_type_cast_integers_to_strings
+    assert_equal '1', @definition.type_cast('1')
+  end
+  
+  def test_should_not_type_cast_booleans
+    assert_equal true, @definition.type_cast(true)
+  end
+  
+  def test_should_query_false_if_value_is_nil
+    assert_equal false, @definition.query(nil)
+  end
+  
+  def test_should_query_true_if_value_is_one
+    assert_equal true, @definition.query(1)
+  end
+  
+  def test_should_query_true_if_value_is_zero
+    assert_equal true, @definition.query(0)
+  end
+  
+  def test_should_query_false_if_value_is_blank
+    assert_equal false, @definition.query('')
+  end
+  
+  def test_should_query_true_if_value_is_not_blank
+    assert_equal true, @definition.query('hello')
+  end
+end

data/test/unit/preference_test.rb

@@ -0,0 +1,145 @@
+require "#{File.dirname(__FILE__)}/../test_helper"
+
+class PreferenceByDefaultTest < Test::Unit::TestCase
+  def setup
+    @preference = Preference.new
+  end
+  
+  def test_should_not_have_an_attribute
+    assert @preference.attribute.blank?
+  end
+  
+  def test_should_not_have_an_owner
+    assert_nil @preference.owner_id
+  end
+  
+  def test_should_not_have_an_owner_type
+    assert @preference.owner_type.blank?
+  end
+  
+  def test_should_not_have_a_preferenced_association
+    assert_nil @preference.preferenced_id
+  end
+  
+  def test_should_not_have_a_preferenced_type
+    assert @preference.preferenced_type.nil?
+  end
+  
+  def test_should_not_have_a_value
+    assert @preference.value.blank?
+  end
+  
+  def test_should_not_have_a_definition
+    assert_nil @preference.definition
+  end
+end
+
+class PreferenceTest < Test::Unit::TestCase
+  def test_should_be_valid_with_a_set_of_valid_attributes
+    preference = new_preference
+    assert preference.valid?
+  end
+  
+  def test_should_require_an_attribute
+    preference = new_preference(:attribute => nil)
+    assert !preference.valid?
+    assert_equal 1, Array(preference.errors.on(:attribute)).size
+  end
+  
+  def test_should_require_an_owner_id
+    preference = new_preference(:owner => nil)
+    assert !preference.valid?
+    assert_equal 1, Array(preference.errors.on(:owner_id)).size
+  end
+  
+  def test_should_require_an_owner_type
+    preference = new_preference(:owner => nil)
+    assert !preference.valid?
+    assert_equal 1, Array(preference.errors.on(:owner_type)).size
+  end
+  
+  def test_should_not_require_a_preferenced_id
+    preference = new_preference(:preferenced => nil)
+    assert preference.valid?
+  end
+  
+  def test_should_require_a_preferenced_id_if_specified
+    preference = new_preference(:preferenced => nil)
+    preference.preferenced_type = 'Car'
+    assert !preference.valid?
+    assert_equal 1, Array(preference.errors.on(:preferenced_id)).size
+  end
+  
+  def test_should_not_require_a_preferenced_type
+    preference = new_preference(:preferenced => nil)
+    assert preference.valid?
+  end
+  
+  def test_should_require_a_preferenced_type_if_specified
+    preference = new_preference(:preferenced => nil)
+    preference.preferenced_id = 1
+    assert !preference.valid?
+    assert_equal 1, Array(preference.errors.on(:preferenced_type)).size
+  end
+end
+
+class PreferenceAfterBeingCreatedTest < Test::Unit::TestCase
+  def setup
+    User.preference :notifications, :boolean
+    
+    @preference = create_preference(:attribute => 'notifications')
+  end
+  
+  def test_should_have_an_owner
+    assert_not_nil @preference.owner
+  end
+  
+  def test_should_have_a_definition
+    assert_not_nil @preference.definition
+  end
+  
+  def test_should_have_a_value
+    assert_not_nil @preference.value
+  end
+  
+  def test_should_not_have_a_preferenced_association
+    assert_nil @preference.preferenced
+  end
+end
+
+class PreferenceWithPreferencedAssociationTest < Test::Unit::TestCase
+  def setup
+    @preference = create_preference(:preferenced => create_car)
+  end
+  
+  def test_should_have_a_preferenced_association
+    assert_not_nil @preference.preferenced
+  end
+end
+
+class PreferenceWithBooleanAttributeTest < Test::Unit::TestCase
+  def setup
+    User.preference :notifications, :boolean
+  end
+  
+  def test_should_type_cast_nil_values
+    preference = new_preference(:attribute => 'notifications', :value => nil)
+    assert_nil preference.value
+  end
+  
+  def test_should_type_cast_numeric_values
+    preference = new_preference(:attribute => 'notifications', :value => 0)
+    assert_equal false, preference.value
+    
+    preference.value = 1
+    assert_equal true, preference.value
+  end
+  
+  def test_should_type_cast_boolean_values
+    preference = new_preference(:attribute => 'notifications', :value => false)
+    assert_equal false, preference.value
+    
+    preference.value = true
+    assert_equal true, preference.value
+  end
+end