activerecord-hierarchical_query 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c5308c4928b4519b1501e578fbe930058261e65
-  data.tar.gz: d466545e9b356e702a16a5ac6ee9b6fdc0ac37fe
+  metadata.gz: 71bc88ee032e123ae1e612a9a589e5ee4b3f87b2
+  data.tar.gz: e8dea5c43cd1b41450635836f4a56bdcb95a77ce
 SHA512:
-  metadata.gz: 3e9ba821eecd7ad1f1e495c6280464b9e6dd75ce080b9251176441a63d2ca4f05e7d8c1c4f7cfe13eb027714791a01fb3e24476ac9de1511490e8f133d3d36a7
-  data.tar.gz: 5e1ef94d4c80629485d4092e26f534b7b003890337d89cefbd52ead9d21ca4864fe3df9610a03d46df7c009f8e56e3797641738e458c3ee162a66b7fe816b2bd
+  metadata.gz: bd73d0c3ccd15dc9217e629db225993c5fc7f73b3375804bfa80abd72a530906a915644b0080fa4a7f796f1b72e3078b3770a9980a62cbba4687d96a94a35870
+  data.tar.gz: 6d58bbd3b65d443482ce233fff71aafa2d03509da62130518c5fa4fb541b5f6bf97e98d90a6ab85cf81e7bc385e6f1cdb56b24a21b12f461f93694a1cd781f05

data/README.md

@@ -72,7 +72,9 @@ crumbs = records.pluck(:name).join(' / ')
 
 Add this line to your application's Gemfile:
 
-    gem 'activerecord-hierarchical_query'
+```ruby
+gem 'activerecord-hierarchical_query'
+```
 
 And then execute:
 
@@ -82,6 +84,19 @@ Or install it yourself as:
 
     $ gem install activerecord-hierarchical_query
 
+You'll then need to require the gem:
+
+```ruby
+require 'active_record/hierarchical_query'
+```
+
+Alternatively, the require can be placed in the `Gemfile`:
+
+```ruby
+gem 'activerecord-hierarchical_query', require: 'active_record/hierarchical_query'
+```
+
+
 ## Usage
 
 Let's say you've got an ActiveRecord model `Category` with attributes `id`, `parent_id`
@@ -280,6 +295,16 @@ FROM "categories" INNER JOIN (
 ORDER BY "categories__recursive"."__order_column" ASC
 ```
 
+If you want to use a `LEFT OUTER JOIN` instead of an `INNER JOIN`, add a query option for `outer_join_hierarchical`.   This option allows the query to return non-hierarchical entries:
+```ruby
+.join_recursive(outer_join_hierarchical: true)
+```
+
+If, when joining the recursive view to the main table, you want to change the foreign_key on the recursive view from the primary key of the main table to another column:
+```ruby
+.join_recursive(foreign_key: another_column)
+```
+
 ## Related resources
 
 * [About hierarchical queries (Wikipedia)](http://en.wikipedia.org/wiki/Hierarchical_and_recursive_queries_in_SQL)

data/lib/active_record/hierarchical_query/join_builder.rb

@@ -6,15 +6,21 @@ module ActiveRecord
       # @param [ActiveRecord::HierarchicalQuery::Query] query
       # @param [ActiveRecord::Relation] join_to
       # @param [#to_s] subquery_alias
-      def initialize(query, join_to, subquery_alias)
+      def initialize(query, join_to, subquery_alias, join_options = {})
         @query = query
         @builder = CTE::QueryBuilder.new(query)
         @relation = join_to
         @alias = Arel::Table.new(subquery_alias, ActiveRecord::Base)
+        @join_options = join_options
       end
 
       def build
-        relation = @relation.joins(inner_join.to_sql)
+        # outer joins to include non-hierarchical entries if specified
+        # default option when flag is not specified is to include only entries participating
+        # in a hierarchy
+        join_sql = @join_options[:outer_join_hierarchical].present? ? outer_join.to_sql : inner_join.to_sql
+        relation = @relation.joins(join_sql)
+
         # copy bound variables from inner subquery (remove duplicates)
         relation.bind_values |= bind_values
         # add ordering by "__order_column"
@@ -28,6 +34,10 @@ module ActiveRecord
         Arel::Nodes::InnerJoin.new(aliased_subquery, constraint)
       end
 
+      def outer_join
+        Arel::Nodes::OuterJoin.new(aliased_subquery, constraint)
+      end
+
       def aliased_subquery
         Arel::Nodes::As.new(subquery, @alias)
       end
@@ -48,8 +58,12 @@ module ActiveRecord
         @relation.table[@relation.klass.primary_key]
       end
 
+      def custom_foreign_key
+        @join_options[:foreign_key]
+      end
+
       def foreign_key
-        @alias[@query.klass.primary_key]
+        custom_foreign_key ? @alias[custom_foreign_key] : @alias[@query.klass.primary_key]
       end
 
       def bind_values
@@ -65,4 +79,4 @@ module ActiveRecord
       end
     end
   end
-end
+end

data/lib/active_record/hierarchical_query/query.rb

@@ -300,7 +300,7 @@ module ActiveRecord
 
         table_alias = join_options.fetch(:as, "#{table.name}__recursive")
 
-        JoinBuilder.new(self, relation, table_alias).build
+        JoinBuilder.new(self, relation, table_alias, join_options).build
       end
 
       private
@@ -317,4 +317,4 @@ module ActiveRecord
       end
     end # class Builder
   end # module HierarchicalQuery
-end # module ActiveRecord
+end # module ActiveRecord

data/lib/active_record/hierarchical_query/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module HierarchicalQuery
-    VERSION = '0.0.7'
+    VERSION = '0.0.8'
   end
 end

data/spec/active_record/hierarchical_query_spec.rb

@@ -213,5 +213,21 @@ describe ActiveRecord::HierarchicalQuery do
         ).to match /my_table/
       end
     end
+
+    describe ':outer_join_hierarchical' do
+      it 'build an outer join' do
+        expect(
+          klass.join_recursive(outer_join_hierarchical: true) { connect_by(id: :parent_id) }.to_sql
+        ).to match /LEFT OUTER JOIN/
+      end
+    end
+
+    describe ':foreign_key' do
+      it 'uses described foreign_key when joining table to recursive view' do
+        expect(
+          klass.join_recursive(foreign_key: 'some_column') { connect_by(id: :parent_id) }.to_sql
+        ).to match /categories\"\.\"id\" = \"categories__recursive\"\.\"some_column/
+      end
+    end
   end
-end
+end

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-hierarchical_query
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Alexei Mikhailov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-28 00:00:00.000000000 Z
+date: 2016-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
 - !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: 10.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 10.4.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.1
 description: 
@@ -131,17 +131,17 @@ 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
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Recursively traverse trees using a single SQL query
@@ -152,4 +152,3 @@ test_files:
 - spec/schema.rb
 - spec/spec_helper.rb
 - spec/support/models.rb
-has_rdoc: