arel-helpers 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7fcf6cccc8b45ef008f68a1da1ef9e8b468d474
-  data.tar.gz: dc76542898067426f8715ccb4b91b2b1d48f1787
+  metadata.gz: 74fd32a2a3bd64b02be9dbd561afe2add390752f
+  data.tar.gz: 78f91129ab6b88b3b93675de7a0e96f7ac9ef716
 SHA512:
-  metadata.gz: 3c95d188bfb80db50e13f8c98d7847bca7abc6c0b95502c22efd0eef043f1a5ec0b71b5c71410cfeaeabfb9533ae9ee02099d5fc55644f886fe95599ecd1631a
-  data.tar.gz: b74df2e5fd0224f8945219944888eea41be7e78532f4e277ae1e17eb3fc5ba792a35e0957e08b1b0dc87cd8a376d4b769c99fb0981c12475ca54efca404e084d
+  metadata.gz: a8082544e84ddca08e248276682473fa8d2af08cd666fb2b76c2588cbf52546c8f9345805693dbd6929ec0a58f64e130f21a7fdb973374feb81f263a2b6fd65c
+  data.tar.gz: 0fa70969de2f89d8fa03c2b0747ca3da4c011e9399f74b4f9222611401df399bbd24ecd7e2e577e9600de21291a5f99d06559ca0648be1c1770b27ff08f902fa

data/History.txt

@@ -8,4 +8,8 @@
 
 == 1.2.0
 
-* Adding Rails 4 support.
+* Adding Rails 4 support.
+
+== 2.0.0
+
+* Turning JoinAssociation into an ActiveSupport::Concern (breaks backwards compatibility).

data/README.md

@@ -39,7 +39,7 @@ Post.where(Post[:id].eq(1))
 
 ### JoinAssociation Helper
 
-Using pure Arel is probably one of the only ways to do an outer join with ActiveRecord. For example, let's say we have these two models:
+Using pure Arel is one of the only ways to do an outer join with ActiveRecord. For example, let's say we have these two models:
 
 ```ruby
 class Post < ActiveRecord::Base
@@ -59,7 +59,7 @@ Post.joins(:comments)
 
 ActiveRecord introspects the association between posts and comments and automatically chooses the right columns to use in the join conditions.
 
-Things start to get messy however if you wanted to do an outer join instead of the default inner join. Your query might look like this:
+Things start to get messy however if you want to do an outer join instead of the default inner join. Your query might look like this:
 
 ```ruby
 Post
@@ -70,25 +70,37 @@ Post
   )
 ```
 
-Such verbose. Much code. Very bloat. Wow. We've lost all the awesome association introspection that ActiveRecord would otherwise have given us. Enter `ArelHelpers::JoinAssociation`:
+Such verbose. Much code. Very bloat. Wow. We've lost all the awesome association introspection that ActiveRecord would otherwise have given us. Enter `ArelHelpers.join_association`:
 
 ```ruby
-include ArelHelpers::JoinAssociation
-Post.joins(join_association(Post, :comments, Arel::OuterJoin))
+Post.joins(ArelHelpers.join_association(Post, :comments, Arel::OuterJoin))
 ```
 
 Easy peasy.
 
-`JoinAssociation` also allows you to customize the join conditions via a block:
+`#join_association` also allows you to customize the join conditions via a block:
 
 ```ruby
 Post.joins(
-  join_association(Post, :comments, Arel::OuterJoin) do |assoc_name, join_conditions|
+  ArelHelpers.join_association(Post, :comments, Arel::OuterJoin) do |assoc_name, join_conditions|
     join_conditions.and(Post[:author_id].eq(4))
   end
 )
 ```
 
+But wait, there's more! Include the `ArelHelpers::JoinAssociation` concern into your models to have access to the `join_association` method directly from the model's class:
+
+```ruby
+include ArelHelpers::JoinAssociation
+
+Post
+  .joins(
+    Post.join_association(:comments, Arel::OuterJoin) do |assoc_name, join_conditions|
+      join_conditions.and(Post[:author_id].eq(4))
+    end
+  )
+```
+
 ### Query Builders
 
 ArelHelpers also contains a very simple class that's designed to provide a light framework for constructing queries using the builder pattern. For example, let's write a class that encapsulates generating queries for blog posts:
@@ -110,7 +122,7 @@ class PostQueryBuilder < ArelHelpers::QueryBuilder
     reflect(
       query
         .joins(:comments => :author)
-        .where(Author[:username].in(usernames))
+        .where(author[:username].in(usernames))
     )
   end
 
@@ -143,7 +155,7 @@ PostQueryBuilder.new
 
 ## Requirements
 
-No external requirements. Depends on SQLite for testing purposes.
+Requires ActiveRecord >= 3.1.0, <= 4.1.0, tested with Ruby 1.9.3, 2.0.0, and 2.1.0. Depends on SQLite for testing purposes.
 
 ## Running Tests
 

