arel-helpers 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c161257669d03d28242c5a446035de4b2053fc75
+  data.tar.gz: ffaced6c4f32e3a1e80e2b3cca6b707aa0881f19
+SHA512:
+  metadata.gz: 14d97e90b02a189ad3b845853e6541396180f2257edbb3e22488bd4e2546fc8ef6520b703c20eb8e58acece20ec408705e0f348a4cd7ff60c80b9c2ac0b0ba1f
+  data.tar.gz: 6712fc03b8565754d297f854ec55bc765aae826e677355cb552681f11bb2192bec1cd0785307c470b01965ee1810df448e6812324ed0023bde7c3413f0a38c0b

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem 'pry-nav'
+  gem 'rake'
+end
+
+group :test do
+  gem 'rspec', '~> 2.11.0'
+  gem 'rr',    '~> 1.0.4'
+  gem 'sqlite3'
+end

data/History.txt

@@ -0,0 +1,3 @@
+== 1.0.0
+
+* Birthday! Includes join_association and arel_table helpers.

data/Rakefile

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+
+require 'bundler'
+require 'rspec/core/rake_task'
+require 'rubygems/package_task'
+
+require './lib/arel-helpers'
+
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = './spec/**/*_spec.rb'
+end

data/arel-helpers.gemspec

@@ -0,0 +1,20 @@
+$:.unshift File.join(File.dirname(__FILE__), 'lib')
+require 'arel-helpers/version'
+
+Gem::Specification.new do |s|
+  s.name     = "arel-helpers"
+  s.version  = ::ArelHelpers::VERSION
+  s.authors  = ["Cameron Dutro"]
+  s.email    = ["camertron@gmail.com"]
+  s.homepage = "http://github.com/camertron"
+
+  s.description = s.summary = "Useful tools to help construct database queries with ActiveRecord and Arel."
+
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+
+  s.add_dependency 'activerecord', '~> 3.0'
+
+  s.require_path = 'lib'
+  s.files = Dir["{lib,spec}/**/*", "Gemfile", "History.txt", "README.md", "Rakefile", "arel-helpers.gemspec"]
+end

data/lib/arel-helpers/arel_table.rb

@@ -0,0 +1,17 @@
+# encoding: UTF-8
+
+module ArelHelpers
+  module ArelTable
+
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      def [](name)
+        arel_table[name]
+      end
+
+    end
+
+  end
+end

data/lib/arel-helpers/join_association.rb

@@ -0,0 +1,33 @@
+# encoding: UTF-8
+
+module ArelHelpers
+  module JoinAssociation
+
+    # 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 returns a SelectManager 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)
+      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
+
+      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

data/lib/arel-helpers/version.rb

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

data/lib/arel-helpers.rb

@@ -0,0 +1,8 @@
+# encoding: UTF-8
+
+require 'active_record'
+
+module ArelHelpers
+  autoload :JoinAssociation, "arel-helpers/join_association"
+  autoload :ArelTable,       "arel-helpers/arel_table"
+end

data/spec/arel_table_spec.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe ArelHelpers::ArelTable 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"
+    end
+  end
+end

data/spec/join_association_spec.rb

@@ -0,0 +1,51 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe ArelHelpers::JoinAssociation do
+  include ArelHelpers::JoinAssociation
+
+  describe "#join_association" do
+    it "should work for a directly associated model" do
+      Post.joins(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 ==
+        '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|
+        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'
+    end
+
+    it "should work for two models, one directly associated and the other indirectly" do
+      Post
+        .joins(join_association(Post, :comments))
+        .joins(join_association(Comment, :commenter))
+        .to_sql.should ==
+          'SELECT "posts".* FROM "posts" INNER JOIN "comments" ON "comments"."post_id" = "posts"."id" INNER JOIN "commenters" ON "commenters"."comment_id" = "comments"."id"'
+    end
+
+    it "should be able to handle multiple associations" do
+      Post.joins(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|
+        case assoc_name
+          when :favorites
+            join_conditions.or(Favorite[:amount].eq("lots"))
+          when :comments
+            join_conditions.and(Comment[:text].eq("Awesome post!"))
+        end
+      end).to_sql.should ==
+        'SELECT "posts".* FROM "posts" INNER JOIN "comments" ON "comments"."post_id" = "posts"."id" AND "comments"."text" = \'Awesome post!\' INNER JOIN "favorites" (ON "favorites"."post_id" = "posts"."id" OR "favorites"."amount" = \'lots\')'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,92 @@
+# encoding: UTF-8
+
+require 'rspec'
+require 'arel-helpers'
+require 'fileutils'
+require 'pry-nav'
+
+def silence(&block)
+  original_stdout = $stdout
+  $stdout = StringIO.new
+  begin
+    yield
+  ensure
+    $stdout = original_stdout
+  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 :commenter
+end
+
+class Commenter < 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
+  end
+end
+
+class CreateCommentsTable < ActiveRecord::Migration
+  def change
+    create_table :comments do |t|
+      t.references :post
+    end
+  end
+end
+
+class CreateCommentersTable < ActiveRecord::Migration
+  def change
+    create_table :commenters 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
+      CreateCommentersTable.new.change
+      CreateFavoritesTable.new.change
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: arel-helpers
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cameron Dutro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Useful tools to help construct database queries with ActiveRecord and
+  Arel.
+email:
+- camertron@gmail.com
+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/version.rb
+- spec/arel_table_spec.rb
+- spec/join_association_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/camertron
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Useful tools to help construct database queries with ActiveRecord and Arel.
+test_files: []