flavors 0.2.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in flavors.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Polydice, Inc.
+
+MIT License
+
+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.md

@@ -0,0 +1,68 @@
+# Flavors
+
+Simple and flexible preferences integration for ActiveRecord models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'flavors'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flavors
+
+## Usage
+
+To add preferences to your ActiveRecord model, in your model file:
+
+```
+class User < ActiveRecord::Base
+  preference :receive_email, :default => true
+end
+```
+
+Then you can then use the methods provided by flavors to read / write preferences.
+
+```
+Loading development environment (Rails 3.2.12)
+irb(main):001:0> u = User.create(:email => "foo@bar.com")
+irb(main):002:0> u.notification
+=> true
+irb(main):003:0> u.notification = false
+=> false
+irb(main):004:0> u.notification
+=> false
+```
+
+From 0.2.0, Flavors also supports callback block for preference setter.
+
+```
+class User < ActiveRecord::Base
+  preference :receive_email, :default => true do |object, value|
+    puts "#{object.name} sets preference to #{value}"
+  end
+end
+```
+
+When you set preference of instances, the callback block will be invoked.
+
+```
+Loading development environment (Rails 3.2.12)
+irb(main):001:0> u = User.create(:name => "foo", :email => "foo@bar.com")
+irb(main):002:0> u.notification = true
+foo sets preference to true
+=> true
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/flavors.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flavors/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "flavors"
+  gem.version       = Flavors::VERSION
+  gem.authors       = ["David Yun", "Richard Lee"]
+  gem.email         = ["david.yun@polydice.com", "rl@polydice.com"]
+  gem.description   = %q{Simple and flexible preferences integration for ActiveRecord models.}
+  gem.summary       = %q{Add preferences to ActiveRecord models.}
+  gem.homepage      = "https://github.com/polydice/flavors"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "railties", "~> 3.1"
+  gem.add_dependency "activesupport", "~> 3.2"
+  gem.add_dependency "activerecord", "~> 3.2"
+
+  gem.add_development_dependency "rspec", "~> 2.12.0"
+  gem.add_development_dependency "rake",  "~> 10.0"
+  gem.add_development_dependency "shoulda-matchers", "~> 1.4"
+  gem.add_development_dependency "sqlite3"
+end

data/lib/flavors/engine.rb

@@ -0,0 +1,12 @@
+require 'flavors/preferences/preferences.rb'
+require 'flavors/preferences/preference.rb'
+
+require 'rails'
+
+module Flavors
+  class Engine < ::Rails::Engine
+    initializer "flavors" do
+      ::ActiveRecord::Base.send :include, Flavors::Preferences
+    end
+  end
+end

data/lib/flavors/preferences/preference.rb

@@ -0,0 +1,7 @@
+require 'active_record'
+
+module Flavors
+  class Preference < ::ActiveRecord::Base
+    belongs_to :prefered, :polymorphic => true
+  end
+end

data/lib/flavors/preferences/preferences.rb

@@ -0,0 +1,37 @@
+require 'active_support/concern'
+
+module Flavors
+  module Preferences
+    extend ::ActiveSupport::Concern
+
+    module ClassMethods
+      def preference(name, options = {}, &callback)
+        has_many :preferences, :as => :prefered, :class_name => "::Flavors::Preference"
+
+        define_method(name) do
+          read_preference(name, options[:default])
+        end
+
+        define_method("#{name}=") do |value|
+          write_preference(name, value)
+          callback.call(self, value) if callback
+        end
+      end
+    end
+
+    def read_preference(name, default = nil)
+      if p = self.preferences.where(:name => name).first
+        p.value
+      elsif default.present?
+        default
+      else
+        nil
+      end
+    end
+
+    def write_preference(name, value)
+      p = self.preferences.find_or_create_by_name(name)
+      p.update_attribute(:value, value)
+    end
+  end
+end

data/lib/flavors/version.rb

@@ -0,0 +1,3 @@
+module Flavors
+  VERSION = "0.2.0"
+end

data/lib/flavors.rb

@@ -0,0 +1,7 @@
+require "flavors/version"
+
+module Flavors
+  module Rails
+      require "flavors/engine"
+    end
+end

data/lib/generators/flavors/migration_generator.rb

@@ -0,0 +1,22 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Flavors
+  class MigrationGenerator < ::Rails::Generators::Base
+    include ::Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+
+    def self.next_migration_number( dirname )
+      next_migration_number = current_migration_number(dirname) + 1
+      if ActiveRecord::Base.timestamped_migrations
+        [Time.now.utc.strftime("%Y%m%d%H%M%S%6N"), "%.20d" % next_migration_number].max
+      else
+        "%.3d" % next_migration_number
+      end
+    end
+
+    def create_model_file
+      migration_template "create_preferences.rb", "db/migrate/create_preferences.rb"
+    end
+  end
+end

data/lib/generators/flavors/templates/create_preferences.rb

@@ -0,0 +1,16 @@
+class CreatePreferences < ActiveRecord::Migration
+  def change
+    create_table :preferences do |t|
+      t.string :name
+      t.boolean :value
+      t.integer :prefered_id
+      t.string :prefered_type
+
+      t.timestamps
+    end
+
+    add_index :preferences, :prefered_id
+    add_index :preferences, :prefered_type
+    add_index :preferences, :name
+  end
+end

data/spec/preference_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Flavors::Preference do
+
+  it { should belong_to(:prefered) }
+
+end

data/spec/preferences_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+require 'flavors'
+
+describe Flavors::Preferences do
+  before do
+    User.class_eval do
+      preference :notification, :default => true
+    end
+
+    Post.class_eval do
+      preference :sticky, :default => false
+    end
+  end
+
+  subject { User.create }
+
+  it "should have a default value" do
+    subject.notification.should == true
+  end
+
+  it "should update preference" do
+    subject.notification = false
+    subject.notification.should == false
+  end
+
+  it "should scope preferences for different classes" do
+    expect {
+      subject.sticky
+    }.to raise_error NoMethodError
+  end
+
+  it "should scope default value for different classes" do
+    Post.class_eval do
+      preference :notification, :default => false
+    end
+
+    subject.notification.should be_true
+  end
+
+  it "should return if nil if no default value defined" do
+    User.class_eval do
+      preference :foo
+    end
+
+    subject.foo.should be_nil
+  end
+
+  it "should invoke callback block" do
+    User.class_eval do
+      def buz; end
+
+      preference :bar do |object, value|
+        object.buz
+      end
+    end
+
+    subject.should_receive(:buz)
+    subject.bar = true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'rspec'
+require 'flavors'
+require 'shoulda-matchers'
+
+require "rails/test_unit/railtie"
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end
+
+# Define the application and configuration
+module Config
+  class Application < ::Rails::Application
+  end
+end
+
+Config::Application.initialize!
+
+# Setup test environment for ActiveRecord
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :database => ':memory:'
+)
+
+load File.dirname(__FILE__) + '/support/schema.rb'
+load File.dirname(__FILE__) + '/support/user.rb'
+load File.dirname(__FILE__) + '/support/post.rb'

data/spec/support/post.rb

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+
+end

data/spec/support/schema.rb

@@ -0,0 +1,42 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20130103134512441314) do
+
+  create_table "preferences", :force => true do |t|
+    t.string   "name"
+    t.boolean  "value"
+    t.integer  "prefered_id"
+    t.string   "prefered_type"
+    t.datetime "created_at",    :null => false
+    t.datetime "updated_at",    :null => false
+  end
+
+  add_index "preferences", ["name"], :name => "index_preferences_on_name"
+  add_index "preferences", ["prefered_id"], :name => "index_preferences_on_prefered_id"
+  add_index "preferences", ["prefered_type"], :name => "index_preferences_on_prefered_type"
+
+  create_table "users", :force => true do |t|
+    t.string   "email"
+    t.string   "username"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
+  end
+
+  create_table "posts", :force => true do |t|
+    t.string   "title"
+    t.text   "body"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
+  end
+
+end

data/spec/support/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: flavors
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- David Yun
+- Richard Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple and flexible preferences integration for ActiveRecord models.
+email:
+- david.yun@polydice.com
+- rl@polydice.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- flavors.gemspec
+- lib/flavors.rb
+- lib/flavors/engine.rb
+- lib/flavors/preferences/preference.rb
+- lib/flavors/preferences/preferences.rb
+- lib/flavors/version.rb
+- lib/generators/flavors/migration_generator.rb
+- lib/generators/flavors/templates/create_preferences.rb
+- spec/preference_spec.rb
+- spec/preferences_spec.rb
+- spec/spec_helper.rb
+- spec/support/post.rb
+- spec/support/schema.rb
+- spec/support/user.rb
+homepage: https://github.com/polydice/flavors
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1685997534619687224
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1685997534619687224
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Add preferences to ActiveRecord models.
+test_files:
+- spec/preference_spec.rb
+- spec/preferences_spec.rb
+- spec/spec_helper.rb
+- spec/support/post.rb
+- spec/support/schema.rb
+- spec/support/user.rb