joiner 0.3.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7249d05e24afee39fbb2547085068230f6b1d62b
-  data.tar.gz: 941f72f5d80c3a6c0b8b88684f7a35b77e7461ee
+SHA256:
+  metadata.gz: 50d83b6e1af0b5ef8c29fbbaabbb56a8c33ed99acbf57f507d13bcff673d92b2
+  data.tar.gz: 62adfb53520243ff108e85f68c61ca121cf28f1e6344fac539aa36c725efe0c1
 SHA512:
-  metadata.gz: 0fd9651d510164f7e5843589678ba62d3f214c67dca6309e4711f71cd8b4200b3e105cd780fdfab14d3a4240d4354fcd95b6568b101d710757da1d093e96600a
-  data.tar.gz: ff41eaace4916f013c03e7407a65709543251908daab4f3203f723282a9c38c50a35b9767a9b074bb6f7f336bb1042cf30542d8ee179cd08ca868a23228b66fe
+  metadata.gz: f96a6e7b1165be044ae4fba8dd71f9950f6635cbac352d7aa9d0aea9f7ead03d8bc0928f4fa69422539e4945976207394efc86704556c5fe44b8bcbda9ac2106
+  data.tar.gz: fa5f47d42b4d823581706dc5644b1b7b0ff4b47232f4216667c9526065e01fa13d1d1f46424e815f6df4bfc42b5659a56dc4831e5af1928ca3151d63bd0a7b5f

data/.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.5', '2.6', '2.7' ]
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+      - name: Set up ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Test
+        run: "bundle exec rspec"

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+dist: xenial
+sudo: false
+rvm:
+- 2.5.8
+- 2.6.6
+before_install:
+- gem update --system
+script: bundle exec rspec

data/README.md

@@ -2,14 +2,14 @@
 
 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).
+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-v4.0 compared to v4.1-v5.1 compared to v5.2).
 
 ## 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.3.4
+gem install joiner --version 0.6.0
 ```
 
 ## Usage
@@ -17,7 +17,7 @@ gem install joiner --version 0.3.4
 First, create a join collection, based on an ActiveRecord model:
 
 ```ruby
-joiner = Joiner::Joins.new user
+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:
@@ -49,6 +49,8 @@ path.model      #=> Comment
 
 ## Contributing
 
