ar_outer_joins 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+bundler_stubs

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in ar_outer_joins.gemspec
+gemspec

data/README.md

@@ -0,0 +1,52 @@
+# ActiveRecord Outer Joins
+
+This gem adds support for the missing `.outer_joins` method. For the most part
+it behaves exactly the same as `.joins`, except that it creates an outer join
+instead of an inner join. If you don't know why that would be useful, this gem
+is probably not for you.
+
+## Installation
+
+``` ruby
+gem "ar_outer_joins"
+```
+
+## Usage
+
+``` ruby
+require "active_record"
+require "ar_outer_joins"
+
+class Product
+  belongs_to :category
+
+  def published
+    outer_joins(:category).where("categories.published = ? OR products.published = ?", true, true)
+  end
+end
+```
+
+# License
+
+(The MIT License)
+
+Copyright (c) 2012 Jonas Nicklas, Elabs AB
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/ar_outer_joins.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ar_outer_joins/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jonas Nicklas", "Elabs AB"]
+  gem.email         = ["jonas.nicklas@gmail.com", "dev@elabs.se"]
+  gem.description   = %q{Adds the missing outer_joins method to ActiveRecord}
+  gem.summary       = %q{outer_joins for ActiveRecord}
+  gem.homepage      = "http://github.com/elabs/ar_outer_joins"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "ar_outer_joins"
+  gem.require_paths = ["lib"]
+  gem.version       = ArOuterJoins::VERSION
+
+  gem.add_dependency "activerecord", "~>3.2"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "pry"
+end

data/lib/ar_outer_joins.rb

@@ -0,0 +1,15 @@
+require "active_record"
+require "ar_outer_joins/version"
+require "ar_outer_joins/join_builder"
+require "ar_outer_joins/join"
+
+module ArOuterJoins
+  def outer_joins(*joins)
+    association_joins, regular_joins = joins.partition do |join|
+      join.is_a?(Hash) or join.is_a?(Array) or join.is_a?(Symbol)
+    end
+    Join.new(self).apply(*association_joins).joins(*regular_joins)
+  end
+end
+
+ActiveRecord::Base.extend ArOuterJoins

data/lib/ar_outer_joins/join.rb

@@ -0,0 +1,26 @@
+module ArOuterJoins
+  class Join
+    attr_reader :klass
+
+    def initialize(klass)
+      @klass = klass
+    end
+
+    def generate(*args)
+      args.flatten.compact.map do |arg|
+        if arg.is_a?(Hash)
+          arg.map do |key, value|
+            association = klass.reflect_on_association(key)
+            generate(key) + Join.new(association.klass).generate(value)
+          end
+        else
+          JoinBuilder.new(klass.reflect_on_association(arg)).build
+        end
+      end
+    end
+
+    def apply(*args)
+      klass.joins(generate(*args))
+    end
+  end
+end

data/lib/ar_outer_joins/join_builder.rb

@@ -0,0 +1,43 @@
+module ArOuterJoins
+  class JoinBuilder
+    class OuterJoinError < StandardError; end
+
+    attr_reader :association
+
+    def initialize(association)
+      @association = association
+    end
+
+    def build
+      if association.is_a? ActiveRecord::Reflection::ThroughReflection
+        [
+          JoinBuilder.new(association.through_reflection).build,
+          JoinBuilder.new(association.source_reflection).build
+        ].flatten
+      else
+        table = association.active_record.arel_table
+        primary_key = association.active_record.primary_key
+        joined_table = association.klass.arel_table
+
+        case association.macro
+        when :belongs_to
+          on = Arel::Nodes::On.new(table[association.foreign_key].eq(joined_table[primary_key]))
+          [Arel::Nodes::OuterJoin.new(joined_table, on)]
+        when :has_and_belongs_to_many
+          join_model_table = Arel::Table.new(association.options[:join_table])
+          joined_primary_key = association.klass.primary_key
+
+          on1 = Arel::Nodes::On.new(join_model_table[association.foreign_key].eq(table[primary_key]))
+          on2 = Arel::Nodes::On.new(join_model_table[association.association_foreign_key].eq(joined_table[joined_primary_key]))
+
+          [Arel::Nodes::OuterJoin.new(join_model_table, on1), Arel::Nodes::OuterJoin.new(joined_table, on2)]
+        when :has_many, :has_one
+          on = Arel::Nodes::On.new(joined_table[association.foreign_key].eq(table[primary_key]))
+          [Arel::Nodes::OuterJoin.new(joined_table, on)]
+        else
+          raise OuterJoinError, "don't know what to do with #{association.macro} association"
+        end
+      end
+    end
+  end
+end

data/lib/ar_outer_joins/version.rb

@@ -0,0 +1,3 @@
+module ArOuterJoins
+  VERSION = "0.1.0"
+end

data/spec/outer_join_spec.rb

