two_faced 0.0.2.alpha

data/.gitignore

@@ -0,0 +1,41 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+.idea/.name
+
+.idea/.rakeTasks
+
+.idea/dictionaries/digital466.xml
+
+.idea/two_faced.iml
+
+.idea/vcs.xml
+
+.idea/workspace.xml
+
+.idea/scopes/scope_settings.xml
+
+.idea/modules.xml
+
+.idea/misc.xml
+
+.idea/encodings.xml
+
+.gitignore
+
+.gitignore

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Kevin Horst
+
+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,120 @@
+# TwoFaced
+
+You've developed a site...and a mobile site...and facebook tab. Everything pulls in the same data and is working swimmingly, until you get a call from your boss/client --
+
+"Hi, can we use a different photo for the Facebook version of this article? Also, the title of the Parmesan Crusted Chicken Cutlets is too long for mobile, can we just call them "Cheesy Cutlets" for mobile? "
+
+At this point you have a few options:
+
+1. Say no. They only get one image and one title and have to deal with it. Congratulations! You've just saved yourself a hassle.
+
+2. Add new columns like "facebook_image" and "mobile_title" for these edge cases
+
+3. Duplicate the records for each context and scope your queries accordingly. (Recipe.where(:context => "facebook").all ) This works, but the duplication can be a pain
+
+4. Use TwoFaced to monkey-patch your data! Only override the attributes that are different.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'two_faced', :git => "git://github.com/krhorst/two_faced.git"
+
+And then execute:
+
+    $ bundle
+
+
+After you install Two Faced and add it to your Gemfile, you need to run the generator:
+
+    $ rails generate two_faced:install
+    $ rake db:migrate
+
+## Configuring Models
+
+Add the following line into any model you want to be overrideable:
+
+    acts_as_overrideable
+
+## Adding overrides with Active Admin
+
+Add the nested attributes to the form for the resource, like so:
+
+       form do |f|
+         f.inputs
+         f.has_many :overrides do |o|
+           o.input :context_name
+           o.input :field_name, :as => :select, :collection => f.object.attribute_names
+           o.input :field_value
+         end
+         f.buttons
+       end
+
+## Adding overrides using the nested_form gem
+
+Add the nested fields for overrides.
+
+    <%= nested_form_for(@yourrecord) do |f| %>
+
+        ## Your existing Fields
+
+        <%= f.fields_for :overrides do |o|  %>
+            <div class="field">
+              <%= f.label :context_name %><br />
+              <%=  o.text_field :context_name %><br/>
+            </div>
+            <div class="field">
+              <%= f.label :field_name %><br />
+              <%= o.select :field_name, f.object.attribute_names.map{ |value| [value, value]}  %>
+              </div>
+            <div class="field">
+              <%= f.label :field_value %><br />
+                <%= o.text_field :field_value %>
+            </div>
+        <% end  %>
+
+        <%= f.link_to_add 'Add Override', :overrides %>
+
+      <div class="actions">
+        <%= f.submit %>
+      </div>
+    <% end %>
+
+## Adding overrides programatically
+
+    @yourrecord.overrides.create(:field_name => "name", :field_value => "New Name", :context_name => "mobile")
+
+## Usage
+
+You can now load up a version of your model with all overrides merged in. By default, two_faced will not overwrite the property, but will create a new method that will return the overridden property or the original property (if no override exists).
+
+    @example = ModelName.for_context("facebook").first
+    @example.name # Will be the original name
+    @example.overridden_name # Will be the overridden name
+
+If the overwrite parameter is passed, both the original property and the overridden property will be set to the new value
+
+    @example = ModelName.for_context("facebook", :overwrite => true).first
+    @example.name # Will be the overridden name
+    @example.overridden_name # Will be the overridden name
+
+If overwrite is set to true, it will also mark any records as read-only (to prevent saving this context-specific value back to the database). So this will give you an error:
+
+    @example = ModelName.for_context("facebook", :overwrite => true).first
+    @example.save #  ActiveRecord::ReadOnlyRecord exception
+
+You can also pass a custom prefix which will be used in place of "overridden". An underscore will be appended to this, and then the property name
+
+    @example = ModelName.for_context("facebook", :overwrite => true, :attribute_prefix = "custom").first
+    @example.name # Will be the overridden name
+    @example.custom_name # Will be the overridden name
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/app/models/override.rb

@@ -0,0 +1,17 @@
+class Override < ActiveRecord::Base
+  attr_accessible :context_name, :field_name, :field_value, :overrideable_id, :overrideable_type
+
+  belongs_to :overrideable, :polymorphic => true
+
+  validates :field_name, :presence => true
+  validates :context_name, :presence => true
+  validate :field_name_exists_on_associated_model
+
+  def field_name_exists_on_associated_model
+    klass =  overrideable_type.constantize
+    unless klass.attribute_names.include?(field_name)
+      errors.add(:field_name, "must be an attribute of #{overrideable_type}")
+    end
+  end
+
+end

data/lib/generators/two_faced/install/install_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators/active_record'
+
+module TwoFaced
+  module Generators
+    class InstallGenerator < ActiveRecord::Generators::Base
+      desc "Installs TwoFaced and generates the necessary migrations"
+
+      argument :name, :type => :string, :default => "create_migrations"
+
+      def self.source_root
+        File.expand_path("../templates", __FILE__)
+      end
+
+
+      def create_migrations
+        Dir["#{self.class.source_root}/migrations/*.rb"].sort.each do |filepath|
+          name = File.basename(filepath)
+          migration_template "migrations/#{name}", "db/migrate/#{name.gsub(/^\d+_/,'')}"
+          sleep 1
+        end
+      end
+    end
+  end
+end

data/lib/generators/two_faced/install/templates/migrations/1_create_overrides.rb

@@ -0,0 +1,17 @@
+class CreateOverrides < ActiveRecord::Migration
+  def change
+    create_table :overrides do |t|
+      t.string :context_name
+      t.string :overrideable_type
+      t.integer :overrideable_id
+      t.string :field_name
+      t.text :field_value
+
+      t.timestamps
+    end
+    add_index :overrides, :context_name
+    add_index :overrides, :overrideable_type
+    add_index :overrides, :overrideable_id
+    add_index :overrides, :field_name
+  end
+end

data/lib/two_faced.rb

@@ -0,0 +1,5 @@
+require "two_faced/version"
+require "two_faced/hook"
+require "two_faced/model_extensions"
+require "two_faced/railtie"
+require "two_faced/engine"

data/lib/two_faced/engine.rb

@@ -0,0 +1,10 @@
+require 'two_faced'
+require 'rails'
+
+module TwoFaced
+  class Engine < Rails::Engine
+
+    config.mount_at = '/'
+
+  end
+end

data/lib/two_faced/hook.rb

@@ -0,0 +1,5 @@
+module TwoFaced::Hook
+  def acts_as_overrideable
+    include TwoFaced::ModelExtensions
+  end
+end

data/lib/two_faced/model_extensions.rb

@@ -0,0 +1,70 @@
+module TwoFaced
+
+  module ModelExtensions
+
+    def self.included(base)
+      base.attr_accessible :overrides_attributes
+      base.has_many :overrides, :as => :overrideable, :dependent => :destroy
+      base.accepts_nested_attributes_for :overrides
+      base.after_find :get_overrides_for_context
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+
+      @overwrite_attribute_prefix = "overridden"
+
+      def context
+        @context
+      end
+
+      def overwrite_attribute_prefix
+        @overwrite_attribute_prefix
+      end
+
+      def overwrite_attributes?
+        @overwrite_attributes
+      end
+
+      def for_context(context, options = {})
+        options = {
+          :attribute_prefix => "overridden",
+          :overwrite => false
+        }.merge(options)
+
+        @context = context
+        includes(:overrides)
+        @overwrite_attributes = options[:overwrite]
+        @overwrite_attribute_prefix = options[:attribute_prefix]
+        self
+      end
+
+
+    end
+
+    def get_overrides_for_context
+      klass = self.class
+      self.overrides.where("context_name" => klass.context).each do |override|
+        singleton_class.class_eval { attr_accessor "#{klass.overwrite_attribute_prefix}_#{override.field_name}" }
+        send "#{klass.overwrite_attribute_prefix}_#{override.field_name}=", override.field_value
+        if self.class.overwrite_attributes?
+          send "#{override.field_name}=", override.field_value
+          send "readonly!"
+        end
+      end
+      self
+    end
+
+    def method_missing(method_name, *args)
+      prefix = "#{self.class.overwrite_attribute_prefix}_"
+      if method_name.to_s[prefix] != nil
+        original_method = method_name.to_s.sub(prefix, "")
+        send original_method
+      else
+        super
+      end
+
+    end
+
+  end
+end

data/lib/two_faced/railtie.rb

@@ -0,0 +1,8 @@
+module TwoFaced
+  class Railtie < Rails::Railtie
+    if defined?(ActiveRecord::Base)
+      ActiveRecord::Base.send :extend, TwoFaced::Hook
+    end
+  end
+
+end

data/lib/two_faced/version.rb

@@ -0,0 +1,3 @@
+module TwoFaced
+  VERSION = "0.0.2.alpha"
+end