data/arel-helpers.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   if ENV["AR"]
     s.add_dependency 'activerecord', ENV["AR"]
   else
-    s.add_dependency 'activerecord', '>= 3.1.0', '<= 4.1.0'
+    s.add_dependency 'activerecord', '>= 3.1.0', '< 5'
   end
 
   s.require_path = 'lib'

data/lib/arel-helpers/join_association.rb

@@ -1,58 +1,67 @@
 # encoding: UTF-8
 
 module ArelHelpers
+
   module JoinAssociation
+    extend ActiveSupport::Concern
 
-    # activerecord uses JoinDependency to automagically generate inner join statements for
-    # any type of association (belongs_to, has_many, and has_and_belongs_to_many).
-    # 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::InnerJoin, &block)
-      if ActiveRecord::VERSION::STRING >= '4.1.0'
-        join_association_4_1(table, association, join_type, &block)
-      else
-        join_association_3_1(table, association, join_type, &block)
+    included do
+      def self.join_association(association, join_type = Arel::InnerJoin, &block)
+        ArelHelpers.join_association(self, association, join_type, &block)
       end
     end
 
-    private
+  end
+
+  # activerecord uses JoinDependency to automagically generate inner join statements for
+  # any type of association (belongs_to, has_many, and has_and_belongs_to_many).
+  # 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 self.join_association(table, association, join_type = Arel::InnerJoin, &block)
+    if ActiveRecord::VERSION::STRING >= '4.1.0'
+      join_association_4_1(table, association, join_type, &block)
+    else
+      join_association_3_1(table, association, join_type, &block)
+    end
+  end
 
-    def join_association_3_1(table, association, join_type)
-      associations = association.is_a?(Array) ? association : [association]
-      join_dependency = ActiveRecord::Associations::JoinDependency.new(table, associations, [])
-      manager = Arel::SelectManager.new(table)
+  private
 
-      join_dependency.join_associations.each do |assoc|
-        assoc.join_type = join_type
-        assoc.join_to(manager)
-      end
+  def self.join_association_3_1(table, association, join_type)
+    associations = association.is_a?(Array) ? association : [association]
+    join_dependency = ActiveRecord::Associations::JoinDependency.new(table, associations, [])
+    manager = Arel::SelectManager.new(table)
 
-      manager.join_sources.map do |assoc|
-        if block_given?
-          # yield |assoc_name, join_conditions|
-          right = yield assoc.left.name.to_sym, assoc.right
-          assoc.class.new(assoc.left, right)
-        else
-          assoc
-        end
-      end
+    join_dependency.join_associations.each do |assoc|
+      assoc.join_type = join_type
+      assoc.join_to(manager)
     end
 
-    def join_association_4_1(table, association, join_type)
-      associations = association.is_a?(Array) ? association : [association]
-      join_dependency = ActiveRecord::Associations::JoinDependency.new(table, associations, [])
+    manager.join_sources.map do |assoc|
+      if block_given?
+        # yield |assoc_name, join_conditions|
+        right = yield assoc.left.name.to_sym, assoc.right
+        assoc.class.new(assoc.left, right)
+      else
+        assoc
+      end
+    end
+  end
 
-      join_dependency.join_constraints([]).map do |constraint|
-        right = if block_given?
-          yield constraint.left.name.to_sym, constraint.right
-        else
-          constraint.right
-        end
+  def self.join_association_4_1(table, association, join_type)
+    associations = association.is_a?(Array) ? association : [association]
+    join_dependency = ActiveRecord::Associations::JoinDependency.new(table, associations, [])
 
-        join_type.new(constraint.left, right)
+    join_dependency.join_constraints([]).map do |constraint|
+      right = if block_given?
+        yield constraint.left.name.to_sym, constraint.right
+      else
+        constraint.right
       end
-    end
 
+      join_type.new(constraint.left, right)
+    end
   end
-end
+
+end

data/lib/arel-helpers/query_builder.rb

@@ -11,6 +11,11 @@ module ArelHelpers
     attr_reader :query
     def_delegators :@query, :to_a, :to_sql, :each
 
+    TERMINAL_METHODS = [:count, :first, :last]
+    TERMINAL_METHODS << :pluck if ActiveRecord::VERSION::MAJOR >= 4
+
+    def_delegators :@query, *TERMINAL_METHODS
+
     def initialize(query)
       @query = query
     end

data/lib/arel-helpers/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module ArelHelpers
-  VERSION = "1.2.0"
+  VERSION = "2.0.0"
 end

data/spec/join_association_spec.rb

@@ -2,22 +2,20 @@
 
 require 'spec_helper'
 
-describe ArelHelpers::JoinAssociation do
-  include ArelHelpers::JoinAssociation
-
+describe ArelHelpers do
   describe "#join_association" do
     it "should work for a directly associated model" do
