left_join 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c226ac4666aed1a80fcc689ace520632c2ea831f
+  data.tar.gz: 402f3e1674f93254b76a6c79bb01c4617899b96e
+SHA512:
+  metadata.gz: acf5969fefa5c6a2a89ad968e45e6e860dd645582e361be7716ce543f5c0379ebde0620c0c3aa6f45d39994bc946ed2636c7d0360b571cdced988e5c4e62777f
+  data.tar.gz: 85e33528364c50b89d5c02ef42882d5111e69263bcecbe31b4625adeb8fcc5ab81021edd63dd2cdb698c54538b7eced80e8637b22ce6b27db467aa0fcae5c2f9

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source 'http://rubygems.org'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'rspec', '~> 3.3.0'
+  gem 'rdoc', '~> 3.12'
+  gem 'bundler', '~> 1.0'
+  gem 'jeweler', '~> 2.0.1'
+  gem 'simplecov', '>= 0'
+  gem 'sqlite3'
+  gem 'activerecord'
+end

data/Gemfile.lock

@@ -0,0 +1,102 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (4.2.4)
+      activesupport (= 4.2.4)
+      builder (~> 3.1)
+    activerecord (4.2.4)
+      activemodel (= 4.2.4)
+      activesupport (= 4.2.4)
+      arel (~> 6.0)
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.8)
+    arel (6.0.3)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.12.4)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.6)
+      oauth2
+    hashie (3.4.2)
+    highline (1.7.7)
+    i18n (0.7.0)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.3)
+    jwt (1.5.1)
+    mini_portile (0.6.2)
+    minitest (5.8.0)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.6.4)
+    rake (10.4.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    sqlite3 (1.3.10)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  bundler (~> 1.0)
+  jeweler (~> 2.0.1)
+  rdoc (~> 3.12)
+  rspec (~> 3.3.0)
+  simplecov
+  sqlite3
+
+BUNDLED WITH
+   1.10.6

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Diego Aguir Selzlein
+
+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/README.md

@@ -0,0 +1,43 @@
+# left_join
+
+This gem helps you doing `LEFT JOIN`s between your ActiveRecord associations, so
+you can do this:
+
+```ruby
+Book.left_join(:category)
+# SELECT "books".* FROM "books"
+# LEFT OUTER JOIN "categories"
+# ON "books"."category_id" = "categories"."id"
+```
+
+## Why?
+
+See [this blog post](http://nerde.github.io/posts/a-better-left-join-with-active-record/)
+for details.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'left_join'
+```
+
+Or install it manually
+
+```
+gem install left_join
+```
+
+## Contributing
+
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a
+future version unintentionally.
+* Create a pull request.
+
+## Copyright
+
+Copyright (c) 2015 Diego Aguir Selzlein. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification...
+  # see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = 'left_join'
+  gem.homepage = 'http://github.com/nerde/left_join'
+  gem.license = 'MIT'
+  gem.summary = 'LEFT JOIN with ActiveRecord'
+  gem.description = 'This gem helps doing LEFT JOIN\'s between ActiveRecord '\
+                    'associations'
+  gem.email = 'diegoselzlein@gmail.com'
+  gem.authors = ['Diego Aguir Selzlein']
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Code coverage detail'
+task :simplecov do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['spec'].execute
+end
+
+task default: :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "left_join #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/left_join.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: left_join 0.1.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "left_join"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Diego Aguir Selzlein"]
+  s.date = "2015-10-09"
+  s.description = "This gem helps doing LEFT JOIN's between ActiveRecord associations"
+  s.email = "diegoselzlein@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "left_join.gemspec",
+    "lib/left_join.rb",
+    "lib/left_join/adapters/active_record_adapter.rb",
+    "lib/left_join/node.rb",
+    "spec/left_join_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/nerde/left_join"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.5.1"
+  s.summary = "LEFT JOIN with ActiveRecord"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 3.3.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<activerecord>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 3.3.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<activerecord>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 3.3.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<activerecord>, [">= 0"])
+  end
+end
+

data/lib/left_join.rb

@@ -0,0 +1,23 @@
+module LeftJoin
+  autoload :Node, 'left_join/node'
+
+  def self.parse_to_nodes(arguments, context)
+    [].tap do |result|
+      case arguments
+      when Hash
+        arguments.each do |key, value|
+          result.concat parse_to_nodes(key, context)
+          result.concat parse_to_nodes(value, context.left_join_subcontext(key))
+        end
+      when Array
+        arguments.each do |value|
+          result.concat parse_to_nodes(value, context)
+        end
+      else
+        result << context.node_for_left_join(arguments)
+      end
+    end
+  end
+end
+
+require 'left_join/adapters/active_record_adapter'

data/lib/left_join/adapters/active_record_adapter.rb

@@ -0,0 +1,43 @@
+module LeftJoin
+  module Adapters
+    module ActiveRecordAdapter
+      # Does a left join through an association. Usage:
+      #
+      #     Book.left_join(:category)
+      #     # SELECT "books".* FROM "books"
+      #     # LEFT OUTER JOIN "categories"
+      #     # ON "books"."category_id" = "categories"."id"
+      #
+      # It also works through association's associations, like `joins` does:
+      #
+      #     Book.left_join(category: :master_category)
+      def left_join(*columns)
+        LeftJoin.parse_to_nodes(columns, self).inject(all) do |acc, association|
+          table = association.active_record.arel_table
+          join_table = association.klass.arel_table
+          foreign_key = association.foreign_key
+          primary_key = association.association_primary_key.to_sym
+          unless association.belongs_to?
+            foreign_key, primary_key = primary_key, foreign_key
+          end
+
+          arel_join = table.join(join_table, Arel::Nodes::OuterJoin) \
+                      .on(table[foreign_key].eq(join_table[primary_key]))
+          acc.joins(arel_join.join_sources)
+        end
+      end
+
+      def node_for_left_join(key)
+        reflect_on_association(key) ||
+          fail("#{self} has no association: #{key}.")
+      end
+
+      def left_join_subcontext(key)
+        node_for_left_join(key).klass
+      end
+    end
+
+    ActiveRecord::Base.extend ActiveRecordAdapter if defined?(ActiveRecord)
+  end
+end
+

data/lib/left_join/node.rb

@@ -0,0 +1 @@
+LeftJoin::Node = Struct.new(:key, :context)

data/spec/left_join_spec.rb

@@ -0,0 +1,50 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class Category < ActiveRecord::Base
+  has_many :books
+end
+
+class Author < ActiveRecord::Base
+  has_many :books
+end
+
+class Book < ActiveRecord::Base
+  belongs_to :author
+  belongs_to :category
+end
+
+describe 'LeftJoin' do
+  it 'generates a LEFT OUTER JOIN SQL' do
+    expect(Book.left_join(:category).to_sql).to eq(
+      "SELECT \"books\".* FROM \"books\" LEFT OUTER JOIN \"categories\" ON "\
+      "\"books\".\"category_id\" = \"categories\".\"id\"")
+  end
+
+  it 'works with nested associations' do
+    expect(Category.left_join(books: :author).to_sql).to eq(
+      "SELECT \"categories\".* FROM \"categories\" "\
+      "LEFT OUTER JOIN \"books\" ON "\
+      "\"categories\".\"id\" = \"books\".\"category_id\" "\
+      "LEFT OUTER JOIN \"authors\" ON "\
+      "\"books\".\"author_id\" = \"authors\".\"id\"")
+  end
+
+  it 'parses single argument to nodes' do
+    expect(LeftJoin.parse_to_nodes(:category, Book)).to eq [
+      Book.reflect_on_association(:category)]
+  end
+
+  it 'parses array argument to nodes' do
+    expect(LeftJoin.parse_to_nodes([:category, :author], Book)).to eq [
+      Book.reflect_on_association(:category),
+      Book.reflect_on_association(:author)
+    ]
+  end
+
+  it 'parses hash argument to nodes' do
+    expect(LeftJoin.parse_to_nodes({ books: :author }, Category)).to eq [
+      Category.reflect_on_association(:books),
+      Book.reflect_on_association(:author)
+    ]
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,48 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_profile 'test_frameworks'
+end
+
+ENV['COVERAGE'] && SimpleCov.start do
+  add_filter '/.rvm/'
+  add_filter '/.rbenv/'
+end
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'active_record'
+require 'left_join'
+require 'rspec'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    ActiveRecord::Base.establish_connection adapter: 'sqlite3',
+                                            database: ':memory:'
+    ActiveRecord::Schema.define do
+      create_table :books do |t|
+        t.string :name
+        t.integer :category_id
+      end
+
+      create_table :authors do |t|
+        t.string :name
+      end
+
+      create_table :categories do |t|
+        t.string :name
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: left_join
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Diego Aguir Selzlein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem helps doing LEFT JOIN's between ActiveRecord associations
+email: diegoselzlein@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- left_join.gemspec
+- lib/left_join.rb
+- lib/left_join/adapters/active_record_adapter.rb
+- lib/left_join/node.rb
+- spec/left_join_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/nerde/left_join
+licenses:
+- MIT
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: LEFT JOIN with ActiveRecord
+test_files: []