arel-helpers 2.8.0 → 2.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e692ef35ca5dfd967971eeb47c87ef93b6ca21c142e03ecb29b608c1e8e533e0
-  data.tar.gz: 719115c3d5f7a9c86d89d6bc720e390906eac6a9d5b60d29c19bebe751aa8c5b
+  metadata.gz: d792fc6a4945a79243f3e4b9720c9f10ce21f5a044328f56f2b381045183589a
+  data.tar.gz: becca530d9ecfd5a25594ce0363cbde8d792d564358d2394a36d7040e6341384
 SHA512:
-  metadata.gz: 946f6a173a8a3da761ad79b9a416cc7b7871ba0ce879ecd0cb32b2348199c65109df1f7ebee1ec438bdf3cf443d840282935e97d56eed009ac54a31b79cb9d83
-  data.tar.gz: 346d3fcbe5be8208734ca9a35f47870531524d008f8e67d307912eb3582d134b2b51c5a721ff31b5488efb519ade8c6c7830db509aa38450280e764147974527
+  metadata.gz: 2d825413e0dc2f3caff9ddcbc93a4eadbb1d8814196bc515fd13b3a759969db970a9fe2df911da86def2125d724d5c651e5a39eba2d9cf873d573c913b6a51f5
+  data.tar.gz: 70bea7795e9bcd75058dad5aaee877f6fb1d00e40f9e62b0db8b908d1a1f0656654fe67170a1024e1776b2a458ea11622fad399cda001ffd127c5f35f8197824

data/Gemfile

@@ -1,16 +1,3 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
-
-group :development, :test do
-  gem 'pry-byebug'
-
-  # lock to 10.0 until rspec is upgraded
-  gem 'rake', '~> 10.0'
-end
-
-group :test do
-  gem 'rspec', '~> 2.11.0'
-  gem 'rr',    '~> 1.0.4'
-  gem 'sqlite3'
-end

data/README.md

@@ -155,7 +155,7 @@ class PostQueryBuilder < ArelHelpers::QueryBuilder
   def with_comments_by(usernames)
     reflect(
       query
-        .joins(:comments => :author)
+        .joins(comments: :author)
         .where(author[:username].in(usernames))
     )
   end
@@ -187,6 +187,32 @@ 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.

data/arel-helpers.gemspec

@@ -1,24 +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.has_rdoc = true
 
-  if ENV["AR"]
-    s.add_dependency 'activerecord', ENV["AR"]
-  else
-    s.add_dependency 'activerecord', '>= 3.1.0', '< 6'
-  end
+  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', '~> 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,11 @@ 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 >= '5.2.1'
+        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)
         elsif version >= '5.2.0'
           join_association_5_2(table, association, join_type, options, &block)
@@ -40,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)
@@ -51,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
@@ -66,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, [])
 
@@ -77,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
@@ -91,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, [])
 
@@ -109,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
@@ -125,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, [])
 
@@ -144,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
@@ -160,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(
@@ -180,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(
@@ -209,14 +202,83 @@ module ArelHelpers
             join.right
           end
 
-          if found_alias = find_alias(join.left.name, aliases)
-            join.left.table_alias = found_alias.name
+          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, []).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|
+          right = if block_given?
+            yield join.left.name.to_sym, join.right
+          else
+            join.right
           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)
@@ -224,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

@@ -16,6 +16,21 @@ module ArelHelpers
 
     def_delegators :@query, *TERMINAL_METHODS
 
+    def self.not_nil(name)
+      mod = Module.new do
+        define_method(name) do |*args|
+          if (value = super(*args))
+            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.8.0'
+  VERSION = '2.12.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