prefered 0.1.0

data/README.rdoc

@@ -0,0 +1,83 @@
+= Prefered
+
+Prefered allows you to add preferences / settings to any model that extends ActiveRecord::Base in a Rails 3 project
+
+== Installation
+
+=== Gem
+
+You can let bundler to install Prefered by adding this line to your application's Gemfile:
+
+  gem 'prefered'
+
+And then execute:
+
+  bundle install 
+
+Or install it yourself as:
+
+  gem install prefered
+  
+=== DB
+
+Next you will need to run the generator which will create the db migration for you:
+
+  rails g prefered:preferences_migration
+  
+Then migrate your db:
+
+  rake db:migrate
+  
+== Usage
+
+Now your all installed you can add preferences to your active record model, for instance for a User model:
+
+  class User < ActiveRecord::Base
+    has_preferences do
+      preference :colour, :default => 'green'
+      group :email
+        preference :html, :default => false
+      end
+    end
+  end
+  
+This would add the following to your user model:
+
+  user.preferences.colour #=> 'green'
+  user.preferences.email.html #=> false
+
+To change preferences you simply use a setter for each preference:
+
+  user.preferences.colour= 'yellow'
+  user.preferences.email.html= false
+  
+And to persist them just save the user model:
+
+  user.save
+  
+== Thanks
+
+  Thanks to anyone who gives this a try, peace & love, Rob :)
+
+== License
+
+Copyright (c) 2010 Robert Oles
+
+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/Rakefile

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'rake'
+
+Dir["#{File.dirname(__FILE__)}/lib/tasks/*.rake"].sort.each { |ext| load ext }

data/lib/generators/prefered/preferences_migration_generator.rb

@@ -0,0 +1,26 @@
+require 'rails/generators'
+require 'rails/generators/migration'    
+
+module Prefered
+  module Generators
+    class PreferencesMigrationGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      def self.source_root
+        @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+      end
+
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      def generate_migration
+        migration_template 'migration.rb', 'db/migrate/create_preferences_table.rb'
+      end
+    end
+  end
+end

data/lib/generators/prefered/templates/migration.rb

@@ -0,0 +1,14 @@
+class CreatePreferencesTable < ActiveRecord::Migration
+   def self.up
+     create_table :preferences do |t|
+       t.string   :owner_type
+       t.integer  :owner_id
+       t.text     :data
+       t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :preferences
+  end
+end

data/lib/prefered.rb

@@ -0,0 +1,29 @@
+require 'prefered/preference'
+
+module Prefered
+  class << self
+    def included base
+      base.extend ClassMethods
+    end
+  end
+  
+  module ClassMethods
+    def has_preferences(&block)
+      has_one :preferences, :class_name => "Prefered::Preference", :as => :owner, :autosave => true, :dependent => :destroy
+      alias_method :settings, :preferences
+      after_initialize do
+        build_preferences(:owner => self) unless preferences
+        # would prefer to pass block straight to preference model through delegation, however rails assoication_proxy later
+        # breaks instance_eval for the block, and the block binding becomes broken, so we have to 'pass' the block through
+        # this instance variable
+        preferences.instance_variable_set(:@preference_settings_block, block)
+        preferences.init_preferences
+      end
+    end
+    alias_method :has_settings, :has_preferences
+  end
+end
+
+if Object.const_defined?("ActiveRecord")
+  ActiveRecord::Base.send(:include, Prefered)
+end

data/lib/prefered/preference.rb

@@ -0,0 +1,118 @@
+class Array
+  def to_h(&block)
+    Hash[*self.collect { |v|
+      [v, block.call(v)]
+    }.flatten]
+  end
+end
+
+module Prefered
+  class PreferenceSettings
+    class << self
+      def evaluate(&block)
+        settings = self.new
+        settings.instance_eval &block
+        settings
+      end
+    end
+    
+    def initialize
+      @preferences = {}
+      @groups = {}
+    end
+    attr_accessor :preferences, :groups
+    
+    def preference(name, options = {})
+      @preferences[name.to_sym] = options
+    end
+    
+    def group(name, &block)
+      @groups[name.to_sym] = PreferenceSettings.evaluate(&block) 
+    end
+  end
+  
+  module PreferenceEngine
+    def serialize_preferences(settings)
+      preferences_data = settings.preferences.keys.to_h do |preference|
+        send(:"#{preference}")
+      end
+      groups_data = settings.groups.keys.to_h do |group|
+        send(:"#{group}").serialize_preferences(settings.groups[group])
+      end
+      preferences_data.merge(groups_data)
+    end
+    
+    def deserialize_preferences(settings, raw_data)
+      settings.preferences.keys.each do |preference|
+        if raw_data.include?(preference)
+          send(:"#{preference}=", raw_data[preference])
+        end
+      end
+      settings.groups.keys.each do |group|
+        if raw_data.include?(group)
+          send(:"#{group}").deserialize_preferences(settings.groups[group], raw_data[group])
+        end
+      end
+    end
+    
+    private
+      def init_methods(settings)
+        settings.preferences.each do |preference, options|
+          self.instance_variable_set(:"@#{preference}", options[:default])
+          self.instance_eval do
+            send(:class).send(:attr_accessor, preference)
+          end
+        end
+      
+        settings.groups.each do |group, group_settings|
+          self.instance_variable_set(:"@#{group}", PreferenceGroup.new(group, group_settings))
+          self.instance_eval do
+            send(:class).send(:attr_reader, group)
+          end
+        end
+      end
+  end
+  
+  class PreferenceGroup
+    include PreferenceEngine
+    
+    def initialize(name, settings)
+      @name = name
+      @settings = settings
+      init_methods(settings)
+    end
+  end
+  
+  class Preference < ActiveRecord::Base
+    include PreferenceEngine
+    serialize   :data, Hash
+    belongs_to  :owner, :polymorphic => true
+    
+    after_initialize :init_data
+    before_save :serialize_data
+    
+    def init_preferences
+      settings = interpret_settings(&@preference_settings_block) # hack, see prefered.rb
+      init_methods(settings)
+      deserialize_data(settings)
+    end
+    
+    private
+      def init_data
+        self.data = {} unless self.data
+      end
+      
+      def interpret_settings(&block)
+        PreferenceSettings.evaluate(&block)
+      end
+      
+      def deserialize_data(settings)
+        deserialize_preferences(settings, self.data)
+      end
+      
+      def serialize_data
+        settings = interpret_settings(&@preference_settings_block)
+        self.data = serialize_preferences(settings)
+      end
+  end
+end

data/lib/tasks/gem.rake

