arel-helpers 2.10.0 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 209526ee9962414d0eb5bab7820f6c97cfc51edf362d4ccdaf6b7309e7196fbe
-  data.tar.gz: e3923216fd30b2ab762c581ef0056145a1b09758433159123bee1df3443bc924
+  metadata.gz: afe6ddeb4e41b56b59f08d6b2ac09bfd832e66b995355169b756ed22d11a2136
+  data.tar.gz: 944d2e1730143abe055f2dad7efe9d01b9ddafabab2080811714d72405177446
 SHA512:
-  metadata.gz: 48814845832553b87d496b70982c46a905b0a2aecba5426d3f9e36f3fc2436cee0e71e68ab733fbc0b37cf90981515de695f309d5a4ea35d49becc83d4d1703f
-  data.tar.gz: 638fa0c5ed41050e17bdd642fab0b4dfc94e0d3bb8084a1ca9c6cc89a9d340f11aadc0d0ba98d78628ecf4bbacd465385074cc1f0f82167f1b50298361672472
+  metadata.gz: 5f03ab5b864494bcc5cfb2bc7558c315a18e6460cd815c34855b2b3f0ac9d2696a49b3bd3755543c9124e2ef0667e4d774ae4164cd0317705f74556696c6cfc3
+  data.tar.gz: e3f704bb25be566eb5797f81804d4446b9c3c96b5df84129afb5bdeec16b91fb420d2cc7ff901648e8dab03a818d2036a5288fa6a11c95d14231b6cd9ed74b97

data/Gemfile

