active_record_inherit_assoc 0.0.6

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/*
+.bundle
+*.log
+localgems
+.*.swp
+/Gemfile.lock

data/.travis.yml

@@ -0,0 +1,7 @@
+script: "bundle exec rake test"
+rvm:
+  - 1.8.7
+  - 1.9.3
+gemfile:
+  - gemfiles/activerecord-2.3.gemfile
+  - gemfiles/activerecord-3.0.gemfile

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "rails2.3" do
+  gem "activerecord", "2.3.14", :require => 'active_record'
+end
+
+appraise "rails3.0" do
+  gem "activerecord", "3.0.15", :require => 'active_record'
+end

data/Gemfile

@@ -0,0 +1,15 @@
+source :rubygems
+
+gemspec
+
+gem 'appraisal'
+gem 'rake'
+gem 'rails'
+gem 'bundler'
+gem 'sqlite3'
+gem 'shoulda'
+gem 'jeweler'
+gem 'ruby-debug', :platforms => :ruby_18
+gem 'debugger', :platforms => :ruby_19
+gem 'test-unit', '>=2.5.1'
+gem 'activerecord', :require => 'active_record'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Zendesk
+
+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,26 @@
+# ActiveRecord association inheritance
+
+Makes the model inherit the specified attribute from a named association.
+
+## Install
+
+    gem install active_record_inherit_assoc
+
+## Usage
+
+    # parent_name - The Symbol name of the parent association.
+    # options     - The Hash options to use:
+    #               :attr - A Symbol or an Array of Symbol names of the attributes
+    #                       that should be inherited from the parent association.
+    #
+    class Post < ActiveRecord::Base
+      belongs_to :category
+      inherits_from :category, :attr => :account
+    end
+
+## Copyright
+
+Copyright (c) 2011 Zendesk. See MIT-LICENSE for details.
+
+## Author
+Ben Osheroff <ben@gimbo.net>

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'appraisal'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/test*.rb'
+  test.verbose = true
+end
+
+task :default do
+  sh "bundle exec rake appraisal:install && bundle exec rake appraisal test"
+end

data/active_record_inherit_assoc.gemspec

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+name = "active_record_inherit_assoc"
+
+Gem::Specification.new name, "0.0.6" do |s|
+  s.summary = "Attribute inheritance for AR associations"
+  s.authors = ["Ben Osheroff"]
+  s.email = ["ben@gimbo.net"]
+  s.files = `git ls-files`.split("\n")
+  s.license = "MIT"
+  s.homepage = "http://github.com/zendesk/#{name}"
+  s.add_runtime_dependency "activerecord"
+end
+

data/gemfiles/rails2.3.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source :rubygems
+
+gem "appraisal"
+gem "rake"
+gem "rails"
+gem "bundler"
+gem "sqlite3"
+gem "shoulda"
+gem "jeweler"
+gem "ruby-debug", :platforms=>:ruby_18
+gem "debugger", :platforms=>:ruby_19
+gem "test-unit", ">=2.5.1"
+gem "activerecord", "2.3.14", :require=>"active_record"
+
+gemspec :path=>"../"

data/gemfiles/rails2.3.gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: /Users/mgrosser/code/tools/active_record_inherit_assoc
+  specs:
+    active_record_inherit_assoc (0.0.5)
+      activerecord
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (2.3.14)
+      actionpack (= 2.3.14)
+    actionpack (2.3.14)
+      activesupport (= 2.3.14)
+      rack (~> 1.1.0)
+    activerecord (2.3.14)
+      activesupport (= 2.3.14)
+    activeresource (2.3.14)
+      activesupport (= 2.3.14)
+    activesupport (2.3.14)
+    appraisal (0.4.1)
+      bundler
+      rake
+    columnize (0.3.6)
+    debugger (1.1.4)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1.1)
+      debugger-ruby_core_source (~> 1.1.3)
+    debugger-linecache (1.1.2)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.3)
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
+    rack (1.1.3)
+    rails (2.3.14)
+      actionmailer (= 2.3.14)
+      actionpack (= 2.3.14)
+      activerecord (= 2.3.14)
+      activeresource (= 2.3.14)
+      activesupport (= 2.3.14)
+      rake (>= 0.8.3)
+    rake (0.9.2.2)
+    rbx-require-relative (0.0.9)
+    rdoc (3.12)
+      json (~> 1.4)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    shoulda (3.0.1)
+      shoulda-context (~> 1.0.0)
+      shoulda-matchers (~> 1.0.0)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.0.0)
+    sqlite3 (1.3.6)
+    test-unit (2.5.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_record_inherit_assoc!
+  activerecord (= 2.3.14)
+  appraisal
+  bundler
+  debugger
+  jeweler
+  rails
+  rake
+  ruby-debug
+  shoulda
+  sqlite3
+  test-unit (>= 2.5.1)

data/gemfiles/rails3.0.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source :rubygems
+
+gem "appraisal"
+gem "rake"
+gem "rails"
+gem "bundler"
+gem "sqlite3"
+gem "shoulda"
+gem "jeweler"
+gem "ruby-debug", :platforms=>:ruby_18
+gem "debugger", :platforms=>:ruby_19
+gem "test-unit", ">=2.5.1"
+gem "activerecord", "3.0.15", :require=>"active_record"
+
+gemspec :path=>"../"

data/gemfiles/rails3.0.gemfile.lock

@@ -0,0 +1,125 @@
+PATH
+  remote: /Users/mgrosser/code/tools/active_record_inherit_assoc
+  specs:
+    active_record_inherit_assoc (0.0.5)
+      activerecord
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.15)
+      actionpack (= 3.0.15)
+      mail (~> 2.2.19)
+    actionpack (3.0.15)
+      activemodel (= 3.0.15)
+      activesupport (= 3.0.15)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.5)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.15)
+      activesupport (= 3.0.15)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.15)
+      activemodel (= 3.0.15)
+      activesupport (= 3.0.15)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.15)
+      activemodel (= 3.0.15)
+      activesupport (= 3.0.15)
+    activesupport (3.0.15)
+    appraisal (0.4.1)
+      bundler
+      rake
+    arel (2.0.10)
+    builder (2.1.2)
+    columnize (0.3.6)
+    debugger (1.1.4)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1.1)
+      debugger-ruby_core_source (~> 1.1.3)
+    debugger-linecache (1.1.2)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.3)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.3)
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    polyglot (0.3.3)
+    rack (1.2.5)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.15)
+      actionmailer (= 3.0.15)
+      actionpack (= 3.0.15)
+      activerecord (= 3.0.15)
+      activeresource (= 3.0.15)
+      activesupport (= 3.0.15)
+      bundler (~> 1.0)
+      railties (= 3.0.15)
+    railties (3.0.15)
+      actionpack (= 3.0.15)
+      activesupport (= 3.0.15)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.4)
+    rake (0.9.2.2)
+    rbx-require-relative (0.0.9)
+    rdoc (3.12)
+      json (~> 1.4)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    shoulda (3.0.1)
+      shoulda-context (~> 1.0.0)
+      shoulda-matchers (~> 1.0.0)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.0.0)
+    sqlite3 (1.3.6)
+    test-unit (2.5.1)
+    thor (0.14.6)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_record_inherit_assoc!
+  activerecord (= 3.0.15)
+  appraisal
+  bundler
+  debugger
+  jeweler
+  rails
+  rake
+  ruby-debug
+  shoulda
+  sqlite3
+  test-unit (>= 2.5.1)

data/lib/active_record_inherit_assoc.rb

@@ -0,0 +1,103 @@
+require 'active_record'
+require 'active_record/base'
+require 'active_record/reflection'
+require 'active_record/associations/association_proxy'
+require 'active_record/associations/association_collection'
+
+ActiveRecord::Base.valid_keys_for_has_many_association << :inherit
+ActiveRecord::Base.valid_keys_for_has_one_association << :inherit
+ActiveRecord::Base.valid_keys_for_belongs_to_association << :inherit
+
+class ActiveRecord::Base
+  # Makes the model inherit the specified attribute from a named association.
+  #
+  # parent_name - The Symbol name of the parent association.
+  # options     - The Hash options to use:
+  #               :attr - A Symbol or an Array of Symbol names of the attributes
+  #                       that should be inherited from the parent association.
+  #
+  # Examples
+  #
+  #   class Post < ActiveRecord::Base
+  #     belongs_to :category
+  #     inherits_from :category, :attr => :account
+  #   end
+  #
+  def self.inherits_from(parent_name, options = {})
+    attrs = Array.wrap(options.fetch(:attr))
+
+    before_validation do |model|
+      parent = model.send(parent_name)
+
+      attrs.each do |attr|
+        model[attr] = parent[attr] if parent.present?
+      end
+    end
+  end
+end
+
+module ActiveRecord
+  module Associations
+    AssociationProxy.class_eval do
+      def conditions_with_value_inheritance
+        return conditions_without_value_inheritance unless @reflection.klass.respond_to?(:sanitize_sql) # ActiveHash TODO test this!
+        copied_merge_conditions(attribute_inheritance_hash, conditions_without_value_inheritance)
+      end
+
+      alias_method_chain :conditions, :value_inheritance
+
+      private
+
+      # copied from activerecord 2.3 to fix compatability with 3.0
+      # Merges conditions so that the result is a valid +condition+
+      def copied_merge_conditions(*conditions)
+        segments = []
+
+        conditions.each do |condition|
+          unless condition.blank?
+            sql = sanitize_sql(condition)
+            segments << sql unless sql.blank?
+          end
+        end
+
+        "(#{segments.join(') AND (')})" unless segments.empty?
+      end
+
+      def attribute_inheritance_hash
+        return {} unless @reflection.options[:inherit]
+        Array(@reflection.options[:inherit]).inject({}) { |hash, obj| hash[obj] = @owner.send(obj) ; hash }
+      end
+    end
+
+    AssociationCollection.class_eval do
+      # this is *maybe* not the correct place to patch in, but it covers all the cases
+      # without having to patch build, create, create!, etc
+      def add_record_to_target_with_callbacks_with_value_inheritance(record, &block)
+        attribute_inheritance_hash.each do |k, v|
+          record[k] = v
+        end
+        add_record_to_target_with_callbacks_without_value_inheritance(record, &block)
+      end
+
+      alias_method_chain :add_record_to_target_with_callbacks, :value_inheritance
+    end
+
+    HasOneAssociation.class_eval do
+      def create_with_value_inheritance(attrs = {}, replace_existing = true)
+        attrs ||= {}
+        create_without_value_inheritance(attribute_inheritance_hash.merge(attrs), replace_existing)
+      end
+
+      def create_with_value_inheritance!(attrs = {}, replace_existing = true)
+        attrs ||= {}
+        create_without_value_inheritance!(attribute_inheritance_hash.merge(attrs), replace_existing)
+      end
+
+      def build_with_value_inheritance(attrs = {}, replace_existing = true)
+        attrs ||= {}
+        build_without_value_inheritance(attribute_inheritance_hash.merge(attrs), replace_existing)
+      end
+      [:create, :create!, :build].each { |sym| alias_method_chain sym, :value_inheritance }
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler.setup
+Bundler.require
+
+require 'active_support/test_case'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => ":memory:"
+)
+require File.expand_path("../schema", __FILE__)
+
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require 'active_record_inherit_assoc'

data/test/schema.rb

@@ -0,0 +1,28 @@
+ActiveRecord::Schema.define(:version => 1) do
+  drop_table(:mains) rescue nil
+  create_table "mains" do |t|
+    t.integer :account_id
+    t.integer :blah_id
+    t.string   "val"
+  end
+
+  drop_table(:others) rescue nil
+  create_table "others" do |t|
+    t.integer :main_id
+    t.integer :account_id
+    t.string  :val
+  end
+
+  drop_table(:thirds) rescue nil
+  create_table "thirds" do |t|
+    t.integer :main_id
+    t.integer :account_id
+  end
+
+  drop_table(:fourths) rescue nil
+  create_table "fourths" do |t|
+    t.integer :main_id
+    t.integer :account_id
+    t.integer :blah_id
+  end
+end

data/test/test_belongs_to_association.rb

@@ -0,0 +1,48 @@
+require File.expand_path '../helper', __FILE__
+
+class TestBelongsToAssociation < ActiveSupport::TestCase
+  class Main < ActiveRecord::Base
+  end
+
+  class Other < ActiveRecord::Base
+    belongs_to :main
+    inherits_from :main, :attr => [:account_id, :val]
+  end
+
+  def test_value_is_inherited_from_parent
+    @main = Main.create!(:account_id => 42)
+    @other = Other.create!(:main => @main)
+
+    assert_equal 42, @other.account_id
+  end
+
+  def test_multiple_values_are_inherited_from_parent
+    @main = Main.create!(:account_id => 42, :val => "The Answer")
+    @other = Other.create!(:main => @main)
+
+    assert_equal 42, @other.account_id
+    assert_equal "The Answer", @other.val
+  end
+
+  def test_does_not_inherit_when_parent_not_present
+    @other = Other.create!
+    assert_nil @other.account_id
+  end
+
+  def test_overwrites_value_on_child
+    @main = Main.create!(:account_id => 42)
+    @other = Other.create!(:main => @main, :account_id => 1337)
+
+    assert_equal 42, @other.account_id
+  end
+
+  def test_allows_setting_the_value_after_instantiation
+    @main = Main.create!
+    @other = Other.new(:main => @main, :account_id => 1337)
+
+    @main.account_id = 42
+    @other.save
+
+    assert_equal 42, @other.account_id
+  end
+end

data/test/test_inherit_assoc.rb

@@ -0,0 +1,99 @@
+require File.expand_path '../helper', __FILE__
+
+class TestInheritAssoc < ActiveSupport::TestCase
+  class Main < ActiveRecord::Base
+    has_many :others, :inherit => :account_id
+    has_one :third, :inherit => :account_id
+    has_many :fourths, :inherit => [:account_id, :blah_id]
+    has_many :conditional_others, :inherit => :account_id, :conditions => {:val => "foo"}, :class_name => "Other"
+  end
+
+  class Other < ActiveRecord::Base
+    belongs_to :main
+  end
+
+  class Third < ActiveRecord::Base
+    belongs_to :main
+  end
+
+  class Fourth < ActiveRecord::Base
+    belongs_to :main
+  end
+
+  context "Main, with some others, scoped by account_id" do
+    setup do
+      @main = Main.create! :account_id => 1
+      Other.create! :main_id => @main.id, :account_id => 1
+      Other.create! :main_id => @main.id, :account_id => 2
+      Other.create! :main_id => @main.id, :account_id => 1, :val => "foo"
+    end
+
+    should "set conditions on simple access" do
+      assert_equal 2, @main.others.size
+    end
+
+    should "set conditions on find" do
+      assert_equal 2, @main.others.find(:all).size
+    end
+
+    should "merge conditions on find" do
+      assert_equal 1, @main.others.all(:conditions => "val = 'foo'").size
+    end
+
+    should "merge conditions" do
+      assert_equal 1, @main.conditional_others.size
+    end
+  end
+
+  def test_has_one_should_set_conditions_on_fetch
+    main = Main.create! :account_id => 1
+    third_1 = Third.create! :main_id => main.id, :account_id => 2
+    third_2 = Third.create! :main_id => main.id, :account_id => 1
+    assert_equal third_2, main.third
+  end
+
+  def test_has_many_should_set_conditions_for_multiple_inherits
+    main = Main.create! :account_id => 1, :blah_id => 10
+    # these two should match
+    Fourth.create! :main_id => main.id, :account_id => 1, :blah_id => 10
+    Fourth.create! :main_id => main.id, :account_id => 1, :blah_id => 10
+
+    # nope.
+    Fourth.create! :main_id => main.id, :account_id => 1, :blah_id => 5
+    Fourth.create! :main_id => main.id, :account_id => 1, :blah_id => 12
+    Fourth.create! :main_id => 99999, :account_id => 1, :blah_id => 12
+
+    assert_equal(2, main.fourths.size)
+  end
+
+  def test_has_many_should_setup_attributes_when_building
+    main = Main.create! :account_id => 1, :blah_id => 10
+
+    other = main.others.build
+    assert_equal main.id, other.main_id
+    assert_equal main.account_id, other.account_id
+  end
+
+  def test_has_many_should_setup_attributes_when_creating
+    main = Main.create! :account_id => 1, :blah_id => 10
+
+    other = main.others.create!
+    assert_equal main.id, other.main_id
+    assert_equal main.account_id, other.account_id
+
+    other = main.others.create
+    assert_equal main.id, other.main_id
+    assert_equal main.account_id, other.account_id
+  end
+
+  def test_has_one_should_setup_attributes_when_building
+    main = Main.create! :account_id => 1, :blah_id => 10
+
+    other = main.build_third
+    assert_equal main.account_id, other.account_id
+
+    other = main.create_third
+    assert_equal main.account_id, other.account_id
+  end
+
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: active_record_inherit_assoc
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+  prerelease: 
+platform: ruby
+authors:
+- Ben Osheroff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- ben@gimbo.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Appraisals
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- active_record_inherit_assoc.gemspec
+- gemfiles/rails2.3.gemfile
+- gemfiles/rails2.3.gemfile.lock
+- gemfiles/rails3.0.gemfile
+- gemfiles/rails3.0.gemfile.lock
+- lib/active_record_inherit_assoc.rb
+- test/helper.rb
+- test/schema.rb
+- test/test_belongs_to_association.rb
+- test/test_inherit_assoc.rb
+homepage: http://github.com/zendesk/active_record_inherit_assoc
+licenses:
+- MIT
+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: -1206521462731846587
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1206521462731846587
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Attribute inheritance for AR associations
+test_files: []