data/spec/override_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+
+describe Override do
+
+  before(:each) do
+    @example_model = ModelToOverride.create({:name => "Name", :description => "Description"})
+    @valid_override_attributes = {
+        :context_name => "website",
+        :field_name => "name",
+      :field_value => "New Name" }
+  end
+
+  it "should create an override given valid attributes" do
+    @example_model.overrides.new(@valid_override_attributes)
+    @example_model.should be_valid
+  end
+
+  it "should not create an override without a field name" do
+    no_field_attributes = @valid_override_attributes.merge(:field_name => "")
+    @example_model.overrides.new(no_field_attributes).should_not be_valid
+  end
+
+  it "should not create an override without a context name" do
+    no_context_attributes = @valid_override_attributes.merge(:context_name => "")
+    @example_model.overrides.new(no_context_attributes).should_not be_valid
+  end
+
+  it "should not create an override if the field name does not exist on the model" do
+    no_field_attributes = @valid_override_attributes.merge(:field_name => "nonexistent_field")
+    @example_model.overrides.new(no_field_attributes).should_not be_valid
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+require "rails"
+require "active_record"
+require "two_faced"
+
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 0) do
+
+    create_table :overrides do |t|
+      t.string :context_name
+      t.string :overrideable_type
+      t.integer :overrideable_id
+      t.string :field_name
+      t.text :field_value
+
+      t.timestamps
+    end
+
+    create_table :model_to_overrides do |t|
+      t.string :name
+      t.string :description
+
+      t.timestamps
+    end
+  end
+end
+
+
+setup_db
+
+def cleanup_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.execute("delete from #{table}")
+  end
+end
+
+class ModelToOverride < ActiveRecord::Base
+  attr_accessible :name, :description
+  acts_as_overrideable
+end
+
+
+load(File.expand_path( 'app/models/override.rb'))

data/spec/two_faced_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+describe TwoFaced do
+
+  after(:each) do
+    cleanup_db
+  end
+
+  before(:each) do
+    @record = ModelToOverride.create(:name => "Original Name", :description => "Original Description")
+  end
+
+  it "should show the original name normally" do
+    @record.name.should eq("Original Name")
+  end
+
+  describe "with mobile override added" do
+
+    before(:each)  do
+      @record.overrides.create(:field_name => "name", :field_value => "New Name", :context_name => "mobile")
+    end
+
+    it "should still show the original name if not scoped" do
+      @record.name.should eq("Original Name")
+    end
+
+    it "should have a different overridden_name if scoped for mobile" do
+      mobile_version = ModelToOverride.for_context("mobile").first
+      mobile_version.overridden_name.should eq("New Name")
+      mobile_version.name.should eq("Original Name")
+    end
+
+    it "should overwrite the name property if passing the overwrite parameter" do
+      overwritten_mobile_version = ModelToOverride.for_context("mobile", :overwrite => true).first
+      overwritten_mobile_version.overridden_name.should eq("New Name")
+      overwritten_mobile_version.name.should eq("New Name")
+    end
+
+    it "should give read only error if attempting to save an overridden record" do
+      overwritten_mobile_version = ModelToOverride.for_context("mobile", :overwrite => true).first
+      expect { overwritten_mobile_version.save }.to raise_error
+    end
+
+    it "should show original name if override does not match scope" do
+      facebook_version = ModelToOverride.for_context("facebook", :overwrite => true).first
+      facebook_version.name.should eq("Original Name")
+      facebook_version.overridden_name.should eq("Original Name")
+    end
+
+    it "should create a property with a custom prefix" do
+      custom_prefixed_version = ModelToOverride.for_context("mobile", :attribute_prefix => "custom").first
+      custom_prefixed_version.name.should eq("Original Name")
+      custom_prefixed_version.custom_name.should eq("New Name")
+    end
+
+  end
+
+end

data/two_faced.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/two_faced/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Kevin Horst"]
+  gem.email         = ["krhorst@gmail.com"]
+  gem.description   = "Monkey-patch your data"
+  gem.summary       = "Add context-specific overrides to model attributes without new columns"
+  gem.homepage      = "http://github.com/krhorst/two_faced"
+
+  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.name          = "two_faced"
+  gem.require_paths = ["lib"]
+  gem.version       = TwoFaced::VERSION
+  gem.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: two_faced
+version: !ruby/object:Gem::Version
+  version: 0.0.2.alpha
+  prerelease: 6
+platform: ruby
+authors:
+- Kevin Horst
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Monkey-patch your data
+email:
+- krhorst@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/models/override.rb
+- lib/generators/two_faced/install/install_generator.rb
+- lib/generators/two_faced/install/templates/migrations/1_create_overrides.rb
+- lib/two_faced.rb
+- lib/two_faced/engine.rb
+- lib/two_faced/hook.rb
+- lib/two_faced/model_extensions.rb
+- lib/two_faced/railtie.rb
+- lib/two_faced/version.rb
+- spec/override_spec.rb
+- spec/spec_helper.rb
+- spec/two_faced_spec.rb
+- two_faced.gemspec
+homepage: http://github.com/krhorst/two_faced
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Add context-specific overrides to model attributes without new columns
+test_files:
+- spec/override_spec.rb
+- spec/spec_helper.rb
+- spec/two_faced_spec.rb