with_recursive_tree 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c1ccdf38306a7ddff768b00b73f3d3ff58bf094f7524e55b63e0502f4d757dd
-  data.tar.gz: 5572ccbc0023f7d7226b41f24ffa8513084dc2e8780075f48904dac3aa510a96
+  metadata.gz: 577a92da7b862dcefb0b95b7a95e56bf2e3dede08cd87f940ca76691300caf88
+  data.tar.gz: c5d32bf01cb73cd8e4f9d1d8d845c6a9c823acef24343d5686de3617d3a1d404
 SHA512:
-  metadata.gz: 0a9003bb5a943e7a4d48abed8db293a292dd21dfae943ab1c4899673920fa1c943b5f949d4caf9351c763b3f62e0a14bbfca0ff3e9dfa8fe7daa8e9f4ea6462e
-  data.tar.gz: 378da103d4c78855cc5c2acef7557e19a27eb2c3f11a4c63d26fa1e29dadff551d433d84060b0f7ef5bd2b711808d97b5c071e80e8f1ff5b61801ddca7a8bd38
+  metadata.gz: e46d3982c72f316453a604deed2879a2ad10f6b97ed9f071f658fb157639958ac851874cc3d4525e744638f97a1592750a29b5c9a2e31a2e001a0472c3cf3527
+  data.tar.gz: 603d05e1f4c5904b243d38f18771605662fa9e72744ba668cd2979ab48b339811b067ff1cf2a4e32eaeeabd3a8d3684f0e8e2e37f052874a4bda8e401759cf2e

data/README.md

@@ -144,6 +144,16 @@ A
 ---R
 ```
 
+## Compatibility
+
+with_recursive_tree is compatible with:
+
+* Rails 6.0 and above
+* Ruby 3.1 and above
+* Postgres version 13 and above
+* MySQL version 8 and above
+* SQLite3 version 3.34 and above
+
 ## 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).

data/lib/with_recursive_tree/backport.rb

@@ -0,0 +1,60 @@
+module WithRecursiveTree
+  def ancestors
+    self_and_ancestors.where.not self.class.with_recursive_tree_primary_key => send(self.class.with_recursive_tree_primary_key)
+  end
+
+  def descendants
+    self_and_descendants.where.not self.class.with_recursive_tree_primary_key => send(self.class.with_recursive_tree_primary_key)
+  end
+
+  def self_and_ancestors
+    sql = <<-SQL
+    WITH RECURSIVE tree AS (
+      #{self.class.where(self.class.with_recursive_tree_primary_key => send(self.class.with_recursive_tree_primary_key)).to_sql}
+      UNION ALL
+      #{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}").to_sql}
+      ) SELECT * FROM tree
+    SQL
+
+    self.class.select("*").from("(#{sql}) AS #{self.class.table_name}")
+  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} || '/'"
+    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
+
+    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")
+
+    # order by is only available in SQLIte for rails versions older than 7.2
+    if defined?(ActiveRecord::ConnectionAdapters::SQLite3)
+      recursive_query = recursive_query.order(self.class.with_recursive_tree_order)
+    end
+
+    sql = <<-SQL
+      WITH RECURSIVE tree AS (
+        #{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").to_sql}
+        UNION ALL
+        #{Arel.sql(recursive_query.to_sql)}
+      ) SELECT * FROM tree
+    SQL
+
+    self.class.select("*").from("(#{sql}) AS #{self.class.table_name}")
+  end
+
+  def siblings
+    self_and_siblings.where.not self.class.with_recursive_tree_primary_key => send(self.class.with_recursive_tree_primary_key)
+  end
+end

data/lib/with_recursive_tree/version.rb

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

data/lib/with_recursive_tree.rb

@@ -6,8 +6,22 @@ module WithRecursiveTree
   extend ActiveSupport::Concern
 
   included do
-    scope :bfs, -> { order :depth }
-    scope :dfs, -> { self }
+    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
@@ -24,6 +38,14 @@ module WithRecursiveTree
     def roots
       where with_recursive_tree_foreign_key => nil
     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
+      end
+    end
   end
 
   def ancestors
@@ -52,21 +74,43 @@ module WithRecursiveTree
   end
 
   def self_and_ancestors
-    self.class.with(search_tree: self.class.with_recursive(
-      search_tree: [
+    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 search_tree ON #{self.class.table_name}.#{self.class.with_recursive_tree_primary_key} = search_tree.#{self.class.with_recursive_tree_foreign_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("search_tree")).from("search_tree AS #{self.class.table_name}")
+    ).select("*").from("tree AS #{self.class.table_name}")
   end
 
   def self_and_descendants
-    self.class.with(search_tree: self.class.with_recursive(
-      search_tree: [
-        self.class.where(self.class.with_recursive_tree_primary_key => send(self.class.with_recursive_tree_primary_key)).select("*, '/' || #{self.class.with_recursive_tree_primary_key} || '/' AS path, 0 AS depth"),
-        Arel.sql(self.class.joins("JOIN search_tree ON #{self.class.table_name}.#{self.class.with_recursive_tree_foreign_key} = search_tree.#{self.class.with_recursive_tree_primary_key}").select("#{self.class.table_name}.*, search_tree.path || #{self.class.table_name}.#{self.class.with_recursive_tree_primary_key} || '/' AS path, depth + 1 AS depth").order(self.class.with_recursive_tree_order).to_sql)
+    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
+
+    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("search_tree")).from("search_tree AS #{self.class.table_name}")
+    ).select("*").from("tree AS #{self.class.table_name}")
   end
 
   def self_and_siblings
@@ -78,6 +122,10 @@ module WithRecursiveTree
   end
 end
 
+if Gem::Dependency.new("", "< 7.2.0").match?("", ActiveRecord::VERSION::STRING)
+  require "with_recursive_tree/backport"
+end
+
 ActiveSupport.on_load :active_record do
   include WithRecursiveTree
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: with_recursive_tree
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Patricio Mac Adden
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-09 00:00:00.000000000 Z
+date: 2025-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '6.0'
 description: Tree structures for ActiveRecord
 email:
 - patriciomacadden@gmail.com
@@ -62,6 +62,7 @@ files:
 - README.md
 - Rakefile
 - lib/with_recursive_tree.rb
+- lib/with_recursive_tree/backport.rb
 - lib/with_recursive_tree/version.rb
 homepage: https://github.com/sinaptia/with_recursive_tree
 licenses: []
@@ -76,7 +77,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="