polyamorous 0.5.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,31 @@
+source "http://rubygems.org"
+gemspec
+
+gem 'rake'
+
+rails = ENV['RAILS'] || 'master'
+arel = ENV['AREL'] || 'master'
+
+arel_opts = case arel
+when /\// # A path
+  {:path => arel}
+when /^v/ # A tagged version
+  {:git => 'git://github.com/rails/arel.git', :tag => arel}
+else
+  {:git => 'git://github.com/rails/arel.git', :branch => arel}
+end
+
+gem 'arel', arel_opts
+
+case rails
+when /\// # A path
+  gem 'activerecord', :path => "#{rails}/activerecord"
+when /^v/ # A tagged version
+  git 'git://github.com/rails/rails.git', :tag => rails do
+    gem 'activerecord'
+  end
+else
+  git 'git://github.com/rails/rails.git', :branch => rails do
+    gem 'activerecord'
+  end
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ernie Miller
+
+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,5 @@
+# Polyamorous
+
+This is just a long-overdue extraction from MetaSearch 1.1.x, Ransack, and Squeel.
+
+Move along. Nothing to see here.

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |rspec|
+  rspec.rspec_opts = ['--backtrace']
+end
+
+task :default => :spec
+
+desc "Open an irb session with Ransack and the sample data used in specs"
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'console'
+  ARGV.clear
+  IRB.start
+end

data/lib/polyamorous.rb

@@ -0,0 +1,19 @@
+require "polyamorous/version"
+
+module Polyamorous
+  if defined?(::ActiveRecord::Associations::JoinDependency)
+    JoinDependency  = ::ActiveRecord::Associations::JoinDependency
+    JoinAssociation = ::ActiveRecord::Associations::JoinDependency::JoinAssociation
+  else
+    JoinDependency  = ::ActiveRecord::Associations::ClassMethods::JoinDependency
+    JoinAssociation = ::ActiveRecord::Associations::ClassMethods::JoinDependency::JoinAssociation
+  end
+end
+
+require 'active_record'
+require 'polyamorous/join'
+require 'polyamorous/join_association'
+require 'polyamorous/join_dependency'
+
+Polyamorous::JoinDependency.send(:include, Polyamorous::JoinDependencyExtensions)
+Polyamorous::JoinAssociation.send(:include, Polyamorous::JoinAssociationExtensions)

data/lib/polyamorous/join.rb

@@ -0,0 +1,64 @@
+module Polyamorous
+  class Join
+    attr_accessor :name
+    attr_reader :type, :klass
+
+    def initialize(name, type = Arel::InnerJoin, klass = nil)
+      @name = name
+      @type = convert_to_arel_join_type(type)
+      @klass = convert_to_class(klass) if klass
+    end
+
+    def klass=(klass)
+      @klass = convert_to_class(klass) if klass
+    end
+
+    def type=(type)
+      @type = convert_to_arel_join_type(type) if type
+    end
+
+    def hash
+      [@name, @type, @klass].hash
+    end
+
+    def eql?(other)
+      self.class == other.class &&
+      self.name  == other.name &&
+      self.type  == other.type &&
+      self.klass == other.klass
+    end
+
+    alias :== :eql?
+
+    private
+
+    def convert_to_arel_join_type(type)
+      case type
+      when 'inner', :inner
+        Arel::InnerJoin
+      when 'outer', :outer
+        Arel::OuterJoin
+      when Class
+        if [Arel::InnerJoin, Arel::OuterJoin].include? type
+          type
+        else
+          raise ArgumentError, "#{type} cannot be converted to an ARel join type"
+        end
+      else
+        raise ArgumentError, "#{type} cannot be converted to an ARel join type"
+      end
+    end
+
+    def convert_to_class(value)
+      case value
+      when String, Symbol
+        Kernel.const_get(value)
+      when Class
+        value
+      else
+        raise ArgumentError, "#{value} cannot be converted to a Class"
+      end
+    end
+
+  end
+end

