ee_preferences 0.4.3

data/test/test_helper.rb

@@ -0,0 +1,26 @@
+# 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")
+Test::Unit::TestCase.class_eval do
+  include Factory
+end
+
+# Add query counter
+ActiveRecord::Base.connection.class.class_eval do
+  IGNORED_SQL = [/^PRAGMA/, /^SELECT currval/, /^SELECT CAST/, /^SELECT @@IDENTITY/, /^SELECT @@ROWCOUNT/, /^SAVEPOINT/, /^ROLLBACK TO SAVEPOINT/, /^RELEASE SAVEPOINT/, /SHOW FIELDS/]
+  
+  def execute_with_query_record(sql, name = nil, &block)
+    $queries_executed ||= []
+    $queries_executed << sql unless IGNORED_SQL.any? { |r| sql =~ r }
+    execute_without_query_record(sql, name, &block)
+  end
+  
+  alias_method_chain :execute, :query_record
+end

data/test/unit/preference_definition_test.rb

@@ -0,0 +1,237 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+class PreferenceDefinitionByDefaultTest < ActiveSupport::TestCase
+  def setup
+    @definition = Preferences::PreferenceDefinition.new(:notifications)
+  end
+  
+  def test_should_have_a_name
+    assert_equal 'notifications', @definition.name
+  end
+  
+  def test_should_not_have_a_default_value
+    assert_nil @definition.default_value
+  end
+  
+  def test_should_have_a_type
+    assert_equal :boolean, @definition.type
+  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 < ActiveSupport::TestCase
+  def test_should_raise_exception_if_invalid_option_specified
+    assert_raise(ArgumentError) {Preferences::PreferenceDefinition.new(:notifications, :invalid => true)}
+  end
+end
+
+class PreferenceDefinitionWithDefaultValueTest < ActiveSupport::TestCase
+  def setup
+    @definition = Preferences::PreferenceDefinition.new(:notifications, :boolean, :default => 1)
+  end
+  
+  def test_should_type_cast_default_values
+    assert_equal true, @definition.default_value
+  end
+end
+
+class PreferenceDefinitionWithGroupDefaultsTest < ActiveSupport::TestCase
+  def setup
+    @definition = Preferences::PreferenceDefinition.new(:notifications, :boolean, :default => 1, :group_defaults => {:chat => 0})
+  end
+  
+  def test_should_use_default_for_default_group
+    assert_equal true, @definition.default_value
+  end
+  
+  def test_should_use_default_for_unknown_group
+    assert_equal true, @definition.default_value('email')
+  end
+  
+  def test_should_use_group_default_for_known_group
+    assert_equal false, @definition.default_value('chat')
+  end
+end
+
+class PreferenceDefinitionWithStringifiedTypeTest < ActiveSupport::TestCase
+  def setup
+    @definition = Preferences::PreferenceDefinition.new(:notifications, 'any')
+  end
+  
+  def test_should_symbolize_type
+    assert_equal :any, @definition.type
+  end
+end
+
+class PreferenceDefinitionWithAnyTypeTest < ActiveSupport::TestCase
+  def setup
+    @definition = Preferences::PreferenceDefinition.new(:notifications, :any)
+  end
+  
+  def test_use_custom_type
+    assert_equal :any, @definition.type
+  end
+  
+  def test_should_not_be_number
+    assert !@definition.number?
+  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 < ActiveSupport::TestCase
+  def setup
+    @definition = Preferences::PreferenceDefinition.new(:notifications)
+  end
+  
+  def test_should_not_be_number
+    assert !@definition.number?
+  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_nil_if_value_is_not_true_string
+    assert_nil @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 < ActiveSupport::TestCase
+  def setup
+    @definition = Preferences::PreferenceDefinition.new(:notifications, :integer)
+  end
+  
+  def test_should_be_number
+    assert @definition.number?
+  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 < ActiveSupport::TestCase
+  def setup
+    @definition = Preferences::PreferenceDefinition.new(:notifications, :string)
+  end
+  
+  def test_should_not_be_number
+    assert !@definition.number?
+  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,236 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+class PreferenceByDefaultTest < ActiveSupport::TestCase
+  def setup
+    @preference = Preference.new
+  end
+  
+  def test_should_not_have_a_name
+    assert @preference.name.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_group_association
+    assert_nil @preference.group_id
+  end
+  
+  def test_should_not_have_a_group_type
+    assert @preference.group_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 < ActiveSupport::TestCase
+  def test_should_be_valid_with_a_set_of_valid_attributes
+    preference = new_preference
+    assert preference.valid?
+  end
+  
+  def test_should_require_a_name
+    preference = new_preference(:name => nil)
+    assert !preference.valid?
+    assert preference.errors.invalid?(:name)
+  end
+  
+  def test_should_require_an_owner_id
+    preference = new_preference(:owner => nil)
+    assert !preference.valid?
+    assert preference.errors.invalid?(:owner_id)
+  end
+  
+  def test_should_require_an_owner_type
+    preference = new_preference(:owner => nil)
+    assert !preference.valid?
+    assert preference.errors.invalid?(:owner_type)
+  end
+  
+  def test_should_not_require_a_group_id
+    preference = new_preference(:group => nil)
+    assert preference.valid?
+  end
+  
+  def test_should_not_require_a_group_id_if_type_specified
+    preference = new_preference(:group => nil)
+    preference.group_type = 'Car'
+    assert preference.valid?
+  end
+  
+  def test_should_not_require_a_group_type
+    preference = new_preference(:group => nil)
+    assert preference.valid?
+  end
+  
+  def test_should_require_a_group_type_if_id_specified
+    preference = new_preference(:group => nil)
+    preference.group_id = 1
+    assert !preference.valid?
+    assert preference.errors.invalid?(:group_type)
+  end
+  
+  def test_should_protect_attributes_from_mass_assignment
+    preference = Preference.new(
+      :id => 1,
+      :name => 'notifications',
+      :value => '123',
+      :owner_id => 1,
+      :owner_type => 'User',
+      :group_id => 1,
+      :group_type => 'Car'
+    )
+    
+    assert_nil preference.id
+    assert_equal 'notifications', preference.name
+    assert_equal '123', preference.value
+    assert_equal 1, preference.owner_id
+    assert_equal 'User', preference.owner_type
+    assert_equal 1, preference.group_id
+    assert_equal 'Car', preference.group_type
+  end
+end
+
+class PreferenceAsAClassTest < ActiveSupport::TestCase
+  def test_should_be_able_to_split_nil_groups
+    group_id, group_type = Preference.split_group(nil)
+    assert_nil group_id
+    assert_nil group_type
+  end
+  
+  def test_should_be_able_to_split_non_active_record_groups
+    group_id, group_type = Preference.split_group('car')
+    assert_nil group_id
+    assert_equal 'car', group_type
+    
+    group_id, group_type = Preference.split_group(:car)
+    assert_nil group_id
+    assert_equal 'car', group_type
+    
+    group_id, group_type = Preference.split_group(10)
+    assert_nil group_id
+    assert_equal 10, group_type
+  end
+  
+  def test_should_be_able_to_split_active_record_groups
+    car = create_car
+    
+    group_id, group_type = Preference.split_group(car)
+    assert_equal 1, group_id
+    assert_equal 'Car', group_type
+  end
+end
+
+class PreferenceAfterBeingCreatedTest < ActiveSupport::TestCase
+  def setup
+    User.preference :notifications, :boolean
+    
+    @preference = create_preference(:name => '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_group_association
+    assert_nil @preference.group
+  end
+  
+  def teardown
+    User.preference_definitions.delete('notifications')
+  end
+end
+
+class PreferenceWithBasicGroupTest < ActiveSupport::TestCase
+  def setup
+    @preference = create_preference(:group_type => 'car')
+  end
+  
+  def test_should_have_a_group_association
+    assert_equal 'car', @preference.group
+  end
+end
+
+class PreferenceWithActiveRecordGroupTest < ActiveSupport::TestCase
+  def setup
+    @car = create_car
+    @preference = create_preference(:group => @car)
+  end
+  
+  def test_should_have_a_group_association
+    assert_equal @car, @preference.group
+  end
+end
+
+class PreferenceWithBooleanTypeTest < ActiveSupport::TestCase
+  def setup
+    User.preference :notifications, :boolean
+  end
+  
+  def test_should_type_cast_nil_values
+    preference = new_preference(:name => 'notifications', :value => nil)
+    assert_nil preference.value
+  end
+  
+  def test_should_type_cast_numeric_values
+    preference = new_preference(:name => '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(:name => 'notifications', :value => false)
+    assert_equal false, preference.value
+    
+    preference.value = true
+    assert_equal true, preference.value
+  end
+  
+  def teardown
+    User.preference_definitions.delete('notifications')
+  end
+end
+
+class PreferenceWithSTIOwnerTest < ActiveSupport::TestCase
+  def setup
+    @manager = create_manager
+    @preference = create_preference(:owner => @manager, :name => 'health_insurance', :value => true)
+  end
+  
+  def test_should_have_an_owner
+    assert_equal @manager, @preference.owner
+  end
+  
+  def test_should_have_an_owner_type
+    assert_equal 'Employee', @preference.owner_type
+  end
+  
+  def test_should_have_a_definition
+    assert_not_nil @preference.definition
+  end
+  
+  def test_should_have_a_value
+    assert_equal true, @preference.value
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: ee_preferences
+version: !ruby/object:Gem::Version
+  version: 0.4.3
+platform: ruby
+authors:
+- Aaron Pfeifer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: plugin_test_helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+description: Adds support for easily creating custom preferences for ActiveRecord
+  models
+email: aaron@pluginaweek.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- CHANGELOG.rdoc
+- LICENSE
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.rdoc
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- app/models/preference.rb
+- generators/preferences/USAGE
+- generators/preferences/preferences_generator.rb
+- generators/preferences/templates/001_create_preferences.rb
+- init.rb
+- lib/preferences.rb
+- lib/preferences/preference_definition.rb
+- lib/preferences/version.rb
+- preferences.gemspec
+- test/app_root/app/models/car.rb
+- test/app_root/app/models/employee.rb
+- test/app_root/app/models/manager.rb
+- test/app_root/app/models/user.rb
+- test/app_root/db/migrate/001_create_users.rb
+- test/app_root/db/migrate/002_create_cars.rb
+- test/app_root/db/migrate/003_create_employees.rb
+- test/app_root/db/migrate/004_migrate_preferences_to_version_1.rb
+- test/factory.rb
+- test/functional/preferences_test.rb
+- test/test_helper.rb
+- test/unit/preference_definition_test.rb
+- test/unit/preference_test.rb
+homepage: http://www.pluginaweek.org
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- preferences
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.3.0
+signing_key: 
+specification_version: 4
+summary: Custom preferences for ActiveRecord models
+test_files:
+- test/app_root/app/models/car.rb
+- test/app_root/app/models/employee.rb
+- test/app_root/app/models/manager.rb
+- test/app_root/app/models/user.rb
+- test/app_root/db/migrate/001_create_users.rb
+- test/app_root/db/migrate/002_create_cars.rb
+- test/app_root/db/migrate/003_create_employees.rb
+- test/app_root/db/migrate/004_migrate_preferences_to_version_1.rb
+- test/factory.rb
+- test/functional/preferences_test.rb
+- test/test_helper.rb
+- test/unit/preference_definition_test.rb
+- test/unit/preference_test.rb