arel-helpers 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f1009f54fd7f6ec015f38a4c4c37321b74aa5a23
-  data.tar.gz: 4d7b85881fc754aa00ad80b869ca3abf6c14c6d1
+SHA256:
+  metadata.gz: c660ae1fe4060cdb950996cc25907f683ccc785701c7cebd7c80bd426a3bb9ea
+  data.tar.gz: 2496cce6af26bb6c243e1947e32b800cb84b9bc3bdc134f59e3c2480521eb5f8
 SHA512:
-  metadata.gz: 130ce322efa3f3cde98f37ce8312487f64bf9b80f597893dc98e4ca0df5ab89b1aabe9173015b45baf869388a8a5386b1fbb8797ffbe7c4b34260ce6f691e53f
-  data.tar.gz: 75deca0bf9ac64644da21446eda134b3815627650bfd52c6087551ede0ef9369025b2dccc64cf8650e53eaeb882e938e8fdb67dfdbe0cc5ebf1200dfb08f8eec
+  metadata.gz: 397035a79ac5c8d9ec98858d76e028dc421d247d8c342131b4ca7b1e8bcd790698ed6400fca56ca1769785cb7dfa9a15aeae1fe0b765f7092b367c98ed5e5879
+  data.tar.gz: 302f2730474bd9f929f36ee9bc10a91b13cd904ccce6963bb072de61b1c21f0526ea0221e3637f4cc10745d47e9e21fb140e100ee7482eafd2b19b463062227a

data/Gemfile

@@ -3,8 +3,10 @@ source "https://rubygems.org"
 gemspec
 
 group :development, :test do
-  gem 'pry-nav'
-  gem 'rake'
+  gem 'pry-byebug'
+
+  # lock to 10.0 until rspec is upgraded
+  gem 'rake', '~> 10.0'
 end
 
 group :test do

data/Rakefile

@@ -10,7 +10,7 @@ require './lib/arel-helpers'
 
 Bundler::GemHelper.install_tasks
 
-task :default => :spec
+task default: :spec
 
 desc 'Run specs'
 RSpec::Core::RakeTask.new do |t|
@@ -21,7 +21,7 @@ task :console do
   $:.push(File.dirname(__FILE__))
 
   require 'spec/env'
-  require 'pry-nav'
+  require 'pry-byebug'
 
   ArelHelpers::Env.establish_connection
   ArelHelpers::Env.reset

data/lib/arel-helpers/aliases.rb

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+
+module ArelHelpers
+
+  module Aliases
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def aliased_as(*args)
+        aliases = args.map { |name| arel_table.alias(name) }
+
+        if block_given?
+          yield *aliases
+        else
+          aliases
+        end
+      end
+    end
+  end
+
+end

data/lib/arel-helpers/join_association.rb

@@ -17,21 +17,22 @@ module ArelHelpers
       # For example, for HABTM associations, two join statements are required.
       # 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, &block)
+      def join_association(table, association, join_type = Arel::Nodes::InnerJoin, options = {}, &block)
         if ActiveRecord::VERSION::STRING >= '5.0.0'
-          join_association_5_0(table, association, join_type, &block)
+          join_association_5_0(table, association, join_type, options, &block)
         elsif ActiveRecord::VERSION::STRING >= '4.2.0'
-          join_association_4_2(table, association, join_type, &block)
+          join_association_4_2(table, association, join_type, options, &block)
         elsif ActiveRecord::VERSION::STRING >= '4.1.0'
-          join_association_4_1(table, association, join_type, &block)
+          join_association_4_1(table, association, join_type, options, &block)
         else
-          join_association_3_1(table, association, join_type, &block)
+          join_association_3_1(table, association, join_type, options, &block)
         end
       end
 
       private
 
-      def join_association_3_1(table, association, join_type)
+      def join_association_3_1(table, association, join_type, options = {})
+        aliases = options.fetch(:aliases, {})
         associations = association.is_a?(Array) ? association : [association]
         join_dependency = ActiveRecord::Associations::JoinDependency.new(table, associations, [])
         manager = Arel::SelectManager.new(table)
@@ -42,6 +43,10 @@ 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
+
           if block_given?
             # yield |assoc_name, join_conditions|
             right = yield assoc.left.name.to_sym, assoc.right
@@ -52,7 +57,8 @@ module ArelHelpers
         end
       end
 
-      def join_association_4_1(table, association, join_type)
+      def join_association_4_1(table, association, join_type, options = {})
+        aliases = options.fetch(:aliases, {})
         associations = association.is_a?(Array) ? association : [association]
         join_dependency = ActiveRecord::Associations::JoinDependency.new(table, associations, [])
 
@@ -63,6 +69,10 @@ module ArelHelpers
             constraint.right
           end
 
+          if found_alias = find_alias(constraint.left.name, aliases)
+            constraint.left.table_alias = found_alias.name
+          end
+
           join_type.new(constraint.left, right)
         end
       end
@@ -72,7 +82,8 @@ module ArelHelpers
       # join_association isn't able to add to the list of bind variables
       # dynamically. To get around the problem, this method must return
       # a string.
-      def join_association_4_2(table, association, join_type)
+      def join_association_4_2(table, association, join_type, options = {})
+        aliases = options.fetch(:aliases, [])
         associations = association.is_a?(Array) ? association : [association]
         join_dependency = ActiveRecord::Associations::JoinDependency.new(table, associations, [])
 
@@ -90,6 +101,10 @@ module ArelHelpers
               join.right
             end
 
+            if found_alias = find_alias(join.left.name, aliases)
+              join.left.table_alias = found_alias.name
+            end
+
             join_type.new(join.left, right)
           end
         end
@@ -101,7 +116,8 @@ module ArelHelpers
         join_strings.join(' ')
       end
 
-      def join_association_5_0(table, association, join_type)
+      def join_association_5_0(table, association, join_type, options = {})
+        aliases = options.fetch(:aliases, [])
         associations = association.is_a?(Array) ? association : [association]
         join_dependency = ActiveRecord::Associations::JoinDependency.new(table, associations, [])
 
@@ -120,6 +136,10 @@ module ArelHelpers
               join.right
             end
 
+            if found_alias = find_alias(join.left.name, aliases)
+              join.left.table_alias = found_alias.name
+            end
+
             join_type.new(join.left, right)
           end
         end
@@ -138,6 +158,10 @@ 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/version.rb

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

data/lib/arel-helpers.rb

@@ -17,8 +17,9 @@ rescue
 end
 
 module ArelHelpers
-  autoload :JoinAssociation, "arel-helpers/join_association"
+  autoload :Aliases,         "arel-helpers/aliases"
   autoload :ArelTable,       "arel-helpers/arel_table"
+  autoload :JoinAssociation, "arel-helpers/join_association"
   autoload :QueryBuilder,    "arel-helpers/query_builder"
 
   def self.join_association(*args, &block)

data/spec/aliases_spec.rb

@@ -0,0 +1,42 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe ArelHelpers::Aliases 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
+      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')
+
+        expect(bar_alias).to be_a(Arel::Nodes::TableAlias)
+        expect(bar_alias.name).to eq('bar')
+      end
+    end
+
+    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
+      aliases = Post.aliased_as('foo', 'bar')
+      expect(aliases.size).to eq(2)
+
+      expect(aliases[0]).to be_a(Arel::Nodes::TableAlias)
+      expect(aliases[0].name).to eq('foo')
+
+      expect(aliases[1]).to be_a(Arel::Nodes::TableAlias)
+      expect(aliases[1].name).to eq('bar')
+    end
+  end
+end

data/spec/env/models.rb

@@ -2,29 +2,34 @@
 
 class Post < ActiveRecord::Base
   include ArelHelpers::ArelTable
+  include ArelHelpers::Aliases
   has_many :comments
   has_many :favorites
 end
 
 class Comment < ActiveRecord::Base
   include ArelHelpers::ArelTable
+  include ArelHelpers::Aliases
   belongs_to :post
   belongs_to :author
 end
 
 class Author < ActiveRecord::Base
   include ArelHelpers::ArelTable
+  include ArelHelpers::Aliases
   has_one :comment
   has_and_belongs_to_many :collab_posts
 end
 
 class Favorite < ActiveRecord::Base
   include ArelHelpers::ArelTable
+  include ArelHelpers::Aliases
   belongs_to :post
 end
 
 class CollabPost < ActiveRecord::Base
   include ArelHelpers::ArelTable
+  include ArelHelpers::Aliases
   has_and_belongs_to_many :authors
 end
 

data/spec/env.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 
-require 'env/models'
 require 'env/migrations'
+require 'env/models'
 
 module ArelHelpers
   class Env

data/spec/join_association_spec.rb

@@ -65,6 +65,22 @@ describe ArelHelpers do
         'SELECT "collab_posts".* FROM "collab_posts" INNER JOIN "authors_collab_posts" ON "authors_collab_posts"."collab_post_id" = "collab_posts"."id" INNER JOIN "authors" ON "authors"."id" = "authors_collab_posts"."author_id"'
     end
 
+    it "allows adding a custom alias to the joined table" do
+      Comment.aliased_as(:foo) do |foo|
+        Post.joins(ArelHelpers.join_association(Post, :comments, Arel::Nodes::InnerJoin, aliases: [foo])).to_sql.should ==
+          'SELECT "posts".* FROM "posts" INNER JOIN "comments" "foo" ON "foo"."post_id" = "posts"."id"'
+      end
+    end
+
+    it "allows aliasing multiple associations" do
+      Comment.aliased_as(:foo) do |foo|
+        Favorite.aliased_as(:bar) do |bar|
+          Post.joins(ArelHelpers.join_association(Post, [:comments, :favorites], Arel::Nodes::InnerJoin, aliases: [foo, bar])).to_sql.should ==
+            'SELECT "posts".* FROM "posts" INNER JOIN "comments" "foo" ON "foo"."post_id" = "posts"."id" INNER JOIN "favorites" "bar" ON "bar"."post_id" = "posts"."id"'
+        end
+      end
+    end
+
     it 'handles polymorphic through associations' do
       relation = Location.joins(
         ArelHelpers.join_association(Location, :community_tickets)

data/spec/spec_helper.rb

@@ -5,7 +5,7 @@ $:.push(File.dirname(__FILE__))
 require 'rspec'
 require 'arel-helpers'
 require 'fileutils'
-require 'pry-nav'
+require 'pry-byebug'
 
 require 'env'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arel-helpers
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Cameron Dutro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-07 00:00:00.000000000 Z
+date: 2018-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -39,16 +39,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
-- History.txt
 - README.md
 - Rakefile
 - arel-helpers.gemspec
 - lib/arel-helpers.rb
+- lib/arel-helpers/aliases.rb
 - lib/arel-helpers/arel_table.rb
 - lib/arel-helpers/ext/collection_proxy.rb
 - lib/arel-helpers/join_association.rb
 - lib/arel-helpers/query_builder.rb
 - lib/arel-helpers/version.rb
+- spec/aliases_spec.rb
 - spec/arel_table_spec.rb
 - spec/env.rb
 - spec/env/migrations.rb
@@ -76,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Useful tools to help construct database queries with ActiveRecord and Arel.

data/History.txt

@@ -1,49 +0,0 @@
-== 1.0.0
-
-* Birthday! Includes join_association and arel_table helpers.
-
-== 1.1.0
-
-* Adding the QueryBuilder class.
-
-== 1.2.0
-
-* Adding Rails 4 support.
-
-== 2.0.0
-
-* Turning JoinAssociation into an ActiveSupport::Concern (breaks backwards compatibility).
-
-== 2.0.1
-
-* Define ArelHelpers.join_association so people can use join_association functionality without relying on autoloading. (@peeja, github issue #8)
-
-== 2.0.2
-
-* Fix issue causing CollectionProxy#[] to return Arel::Attribute objects instead of model instances. See https://github.com/camertron/arel-helpers/pull/11
-
-== 2.1.0
-
-* Adding support for Rails 4.2 (@hasghari, github issue #12)
-
-== 2.1.1
-
-* Fixing issue causing ArelTable instances to get returned when accessing records inside an ActiveRecord::Relation. (@svoynow, #18)
-
-== 2.2.0
-
-* Adding polymorphic join support for Rails 4.2.
-
-== 2.3.0
-
-* Adding support for Rails 5 (@vkill #24, @camertron #26)
-
-== 2.4.0
-
-* Adding support for Rails 5.1 (@hasghari #30)
-
-== 2.5.0
-
-* Add license information to gemspec so it is parsed by verifiers (@petergoldstein #31)
-* Update QueryBuilder#reflect to create deep copy of builder (@wycleffsean #32)
-