dm_preferences 0.5.6 → 1.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 22afc1090fdd19367b6cce592aef904ddd64f678
-  data.tar.gz: d9666d94c3aec78e866f6b4f782708ade93b8f8e
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NGU0NzUwOWQ4MGQ2ZGZmZWM4OWNmNjAwNmNmZjU1MmEyMmVkYzkxZA==
+  data.tar.gz: !binary |-
+    MzE1ZGI3ZDU1MWE4MDI5MmI5ZmY1YTFlM2I2MDkxZTQzYmVlNTdjOQ==
 SHA512:
-  metadata.gz: e66a031fb4116289eaeb68ed0a4c616d1460d5c27df3d54f65be940f0d007145f9a2e6c3385f0da16bd2b1c9e0e4fde4d604e70635e126eb3686a40ee40a4d00
-  data.tar.gz: 536a0de247d6fdfd73ee9916bd0d56ccd2671a498aeedaec49b8657a8adb95f6755c88007867d07c0b88f2e9f2fb480acf5c9e37a74ceeeee12b903fdd239e5f
+  metadata.gz: !binary |-
+    ZmFlY2JjODc2NDViNGVkMmY0MmNiNzQwMGRhNDkyZmY3NGFhZjllZjU5OTk1
+    YmRlNTMzZTQ5YzJkNTZiZDVkNzNkMWY5ZGJkZDY1ODBkNjM2MTdmZGNkNjcw
+    NTE1NjEzOWJiYjM5Yjk3MmM4ZmIzOTM0MjJiZWNhNGE0NGIyYzQ=
+  data.tar.gz: !binary |-
+    MmVlNjc1MTk5NDE0Mzg0MDZiZDJjYmRjMTM1ZjNmMjU5MTY0NzA2MzliMjc4
+    OWJkNTk1OTQ4Y2VkMzkzODc3YjY1MzM1ZTIxMzJiN2YxMjIwNWU1ZDRlYzBk
+    ZDc3YjZhYTBjMWJlN2NiNGQ4OWFiMjM4ODE2ZDY3NjdkYTA4ZmM=

data/.gitignore

@@ -5,3 +5,5 @@ rdoc
 test/app_root/log
 test/app_root/script
 Gemfile.lock
+spec/dummy/db/test.sqlite3
+spec/dummy/log

data/.travis.yml

@@ -1,3 +1,3 @@
 rvm:
-  - 1.9.2
-  - 1.8.7
+  - 1.9.3
+  - 2.1

data/{CHANGELOG.rdoc → CHANGELOG.md}

@@ -1,19 +1,30 @@
-== master
+## 1.0 / 2015-08-01
 
-== 0.5.0 / 2011-08-23
+* Rails 4.2 support
+* Uses rspec for testing - all tests now pass
+* Removed deprecation: "sanitize_sql_hash_for_conditions is deprecated, and will be removed in Rails 5.0"
+* Add ActiveRecord::Type support for Rails 4.2
+* use :delete_all on stored_preferences
+
+## 0.5.6 / 2015-07-31
+
+* changed name of gem to _dm_preferences_ so as not to conflict with original
+* works with Rails 4.1
+
+## 0.5.0 / 2011-08-23
 
 * Rails 3 support [Jack Dempsey]
 
-== 0.4.2 / 2010-04-17
+## 0.4.2 / 2010-04-17
 
 * Fix #preferences lookup not typecasting values
 
-== 0.4.1 / 2010-03-07
+## 0.4.1 / 2010-03-07
 
 * Add support for per-group default preferences
 * Fix unsaved boolean preferences getting overridden by defaults if value is false
 
-== 0.4.0 / 2010-03-07
+## 0.4.0 / 2010-03-07
 
 * Add {preference}_changed?, {preference}_was, {preference}_changed, {preference}_will_change!, and reset_{preference}!
 * Add #preferences_changed?, #preferences_changed, and #preference_changes
@@ -30,44 +41,44 @@
 * Add a generator for db migration to make installation a bit easier [Tim Lowrimore]
 * Add named scopes: #with_preferences and #without_preferences
 
-== 0.3.1 / 2009-04-25
+## 0.3.1 / 2009-04-25
 
 * Rename Preference#attribute to #name to avoid conflicts with reserved methods in ActiveRecord
 
