preferences 0.1.2 → 0.1.3

data/CHANGELOG.rdoc

@@ -0,0 +1,34 @@
+== master
+
+== 0.1.3 / 2008-06-29
+
+* Add +prefs+ as an alias for +preferences+
+* Fix +preferences+ not properly selecting preferences when a group is specified
+* Improve test coverage
+
+== 0.1.2 / 2008-06-22
+
+* Remove log files from gems
+
+== 0.1.1 / 2008-06-20
+
+* Rename preference_values hash to preferences
+* Rename preferences association to stored_preferences
+
+== 0.1.0 / 2008-06-19
+
+* Avoid string evaluation for dynamic methods
+* Return hashes for the preference_values, e.g.
+  
+  user.preference_values            # => {'color' => 'red', 'number' => 11, 'website' => {'background' => 'white', 'foreground' => 'black'}}
+  user.preference_values('website') # => {'background' => 'white', 'foreground' => 'black'}
+
+* Add more generic grouping of preferences than with just other records, e.g.
+  
+  user.preferred_color('cars')
+
+* Remove support for an options hash when specifying :for associations for preference
+
+== 0.0.1 / 2008-05-10
+
+* Initial public release

data/{README → README.rdoc}

@@ -4,21 +4,21 @@
 
 == Resources
 
-Wiki
-
-* http://wiki.pluginaweek.org/Preferences
-
 API
 
 * http://api.pluginaweek.org/preferences
 
+Bugs
+
+* http://pluginaweek.lighthouseapp.com/projects/13286-preferences
+
 Development
 
-* http://dev.pluginaweek.org/browser/trunk/preferences
+* http://github.com/pluginaweek/preferences
 
 Source
 
-* http://svn.pluginaweek.org/trunk/preferences
+* git://github.com/pluginaweek/preferences.git
 
 == Description
 
@@ -119,6 +119,10 @@ This hash will contain the value for every preference that has been defined for
 the model, whether that's the default value or one that has been previously
 stored.
 
+A short-hand alternative for preferences is also available:
+
+  user.prefs  # => {"language"=>"English", "color"=>nil}
+
 === Grouping preferences
 
 In addition to defining generic preferences for the owning record, you can also
@@ -168,7 +172,7 @@ Preferences are stored in a separate table called "preferences".
 == Testing
 
 Before you can run any tests, the following gem must be installed:
-* plugin_test_helper[http://wiki.pluginaweek.org/Plugin_test_helper]
+* plugin_test_helper[http://github.com/pluginaweek/plugin_test_helper]
 
 To run against a specific version of Rails:
 
@@ -177,4 +181,4 @@ To run against a specific version of Rails:
 == Dependencies
 
 * Rails 2.1 or later
-* plugins_plus[http://wiki.pluginaweek.org/Plugins_plus]
+* plugins_plus[http://github.com/pluginaweek/plugins_plus]

data/Rakefile

@@ -3,46 +3,54 @@ require 'rake/rdoctask'
 require 'rake/gempackagetask'
 require 'rake/contrib/sshpublisher'
 
-PKG_NAME           = 'preferences'
-PKG_VERSION        = '0.1.2'
-PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
-RUBY_FORGE_PROJECT = 'pluginaweek'
-
-desc 'Default: run unit tests.'
+spec = Gem::Specification.new do |s|
+  s.name              = 'preferences'
+  s.version           = '0.1.3'
+  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.require_path      = 'lib'
+  s.has_rdoc          = true
+  s.test_files        = Dir['test/**/*_test.rb']
+  
+  s.author            = 'Aaron Pfeifer'
+  s.email             = 'aaron@pluginaweek.org'
+  s.homepage          = 'http://www.pluginaweek.org'
+  s.rubyforge_project = 'pluginaweek'
+end
+  
+desc 'Default: run all tests.'
 task :default => :test
 
-desc 'Test the preferences plugin.'
+desc "Test the #{spec.name} plugin."
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
+  t.test_files = spec.test_files
   t.verbose = true
 end
 
-desc 'Generate documentation for the preferences plugin.'
+begin
+  require 'rcov/rcovtask'
+  namespace :test do
+    desc "Test the #{spec.name} plugin with Rcov."
+    Rcov::RcovTask.new(:rcov) do |t|
+      t.libs << 'lib'
+      t.test_files = spec.test_files
+      t.rcov_opts << '--exclude="^(?!lib/|app/)"'
+      t.verbose = true
+    end
+  end
+rescue LoadError
+end
+
+desc "Generate documentation for the #{spec.name} plugin."
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Preferences'
+  rdoc.title    = spec.name
   rdoc.template = '../rdoc_template.rb'
   rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-spec = Gem::Specification.new do |s|
-  s.name            = PKG_NAME
-  s.version         = PKG_VERSION
-  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 init.rb MIT-LICENSE Rakefile README)
-  s.require_path    = 'lib'
-  s.autorequire     = 'preferences'
-  s.has_rdoc        = true
-  s.test_files      = Dir['test/**/*_test.rb']
-  
-  s.author          = 'Aaron Pfeifer'
-  s.email           = 'aaron@pluginaweek.org'
-  s.homepage        = 'http://www.pluginaweek.org'
+  rdoc.rdoc_files.include('README.rdoc', 'CHANGELOG.rdoc', 'LICENSE', 'lib/**/*.rb', 'app/**/*.rb')
 end
   
 Rake::GemPackageTask.new(spec) do |p|
@@ -51,14 +59,14 @@ Rake::GemPackageTask.new(spec) do |p|
   p.need_zip = true
 end
 
-desc 'Publish the beta gem'
+desc 'Publish the beta gem.'
 task :pgem => [:package] do
-  Rake::SshFilePublisher.new('aaron@pluginaweek.org', '/home/aaron/gems.pluginaweek.org/public/gems', 'pkg', "#{PKG_FILE_NAME}.gem").upload
+  Rake::SshFilePublisher.new('aaron@pluginaweek.org', '/home/aaron/gems.pluginaweek.org/public/gems', 'pkg', "#{spec.name}-#{spec.version}.gem").upload
 end
 
-desc 'Publish the API documentation'
+desc 'Publish the API documentation.'
 task :pdoc => [:rdoc] do
-  Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{PKG_NAME}", 'rdoc').upload
+  Rake::SshDirPublisher.new('aaron@pluginaweek.org', "/home/aaron/api.pluginaweek.org/public/#{spec.name}", 'rdoc').upload
 end
 
 desc 'Publish the API docs and gem'
@@ -71,10 +79,10 @@ task :release => [:gem, :package] do
   ruby_forge = RubyForge.new.configure
   ruby_forge.login
   
-  %w( gem tgz zip ).each do |ext|
-    file = "pkg/#{PKG_FILE_NAME}.#{ext}"
+  %w(gem tgz zip).each do |ext|
+    file = "pkg/#{spec.name}-#{spec.version}.#{ext}"
     puts "Releasing #{File.basename(file)}..."
     
-    ruby_forge.add_release(RUBY_FORGE_PROJECT, PKG_NAME, PKG_VERSION, file)
+    ruby_forge.add_release(spec.rubyforge_project, spec.name, spec.version, file)
   end
 end

data/lib/preferences.rb

@@ -140,6 +140,12 @@ module PluginAWeek #:nodoc:
     end
     
     module InstanceMethods
+      def self.included(base) #:nodoc:
+        base.class_eval do
+          alias_method :prefs, :preferences
+        end
+      end
+      
       # Finds all preferences, including defaults, for the current record.  If
       # any custom group preferences have been stored, then this will include
       # all default preferences within that particular group.
@@ -164,27 +170,28 @@ module PluginAWeek #:nodoc:
       #   user.preferences('cars')
       #   => {"language"=>"English", "color"=>"red"}
       def preferences(*args)
-        if args.any?
+        if args.empty?
+          group = nil
+          conditions = {}
+        else
           group = args.first
           group_id, group_type = Preference.split_group(group)
           conditions = {:group_id => group_id, :group_type => group_type}
-        else
-          conditions = {}
         end
         
         # Find all of the stored preferences
         stored_preferences = self.stored_preferences.find(:all, :conditions => conditions)
         
         # Hashify attribute -> value or group -> attribute -> value
-        stored_preferences.inject(self.class.default_preferences.dup) do |preferences, preference|
-          if group = preference.group
-            preference_group = preferences[group] ||= self.class.default_preferences.dup
+        stored_preferences.inject(self.class.default_preferences.dup) do |all_preferences, preference|
+          if !group && (preference_group = preference.group)
+            preferences = all_preferences[preference_group] ||= self.class.default_preferences.dup
           else
-            preference_group = preferences
+            preferences = all_preferences
           end
           
-          preference_group[preference.attribute] = preference.value
-          preferences
+          preferences[preference.attribute] = preference.value
+          all_preferences
         end
       end
       

data/test/factory.rb

@@ -1,26 +1,32 @@
 module Factory
-  # Build actions for the class
-  def self.build(klass, &block)
-    name = klass.to_s.underscore
-    define_method("#{name}_attributes", block)
+  # Build actions for the model
+  def self.build(model, &block)
+    name = model.to_s.underscore
     
-    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
+    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
+  end
+  
+  # Build an unsaved record
+  def new_record(model, *args)
+    model.new(valid_attributes_for(model, *args))
+  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|

data/test/functional/preferences_test.rb

@@ -209,6 +209,18 @@ class UserWithStoredPreferencesTest < Test::Unit::TestCase
     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!
@@ -260,7 +272,7 @@ class UserWithStoredPreferencesForBasicGroupsTest < Test::Unit::TestCase
     assert_equal 1, @user.stored_preferences.size
   end
   
-  def test_should_have_preferences_for_group
+  def test_should_include_group_in_preferences
     expected = {
       'hot_salsa' => nil,
       'dark_chocolate' => true,
@@ -279,6 +291,30 @@ class UserWithStoredPreferencesForBasicGroupsTest < Test::Unit::TestCase
     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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: preferences
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Aaron Pfeifer
-autorequire: preferences
+autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-06-22 00:00:00 -04:00
+date: 2008-06-29 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -47,11 +47,11 @@ files:
 - test/unit
 - test/unit/preference_test.rb
 - test/unit/preference_definition_test.rb
-- CHANGELOG
+- CHANGELOG.rdoc
 - init.rb
-- MIT-LICENSE
+- LICENSE
 - Rakefile
-- README
+- README.rdoc
 has_rdoc: true
 homepage: http://www.pluginaweek.org
 post_install_message: 
@@ -73,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: pluginaweek
 rubygems_version: 1.1.1
 signing_key: 
 specification_version: 2

data/CHANGELOG

@@ -1,30 +0,0 @@
-*SVN*
-
-*0.1.2* (June 22nd, 2008)
-
-* Remove log files from gems
-
-*0.1.1* (June 20th, 2008)
-
-* Rename preference_values hash to preferences
-
-* Rename preferences association to stored_preferences
-
-*0.1.0* (June 19th, 2008)
-
-* Avoid string evaluation for dynamic methods
-
-* Return hashes for the preference_values, e.g.
-
-  user.preference_values              # => {'color' => 'red', 'number' => 11, 'website' => {'background' => 'white', 'foreground' => 'black'}}
-  user.preference_values('website')  # => {'background' => 'white', 'foreground' => 'black'}
-
-* Add more generic grouping of preferences than with just other records, e.g.
-
-  user.preferred_color('cars')
-
-* Remove support for an options hash when specifying :for associations for preference
-
-*0.0.1* (May 10th, 2008)
-
-* Initial public release