activerecord-hierarchical_query 1.0.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 81984079ce907a96ab19520c8ecd77bcf587b0b4
-  data.tar.gz: a75cf7a24893407ab3be1c30289fdb3d1e6d926a
+SHA256:
+  metadata.gz: b5166c41ef62af29c1883f5b6e3f3447ba422bf76bae1bf5672f1f4991bbda08
+  data.tar.gz: 519b6c33c67c1b3e69578ca7abf693f1076a69f9d7f45cec5b800b954f17c7a2
 SHA512:
-  metadata.gz: a5de9642594d03716e3ee6cda1ee023e2362c2608eb06d50321611eab31e09b7b7d01f03ddecd062d38dd0579bf87002625a21d2e0230e6a582ea121cb6bdb3e
-  data.tar.gz: 968afb8c7471b36a6e2029f5f8022a325e521a1808fbace12365be16c83aa360785c9009ee566403c9b7eb0a14ed2c58945f1ca51464c6b85ef612b28186248c
+  metadata.gz: 21208d283a34594e442d19023db12e2d8cf3f79b04a55c397ce1dd97b5ccc6990db05a799b1a71a85410d5c2a905b7ba5e3791cbcb83e34611d138afe8c044d9
+  data.tar.gz: e54b02481e06962334aa9627c1fa1971dd92960aa5d2247dd4172a82f59738bcb5d10cafbc65efe8e8dcf373d81da7e4544e3fc0c938937fd33e343f7e672cd7

data/README.md

@@ -3,12 +3,32 @@
 [![Build Status](https://travis-ci.org/take-five/activerecord-hierarchical_query.png?branch=master)](https://travis-ci.org/take-five/activerecord-hierarchical_query)
 [![Code Climate](https://codeclimate.com/github/take-five/activerecord-hierarchical_query.png)](https://codeclimate.com/github/take-five/activerecord-hierarchical_query)
 [![Coverage Status](https://coveralls.io/repos/take-five/activerecord-hierarchical_query/badge.png)](https://coveralls.io/r/take-five/activerecord-hierarchical_query)
-[![Dependency Status](https://gemnasium.com/take-five/activerecord-hierarchical_query.png)](https://gemnasium.com/take-five/activerecord-hierarchical_query)
 [![Gem Version](https://badge.fury.io/rb/activerecord-hierarchical_query.png)](http://badge.fury.io/rb/activerecord-hierarchical_query)
 
-Create hierarchical queries using simple DSL, recursively traverse trees using single SQL query.
+Create hierarchical queries using simple DSL, recursively
+traverse trees using single SQL query.
 
-If a table contains hierarchical data, then you can select rows in hierarchical order using hierarchical query builder.
+If a table contains hierarchical data, then you can select rows
+in hierarchical order using hierarchical query builder.
+
+## Requirements
+
+- ActiveRecord >= 5.0, < 6.1
+- PostgreSQL >= 8.4
+- Postgres Gem >= 0.21, < 1.2
+
+Note that though PostgresSQL 8.4 and up should work, this library
+is tested on PostgresSQL 10.5.
+
+### Rails Version
+
+**Rails 4 support has ended.**
+
+If you have trouble with Rails 5.1 or 5.0, try upgrading to Rails 5.2
+first. Rails 6 should work, but please report issues immediately as
+support is recent.
+
+## In a nutshell
 
 ### Traverse trees
 
@@ -59,25 +79,12 @@ records = Category.join_recursive do |query|
     .connect_by(parent_id: :id)
 end.order('depth ASC')
 
-# returned value is just regular ActiveRecord::Relation instance, so you can use its methods
+# returns a regular ActiveRecord::Relation instance
+# so methods like `pluck` all work as expected.
+
 crumbs = records.pluck(:name).join(' / ')
 ```
 
-## Requirements
-
-* ActiveRecord >= 3.1.0
-* PostgreSQL >= 8.4
-
-## Rails 5
-
-Rails 5 is supported on the `rails-5` branch and through gem versions
-`>= 1.0.0` on rubygems.org. The Rails branch is intended to
-follow minor Rails releases (currently 5.1), but it should be
-compatible with 5.0 as well. If you have trouble try upgrading Rails
-first. Tag @zachaysan with in a GitHub issue if the latest version
-of Rails is not supported or if there are reproducable problems on
-the latest minor version of Rails 5.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -106,12 +113,12 @@ Alternatively, the require can be placed in the `Gemfile`:
 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`
-and `name`. You can traverse nodes recursively starting from root rows connected by
-`parent_id` column ordered by `name`:
+Let's say you've got an ActiveRecord model `Category` with
+attributes `id`, `parent_id` and `name`. You can traverse nodes
+recursively starting from root rows connected by `parent_id`
+column ordered by `name`:
 
 ```ruby
 Category.join_recursive do
@@ -123,13 +130,15 @@ end
 
 Hierarchical queries consist of these important clauses:
 
-* **START WITH** clause
+- **START WITH** clause
 
   This clause specifies the root row(s) of the hierarchy.
-* **CONNECT BY** clause
+
+- **CONNECT BY** clause
 
   This clause specifies relationship between parent rows and child rows of the hierarchy.
-* **ORDER SIBLINGS** clause
+
+- **ORDER SIBLINGS** clause
 
   This clause specifies an order of rows in which they appear on each hierarchy level.
 
@@ -137,14 +146,16 @@ These terms are borrowed from [Oracle hierarchical queries syntax](http://docs.o
 
 Hierarchical queries are processed as follows:
 
-* First, root rows are selected -- those rows that satisfy `START WITH` condition in
+- First, root rows are selected -- those rows that satisfy `START WITH` condition in
   order specified by `ORDER SIBLINGS` clause. In example above it's specified by
   statements `query.start_with(parent_id: nil)` and `query.order_siblings(:name)`.
-* Second, child rows for each root rows are selected. Each child row must satisfy
+
+- Second, child rows for each root rows are selected. Each child row must satisfy
   condition specified by `CONNECT BY` clause with respect to one of the root rows
   (`query.connect_by(id: :parent_id)` in example above). Order of child rows is
   also specified by `ORDER SIBLINGS` clause.
-* Successive generations of child rows are selected with respect to `CONNECT BY` clause.
+
+- Successive generations of child rows are selected with respect to `CONNECT BY` clause.
   First the children of each row selected in step 2 selected, then the children of those
   children and so on.
 
@@ -201,7 +212,8 @@ Category.join_recursive do
 end
 ```
 
-You can even refer to parent table, just don't forget to include columns in `SELECT` clause!
+You can even refer to parent table, just don't forget to include
+columns in `SELECT` clause!
 
 ```ruby
 Category.join_recursive do |query|
@@ -222,8 +234,9 @@ end
 
 ### NOCYCLE
 
-Recursive query will loop if hierarchy contains cycles (your graph is not acyclic).
-`NOCYCLE` clause, which is turned off by default, could prevent it.
+Recursive query will loop if hierarchy contains cycles (your
+graph is not acyclic). `NOCYCLE` clause, which is turned off by
+default, could prevent it.
 
 Loop example:
 
@@ -235,7 +248,8 @@ node_1.parent = node_2
 node_1.save
 ```
 
-`node_1` and `node_2` now link to each other, so following query will never end:
+`node_1` and `node_2` now link to each other, so the following
+query will not terminate:
 
 ```ruby
 Category.join_recursive do |query|
@@ -255,8 +269,11 @@ 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`:
+
+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)
@@ -265,7 +282,9 @@ Category.join_recursive do |query|
 end
 ```
 
-If you want to join CTE terms by `UNION DISTINCT`, pass an option to `join_recursive`:
+If you want to join CTE terms by `UNION DISTINCT`, pass an option
+to `join_recursive`:
+
 ```ruby
 Category.join_recursive(union_type: :distinct) do |query|
   query.connect_by(id: :parent_id)
@@ -291,7 +310,7 @@ Category.join_recursive do |query|
 end
 ```
 
-would generate following SQL (if PostgreSQL used):
+Would generate following SQL:
 
 ```sql
 SELECT "categories".*
@@ -324,27 +343,30 @@ 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:
+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:
+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)
+  .join_recursive(foreign_key: another_column)
 ```
 
 ## Related resources
 
-* [About hierarchical queries (Wikipedia)](http://en.wikipedia.org/wiki/Hierarchical_and_recursive_queries_in_SQL)
-* [Hierarchical queries in Oracle](http://docs.oracle.com/cd/B19306_01/server.102/b14200/queries003.htm)
-* [Recursive queries in PostgreSQL](http://www.postgresql.org/docs/9.3/static/queries-with.html)
-* [Using Recursive SQL with ActiveRecord trees](http://hashrocket.com/blog/posts/recursive-sql-in-activerecord)
+- [About hierarchical queries (Wikipedia)](http://en.wikipedia.org/wiki/Hierarchical_and_recursive_queries_in_SQL)
+- [Hierarchical queries in Oracle](http://docs.oracle.com/cd/B19306_01/server.102/b14200/queries003.htm)
+- [Recursive queries in PostgreSQL](http://www.postgresql.org/docs/9.3/static/queries-with.html)
+- [Using Recursive SQL with ActiveRecord trees](http://hashrocket.com/blog/posts/recursive-sql-in-activerecord)
 
 ## Contributing
 
-1. Fork it ( http://github.com/take-five/activerecord-hierarchical_query/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
+Read through the short
+[contributing guide](https://github.com/take-five/activerecord-hierarchical_query/blob/master/CONTRIBUTING.md).

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

@@ -1,5 +1,3 @@
-require 'arel/visitors/depth_first'
-
 module ActiveRecord
   module HierarchicalQuery
     module CTE
@@ -18,7 +16,23 @@ module ActiveRecord
 
         private
         def connect_by_columns
-          @query.join_conditions.grep(Arel::Attributes::Attribute) { |column| column.name.to_s }
+          columns = []
+          traverse(@query.join_conditions) do |node|
+            columns << node.name.to_s if node.is_a?(Arel::Attributes::Attribute)
+          end
+          columns
+        end
+
+        def traverse(ast, &blck)
+          if ast && ast.respond_to?(:left) && ast.left
+            traverse(ast.left, &blck)
+          end
+
+          if ast && ast.respond_to?(:right) && ast.right
+            traverse(ast.right, &blck)
+          end
+
+          yield ast
         end
       end
     end

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

@@ -14,8 +14,14 @@ module ActiveRecord
           @builder = builder
         end
 
-        def bind_values
-          scope.bound_attributes
+        if ActiveRecord.version < Gem::Version.new("5.2")
+          def bind_values
+            scope.bound_attributes
+          end
+        else
+          def bind_values
+            scope.values || {}
+          end
         end
 
         def arel

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

@@ -12,8 +12,14 @@ module ActiveRecord
           @builder = builder
         end
 
-        def bind_values
-          scope.bound_attributes
+        if ActiveRecord.version < Gem::Version.new("5.2")
+          def bind_values
+            scope.bound_attributes
+          end
+        else
+          def bind_values
+            scope.values || {}
+          end
         end
 
         def arel

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

@@ -11,8 +11,16 @@ module ActiveRecord
           @union_type = options.fetch(:union_type, :all)
         end
 
-        def bind_values
-          non_recursive_term.bind_values + recursive_term.bind_values
+        if ActiveRecord.version < Gem::Version.new("5.2")
+          def bind_values
+            non_recursive_term.bind_values + recursive_term.bind_values
+          end
+        else
+          def bind_values
+            non_recursive_term
+              .bind_values
+              .merge recursive_term.bind_values
+          end
         end
 
         def arel

data/lib/active_record/hierarchical_query/join_builder.rb

@@ -23,13 +23,21 @@ module ActiveRecord
 
         relation = relation.joins(joined_arel_node)
 
-        # copy bound variables from inner subquery
+        return relation unless ActiveRecord.version < Gem::Version.new("5.2")
+
         relation.bind_values += bind_values
 
         relation
       end
 
       private
+
+      if ActiveRecord.version < Gem::Version.new("5.2")
+        def bind_values
+          @builder.bind_values
+        end
+      end
+
       def joined_arel_node
         @options[:outer_join_hierarchical] == true ? outer_join : inner_join
       end
@@ -70,10 +78,6 @@ module ActiveRecord
         custom_foreign_key ? @alias[custom_foreign_key] : @alias[@query.klass.primary_key]
       end
 
-      def bind_values
-        @builder.bind_values
-      end
-
       def ordered?
         @query.orderings.any?
       end
@@ -84,12 +88,29 @@ module ActiveRecord
 
       # This node is required to support joins to aliased Arel nodes
       class SubqueryAlias < Arel::Nodes::As
+
         attr_reader :table_name
 
+        unless method_defined? :name
+          alias_method :name, :table_name
+        end
+
         def initialize(subquery, alias_node)
           super
-          @table_name = alias_node.name
+
+          @table_name = alias_node.try :name
+
+          return unless alias_node.respond_to? :left
+
+          aliased_name = alias_node.left.relation.name
+          return if @table_name == aliased_name
+
+          # Defensive coding; this shouldn't happen unless the
+          # Rails team does a change to how Arel works.
+          message = "Unexpected alias name mismatch"
+          raise RuntimeError, message
         end
+
       end
     end
   end

data/lib/active_record/hierarchical_query/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   module HierarchicalQuery
-    VERSION = '1.0.1'
+    VERSION = '1.3.0'
   end
 end

data/lib/arel/nodes/postgresql.rb

@@ -25,7 +25,7 @@ module Arel
       ARRAY_CLOSING = ']'.freeze
       ARRAY_CONCAT = '||'.freeze
 
-      if Arel::VERSION < '6.0.0'
+      if Gem::Version.new(Arel::VERSION) < Gem::Version.new('6.0.0')
         def visit_Arel_Nodes_PostgresArray o, *a
           "#{ARRAY_OPENING}#{visit o.values, *a}#{ARRAY_CLOSING}"
         end

data/spec/active_record/hierarchical_query_spec.rb

@@ -59,6 +59,18 @@ describe ActiveRecord::HierarchicalQuery do
           end
         ).to include root, child_1, child_2, child_3, child_4, child_5
       end
+
+      it 'handles Arel::Nodes::As name delegation' do
+        expected_array = \
+        klass.join_recursive do
+          connect_by { |parent, child| parent[:id].eq child[:parent_id] }
+        end
+
+        expect(
+          child_5.alias_node_query
+        ).to match_array expected_array
+      end
+
     end
 
     describe 'START WITH clause' do

data/spec/spec_helper.rb

@@ -2,9 +2,14 @@
 require 'pathname'
 require 'logger'
 
+begin
+  require 'pry'
+rescue LoadError
+end
+
 ENV['TZ'] = 'UTC'
 
-SPEC_ROOT = Pathname.new(File.dirname(__FILE__))
+SPEC_ROOT = Pathname.new(File.dirname(__FILE__)) unless defined? SPEC_ROOT
 
 require 'bundler'
 Bundler.setup(:default, ENV['TRAVIS'] ? :travis : :local)
@@ -15,25 +20,35 @@ require 'active_record'
 
 ActiveRecord::Base.configurations = YAML.load(SPEC_ROOT.join('database.yml').read)
 ActiveRecord::Base.establish_connection(:pg)
+
 ActiveRecord::Base.logger = Logger.new(ENV['DEBUG'] ? $stderr : '/dev/null')
 ActiveRecord::Base.logger.formatter = proc do |severity, datetime, progname, msg|
   "#{datetime.strftime('%H:%M:%S.%L')}: #{msg}\n"
 end
 
-load SPEC_ROOT.join('schema.rb')
+begin
+  load SPEC_ROOT.join('schema.rb')
+rescue ActiveRecord::NoDatabaseError
+  bold  = "\033[1m"
+  red   = "\033[31m"
+  reset = "\033[0m"
+
+  puts ""
+  puts bold + red + "Database missing." + reset
+  puts "If you have #{bold}sudo#{reset}, run the below " +
+       "(ignore any role creation errors)."
+  puts ""
+  puts bold + "rake db:create" + reset
+  puts ""
+  exit
+end
+
 require SPEC_ROOT.join('support', 'models').to_s
 
 DatabaseCleaner.strategy = :transaction
 
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
 
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
   config.order = 'random'
 
   config.around(:each) do |example|

data/spec/support/models.rb

@@ -37,6 +37,16 @@ class Category < ActiveRecord::Base
   def ancestors
     parent ? parent.ancestors + [parent] : []
   end
+
+  # Arel::Nodes::As delegates name to the left relation
+  def alias_node_query
+    Category.left_outer_joins(:articles)
+      .join_recursive do |query|
+      query
+        .connect_by(id: :parent_id)
+    end
+  end
+
 end
 
 class Article < ActiveRecord::Base

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-hierarchical_query
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Alexei Mikhailov
+- Zach Aysan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-21 00:00:00.000000000 Z
+date: 2021-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,93 +17,114 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.21'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.21'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: '0.16'
 description: 
 email:
 - amikhailov83@gmail.com
+- zachaysan@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -147,8 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Recursively traverse trees using a single SQL query