joiner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 95831ffeed5e8c01635e9d2a9719daf72b7db24f
+  data.tar.gz: b76e140e99fa969a716e69f35396ff7a1f323cbb
+SHA512:
+  metadata.gz: 94ff8d0bf4e2acce3ce4d3fd4f0fd6ad46bd2ce91936564a6ab970ce9a7db518dac9cbc4d25c41a6eeb06e060595d0285033477b0a560a1372d0cbdb3e61e8ec
+  data.tar.gz: a1927657a5db57b18891242ee5def0c1c9d1f111fa3b75eeeda9b404ba6f6d9319d849714ecd6373e33912376c7de0d0b4edb480da158b9368b01bed2a79c5cb

data/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/internal/db/combustion_test.sqlite
+spec/reports
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pat Allan
+
+MIT License
+
+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,60 @@
+# Joiner
+
+This gem, abstracted out from [Thinking Sphinx](http://pat.github.io/thinking-sphinx), turns a bunch of association trees from the perspective of a single model and builds a bunch of OUTER JOINs that can be passed into ActiveRecord::Relation's `join` method. You can also find out the generated table aliases for each join, in case you're referring to columns from those joins at some other point.
+
+If this gem is used by anyone other than myself/Thinking Sphinx, I'll be surprised. My reason for pulling it out is so I can more cleanly support Rails' changing approaches to join generation (see v3.1-4.0 compared to v4.1).
+
+## Installation
+
+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.1.0
+```
+
+## Usage
+
+First, create a join collection, based on an ActiveRecord model:
+
+```ruby
+joiner = Joiner::Joins.new user
+```
+
+Then you can add joins for a given association path. For example, if User has many articles, and articles have many comments:
+
+```ruby
+joiner.add_join_to [:articles]
+joiner.add_join_to [:articles, :comments]
+```
+
+If you need the table/join alias for a given association path, just ask for it:
+
+```ruby
+joiner.alias_for([:articles, :comments])
+```
+
+And once you've loaded up all the joins, you'll want something you can push out into `ActiveRecord::Relation#joins`:
+
+```ruby
+User.joins(joiner.join_values)
+```
+
+You can also check if a given association path will return potentially more than one record (thus perhaps requiring aggregation), or find out what the model at the end of the path is:
+
+```ruby
+path = Joiner::Path.new(User, [:articles, :comments])
+path.aggregate? #=> true
+path.model      #=> Comment
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Licence
+
+Copyright (c) 2013, Joiner is developed and maintained by [Pat Allan](http://freelancing-gods.com), and is released under the open MIT Licence.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/joiner.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = 'joiner'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Pat Allan']
+  spec.email         = ['pat@freelancing-gods.com']
+  spec.summary       = %q{Builds ActiveRecord joins from association paths}
+  spec.description   = %q{Builds ActiveRecord outer joins from association paths and provides references to table aliases.}
+  spec.homepage      = 'https://github.com/pat/joiner'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency 'combustion',  '~> 0.5.1'
+  spec.add_development_dependency 'rspec-rails', '~> 2.14.1'
+  spec.add_development_dependency 'sqlite3',     '~> 1.3.8'
+end

data/lib/joiner.rb

@@ -0,0 +1,6 @@
+module Joiner
+  #
+end
+
+require 'joiner/joins'
+require 'joiner/path'

data/lib/joiner/joins.rb

@@ -0,0 +1,81 @@
+class Joiner::Joins
+  JoinDependency = ::ActiveRecord::Associations::JoinDependency
+
+  attr_reader :model
+
+  def initialize(model)
+    @model = model
+    @joins = ActiveSupport::OrderedHash.new
+  end
+
+  def add_join_to(path)
+    join_for(path)
+  end
+
+  def alias_for(path)
+    return model.quoted_table_name if path.empty?
+
+    join_for(path).aliased_table_name
+  end
+
+  def join_values
+    @joins.values.compact
+  end
+
+  private
+
+  def base
+    @base ||= JoinDependency.new model, [], []
+  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
+
+        rewrite_conditions_for join
+      }
+    end
+  end
+
+  def joins_for(path)
+    if path.length == 1
+      [join_for(path)]
+    else
+      [joins_for(path[0..-2]), join_for(path)].flatten
+    end
+  end
+
+  def parent_for(path)
+    path.length == 1 ? base : join_for(path[0..-2])
+  end
+
+  def parent_join_for(path)
+    path.length == 1 ? base.join_base : parent_for(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]
+  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
+
+    conditions.each do |condition|
+      next unless condition.is_a?(String)
+
+      condition.gsub! /::ts_join_alias::/,
+        model.connection.quote_table_name(join.parent.aliased_table_name)
+    end
+  end
+end

data/lib/joiner/path.rb

@@ -0,0 +1,33 @@
+class Joiner::Path
+  AGGREGATE_MACROS = [:has_many, :has_and_belongs_to_many]
+
+  def initialize(base, path)
+    @base, @path = base, path
+  end
+
+  def aggregate?
+    macros.any? { |macro| AGGREGATE_MACROS.include? macro }
+  end
+
+  def macros
+    reflections.collect(&:macro)
+  end
+
+  def model
+    path.empty? ? base : reflections.last.try(:klass)
+  end
+
+  private
+
+  attr_reader :base, :path
+
+  def reflections
+    klass = base
+    path.collect { |reference|
+      klass.reflect_on_association(reference).tap { |reflection|
+        return [] if reflection.nil?
+        klass = reflection.klass
+      }
+    }
+  end
+end

data/spec/acceptance/joiner_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe 'Joiner' do
+  it "handles has many associations" do
+    joiner = Joiner::Joins.new User
+    joiner.add_join_to [:articles]
+
+    sql = User.joins(joiner.join_values).to_sql
+    expect(sql).to match(/LEFT OUTER JOIN \"articles\"/)
+  end
+
+  it "handles multiple has many associations separately" do
+    joiner = Joiner::Joins.new User
+    joiner.add_join_to [:articles]
+    joiner.add_join_to [:articles, :comments]
+
+    sql = User.joins(joiner.join_values).to_sql
+    expect(sql).to match(/LEFT OUTER JOIN \"articles\"/)
+    expect(sql).to match(/LEFT OUTER JOIN \"comments\"/)
+  end
+
+  it "handles multiple has many associations together" do
+    joiner = Joiner::Joins.new User
+    joiner.add_join_to [:articles, :comments]
+
+    sql = User.joins(joiner.join_values).to_sql
+    expect(sql).to match(/LEFT OUTER JOIN \"articles\"/)
+    expect(sql).to match(/LEFT OUTER JOIN \"comments\"/)
+  end
+
+  it "handles a belongs to association" do
+    joiner = Joiner::Joins.new Comment
+    joiner.add_join_to [:article]
+
+    sql = Comment.joins(joiner.join_values).to_sql
+    expect(sql).to match(/LEFT OUTER JOIN \"articles\"/)
+  end
+
+  it "handles both belongs to and has many associations separately" do
+    joiner = Joiner::Joins.new Article
+    joiner.add_join_to [:user]
+    joiner.add_join_to [:comments]
+
+    sql = Article.joins(joiner.join_values).to_sql
+    expect(sql).to match(/LEFT OUTER JOIN \"users\"/)
+    expect(sql).to match(/LEFT OUTER JOIN \"comments\"/)
+  end
+
+  it "handles both belongs to and has many associations together" do
+    joiner = Joiner::Joins.new Article
+    joiner.add_join_to [:user, :comments]
+
+    sql = Article.joins(joiner.join_values).to_sql
+    expect(sql).to match(/LEFT OUTER JOIN \"users\"/)
+    expect(sql).to match(/LEFT OUTER JOIN \"comments\"/)
+  end
+
+  it "distinguishes joins via different relationships" do
+    joiner = Joiner::Joins.new Article
+    joiner.add_join_to [:comments]
+    joiner.add_join_to [:user, :comments]
+
+    expect(joiner.alias_for([:comments])).to eq('comments')
+    expect(joiner.alias_for([:user, :comments])).to eq('comments_users')
+  end
+end

data/spec/acceptance/paths_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe 'Paths' do
+  describe 'Aggregations' do
+    it "indicates aggregation for has many associations" do
+      path = Joiner::Path.new User, [:articles]
+
+      expect(path).to be_aggregate
+    end
+
+    it "indicates non-aggregation for belongs to association" do
+      path = Joiner::Path.new Article, [:user]
+
+      expect(path).to_not be_aggregate
+    end
+
+    it "indicates non-aggregation when the path is empty" do
+      path = Joiner::Path.new Article, []
+
+      expect(path).to_not be_aggregate
+    end
+  end
+
+  describe 'models' do
+    it "determines the underlying model for an association path" do
+      path = Joiner::Path.new User, [:articles, :comments]
+
+      expect(path.model).to eq(Comment)
+    end
+
+    it "returns the base model if the path is empty" do
+      path = Joiner::Path.new User, []
+
+      expect(path.model).to eq(User)
+    end
+
+    it "returns nil if the path is invalid" do
+      path = Joiner::Path.new User, [:articles, :likes]
+
+      expect(path.model).to be_nil
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+class Article < ActiveRecord::Base
+  has_many :comments
+  belongs_to :user
+end

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

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

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

@@ -0,0 +1,4 @@
+class User < ActiveRecord::Base
+  has_many :articles
+  has_many :comments
+end

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/db/schema.rb

@@ -0,0 +1,16 @@
+ActiveRecord::Schema.define do
+  create_table :articles, :force => true do |t|
+    t.integer :user_id
+    t.timestamps
+  end
+
+  create_table :comments, :force => true do |t|
+    t.integer :article_id
+    t.integer :user_id
+    t.timestamps
+  end
+
+  create_table :users, :force => true do |t|
+    t.timestamps
+  end
+end

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'combustion'
+
+Combustion.initialize! :active_record
+
+require 'rspec/rails'
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: joiner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pat Allan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-11 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: 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
+  to table aliases.
+email:
+- pat@freelancing-gods.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- joiner.gemspec
+- lib/joiner.rb
+- lib/joiner/joins.rb
+- lib/joiner/path.rb
+- spec/acceptance/joiner_spec.rb
+- spec/acceptance/paths_spec.rb
+- spec/internal/app/models/article.rb
+- spec/internal/app/models/comment.rb
+- spec/internal/app/models/user.rb
+- spec/internal/config/database.yml
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/spec_helper.rb
+homepage: https://github.com/pat/joiner
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Builds ActiveRecord joins from association paths
+test_files:
+- spec/acceptance/joiner_spec.rb
+- spec/acceptance/paths_spec.rb
+- spec/internal/app/models/article.rb
+- spec/internal/app/models/comment.rb
+- spec/internal/app/models/user.rb
+- spec/internal/config/database.yml
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/spec_helper.rb