@@ -1,2 +1,3 @@
-ENV['BUNDLE_GEMFILE'] = File.expand_path('../Gemfile-rails-6.0.x', __FILE__)
-Bundler.load
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -1,6 +1,6 @@
+![Unit Tests](https://github.com/camertron/arel-helpers/actions/workflows/unit_tests.yml/badge.svg?branch=master)
 
-
-## arel-helpers [![Build Status](https://secure.travis-ci.org/camertron/arel-helpers.png?branch=master)](http://travis-ci.org/camertron/arel-helpers)
+## arel-helpers
 
 Useful tools to help construct database queries with ActiveRecord and Arel.
 
@@ -187,9 +187,35 @@ PostQueryBuilder.new
   .since_yesterday
 ```
 
+#### Conditional reflections
+
+If you have parts of a query that should only be added under certain conditions you can return `reflect(query)` from your method. E.g:
+
+```ruby
+  def with_comments_by(usernames)
+    if usernames
+      reflect(
+        query.where(post[:title].matches("%#{title}%"))
+      )
+    else
+      reflect(query)
+    end
+  end
+```
+
+This can become repetitive, and as an alternative you can choose to prepend `not_nil` to your method definition:
+
+```ruby
+  class PostQueryBuilder < ArelHelpers::QueryBuilder
+    not_nil def with_comments_by(usernames)
+      reflect(query.where(post[:title].matches("%#{title}%"))) if usernames
+    end
+  end
+```
+
 ## Requirements
 
-Requires ActiveRecord >= 3.1.0, < 6, tested against Ruby 2.2.4. Depends on SQLite for testing purposes.
+Requires ActiveRecord >= 3.1.0, < 7. Depends on SQLite for testing purposes.
 
 ## Running Tests
 

data/arel-helpers.gemspec

@@ -1,23 +1,26 @@
-$:.unshift File.join(File.dirname(__FILE__), 'lib')
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), 'lib')
 require 'arel-helpers/version'
 
 Gem::Specification.new do |s|
-  s.name     = "arel-helpers"
+  s.name     = 'arel-helpers'
   s.version  = ::ArelHelpers::VERSION
-  s.authors  = ["Cameron Dutro"]
-  s.email    = ["camertron@gmail.com"]
-  s.homepage = "https://github.com/camertron/arel-helpers"
+  s.authors  = ['Cameron Dutro']
+  s.email    = ['camertron@gmail.com']
+  s.homepage = 'https://github.com/camertron/arel-helpers'
   s.license  = 'MIT'
-  s.description = s.summary = "Useful tools to help construct database queries with ActiveRecord and Arel."
+  s.description = s.summary = 'Useful tools to help construct database queries with ActiveRecord and Arel.'
 
   s.platform = Gem::Platform::RUBY
 
   s.add_dependency 'activerecord', '>= 3.1.0', '< 7'
 
+  s.add_development_dependency 'appraisal'
+  s.add_development_dependency 'combustion', '~> 1.3'
+  s.add_development_dependency 'database_cleaner', '~> 1.8'
   s.add_development_dependency 'rake', '~> 10.0'
-  s.add_development_dependency 'rspec', '~> 2.11'
-  s.add_development_dependency 'rr', '~> 1.0'
+  s.add_development_dependency 'rspec', '~> 3'
+  s.add_development_dependency 'sqlite3', '~> 1.4.0'
 
   s.require_path = 'lib'
-  s.files = Dir["{lib,spec}/**/*", "Gemfile", "History.txt", "README.md", "Rakefile", "arel-helpers.gemspec"]
+  s.files = Dir['{lib,spec}/**/*', 'Gemfile', 'History.txt', 'README.md', 'Rakefile', 'arel-helpers.gemspec']
 end

data/lib/arel-helpers/join_association.rb

@@ -18,7 +18,9 @@ module ArelHelpers
       # This method encapsulates that functionality and yields an intermediate object for chaining.
       # It also allows you to use an outer join instead of the default inner via the join_type arg.
       def join_association(table, association, join_type = Arel::Nodes::InnerJoin, options = {}, &block)
-        if version >= '6.0.0'
+        if version >= '6.1.0'
+          join_association_6_1_0(table, association, join_type, options, &block)
+        elsif version >= '6.0.0'
           join_association_6_0_0(table, association, join_type, options, &block)
         elsif version >= '5.2.1'
           join_association_5_2_1(table, association, join_type, options, &block)
@@ -42,7 +44,7 @@ module ArelHelpers
       end
 
       def join_association_3_1(table, association, join_type, options = {})
-        aliases = options.fetch(:aliases, {})
+        aliases = options.fetch(:aliases, []).index_by(&:table_name)
         associations = association.is_a?(Array) ? association : [association]
         join_dependency = ActiveRecord::Associations::JoinDependency.new(table, associations, [])
         manager = Arel::SelectManager.new(table)
@@ -53,12 +55,9 @@ module ArelHelpers
         end
 
         manager.join_sources.map do |assoc|
-          if found_alias = find_alias(assoc.left.name, aliases)
-            assoc.left.table_alias = found_alias.name
-          end
+          assoc.left.table_alias = aliases[assoc.left.name].name if aliases.key?(assoc.left.name)
 
           if block_given?
-            # yield |assoc_name, join_conditions|
             right = yield assoc.left.name.to_sym, assoc.right
             assoc.class.new(assoc.left, right)
           else
@@ -68,7 +67,7 @@ module ArelHelpers
       end
 
       def join_association_4_1(table, association, join_type, options = {})
-        aliases = options.fetch(:aliases, {})
+        aliases = options.fetch(:aliases, []).index_by(&:table_name)
         associations = association.is_a?(Array) ? association : [association]
         join_dependency = ActiveRecord::Associations::JoinDependency.new(table, associations, [])
 
@@ -79,9 +78,7 @@ module ArelHelpers
             constraint.right
           end
 
-          if found_alias = find_alias(constraint.left.name, aliases)
-            constraint.left.table_alias = found_alias.name
-          end
+          constraint.left.table_alias = aliases[constraint.left.name].name if aliases.key?(constraint.left.name)
 
           join_type.new(constraint.left, right)
         end
@@ -93,7 +90,7 @@ module ArelHelpers
       # dynamically. To get around the problem, this method must return
       # a string.
       def join_association_4_2(table, association, join_type, options = {})
-        aliases = options.fetch(:aliases, [])
+        aliases = options.fetch(:aliases, []).index_by(&:table_name)
         associations = association.is_a?(Array) ? association : [association]
         join_dependency = ActiveRecord::Associations::JoinDependency.new(table, associations, [])
 
@@ -111,9 +108,7 @@ module ArelHelpers
               join.right
             end
 
-            if found_alias = find_alias(join.left.name, aliases)
-              join.left.table_alias = found_alias.name
-            end
+            join.left.table_alias = aliases[join.left.name].name if aliases.key?(join.left.name)
 
             join_type.new(join.left, right)
           end
@@ -127,7 +122,7 @@ module ArelHelpers
       end
 
       def join_association_5_0(table, association, join_type, options = {})
-        aliases = options.fetch(:aliases, [])
+        aliases = options.fetch(:aliases, []).index_by(&:table_name)
         associations = association.is_a?(Array) ? association : [association]
         join_dependency = ActiveRecord::Associations::JoinDependency.new(table, associations, [])
 
@@ -146,9 +141,7 @@ module ArelHelpers
               join.right
             end
 
-            if found_alias = find_alias(join.left.name, aliases)
-              join.left.table_alias = found_alias.name
-            end
+            join.left.table_alias = aliases[join.left.name].name if aliases.key?(join.left.name)
 
             join_type.new(join.left, right)
           end
@@ -162,7 +155,7 @@ module ArelHelpers
       end
 
       def join_association_5_2(table, association, join_type, options = {})
-        aliases = options.fetch(:aliases, [])
+        aliases = options.fetch(:aliases, []).index_by(&:table_name)
         associations = association.is_a?(Array) ? association : [association]
 
         alias_tracker = ActiveRecord::Associations::AliasTracker.create(
@@ -182,16 +175,14 @@ module ArelHelpers
             join.right
           end
 
-          if found_alias = find_alias(join.left.name, aliases)
-            join.left.table_alias = found_alias.name
-          end
+          join.left.table_alias = aliases[join.left.name].name if aliases.key?(join.left.name)
 
           join_type.new(join.left, right)
         end
       end
 
       def join_association_5_2_1(table, association, join_type, options = {})
-        aliases = options.fetch(:aliases, [])
+        aliases = options.fetch(:aliases, []).index_by(&:table_name)
         associations = association.is_a?(Array) ? association : [association]
 
         alias_tracker = ActiveRecord::Associations::AliasTracker.create(
@@ -211,16 +202,14 @@ module ArelHelpers
             join.right
           end
 
-          if found_alias = find_alias(join.left.name, aliases)
-            join.left.table_alias = found_alias.name
-          end
+          join.left.table_alias = aliases[join.left.name].name if aliases.key?(join.left.name)
 
           join_type.new(join.left, right)
         end
       end
 
       def join_association_6_0_0(table, association, join_type, options = {})
-        aliases = options.fetch(:aliases, [])
+        aliases = options.fetch(:aliases, []).index_by(&:table_name)
         associations = association.is_a?(Array) ? association : [association]
 
         alias_tracker = ActiveRecord::Associations::AliasTracker.create(
@@ -240,14 +229,56 @@ module ArelHelpers
             join.right
           end
 
-          if found_alias = find_alias(join.left.name, aliases)
-            join.left.table_alias = found_alias.name
-          end
+          join.left.table_alias = aliases[join.left.name].name if aliases.key?(join.left.name)
 
           join_type.new(join.left, right)
         end
       end
 
+      def join_association_6_1_0(table, association, join_type, options = {})
+        aliases = options.fetch(:aliases, []).index_by(&:table_name)
+        associations = association.is_a?(Array) ? association : [association]
+
+        alias_tracker = ActiveRecord::Associations::AliasTracker.create(
+          table.connection, table.name, {}
+        )
+
+        join_dependency = ActiveRecord::Associations::JoinDependency.new(
+          table, table.arel_table, associations, join_type
+        )
+
+        constraints = join_dependency.join_constraints([], alias_tracker, [])
+
+        constraints.map do |join|
+          apply_aliases(join, aliases)
+
+          right = if block_given?
+                    yield join.left.name.to_sym, join.right
+                  else
+                    join.right
+                  end
+
+          join_type.new(join.left, right)
+        end
+      end
+
+      def apply_aliases(node, aliases)
+        case node
+        when Arel::Nodes::Join
+          node.left = aliases[node.left.name] || node.left
+          apply_aliases(node.right, aliases)
+        when Arel::Attributes::Attribute
+          node.relation = aliases[node.relation.name] || node.relation
+        when Arel::Nodes::And
+          node.children.each { |child| apply_aliases(child, aliases) }
+        when Arel::Nodes::Unary
+          apply_aliases(node.value, aliases)
+        when Arel::Nodes::Binary
+          apply_aliases(node.left, aliases)
+          apply_aliases(node.right, aliases)
+        end
+      end
+
       private
 
       def to_sql(node, table, binds)
@@ -255,10 +286,6 @@ module ArelHelpers
         collect = visitor.accept(node, Arel::Collectors::Bind.new)
         collect.substitute_binds(binds).join
       end
-
-      def find_alias(name, aliases)
-        aliases.find { |a| a.table_name == name }
-      end
     end
   end
 end

data/lib/arel-helpers/query_builder.rb

@@ -9,13 +9,28 @@ module ArelHelpers
     include Enumerable
 
     attr_reader :query
-    def_delegators :@query, :to_a, :to_sql, :each
+    def_delegators :@query, :to_a, :to_sql, :each, :empty?, :size
 
     TERMINAL_METHODS = [:count, :first, :last]
     TERMINAL_METHODS << :pluck if ActiveRecord::VERSION::MAJOR >= 4
 
     def_delegators :@query, *TERMINAL_METHODS
 
+    def self.not_nil(name)
+      mod = Module.new do
+        define_method(name) do |*args, **kwargs|
+          if (value = super(*args, **kwargs))
+            value
+          else
+            reflect(query)
+          end
+        end
+      end
+
+      prepend mod
+      name
+    end
+
     def initialize(query)
       @query = query
     end

data/lib/arel-helpers/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module ArelHelpers
-  VERSION = '2.10.0'
+  VERSION = '2.13.0'
 end

data/spec/aliases_spec.rb

@@ -1,17 +1,15 @@
-# encoding: UTF-8
-
 require 'spec_helper'
 
 describe ArelHelpers::Aliases do
-  describe "#aliased_as" do
-    it "yields an alias when passed a block" do
+  describe '#aliased_as' do
+    it 'yields an alias when passed a block' do
       Post.aliased_as('foo') do |foo_alias|
         expect(foo_alias).to be_a(Arel::Nodes::TableAlias)
         expect(foo_alias.name).to eq('foo')
       end
     end
 
-    it "is capable of yielding multiple aliases" do
+    it 'is capable of yielding multiple aliases' do
       Post.aliased_as('foo', 'bar') do |foo_alias, bar_alias|
         expect(foo_alias).to be_a(Arel::Nodes::TableAlias)
         expect(foo_alias.name).to eq('foo')
@@ -21,14 +19,14 @@ describe ArelHelpers::Aliases do
       end
     end
 
-    it "returns an alias when not passed a block" do
+    it 'returns an alias when not passed a block' do
       aliases = Post.aliased_as('foo')
       expect(aliases.size).to eq(1)
       expect(aliases[0]).to be_a(Arel::Nodes::TableAlias)
       expect(aliases[0].name).to eq('foo')
     end
 
-    it "is capable of returning multiple aliases" do
+    it 'is capable of returning multiple aliases' do
       aliases = Post.aliased_as('foo', 'bar')
       expect(aliases.size).to eq(2)
 

data/spec/arel_table_spec.rb

@@ -1,30 +1,28 @@
-# encoding: UTF-8
-
 require 'spec_helper'
 
 describe ArelHelpers::ArelTable do
-  it "should add the [] function to the model and allow attribute access" do
+  it 'should add the [] function to the model and allow attribute access' do
     Post[:id].tap do |post_id|
-      post_id.should be_a(Arel::Attribute)
-      post_id.name.should == :id
-      post_id.relation.name.should == "posts"
+      expect(post_id).to be_a Arel::Attribute
+      expect(post_id.name.to_s).to eq 'id'
+      expect(post_id.relation.name).to eq 'posts'
     end
   end
 
-  it "should not interfere with associations" do
+  it 'should not interfere with associations' do
     post = Post.create(title: "I'm a little teapot")
-    post.comments[0].should be_nil
+    expect(post.comments[0]).to be_nil
   end
 
-  it "should allow retrieving associated records" do
+  it 'should allow retrieving associated records' do
     post = Post.create(title: "I'm a little teapot")
     comment = post.comments.create
-    post.reload.comments[0].id.should == comment.id
+    expect(post.reload.comments[0].id).to eq comment.id
   end
 
-  it "does not interfere with ActiveRecord::Relation objects" do
-    Post.all[0].should be_nil
+  it 'does not interfere with ActiveRecord::Relation objects' do
+    expect(Post.all[0]).to be_nil
     p = Post.create(title: 'foo')
-    Post.all[0].id.should == p.id
+    expect(Post.all[0].id).to eq p.id
   end
 end

data/spec/env/models.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-
 class Post < ActiveRecord::Base
   include ArelHelpers::ArelTable
   include ArelHelpers::Aliases
@@ -44,12 +42,10 @@ end
 
 class Location < ActiveRecord::Base
   has_many :card_locations
-  has_many :community_tickets, {
-    through: :card_locations, source: :card, source_type: 'CommunityTicket'
-  }
+  has_many :community_tickets, through: :card_locations, source: :card, source_type: 'CommunityTicket'
 end
 
 class CommunityTicket < ActiveRecord::Base
-  has_many :card_locations, as: :card, source_type: 'CommunityTicket'
+  has_many :card_locations, as: :card
   has_many :locations, through: :card_locations
 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,34 @@
+# frozen_string_literal: true
+
+ActiveRecord::Schema.define do
+  create_table :posts do |t|
+    t.column :title, :string
+  end
+
+  create_table :comments do |t|
+    t.references :post
+  end
+
+  create_table :authors do |t|
+    t.references :comment
+    t.references :collab_posts
+  end
+
+  create_table :favorites do |t|
+    t.references :post
+  end
+
+  create_table :collab_posts do |t|
+    t.references :authors
+  end
+
+  create_table :cards
+
+  create_table :card_locations do |t|
+    t.references :location
+    t.references :card, polymorphic: true
+  end
+
+  create_table :locations
+  create_table :community_tickets
+end