-      Post.joins(join_association(Post, :comments)).to_sql.should ==
+      Post.joins(ArelHelpers.join_association(Post, :comments)).to_sql.should ==
         'SELECT "posts".* FROM "posts" INNER JOIN "comments" ON "comments"."post_id" = "posts"."id"'
     end
 
     it "should work with an outer join" do
-      Post.joins(join_association(Post, :comments, Arel::OuterJoin)).to_sql.should ==
+      Post.joins(ArelHelpers.join_association(Post, :comments, Arel::OuterJoin)).to_sql.should ==
         'SELECT "posts".* FROM "posts" LEFT OUTER JOIN "comments" ON "comments"."post_id" = "posts"."id"'
     end
 
     it "should allow adding additional join conditions" do
-      Post.joins(join_association(Post, :comments) do |assoc_name, join_conditions|
+      Post.joins(ArelHelpers.join_association(Post, :comments) do |assoc_name, join_conditions|
         join_conditions.and(Comment[:id].eq(10))
       end).to_sql.should ==
         'SELECT "posts".* FROM "posts" INNER JOIN "comments" ON "comments"."post_id" = "posts"."id" AND "comments"."id" = 10'
@@ -25,19 +23,19 @@ describe ArelHelpers::JoinAssociation do
 
     it "should work for two models, one directly associated and the other indirectly" do
       Post
-        .joins(join_association(Post, :comments))
-        .joins(join_association(Comment, :author))
+        .joins(ArelHelpers.join_association(Post, :comments))
+        .joins(ArelHelpers.join_association(Comment, :author))
         .to_sql.should ==
           'SELECT "posts".* FROM "posts" INNER JOIN "comments" ON "comments"."post_id" = "posts"."id" INNER JOIN "authors" ON "authors"."comment_id" = "comments"."id"'
     end
 
     it "should be able to handle multiple associations" do
-      Post.joins(join_association(Post, [:comments, :favorites])).to_sql.should ==
+      Post.joins(ArelHelpers.join_association(Post, [:comments, :favorites])).to_sql.should ==
         'SELECT "posts".* FROM "posts" INNER JOIN "comments" ON "comments"."post_id" = "posts"."id" INNER JOIN "favorites" ON "favorites"."post_id" = "posts"."id"'
     end
 
     it "should yield once for each association" do
-      Post.joins(join_association(Post, [:comments, :favorites]) do |assoc_name, join_conditions|
+      Post.joins(ArelHelpers.join_association(Post, [:comments, :favorites]) do |assoc_name, join_conditions|
         case assoc_name
           when :favorites
             join_conditions.or(Favorite[:amount].eq("lots"))
@@ -49,3 +47,14 @@ describe ArelHelpers::JoinAssociation do
     end
   end
 end
+
+describe ArelHelpers::JoinAssociation do
+  class AssocPost < Post
+    include ArelHelpers::JoinAssociation
+  end
+
+  it "should provide the join_association method and use the parent class as the model to join on" do
+    AssocPost.joins(AssocPost.join_association(:comments)).to_sql.should ==
+      'SELECT "posts".* FROM "posts" INNER JOIN "comments" ON "comments"."post_id" = "posts"."id"'
+  end
+end

data/spec/query_builder_spec.rb

@@ -44,4 +44,11 @@ describe ArelHelpers::QueryBuilder do
     Post.create(title: "Foobar")
     builder.map(&:title).should == ["Foobar"]
   end
+
+  ArelHelpers::QueryBuilder::TERMINAL_METHODS.each do |method|
+    it "does not enumerate records for #{method}" do
+      mock(builder).each.never
+      builder.public_send(method)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arel-helpers
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Cameron Dutro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-07 00:00:00.000000000 Z
+date: 2014-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,9 +17,9 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
-    - - <=
+    - - <
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +27,9 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 3.1.0
-    - - <=
+    - - <
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: '5'
 description: Useful tools to help construct database queries with ActiveRecord and
   Arel.
 email:
@@ -38,20 +38,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- History.txt
+- README.md
+- Rakefile
+- arel-helpers.gemspec
+- lib/arel-helpers.rb
 - lib/arel-helpers/arel_table.rb
 - lib/arel-helpers/join_association.rb
 - lib/arel-helpers/query_builder.rb
 - lib/arel-helpers/version.rb
-- lib/arel-helpers.rb
 - spec/arel_table_spec.rb
 - spec/join_association_spec.rb
 - spec/query_builder_spec.rb
 - spec/spec_helper.rb
-- Gemfile
-- History.txt
-- README.md
-- Rakefile
-- arel-helpers.gemspec
 homepage: http://github.com/camertron
 licenses: []
 metadata: {}
@@ -71,7 +71,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Useful tools to help construct database queries with ActiveRecord and Arel.