with_recursive_tree 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 577a92da7b862dcefb0b95b7a95e56bf2e3dede08cd87f940ca76691300caf88
-  data.tar.gz: c5d32bf01cb73cd8e4f9d1d8d845c6a9c823acef24343d5686de3617d3a1d404
+  metadata.gz: 108a3060c431b14be0274538083b1251da56c3c5404ff96628007c849a86b94c
+  data.tar.gz: 6d3619942217a168e4eb8bfc04533b5aa78edd6e0bf428eac9cd628007a47582
 SHA512:
-  metadata.gz: e46d3982c72f316453a604deed2879a2ad10f6b97ed9f071f658fb157639958ac851874cc3d4525e744638f97a1592750a29b5c9a2e31a2e001a0472c3cf3527
-  data.tar.gz: 603d05e1f4c5904b243d38f18771605662fa9e72744ba668cd2979ab48b339811b067ff1cf2a4e32eaeeabd3a8d3684f0e8e2e37f052874a4bda8e401759cf2e
+  metadata.gz: be39718928d3296a0dcbd9e2d149a6d8c7dcb3fece985620b433a4e45f5f83a4bdcc3e87f8b6840b2b6194d6428b476ba260a49c874754454622bc88811d4b06
+  data.tar.gz: 7e66c836eced475a35d398a4bceb47cd1ca441178b823b5be7c82d3a47534dd9e8ff1b9fd3842e72c1c288233c4a2c40b0703c7bdaad2e75e0273d551268ebfb

data/README.md

@@ -18,7 +18,7 @@ $ bundle
 
 ## Usage
 
-First, your model needs a reference to the its parent. Tipically, this is a `parent_id` column in your table. Once you have that reference, you can add `with_recursive_tree` to your model:
+First, your model needs a reference to the its parent. Typically, this is a `parent_id` column in your table. Once you have that reference, you can add `with_recursive_tree` to your model:
 
 ```ruby
 class Category < ApplicationRecord
@@ -31,7 +31,7 @@ By doing this, with_recursive_tree will add 2 associations:
 * `parent`: the parent of the node
 * `children`: the children of this node
 
-To build these associations, with_recursive_tree will use the `id` and the `parent_id` columns as the primary and foreing keys, respectively. If you want to specify different primary and foreign keys, you can do that by passing the `primary_key` and `foreign_key` options. For example, for a categories table whose primary key is `category_id` and the parent record id is `parent_category_id`, you would set it up as follows:
+To build these associations, with_recursive_tree will use the `id` and the `parent_id` columns as the primary and foreign keys, respectively. If you want to specify different primary and foreign keys, you can do that by passing the `primary_key` and `foreign_key` options. For example, for a categories table whose primary key is `category_id` and the parent record id is `parent_category_id`, you would set it up as follows:
 
 ```ruby
 class Category < ApplicationRecord
@@ -156,7 +156,7 @@ with_recursive_tree is compatible with:
 
 ## Benchmarks
 
