attribute_delegator 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+test/*.db

data/Gemfile

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

data/README.markdown

@@ -0,0 +1,51 @@
+# Attribute Delegator
+
+AttributeDelegator is a gem that provides a class method to ActiveRecord
+models which will generate native getter/setter methods for a the attributes of
+a has_one delegate.
+
+Sound complicated? It's not.
+
+## How To Use
+
+This is how to setup AttributeDelegator
+
+    # Contains a 'title' field.
+    class Entry < ActiveRecord::Base
+      include ::AttributeDelegator
+      has_one :entry_metadata
+      delegates_attributes_to :entry_metadata, [:page_views]
+    end
+
+    # Contains 'entry_id' and 'page_views' fields.
+    class EntryMetadata < ActiveRecord::Base
+      belongs_to :entry
+      validates_uniqueness_of :entry_id
+    end
+
+And this is how you can use it
+
+    # You can use normal getter/setter methods
+    e1 = Entry.new(:title => 'entry title')
+    e1.page_views = 50
+    e1.save!
+    assert_equal e1.page_views, e1.entry_metadata.page_views
+
+    # You can also set the attributes upon creation
+    e2 = Entry.create!(:title => 'Another title', :page_views => 50)
+    assert_equal 50, e2.page_views
+
+    # Finally, you can use attributes=, like you would submitting a form
+    e3 = Entry.new
+    e3.attributes = { :title => 'a title', :page_views => 50}
+    assert_equal 50, e3.page_views
+
+## Why?
+
+This gem was created to prevent large, STI models from bloating unecceesarily
+when new fields needed to be added for certain subtypes, but not the
+base class. This interface is particularly useful when the attributes
+for that model are set by a form, because it means that the foreign
+attributes can be seamlessly set using attributes=, and the form can
+remain simple, even for attributes specific to one subtype.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/attribute_delegator.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "attribute_delegator/version"
+
+Gem::Specification.new do |s|
+  s.name        = "attribute_delegator"
+  s.version     = AttributeDelegator::VERSION
+  s.authors     = ["Clif Reeder"]
+  s.email       = ["clif@voxmedia.com"]
+  s.homepage    = ""
+  s.summary     = %q{ActiveRecord extension that allows you to treat fields from another model/table as local attributes.}
+  s.description = %q{AttributeDelegator provides a class method to ActiveRecord models that dynamically generates getter/setter to treat the attributes of a has_one model like native attributes. This is particularly useful because it allows the delegated attributes to be assigned via model.attributes= {}, such as by a form submission.}
+
+  s.rubyforge_project = "attribute_delegator"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "activerecord", ">= 2.3.8"
+  s.add_dependency "activesupport", ">= 2.3.8"
+  s.add_development_dependency "sqlite3"
+end

data/lib/attribute_delegator.rb

@@ -0,0 +1,51 @@
+require "attribute_delegator/version"
+
+module AttributeDelegator
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+
+    private
+
+    def delegates_attributes_to(the_delegate, attrs)
+
+      exists_method = :"ensure_#{the_delegate}_exists"
+      define_method exists_method do
+        build_method = "build_#{the_delegate.to_s}"
+        self.send(build_method.to_sym)
+      end
+
+      saved_method = :"ensure_#{the_delegate}_saved"
+      define_method saved_method do
+        delegate_obj = self.send(the_delegate)
+        return unless delegate_obj
+        if delegate_obj.changed? || delegate_obj.new_record?
+          delegate_obj.save!
+        end
+      end
+
+      # This would normally be an 'after_update' callback, but meta it cause the callback name changes
+      self.send(:after_update, saved_method)
+
+      attrs.each do |attr|
+        # Define the getter
+        define_method :"#{attr}" do
+          delegate_obj = self.send(the_delegate)
+          # Only send the attribute query if the object already
+          # exists. If it hasn't been instantiated, just return nil
+          if delegate_obj
+            delegate_obj.send(attr)
+          else
+            nil
+          end
+        end
+
+        #Define the setter
+        define_method :"#{attr}=" do |arg|
+          self.send(exists_method)
+          self.send(the_delegate).send("#{attr}=".to_sym, arg)
+        end
+      end
+    end
+  end
+end

data/lib/attribute_delegator/version.rb

@@ -0,0 +1,3 @@
+module AttributeDelegator
+  VERSION = "0.0.1"
+end

data/test/attribute_delegator_test.rb

@@ -0,0 +1,49 @@
+require 'test/setup'
+
+class Entry < ActiveRecord::Base
+  include ::AttributeDelegator
+  has_one :entry_metadata
+  delegates_attributes_to :entry_metadata, [:page_views]
+end
+
+class EntryMetadata < ActiveRecord::Base
+  belongs_to :entry
+  validates_uniqueness_of :entry_id
+end
+
+
+class TestAttributeDelegator < Test::Unit::TestCase
+  def setup
+    @entry = Entry.create!(:title => "Entry Title", :body => "Body of entry")
+  end
+
+  def test_delegated_attributes_getters_and_setters
+    assert_nil @entry.page_views
+    page_views = 5
+    @entry.page_views = page_views
+    assert_equal @entry.page_views, page_views
+    assert @entry.entry_metadata.changed?
+
+    @entry.save!
+    @entry = Entry.find(@entry.id)
+    assert_equal @entry.page_views, @entry.entry_metadata.page_views
+    assert_equal false, @entry.entry_metadata.changed?, "if the parent object is saved, the delgate should be as well"
+  end
+
+  def test_delegates_attributes_can_be_set_by_attributes=
+    assert_nil @entry.page_views
+    page_views = 5
+    @entry.attributes = { :page_views => page_views }
+    @entry.save!
+
+    entry = Entry.find(@entry.id)
+    assert_equal 5, entry.page_views
+  end
+
+  def test_repeated_assignment_doesnt_break
+    @entry.page_views = 5
+    assert_equal 5, @entry.page_views
+    @entry.page_views = 10
+    assert_equal 10, @entry.page_views
+  end
+end

data/test/multiple_attribute_delegator_test.rb

@@ -0,0 +1,40 @@
+require 'test/setup'
+
+class Entry < ActiveRecord::Base
+  include ::AttributeDelegator
+  has_one :entry_metadata
+  delegates_attributes_to :entry_metadata, [:page_views]
+
+  has_one :entry_photo
+  delegates_attributes_to :entry_photo, [:photo]
+end
+
+class EntryMetadata < ActiveRecord::Base
+  belongs_to :entry
+  validates_uniqueness_of :entry_id
+end
+
+class EntryPhoto < ActiveRecord::Base
+  belongs_to :entry
+  validates_uniqueness_of :entry_id
+end
+
+
+class TestMultipleAttributeDelegators < Test::Unit::TestCase
+  def setup
+    @entry = Entry.create!(:title => "Entry Title", :body => "Body of entry")
+  end
+
+  def test_working_with_multiple_delegates
+    page_views = 10
+    photo = "ok pretend this string is a photo"
+    e = Entry.create!({
+      :page_views => page_views,
+      :photo => photo
+    })
+    assert_equal photo, e.photo
+    assert_equal photo, e.entry_photo.photo
+    assert_equal page_views, e.page_views
+    assert_equal page_views, e.entry_metadata.page_views
+  end
+end

data/test/setup.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'active_record'
+require 'active_record/fixtures'
+require 'attribute_delegator'
+require 'test/unit'
+
+ActiveRecord::Base.establish_connection({
+  :adapter => 'sqlite3',
+  :database => 'test/attribute_delegator_test.db',
+  :dbfile => 'test.db'
+})
+
+ActiveRecord::Schema.define do
+  create_table "entries", :force => true do |t|
+    t.column "title",  :string
+    t.column "body",  :text
+  end
+
+  create_table "entry_metadata", :force => true do |t|
+    t.column "entry_id", :integer
+    t.column "page_views",  :integer
+  end
+
+  create_table "entry_photos", :force => true do |t|
+    t.column "entry_id", :integer
+    t.column "photo",  :text
+  end
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: attribute_delegator
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Clif Reeder
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-16 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 3
+        - 8
+        version: 2.3.8
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 3
+        - 8
+        version: 2.3.8
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: AttributeDelegator provides a class method to ActiveRecord models that dynamically generates getter/setter to treat the attributes of a has_one model like native attributes. This is particularly useful because it allows the delegated attributes to be assigned via model.attributes= {}, such as by a form submission.
+email: 
+- clif@voxmedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- attribute_delegator.gemspec
+- lib/attribute_delegator.rb
+- lib/attribute_delegator/version.rb
+- test/attribute_delegator_test.rb
+- test/multiple_attribute_delegator_test.rb
+- test/setup.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+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: attribute_delegator
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: ActiveRecord extension that allows you to treat fields from another model/table as local attributes.
+test_files: 
+- test/attribute_delegator_test.rb
+- test/multiple_attribute_delegator_test.rb
+- test/setup.rb