acts_as_recursive_tree 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cb3b3fef0f54be5c64a667f3ce289fb536bbdce72dc9758eae7a3c27385adf1
-  data.tar.gz: 5c65367bf564d3d12b70506ec2ecdaed1e9aaed535a822ccebff0b1aefe99b59
+  metadata.gz: 001a83205a1b8198bce2a13dda33718cd7733f67d99b8dd7f77562d8a9c16abf
+  data.tar.gz: 8ba160e08df9f2b5b0c508ed94c404e17dcde6206c14cafc6cc6d1c0794e13bd
 SHA512:
-  metadata.gz: 187193f5f118a30d1359cde9b40d239e2d89ed9166dce8c0e73469dd3baf28b86fd7874ed89c763f6bdeff4c8d012bb78fa6cd521998f28289134d7bd0cce13a
-  data.tar.gz: 6ca7d12b131992d6f901d462c857b79a976e323f40d0f198d6e1c26f3ce1ff36d6707226d695687b8b1bfb2a1209f7ca754ab4412bb23d581771add1ee1826bd
+  metadata.gz: a3e9db36bef6ef087286641f6b58c30fc1bea95368a9bea2bfce0210fea9418cdfb9c897d9835a2c1f189a681472d885108602eb5b8186868621263242d0cdab
+  data.tar.gz: c7eb40f03f62e577da3a5baa6261f61408251f6ec0e0253fa18d1f11b7446487cc87c529a1960688ff8ef40468e34328d28cd155a11ff5de2da40d01f684e843

data/.github/workflows/ci.yml

@@ -19,12 +19,31 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.5', '2.6', '2.7']
-        gemfile: [ar_52, ar_60, ar_61]
+        ruby-version: ['2.5', '2.6', '2.7', '3.0', '3.1', '3.2']
+        gemfile: [ar_52, ar_60, ar_61, ar_70]
+        exclude:
+          - ruby-version: '3.2'
+            gemfile: ar_52
+          - ruby-version: '3.2'
+            gemfile: ar_60
+          - ruby-version: '3.2'
+            gemfile: ar_61
+          - ruby-version: '3.1'
+            gemfile: ar_52
+          - ruby-version: '3.1'
+            gemfile: ar_60
+          - ruby-version: '3.1'
+            gemfile: ar_61
+          - ruby-version: '3.0'
+            gemfile: ar_52
+          - ruby-version: '2.5'
+            gemfile: ar_70
+          - ruby-version: '2.6'
+            gemfile: ar_70
     env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
       BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}.gemfile
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Ruby
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
     # change this to (see https://github.com/ruby/setup-ruby#versioning):

data/.gitignore

@@ -17,3 +17,4 @@ db.log
 test.sqlite3
 /gemfiles/*.lock
 /gemfiles/.bundle
+/.ruby-version

data/.rubocop.yml

@@ -9,6 +9,9 @@ AllCops:
   NewCops: enable
   SuggestExtensions: false
 
+Gemspec/RequireMFA:
+  Enabled: false
+
 Metrics/AbcSize:
   Max: 20
 

data/Appraisals

@@ -14,3 +14,8 @@ appraise 'ar-61' do
   gem 'activerecord', '~> 6.1.0'
   gem 'activesupport', '~> 6.1.0'
 end
+
+appraise 'ar-70' do
+  gem 'activerecord', '~> 7.0.1'
+  gem 'activesupport', '~> 7.0.1'
+end

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### Version 3.2.0
+- Added #preload_tree method to preload the parent/child relations of a single node
+
+### Version 3.1.0
+- Rails 7 support
+
 ### Version 3.0.0
 - BREAKING: Dropped support for Rails < 5.2
 - BREAKING: Increased minimum Ruby version to 2.5

data/README.md

@@ -12,6 +12,23 @@ When you have tree based data in your application, you always to struggle with r
 
 Luckily, there is already a SQL standard that makes it very easy to retrieve data in the traditional parent/child relation. Currently this is only supported in sqlite and Postgres. With this it is possible to query complete trees without the need of extra tables or indices.
 
+## Supported environments
+ActsAsRecursiveTree currently supports following ActiveRecord versions and is tested for compatibility:
+  * ActiveRecord 5.2.x
+  * ActiveRecord 6.0.x
+  * ActiveRecord 6.1.x
+  * ActiveRecord 7.0.x
+
+## Supported Rubies
+ActsAsRecursiveTree is tested with following rubies:
+  * MRuby 2.5
+  * MRuby 2.6
+  * MRuby 2.7
+  * MRuby 3.0
+  * MRuby 3.1
+  * MRuby 3.2
+
+Other Ruby implementations are not tested, but should also work.
 
 ## Installation
 
@@ -117,7 +134,7 @@ __Additional methods:__
 __Utility methods:__
   * `root?` - returns true if this node is a root node
   * `leaf?` - returns true if this node is a leave node
-
+  * `preload_tree` - fetches all descendants of this node and assignes the proper parent/children associations. You are then able to traverse the tree through the children/parent association without querying the database again.
 
 ## Customizing the recursion
 
@@ -195,17 +212,6 @@ sub_node_instance.descendants # => returns Node and SubNode instances
 ```
 
 
-## Known Issues
-
-When using PostgreSQL as underlying database system chances are good that you encounter following error message:
-
-`
-ActiveRecord::StatementInvalid: PG::ProtocolViolation: ERROR:  bind message supplies 1 parameters, but prepared statement "" requires 2
-`
-
-This is a known ActiveRecord issue which should be fixed in Rails 5.2. Alternative 
-
-
 ## Contributing
 
 1. Fork it ( https://github.com/1and1/acts_as_recursive_tree/fork )

data/acts_as_recursive_tree.gemspec

@@ -16,24 +16,24 @@ Gem::Specification.new do |spec|
   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'
+    'changelog_uri' => 'https://github.com/1and1/acts_as_recursive_tree/blob/main/CHANGELOG.md'
   }
   spec.required_ruby_version = '>= 2.5.0'
   spec.files                 = `git ls-files -z`.split("\x0")
   spec.test_files            = spec.files.grep(%r{^spec/})
   spec.require_paths         = ['lib']
 
-  spec.add_runtime_dependency 'activerecord', '>= 5.2.0', '< 7.0'
-  spec.add_runtime_dependency 'activesupport', '>= 5.2.0', '< 7.0'
+  spec.add_runtime_dependency 'activerecord', '>= 5.2.0', '< 7.1'
+  spec.add_runtime_dependency 'activesupport', '>= 5.2.0', '< 7.1'
   spec.add_runtime_dependency 'zeitwerk', '>= 2.4'
 
   spec.add_development_dependency 'appraisal', '~> 2.4'
   spec.add_development_dependency 'database_cleaner', '~> 1.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 'rubocop', '~> 1.23.0'
+  spec.add_development_dependency 'rubocop-rails', '~> 2.12.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.6.0'
 
   spec.add_development_dependency 'sqlite3', '~> 1.3'
 end

data/gemfiles/ar_70.gemfile

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

data/lib/acts_as_recursive_tree/acts_macro.rb

@@ -8,7 +8,8 @@ module ActsAsRecursiveTree
     # * <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
+      class_attribute(:_recursive_tree_config, instance_writer: false)
+
       self._recursive_tree_config = Config.new(
         model_class: self,
         parent_key: parent_key.to_sym,

data/lib/acts_as_recursive_tree/model.rb

@@ -91,6 +91,14 @@ module ActsAsRecursiveTree
       children.none?
     end
 
+    #
+    # Fetches all descendants of this node and assigns the parent/children associations
+    #
+    def preload_tree
+      ActsAsRecursiveTree::Preloaders::Descendants.new(self).preload!
+      true
+    end
+
     def base_class
       self.class.base_class
     end

data/lib/acts_as_recursive_tree/preloaders/descendants.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module ActsAsRecursiveTree
+  module Preloaders
+    #
+    # Preloads all descendants records for a given node and sets the parent and child associations on each record
+    # based on the preloaded data. After this, calling #parent or #children will not trigger a database query.
+    #
+    class Descendants
+      def initialize(node)
+        @node = node
+        @parent_key = node._recursive_tree_config.parent_key
+      end
+
+      def preload!
+        apply_records(@node)
+      end
+
+      private
+
+      def records
+        @records ||= @node.descendants.to_a
+      end
+
+      def apply_records(parent_node)
+        children = records.select { |child| child.send(@parent_key) == parent_node.id }
+
+        parent_node.association(:children).target = children
+
+        children.each do |child|
+          child.association(:parent).target = parent_node
+          apply_records(child)
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_recursive_tree/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActsAsRecursiveTree
-  VERSION = '3.0.0'
+  VERSION = '3.2.0'
 end

data/spec/acts_as_recursive_tree/preloaders/descendants_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe ActsAsRecursiveTree::Preloaders::Descendants do
+  include TreeMethods
+
+  let(:preloader) { described_class.new(root.reload) }
+  let(:root) { create_tree(2) }
+  let(:children) { root.children }
+
+  describe '#preload! will set the associations target attribute' do
+    before do
+      preloader.preload!
+    end
+
+    it 'sets the children assoction' do
+      children.each do |child|
+        expect(child.association(:children).target).not_to be_nil
+      end
+    end
+
+    it 'sets the parent assoction' do
+      children.each do |child|
+        expect(child.association(:parent).target).not_to be_nil
+      end
+    end
+  end
+end

data/spec/db/database.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'fileutils'
+
 database_folder           = "#{File.dirname(__FILE__)}/../db"
 database_adapter          = 'sqlite'
 

data/spec/model/node_spec.rb

@@ -3,16 +3,7 @@
 require 'spec_helper'
 
 describe Node do
-  def create_tree(max_level, current_level = 0, node = nil)
-    node = Node.create!(name: 'root') if node.nil?
-
-    1.upto(max_level - current_level) do |index|
-      child = node.children.create!(name: "child #{index} - level #{current_level}")
-      create_tree(max_level, current_level + 1, child)
-    end
-
-    node
-  end
+  include TreeMethods
 
   before do
     @root  = create_tree(3)
@@ -24,7 +15,7 @@ describe Node do
       expect(@root.children.count).to be(3)
     end
 
-    it 'does not include root node ' do
+    it 'does not include root node' do
       expect(@root.children).not_to include(@root)
     end
   end

data/spec/spec_helper.rb

@@ -11,6 +11,10 @@ require_relative 'db/database'
 
 require 'database_cleaner'
 
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(__dir__, 'support/**/*.rb')].sort.each { |f| require f }
+
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # The generated `.rspec` file contains `--require spec_helper` which will cause

data/spec/support/tree_methods.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Helper methods for simple tree creation
+module TreeMethods
+  def create_tree(max_level, current_level = 0, node = nil)
+    node = Node.create!(name: 'root') if node.nil?
+
+    1.upto(max_level - current_level) do |index|
+      child = node.children.create!(name: "child #{index} - level #{current_level}")
+      create_tree(max_level, current_level + 1, child)
+    end
+
+    node
+  end
+end

data/spec/values_spec.rb

@@ -72,9 +72,16 @@ describe ActsAsRecursiveTree::Options::Values do
     end
 
     context 'Relation' do
-      subject(:value) { described_class.create(relation, OpenStruct.new(primary_key: :id)) }
+      subject(:value) { described_class.create(relation, double) }
 
       let(:relation) { Node.where(name: 'test') }
+      let(:double) do
+        Class.new do
+          def self.primary_key
+            :id
+          end
+        end
+      end
 
       it { is_expected.to be_a ActsAsRecursiveTree::Options::Values::Relation }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_recursive_tree
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Wolfgang Wedelich-John
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-02 00:00:00.000000000 Z
+date: 2023-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -20,7 +20,7 @@ dependencies:
         version: 5.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -30,7 +30,7 @@ dependencies:
         version: 5.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -40,7 +40,7 @@ dependencies:
         version: 5.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
         version: 5.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -125,44 +125,44 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.23.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.23.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: 2.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: 2.12.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -204,6 +204,7 @@ files:
 - gemfiles/ar_52.gemfile
 - gemfiles/ar_60.gemfile
 - gemfiles/ar_61.gemfile
+- gemfiles/ar_70.gemfile
 - lib/acts_as_recursive_tree.rb
 - lib/acts_as_recursive_tree/acts_macro.rb
 - lib/acts_as_recursive_tree/associations.rb
@@ -221,9 +222,11 @@ files:
 - lib/acts_as_recursive_tree/options/depth_condition.rb
 - lib/acts_as_recursive_tree/options/query_options.rb
 - lib/acts_as_recursive_tree/options/values.rb
+- lib/acts_as_recursive_tree/preloaders/descendants.rb
 - lib/acts_as_recursive_tree/railtie.rb
 - lib/acts_as_recursive_tree/scopes.rb
 - lib/acts_as_recursive_tree/version.rb
+- spec/acts_as_recursive_tree/preloaders/descendants_spec.rb
 - spec/builders_spec.rb
 - spec/db/database.rb
 - spec/db/database.yml
@@ -233,13 +236,14 @@ files:
 - spec/model/node_spec.rb
 - spec/model/relation_spec.rb
 - spec/spec_helper.rb
+- spec/support/tree_methods.rb
 - spec/values_spec.rb
 homepage: https://github.com/1and1/acts_as_recursive_tree
 licenses:
 - MIT
 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
+  changelog_uri: https://github.com/1and1/acts_as_recursive_tree/blob/main/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -260,6 +264,7 @@ signing_key:
 specification_version: 4
 summary: Drop in replacement for acts_as_tree but using recursive queries
 test_files:
+- spec/acts_as_recursive_tree/preloaders/descendants_spec.rb
 - spec/builders_spec.rb
 - spec/db/database.rb
 - spec/db/database.yml
@@ -269,4 +274,5 @@ test_files:
 - spec/model/node_spec.rb
 - spec/model/relation_spec.rb
 - spec/spec_helper.rb
+- spec/support/tree_methods.rb
 - spec/values_spec.rb