-You can run some [benchmarks](/benchmarks/benchmark.rb) to compare with_recursive_tree agains [acts_as_tree](https://github.com/amerine/acts_as_tree), [ancestry](https://github.com/stefankroes/ancestry/) and [closure_tree](https://github.com/ClosureTree/closure_tree).
+You can run some [benchmarks](/benchmarks/benchmark.rb) to compare with_recursive_tree against [acts_as_tree](https://github.com/amerine/acts_as_tree), [ancestry](https://github.com/stefankroes/ancestry/) and [closure_tree](https://github.com/ClosureTree/closure_tree).
 
 Spoiler: benchmarks are always basic cases so you mustn't trust them as if they were the word of god, but they are useful tools for development/testing and setting a baseline performance requirement..
 

data/lib/with_recursive_tree/backport.rb

@@ -1,4 +1,4 @@
-module WithRecursiveTree
+module WithRecursiveTree::InstanceMethods
   def ancestors
     self_and_ancestors.where.not self.class.with_recursive_tree_primary_key => send(self.class.with_recursive_tree_primary_key)
   end

data/lib/with_recursive_tree/version.rb

@@ -1,3 +1,3 @@
 module WithRecursiveTree
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/with_recursive_tree.rb

@@ -1,31 +1,10 @@
-require "active_support/concern"
-
 require "with_recursive_tree/version"
 
 module WithRecursiveTree
-  extend ActiveSupport::Concern
-
-  included do
-    scope :bfs, -> {
-      if defined?(ActiveRecord::ConnectionAdapters::MySQL)
-        order :depth, with_recursive_tree_order
-      else
-        order :depth
-      end
-    }
-    scope :dfs, -> do
-      if defined?(ActiveRecord::ConnectionAdapters::MySQL)
-        order with_recursive_tree_order, :path
-      elsif defined?(ActiveRecord::ConnectionAdapters::PostgreSQL)
-        order :path
-      elsif defined?(ActiveRecord::ConnectionAdapters::SQLite3)
-        self
-      end
-    end
-  end
-
-  class_methods do
+  module ClassMethods
     def with_recursive_tree(primary_key: :id, foreign_key: :parent_id, order: nil)
+      include InstanceMethods
+
       belongs_to :parent, class_name: name, primary_key: primary_key, foreign_key: foreign_key, inverse_of: :children, optional: true
 
       has_many :children, -> { order order }, class_name: name, primary_key: primary_key, foreign_key: foreign_key, inverse_of: :parent
@@ -33,92 +12,111 @@ module WithRecursiveTree
       define_singleton_method(:with_recursive_tree_primary_key) { primary_key }
       define_singleton_method(:with_recursive_tree_foreign_key) { foreign_key }
       define_singleton_method(:with_recursive_tree_order) { order || primary_key }
-    end
-
-    def roots
-      where with_recursive_tree_foreign_key => nil
-    end
+      define_singleton_method(:with_recursive_tree_order_column) do
+        if with_recursive_tree_order.is_a?(Hash)
+          with_recursive_tree_order.keys.first
+        else
+          with_recursive_tree_order.to_s.split(" ").first
+        end
+      end
 
-    def with_recursive_tree_order_column
-      if with_recursive_tree_order.is_a?(Hash)
-        with_recursive_tree_order.keys.first
-      else
-        with_recursive_tree_order.to_s.split(" ").first
+      scope :bfs, -> {
+        if defined?(ActiveRecord::ConnectionAdapters::MySQL)
+          order(:depth, with_recursive_tree_order)
+        else
+          order(:depth)
+        end
+      }
+      scope :dfs, -> do
+        if defined?(ActiveRecord::ConnectionAdapters::MySQL)
+          order(with_recursive_tree_order, :path)
+        elsif defined?(ActiveRecord::ConnectionAdapters::PostgreSQL)
+          order(:path)
+        elsif defined?(ActiveRecord::ConnectionAdapters::SQLite3)
+          self
+        end
       end
+      scope :roots, -> { where with_recursive_tree_foreign_key => nil }
     end
   end
 
-  def ancestors
-    self_and_ancestors.excluding self
-  end
-
-  def descendants
-    self_and_descendants.excluding self
-  end
-
-  def leaf?
-    children.none?
-  end
+  module InstanceMethods
+    def ancestors
+      self_and_ancestors.excluding self
+    end
 
-  def depth
-    attributes["depth"] || ancestors.count
-  end
-  alias_method :level, :depth
+    def descendants
+      self_and_descendants.excluding self
+    end
 
-  def root
-    self_and_ancestors.find_by self.class.with_recursive_tree_foreign_key => nil
-  end
+    def leaf?
+      children.none?
+    end
 
-  def root?
-    parent.blank?
-  end
+    def depth
+      attributes["depth"] || ancestors.count
+    end
+    alias_method :level, :depth
 
-  def self_and_ancestors
-    self.class.with_recursive(
-      tree: [
-        self.class.where(self.class.with_recursive_tree_primary_key => send(self.class.with_recursive_tree_primary_key)),
-        self.class.joins("JOIN tree ON #{self.class.table_name}.#{self.class.with_recursive_tree_primary_key} = tree.#{self.class.with_recursive_tree_foreign_key}")
-      ]
-    ).select("*").from("tree AS #{self.class.table_name}")
-  end
+    def root
+      self_and_ancestors.find_by self.class.with_recursive_tree_foreign_key => nil
+    end
 
-  def self_and_descendants
-    anchor_path = if defined?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
-      "ARRAY[#{self.class.with_recursive_tree_order_column}]::text[]"
-    elsif defined?(ActiveRecord::ConnectionAdapters::MySQL)
-      "CAST(CONCAT('/', #{self.class.with_recursive_tree_primary_key}, '/') AS CHAR(512))"
-    elsif defined?(ActiveRecord::ConnectionAdapters::SQLite3Adapter)
-      "'/' || #{self.class.with_recursive_tree_primary_key} || '/'"
+    def root?
+      parent.blank?
     end
 
-    recursive_path = if defined?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
-      "tree.path || #{self.class.table_name}.#{self.class.with_recursive_tree_order_column}::text"
-    elsif defined?(ActiveRecord::ConnectionAdapters::MySQL)
-      "CONCAT(tree.path, #{self.class.table_name}.#{self.class.with_recursive_tree_primary_key}, '/')"
-    elsif defined?(ActiveRecord::ConnectionAdapters::SQLite3)
-      "tree.path || #{self.class.table_name}.#{self.class.with_recursive_tree_primary_key} || '/'"
+    def self_and_ancestors
+      self.class.with_recursive(
+        tree: [
+          self.class.where(self.class.with_recursive_tree_primary_key => send(self.class.with_recursive_tree_primary_key)),
+          self.class.joins("JOIN tree ON #{self.class.table_name}.#{self.class.with_recursive_tree_primary_key} = tree.#{self.class.with_recursive_tree_foreign_key}")
+        ]
+      ).select("*").from("tree AS #{self.class.table_name}")
     end
 
-    recursive_query = self.class.joins("JOIN tree ON #{self.class.table_name}.#{self.class.with_recursive_tree_foreign_key} = tree.#{self.class.with_recursive_tree_primary_key}").select("#{self.class.table_name}.*, #{recursive_path} AS path, depth + 1 AS depth")
+    def self_and_descendants
+      anchor_path = if defined?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
+        "ARRAY[#{self.class.with_recursive_tree_order_column}]::text[]"
+      elsif defined?(ActiveRecord::ConnectionAdapters::MySQL)
+        "CAST(CONCAT('/', #{self.class.with_recursive_tree_primary_key}, '/') AS CHAR(512))"
+      elsif defined?(ActiveRecord::ConnectionAdapters::SQLite3Adapter)
+        "'/' || #{self.class.with_recursive_tree_primary_key} || '/'"
+      end
+
+      recursive_path = if defined?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
+        "tree.path || #{self.class.table_name}.#{self.class.with_recursive_tree_order_column}::text"
+      elsif defined?(ActiveRecord::ConnectionAdapters::MySQL)
+        "CONCAT(tree.path, #{self.class.table_name}.#{self.class.with_recursive_tree_primary_key}, '/')"
+      elsif defined?(ActiveRecord::ConnectionAdapters::SQLite3)
+        "tree.path || #{self.class.table_name}.#{self.class.with_recursive_tree_primary_key} || '/'"
+      end
 
-    unless defined?(ActiveRecord::ConnectionAdapters::MySQL)
-      recursive_query = recursive_query.order(self.class.with_recursive_tree_order)
+      recursive_query = self.class.joins("JOIN tree ON #{self.class.table_name}.#{self.class.with_recursive_tree_foreign_key} = tree.#{self.class.with_recursive_tree_primary_key}").select("#{self.class.table_name}.*, #{recursive_path} AS path, depth + 1 AS depth")
+
+      unless defined?(ActiveRecord::ConnectionAdapters::MySQL)
+        recursive_query = recursive_query.order(self.class.with_recursive_tree_order)
+      end
+
+      self.class.with_recursive(
+        tree: [
+          self.class.where(self.class.with_recursive_tree_primary_key => send(self.class.with_recursive_tree_primary_key)).select("*, #{anchor_path} AS path, 0 AS depth"),
+          Arel.sql(recursive_query.to_sql)
+        ]
+      ).select("*").from("tree AS #{self.class.table_name}")
     end
 
-    self.class.with_recursive(
-      tree: [
-        self.class.where(self.class.with_recursive_tree_primary_key => send(self.class.with_recursive_tree_primary_key)).select("*, #{anchor_path} AS path, 0 AS depth"),
-        Arel.sql(recursive_query.to_sql)
-      ]
-    ).select("*").from("tree AS #{self.class.table_name}")
-  end
+    def self_and_siblings
+      root? ? self.class.roots : parent.children
+    end
 
-  def self_and_siblings
-    root? ? self.class.roots : parent.children
+    def siblings
+      self_and_siblings.excluding self
+    end
   end
 
-  def siblings
-    self_and_siblings.excluding self
+  def self.included(mod)
+    mod.extend ClassMethods
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: with_recursive_tree
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Patricio Mac Adden
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-03 00:00:00.000000000 Z
+date: 2025-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -77,7 +77,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="