arel-helpers 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74fd32a2a3bd64b02be9dbd561afe2add390752f
-  data.tar.gz: 78f91129ab6b88b3b93675de7a0e96f7ac9ef716
+  metadata.gz: ea16c7f7e25c5cfbfffefce34a8c9533b0843476
+  data.tar.gz: 1166b9bbb46d3752cd1dfbbbdca2af9722a1dd71
 SHA512:
-  metadata.gz: a8082544e84ddca08e248276682473fa8d2af08cd666fb2b76c2588cbf52546c8f9345805693dbd6929ec0a58f64e130f21a7fdb973374feb81f263a2b6fd65c
-  data.tar.gz: 0fa70969de2f89d8fa03c2b0747ca3da4c011e9399f74b4f9222611401df399bbd24ecd7e2e577e9600de21291a5f99d06559ca0648be1c1770b27ff08f902fa
+  metadata.gz: d84deff5d029af7d5309206e2ad6d085b606cdf4e8f71f75339ccd1dad828f03fdf625021110fcbf20768fb7d77122877a649d9eaea533fc043acdd9f683d28f
+  data.tar.gz: e3fa334933b5792e55d222696401c53bda1ace66ec973da7c27b5fe738f8506269434265cceda4aefb38b71c1bc771288520ebebbdd391004bd0ee088d26deef

data/History.txt

@@ -12,4 +12,9 @@
 
 == 2.0.0
 
-* Turning JoinAssociation into an ActiveSupport::Concern (breaks backwards compatibility).
+* 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)
+

data/Rakefile

@@ -16,3 +16,16 @@ desc 'Run specs'
 RSpec::Core::RakeTask.new do |t|
   t.pattern = './spec/**/*_spec.rb'
 end
+
+task :console do
+  $:.push(File.dirname(__FILE__))
+
+  require 'spec/env'
+  require 'pry-nav'
+
+  ArelHelpers::Env.establish_connection
+  ArelHelpers::Env.reset
+  ArelHelpers::Env.migrate
+
+  Pry.start
+end

data/lib/arel-helpers.rb

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

data/lib/arel-helpers/join_association.rb

@@ -5,63 +5,63 @@ module ArelHelpers
   module JoinAssociation
     extend ActiveSupport::Concern
 
-    included do
-      def self.join_association(association, join_type = Arel::InnerJoin, &block)
-        ArelHelpers.join_association(self, association, join_type, &block)
+    module ClassMethods
+      def join_association(*args, &block)
+        ArelHelpers::JoinAssociation.join_association(self, *args, &block)
       end
     end
 
-  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
+    class << self
+      # 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)
+        end
+      end
 
-  private
+      private
 
-  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)
+      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)
 
-    join_dependency.join_associations.each do |assoc|
-      assoc.join_type = join_type
-      assoc.join_to(manager)
-    end
+        join_dependency.join_associations.each do |assoc|
+          assoc.join_type = join_type
+          assoc.join_to(manager)
+        end
 
-    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
+        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
-    end
-  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, [])
+      def join_association_4_1(table, association, join_type)
+        associations = association.is_a?(Array) ? association : [association]
+        join_dependency = ActiveRecord::Associations::JoinDependency.new(table, associations, [])
 
-    join_dependency.join_constraints([]).map do |constraint|
-      right = if block_given?
-        yield constraint.left.name.to_sym, constraint.right
-      else
-        constraint.right
-      end
+        join_dependency.join_constraints([]).map do |constraint|
+          right = if block_given?
+                    yield constraint.left.name.to_sym, constraint.right
+                  else
+                    constraint.right
+                  end
 
-      join_type.new(constraint.left, right)
+          join_type.new(constraint.left, right)
+        end
+      end
     end
   end
-
 end

data/lib/arel-helpers/version.rb

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

data/spec/env.rb

@@ -0,0 +1,40 @@
+# encoding: UTF-8
+
+require 'env/models'
+require 'env/migrations'
+
+module ArelHelpers
+  class Env
+    class << self
+
+      def db_dir
+        @db_dir ||= File.join(File.dirname(File.dirname(__FILE__)), "tmp")
+      end
+
+      def db_file
+        @db_file ||= File.join(db_dir, "test.sqlite3")
+      end
+
+      def establish_connection
+        ActiveRecord::Base.establish_connection(
+          :adapter  => "sqlite3",
+          :database => db_file
+        )
+      end
+
+      def migrate
+        CreatePostsTable.new.change
+        CreateCommentsTable.new.change
+        CreateAuthorsTable.new.change
+        CreateFavoritesTable.new.change
+        CreateCollabPostsTable.new.change
+      end
+
+      def reset
+        File.unlink(db_file) if File.exist?(db_file)
+        FileUtils.mkdir_p(db_dir)
+      end
+
+    end
+  end
+end

data/spec/env/migrations.rb

@@ -0,0 +1,42 @@
+# encoding: UTF-8
+
+class CreatePostsTable < ActiveRecord::Migration
+  def change
+    create_table :posts do |t|
+      t.column :title, :string
+    end
+  end
+end
+
+class CreateCommentsTable < ActiveRecord::Migration
+  def change
+    create_table :comments do |t|
+      t.references :post
+    end
+  end
+end
+
+class CreateAuthorsTable < ActiveRecord::Migration
+  def change
+    create_table :authors do |t|
+      t.references :comment
+      t.references :collab_posts
+    end
+  end
+end
+
+class CreateFavoritesTable < ActiveRecord::Migration
+  def change
+    create_table :favorites do |t|
+      t.references :post
+    end
+  end
+end
+
+class CreateCollabPostsTable < ActiveRecord::Migration
+  def change
+    create_table :collab_posts do |t|
+      t.references :authors
+    end
+  end
+end

data/spec/env/models.rb

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+
+class Post < ActiveRecord::Base
+  include ArelHelpers::ArelTable
+  has_many :comments
+  has_many :favorites
+end
+
+class Comment < ActiveRecord::Base
+  include ArelHelpers::ArelTable
+  belongs_to :post
+  belongs_to :author
+end
+
+class Author < ActiveRecord::Base
+  include ArelHelpers::ArelTable
+  has_one :comment
+  has_and_belongs_to_many :collab_posts
+end
+
+class Favorite < ActiveRecord::Base
+  include ArelHelpers::ArelTable
+  belongs_to :post
+end
+
+class CollabPost < ActiveRecord::Base
+  include ArelHelpers::ArelTable
+  has_and_belongs_to_many :authors
+end

data/spec/join_association_spec.rb

@@ -26,7 +26,7 @@ describe ArelHelpers do
         .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"'
+          'SELECT "posts".* FROM "posts" INNER JOIN "comments" ON "comments"."post_id" = "posts"."id" INNER JOIN "authors" ON "authors"."id" = "comments"."author_id"'
     end
 
     it "should be able to handle multiple associations" do

data/spec/spec_helper.rb

@@ -1,10 +1,14 @@
 # encoding: UTF-8
 
+$:.push(File.dirname(__FILE__))
+
 require 'rspec'
 require 'arel-helpers'
 require 'fileutils'
 require 'pry-nav'
 
+require 'env'
+
 def silence(&block)
   original_stdout = $stdout
   $stdout = StringIO.new
@@ -15,80 +19,12 @@ def silence(&block)
   end
 end
 
-class Post < ActiveRecord::Base
-  include ArelHelpers::ArelTable
-  has_many :comments
-  has_many :favorites
-end
-
-class Comment < ActiveRecord::Base
-  include ArelHelpers::ArelTable
-  belongs_to :post
-  has_one :author
-end
-
-class Author < ActiveRecord::Base
-  include ArelHelpers::ArelTable
-  belongs_to :comment
-end
-
-class Favorite < ActiveRecord::Base
-  include ArelHelpers::ArelTable
-  belongs_to :post
-end
-
-class CreatePostsTable < ActiveRecord::Migration
-  def change
-    create_table :posts do |t|
-      t.column :title, :string
-    end
-  end
-end
-
-class CreateCommentsTable < ActiveRecord::Migration
-  def change
-    create_table :comments do |t|
-      t.references :post
-    end
-  end
-end
-
-class CreateAuthorsTable < ActiveRecord::Migration
-  def change
-    create_table :authors do |t|
-      t.references :comment
-    end
-  end
-end
-
-class CreateFavoritesTable < ActiveRecord::Migration
-  def change
-    create_table :favorites do |t|
-      t.references :post
-    end
-  end
-end
-
 RSpec.configure do |config|
   config.mock_with :rr
 
-  db_dir = File.join(File.dirname(File.dirname(__FILE__)), "tmp")
-  db_file = File.join(db_dir, "test.sqlite3")
-
   config.before(:each) do
-    File.unlink(db_file) if File.exist?(db_file)
-    FileUtils.mkdir_p(db_dir)
-
-    ActiveRecord::Base.establish_connection(
-      :adapter  => "sqlite3",
-      :database => db_file
-    )
-
-    silence do
-      CreatePostsTable.new.change
-      CreateCommentsTable.new.change
-      CreateAuthorsTable.new.change
-      CreateFavoritesTable.new.change
-    end
+    ArelHelpers::Env.establish_connection
+    ArelHelpers::Env.reset
+    silence { ArelHelpers::Env.migrate }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arel-helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Cameron Dutro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-22 00:00:00.000000000 Z
+date: 2014-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -49,6 +49,9 @@ files:
 - lib/arel-helpers/query_builder.rb
 - lib/arel-helpers/version.rb
 - spec/arel_table_spec.rb
+- spec/env.rb
+- spec/env/migrations.rb
+- spec/env/models.rb
 - spec/join_association_spec.rb
 - spec/query_builder_spec.rb
 - spec/spec_helper.rb