data/lib/polyamorous/join_association.rb

@@ -0,0 +1,72 @@
+module Polyamorous
+  module JoinAssociationExtensions
+
+    def self.included(base)
+      base.class_eval do
+        alias_method_chain :initialize, :polymorphism
+        alias_method :equality_without_polymorphism, :==
+        alias_method :==, :equality_with_polymorphism
+
+        if ActiveRecord::VERSION::STRING =~ /^3\.0\./
+          alias_method_chain :association_join, :polymorphism
+        else
+          alias_method_chain :build_constraint, :polymorphism
+        end
+      end
+    end
+
+    def initialize_with_polymorphism(reflection, join_dependency, parent = nil, polymorphic_class = nil)
+      if polymorphic_class && ::ActiveRecord::Base > polymorphic_class
+        swapping_reflection_klass(reflection, polymorphic_class) do |reflection|
+          initialize_without_polymorphism(reflection, join_dependency, parent)
+        end
+      else
+        initialize_without_polymorphism(reflection, join_dependency, parent)
+      end
+    end
+
+    def swapping_reflection_klass(reflection, klass)
+      reflection = reflection.clone
+      original_polymorphic = reflection.options.delete(:polymorphic)
+      reflection.instance_variable_set(:@klass, klass)
+      yield reflection
+    ensure
+      reflection.options[:polymorphic] = original_polymorphic
+    end
+
+    def equality_with_polymorphism(other)
+      equality_without_polymorphism(other) && active_record == other.active_record
+    end
+
+    def build_constraint_with_polymorphism(reflection, table, key, foreign_table, foreign_key)
+      if reflection.options[:polymorphic]
+        build_constraint_without_polymorphism(reflection, table, key, foreign_table, foreign_key).and(
+          foreign_table[reflection.foreign_type].eq(reflection.klass.name)
+        )
+      else
+        build_constraint_without_polymorphism(reflection, table, key, foreign_table, foreign_key)
+      end
+    end
+
+    def association_join_with_polymorphism
+      return @join if @Join
+
+      @join = association_join_without_polymorphism
+
+      if reflection.macro == :belongs_to && reflection.options[:polymorphic]
+        aliased_table = Arel::Table.new(table_name, :as      => @aliased_table_name,
+                                                    :engine  => arel_engine,
+                                                    :columns => klass.columns)
+
+        parent_table = Arel::Table.new(parent.table_name, :as      => parent.aliased_table_name,
+                                                          :engine  => arel_engine,
+                                                          :columns => parent.active_record.columns)
+
+        @join << parent_table[reflection.options[:foreign_type]].eq(reflection.klass.name)
+      end
+
+      @join
+    end
+
+  end
+end

data/lib/polyamorous/join_dependency.rb

@@ -0,0 +1,75 @@
+module Polyamorous
+  module JoinDependencyExtensions
+
+    def self.included(base)
+      base.class_eval do
+        alias_method_chain :build, :polymorphism
+        alias_method_chain :graft, :polymorphism
+      end
+    end
+
+    def graft_with_polymorphism(*associations)
+      associations.each do |association|
+        unless join_associations.detect {|a| association == a}
+          if association.reflection.options[:polymorphic]
+            build(Join.new(association.reflection.name, association.join_type, association.reflection.klass),
+                  association.find_parent_in(self) || join_base, association.join_type)
+          else
+            build(association.reflection.name, association.find_parent_in(self) || join_base, association.join_type)
+          end
+        end
+      end
+      self
+    end
+
+    if ActiveRecord::VERSION::STRING =~ /^3\.0\./
+      def _join_parts
+        @joins
+      end
+    else
+      def _join_parts
+        @join_parts
+      end
+    end
+
+    def build_with_polymorphism(associations, parent = nil, join_type = Arel::InnerJoin)
+      case associations
+      when Join
+        parent ||= _join_parts.last
+        reflection = parent.reflections[associations.name] or
+          raise ::ActiveRecord::ConfigurationError, "Association named '#{ associations.name }' was not found; perhaps you misspelled it?"
+
+        unless join_association = find_join_association_respecting_polymorphism(reflection, parent, associations.klass)
+          @reflections << reflection
+          join_association = build_join_association_respecting_polymorphism(reflection, parent, associations.klass)
+          join_association.join_type = associations.type
+          _join_parts << join_association
+          cache_joined_association(join_association)
+        end
+
+        join_association
+      else
+        build_without_polymorphism(associations, parent, join_type)
+      end
+    end
+
+    def find_join_association_respecting_polymorphism(reflection, parent, klass)
+      if association = find_join_association(reflection, parent)
+        unless reflection.options[:polymorphic]
+          association
+        else
+          association if association.active_record == klass
+        end
+      end
+    end
+
+    def build_join_association_respecting_polymorphism(reflection, parent, klass)
+      if reflection.options[:polymorphic] && klass
+        JoinAssociation.new(reflection, self, parent, klass)
+      else
+        JoinAssociation.new(reflection, self, parent)
+      end
+    end
+
+  end
+end

data/lib/polyamorous/version.rb

@@ -0,0 +1,3 @@
+module Polyamorous
+  VERSION = "0.5.0"
+end

data/polyamorous.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "polyamorous/version"
+
+Gem::Specification.new do |s|
+  s.name        = "polyamorous"
+  s.version     = Polyamorous::VERSION
+  s.authors     = ["Ernie Miller"]
+  s.email       = ["ernie@metautonomo.us"]
+  s.homepage    = "http://github.com/ernie/polyamorous"
+  s.summary     = %q{
+    Loves/is loved by polymorphic belongs_to associations, Ransack, Squeel, MetaSearch...
+  }
+  s.description = %q{
+    This is just an extraction from Ransack/Squeel. You probably don't want to use this
+    directly. It extends ActiveRecord's associations to support polymorphic belongs_to
+    associations.
+  }
+
+  s.rubyforge_project = "polyamorous"
+
+  s.add_dependency 'activerecord', '~> 3.0'
+  s.add_development_dependency 'rspec', '~> 2.6.0'
+  s.add_development_dependency 'machinist', '~> 1.0.6'
+  s.add_development_dependency 'faker', '~> 0.9.5'
+  s.add_development_dependency 'sqlite3', '~> 1.3.3'
+
+  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"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/spec/blueprints/articles.rb

@@ -0,0 +1,5 @@
+Article.blueprint do
+  person
+  title
+  body
+end

data/spec/blueprints/comments.rb

@@ -0,0 +1,5 @@
+Comment.blueprint do
+  article
+  person
+  body
+end

data/spec/blueprints/notes.rb

@@ -0,0 +1,3 @@
+Note.blueprint do
+  note
+end

data/spec/blueprints/people.rb

@@ -0,0 +1,4 @@
+Person.blueprint do
+  name
+  salary
+end

data/spec/blueprints/tags.rb

@@ -0,0 +1,3 @@
+Tag.blueprint do
+  name    { Sham.tag_name }
+end

data/spec/helpers/polyamorous_helper.rb

@@ -0,0 +1,11 @@
+module PolyamorousHelper
+
+  def new_join_dependency(klass, associations = {})
+    Polyamorous::JoinDependency.new klass, associations, []
+  end
+
+  def new_join(name, type = Arel::InnerJoin, klass = nil)
+    Polyamorous::Join.new name, type, klass
+  end
+
+end

data/spec/polyamorous/join_association_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+module Polyamorous
+  describe JoinAssociation do
+  end
+end

data/spec/polyamorous/join_dependency_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+module Polyamorous
+  describe JoinDependency do
+
+    context 'with symbol joins' do
+      subject { new_join_dependency Person, :articles => :comments }
+
+      specify { subject.join_associations.should have(2).associations }
+      specify { subject.join_associations.should be_all { |a| a.join_type == Arel::InnerJoin } }
+    end
+
+    context 'with has_many :through association' do
+      subject { new_join_dependency Person, :authored_article_comments }
+
+      specify { subject.join_associations.should have(1).association }
+      specify { subject.join_associations.first.table_name.should eq 'comments' }
+    end
+
+    context 'with outer join' do
+      subject { new_join_dependency Person, new_join(:articles, :outer) }
+
+      specify { subject.join_associations.should have(1).association }
+      specify { subject.join_associations.should be_all { |a| a.join_type == Arel::OuterJoin } }
+    end
+
+    context 'with nested outer joins' do
+      subject { new_join_dependency Person, new_join(:articles, :outer) => new_join(:comments, :outer) }
+
+      specify { subject.join_associations.should have(2).associations }
+      specify { subject.join_associations.should be_all { |a| a.join_type == Arel::OuterJoin } }
+    end
+
+    context 'with polymorphic belongs_to join' do
+      subject { new_join_dependency Note, new_join(:notable, :inner, Person) }
+
+      specify { subject.join_associations.should have(1).association }
+      specify { subject.join_associations.should be_all { |a| a.join_type == Arel::InnerJoin } }
+      specify { subject.join_associations.first.table_name.should eq 'people' }
+    end
+
+    context 'with polymorphic belongs_to join and nested symbol join' do
+      subject { new_join_dependency Note, new_join(:notable, :inner, Person) => :comments }
+
+      specify { subject.join_associations.should have(2).association }
+      specify { subject.join_associations.should be_all { |a| a.join_type == Arel::InnerJoin } }
+      specify { subject.join_associations.first.table_name.should eq 'people' }
+      specify { subject.join_associations[1].table_name.should eq 'comments' }
+    end
+
+  end
+end

data/spec/polyamorous/join_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+module Polyamorous
+  describe Join do
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require 'machinist/active_record'
+require 'sham'
+require 'faker'
+require 'polyamorous'
+
+Time.zone = 'Eastern Time (US & Canada)'
+
+Dir[File.expand_path('../{helpers,support,blueprints}/*.rb', __FILE__)].each do |f|
+  require f
+end
+
+Sham.define do
+  name     { Faker::Name.name }
+  title    { Faker::Lorem.sentence }
+  body     { Faker::Lorem.paragraph }
+  salary   {|index| 30000 + (index * 1000)}
+  tag_name { Faker::Lorem.words(3).join(' ') }
+  note     { Faker::Lorem.words(7).join(' ') }
+end
+
+RSpec.configure do |config|
+  config.before(:suite) { Schema.create }
+  config.before(:all)   { Sham.reset(:before_all) }
+  config.before(:each)  { Sham.reset(:before_each) }
+
+  config.include PolyamorousHelper
+end
+
+RSpec::Matchers.define :be_like do |expected|
+  match do |actual|
+    actual.gsub(/^\s+|\s+$/, '').gsub(/\s+/, ' ').strip ==
+      expected.gsub(/^\s+|\s+$/, '').gsub(/\s+/, ' ').strip
+  end
+end

data/spec/support/schema.rb

@@ -0,0 +1,103 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => 'sqlite3',
+  :database => ':memory:'
+)
+
+class Person < ActiveRecord::Base
+  belongs_to :parent, :class_name => 'Person', :foreign_key => :parent_id
+  has_many   :children, :class_name => 'Person', :foreign_key => :parent_id
+  has_many   :articles
+  has_many   :comments
+  has_many   :authored_article_comments, :through => :articles,
+             :foreign_key => :person_id, :source => :comments
+  has_many   :notes, :as => :notable
+end
+
+class Article < ActiveRecord::Base
+  belongs_to              :person
+  has_many                :comments
+  has_and_belongs_to_many :tags
+  has_many   :notes, :as => :notable
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :article
+  belongs_to :person
+end
+
+class Tag < ActiveRecord::Base
+  has_and_belongs_to_many :articles
+end
+
+class Note < ActiveRecord::Base
+  belongs_to :notable, :polymorphic => true
+end
+
+module Schema
+  def self.create
+    ActiveRecord::Base.silence do
+      ActiveRecord::Migration.verbose = false
+
+      ActiveRecord::Schema.define do
+        create_table :people, :force => true do |t|
+          t.integer  :parent_id
+          t.string   :name
+          t.integer  :salary
+          t.boolean  :awesome, :default => false
+          t.timestamps
+        end
+
+        create_table :articles, :force => true do |t|
+          t.integer :person_id
+          t.string  :title
+          t.text    :body
+        end
+
+        create_table :comments, :force => true do |t|
+          t.integer :article_id
+          t.integer :person_id
+          t.text    :body
+        end
+
+        create_table :tags, :force => true do |t|
+          t.string :name
+        end
+
+        create_table :articles_tags, :force => true, :id => false do |t|
+          t.integer :article_id
+          t.integer :tag_id
+        end
+
+        create_table :notes, :force => true do |t|
+          t.integer :notable_id
+          t.string  :notable_type
+          t.string  :note
+        end
+
+      end
+    end
+
+    10.times do
+      person = Person.make
+      Note.make(:notable => person)
+      3.times do
+        article = Article.make(:person => person)
+        3.times do
+          article.tags = [Tag.make, Tag.make, Tag.make]
+        end
+        Note.make(:notable => article)
+        10.times do
+          Comment.make(:article => article)
+        end
+      end
+      2.times do
+        Comment.make(:person => person)
+      end
+    end
+
+    Comment.make(:body => 'First post!', :article => Article.make(:title => 'Hello, world!'))
+
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: polyamorous
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- Ernie Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-03 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70198431647040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70198431647040
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70198431646120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *70198431646120
+- !ruby/object:Gem::Dependency
+  name: machinist
+  requirement: &70198431645200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.6
+  type: :development
+  prerelease: false
+  version_requirements: *70198431645200
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: &70198431644480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :development
+  prerelease: false
+  version_requirements: *70198431644480
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70198431643680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :development
+  prerelease: false
+  version_requirements: *70198431643680
+description: ! "\n    This is just an extraction from Ransack/Squeel. You probably
+  don't want to use this\n    directly. It extends ActiveRecord's associations to
+  support polymorphic belongs_to\n    associations.\n  "
+email:
+- ernie@metautonomo.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/polyamorous.rb
+- lib/polyamorous/join.rb
+- lib/polyamorous/join_association.rb
+- lib/polyamorous/join_dependency.rb
+- lib/polyamorous/version.rb
+- polyamorous.gemspec
+- spec/blueprints/articles.rb
+- spec/blueprints/comments.rb
+- spec/blueprints/notes.rb
+- spec/blueprints/people.rb
+- spec/blueprints/tags.rb
+- spec/helpers/polyamorous_helper.rb
+- spec/polyamorous/join_association_spec.rb
+- spec/polyamorous/join_dependency_spec.rb
+- spec/polyamorous/join_spec.rb
+- spec/spec_helper.rb
+- spec/support/schema.rb
+homepage: http://github.com/ernie/polyamorous
+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: '0'
+requirements: []
+rubyforge_project: polyamorous
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Loves/is loved by polymorphic belongs_to associations, Ransack, Squeel, MetaSearch...
+test_files:
+- spec/blueprints/articles.rb
+- spec/blueprints/comments.rb
+- spec/blueprints/notes.rb
+- spec/blueprints/people.rb
+- spec/blueprints/tags.rb
+- spec/helpers/polyamorous_helper.rb
+- spec/polyamorous/join_association_spec.rb
+- spec/polyamorous/join_dependency_spec.rb
+- spec/polyamorous/join_spec.rb
+- spec/spec_helper.rb
+- spec/support/schema.rb