@@ -0,0 +1,17 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "prefered"
+    s.version = '0.1.0'
+    s.summary = "Allows you to add preferences to any active record model"
+    s.email = "robertoles@me.com"
+    s.homepage = "http://github.com/robertoles/prefered"
+    s.description = "Allows you to add preferences to any active record model"
+    s.authors = ['Robert Oles']
+    s.add_dependency("rails", ">= 3.0.0")
+    s.files = FileList["[A-Z]*", "{lib}/**/*"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/lib/tasks/rspec.rake

@@ -0,0 +1,4 @@
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/spec/lib/prefered/preference_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Prefered::Preference do
+  before do 
+    rebuild_model do
+      preference :colour, :default => 'yellow'
+      group :sizes do
+        preference :width
+        preference :height, :default => 20
+      end
+    end
+  end
+  
+  let(:owner) {Dummy.create}
+  let(:preference) {owner.preferences}
+  subject {preference}
+  
+  it {should belong_to(:owner)}
+  it {should serialize(:data)}
+  
+  describe "#colour" do
+    its(:colour) {should == 'yellow'}
+  end
+  
+  describe "#colour=" do
+    before {subject.colour= 'green'}
+    its(:colour) {should == 'green'}
+  end
+  
+  describe "#group#width" do
+    before {subject.sizes.width=10}
+    it {subject.sizes.width.should==10}
+  end
+  
+  describe "#group#height" do
+    it {subject.sizes.height.should==20}
+  end
+  
+  context "save and reload" do
+    before do
+      preference.colour='red'
+      preference.sizes.width=200
+      preference.sizes.height=400
+      preference.save
+    end
+    subject {Dummy.find(owner.id).preferences}
+    
+    its(:colour) {should == 'red'}
+    it {subject.sizes.width.should == 200}
+    it {subject.sizes.height.should == 400}
+  end
+end

data/spec/lib/prefered_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Prefered do
+  before {rebuild_model {}}
+  
+  context "ActiveRecord::Base extension" do
+    subject {Dummy}
+  
+    its(:included_modules) {should include(Prefered)}
+    it {should respond_to(:has_preferences)}
+    it {should respond_to(:has_settings)}
+  end
+
+  context "Instance" do
+    subject {Dummy.new}
+    
+    it {should have_one(:preferences)}
+    it {should respond_to(:settings)}
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'rspec'
+require 'shoulda'
+
+begin
+  require 'ruby-debug'
+rescue LoadError
+  puts "ruby-debug not loaded"
+end
+
+ROOT = File.join(File.dirname(__FILE__), '..')
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+Dir["#{File.dirname(__FILE__)}/../lib/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.include RSpec::Prefered::ModelHelpers
+end

data/spec/support/initialize_active_record.rb

@@ -0,0 +1,8 @@
+require 'rails'
+require 'active_record'
+require 'active_support'
+require 'sqlite3'
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/../database.yml'))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.establish_connection(config['test'])

data/spec/support/macros/model_helpers.rb

@@ -0,0 +1,26 @@
+module RSpec
+  module Prefered
+    module ModelHelpers
+      def rebuild_model(&block)
+        ActiveRecord::Base.connection.create_table :dummies, :force => true do |table|
+        end
+        ActiveRecord::Base.connection.create_table :preferences, :force => true do |table|
+          table.column :owner_type, :string
+          table.column :owner_id,   :integer
+          table.column :data,       :text
+        end
+        rebuild_class(&block)
+      end
+
+      def rebuild_class(&block)
+        ActiveRecord::Base.send(:include, Prefered)
+        Object.send(:remove_const, "Dummy") rescue nil
+        Object.const_set("Dummy", Class.new(ActiveRecord::Base))
+        Dummy.class_eval do
+          include Prefered
+          has_preferences &block
+        end
+      end
+    end
+  end
+end

data/spec/support/matchers/serialize_matcher.rb

@@ -0,0 +1,5 @@
+RSpec::Matchers.define :serialize do |attribute_name|
+  match do |target|
+    target.class.serialized_attributes.symbolize_keys.include?(attribute_name.to_sym)
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: prefered
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Robert Oles
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-13 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+description: Allows you to add preferences to any active record model
+email: robertoles@me.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- lib/generators/prefered/preferences_migration_generator.rb
+- lib/generators/prefered/templates/migration.rb
+- lib/prefered.rb
+- lib/prefered/preference.rb
+- lib/tasks/gem.rake
+- lib/tasks/rspec.rake
+- spec/lib/prefered/preference_spec.rb
+- spec/lib/prefered_spec.rb
+- spec/spec_helper.rb
+- spec/support/initialize_active_record.rb
+- spec/support/macros/model_helpers.rb
+- spec/support/matchers/serialize_matcher.rb
+has_rdoc: true
+homepage: http://github.com/robertoles/prefered
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Allows you to add preferences to any active record model
+test_files: 
+- spec/lib/prefered/preference_spec.rb
+- spec/lib/prefered_spec.rb
+- spec/spec_helper.rb
+- spec/support/initialize_active_record.rb
+- spec/support/macros/model_helpers.rb
+- spec/support/matchers/serialize_matcher.rb