acts_as_recursive_tree 2.1.0 → 3.0.0

data/Appraisals

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+appraise 'ar-52' do
+  gem 'activerecord', '~> 5.2.0'
+  gem 'activesupport', '~> 5.2.0'
+end
+
+appraise 'ar-60' do
+  gem 'activerecord', '~> 6.0.0'
+  gem 'activesupport', '~> 6.0.0'
+end
+
+appraise 'ar-61' do
+  gem 'activerecord', '~> 6.1.0'
+  gem 'activesupport', '~> 6.1.0'
+end

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+### Version 3.0.0
+- BREAKING: Dropped support for Rails < 5.2
+- BREAKING: Increased minimum Ruby version to 2.5
+- ADD: initial support for Rails < 7
+- CHANGE: Using zeitwerk for auto loading
+
+### Version 2.2.1
+- Rails 6.1 support
+
+### Version 2.2.0
+- Rails 6.0 support
+
+### Version 2.1.1
+- Enabled subselect query when using depth
+- new QueryOption query_strategy for forcing a specific strategy (:join, :subselect)
+
 ### Version 2.1.0
 - BUGFIX association self_and_siblings not working
 - BUGFIX primary_key of model is retrieved on first usage and not on setup
@@ -25,4 +41,4 @@
 - BUGFIX: ordering result when querying ancestors
 
 ### Version 1.0.0
-- inital release using AREL
+- initial release using AREL

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in acts_as_recursive_tree.gemspec

data/README.md

@@ -1,5 +1,8 @@
 # ActsAsRecursiveTree
 
+[![CI Status](https://github.com/1and1/acts_as_recursive_tree/workflows/CI/badge.svg?branch=main)](https://github.com/1and1/acts_as_recursive_tree/actions?query=workflow%3ACI+branch%3Amaster)
+[![Gem Version](https://badge.fury.io/rb/acts_as_recursive_tree.svg)](https://badge.fury.io/rb/acts_as_recursive_tree)
+
 Use the power of recursive SQL statements in your Rails application.
 
 When you have tree based data in your application, you always to struggle with retrieving data. There are solutions, but the always come at a price:

data/Rakefile

@@ -1,15 +1,15 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
-begin
-  require 'rspec/core/rake_task'
-  RSpec::Core::RakeTask.new(:spec)
+require 'rspec/core/rake_task'
 
-  task default: [:spec]
-rescue LoadError
-end
+RSpec::Core::RakeTask.new(:spec)
+
+task default: [:spec]
 
 desc 'Deletes temporary files'
 task :clean_tmp_files do
-  %w( db.log test.sqlite3 ).each do |file|
-    File.delete(file) if File.exists?(file)
+  %w[db.log test.sqlite3].each do |file|
+    File.delete(file) if File.exist?(file)
   end
 end

data/acts_as_recursive_tree.gemspec

@@ -1,30 +1,39 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'acts_as_recursive_tree/version'
 
 Gem::Specification.new do |spec|
-  spec.name        = 'acts_as_recursive_tree'
-  spec.version     = ActsAsRecursiveTree::VERSION
-  spec.authors     = ['Wolfgang Wedelich-John']
-  spec.email       = ['wolfgang.wedelich@1und1.de']
-  spec.summary     = %q{Drop in replacement for acts_as_tree but using recursive queries}
-  spec.description = %q{
-  This is a ruby gem that provides drop in replacement for acts_as_tree but makes use of SQL recursive statement. Be sure to have a DBMS that supports recursive queries when using this gem (e.g. PostgreSQL or SQLite). }
-  spec.homepage    = 'https://github.com/1and1/acts_as_recursive_tree'
-  spec.license     = 'MIT'
-
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.name                  = 'acts_as_recursive_tree'
+  spec.version               = ActsAsRecursiveTree::VERSION
+  spec.authors               = ['Wolfgang Wedelich-John', 'Willem Mulder']
+  spec.email                 = %w[wolfgang.wedelich@ionos.com 14mRh4X0r@gmail.com]
+  spec.summary               = 'Drop in replacement for acts_as_tree but using recursive queries'
+  spec.description           = '
+  This is a ruby gem that provides drop in replacement for acts_as_tree but makes use of SQL recursive statement. Be sure to have a DBMS that supports recursive queries when using this gem (e.g. PostgreSQL or SQLite). '
+  spec.homepage              = 'https://github.com/1and1/acts_as_recursive_tree'
+  spec.license               = 'MIT'
+  spec.metadata              = {
+    'bug_tracker_uri' => 'https://github.com/1and1/acts_as_recursive_tree/issues',
+    'changelog_uri' => 'https://github.com/1and1/acts_as_recursive_tree/CHANGELOG.md'
+  }
+  spec.required_ruby_version = '>= 2.5.0'
   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{^spec/})
   spec.require_paths         = ['lib']
 
-  spec.add_runtime_dependency 'activerecord', '>= 5.0.0', '< 6.0.0'
+  spec.add_runtime_dependency 'activerecord', '>= 5.2.0', '< 7.0'
+  spec.add_runtime_dependency 'activesupport', '>= 5.2.0', '< 7.0'
+  spec.add_runtime_dependency 'zeitwerk', '>= 2.4'
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'appraisal', '~> 2.4'
   spec.add_development_dependency 'database_cleaner', '~> 1.5'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec-rails', '~> 3.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec-rails', '>= 3.5'
+  spec.add_development_dependency 'rubocop', '>= 1.8.0'
+  spec.add_development_dependency 'rubocop-rails', '>= 2.9.0'
+  spec.add_development_dependency 'rubocop-rspec', '>= 2.1.0'
+
   spec.add_development_dependency 'sqlite3', '~> 1.3'
 end

data/gemfiles/ar_52.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.2.0"
+gem "activesupport", "~> 5.2.0"
+
+gemspec path: "../"

data/gemfiles/ar_60.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.0.0"
+gem "activesupport", "~> 6.0.0"
+
+gemspec path: "../"

data/gemfiles/ar_61.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.1.0"
+gem "activesupport", "~> 6.1.0"
+
+gemspec path: "../"

data/lib/acts_as_recursive_tree.rb

@@ -1,15 +1,11 @@
-require 'active_support/all'
+# frozen_string_literal: true
+
 require_relative 'acts_as_recursive_tree/railtie' if defined?(Rails)
+require 'zeitwerk'
 
-module ActsAsRecursiveTree
-  extend ActiveSupport::Autoload
+loader = Zeitwerk::Loader.for_gem
+loader.setup
 
-  autoload :Config
-  autoload :ActsMacro
-  autoload :Model
-  autoload :Associations
-  autoload :Scopes
-  autoload :Version
-  autoload :Options
-  autoload :Builders
+module ActsAsRecursiveTree
+  # nothing special here
 end

data/lib/acts_as_recursive_tree/acts_macro.rb

@@ -1,17 +1,17 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module ActsMacro
-
     ##
     # Configuration options are:
     #
     # * <tt>foreign_key</tt> - specifies the column name to use for tracking
     # of the tree (default: +parent_id+)
     def recursive_tree(parent_key: :parent_id, parent_type_column: nil)
-
       class_attribute :_recursive_tree_config
       self._recursive_tree_config = Config.new(
-        model_class:        self,
-        parent_key:         parent_key.to_sym,
+        model_class: self,
+        parent_key: parent_key.to_sym,
         parent_type_column: parent_type_column.try(:to_sym)
       )
 
@@ -20,6 +20,6 @@ module ActsAsRecursiveTree
       include ActsAsRecursiveTree::Scopes
     end
 
-    alias_method :acts_as_tree, :recursive_tree
+    alias acts_as_tree recursive_tree
   end
-end
+end

data/lib/acts_as_recursive_tree/associations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/concern'
 
 module ActsAsRecursiveTree
@@ -6,20 +8,20 @@ module ActsAsRecursiveTree
 
     included do
       belongs_to :parent,
-                 class_name:  self.base_class.to_s,
-                 foreign_key: self._recursive_tree_config.parent_key,
-                 inverse_of:  :children,
-                 optional:    true
+                 class_name: base_class.to_s,
+                 foreign_key: _recursive_tree_config.parent_key,
+                 inverse_of: :children,
+                 optional: true
 
       has_many :children,
-               class_name:  self.base_class.to_s,
-               foreign_key: self._recursive_tree_config.parent_key,
-               inverse_of:  :parent
+               class_name: base_class.to_s,
+               foreign_key: _recursive_tree_config.parent_key,
+               inverse_of: :parent
 
       has_many :self_and_siblings,
                through: :parent,
                source: :children,
-               class_name:  self.base_class.to_s
+               class_name: base_class.to_s
     end
   end
 end

data/lib/acts_as_recursive_tree/builders/ancestors.rb

@@ -1,17 +1,15 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Builders
     class Ancestors < RelationBuilder
-
-      def build_join_condition
-        travers_loc_table[parent_key].eq(base_table[primary_key])
-      end
+      self.traversal_strategy = ActsAsRecursiveTree::Builders::Strategies::Ancestor
 
       def get_query_options(_)
         opts = super
         opts.ensure_ordering!
         opts
       end
-
     end
   end
 end

data/lib/acts_as_recursive_tree/builders/descendants.rb

@@ -1,9 +1,9 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Builders
     class Descendants < RelationBuilder
-      def build_join_condition
-        base_table[parent_key].eq(travers_loc_table[primary_key])
-      end
+      self.traversal_strategy = ActsAsRecursiveTree::Builders::Strategies::Descendant
     end
   end
 end

data/lib/acts_as_recursive_tree/builders/leaves.rb

@@ -1,26 +1,25 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Builders
     class Leaves < Descendants
-
       def create_select_manger(column = nil)
         select_manager = super
 
         select_manager.where(
-            travers_loc_table[primary_key].not_in(
-                travers_loc_table.where(
-                    travers_loc_table[parent_key].not_eq(nil)
-                ).project(travers_loc_table[parent_key])
-            )
+          travers_loc_table[primary_key].not_in(
+            travers_loc_table.where(
+              travers_loc_table[parent_key].not_eq(nil)
+            ).project(travers_loc_table[parent_key])
+          )
         )
         select_manager
-
       end
 
       def get_query_options(_)
         # do not allow any custom options
         ActsAsRecursiveTree::Options::QueryOptions.new
       end
-
     end
   end
 end

data/lib/acts_as_recursive_tree/builders/relation_builder.rb

@@ -1,15 +1,19 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Builders
     #
     # Constructs the Arel necessary for recursion.
     #
     class RelationBuilder
-
       def self.build(klass, ids, exclude_ids: false, &block)
         new(klass, ids, exclude_ids: exclude_ids, &block).build
       end
 
+      class_attribute :traversal_strategy, instance_writer: false
+
       attr_reader :klass, :ids, :recursive_temp_table, :travers_loc_table, :without_ids
+
       mattr_reader(:random) { Random.new }
 
       # Delegators for easier accessing config and query options
@@ -39,7 +43,7 @@ module ActsAsRecursiveTree
       def get_query_options(proc)
         opts = ActsAsRecursiveTree::Options::QueryOptions.new
 
-        proc.call(opts) if proc
+        proc&.call(opts)
 
         opts
       end
@@ -49,36 +53,33 @@ module ActsAsRecursiveTree
       end
 
       def build
-        relation = Strategy.for_query_options(@query_opts).build(self)
+        relation = Strategies.for_query_options(@query_opts).build(self)
 
-        relation = apply_except_id(relation)
-        relation
+        apply_except_id(relation)
       end
 
       def apply_except_id(relation)
         return relation unless without_ids
+
         relation.where(ids.apply_negated_to(base_table[primary_key]))
       end
 
-      def apply_depth(relation)
-        return relation unless depth_present?
-
-        relation.where(depth.apply_to(recursive_temp_table[depth_column]))
-      end
+      def apply_depth(select_manager)
+        return select_manager unless depth_present?
 
-      def apply_order(relation)
-        return relation unless ensure_ordering
-        relation.order(recursive_temp_table[depth_column].asc)
+        select_manager.where(depth.apply_to(travers_loc_table[depth_column]))
       end
 
       def create_select_manger(column = nil)
         projections = if column
-          travers_loc_table[column]
-        else
-          Arel.star
-        end
+                        travers_loc_table[column]
+                      else
+                        Arel.star
+                      end
+
+        select_mgr = travers_loc_table.project(projections).with(:recursive, build_cte_table)
 
-        travers_loc_table.project(projections).with(:recursive, build_cte_table)
+        apply_depth(select_mgr)
       end
 
       def build_cte_table
@@ -101,7 +102,9 @@ module ActsAsRecursiveTree
       end
 
       def build_union_select
-        join_condition = apply_parent_type_column(build_join_condition)
+        join_condition = apply_parent_type_column(
+          traversal_strategy.build(self)
+        )
 
         select_manager = base_table.join(travers_loc_table).on(join_condition)
 
@@ -113,7 +116,8 @@ module ActsAsRecursiveTree
       end
 
       def apply_parent_type_column(arel_condition)
-        return arel_condition unless parent_type_column.present?
+        return arel_condition if parent_type_column.blank?
+
         arel_condition.and(base_table[parent_type_column].eq(klass.base_class))
       end
 
@@ -130,16 +134,9 @@ module ActsAsRecursiveTree
       def apply_query_opts_condition(relation)
         # check with nil? and not #present?/#blank? which will execute the query
         return relation if condition.nil?
-        relation.merge(condition)
-      end
 
-      #
-      # U
-      #
-      def build_join_condition
-        raise 'not implemented'
+        relation.merge(condition)
       end
-
     end
   end
 end