hierarchy-tree 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a387476231d9e229cd35249afe3cdd379d88cb8de7ad5e20147788f905e37868
-  data.tar.gz: 71289f5698f69dd47c36c1ba1127b14ce0d0a5a409149e3be284e4f6406890d6
+  metadata.gz: cab69803c942b2cda581356ae1c3701febf660db154041a799d0c2dd22eefbfa
+  data.tar.gz: de33c12ba0a884a268d0730a3fce604591b9d62ff5b07e994e583b9e8524316a
 SHA512:
-  metadata.gz: aa5205f67c7ac11a1e981de223fd1d18d19ac65b44ec0695db6b093043d3f185776a887f2c51ab30521c37ddf68b6c08605ae8a399d379b6ad6063b1b65636a1
-  data.tar.gz: 97029a37131556fa12d7bb2e8394cbcadfa7236e186f03e6c006ffc2a54a6dd79307f89c1307c50f6d276c20db020f824745576abcec7d32ccf043f12c0967e7
+  metadata.gz: eecf514e48906d8fcc98e5c80896e56b0d2cf1d2f60d207ce644dc72b131c35fe0d6329d3f786cb2ed35df8f113bf9c11d6b3083835a39e7600c22adc7d3c631
+  data.tar.gz: 9dacd1c66e4bb7355eeee8bf51341bcfa3d3a6cea7d76b6bce0a6057614e48a6bf8751ba064da6ec54b5f84cb1a41063e3c7904c4f8fbf12cec4db86905e98cf

data/lib/hierarchy_tree.rb

@@ -1,17 +1,73 @@
 require 'active_record'
 require 'active_support/core_ext/object/inclusion.rb'
 
+################ Debug ################
+# gem uninstall hierarchy-tree -v 0.3.0
+# rm hierarchy-tree-0.3.0.gem
+# gem build hierarchy_tree
+# gem install hierarchy-tree-0.3.0.gem
+# ruby -Itest test/test_hierarchy_tree.rb
+
 class Hierarchy
-  # Return the full hierarchy starting from the provided class
+  # Return the full hierarchy as associations starting from the provided class
   def self.associations(klass)
-    build_hierarchy(klass)
+    build_hierarchy(class: klass)
+  end
+
+  # Return the full hierarchy as classes starting from the provided class
+  def self.classes(klass)
+    build_hierarchy(class: klass, classes?: true)
   end
 
-  # Return just the descendant classes of a provided class
-  def self.descendants(klass)
-    @descendants = []
+  # Return the array of children classes
+  def self.classes_list(klass)
+    @classes_list = []
     build_descendants(klass)
-    @descendants
+    @classes_list
+  end
+
+  # Return the ancestors associations by navigating through :belongs_to
+  # Starting from the "from" class towards the "to" class
+  # Using DFS - Depth First Search, thus finding the Deepest Path (more likely)
+  def self.ancestors_dfs(from:, to:, descendants: [])
+    return if from.to_s == to.to_s and descendants == [] # Base case
+    return 'loop' if from.in? descendants # Avoids cycle
+
+    descendants.push(from)
+
+    from.reflect_on_all_associations(:belongs_to).map do |relation|
+      return relation.name if relation.klass.to_s == to.to_s # Path is found
+      path = ancestors_dfs(from: relation.klass, to: to, descendants: descendants)
+      return { relation.name => path } if valid_path?(path, to.model_name.param_key.to_sym)
+    end.compact.first
+  end
+
+  # Return the ancestors associations by navigating through :belongs_to
+  # Starting from the "from" class towards the "to" class
+  # Using BFS - Breadth First Search, thus finding the Shortest Path
+  def self.ancestors_bfs(from:, to:)
+    return if from == to
+
+    queue = [{ class: from, path: [] }]
+    visited = [from]
+
+    while queue.any?
+      current = queue.shift
+      current_class = current[:class]
+      current_path = current[:path]
+
+      current_class.reflect_on_all_associations(:belongs_to).each do |relation|
+        next_class = relation.klass
+        next_path = current_path + [relation.name]
+
+        return hashify(next_path) if next_class.to_s == to.to_s
+
+        if visited.exclude?(next_class)
+          visited << next_class
+          queue.push({ class: next_class, path: next_path })
+        end
+      end
+    end
   end
 
   def self.loop?(klass)
@@ -23,9 +79,9 @@ class Hierarchy
 
   private_class_method
 
-  def self.build_hierarchy(klass)
+  def self.build_hierarchy(opts)
     @cache = {}
-    dfs_hierarchy(class: klass)
+    dfs_hierarchy(opts)
   rescue SystemStackError
     Rails.logger.ap "Infinite loop detected and handled for #{opts[:class]} hierarchy", :warn
     []
@@ -81,17 +137,38 @@ class Hierarchy
   def self.build_descendants(klass)
     dfs_descendants(class: klass, classes?: true)
   rescue SystemStackError
-    Rails.logger.ap "Infinite loop detected and handled for #{opts[:class]} descendants", :warn
+    Rails.logger.ap "Infinite loop detected and handled for #{opts[:class]} classes_list", :warn
     []
   end
 
   def self.dfs_descendants(opts, klass_name = nil)
-    return if klass_name.in? @descendants
-    @descendants.push(klass_name) if klass_name.present?
+    return if klass_name.in? @classes_list
+    @classes_list.push(klass_name) if klass_name.present?
     children_classes(opts).each do |child_klass, child_name|
       child_opts = { class: child_klass, classes?: opts[:classes?] }
       dfs_descendants(child_opts, child_name)
     end
     true
   end
+
+  def self.valid_path?(path, target)
+    return true if path == target
+
+    case path
+    when Array
+      path.any? { |sub_path| valid_path?(sub_path, target) }
+    when Hash
+      path.values.any? { |value| valid_path?(value, target) }
+    else
+      false
+    end
+  end
+
+  def self.hashify(array)
+    if array.length == 1
+      array.first
+    else
+      { array.first => hashify(array.drop(1)) }
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hierarchy-tree
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Victor Cordeiro Costa
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-15 00:00:00.000000000 Z
+date: 2023-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -66,7 +66,7 @@ homepage: https://github.com/Victorcorcos/hierarchy-tree
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: hierarchy-tree is a gem that shows the whole hierarchy and the associations
   related to a desired class.