acts_as_recursive_tree 2.1.1 → 3.1.0

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/gemfiles/ar_70.gemfile

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

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,14 +1,15 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Builders
     class Ancestors < RelationBuilder
-      self.traversal_strategy = ActsAsRecursiveTree::Builders::Strategy::Ancestor
+      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,7 +1,9 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Builders
     class Descendants < RelationBuilder
-      self.traversal_strategy = ActsAsRecursiveTree::Builders::Strategy::Descendant
+      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,10 +1,11 @@
+# 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
@@ -12,6 +13,7 @@ module ActsAsRecursiveTree
       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
@@ -41,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
@@ -51,14 +53,14 @@ 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
 
@@ -70,10 +72,10 @@ module ActsAsRecursiveTree
 
       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)
 
@@ -114,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
 
@@ -131,6 +134,7 @@ 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
     end

data/lib/acts_as_recursive_tree/builders/{strategy → strategies}/ancestor.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Builders
-    module Strategy
+    module Strategies
       #
       # Strategy for building ancestors relation
       #

data/lib/acts_as_recursive_tree/builders/{strategy → strategies}/descendant.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Builders
-    module Strategy
+    module Strategies
       #
       # Strategy for building descendants relation
       #

data/lib/acts_as_recursive_tree/builders/{strategy → strategies}/join.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Builders
-    module Strategy
+    module Strategies
       #
       # Build a relation using an INNER JOIN.
       #
@@ -19,12 +21,12 @@ module ActsAsRecursiveTree
 
           relation = builder.klass.joins(final_select_mgr.join_sources)
 
-          relation = apply_order(builder, relation)
-          relation
+          apply_order(builder, relation)
         end
 
         def self.apply_order(builder, relation)
           return relation unless builder.ensure_ordering
+
           relation.order(builder.recursive_temp_table[builder.depth_column].asc)
         end
       end

data/lib/acts_as_recursive_tree/builders/{strategy → strategies}/subselect.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Builders
-    module Strategy
+    module Strategies
       #
       # Strategy for building a relation using an WHERE ID IN(...).
       #

data/lib/acts_as_recursive_tree/builders/{strategy.rb → strategies.rb}

@@ -1,17 +1,11 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Builders
     #
     # Strategy module for different strategies of how to build the resulting query.
     #
-    module Strategy
-      extend ActiveSupport::Autoload
-
-      autoload :Join
-      autoload :Subselect
-
-      autoload :Descendant
-      autoload :Ancestor
-
+    module Strategies
       #
       # Returns a Strategy appropriate for query_opts
       #

data/lib/acts_as_recursive_tree/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   #
   # Stores the configuration of one Model class

data/lib/acts_as_recursive_tree/model.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Model
     extend ActiveSupport::Concern
@@ -40,7 +42,7 @@ module ActsAsRecursiveTree
     ##
     # Returns the root node of the tree.
     def root
-      self_and_ancestors.where(self._recursive_tree_config.parent_key => nil).first
+      self_and_ancestors.where(_recursive_tree_config.parent_key => nil).first
     end
 
     ##
@@ -48,7 +50,7 @@ module ActsAsRecursiveTree
     #
     # subchild1.siblings # => [subchild2]
     def siblings
-      self_and_siblings.where.not(id: self.id)
+      self_and_siblings.where.not(id: id)
     end
 
     ##
@@ -57,11 +59,11 @@ module ActsAsRecursiveTree
     # root.self_and_children # => [root, child1]
     def self_and_children
       table = self.class.arel_table
-      id    = self.attributes[self._recursive_tree_config.primary_key.to_s]
+      id    = attributes[_recursive_tree_config.primary_key.to_s]
 
       base_class.where(
-        table[self._recursive_tree_config.primary_key].eq(id).or(
-          table[self._recursive_tree_config.parent_key].eq(id)
+        table[_recursive_tree_config.primary_key].eq(id).or(
+          table[_recursive_tree_config.parent_key].eq(id)
         )
       )
     end
@@ -73,13 +75,12 @@ module ActsAsRecursiveTree
       base_class.leaves_of(self)
     end
 
-
     # Returns true if node has no parent, false otherwise
     #
     # subchild1.root? # => false
     # root.root? # => true
     def root?
-      self.attributes[self._recursive_tree_config.parent_key.to_s].blank?
+      attributes[_recursive_tree_config.parent_key.to_s].blank?
     end
 
     # Returns true if node has no children, false otherwise
@@ -87,7 +88,7 @@ module ActsAsRecursiveTree
     # subchild1.leaf? # => true
     # child1.leaf? # => false
     def leaf?
-      !children.any?
+      children.none?
     end
 
     def base_class

data/lib/acts_as_recursive_tree/options/depth_condition.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Options
     class DepthCondition
-
       def ==(other)
         @value     = Values.create(other)
         @operation = true
@@ -45,4 +46,4 @@ module ActsAsRecursiveTree
       end
     end
   end
-end
+end

data/lib/acts_as_recursive_tree/options/query_options.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Options
     class QueryOptions
-
-      STRATEGIES = %i[subselect, join].freeze
+      STRATEGIES = %i[subselect join].freeze
 
       attr_accessor :condition
       attr_reader :ensure_ordering, :query_strategy
@@ -21,6 +22,7 @@ module ActsAsRecursiveTree
 
       def query_strategy=(strategy)
         raise "invalid strategy #{strategy} - only #{STRATEGIES} are allowed" unless STRATEGIES.include?(strategy)
+
         @query_strategy = strategy
       end
     end

data/lib/acts_as_recursive_tree/options/values.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Options
     module Values
@@ -13,13 +15,9 @@ module ActsAsRecursiveTree
           value
         end
 
-        def apply_to(attribute)
-
-        end
-
-        def apply_negated_to(attribute)
+        def apply_to(attribute); end
 
-        end
+        def apply_negated_to(attribute); end
       end
 
       class SingleValue < Base
@@ -38,6 +36,16 @@ module ActsAsRecursiveTree
         end
       end
 
+      class RangeValue < Base
+        def apply_to(attribute)
+          attribute.between(prepared_value)
+        end
+
+        def apply_negated_to(attribute)
+          attribute.not_between(prepared_value)
+        end
+      end
+
       class MultiValue < Base
         def apply_to(attribute)
           attribute.in(prepared_value)
@@ -58,20 +66,22 @@ module ActsAsRecursiveTree
 
       def self.create(value, config = nil)
         klass = case value
-        when ::Numeric, ::String
-          SingleValue
-        when ::ActiveRecord::Relation
-          Relation
-        when Enumerable
-          MultiValue
-        when ::ActiveRecord::Base
-          ActiveRecord
-        else
-          raise "#{value.class} is not supported"
-        end
+                when ::Numeric, ::String
+                  SingleValue
+                when ::ActiveRecord::Relation
+                  Relation
+                when Range
+                  RangeValue
+                when Enumerable
+                  MultiValue
+                when ::ActiveRecord::Base
+                  ActiveRecord
+                else
+                  raise "#{value.class} is not supported"
+                end
 
         klass.new(value, config)
       end
     end
   end
-end
+end

data/lib/acts_as_recursive_tree/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   class Railtie < Rails::Railtie
     initializer 'acts_as_recursive_tree.active_record_initializer' do

data/lib/acts_as_recursive_tree/scopes.rb

@@ -1,13 +1,17 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
   module Scopes
     extend ActiveSupport::Concern
 
     included do
-      scope :roots, -> {
+      scope :roots, lambda {
         rel = where(_recursive_tree_config.parent_key => nil)
-        rel = rel.or(
-          where.not(_recursive_tree_config.parent_type_column => self.to_s)
-        ) if _recursive_tree_config.parent_type_column
+        if _recursive_tree_config.parent_type_column
+          rel = rel.or(
+            where.not(_recursive_tree_config.parent_type_column => to_s)
+          )
+        end
 
         rel
       }

data/lib/acts_as_recursive_tree/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActsAsRecursiveTree
-  VERSION = '2.1.1'.freeze
+  VERSION = '3.1.0'
 end

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/spec/builders_spec.rb

@@ -1,13 +1,17 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 shared_context 'setup with enforced ordering' do
   let(:ordering) { false }
   include_context 'base_setup' do
-    let(:proc) { -> (config) { config.ensure_ordering! } }
+    let(:proc) { ->(config) { config.ensure_ordering! } }
   end
 end
 
 shared_context 'base_setup' do
+  subject(:query) { builder.build.to_sql }
+
   let(:model_id) { 1 }
   let(:model_class) { Node }
   let(:exclude_ids) { false }
@@ -15,17 +19,20 @@ shared_context 'base_setup' do
   let(:builder) do
     described_class.new(model_class, model_id, exclude_ids: exclude_ids, &proc)
   end
-  subject(:query) { builder.build.to_sql }
 end
 
 shared_examples 'basic recursive examples' do
   it { is_expected.to start_with "SELECT \"#{model_class.table_name}\".* FROM \"#{model_class.table_name}\"" }
-  it { is_expected.to match /WHERE "#{model_class.table_name}"."#{model_class.primary_key}" = #{model_id}/ }
-  it { is_expected.to match /WITH RECURSIVE "#{builder.travers_loc_table.name}" AS/ }
-  it { is_expected.to match /SELECT "#{model_class.table_name}"."#{model_class.primary_key}", "#{model_class.table_name}"."#{model_class._recursive_tree_config.parent_key}", 0 AS recursive_depth FROM "#{model_class.table_name}"/ }
-  it { is_expected.to match /SELECT "#{model_class.table_name}"."#{model_class.primary_key}", "#{model_class.table_name}"."#{model_class._recursive_tree_config.parent_key}", \("#{builder.travers_loc_table.name}"."recursive_depth" \+ 1\) AS recursive_depth FROM "#{model_class.table_name}"/ }
-  it { is_expected.to match /#{Regexp.escape(builder.travers_loc_table.project(Arel.star).to_sql)}/ }
-  it { is_expected.to match /"#{model_class.table_name}"."#{model_class.primary_key}" = "#{builder.recursive_temp_table.name}"."#{model_class.primary_key}"/ }
+
+  it { is_expected.to match(/WHERE "#{model_class.table_name}"."#{model_class.primary_key}" = #{model_id}/) }
+
+  it { is_expected.to match(/WITH RECURSIVE "#{builder.travers_loc_table.name}" AS/) }
+
+  it { is_expected.to match(/SELECT "#{model_class.table_name}"."#{model_class.primary_key}", "#{model_class.table_name}"."#{model_class._recursive_tree_config.parent_key}", 0 AS recursive_depth FROM "#{model_class.table_name}"/) }
+
+  it {
+    expect(subject).to match(/SELECT "#{model_class.table_name}"."#{model_class.primary_key}", "#{model_class.table_name}"."#{model_class._recursive_tree_config.parent_key}", \("#{builder.travers_loc_table.name}"."recursive_depth" \+ 1\) AS recursive_depth FROM "#{model_class.table_name}"/)
+  }
 end
 
 shared_examples 'build recursive query' do
@@ -63,13 +70,14 @@ end
 shared_examples 'ancestor query' do
   include_context 'base_setup'
 
-  it { is_expected.to match /"#{builder.travers_loc_table.name}"."#{model_class._recursive_tree_config.parent_key}" = "#{model_class.table_name}"."#{model_class.primary_key}"/ }
+  it { is_expected.to match(/"#{builder.travers_loc_table.name}"."#{model_class._recursive_tree_config.parent_key}" = "#{model_class.table_name}"."#{model_class.primary_key}"/) }
 end
 
 shared_examples 'descendant query' do
   include_context 'base_setup'
 
-  it { is_expected.to match /"#{model_class.table_name}"."#{model_class._recursive_tree_config.parent_key}" = "#{builder.travers_loc_table.name}"."#{model_class.primary_key}"/ }
+  it { is_expected.to match(/"#{model_class.table_name}"."#{model_class._recursive_tree_config.parent_key}" = "#{builder.travers_loc_table.name}"."#{model_class.primary_key}"/) }
+  it { is_expected.to match(/#{Regexp.escape(builder.travers_loc_table.project(builder.travers_loc_table[model_class.primary_key]).to_sql)}/) }
 end
 
 shared_context 'context with ordering' do
@@ -85,11 +93,11 @@ shared_context 'context without ordering' do
 end
 
 shared_examples 'with ordering' do
-  it { is_expected.to match /ORDER BY #{Regexp.escape(builder.recursive_temp_table[model_class._recursive_tree_config.depth_column].asc.to_sql)}/ }
+  it { is_expected.to match(/ORDER BY #{Regexp.escape(builder.recursive_temp_table[model_class._recursive_tree_config.depth_column].asc.to_sql)}/) }
 end
 
 shared_examples 'without ordering' do
-  it { is_expected.to_not match /ORDER BY/ }
+  it { is_expected.not_to match(/ORDER BY/) }
 end
 
 describe ActsAsRecursiveTree::Builders::Descendants do
@@ -113,6 +121,7 @@ describe ActsAsRecursiveTree::Builders::Ancestors do
     it_behaves_like 'ancestor query'
     include_context 'context with ordering'
   end
+
   context 'with options' do
     include_context 'setup with enforced ordering' do
       it_behaves_like 'with ordering'