joiner 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b7b02b7622a82eeefbf7a3abca876d752e809d0
-  data.tar.gz: 9b6809d20db5b15abb97f40a06349a8186d3f863
+  metadata.gz: fa6e6cc16da43c455ac08933d6c0a0b4e27914c9
+  data.tar.gz: a77958f970489d51253f581afdea3317b8c764bc
 SHA512:
-  metadata.gz: 33aac1b4d121b51ed4a23f314478135f0514e583c880c06c4b8931ef1e0fb07211ee142813e13e6d230a94096dfa486c31f60fe48bcd22df6583c8d96d29177c
-  data.tar.gz: 8ca6904f2f5e37fbf49eeee879af83e261a650fae726a1263a46a3013105de0a1da8ccfe2665cac1cfe22ab9d227cc520319f8d965ad98ae416e0b8ce8f670a8
+  metadata.gz: 12d1d52dd1fcc4f91bb5f4cc0472bea0729fbbcdf3ab563bc9a7b7c1ce16db10ab77fc327ab80437e923a67ba91d7ee269022bcb46af68de6f74b558d21d54b0
+  data.tar.gz: 2a3d2d038dd4c725dbeadc456e1c1cd83a082abc6467ae5cfc52c71f38a8bcb292c7b7fa231d202108a53a45ce9a50da832c616b3bf0a2d4b8b754d461bff198

data/README.md

@@ -9,7 +9,7 @@ If this gem is used by anyone other than myself/Thinking Sphinx, I'll be surpris
 It's a gem - so you can either install it yourself, or add it to the appropriate Gemfile or gemspec.
 
 ```term
-gem install joiner --version 0.2.0
+gem install joiner --version 0.3.0
 ```
 
 ## Usage

data/joiner.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   spec.name          = 'joiner'
-  spec.version       = '0.2.0'
+  spec.version       = '0.3.0'
   spec.authors       = ['Pat Allan']
   spec.email         = ['pat@freelancing-gods.com']
   spec.summary       = %q{Builds ActiveRecord joins from association paths}
@@ -13,9 +13,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(spec)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'activerecord', ['>= 3.1.0', '< 4.1.0']
+  spec.add_runtime_dependency 'activerecord', '>= 4.1.0'
 
   spec.add_development_dependency 'combustion',  '~> 0.5.1'
+  spec.add_development_dependency 'rails',       '>= 4.1.0'
   spec.add_development_dependency 'rspec-rails', '~> 2.14.1'
   spec.add_development_dependency 'sqlite3',     '~> 1.3.8'
 end

data/lib/joiner/joins.rb

@@ -4,78 +4,94 @@ class Joiner::Joins
   attr_reader :model
 
   def initialize(model)
-    @model = model
-    @joins = ActiveSupport::OrderedHash.new
+    @model       = model
+    @base        = JoinDependency.new model, [], []
+    @joins_cache = ActiveSupport::OrderedHash.new
   end
 
   def add_join_to(path)
-    join_for(path)
+    @joins_cache[path] ||= build_join(path)
   end
 
   def alias_for(path)
-    return model.quoted_table_name if path.empty?
-
-    join_for(path).aliased_table_name
+    return model.table_name if path.empty?
+    add_join_to(path).aliased_table_name
   end
 
   def join_values
-    @joins.values.compact
+    @base
   end
 
   private
 
-  def base
-    @base ||= JoinDependency.new model, [], []
+  def build_join(path)
+    if join = find_join(path)
+      return join
+    end
+
+    base_node, short_path = relative_path(path)
+
+    join = build_join_association(short_path, base_node.base_klass)
+    base_node.children << join
+    construct_tables! base_node, join
+
+    find_join(path)
   end
 
-  def join_for(path)
-    @joins[path] ||= begin
-      reflection = reflection_for path
-      reflection.nil? ? nil : JoinDependency::JoinAssociation.new(
-        reflection, base, parent_join_for(path)
-      ).tap { |join|
-        join.join_type = Arel::OuterJoin
+  def build_join_association(path, base_class)
+    return nil if path.empty?
 
-        rewrite_conditions_for join
-      }
-    end
+    step = path.first
+    reflection = find_reflection(step, base_class)
+    reflection.check_validity!
+
+    JoinDependency::JoinAssociation.new reflection, [build_join_association(path[1..-1], reflection.klass)].compact
   end
 
-  def joins_for(path)
-    if path.length == 1
-      [join_for(path)]
-    else
-      [joins_for(path[0..-2]), join_for(path)].flatten
+  def find_join(path, base = nil)
+    base ||= @base.join_root
+
+    return base if path.empty?
+
+    if next_step = base.children.detect{ |c| c.reflection.name == path.first }
+      find_join path[1..-1], next_step
     end
   end
 
-  def parent_for(path)
-    path.length == 1 ? base : join_for(path[0..-2])
-  end
+  def relative_path(path)
+    short_path = []
+    test_path = path.dup
+
+    while test_path.size > 1
+      short_path << test_path.pop
+      node = find_join(test_path)
+      return [node, short_path] if node
+    end
 
-  def parent_join_for(path)
-    path.length == 1 ? base.join_base : parent_for(path)
+    [@base.join_root, path]
   end
 
-  def reflection_for(path)
-    parent = parent_for(path)
-    klass  = parent.respond_to?(:base_klass) ? parent.base_klass :
-      parent.active_record
-    klass.reflections[path.last]
+  def find_reflection(name, klass)
+    klass.reflect_on_association(name)
   end
 
-  def rewrite_conditions_for(join)
-    if join.respond_to?(:scope_chain)
-      conditions = Array(join.scope_chain).flatten
-    else
-      conditions = Array(join.conditions).flatten
-    end
+  def table_aliases_for(parent, node)
+    node.reflection.chain.map { |reflection|
+      @base.alias_tracker.aliased_table_for(
+        reflection.table_name,
+        table_alias_for(reflection, parent, reflection != node.reflection)
+      )
+    }
+  end
 
-    conditions.each do |condition|
-      next unless condition.is_a?(String)
+  def construct_tables!(parent, node)
+    node.tables = table_aliases_for(parent, node)
+    node.children.each { |child| construct_tables! node, child }
+  end
 
-      condition.gsub! /::ts_join_alias::/,
-        model.connection.quote_table_name(join.parent.aliased_table_name)
-    end
+  def table_alias_for(reflection, parent, join)
+    name = "#{reflection.plural_name}_#{parent.table_name}"
+    name << "_join" if join
+    name
   end
 end

data/spec/internal/app/models/comment.rb

@@ -1,4 +1,4 @@
 class Comment < ActiveRecord::Base
   belongs_to :article
-  belongs_to :comments
+  belongs_to :user
 end

data/spec/joiner/joins_spec.rb

@@ -3,177 +3,81 @@ require 'spec_helper'
 describe Joiner::Joins do
   JoinDependency = ::ActiveRecord::Associations::JoinDependency
 
-  let(:joins)     { Joiner::Joins.new model }
-  let(:model)     { model_double 'articles' }
-  let(:base)      {
-    double('base', :active_record => model, :join_base => join_base)
-  }
-  let(:join_base) { double('join base') }
-  let(:join)      { join_double 'users' }
-  let(:sub_join)  { join_double 'posts' }
-
-  def join_double(table_alias)
-    double 'join',
-      :join_type=         => nil,
-      :aliased_table_name => table_alias,
-      :reflection         => double('reflection'),
-      :conditions         => []
-  end
-
-  def model_double(table_name = nil)
-    double 'model', :quoted_table_name => table_name, :reflections => {}
-  end
-
-  before :each do
-    JoinDependency.stub :new => base
-    JoinDependency::JoinAssociation.stub(:new).and_return(join, sub_join)
-    model.reflections[:user] = join.reflection
-
-    join.stub :active_record => model_double
-    join.active_record.reflections[:posts] = sub_join.reflection
-  end
+  subject { Joiner::Joins.new Article }
 
   describe '#add_join_to' do
-    before :each do
-      JoinDependency::JoinAssociation.unstub :new
-    end
-
     it "adds just one join for a stack with a single association" do
       JoinDependency::JoinAssociation.should_receive(:new).
-        with(join.reflection, base, join_base).once.and_return(join)
+        with(Article.reflections[:user], []).once.and_call_original
 
-      joins.add_join_to([:user])
+      subject.add_join_to([:user])
     end
 
     it "does not duplicate joins when given the same stack twice" do
-      JoinDependency::JoinAssociation.should_receive(:new).once.and_return(join)
+      JoinDependency::JoinAssociation.should_receive(:new).once.and_call_original
 
-      joins.add_join_to([:user])
-      joins.add_join_to([:user])
+      subject.add_join_to([:user])
+      subject.add_join_to([:user])
     end
 
-    context 'multiple joins' do
+    context 'when joins are nested' do
       it "adds two joins for a stack with two associations" do
         JoinDependency::JoinAssociation.should_receive(:new).
-          with(join.reflection, base, join_base).once.and_return(join)
+          with(Article.reflections[:user], kind_of(Array)).once.and_call_original
         JoinDependency::JoinAssociation.should_receive(:new).
-          with(sub_join.reflection, base, join).once.and_return(sub_join)
+          with(User.reflections[:comments], kind_of(Array)).once.and_call_original
 
-        joins.add_join_to([:user, :posts])
+        subject.add_join_to([:user, :comments])
       end
 
       it "extends upon existing joins when given stacks where parts are already mapped" do
-        JoinDependency::JoinAssociation.should_receive(:new).twice.
-          and_return(join, sub_join)
-
-        joins.add_join_to([:user])
-        joins.add_join_to([:user, :posts])
-      end
-    end
-
-    context 'join with conditions' do
-      let(:connection) { double }
-      let(:parent)     { double :aliased_table_name => 'qux' }
-
-      before :each do
-        JoinDependency::JoinAssociation.stub :new => join
-
-        join.stub :parent => parent
-        model.stub :connection => connection
-        connection.stub(:quote_table_name) { |table| "\"#{table}\"" }
-      end
-
-      it "leaves standard conditions untouched" do
-        join.stub :conditions => 'foo = bar'
-
-        joins.add_join_to [:user]
-
-        join.conditions.should == 'foo = bar'
-      end
-
-      it "modifies filtered polymorphic conditions" do
-        join.stub :conditions => '::ts_join_alias::.foo = bar'
-
-        joins.add_join_to [:user]
+        JoinDependency::JoinAssociation.should_receive(:new).twice.and_call_original
 
-        join.conditions.should == '"qux".foo = bar'
-      end
-
-      it "modifies filtered polymorphic conditions within arrays" do
-        join.stub :conditions => ['::ts_join_alias::.foo = bar']
-
-        joins.add_join_to [:user]
+        join1 = subject.add_join_to([:user])
+        join2 = subject.add_join_to([:user, :comments])
 
-        join.conditions.should == ['"qux".foo = bar']
-      end
-
-      it "does not modify conditions as hashes" do
-        join.stub :conditions => [{:foo => 'bar'}]
-
-        joins.add_join_to [:user]
-
-        join.conditions.should == [{:foo => 'bar'}]
+        join1.children.should include(join2)
       end
     end
   end
 
   describe '#alias_for' do
     it "returns the model's table name when no stack is given" do
-      joins.alias_for([]).should == 'articles'
+      subject.alias_for([]).should == 'articles'
     end
 
-    it "adds just one join for a stack with a single association" do
-      JoinDependency::JoinAssociation.unstub :new
-      JoinDependency::JoinAssociation.should_receive(:new).
-        with(join.reflection, base, join_base).once.and_return(join)
-
-      joins.alias_for([:user])
+    it "gets join association using #add_join_to" do
+      subject.should_receive(:add_join_to).with([:user]).and_call_original
+      subject.alias_for([:user])
     end
 
     it "returns the aliased table name for the join" do
-      joins.alias_for([:user]).should == 'users'
+      subject.alias_for([:user]).should == 'users'
     end
 
     it "does not duplicate joins when given the same stack twice" do
-      JoinDependency::JoinAssociation.unstub :new
-      JoinDependency::JoinAssociation.should_receive(:new).once.and_return(join)
+      JoinDependency::JoinAssociation.should_receive(:new).once.and_call_original
 
-      joins.alias_for([:user])
-      joins.alias_for([:user])
+      subject.alias_for([:user])
+      subject.alias_for([:user])
     end
 
-    context 'multiple joins' do
-      it "adds two joins for a stack with two associations" do
-        JoinDependency::JoinAssociation.unstub :new
-        JoinDependency::JoinAssociation.should_receive(:new).
-          with(join.reflection, base, join_base).once.and_return(join)
-        JoinDependency::JoinAssociation.should_receive(:new).
-          with(sub_join.reflection, base, join).once.and_return(sub_join)
-
-        joins.alias_for([:user, :posts])
-      end
-
+    context 'when joins are nested' do
       it "returns the sub join's aliased table name" do
-        joins.alias_for([:user, :posts]).should == 'posts'
-      end
-
-      it "extends upon existing joins when given stacks where parts are already mapped" do
-        JoinDependency::JoinAssociation.unstub :new
-        JoinDependency::JoinAssociation.should_receive(:new).twice.
-          and_return(join, sub_join)
-
-        joins.alias_for([:user])
-        joins.alias_for([:user, :posts])
+        subject.alias_for([:user, :comments]).should == 'comments'
       end
     end
   end
 
   describe '#join_values' do
-    it "returns all joins that have been created" do
-      joins.alias_for([:user])
-      joins.alias_for([:user, :posts])
-
-      joins.join_values.should == [join, sub_join]
+    it "returns JoinDependency with all joins that have been created" do
+      join1 = subject.add_join_to([:user])
+      join2 = subject.add_join_to([:comments])
+      join3 = subject.add_join_to([:comments, :user])
+
+      join_values = subject.join_values
+      join_values.should be_a JoinDependency
+      join_values.join_root.children.should == [join1, join2]
     end
   end
 end

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ require 'bundler/setup'
 
 require 'combustion'
 
-Combustion.initialize! :active_record
+Combustion.initialize! :all
 
 require 'rspec/rails'
 

metadata

@@ -1,75 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: joiner
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Pat Allan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-11 00:00:00.000000000 Z
+date: 2014-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 3.1.0
-    - - <
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 3.1.0
-    - - <
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.0
 - !ruby/object:Gem::Dependency
   name: combustion
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.8
 description: Builds ActiveRecord outer joins from association paths and provides references
@@ -80,7 +88,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -109,17 +117,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Builds ActiveRecord joins from association paths