extended_joins_impl 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 403d54fe3888676bfdc11699909314b277236c1d
+  data.tar.gz: cfe6bd058d44fd9216c01f2d175d739150b646c4
+SHA512:
+  metadata.gz: 44f5f7b04a8fa77b81cffdf2aa4f523eed713463695fd0b3b0f06c6324ea6d0c4fe5780518520364944afbaa56a3d6a8ebde25ed6bc7aece7b69d55293ca76d0
+  data.tar.gz: b462edba146c8af41d91cd1413384dbad62100b57e2572489e9b9a336d276d9930ff5baa007e47b2958b9bedcd50144cab696c06122bb31c9c5e6759f0fd05b3

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+env:
+  - "RAILS_VERSION=4.0.0"
+  - "RAILS_VERSION=3.2.0"
+branches:
+  only:
+    - master
+    - develop

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in extended_joins_impl.gemspec
+gemspec
+
+rails_version = ENV['RAILS_VERSION'] || 'default'
+
+rails = case rails_version
+          when 'master'
+            { :github => 'rails/rails' }
+          when 'default'
+            '~> 3.2.0'
+          else
+            "~> #{rails_version}"
+        end
+
+gem 'rails', rails

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 MnrUchida
+
+MIT License
+
+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,65 @@
+# ExtendedJoinsImpl
+
+Syntactic sugar for using a subquery and left outer join in ActiveRecord
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'extended_joins_impl'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install extended_joins_impl
+
+## Usage
+In these case
+
+    class User < ActiveRecord::Base
+      belongs_to :type
+      has_many :user_notes,
+               class_name: "Note",
+               primary_key: :code,
+               foreign_key: :user_code
+
+    end
+
+    class Type < ActiveRecord::Base
+    end
+
+    class Note < ActiveRecord::Base
+    end
+
+    # SELECT users.* FROM users INNER JOIN (SELECT * FROM types) types ON users.type_id = types.id
+    User.scoped.extended_joins(:inner, Type.scoped)
+
+    # SELECT users.* FROM users LEFT OUTER JOIN (SELECT * FROM types) types ON users.type_id = types.id
+    User.scoped.extended_joins(:outer, Type.scoped)
+
+    # SELECT users.* FROM users INNER JOIN (SELECT * FROM types WHERE id = 3) types ON users.type_id = types.id
+    User.scoped.extended_joins(:inner, Type.where(id: 3)
+
+    # SELECT users.* FROM users INNER JOIN (SELECT * FROM types) user_types ON users.type_id = user_types.id
+    User.scoped.extended_joins(:inner, Type.scoped, as: "user_types")
+
+    # SELECT users.* FROM users INNER JOIN (SELECT * FROM notes) notes ON users.code = notes.user_code
+    User.scoped.extended_joins(:inner, Note.scoped, on: {code: :user_code})
+
+    # SELECT users.* FROM users INNER JOIN (SELECT * FROM notes) notes ON users.id = notes.user_id AND notes.user_code = 3
+    User.scoped.extended_joins(:inner, Note.scoped, where: {user_code: 3})
+
+    # if alias name is same as association name
+    # SELECT users.* FROM users INNER JOIN (SELECT * FROM notes) notes ON users.code = notes.user_code
+    User.scoped.extended_joins(:inner, Note.scoped, as: "user_notes")
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/extended_joins_impl/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+# coding: utf-8
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Default: run specs.'
+task :default => :spec

data/extended_joins_impl.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'extended_joins_impl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "extended_joins_impl"
+  spec.version       = ExtendedJoinsImpl::VERSION
+  spec.authors       = ["MnrUchida"]
+  spec.email         = ["mukenan108@gmail.com"]
+  spec.summary       = %q{Syntactic sugar for ActiveRecord.}
+  spec.description   = %q{Syntactic sugar for using a subquery and left outer join in ActiveRecord}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency "rspec"
+end

data/lib/extended_joins_impl/version.rb

@@ -0,0 +1,3 @@
+module ExtendedJoinsImpl
+  VERSION = "0.0.1"
+end

data/lib/extended_joins_impl.rb

@@ -0,0 +1,52 @@
+require "extended_joins_impl/version"
+
+module ExtendedJoinsImpl
+  def extended_joins(join_type, table, params={})
+    on_key = params[:on] || default_condition(table.table_name, params[:as])
+
+    joins_table_name = params[:as] || table.table_name
+    table_arel = table.arel.as(joins_table_name.to_s)
+
+    condition = nil
+    on_key.each do |left, right|
+      right_value = right.class == Symbol ? table_arel[right.to_sym] : right
+
+      a_condition = self.arel_table[left.to_sym].eq(right_value)
+      if condition.present?
+        condition = condition.and(a_condition)
+      else
+        condition = a_condition
+      end
+    end
+    if params[:where].present?
+      params[:where].each {|right, value| condition = condition.and(table_arel[right.to_sym].eq(value)) }
+    end
+
+    join_node = (join_type == :outer) ? Arel::Nodes::OuterJoin : Arel::Nodes::InnerJoin
+    join_state = join_node.new( table_arel, Arel::Nodes::On.new(condition))
+
+    self.joins(join_state.to_sql)
+  end
+
+  private
+  def default_condition(table_name, alias_name)
+    association = reflect_on_association(alias_name.to_sym) if alias_name.present?
+    if association.blank?
+      association = reflect_on_association(table_name.singularize.to_sym) ||
+          reflect_on_association(table_name.to_sym)
+    end
+
+    options = association.try(:options) || {}
+    if association.try(:macro) == :belongs_to
+      {(options[:foreign_key] || "#{table_name.singularize}_id") => (options[:primary_key] || :id)}
+    else
+      {(options[:primary_key] || :id) => (options[:foreign_key] || "#{self.table_name.singularize}_id".to_sym)}
+    end
+  end
+end
+
+module ActiveRecord
+  class Relation
+    include ExtendedJoinsImpl
+  end
+end

data/spec/extended_joins_impl_spec.rb

@@ -0,0 +1,53 @@
+# coding: utf-8
+require 'spec_helper'
+require 'extended_joins_impl'
+
+describe ExtendedJoinsImpl do
+
+  it "inner join" do
+    sql = User.where(nil).extended_joins(:inner, Type.where(nil)).to_sql
+    expect(sql).to include "INNER JOIN"
+    expect(sql).to include "\"users\".\"type_id\" = types.\"id\""
+  end
+
+  it "left outer join" do
+    sql = User.where(nil).extended_joins(:outer, Type.where(nil)).to_sql
+    expect(sql).to include "LEFT OUTER JOIN"
+    expect(sql).to include "\"users\".\"type_id\" = types.\"id\""
+  end
+
+  it "subquery join" do
+    sql = User.where(nil).extended_joins(:outer, Type.where(id: 3)).to_sql
+    expect(sql).to include "LEFT OUTER JOIN"
+    expect(sql).to include "\"users\".\"type_id\" = types.\"id\""
+    expect(sql).to include "WHERE \"types\".\"id\" = 3"
+  end
+
+  it "join alias" do
+    sql = User.where(nil).extended_joins(:outer, Type.where(id: 3), as: "user_types").to_sql
+    expect(sql).to include "LEFT OUTER JOIN"
+    expect(sql).to include "\"users\".\"type_id\" = user_types.\"id\""
+    expect(sql).to include "WHERE \"types\".\"id\" = 3"
+  end
+
+  it "join on condition" do
+    sql = User.where(nil).extended_joins(:inner, Note.where(nil), on: {code: :user_code}).to_sql
+    expect(sql).to include "INNER JOIN"
+    expect(sql).to include "\"users\".\"code\" = notes.\"user_code\""
+  end
+
+  it "join on constant" do
+    sql = User.where(nil).extended_joins(:inner, Note.where(nil), where: {id: 3, user_code: 4}).to_sql
+    expect(sql).to include "INNER JOIN"
+    expect(sql).to include "\"users\".\"id\" = notes.\"user_id\""
+    expect(sql).to include "notes.\"id\" = 3"
+    expect(sql).to include "notes.\"user_code\" = 4"
+  end
+
+  it "join with association" do
+    sql = User.where(nil).extended_joins(:inner, Note.where(nil), as: "user_notes").to_sql
+    expect(sql).to include "INNER JOIN"
+    expect(sql).to include "\"users\".\"code\" = user_notes.\"user_code\""
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+## coding: utf-8
+require 'rubygems'
+require 'active_record'
+require File.expand_path('../support/schema.rb', __FILE__)
+require File.expand_path('../support/models.rb', __FILE__)

data/spec/support/models.rb

@@ -0,0 +1,15 @@
+# coding: utf-8
+class User < ActiveRecord::Base
+  belongs_to :type
+  has_many :user_notes,
+           class_name: "Note",
+           primary_key: :code,
+           foreign_key: :user_code
+
+end
+
+class Type < ActiveRecord::Base
+end
+
+class Note < ActiveRecord::Base
+end

data/spec/support/schema.rb

@@ -0,0 +1,22 @@
+# coding: utf-8
+ActiveRecord::Base.establish_connection(
+    :adapter  => 'sqlite3',
+    :database => ':memory:'
+)
+
+ActiveRecord::Schema.define do
+  create_table :users, :force => true do |t|
+    t.references :type
+    t.integer :code
+    t.timestamps
+  end
+
+  create_table :types, :force => true do |t|
+    t.timestamps
+  end
+
+  create_table :notes, :force => true do |t|
+    t.references :user
+    t.integer :user_code
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: extended_joins_impl
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- MnrUchida
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: Syntactic sugar for using a subquery and left outer join in ActiveRecord
+email:
+- mukenan108@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- extended_joins_impl.gemspec
+- lib/extended_joins_impl.rb
+- lib/extended_joins_impl/version.rb
+- spec/extended_joins_impl_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+homepage: ''
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Syntactic sugar for ActiveRecord.
+test_files:
+- spec/extended_joins_impl_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+has_rdoc: