pluginaweek-preferences 0.3.1

data/lib/preferences/preference_definition.rb

@@ -0,0 +1,43 @@
+module Preferences
+  # Represents the definition of a preference for a particular model
+  class PreferenceDefinition
+    def initialize(name, *args) #:nodoc:
+      options = args.extract_options!
+      options.assert_valid_keys(:default)
+      
+      @type = args.first ? args.first.to_s : 'boolean'
+      
+      # Create a column that will be responsible for typecasting
+      @column = ActiveRecord::ConnectionAdapters::Column.new(name.to_s, options[:default], @type == 'any' ? nil : @type)
+    end
+    
+    # The name of the preference
+    def name
+      @column.name
+    end
+    
+    # The default value to use for the preference in case none have been
+    # previously defined
+    def default_value
+      @column.default
+    end
+    
+    # Typecasts the value based on the type of preference that was defined.
+    # This uses ActiveRecord's typecast functionality so the same rules for
+    # typecasting a model's columns apply here.
+    def type_cast(value)
+      @type == 'any' ? value : @column.type_cast(value)
+    end
+    
+    # Typecasts the value to true/false depending on the type of preference
+    def query(value)
+      if !(value = type_cast(value))
+        false
+      elsif @column.number?
+        !value.zero?
+      else
+        !value.blank?
+      end
+    end
+  end
+end

data/test/app_root/app/models/car.rb

@@ -0,0 +1,2 @@
+class Car < ActiveRecord::Base
+end

data/test/app_root/app/models/employee.rb

@@ -0,0 +1,2 @@
+class Employee < ActiveRecord::Base
+end

data/test/app_root/app/models/manager.rb

@@ -0,0 +1,3 @@
+class Manager < Employee
+  preference :health_insurance
+end

data/test/app_root/app/models/user.rb

@@ -0,0 +1,7 @@
+class User < ActiveRecord::Base
+  preference :hot_salsa
+  preference :dark_chocolate, :default => true
+  preference :color, :string
+  preference :car, :integer
+  preference :language, :string, :default => 'English'
+end

data/test/app_root/db/migrate/001_create_users.rb

@@ -0,0 +1,11 @@
+class CreateUsers < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.string :login, :null => false
+    end
+  end
+  
+  def self.down
+    drop_table :users
+  end
+end

data/test/app_root/db/migrate/002_create_cars.rb

@@ -0,0 +1,11 @@
+class CreateCars < ActiveRecord::Migration
+  def self.up
+    create_table :cars do |t|
+      t.string :name, :null => false
+    end
+  end
+  
+  def self.down
+    drop_table :cars
+  end
+end

data/test/app_root/db/migrate/003_create_employees.rb

@@ -0,0 +1,12 @@
+class CreateEmployees < ActiveRecord::Migration
+  def self.up
+    create_table :employees do |t|
+      t.string :name, :null => false
+      t.string :type
+    end
+  end
+  
+  def self.down
+    drop_table :employees
+  end
+end

data/test/app_root/db/migrate/004_migrate_preferences_to_version_1.rb

@@ -0,0 +1,13 @@
+class MigratePreferencesToVersion1 < ActiveRecord::Migration
+  def self.up
+    ActiveRecord::Migrator.new(:up, "#{Rails.root}/../../db/migrate", 0).migrations.each do |migration|
+      migration.migrate(:up)
+    end
+  end
+  
+  def self.down
+    ActiveRecord::Migrator.new(:up, "#{Rails.root}/../../db/migrate", 0).migrations.each do |migration|
+      migration.migrate(:down)
+    end
+  end
+end

data/test/factory.rb

@@ -0,0 +1,65 @@
+module Factory
+  # Build actions for the model
+  def self.build(model, &block)
+    name = model.to_s.underscore
+    
+    define_method("#{name}_attributes", block)
+    define_method("valid_#{name}_attributes") {|*args| valid_attributes_for(model, *args)}
+    define_method("new_#{name}")              {|*args| new_record(model, *args)}
+    define_method("create_#{name}")           {|*args| create_record(model, *args)}
+  end
+  
+  # Get valid attributes for the model
+  def valid_attributes_for(model, attributes = {})
+    name = model.to_s.underscore
+    send("#{name}_attributes", attributes)
+    attributes.stringify_keys!
+    attributes
+  end
+  
+  # Build an unsaved record
+  def new_record(model, *args)
+    attributes = valid_attributes_for(model, *args)
+    record = model.new(attributes)
+    attributes.each {|attr, value| record.send("#{attr}=", value) if model.accessible_attributes && !model.accessible_attributes.include?(attr) || model.protected_attributes && model.protected_attributes.include?(attr)}
+    record
+  end
+  
+  # Build and save/reload a record
+  def create_record(model, *args)
+    record = new_record(model, *args)
+    record.save!
+    record.reload
+    record
+  end
+  
+  build Car do |attributes|
+    attributes.reverse_merge!(
+      :name => 'Porsche'
+    )
+  end
+  
+  build Employee do |attributes|
+    attributes.reverse_merge!(
+      :name => 'John Smith'
+    )
+  end
+  
+  build Manager do |attributes|
+    valid_employee_attributes(attributes)
+  end
+  
+  build Preference do |attributes|
+    attributes[:owner] = create_user unless attributes.include?(:owner)
+    attributes.reverse_merge!(
+      :name => 'notifications',
+      :value => false
+    )
+  end
+  
+  build User do |attributes|
+    attributes.reverse_merge!(
+      :login => 'admin'
+    )
+  end
+end

data/test/functional/preferences_test.rb

@@ -0,0 +1,426 @@
+require "#{File.dirname(__FILE__)}/../test_helper"
+
+class PreferencesTest < ActiveSupport::TestCase
+  def setup
+    User.preference :notifications, :boolean
+    
+    @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_preferred_query_method
+    assert @user.respond_to?(:preferred_notifications?)
+  end
+  
+  def test_should_create_prefers_query_method
+    assert @user.respond_to?(:prefers_notifications?)
+  end
+  
+  def test_should_create_preferred_reader
+    assert @user.respond_to?(:preferred_notifications)
+  end
+  
+  def test_should_create_prefers_reader
+    assert @user.respond_to?(:prefers_notifications)
+  end
+  
+  def test_should_create_preferred_writer
+    assert @user.respond_to?(:preferred_notifications=)
+  end
+  
+  def test_should_create_prefers_writer
+    assert @user.respond_to?(:prefers_notifications=)
+  end
+  
+  def test_should_create_preference_definitions
+    assert User.respond_to?(:preference_definitions)
+  end
+  
+  def test_should_create_default_preferences
+    assert User.respond_to?(:default_preferences)
+  end
+  
+  def test_should_include_new_definitions_in_preference_definitions
+    assert_not_nil User.preference_definitions['notifications']
+  end
+  
+  def teardown
+    User.preference_definitions.delete('notifications')
+    User.default_preferences.delete('notifications')
+  end
+end
+
+class UserByDefaultTest < ActiveSupport::TestCase
+  def setup
+    @user = User.new
+  end
+  
+  def test_should_not_prefer_hot_salsa
+    assert_nil @user.preferred_hot_salsa
+    assert_nil @user.prefers_hot_salsa
+  end
+  
+  def test_should_prefer_dark_chocolate
+    assert_equal true, @user.preferred_dark_chocolate
+    assert_equal true, @user.prefers_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_have_only_default_preferences
+    expected = {
+      'hot_salsa' => nil,
+      'dark_chocolate' => true,
+      'color' => nil,
+      'car' => nil,
+      'language' => 'English'
+    }
+    
+    assert_equal expected, @user.preferences
+  end
+end
+
+class UserTest < ActiveSupport::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_preferred_query_method
+    @user.prefers_hot_salsa = true
+    assert @user.preferred?(:hot_salsa)
+  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_prefers_method
+    @user.preferred_color = 'blue'
+    assert_equal 'blue', @user.prefers(: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.stored_preferences.empty?
+  end
+end
+
+class UserAfterBeingCreatedTest < ActiveSupport::TestCase
+  def setup
+    @user = create_user
+  end
+  
+  def test_should_not_have_any_stored_preferences
+    assert @user.stored_preferences.empty?
+  end
+end
+
+class UserWithoutStoredPreferencesTest < ActiveSupport::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.stored_preferences.empty?
+  end
+end
+
+class UserWithStoredPreferencesTest < ActiveSupport::TestCase
+  def setup
+    @user = create_user
+    @user.preferred_language = 'Latin'
+    @user.save!
+  end
+  
+  def test_should_have_stored_preferences
+    assert_equal 1, @user.stored_preferences.size
+  end
+  
+  def test_should_include_custom_and_default_preferences_in_preferences
+    expected = {
+      'hot_salsa' => nil,
+      'dark_chocolate' => true,
+      'color' => nil,
+      'car' => nil,
+      'language' => 'Latin'
+    }
+    
+    assert_equal expected, @user.preferences
+  end
+  
+  def test_should_use_preferences_for_prefs
+    expected = {
+      'hot_salsa' => nil,
+      'dark_chocolate' => true,
+      'color' => nil,
+      'car' => nil,
+      'language' => 'Latin'
+    }
+    
+    assert_equal expected, @user.prefs
+  end
+  
+  def test_should_not_remove_preference_if_set_to_default
+    @user.preferred_language = 'English'
+    @user.save!
+    @user.reload
+    assert_equal 1, @user.stored_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.stored_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.stored_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.stored_preferences.size
+  end
+end
+
+class UserWithStoredPreferencesForBasicGroupsTest < ActiveSupport::TestCase
+  def setup
+    @user = create_user
+    @user.preferred_color = 'red', 'cars'
+    @user.save!
+  end
+  
+  def test_should_have_stored_preferences
+    assert_equal 1, @user.stored_preferences.size
+  end
+  
+  def test_should_include_group_in_preferences
+    expected = {
+      'hot_salsa' => nil,
+      'dark_chocolate' => true,
+      'color' => nil,
+      'car' => nil,
+      'language' => 'English',
+      'cars' => {
+        'hot_salsa' => nil,
+        'dark_chocolate' => true,
+        'color' => 'red',
+        'car' => nil,
+        'language' => 'English'
+      }
+    }
+    
+    assert_equal expected, @user.preferences
+  end
+  
+  def test_should_be_able_to_show_all_preferences_just_for_the_owner
+    expected = {
+      'hot_salsa' => nil,
+      'dark_chocolate' => true,
+      'color' => nil,
+      'car' => nil,
+      'language' => 'English'
+    }
+    
+    assert_equal expected, @user.preferences(nil)
+  end
+  
+  def test_should_be_able_to_show_all_preferences_for_a_single_group
+    expected = {
+      'hot_salsa' => nil,
+      'dark_chocolate' => true,
+      'color' => 'red',
+      'car' => nil,
+      'language' => 'English'
+    }
+    
+    assert_equal expected, @user.preferences('cars')
+  end
+  
+  def test_should_not_have_preference_without_group
+    assert_nil @user.preferred_color
+  end
+  
+  def test_should_have_preference_with_group
+    assert_equal 'red', @user.preferred_color('cars')
+  end
+  
+  def test_should_modify_existing_preferences_when_saved
+    @user.preferred_color = 'blue', 'cars'
+    assert @user.save
+    
+    @user.reload
+    assert_equal 'blue', @user.preferred_color('cars')
+    assert_equal 1, @user.stored_preferences.size
+  end
+  
+  def test_should_be_able_to_differentiate_between_groups
+    @user.preferred_color = 'blue', 'boats'
+    assert @user.save
+    
+    @user.reload
+    assert_equal 'red', @user.preferred_color('cars')
+    assert_equal 'blue', @user.preferred_color('boats')
+    assert_equal 2, @user.stored_preferences.size
+  end
+end
+
+class UserWithStoredPreferencesForActiveRecordGroupsTest < ActiveSupport::TestCase
+  def setup
+    @car = create_car
+    
+    @user = create_user
+    @user.preferred_color = 'red', @car
+    @user.save!
+  end
+  
+  def test_should_have_stored_preferences
+    assert_equal 1, @user.stored_preferences.size
+  end
+  
+  def test_should_have_preferences_for_group
+    expected = {
+      'hot_salsa' => nil,
+      'dark_chocolate' => true,
+      'color' => nil,
+      'car' => nil,
+      'language' => 'English',
+      @car => {
+        'hot_salsa' => nil,
+        'dark_chocolate' => true,
+        'color' => 'red',
+        'car' => nil,
+        'language' => 'English'
+      }
+    }
+    
+    assert_equal expected, @user.preferences
+  end
+  
+  def test_should_not_have_preference_without_group
+    assert_nil @user.preferred_color
+  end
+  
+  def test_should_have_preference_with_group
+    assert_equal 'red', @user.preferred_color(@car)
+  end
+  
+  def test_should_modify_existing_preferences_when_saved
+    @user.preferred_color = 'blue', @car
+    assert @user.save
+    
+    @user.reload
+    assert_equal 'blue', @user.preferred_color(@car)
+    assert_equal 1, @user.stored_preferences.size
+  end
+  
+  def test_should_be_able_to_differentiate_between_groups
+    @different_car = create_car
+    
+    @user.preferred_color = 'blue', @different_car
+    assert @user.save
+    
+    @user.reload
+    assert_equal 'red', @user.preferred_color(@car)
+    assert_equal 'blue', @user.preferred_color(@different_car)
+    assert_equal 2, @user.stored_preferences.size
+  end
+end