preferences 0.1.3 → 0.1.4

data/CHANGELOG.rdoc

@@ -1,5 +1,9 @@
 == master
 
+== 0.1.4 / 2008-10-26
+
+* Change how the base module is included to prevent namespacing conflicts
+
 == 0.1.3 / 2008-06-29
 
 * Add +prefs+ as an alias for +preferences+

data/README.rdoc

@@ -181,4 +181,4 @@ To run against a specific version of Rails:
 == Dependencies
 
 * Rails 2.1 or later
-* plugins_plus[http://github.com/pluginaweek/plugins_plus]
+* plugins_plus[http://github.com/pluginaweek/plugins_plugins] (optional if app files are copied to your project tree)

data/Rakefile

@@ -5,11 +5,11 @@ require 'rake/contrib/sshpublisher'
 
 spec = Gem::Specification.new do |s|
   s.name              = 'preferences'
-  s.version           = '0.1.3'
+  s.version           = '0.1.4'
   s.platform          = Gem::Platform::RUBY
   s.summary           = 'Adds support for easily creating custom preferences for models'
   
-  s.files             = FileList['{app,lib,test}/**/*'].to_a - FileList['test/app_root/log/*'].to_a + %w(CHANGELOG.rdoc init.rb LICENSE Rakefile README.rdoc)
+  s.files             = FileList['{app,lib,test}/**/*'] + %w(CHANGELOG.rdoc init.rb LICENSE Rakefile README.rdoc) - FileList['test/app_root/{log,log/*,script,script/*}']
   s.require_path      = 'lib'
   s.has_rdoc          = true
   s.test_files        = Dir['test/**/*_test.rb']

data/app/models/preference.rb

@@ -1,12 +1,12 @@
 # Represents a preferred value for a particular preference on a model.
 # 
-# == Targeted preferences
+# == Grouped preferences
 # 
-# In addition to simple named preferences, preferences can also be targeted for
-# a particular record.  For example, a User may have a preferred color for a
-# particular Car.  In this case, the +owner+ is the User, the +preference+ is
-# the color, and the +target+ is the Car.  This allows preferences to have a sort
-# of context around them.
+# In addition to simple named preferences, preferences can also be grouped by
+# a particular value, be it a string or ActiveRecord object.  For example, a
+# User may have a preferred color for a particular Car.  In this case, the
+# +owner+ is the User, the +attribute+ is the color, and the +group+ is the Car.
+# This allows preferences to have a sort of context around them.
 class Preference < ActiveRecord::Base
   belongs_to  :owner,
                 :polymorphic => true
@@ -20,7 +20,16 @@ class Preference < ActiveRecord::Base
                           :if => :group_id?
   
   class << self
-    # Splits the given group into its corresponding id and type
+    # Splits the given group into its corresponding id and type. For simple
+    # primitives, the id will be nil.  For complex types, specifically ActiveRecord
+    # objects, the id is the unique identifier stored in the databse for the
+    # record.
+    # 
+    # For example,
+    # 
+    #   Preference.split_group('google')      # => [nil, "google"]
+    #   Preference.split_group(1)             # => [nil, 1]
+    #   Preference.split_group(User.find(1))  # => [1, "User"]
     def split_group(group = nil)
       if group.is_a?(ActiveRecord::Base)
         group_id, group_type = group.id, group.class.base_class.name.to_s
@@ -28,7 +37,7 @@ class Preference < ActiveRecord::Base
         group_id, group_type = nil, group
       end
       
-      return group_id, group_type
+      [group_id, group_type]
     end
   end
   

data/lib/preferences.rb

@@ -21,12 +21,6 @@ module PluginAWeek #:nodoc:
   #   u.attributes = {:prefers_notifications => true}
   #   u.save!
   module Preferences
-    def self.included(base) #:nodoc:
-      base.class_eval do
-        extend PluginAWeek::Preferences::MacroMethods
-      end
-    end
-    
     module MacroMethods
       # Defines a new preference for all records in the model.  By default, preferences
       # are assumed to have a boolean data type, so all values will be typecasted
@@ -286,5 +280,5 @@ module PluginAWeek #:nodoc:
 end
 
 ActiveRecord::Base.class_eval do
-  include PluginAWeek::Preferences
+  extend PluginAWeek::Preferences::MacroMethods
 end

data/lib/preferences/preference_definition.rb

@@ -1,5 +1,4 @@
 module PluginAWeek #:nodoc:
-  # Adds support for defining preferences on ActiveRecord models.
   module Preferences
     # Represents the definition of a preference for a particular model
     class PreferenceDefinition
@@ -24,7 +23,8 @@ module PluginAWeek #:nodoc:
         @column.default
       end
       
-      # Typecasts the value based on the type of preference that was defined
+      # Typecasts the value based on the type of preference that was defined.
+      # This uses ActiveRecord's typecast functionality.
       def type_cast(value)
         if @type == 'any'
           value

data/test/factory.rb

@@ -13,12 +13,16 @@ module Factory
   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)
-    model.new(valid_attributes_for(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

data/test/test_helper.rb

@@ -8,6 +8,6 @@ ActiveRecord::Migrator.migrate("#{Rails.root}/db/migrate")
 
 # Mixin the factory helper
 require File.expand_path("#{File.dirname(__FILE__)}/factory")
-class Test::Unit::TestCase #:nodoc:
+Test::Unit::TestCase.class_eval do
   include Factory
 end

data/test/unit/preference_test.rb

@@ -80,6 +80,26 @@ class PreferenceTest < Test::Unit::TestCase
     assert !preference.valid?
     assert_equal 1, Array(preference.errors.on(:group_type)).size
   end
+  
+  def test_should_protect_attributes_from_mass_assignment
+    preference = Preference.new(
+      :id => 1,
+      :attribute => 'notifications',
+      :value => '123',
+      :owner_id => 1,
+      :owner_type => 'User',
+      :group_id => 1,
+      :group_type => 'Car'
+    )
+    
+    assert_nil preference.id
+    assert_equal 'notifications', preference.attribute
+    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 < Test::Unit::TestCase

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: preferences
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - Aaron Pfeifer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-29 00:00:00 -04:00
+date: 2008-10-26 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -39,7 +39,6 @@ files:
 - test/app_root/db/migrate/001_create_users.rb
 - test/app_root/db/migrate/003_migrate_preferences_to_version_1.rb
 - test/app_root/db/migrate/002_create_cars.rb
-- test/app_root/log
 - test/functional
 - test/functional/preferences_test.rb
 - test/test_helper.rb
@@ -74,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: pluginaweek
-rubygems_version: 1.1.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Adds support for easily creating custom preferences for models