+Please note that this project now has a [Contributor Code of Conduct](http://contributor-covenant.org/version/1/0/0/). By participating in this project you agree to abide by its terms.
+
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
@@ -57,4 +59,4 @@ path.model      #=> Comment
 
 ## Licence
 
-Copyright (c) 2013, Joiner is developed and maintained by [Pat Allan](http://freelancing-gods.com), and is released under the open MIT Licence.
+Copyright (c) 2013-2020, Joiner is developed and maintained by [Pat Allan](http://freelancing-gods.com), and is released under the open MIT Licence.

data/Rakefile

@@ -1 +1,6 @@
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/joiner.gemspec

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

data/lib/joiner.rb

@@ -1,9 +1,13 @@
 require 'set'
+require 'active_record'
 
 module Joiner
   class AssociationNotFound < StandardError
   end
 end
 
+require 'joiner/alias_tracker'
+require 'joiner/join_aliaser'
+require 'joiner/join_dependency'
 require 'joiner/joins'
 require 'joiner/path'

data/lib/joiner/alias_tracker.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/string/conversions"
+
+# This code is taken straight from Rails, prior to v6.1.0.
+# I'm maintaining a copy here to save myself having to work through aliasing
+# logic myself - there's a good chance I don't need all of thiis, but it'll do
+# to get this gem working with Rails 6.1.
+
+class Joiner::AliasTracker # :nodoc:
+  def self.create(connection, initial_table, joins, aliases = nil)
+    if joins.empty?
+      aliases ||= Hash.new(0)
+    elsif aliases
+      default_proc = aliases.default_proc || proc { 0 }
+      aliases.default_proc = proc { |h, k|
+        h[k] = initial_count_for(connection, k, joins) + default_proc.call(h, k)
+      }
+    else
+      aliases = Hash.new { |h, k|
+        h[k] = initial_count_for(connection, k, joins)
+      }
+    end
+    aliases[initial_table] = 1
+    new(connection, aliases)
+  end
+
+  def self.initial_count_for(connection, name, table_joins)
+    quoted_name = nil
+
+    counts = table_joins.map do |join|
+      if join.is_a?(Arel::Nodes::StringJoin)
+        # quoted_name should be case ignored as some database adapters (Oracle) return quoted name in uppercase
+        quoted_name ||= connection.quote_table_name(name)
+
+        # Table names + table aliases
+        join.left.scan(
+          /JOIN(?:\s+\w+)?\s+(?:\S+\s+)?(?:#{quoted_name}|#{name})\sON/i
+        ).size
+      elsif join.is_a?(Arel::Nodes::Join)
+        join.left.name == name ? 1 : 0
+      else
+        raise ArgumentError, "joins list should be initialized by list of Arel::Nodes::Join"
+      end
+    end
+
+    counts.sum
+  end
+
+  # table_joins is an array of arel joins which might conflict with the aliases we assign here
+  def initialize(connection, aliases)
+    @aliases    = aliases
+    @connection = connection
+  end
+
+  def aliased_table_for(table_name, aliased_name, type_caster)
+    if aliases[table_name].zero?
+      # If it's zero, we can have our table_name
+      aliases[table_name] = 1
+      Arel::Table.new(table_name, type_caster: type_caster)
+    else
+      # Otherwise, we need to use an alias
+      aliased_name = @connection.table_alias_for(aliased_name)
+
+      # Update the count
+      aliases[aliased_name] += 1
+
+      table_alias = if aliases[aliased_name] > 1
+        "#{truncate(aliased_name)}_#{aliases[aliased_name]}"
+      else
+        aliased_name
+      end
+      Arel::Table.new(table_name, type_caster: type_caster).alias(table_alias)
+    end
+  end
+
+  attr_reader :aliases
+
+  private
+
+  def truncate(name)
+    name.slice(0, @connection.table_alias_length - 2)
+  end
+end

data/lib/joiner/join_aliaser.rb

@@ -0,0 +1,41 @@
+# The core logic of this class is old Rails behaviour, replicated here because
+# their own alias logic has evolved, but I haven't yet found a way to make use
+# of it - and besides, this is only used to generate Thinking Sphinx's
+# configuration rarely - not in any web requests, so performance issues are less
+# critical here.
+
+class Joiner::JoinAliaser
+  def self.call(join_root, alias_tracker)
+    new(join_root, alias_tracker).call
+  end
+
+  def initialize(join_root, alias_tracker)
+    @join_root = join_root
+    @alias_tracker = alias_tracker
+  end
+
+  def call
+    join_root.each_children do |parent, child|
+      child.table = table_aliases_for(parent, child).first
+    end
+  end
+
+  private
+
+  attr_reader :join_root, :alias_tracker
+
+  def table_aliases_for(parent, node)
+    node.reflection.chain.map { |reflection|
+      alias_tracker.aliased_table_for(
+        reflection.table_name,
+        table_alias_for(reflection, parent, reflection != node.reflection),
+        reflection.klass.type_caster
+      )
+    }
+  end
+
+  def table_alias_for(reflection, parent, join)
+    name = reflection.alias_candidate(parent.table_name)
+    join ? "#{name}_join" : name
+  end
+end

data/lib/joiner/join_dependency.rb

@@ -0,0 +1,11 @@
+class Joiner::JoinDependency < ActiveRecord::Associations::JoinDependency
+  def join_association_for(path, alias_tracker = nil)
+    @alias_tracker = alias_tracker
+
+    Joiner::JoinAliaser.call join_root, alias_tracker
+
+    path.inject(join_root) do |node, piece|
+      node.children.detect { |child| child.reflection.name == piece }
+    end
+  end
+end

data/lib/joiner/joins.rb

@@ -2,11 +2,7 @@ require 'active_record'
 require 'active_support/ordered_hash'
 
 class Joiner::Joins
-  JoinDependency  = ActiveRecord::Associations::JoinDependency
-  JoinAssociation = JoinDependency::JoinAssociation
-
-  attr_reader   :model
-  attr_accessor :join_association_class
+  attr_reader :model
 
   def initialize(model)
     @model       = model
@@ -23,35 +19,34 @@ class Joiner::Joins
     return model.table_name if path.empty?
 
     add_join_to path
-    join_association_for(path).tables.first.name
+    association_for(path).table.name
   end
 
   def join_values
-    switch_join_dependency join_association_class
-    result = JoinDependency.new model, joins_cache.to_a, []
-    switch_join_dependency JoinAssociation
-
-    result
+    Joiner::JoinDependency.new(
+      model, table, joins_cache.to_a, Arel::Nodes::OuterJoin
+    )
   end
 
   private
 
   attr_reader :joins_cache
 
-  def join_association_for(path)
-    path.inject(join_values.join_root) do |node, piece|
-      node.children.detect { |child| child.reflection.name == piece }
-    end
+  def alias_tracker
+    Joiner::AliasTracker.create(
+      model.connection, table.name, []
+    )
+  end
+
+  def association_for(path)
+    join_values.join_association_for path, alias_tracker
   end
 
   def path_as_hash(path)
     path[0..-2].reverse.inject(path.last) { |key, item| {item => key} }
   end
 
-  def switch_join_dependency(klass)
-    return unless join_association_class
-
-    JoinDependency.send :remove_const, :JoinAssociation
-    JoinDependency.const_set :JoinAssociation, klass
+  def table
+    @table ||= model.arel_table
   end
 end

data/spec/spec_helper.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: joiner
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Pat Allan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-11-17 00:00:00.000000000 Z
+date: 2020-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,70 +16,70 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 6.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: combustion
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.2
+        version: 6.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.2
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.8
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.8
+        version: '1.4'
 description: Builds ActiveRecord outer joins from association paths and provides references
   to table aliases.
 email:
@@ -88,13 +88,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - joiner.gemspec
 - lib/joiner.rb
+- lib/joiner/alias_tracker.rb
+- lib/joiner/join_aliaser.rb
+- lib/joiner/join_dependency.rb
 - lib/joiner/joins.rb
 - lib/joiner/path.rb
 - spec/acceptance/joiner_spec.rb
@@ -110,7 +115,7 @@ homepage: https://github.com/pat/joiner
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -125,9 +130,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.3.0
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Builds ActiveRecord joins from association paths
 test_files: