Resolve RuboCop updates

Apply remaining RuboCop fixes and configuration updates after the\ninitial
autocorrections. Includes cache helpers, helper refactors,\nand spec/test
adjustments to keep lint clean.

Configure rubocop-rake and rubocop-rspec via the plugins list and drop
Rake task requires that trigger extension warnings. This keeps the lint
output clean while still running the extra cops.

Author: evolve75

.rubocop.yml

@@ -3,6 +3,10 @@
 # Inherit from the working file.
 inherit_from: .rubocop_todo.yml
 
+plugins:
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
   NewCops: enable
   TargetRubyVersion: 3.1
@@ -13,3 +17,6 @@ AllCops:
 Lint/UselessAssignment:
   Exclude:
     - 'examples/example_basic.rb'
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false

Rakefile

@@ -41,10 +41,10 @@ GEM_SPEC = Bundler.load_gemspec(File.join(__dir__, 'rubytree.gemspec'))
 
 PKG_NAME = GEM_SPEC.name
 PKG_VER  = GEM_SPEC.version
-GEM_NAME = "#{PKG_NAME}-#{PKG_VER}.gem"
+GEM_NAME = "#{PKG_NAME}-#{PKG_VER}.gem".freeze
 
 desc 'Default Task (Run the tests)'
-task :default => 'test:all'
+task default: 'test:all'
 
 desc 'Display the current gem version'
 task :version do
@@ -154,8 +154,6 @@ begin
 
   RuboCop::RakeTask.new(:rubocop) do |t|
     t.options = ['--display-cop-names']
-    t.requires << 'rubocop-rake'
-    t.requires << 'rubocop-rspec'
   end
 rescue LoadError
   # RuboCop not available.

lib/tree.rb

@@ -39,6 +39,7 @@
 # frozen_string_literal: true
 
 require 'tree/tree_deps'
+require 'tree/utils/cache_methods'
 require 'tree/utils/structure_methods'
 require 'tree/utils/navigation_methods'
 require 'tree/utils/traversal_methods'
@@ -93,6 +94,7 @@ class TreeNode
     include Tree::Utils::JSONConverter
     include Tree::Utils::TreeMergeHandler
     include Tree::Utils::HashConverter
+    include Tree::Utils::TreeCacheHandler
     include Tree::Utils::TreeStructureHandler
     include Tree::Utils::TreeNavigationHandler
     include Tree::Utils::TreeTraversalHandler
@@ -371,6 +373,5 @@ def <=>(other)
 
       name <=> other.name
     end
-
   end
 end

lib/tree/binarytree.rb

@@ -202,35 +202,50 @@ def inordered_each
     #
     # @raise [ArgumentError] If the index is out of limits.
     def set_child_at(child, at_index)
-      raise ArgumentError,
-            'A binary tree cannot have more than two children.' unless (0..1).include? at_index
+      validate_binary_index!(at_index)
 
       old_child = @children[at_index]
-      if old_child && old_child != child
-        still_present = @children.each_with_index.any? do |existing, idx|
-          idx != at_index && existing.equal?(old_child)
-        end
-
-        unless still_present
-          @children_hash.delete(old_child.name)
-          old_child.set_as_root!
-        end
-      end
+      detach_old_child(old_child, at_index) if old_child && old_child != child
 
       if child
-        child.parent&.remove!(child) unless child.parent == self
-        @children[at_index]        = child
-        @children_hash[child.name] = child # Assign the name mapping
-        child.parent               = self
+        attach_child(child, at_index)
       else
         @children[at_index] = nil
       end
+
       send(:invalidate_size_cache_upwards!)
       child
     end
 
     protected :set_child_at
 
+    private
+
+    def validate_binary_index!(at_index)
+      return if (0..1).include?(at_index)
+
+      raise ArgumentError, 'A binary tree cannot have more than two children.'
+    end
+
+    def detach_old_child(old_child, at_index)
+      still_present = @children.each_with_index.any? do |existing, idx|
+        idx != at_index && existing.equal?(old_child)
+      end
+      return if still_present
+
+      @children_hash.delete(old_child.name)
+      old_child.set_as_root!
+    end
+
+    def attach_child(child, at_index)
+      child.parent&.remove!(child) unless child.parent == self
+      @children[at_index] = child
+      @children_hash[child.name] = child
+      child.parent = self
+    end
+
+    public
+
     # Sets the left child of the receiver node. If a previous child existed, it
     # is replaced.
     #

lib/tree/utils/cache_methods.rb

@@ -0,0 +1,56 @@
+# cache_methods.rb - This file is part of the RubyTree package.
+#
+# Copyright (c) 2006-2026 Anupam Sengupta. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# - Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# - Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+#
+# - Neither the name of the organization nor the names of its contributors may
+#   be used to endorse or promote products derived from this software without
+#   specific prior written permission.
+#
+#   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# frozen_string_literal: true
+
+module Tree
+  module Utils
+    # Provides cache helpers for TreeNode.
+    module TreeCacheHandler
+      private
+
+      def clear_root_cache!
+        @root_cache = nil
+        return unless @children
+
+        children_array.each do |child|
+          child&.__send__(:clear_root_cache!)
+        end
+      end
+
+      def invalidate_size_cache_upwards!
+        node = self
+        while node
+          node.instance_variable_set(:@size, nil)
+          node = node.parent
+        end
+      end
+    end
+  end
+end

lib/tree/utils/navigation_methods.rb

@@ -91,26 +91,21 @@ def last_sibling?
       # An array of siblings for this node. This node is excluded.
       #
       # @note Nil child slots (e.g., in binary trees) are skipped.
-      def siblings
-        if block_given?
-          return self if root?
+      def siblings(&block)
+        return [] if root?
+
+        siblings = []
+        parent.send(:children_array).each do |sibling|
+          next unless sibling
+          next if sibling == self
 
-          parent.send(:children_array).each do |sibling|
-            next unless sibling
-            next if sibling == self
+          siblings << sibling
+        end
 
-            yield sibling
-          end
+        if block
+          siblings.each(&block)
           self
         else
-          return [] if root?
-
-          siblings = []
-          parent.send(:children_array).each do |my_sibling|
-            next unless my_sibling
-
-            siblings << my_sibling if my_sibling != self
-          end
           siblings
         end
       end

lib/tree/utils/structure_methods.rb

@@ -32,6 +32,7 @@
 module Tree
   module Utils
     # Provides structure-modification helpers for TreeNode.
+    # rubocop:disable Metrics/ModuleLength
     module TreeStructureHandler
       # Convenience synonym for {Tree::TreeNode#add} method.
       def <<(child)
@@ -40,39 +41,12 @@ def <<(child)
 
       # Adds the specified child node to this node.
       def add(child, at_index = -1)
-        # Only handles the immediate child scenario
-        raise ArgumentError, 'Attempting to add a nil node' unless child
-
-        raise ArgumentError, 'Attempting add node to itself' if equal?(child)
-
-        raise ArgumentError, 'Attempting add root as a child' if child.equal?(root)
-
-        if (ancestors = parentage) && ancestors.include?(child)
-          raise ArgumentError, 'Attempting add ancestor as a child'
-        end
-
-        # Lazy man's unique test, won't test if children of child are unique in
-        # this tree too.
-        raise "Child #{child.name} already added!" if @children_hash.include?(child.name)
+        validate_add_child!(child)
+        ensure_unique_child_name!(child)
 
         child.parent&.remove! child # Detach from the old parent
-
-        if insertion_range.include?(at_index)
-          @children.insert(at_index, child)
-        else
-          message = [
-            'Attempting to insert a child at a non-existent location',
-            "(#{at_index})",
-            'when only positions from',
-            "#{insertion_range.min} to #{insertion_range.max} exist."
-          ].join(' ')
-          raise message
-        end
-
-        @children_hash[child.name] = child
-        child.parent = self
-        invalidate_size_cache_upwards!
-        child
+        insert_child_at!(child, at_index)
+        attach_child!(child)
       end
 
       # Return a range of valid insertion positions.  Used in the #add method.
@@ -97,11 +71,9 @@ def rename(new_name)
 
       # Renames the specified child node
       def rename_child(old_name, new_name)
-        raise ArgumentError,
-              "Invalid child name specified: #{old_name}" unless @children_hash.key?(old_name)
+        raise ArgumentError, "Invalid child name specified: #{old_name}" unless @children_hash.key?(old_name)
 
-        raise ArgumentError,
-              "Child name already exists: #{new_name}" if @children_hash.key?(new_name)
+        raise ArgumentError, "Child name already exists: #{new_name}" if @children_hash.key?(new_name)
 
         @children_hash[new_name] = @children_hash.delete(old_name)
         @children_hash[new_name].name = new_name
@@ -170,25 +142,45 @@ def freeze_tree!
         each(&:freeze)
       end
 
-      def clear_root_cache!
-        @root_cache = nil
-        return unless @children
+      def validate_add_child!(child)
+        raise ArgumentError, 'Attempting to add a nil node' unless child
+        raise ArgumentError, 'Attempting add node to itself' if equal?(child)
+        raise ArgumentError, 'Attempting add root as a child' if child.equal?(root)
 
-        children_array.each do |child|
-          child&.__send__(:clear_root_cache!)
-        end
+        return unless (ancestors = parentage) && ancestors.include?(child)
+
+        raise ArgumentError, 'Attempting add ancestor as a child'
       end
 
-      def invalidate_size_cache_upwards!
-        node = self
-        while node
-          node.instance_variable_set(:@size, nil)
-          node = node.parent
-        end
+      def ensure_unique_child_name!(child)
+        return unless @children_hash.include?(child.name)
+
+        raise "Child #{child.name} already added!"
+      end
+
+      def insert_child_at!(child, at_index)
+        return @children.insert(at_index, child) if insertion_range.include?(at_index)
+
+        message = [
+          'Attempting to insert a child at a non-existent location',
+          "(#{at_index})",
+          'when only positions from',
+          "#{insertion_range.min} to #{insertion_range.max} exist."
+        ].join(' ')
+        raise message
+      end
+
+      def attach_child!(child)
+        @children_hash[child.name] = child
+        child.parent = self
+        invalidate_size_cache_upwards!
+        child
       end
 
-      private :insertion_range, :clear_root_cache!, :invalidate_size_cache_upwards!
+      private :insertion_range, :validate_add_child!, :ensure_unique_child_name!,
+              :insert_child_at!, :attach_child!
       protected :parent=, :set_as_root!
     end
+    # rubocop:enable Metrics/ModuleLength
   end
 end

rubytree.gemspec

@@ -64,17 +64,17 @@ Gem::Specification.new do |s|
                             '--main', 'README.md',
                             '--quiet']
 
-  s.add_runtime_dependency 'json', '~> 2.18'
+  s.add_dependency 'json', '~> 2.18'
 
   # NOTE: Rake is added as a development and test dependency in the Gemfile.
   s.add_development_dependency 'bundler', '~> 2.6'
   s.add_development_dependency 'rake', '~> 13.3'
   s.add_development_dependency 'rdoc', '~> 7.1'
+  s.add_development_dependency 'rspec', '~> 3.13'
   s.add_development_dependency 'rtagstask', '~> 0.0'
   s.add_development_dependency 'rubocop', '~> 1.84'
-  s.add_development_dependency 'rubocop-rspec', '~> 3.0'
   s.add_development_dependency 'rubocop-rake', '~> 0.7'
-  s.add_development_dependency 'rspec', '~> 3.13'
+  s.add_development_dependency 'rubocop-rspec', '~> 3.0'
   s.add_development_dependency 'simplecov', '~> 0.22'
   s.add_development_dependency 'simplecov-lcov', '~> 0.9'
   s.add_development_dependency 'test-unit', '~> 3.7'

spec/spec_helper.rb

@@ -39,6 +39,6 @@
       enable_coverage :branch
     end
   rescue LoadError => e
-    puts "Could not load simplecov; continuing without code coverage #{e.cause}"
+    warn "Could not load simplecov; continuing without code coverage #{e.cause}"
   end
 end