@@ -0,0 +1,200 @@
+require "spec_helper"
+
+class Product < ActiveRecord::Base
+  belongs_to :category
+  belongs_to :site
+  has_many :line_items
+  has_many :baskets, :through => :line_items
+  has_many :discounts, :through => :line_items
+  has_and_belongs_to_many :tags
+  has_one :image
+end
+
+class LineItem < ActiveRecord::Base
+  belongs_to :basket
+  belongs_to :product
+  has_many :discounts
+end
+
+class Image < ActiveRecord::Base
+  belongs_to :product
+end
+
+class Discount < ActiveRecord::Base
+  belongs_to :line_item
+end
+
+class Basket < ActiveRecord::Base; end
+class Category < ActiveRecord::Base; end
+class Site < ActiveRecord::Base; end
+class Tag < ActiveRecord::Base; end
+
+describe ActiveRecord::Base do
+  describe ".outer_joins" do
+    context "with belongs_to" do
+      it "performs an outer join" do
+        category1 = Category.create! :name => "Shoes"
+        category2 = Category.create! :name => "Shirts"
+        product1 = Product.create! :category => category1
+        product2 = Product.create! :category => category2
+        product3 = Product.create! :published => true
+        query = Product.outer_joins(:category).where("categories.name = ? OR products.published = ?", "Shirts", true)
+        query.all.should =~ [product2, product3]
+      end
+
+      it "joins several associations" do
+        site1 = Site.create! :name => "Elabs"
+        category1 = Category.create! :name => "Shoes"
+        category2 = Category.create! :name => "Shirts"
+        product1 = Product.create! :category => category1
+        product2 = Product.create! :category => category2
+        product3 = Product.create! :published => true
+        product4 = Product.create! :site => site1
+        query = Product.outer_joins(:category, :site).where("sites.name = ? OR categories.name = ? OR products.published = ?", "Elabs", "Shirts", true)
+        query.all.should =~ [product2, product3, product4]
+      end
+    end
+
+    context "with has_one" do
+      it "performs an outer join" do
+        product1 = Product.create!
+        product2 = Product.create!
+        product3 = Product.create! :published => true
+        product4 = Product.create!
+
+        Image.create! :highres => true, :product => product1
+        Image.create! :product => product2
+
+        query = Product.outer_joins(:image).where("images.highres = ? OR products.published = ?", true, true)
+        query.all.should =~ [product1, product3]
+      end
+    end
+
+    context "with has_many" do
+      it "performs an outer join" do
+        product1 = Product.create!
+        product2 = Product.create!
+        product3 = Product.create! :published => true
+        product4 = Product.create!
+
+        LineItem.create! :price => 4, :product => product1
+        LineItem.create! :product => product2
+
+        query = Product.outer_joins(:line_items).where("line_items.price = ? OR products.published = ?", 4, true)
+        query.all.should =~ [product1, product3]
+      end
+    end
+
+    context "with has_and_belongs_to_many" do
+      it "performs an outer join" do
+        red = Tag.create! :name => "Red"
+        blue = Tag.create! :name => "Blue"
+
+        product1 = Product.create!
+        product2 = Product.create! :tags => [red]
+        product3 = Product.create! :tags => [red, blue]
+        product4 = Product.create! :published => true
+
+
+        query = Product.outer_joins(:tags).where("tags.name = ? OR products.published = ?", "Red", true)
+        query.all.should =~ [product2, product3, product4]
+      end
+    end
+
+    context "with has_many :through" do
+      it "performs an outer join" do
+        product1 = Product.create!
+        product2 = Product.create!
+        product3 = Product.create! :published => true
+        product4 = Product.create!
+
+        basket1 = Basket.create! :purchased => true
+        basket2 = Basket.create! :purchased => false
+
+        LineItem.create! :product => product1, :basket => basket1
+        LineItem.create! :product => product2, :basket => basket2
+        LineItem.create! :product => product3
+
+        query = Product.outer_joins(:baskets).where("baskets.purchased = ? OR products.published = ?", true, true)
+        query.all.should =~ [product1, product3]
+      end
+    end
+
+    context "with nested associations" do
+      it "allows hashes" do
+        product1 = Product.create!
+        product2 = Product.create!
+        product3 = Product.create! :published => true
+        product4 = Product.create!
+
+        basket1 = Basket.create! :purchased => true
+        basket2 = Basket.create! :purchased => false
+
+        LineItem.create! :product => product1, :basket => basket1
+        LineItem.create! :product => product2, :basket => basket2
+        LineItem.create! :product => product3
+
+        query = Product.outer_joins(:line_items => :basket).where("baskets.purchased = ? OR products.published = ?", true, true)
+        query.all.should =~ [product1, product3]
+      end
+
+      it "allows hashes with arrays" do
+        product1 = Product.create!
+        product2 = Product.create!
+        product3 = Product.create! :published => true
+        product4 = Product.create!
+
+        basket1 = Basket.create! :purchased => true
+        basket2 = Basket.create! :purchased => false
+
+        line_item1 = LineItem.create! :product => product1, :basket => basket1
+        line_item2 = LineItem.create! :product => product2, :basket => basket2
+        line_item3 = LineItem.create! :product => product4
+
+        Discount.create! :line_item => line_item3, :percentage => 80
+
+        query = Product.outer_joins(:line_items => [:basket, :discounts]).where("baskets.purchased = ? OR products.published = ? OR discounts.percentage > ?", true, true, 50)
+        query.all.should =~ [product1, product3, product4]
+      end
+    end
+
+    context "with raw hash" do
+      it "allows a join as a string" do
+        category1 = Category.create! :name => "Shoes"
+        category2 = Category.create! :name => "Shirts"
+        product1 = Product.create! :category => category1
+        product2 = Product.create! :category => category2
+        product3 = Product.create! :published => true
+        query = Product.outer_joins("LEFT OUTER JOIN categories ON products.category_id = categories.id")
+        query = query.where("categories.name = ? OR products.published = ?", "Shirts", true)
+        query.all.should =~ [product2, product3]
+      end
+
+      it "allows multiple joins" do
+        category1 = Category.create! :name => "Shoes"
+        category2 = Category.create! :name => "Shirts"
+        product1 = Product.create! :category => category1
+        product2 = Product.create! :category => category2
+        product3 = Product.create! :published => true
+        query = Product.outer_joins(:line_items, "LEFT OUTER JOIN categories ON products.category_id = categories.id")
+        query = query.where("categories.name = ? OR products.published = ?", "Shirts", true)
+        query.all.should =~ [product2, product3]
+      end
+
+      it "allows arel joins" do
+        category1 = Category.create! :name => "Shoes"
+        category2 = Category.create! :name => "Shirts"
+        product1 = Product.create! :category => category1
+        product2 = Product.create! :category => category2
+        product3 = Product.create! :published => true
+
+        on = Arel::Nodes::On.new(Product.arel_table[:category_id].eq(Category.arel_table[:id]))
+        join = Arel::Nodes::OuterJoin.new(Category.arel_table, on)
+
+        query = Product.outer_joins(join)
+        query = query.where("categories.name = ? OR products.published = ?", "Shirts", true)
+        query.all.should =~ [product2, product3]
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,57 @@
+require "active_record"
+require "ar_outer_joins"
+require "pry"
+
+ActiveRecord::Base.establish_connection :adapter => "sqlite3", :database => ":memory:"
+
+ActiveRecord::Base.connection.create_table :products do |t|
+  t.integer :category_id
+  t.integer :site_id
+  t.boolean :published, :default => false, :null => false
+end
+
+ActiveRecord::Base.connection.create_table :line_items do |t|
+  t.integer :product_id
+  t.integer :basket_id
+  t.integer :discount_id
+  t.integer :price, :default => 0, :null => false
+end
+
+ActiveRecord::Base.connection.create_table :baskets do |t|
+  t.boolean :purchased, :default => false, :null => false
+end
+
+ActiveRecord::Base.connection.create_table :categories do |t|
+  t.string :name
+end
+
+ActiveRecord::Base.connection.create_table :sites do |t|
+  t.string :name
+end
+
+ActiveRecord::Base.connection.create_table :discounts do |t|
+  t.integer :percentage, :default => 0, :null => false
+  t.integer :line_item_id
+end
+
+ActiveRecord::Base.connection.create_table :tags do |t|
+  t.string :name
+end
+
+ActiveRecord::Base.connection.create_table :products_tags, :id => false do |t|
+  t.integer :product_id, :tag_id
+end
+
+ActiveRecord::Base.connection.create_table :images do |t|
+  t.boolean :highres, :default => false, :null => false
+  t.integer :product_id
+end
+
+RSpec.configure do |config|
+  config.around do |example|
+    ActiveRecord::Base.transaction do
+      example.run
+      raise ActiveRecord::Rollback
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: ar_outer_joins
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jonas Nicklas
+- Elabs AB
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &2159798540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2159798540
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2159798120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2159798120
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2159797660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2159797660
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &2159797200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2159797200
+description: Adds the missing outer_joins method to ActiveRecord
+email:
+- jonas.nicklas@gmail.com
+- dev@elabs.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- ar_outer_joins.gemspec
+- lib/ar_outer_joins.rb
+- lib/ar_outer_joins/join.rb
+- lib/ar_outer_joins/join_builder.rb
+- lib/ar_outer_joins/version.rb
+- spec/outer_join_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/elabs/ar_outer_joins
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: outer_joins for ActiveRecord
+test_files:
+- spec/outer_join_spec.rb
+- spec/spec_helper.rb
+has_rdoc: