preference_fu 0.0.1

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use 1.9.2@preference_fu

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org' 
+source 'http://gems.github.com'
+
+gem 'jeweler','~>1.5'

data/Gemfile.lock

@@ -0,0 +1,16 @@
+GEM
+  remote: http://rubygems.org/
+  remote: http://gems.github.com/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler (~> 1.5)

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,76 @@
+PreferenceFu
+============
+
+This plugin, greatly inspired by Jim Morris' blog post (http://blog.wolfman.com/articles/2007/08/07/bit-vector-preferences), aims to make it easy and flexible to store boolean preferences for an ActiveRecord model. This can be also used as a very quick way to setup an ACL.
+
+Because the values are stored within a bit vector, a virtually unlimited number of preferences can be created without additional  migrations.
+
+Feel free to email me with any suggestions or problems.
+
+Blog: http://www.brennandunn.com
+Email address: me@brennandunn.com
+
+
+Setup
+=====
+
+Simply add an integer column to each table of the database that requires preferences. By default, the column used is 'preferences', and can be changed using an options hash when defining preferences:
+  
+  has_preferences :send_email, :column => 'something_else'
+
+Your migration should probably look something like this:
+	
+	add_column :people, :preferences, :integer
+		
+
+Examples
+========
+
+Using PreferenceFu is very simple.
+
+	class User < ActiveRecord::Base
+	
+		has_preferences :send_email, :change_theme, :delete_user, :create_user
+		
+		set_default_preference :send_email, true
+	
+	end
+	
+For new AR objects, all preference options will be set to false. This can be overwritten using set_default_preference. I really recommend you read the 'Warning' section below.
+
+Setting a key:
+	...individually
+	@user.prefs[:delete_user] = true 
+		
+	...mass assignment (useful with the params hash)
+	@user.prefs = {:delete_user => true, :create_user => true}
+	
+Setting an option as true doesn't necessarily need to be done with the Boolean true - in fact, the Fixnum 1, and strings '1', 'y' and 'yes' are all valid. This is particularly helpful for checkbox form posts.
+
+ 	@user.prefs[:create_user] = 'yes'
+
+
+Fetching a key:
+	@user.prefs[:change_theme]  => false
+	
+
+Getting the index of a key:
+	@user.prefs.index(:delete_user)  => 4
+	
+
+Enumerable...
+	@user.prefs.size  => 4
+	
+	@user.prefs.each do |key, value|
+		puts "#{key} is set to #{value}"
+	end
+	
+
+Warning
+=======
+
+This works by taking the index of the splat supplied in has_preferences as the power of two, summing all values, and storing the sum in the preferences column. Because of this, the first item in the splat will be identified by 1, the second by 2, the third by 4, etc. Once you start using PreferenceFu in production, add new options to the *end* of the splat. At the moment, there's no safe way to delete a preference item at the moment. Any advice is welcome! 
+
+	
+
+Copyright (c) 2008 Brennan Dunn, released under the MIT license

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the preference_fu plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the preference_fu plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PreferenceFu'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+                 
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "preference_fu"
+  gem.summary = %Q{Rails 3 compatible plugin gem for boolean preferences for an ActiveRecord model}
+  gem.description = %Q{This plugin, greatly inspired by Jim Morris' blog post (http://blog.wolfman.com/articles/2007/08/07/bit-vector-preferences), aims to make it easy and flexible to store boolean preferences for an ActiveRecord model.This can be also used as a very quick way to setup an ACL.  Because the values are stored within a bit vector, a virtually unlimited number of preferences can be created without additional  migrations.}
+  gem.email = ""
+  gem.homepage = "http://github.com/g5search/preference_fu"
+  gem.authors = ["Brennan Dunn"]                           
+  gem.has_rdoc=true 
+end                 
+Jeweler::GemcutterTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/init.rb

@@ -0,0 +1,3 @@
+# Include hook code here
+
+ActiveRecord::Base.class_eval { include PreferenceFu }

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/preference_fu.rb

@@ -0,0 +1,158 @@
+module PreferenceFu
+  
+  def self.included(receiver)
+    receiver.extend         ClassMethods
+    receiver.send :include, InstanceMethods
+  end
+  
+  module ClassMethods
+    
+    def has_preferences(*prefs)
+      alias_method_chain :initialize, :preferences
+      
+      class_eval do
+        class << self
+          alias_method_chain :instantiate, :preferences
+          attr_accessor :preference_options
+        end
+      end
+      
+      options = prefs.extract_options!
+      @config = { :column => 'preferences' }.merge(options)
+      
+      self.preference_options = {}
+      prefs.each_with_index do |pref, idx|
+        self.preference_options[2**idx] = { :key => pref.to_sym, :default => false }
+      end
+      
+      class << self
+        define_method(:preferences_column) { @config[:column] }
+      end
+            
+    end
+    
+    def set_default_preference(key, default)
+      raise ArgumentError.new("Default value must be boolean") unless [true, false].include?(default)
+      idx = preference_options.find { |idx, hsh| hsh[:key] == key.to_sym }.first rescue nil
+      if idx
+        preference_options[idx][:default] = default
+      end
+    end
+    
+    def instantiate_with_preferences(*args)
+      record = instantiate_without_preferences(*args)
+      record.prefs
+      record
+    end
+    
+  end
+  
+  module InstanceMethods
+    
+    def initialize_with_preferences(attributes = nil)
+      initialize_without_preferences(attributes)
+      prefs # use this to trigger update_permissions in Preferences
+      yield self if block_given?
+    end
+    
+    def preferences_column
+      self.class.preferences_column
+    end
+    
+    def prefs
+      @preferences_object ||= Preferences.new(read_attribute(preferences_column.to_sym), self)
+    end
+    
+    def prefs=(hsh)
+      prefs.store(hsh)
+    end
+    
+  end
+  
+  
+  class Preferences
+    
+    include Enumerable
+    
+    attr_accessor :instance, :options
+    
+    def initialize(prefs, instance)
+      @instance = instance
+      @options = instance.class.preference_options
+      
+      # setup defaults if prefs is nil
+      if prefs.nil?
+        @options.each do |idx, hsh|
+          instance_variable_set("@#{hsh[:key]}", hsh[:default])
+        end
+      elsif prefs.is_a?(Numeric)
+        @options.each do |idx, hsh|
+          instance_variable_set("@#{hsh[:key]}", (prefs & idx) != 0 ? true : false)
+        end
+      else
+        raise(ArgumentError, "Input must be numeric")
+      end
+      
+      update_permissions
+      
+    end
+    
+    def each
+      @options.each_value do |hsh|
+        yield hsh[:key], self[hsh[:key]]
+      end
+    end
+    
+    def size
+      @options.size
+    end
+    
+    def [](key)
+      instance_variable_get("@#{key}")
+    end
+    
+    def []=(key, value)
+      idx, hsh = lookup(key)
+      instance_variable_set("@#{key}", is_true(value))
+      update_permissions
+    end
+    
+    def index(key)
+      idx, hsh = lookup(key)
+      idx
+    end
+    
+    # used for mass assignment of preferences, such as a hash from params
+    def store(prefs)
+      prefs.each do |key, value|
+        self[key] = value
+      end if prefs.respond_to?(:each)
+    end
+    
+    def to_i
+      @options.inject(0) do |bv, (idx, hsh)|
+        bv |= instance_variable_get("@#{hsh[:key]}") ? idx : 0
+      end
+    end
+    
+    private
+    
+      def update_permissions
+        instance.write_attribute(instance.preferences_column, self.to_i)
+      end
+    
+      def is_true(value)
+        case value
+        when true, 1, /1|y|yes/i then true
+        else false
+        end
+      end
+      
+      def lookup(key)
+        @options.find { |idx, hsh| hsh[:key] == key.to_sym }
+      end
+    
+  end
+  
+end
+ActiveRecord::Base.class_eval { include PreferenceFu }

data/preference_fu.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{preference_fu}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brennan Dunn"]
+  s.date = %q{2010-11-15}
+  s.description = %q{This plugin, greatly inspired by Jim Morris' blog post (http://blog.wolfman.com/articles/2007/08/07/bit-vector-preferences), aims to make it easy and flexible to store boolean preferences for an ActiveRecord model.This can be also used as a very quick way to setup an ACL.  Because the values are stored within a bit vector, a virtually unlimited number of preferences can be created without additional  migrations.}
+  s.email = %q{}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "MIT-LICENSE",
+    "README",
+    "Rakefile",
+    "VERSION",
+    "init.rb",
+    "install.rb",
+    "lib/preference_fu.rb",
+    "preference_fu.gemspec",
+    "tasks/preference_fu_tasks.rake",
+    "test/abstract_unit.rb",
+    "test/person.rb",
+    "test/preference_fu_test.rb",
+    "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/g5search/preference_fu}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Rails 3 compatible plugin gem for boolean preferences for an ActiveRecord model}
+  s.test_files = [
+    "test/abstract_unit.rb",
+    "test/person.rb",
+    "test/preference_fu_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<jeweler>, ["~> 1.5"])
+    else
+      s.add_dependency(%q<jeweler>, ["~> 1.5"])
+    end
+  else
+    s.add_dependency(%q<jeweler>, ["~> 1.5"])
+  end
+end
+

data/tasks/preference_fu_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :preference_fu do
+#   # Task goes here
+# end

data/test/abstract_unit.rb

@@ -0,0 +1,27 @@
+begin
+  require File.dirname(__FILE__) + '/../../../../config/environment'
+rescue LoadError
+  require 'rubygems'
+  require 'active_record'
+  gem 'activerecord'
+end
+
+require 'preference_fu'
+require "#{File.dirname(__FILE__)}/../init"
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :people do |t|
+      t.string      :name
+      t.integer     :preferences
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end

data/test/person.rb

@@ -0,0 +1,8 @@
+
+class Person < ActiveRecord::Base
+  
+  has_preferences :send_email, :change_theme, :delete_user, :create_user
+  
+  set_default_preference :send_email, true
+  
+end

data/test/preference_fu_test.rb

@@ -0,0 +1,65 @@
+require 'test/unit'
+require File.join(File.dirname(__FILE__), 'abstract_unit')
+require File.join(File.dirname(__FILE__), 'person')
+
+
+class PreferenceFuTest < Test::Unit::TestCase
+  
+  def setup
+    setup_db
+    @person = Person.new
+  end
+
+  def teardown
+    teardown_db
+  end
+  
+  def test_that_all_default_to_true_except_send_email
+    assert_equal [true, false, false, false], @person.prefs.map { |k, v| v }
+  end
+  
+  def test_new_user_for_default_preference_int
+    assert_equal 1, @person.read_attribute(:preferences)
+  end
+  
+  def test_changing_the_default_preference_column
+    klass = Class.new(ActiveRecord::Base) { include PreferenceFu ; has_preferences :foo, :column => 'something_else' }
+    assert_equal 'something_else', klass.preferences_column
+  end
+  
+  def test_changing_of_preference
+    assert_equal false, @person.prefs[:delete_user]
+    @person.prefs[:delete_user] = true
+    assert_equal true, @person.prefs[:delete_user]
+  end
+  
+  def test_mass_assignment
+    @person.prefs = {:send_email => true, :change_theme => true, :delete_user => true, :create_user => true}
+    assert_equal [true, true, true, true], @person.prefs.map { |k, v| v }
+  end
+  
+  def test_setting_an_unknown_option
+    @person.prefs[:unknown] = true
+    assert_equal 4, @person.prefs.size
+  end
+  
+  def test_saving_and_loading
+    @person.prefs[:change_theme] = true
+    @person.save
+    
+    @new_person = Person.find(:first)
+    assert_equal [true, true, false, false], @new_person.prefs.map { |k, v| v }
+  end
+  
+  def test_various_ways_of_stating_truth
+    [true, 1, '1', 'y', 'yes', 'Y', 'YES'].each do |val|
+      @person.prefs[:change_theme] = val
+      assert_equal true, @person.prefs[:change_theme]
+    end
+  end
+  
+  def test_lookup_index_of_key
+    assert_equal 4, @person.prefs.index(:delete_user)
+  end
+  
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: preference_fu
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Brennan Dunn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-15 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        version: "1.5"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+description: This plugin, greatly inspired by Jim Morris' blog post (http://blog.wolfman.com/articles/2007/08/07/bit-vector-preferences), aims to make it easy and flexible to store boolean preferences for an ActiveRecord model.This can be also used as a very quick way to setup an ACL.  Because the values are stored within a bit vector, a virtually unlimited number of preferences can be created without additional  migrations.
+email: ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- init.rb
+- install.rb
+- lib/preference_fu.rb
+- preference_fu.gemspec
+- tasks/preference_fu_tasks.rake
+- test/abstract_unit.rb
+- test/person.rb
+- test/preference_fu_test.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/g5search/preference_fu
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -1418568282675616323
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rails 3 compatible plugin gem for boolean preferences for an ActiveRecord model
+test_files: 
+- test/abstract_unit.rb
+- test/person.rb
+- test/preference_fu_test.rb