-== 0.3.0 / 2009-04-13
+## 0.3.0 / 2009-04-13
 
 * Add dependency on Rails 2.3
 * Remove dependency on plugins_plus
 
-== 0.2.0 / 2008-12-14
+## 0.2.0 / 2008-12-14
 
 * Remove the PluginAWeek namespace
 
-== 0.1.5 / 2008-11-16
+## 0.1.5 / 2008-11-16
 
 * Add all prefers/preferred accessors for preferences to be analogous to ActiveRecord column accessors
 * Fix preferences defined in STI subclasses not working [Quinn Shanahan]
 
-== 0.1.4 / 2008-10-26
+## 0.1.4 / 2008-10-26
 
 * Change how the base module is included to prevent namespacing conflicts
 
-== 0.1.3 / 2008-06-29
+## 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
+## 0.1.2 / 2008-06-22
 
 * Remove log files from gems
 
-== 0.1.1 / 2008-06-20
+## 0.1.1 / 2008-06-20
 
 * Rename preference_values hash to preferences
 * Rename preferences association to stored_preferences
 
-== 0.1.0 / 2008-06-19
+## 0.1.0 / 2008-06-19
 
 * Avoid string evaluation for dynamic methods
 * Return hashes for the preference_values, e.g.
@@ -81,6 +92,6 @@
 
 * Remove support for an options hash when specifying :for associations for preference
 
-== 0.0.1 / 2008-05-10
+## 0.0.1 / 2008-05-10
 
 * Initial public release

data/LICENSE

@@ -1,3 +1,5 @@
+The MIT License (MIT)
+
 Copyright (c) 2008-2009 Aaron Pfeifer
 
 Permission is hereby granted, free of charge, to any person obtaining

data/{README.rdoc → README.md}

@@ -1,34 +1,13 @@
-== preferences http://travis-ci.org/pluginaweek/preferences.png
+# Preferences 
 
-+preferences+ adds support for easily creating custom preferences for models.
+[![Gem Version](https://badge.fury.io/rb/dm_preferences.svg)](http://badge.fury.io/rb/dm_preferences)
+[![Build Status](https://travis-ci.org/digitalmoksha/preferences.svg)](https://travis-ci.org/digitalmoksha/preferences)
 
-== Resources
+**Preferences** adds support for easily creating custom preferences for models.
 
-API
-
-* http://rdoc.info/github/pluginaweek/preferences/master/frames
-
-Bugs
-
-* http://github.com/pluginaweek/preferences/issues
-
-Development
-
-* http://github.com/pluginaweek/preferences
-
-Testing
-
-* http://travis-ci.org/pluginaweek/preferences
+This gem is a fork of the original [preferences gem by Aaron Pfeifer](https://github.com/pluginaweek/preferences).  It supports Rails 4.2, and all tests are working.  The gem has been renamed to [dm_preferences](https://rubygems.org/gems/dm_preferences) so as not to conflict with the original.
 
-Source
-
-* git://github.com/pluginaweek/preferences.git
-
-Mailing List
-
-* http://groups.google.com/group/pluginaweek-talk
-
-== Description
+## Description
 
 Preferences for models within an application, such as for users, is a pretty
 common idiom.  Although the rule of thumb is to keep the number of preferences
@@ -37,41 +16,49 @@ disable things like e-mail notifications.
 
 Generally, basic preferences can be accomplished through simple designs, such as
 additional columns or a bit vector described and implemented by preference_fu[http://agilewebdevelopment.com/plugins/preferencefu].
+
 However, as you find the need for non-binary preferences and the number of
 preferences becomes unmanageable as individual columns in the database, the next
 step is often to create a separate "preferences" table.  This is where the
-+preferences+ plugin comes in.
+_preferences_ gem comes in.
 
-+preferences+ encapsulates this design by exposing preferences using simple
+_preferences_ encapsulates this design by exposing preferences using simple
 attribute accessors on the model, hiding the fact that preferences are stored in
 a separate table and making it dead-simple to define and manage preferences.
 
-== Usage
+## Usage
 
-=== Installation
+### Installation
 
-+preferences+ requires an additional database table to work.  You can generate
+Add the following to your gem file:
+
+    gem 'dm_preferences', '~> 1.0'
+
+_preferences_ requires an additional database table to work.  You can generate
 a migration for this table like so:
 
-  script/generate preferences
+    rails generate preferences
 
 Then simply migrate your database:
 
-  rake db:migrate
+    rake db:migrate
 
 === Defining preferences
 
 To define the preferences for a model, you can do so right within the model:
 
-  class User < ActiveRecord::Base
-    preference :hot_salsa
-    preference :dark_chocolate, :default => true
-    preference :color, :string
-    preference :favorite_number
-    preference :language, :string, :default => 'English', :group_defaults => {:chat => 'Spanish'}
-  end
+```ruby
+class User < ActiveRecord::Base
+  preference :hot_salsa
+  preference :dark_chocolate, :default => true
+  preference :color, :string
+  preference :favorite_number
+  preference :language, :string, :default => 'English', :group_defaults => {:chat => 'Spanish'}
+end
+```
 
 In the above model, 5 preferences have been defined:
+
 * hot_salsa
 * dark_chocolate
 * color
@@ -82,59 +69,81 @@ For each preference, a data type and default value can be specified.  If no
 data type is given, it's assumed to be a boolean value.  If no default value is
 given, the default is assumed to be nil.
 
-=== Accessing preferences
+### Accessing preferences
 
 Once preferences have been defined for a model, they can be accessed either
 using the accessor methods that are generated for each preference or the generic
 methods that are not specific to a particular preference.
 
-==== Accessors
+#### Accessors
 
 There are several shortcut methods that are generated for each preference
 defined on a model.  These reflect the same set of methods (attribute accessors)
 that are generated for a model's columns.  Examples of these are shown below:
 
 Query methods:
+
+```ruby
   user.prefers_hot_salsa?         # => false
   user.preferred_language?        # => true
+```
 
 Reader methods:
+
+```ruby
   user.prefers_hot_salsa          # => false
   user.preferred_language         # => "English"
+```
 
 Writer methods:
-  user.prefers_hot_salsa = false        # => false
-  user.preferred_language = 'English'   # => "English"
 
-==== Generic methods
+```ruby
+user.prefers_hot_salsa = false        # => false
+user.preferred_language = 'English'   # => "English"
+```
+
+#### Generic methods
 
 Each preference accessor is essentially a wrapper for the various generic methods
 shown below:
 
 Query method:
-  user.prefers?(:hot_salsa)     # => false
-  user.preferred?(:language)    # => true
+
+```ruby
+user.prefers?(:hot_salsa)     # => false
+user.preferred?(:language)    # => true
+```
 
 Reader method:
-  user.prefers(:hot_salsa)      # => false
-  user.preferred(:language)     # => "English"
+
+```ruby
+user.prefers(:hot_salsa)      # => false
+user.preferred(:language)     # => "English"
+```
 
 Write method:
-  user.write_preference(:hot_salsa, false)      # => false
-  user.write_preference(:language, "English")   # => "English"
 
-=== Accessing all preferences
+```ruby
+user.write_preference(:hot_salsa, false)      # => false
+user.write_preference(:language, "English")   # => "English"
+```
+
+### Accessing all preferences
 
 To get the collection of all custom, stored preferences for a particular record,
 you can access the +stored_preferences+ has_many association which is automatically
 generated:
 
-  user.stored_preferences
+```ruby
+user.stored_preferences
+```
 
 In addition to this, you can get a hash of all stored preferences *and* default
 preferences, by accessing the +preferences+ helper:
 
-  user.preferences  # => {"language"=>"English", "color"=>nil}
+```ruby
+user.preferences  # => {"language"=>"English", "color"=>nil}
+```
 
 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
@@ -142,19 +151,23 @@ stored.
 
 A short-hand alternative for preferences is also available:
 
-  user.prefs  # => {"language"=>"English", "color"=>nil}
+```ruby
+user.prefs  # => {"language"=>"English", "color"=>nil}
+```
 
-=== Grouping preferences
+### Grouping preferences
 
 In addition to defining generic preferences for the owning record, you can also
 group preferences by ActiveRecord objects or arbitrary names.  This is best shown
 through an example:
 
-  user = User.find(:first)
-  car = Car.find(:first)
-  
-  user.preferred_color = 'red', car
-  # user.write_preference(:color, 'red', car) # The generic way
+```ruby
+user = User.find(:first)
+car = Car.find(:first)
+
+user.preferred_color = 'red', car
+# user.write_preference(:color, 'red', car) # The generic way
+```
 
 This will create a color preference of "red" for the given car.  In this way,
 you can have "color" preferences for different records.
@@ -162,63 +175,98 @@ you can have "color" preferences for different records.
 To access the preference for a particular record, you can use the same accessor
 methods as before:
 
-  user.preferred_color(car)
-  # user.preferred(:color, car) # The generic way
+```ruby
+user.preferred_color(car)
+# user.preferred(:color, car) # The generic way
+```
 
 In addition to grouping preferences for a particular record, you can also group
 preferences by name.  For example,
 
-  user = User.find(:first)
-  
-  user.preferred_color = 'red', :automobiles
-  user.preferred_color = 'tan', :clothing
-  
-  user.preferred_color(:automobiles)  # => "red"
-  user.preferred_color(:clothing)     # => "tan"
-  
-  user.preferences(:automobiles)      # => {"color"=>"red"}
+```ruby
+user = User.find(:first)
+
+user.preferred_color = 'red', :automobiles
+user.preferred_color = 'tan', :clothing
 
-=== Saving preferences
+user.preferred_color(:automobiles)  # => "red"
+user.preferred_color(:clothing)     # => "tan"
+
+user.preferences(:automobiles)      # => {"color"=>"red"}
+```
+
+### Saving preferences
 
 Note that preferences are not saved until the owning record is saved.
 Preferences are treated in a similar fashion to attributes.  For example,
 
-  user = user.find(:first)
-  user.attributes = {:prefers_hot_salsa => false, :preferred_color => 'red'}
-  user.save!
+```ruby
+user = user.find(:first)
+user.attributes = {:prefers_hot_salsa => false, :preferred_color => 'red'}
+user.save!
+```
 
 Preferences are stored in a separate table called "preferences".
 
-=== Tracking changes
+### Tracking changes
 
 Similar to ActiveRecord attributes, unsaved changes to preferences can be
 tracked.  For example,
 
-  user.preferred_language               # => "English"
-  user.preferred_language_changed?      # => false
-  user.preferred_language = 'Spanish'
-  user.preferred_language_changed?      # => true
-  user.preferred_language_was           # => "English"
-  user.preferred_language_change        # => ["English", "Spanish"]
-  user.reset_preferred_language!
-  user.preferred_language               # => "English"
+```ruby
+user.preferred_language               # => "English"
+user.preferred_language_changed?      # => false
+user.preferred_language = 'Spanish'
+user.preferred_language_changed?      # => true
+user.preferred_language_was           # => "English"
+user.preferred_language_change        # => ["English", "Spanish"]
+user.reset_preferred_language!
+user.preferred_language               # => "English"
+```
 
 Assigning the same value leaves the preference unchanged:
 
-  user.preferred_language               # => "English"
-  user.preferred_language = 'English'
-  user.preferred_language_changed?      # => false
-  user.preferred_language_change        # => nil
+```ruby
+user.preferred_language               # => "English"
+user.preferred_language = 'English'
+user.preferred_language_changed?      # => false
+user.preferred_language_change        # => nil
+```
+
+## Testing
+
+You can run the tests by doing
 
-== Testing
+    rake
 
-Before you can run any tests, the following gem must be installed:
-* plugin_test_helper[http://github.com/pluginaweek/plugin_test_helper]
+## Original List of Resources
+
+API
+
+* http://rdoc.info/github/pluginaweek/preferences/master/frames
+
+Bugs
+
+* http://github.com/pluginaweek/preferences/issues
 
-To run against a specific version of Rails:
+Development
+
+* http://github.com/pluginaweek/preferences
+
+Testing
+
+* http://travis-ci.org/pluginaweek/preferences
+
+Source
+
+* git://github.com/pluginaweek/preferences.git
+
+Mailing List
+
+* http://groups.google.com/group/pluginaweek-talk
 
-  rake test RAILS_FRAMEWORK_ROOT=/path/to/rails
 
-== Dependencies
+## Dependencies
 
+* 1.0.x for Rails 4.2
 * 0.5.6 for Rails 4.1