friendly-attributes 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,15 @@
+source 'http://rubygems.org'
+
+gem 'activerecord', '~> 2.3.5'
+gem 'friendly', '~> 0.6.0'
+gem 'yajl-ruby', '~> 0.7.7'
+gem 'memcached', '~> 0.20.1'
+
+group :development do
+  gem 'mysql', '~> 2.8.1'
+  gem 'rspec', '~> 2.1.0'
+  gem 'bundler', '~> 1.0.0'
+  gem 'jeweler', '~> 1.5.1'
+  gem 'rcov', '>= 0'
+  gem 'database_cleaner', '~> 0.5.0'
+end

data/Gemfile.lock

@@ -0,0 +1,49 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activerecord (2.3.5)
+      activesupport (= 2.3.5)
+    activesupport (2.3.5)
+    database_cleaner (0.5.2)
+    diff-lcs (1.1.2)
+    friendly (0.6.0)
+      activesupport (= 2.3.5)
+      rufus-json (= 0.2.3)
+      sequel (>= 3.7.0)
+      will_paginate
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    memcached (0.20.1)
+    mysql (2.8.1)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    rufus-json (0.2.3)
+    sequel (3.17.0)
+    will_paginate (2.3.15)
+    yajl-ruby (0.7.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 2.3.5)
+  bundler (~> 1.0.0)
+  database_cleaner (~> 0.5.0)
+  friendly (~> 0.6.0)
+  jeweler (~> 1.5.1)
+  memcached (~> 0.20.1)
+  mysql (~> 2.8.1)
+  rcov
+  rspec (~> 2.1.0)
+  yajl-ruby (~> 0.7.7)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Istvan Hoka
+
+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.rdoc

@@ -0,0 +1,21 @@
+= friendly-attributes
+
+Pattern to add fields to ActiveRecord models, using an associated document, without needing schema migrations.
+
+Uses http://friendlyorm.com/
+
+== Contributing to friendly-attributes
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010 Istvan Hoka. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+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 = "friendly-attributes"
+  gem.homepage = "http://github.com/ihoka/friendly-attributes"
+  gem.license = "MIT"
+  gem.summary = %Q{Extend ActiveRecord models using Friendly ORM delegate models}
+  gem.description = %Q{Pattern to add fields to ActiveRecord models, using an associated document, without needing schema migrations.}
+  gem.email = "istvan.hoka@gmail.com"
+  gem.authors = ["Istvan Hoka"]
+  gem.add_runtime_dependency 'activerecord', '~> 2.3.5'
+  gem.add_runtime_dependency 'friendly', '~> 0.6.0'
+  gem.add_runtime_dependency 'yajl-ruby', '~> 0.7.7'
+  gem.add_runtime_dependency 'memcached', '~> 0.20.1'
+  
+  gem.add_development_dependency 'mysql', '~> 2.8.1'
+  gem.add_development_dependency 'rspec', '~> 2.1.0'
+  gem.add_development_dependency 'bundler', '~> 1.0.0'
+  gem.add_development_dependency 'jeweler', '~> 1.5.1'
+  gem.add_development_dependency 'rcov', '>= 0'
+  gem.add_development_dependency 'database_cleaner', '~> 0.5.0'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.rcov = true
+  spec.rcov_opts = %w{-I spec:lib --exclude gems\/,spec\/}
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "friendly-attributes #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/friendly-attributes.gemspec

@@ -0,0 +1,130 @@
+# 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{friendly-attributes}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Istvan Hoka"]
+  s.date = %q{2010-11-20}
+  s.description = %q{Pattern to add fields to ActiveRecord models, using an associated document, without needing schema migrations.}
+  s.email = %q{istvan.hoka@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "friendly-attributes.gemspec",
+    "lib/friendly-attributes.rb",
+    "lib/friendly_attributes.rb",
+    "lib/friendly_attributes/class_methods.rb",
+    "lib/friendly_attributes/details.rb",
+    "lib/friendly_attributes/details_delegator.rb",
+    "lib/friendly_attributes/instance_methods.rb",
+    "spec/config.yml.example",
+    "spec/friendly_attributes/class_methods_spec.rb",
+    "spec/friendly_attributes/details_delegator_spec.rb",
+    "spec/friendly_attributes/details_spec.rb",
+    "spec/friendly_attributes/instance_methods_spec.rb",
+    "spec/friendly_attributes_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/active_record_fake.rb",
+    "spec/support/database_cleaner_helpers.rb"
+  ]
+  s.homepage = %q{http://github.com/ihoka/friendly-attributes}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Extend ActiveRecord models using Friendly ORM delegate models}
+  s.test_files = [
+    "spec/friendly_attributes/class_methods_spec.rb",
+    "spec/friendly_attributes/details_delegator_spec.rb",
+    "spec/friendly_attributes/details_spec.rb",
+    "spec/friendly_attributes/instance_methods_spec.rb",
+    "spec/friendly_attributes_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/active_record_fake.rb",
+    "spec/support/database_cleaner_helpers.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<activerecord>, ["~> 2.3.5"])
+      s.add_runtime_dependency(%q<friendly>, ["~> 0.6.0"])
+      s.add_runtime_dependency(%q<yajl-ruby>, ["~> 0.7.7"])
+      s.add_runtime_dependency(%q<memcached>, ["~> 0.20.1"])
+      s.add_development_dependency(%q<mysql>, ["~> 2.8.1"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<database_cleaner>, ["~> 0.5.0"])
+      s.add_runtime_dependency(%q<activerecord>, ["~> 2.3.5"])
+      s.add_runtime_dependency(%q<friendly>, ["~> 0.6.0"])
+      s.add_runtime_dependency(%q<yajl-ruby>, ["~> 0.7.7"])
+      s.add_runtime_dependency(%q<memcached>, ["~> 0.20.1"])
+      s.add_development_dependency(%q<mysql>, ["~> 2.8.1"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<database_cleaner>, ["~> 0.5.0"])
+    else
+      s.add_dependency(%q<activerecord>, ["~> 2.3.5"])
+      s.add_dependency(%q<friendly>, ["~> 0.6.0"])
+      s.add_dependency(%q<yajl-ruby>, ["~> 0.7.7"])
+      s.add_dependency(%q<memcached>, ["~> 0.20.1"])
+      s.add_dependency(%q<mysql>, ["~> 2.8.1"])
+      s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<database_cleaner>, ["~> 0.5.0"])
+      s.add_dependency(%q<activerecord>, ["~> 2.3.5"])
+      s.add_dependency(%q<friendly>, ["~> 0.6.0"])
+      s.add_dependency(%q<yajl-ruby>, ["~> 0.7.7"])
+      s.add_dependency(%q<memcached>, ["~> 0.20.1"])
+      s.add_dependency(%q<mysql>, ["~> 2.8.1"])
+      s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<database_cleaner>, ["~> 0.5.0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, ["~> 2.3.5"])
+    s.add_dependency(%q<friendly>, ["~> 0.6.0"])
+    s.add_dependency(%q<yajl-ruby>, ["~> 0.7.7"])
+    s.add_dependency(%q<memcached>, ["~> 0.20.1"])
+    s.add_dependency(%q<mysql>, ["~> 2.8.1"])
+    s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<database_cleaner>, ["~> 0.5.0"])
+    s.add_dependency(%q<activerecord>, ["~> 2.3.5"])
+    s.add_dependency(%q<friendly>, ["~> 0.6.0"])
+    s.add_dependency(%q<yajl-ruby>, ["~> 0.7.7"])
+    s.add_dependency(%q<memcached>, ["~> 0.20.1"])
+    s.add_dependency(%q<mysql>, ["~> 2.8.1"])
+    s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<database_cleaner>, ["~> 0.5.0"])
+  end
+end
+

data/lib/friendly-attributes.rb

@@ -0,0 +1 @@
+require 'friendly_attributes'

data/lib/friendly_attributes.rb

@@ -0,0 +1,14 @@
+require 'friendly'
+require 'active_record'
+
+module FriendlyAttributes
+  autoload :ClassMethods,     'friendly_attributes/class_methods'
+  autoload :InstanceMethods,  'friendly_attributes/instance_methods'
+  autoload :Details,          'friendly_attributes/details'
+  autoload :DetailsDelegator, 'friendly_attributes/details_delegator'
+  
+  def self.included(base)
+    base.extend ClassMethods
+    base.send(:include, InstanceMethods)
+  end
+end

data/lib/friendly_attributes/class_methods.rb

@@ -0,0 +1,16 @@
+module FriendlyAttributes
+  module ClassMethods
+    def friendly_details(klass, &block)
+      DetailsDelegator.new(klass, self, &block)
+    end
+    
+    def friendly_mount_uploader(name, klass)
+      mount_uploader name, klass
+      
+      instance_eval do
+        alias_method :read_uploader, :read_friendly_attribute
+        alias_method :write_uploader, :write_friendly_attribute
+      end
+    end
+  end
+end

data/lib/friendly_attributes/details.rb

@@ -0,0 +1,9 @@
+module FriendlyAttributes
+  class Details
+    class << self
+      def find_or_build_by_active_record_id(active_record_id)
+        active_record_id && first(:active_record_id => active_record_id) || new(:active_record_id => active_record_id)
+      end
+    end
+  end
+end

data/lib/friendly_attributes/details_delegator.rb

@@ -0,0 +1,42 @@
+module FriendlyAttributes
+  class DetailsDelegator
+    attr_reader :friendly_model, :ar_model
+    
+    delegate :attribute, :indexes, :to => :friendly_model
+    
+    def initialize(friendly_model, ar_model, &block)
+      @ar_model       = ar_model
+      @friendly_model = friendly_model
+      
+      friendly_model.instance_eval do
+        include Friendly::Document
+      
+        attribute :active_record_id, Integer
+        indexes :active_record_id
+      end
+      
+      ar_model.class_eval do
+        after_save :update_friendly_details
+        after_destroy :destroy_friendly_details
+        
+        define_method(:details) do
+          @details ||= friendly_model.find_or_build_by_active_record_id(id)
+        end
+      end
+      
+      self.instance_eval(&block)
+    end
+    
+    def delegated_attribute(name, klass)
+      attribute name, klass
+      delegated_method(:"#{name}")
+      delegated_method(:"#{name}=")
+    end
+    
+    def delegated_method(name)
+      ar_model.class_eval do
+        delegate :"#{name}", :to => :details
+      end
+    end
+  end
+end

data/lib/friendly_attributes/instance_methods.rb

@@ -0,0 +1,25 @@
+module FriendlyAttributes
+  module InstanceMethods
+    def read_friendly_attribute(column)
+      details.send(column)
+    end
+
+    def write_friendly_attribute(column, instance)
+      details.send(:"#{column}=", instance)
+    end
+
+    def details_present?
+      @details.present?
+    end
+
+    def update_friendly_details
+      return unless details_present?
+      details.active_record_id = id unless details.active_record_id == id
+      details.save if details.changed?
+    end
+
+    def destroy_friendly_details
+      details.destroy
+    end
+  end
+end

data/spec/config.yml.example

@@ -0,0 +1,6 @@
+test:
+  :adapter:  "mysql"
+  :host:     "localhost"
+  :user:     "root"
+  :password:
+  :database: "friendly_attributes_test"

data/spec/friendly_attributes/class_methods_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe FriendlyAttributes::ClassMethods do
+  let(:friendly_model)    { Class.new }
+  let(:ar_model)          {
+    Class.new {
+      include ActiveRecordFake
+      extend FriendlyAttributes::ClassMethods
+    }
+  }
+  let(:initializer)       { proc {} }
+  let(:details_delegator) { mock(FriendlyAttributes::DetailsDelegator) }
+  
+  class FakeUploader; end
+  
+  describe ".friendly_details" do
+    it "instantiates a new DetailsDelegator" do
+      FriendlyAttributes::DetailsDelegator.should_receive(:new).with(friendly_model, ar_model, &initializer).and_return(details_delegator)
+      ar_model.friendly_details(friendly_model, &initializer).should == details_delegator
+    end
+  end
+  
+  describe ".friendly_mount_uploader" do
+    let(:foo_value) { mock("Friendly attribute value") }
+    
+    before(:each) do
+      ar_model.stub(:mount_uploader => nil)
+      
+      foo = foo_value
+      
+      ar_model.class_eval do
+        define_method(:read_friendly_attribute) do |attribute|
+          attribute.should == :foo
+          foo
+        end
+        
+        define_method(:write_friendly_attribute) do |attribute, value|
+          value.tap do
+            attribute.should == :foo
+            value.should == foo
+          end
+        end
+      end
+    end
+    
+    it "mounts the uploader" do
+      ar_model.should_receive(:mount_uploader).with(:foo, FakeUploader)
+      ar_model.friendly_mount_uploader :foo, FakeUploader
+    end
+    
+    it "aliases #read_friendly_attribute to #read_uploader" do
+      ar_model.friendly_mount_uploader :foo, FakeUploader
+      ar_object = ar_model.new
+      
+      ar_object.read_uploader(:foo).should == foo_value
+    end
+    
+    it "aliases #read_friendly_attribute to #read_uploader" do
+      ar_model.friendly_mount_uploader :foo, FakeUploader
+      ar_object = ar_model.new
+      
+      ar_object.write_uploader(:foo, foo_value).should == foo_value
+    end
+  end
+end

data/spec/friendly_attributes/details_delegator_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+
+describe FriendlyAttributes::DetailsDelegator do
+  let(:details_delegator) { FriendlyAttributes::DetailsDelegator.new(friendly_model, ar_model, &initializer) }
+  let(:initializer)       { proc {} }
+  
+  let(:friendly_model)    { Class.new }
+  let(:ar_model)          { Class.new { include ActiveRecordFake } }
+  
+  let(:ar_instance)       { ar_model.new(:id => 42) }
+  let(:friendly_instance) { mock(friendly_model) }
+  
+  describe "initialization" do
+    context "the Friendly model" do
+      before(:each) do
+        details_delegator
+      end
+      
+      it "includes Friendly::Document" do
+        friendly_model.ancestors.should include(Friendly::Document)
+      end
+
+      it "adds the active_record_id attribute" do
+        friendly_model.attributes.should include(:active_record_id)
+      end
+
+      it "adds an index to active_record_id" do
+        friendly_model.storage_proxy.index_for_fields([:active_record_id]).should be_an_instance_of(Friendly::Index)
+      end
+    end
+    
+    context "the ActiveRecord model" do
+      it "installs the update_friendly_details callback after_save" do
+        ar_model.should_receive(:after_save).with(:update_friendly_details)
+        details_delegator
+      end
+      
+      it "installs the destroy_friendly_details callback after_destroy" do
+        ar_model.should_receive(:after_destroy).with(:destroy_friendly_details)
+        details_delegator
+      end
+      
+      context ".details" do
+        before(:each) do
+          details_delegator
+        end
+        
+        it "is defined" do
+          ar_instance.should respond_to(:details)
+        end
+        
+        it "finds and memoizes the associated Friendly model" do
+          friendly_model.should_receive(:find_or_build_by_active_record_id).with(ar_instance.id).once.and_return(friendly_instance)
+          ar_instance.details.should == friendly_instance
+          ar_instance.details.should == friendly_instance
+        end
+      end
+    end
+  
+    context "the initialization block" do
+      def yielded_inside(instance)
+        @yielded_instance = instance
+      end
+      
+      let(:initializer) do
+        example = self
+        
+        proc {
+          example.yielded_inside(self)
+        }
+      end
+      
+      it "is instance evaled" do
+        details_delegator
+        @yielded_instance.should == details_delegator
+      end
+    end
+  end
+  
+  describe "#delegated_method" do
+    before(:each) do
+      details_delegator
+      details_delegator.delegated_method(:some_method)
+      ar_instance.stub(:details => friendly_instance)
+    end
+    
+    it "delegates the method to Friendly model" do
+      bar = mock
+      friendly_instance.should_receive(:some_method).with(:foo).and_return(bar)
+      ar_instance.some_method(:foo).should == bar
+    end
+  end
+  
+  describe "#delegated_attribute" do
+    before(:each) do
+      details_delegator
+      details_delegator.delegated_attribute(:some_attribute, String)
+      ar_instance.stub(:details => friendly_instance)
+    end
+    
+    it "adds an attribute to the Friendly model" do
+      friendly_model.attributes.should include(:some_attribute)
+      friendly_model.attributes[:some_attribute].type.should == String
+    end
+    
+    it "delegates the reader to Friendly model" do
+      bar = mock
+      friendly_instance.should_receive(:some_attribute).and_return(bar)
+      ar_instance.some_attribute.should == bar
+    end
+    
+    it "delegates the writer to Friendly model" do
+      bar = mock
+      friendly_instance.should_receive(:some_attribute=).with(:value)
+      ar_instance.some_attribute = :value
+    end
+  end
+end

data/spec/friendly_attributes/details_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe FriendlyAttributes::Details do
+  use_database_cleanup
+  
+  describe ".find_or_build_by_active_record_id" do
+    context "when the record does not exist" do
+      it "builds a new record with the active_record_id" do
+        details = UserDetails.find_or_build_by_active_record_id(42)
+        details.should be_new_record
+        details.active_record_id.should == 42
+      end
+    end
+    
+    context "when the record exists" do
+      let(:details) { UserDetails.create(:active_record_id => 42) }
+      
+      before(:each) do
+        details.should_not be_new_record
+      end
+      
+      it "finds the record" do
+        UserDetails.find_or_build_by_active_record_id(42).should == details
+      end
+    end
+  end
+end

data/spec/friendly_attributes/instance_methods_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+describe FriendlyAttributes::InstanceMethods do
+  let(:object)  { klass.new.tap { |o| o.stub(:details => details) } }
+  let(:klass)   {
+    Class.new {
+      include ActiveRecordFake
+      include FriendlyAttributes::InstanceMethods
+    }
+  }
+  let(:details) { mock("details") }
+  
+  describe "#read_friendly_attribute" do
+    it "reads the attribute from details" do
+      foo = mock
+      
+      details.should_receive(:foo).and_return(foo)
+      object.read_friendly_attribute(:foo).should == foo
+    end
+  end
+  
+  describe "#write_friendly_attribute" do
+    it "writes the attribute to details" do
+      foo = mock
+      
+      details.should_receive(:foo=).with(:value)
+      object.write_friendly_attribute(:foo, :value)
+    end
+  end
+  
+  describe "#details_present?" do
+    subject { object.details_present? }
+    
+    context "when @details is present" do
+      before(:each) do
+        object.instance_variable_set(:"@details", mock)
+      end
+      
+      it { should be_true }
+    end
+    
+    context "when @details is not present" do
+      it { should be_false }
+    end
+  end
+  
+  describe "#update_friendly_details" do
+    context "details are present" do
+      before(:each) do
+        object.id = 42
+        object.should_receive(:details_present?).and_return(true)
+        details.stub(:changed? => false, :active_record_id => object.id)
+      end
+      
+      context "details.active_record_id does not equal object.id" do
+        before(:each) do
+          details.should_receive(:active_record_id).and_return(nil)
+        end
+        
+        it "sets the active_record_id" do
+          details.should_receive(:active_record_id=).with(object.id)
+          object.update_friendly_details
+        end
+      end
+      
+      context "details.active_record_id equals object.id" do
+        before(:each) do
+          details.should_receive(:active_record_id).and_return(object.id)
+        end
+        
+        it "sets the active_record_id" do
+          details.should_not_receive(:active_record_id=)
+          object.update_friendly_details
+        end
+      end
+      
+      context "the details have changed" do
+        before(:each) do
+          details.should_receive(:changed?).and_return(true)
+        end
+        
+        it "saves the details" do
+          details.should_receive(:save)
+          object.update_friendly_details
+        end
+      end
+      
+      context "the details have NOT changed" do
+        before(:each) do
+          details.should_receive(:changed?).and_return(false)
+        end
+        
+        it "saves the details" do
+          details.should_not_receive(:save)
+          object.update_friendly_details
+        end
+      end
+    end
+    
+    context "details are NOT present" do
+      before(:each) do
+        object.should_receive(:details_present?).and_return(false)
+      end
+    end
+  end
+
+  describe "#destroy_friendly_details" do
+    it "destroys the details" do
+      details.should_receive(:destroy)
+      object.destroy_friendly_details
+    end
+  end
+end

data/spec/friendly_attributes_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe FriendlyAttributes do
+  use_database_cleanup
+  
+  describe "creating" do
+    context "with Friendly attributes" do
+      let(:user) { User.create(:name => "Stan", :email => "stan@example.com") }
+      
+      it "creates an associated Details model with the AR model" do
+        expect do
+          user
+        end.to change { UserDetails.count({}) }
+        
+        user_detail = user.details
+        user_detail.name.should == "Stan"
+      end
+    end
+    
+    context "without Friendly attributes" do
+      let(:user) { User.create(:email => "stan@example.com") }
+      
+      it "does not create an associated Details model" do
+        expect do
+          user
+        end.to_not change { UserDetails.count({}) }
+      end
+    end
+  end
+  
+  describe "updating" do
+    context "with Friendly attributes" do
+      let(:user) { User.create(:name => "Stan", :email => "stan@example.com") }
+      
+      it "updates the attributes" do
+        user.update_attributes(:name => "Eric")
+        UserDetails.first({}).name.should == "Eric"
+      end
+    end
+    
+    context "without Friendly attributes" do
+      let(:user) { User.create(:email => "stan@example.com") }
+      
+      it "does not create an associated Details model, if no delegated attributes are updated" do
+        expect do
+          user.update_attributes(:email => "eric@example.com")
+        end.to_not change { UserDetails.count({}) }
+      end
+      
+      it "creates an associated Details model, if delegated attributes are updated" do
+        expect do
+          user.update_attributes(:name => "Eric")
+        end.to change { UserDetails.count({}) }
+        user.name.should == "Eric"
+      end
+    end
+  end
+  
+  describe "destroying" do
+    let(:user) { User.create(:name => "Stan", :email => "stan@example.com") }
+    
+    it "destroys the associated Details model" do
+      user # create it first
+      
+      expect do
+        user.destroy
+      end.to change { UserDetails.count({}) }.by(-1)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,56 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'memcached'
+require 'yajl'
+require 'friendly_attributes'
+require 'database_cleaner'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  yaml = YAML.load(File.read(File.dirname(__FILE__) + "/config.yml"))
+  Friendly.configure yaml['test']
+  
+  $db = Friendly.db
+  
+  %w[user_details index_user_details_on_active_record_id].each do |table|
+    $db.drop_table(table) if $db.table_exists?(table)
+  end
+  
+  datastore                    = Friendly::DataStore.new($db)
+  Friendly.datastore           = datastore
+  $cache                       = Memcached.new
+  Friendly.cache               = Friendly::Memcached.new($cache)
+  
+  ActiveRecord::Base.logger = Friendly.db.logger = Logger.new(File.dirname(__FILE__) + "/../log/test.log")
+  
+  ActiveRecord::Base.configurations = yaml
+  ActiveRecord::Base.establish_connection 'test'
+  ActiveRecord::Schema.define do
+    create_table :users, :force => true do |t|
+      t.string :email
+    end
+  end
+      
+  class ::UserDetails < FriendlyAttributes::Details
+  end
+  
+  class ::User < ActiveRecord::Base
+    include FriendlyAttributes
+    
+    friendly_details UserDetails do
+      delegated_attribute :name, String
+    end
+  end
+  
+  Friendly::Document.create_tables!
+  
+  DatabaseCleaner.strategy = :truncation
+  DatabaseCleaner.clean_with(:truncation)
+  
+  config.extend DatabaseCleanerHelpers
+end
+

data/spec/support/active_record_fake.rb

@@ -0,0 +1,18 @@
+module ActiveRecordFake
+  def self.included(base)
+    base.instance_eval do
+      attr_accessor :id
+    end
+    
+    (class << base; self; end).class_eval do
+      def after_save(*args); end
+      def after_destroy(*args); end
+    end
+  end
+  
+  def initialize(attributes={})
+    attributes.each do |k, v|
+      send(:"#{k}=", v)
+    end
+  end
+end

data/spec/support/database_cleaner_helpers.rb

@@ -0,0 +1,11 @@
+module DatabaseCleanerHelpers
+  def use_database_cleanup
+    before(:each) do
+      DatabaseCleaner.start
+    end
+    
+    after(:each) do
+      DatabaseCleaner.clean
+    end
+  end
+end

metadata

@@ -0,0 +1,412 @@
+--- !ruby/object:Gem::Specification 
+name: friendly-attributes
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Istvan Hoka
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-20 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: activerecord
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: friendly
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: yajl-ruby
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 7
+        - 7
+        version: 0.7.7
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: memcached
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 77
+        segments: 
+        - 0
+        - 20
+        - 1
+        version: 0.20.1
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: mysql
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 45
+        segments: 
+        - 2
+        - 8
+        - 1
+        version: 2.8.1
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rspec
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: bundler
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: jeweler
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  requirement: *id008
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rcov
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id009
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: database_cleaner
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  requirement: *id010
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: activerecord
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  requirement: *id011
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: friendly
+  version_requirements: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  requirement: *id012
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: yajl-ruby
+  version_requirements: &id013 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 7
+        - 7
+        version: 0.7.7
+  requirement: *id013
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: memcached
+  version_requirements: &id014 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 77
+        segments: 
+        - 0
+        - 20
+        - 1
+        version: 0.20.1
+  requirement: *id014
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: mysql
+  version_requirements: &id015 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 45
+        segments: 
+        - 2
+        - 8
+        - 1
+        version: 2.8.1
+  requirement: *id015
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rspec
+  version_requirements: &id016 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  requirement: *id016
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: bundler
+  version_requirements: &id017 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id017
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: jeweler
+  version_requirements: &id018 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  requirement: *id018
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rcov
+  version_requirements: &id019 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id019
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: database_cleaner
+  version_requirements: &id020 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  requirement: *id020
+description: Pattern to add fields to ActiveRecord models, using an associated document, without needing schema migrations.
+email: istvan.hoka@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- friendly-attributes.gemspec
+- lib/friendly-attributes.rb
+- lib/friendly_attributes.rb
+- lib/friendly_attributes/class_methods.rb
+- lib/friendly_attributes/details.rb
+- lib/friendly_attributes/details_delegator.rb
+- lib/friendly_attributes/instance_methods.rb
+- spec/config.yml.example
+- spec/friendly_attributes/class_methods_spec.rb
+- spec/friendly_attributes/details_delegator_spec.rb
+- spec/friendly_attributes/details_spec.rb
+- spec/friendly_attributes/instance_methods_spec.rb
+- spec/friendly_attributes_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record_fake.rb
+- spec/support/database_cleaner_helpers.rb
+has_rdoc: true
+homepage: http://github.com/ihoka/friendly-attributes
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+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: Extend ActiveRecord models using Friendly ORM delegate models
+test_files: 
+- spec/friendly_attributes/class_methods_spec.rb
+- spec/friendly_attributes/details_delegator_spec.rb
+- spec/friendly_attributes/details_spec.rb
+- spec/friendly_attributes/instance_methods_spec.rb
+- spec/friendly_attributes_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record_fake.rb
+- spec/support/database_cleaner_helpers.rb