activerecord-hierarchical_query 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71bc88ee032e123ae1e612a9a589e5ee4b3f87b2
-  data.tar.gz: e8dea5c43cd1b41450635836f4a56bdcb95a77ce
+  metadata.gz: 35f6d79b615d8ca821c2258b9287f10044ed997c
+  data.tar.gz: 4dc56871743b3a2d9bd2dc920d1195894dfc8aa5
 SHA512:
-  metadata.gz: bd73d0c3ccd15dc9217e629db225993c5fc7f73b3375804bfa80abd72a530906a915644b0080fa4a7f796f1b72e3078b3770a9980a62cbba4687d96a94a35870
-  data.tar.gz: 6d58bbd3b65d443482ce233fff71aafa2d03509da62130518c5fa4fb541b5f6bf97e98d90a6ab85cf81e7bc385e6f1cdb56b24a21b12f461f93694a1cd781f05
+  metadata.gz: 7cd10f34571215ba462f81ebd552667a432f38bfd7f84eb4cc25c05dcc006623c0b7f4e0f4f24211f1bd2874ce4458bee0bec1a43db61109cd7227105606c4fc
+  data.tar.gz: 2936034c375afb978a9c5b5a8f7c69cc4cd36690315affa3c1e3fde2433b84fbf20eb3a07cac37461f672ea5f753702c4045cf1566c1da6df3cdcce393fe8252

data/README.md

@@ -244,6 +244,17 @@ Category.join_recursive do |query|
 end
 ```
 
+## DISTINCT
+By default, the union term in the Common Table Expression uses a `UNION ALL`. If you want
+to `SELECT DISTINCT` CTE values, add a query option for  `distinct`
+```ruby
+Category.join_recursive do |query|
+  query.connect_by(id: :parent_id)
+       .start_with(id: node_1.id)
+       .distinct
+end
+```
+
 ## Generated SQL queries
 
 Under the hood this extensions builds `INNER JOIN` to recursive subquery.
@@ -297,7 +308,7 @@ 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)
+  .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:

data/lib/active_record/hierarchical_query/cte/query_builder.rb

@@ -58,7 +58,11 @@ module ActiveRecord
         end
 
         def build_select
-          @arel.project(recursive_table[Arel.star])
+          if @query.distinct_value == true
+            @arel.project(recursive_table[Arel.star]).distinct
+          else
+            @arel.project(recursive_table[Arel.star])
+          end
         end
 
         def build_limits
@@ -79,4 +83,4 @@ module ActiveRecord
       end
     end
   end
-end
+end

data/lib/active_record/hierarchical_query/join_builder.rb

@@ -6,19 +6,20 @@ module ActiveRecord
       # @param [ActiveRecord::HierarchicalQuery::Query] query
       # @param [ActiveRecord::Relation] join_to
       # @param [#to_s] subquery_alias
-      def initialize(query, join_to, subquery_alias, join_options = {})
+      def initialize(query, join_to, subquery_alias, options = {})
         @query = query
         @builder = CTE::QueryBuilder.new(query)
         @relation = join_to
         @alias = Arel::Table.new(subquery_alias, ActiveRecord::Base)
-        @join_options = join_options
+        @options = options
       end
 
       def build
         # 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
+        join_sql = @options[:outer_join_hierarchical] == true ? outer_join.to_sql : inner_join.to_sql
+
         relation = @relation.joins(join_sql)
 
         # copy bound variables from inner subquery (remove duplicates)
@@ -59,7 +60,7 @@ module ActiveRecord
       end
 
       def custom_foreign_key
-        @join_options[:foreign_key]
+        @options[:foreign_key]
       end
 
       def foreign_key

data/lib/active_record/hierarchical_query/query.rb

@@ -20,7 +20,8 @@ module ActiveRecord
                   :limit_value,
                   :offset_value,
                   :order_values,
-                  :nocycle_value
+                  :nocycle_value,
+                  :distinct_value
 
       # @api private
       CHILD_SCOPE_METHODS = :where, :joins, :group, :having, :bind
@@ -36,6 +37,7 @@ module ActiveRecord
         @offset_value = nil
         @nocycle_value = false
         @order_values = []
+        @distinct_value = false
       end
 
       # Specify root scope of the hierarchy.
@@ -270,6 +272,14 @@ module ActiveRecord
         @klass.arel_table
       end
 
+      # Turn on select distinct option in the CTE.
+      #
+      # @return [ActiveRecord::HierarchicalQuery::Query] self
+      def distinct
+        @distinct_value = true
+        self
+      end
+
       # @return [Arel::Nodes::Node]
       # @api private
       def join_conditions

data/lib/active_record/hierarchical_query/version.rb

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

data/spec/active_record/hierarchical_query_spec.rb

@@ -214,14 +214,6 @@ describe ActiveRecord::HierarchicalQuery do
       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(
@@ -229,5 +221,62 @@ describe ActiveRecord::HierarchicalQuery do
         ).to match /categories\"\.\"id\" = \"categories__recursive\"\.\"some_column/
       end
     end
+
+    describe ':outer_join_hierarchical' do
+      subject { klass.join_recursive(outer_join_hierarchical: value) { connect_by(id: :parent_id) }.to_sql }
+
+      let(:value) { true }
+      let(:inner_join) {
+        /INNER JOIN \(WITH RECURSIVE \"categories__recursive\"/
+      }
+
+      it 'builds an outer join' do
+        expect(subject).to match /LEFT OUTER JOIN \(WITH RECURSIVE \"categories__recursive\"/
+      end
+
+      context 'value is false' do
+        let(:value) { false }
+
+        it 'builds an inner join' do
+          expect(subject).to match inner_join
+        end
+      end
+
+      context 'value is a string' do
+        let(:value) { 'foo' }
+
+        it 'builds an inner join' do
+          expect(subject).to match inner_join
+        end
+      end
+
+      context 'key is absent' do
+        subject { klass.join_recursive { connect_by(id: :parent_id) }.to_sql }
+
+        it 'builds an inner join' do
+          expect(subject).to match inner_join
+        end
+      end
+    end
+  end
+
+  describe ':distinct query method' do
+    subject { klass.join_recursive { connect_by(id: :parent_id).distinct }.to_sql }
+
+    let(:select) {
+      /SELECT \"categories__recursive\"/
+    }
+
+    it 'selects using a distinct option after joining table to recursive view' do
+      expect(subject).to match /SELECT DISTINCT \"categories__recursive\"/
+    end
+
+    context 'distinct method is absent' do
+      subject { klass.join_recursive { connect_by(id: :parent_id) }.to_sql }
+
+      it 'selects without using a distinct' do
+        expect(subject).to match select
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-hierarchical_query
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - Alexei Mikhailov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-07 00:00:00.000000000 Z
+date: 2016-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -141,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Recursively traverse trees using a single SQL query
@@ -152,3 +152,4 @@ test_files:
 - spec/schema.rb
 - spec/spec_helper.rb
 - spec/support/models.rb
+has_rdoc: