hierarchy-tree 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c69d1d28db8ef461d3a9dbdc093cee55aeb3899d0127965f5f282402e3a92d20
+  data.tar.gz: 66637e5ac94c03c4add0fe2373141761ce89cb96aeff0b0bf7eda20cdda1a50c
+SHA512:
+  metadata.gz: 4d24c501e41cf7594dd4ade171659fda73b0fde49dd812bd4ac05af3e1fc77b77e9845b101972e067db10cb54af3890d19ed84f1bbddd8b20d1fcac7d1e227dd
+  data.tar.gz: 006ad25440512ff39490a5b7ed8988c7b34c0ce2f73d4085a6947c9cd4e00e2e70f653560c386ff02d8a6e3e3e0ab8ef5bf14ccc09db9f01d641e1fe493b0b72

data/lib/hierarchy_tree.rb

@@ -0,0 +1,97 @@
+require 'active_record'
+require 'active_support/core_ext/object/inclusion.rb'
+
+class Hierarchy
+  # Return the full hierarchy starting from the provided class
+  def self.associations(klass)
+    build_hierarchy(klass)
+  end
+
+  # Return just the descendant classes of a provided class
+  def self.descendants(klass)
+    @descendants = []
+    build_descendants(klass)
+    @descendants
+  end
+
+  def self.loop?(klass)
+    @cache = {}
+    false if dfs_hierarchy(class: klass, classes?: false)
+  rescue SystemStackError
+    true
+  end
+
+  private_class_method
+
+  def self.build_hierarchy(klass)
+    @cache = {}
+    dfs_hierarchy(class: klass)
+  rescue SystemStackError
+    Rails.logger.ap "Infinite loop detected and handled for #{opts[:class]} hierarchy", :warn
+    []
+  end
+
+  def self.dfs_hierarchy(opts, klass_name = nil, ancestral_nodes = [])
+    return @cache[klass_name] if klass_name.in? @cache.keys
+    return klass_name if opts[:class].in? ancestral_nodes # Early abort to not enter in a cycle
+    if leaf?(opts[:class])
+      @cache[klass_name] = klass_name
+      return klass_name if klass_name.present? # Leaf
+      [] # Leaf and Root
+    else
+      ancestral_nodes.push(opts[:class])
+      children_hierarchies = children_classes(opts).map do |c_class, c_name|
+        dfs_hierarchy({ class: c_class, classes?: opts[:classes?] }, c_name, ancestral_nodes.dup)
+      end
+      @cache[klass_name] = { klass_name => children_hierarchies }
+      return @cache[klass_name] if klass_name.present? # Middle
+      children_hierarchies # Root
+    end
+  end
+
+  def self.leaf?(klass)
+    return true if walkables(klass).empty?
+    false
+  end
+
+  def self.children_classes(opts)
+    walkables(opts[:class]).map do |reflection|
+      child_class = get_class(reflection)
+      if opts[:classes?]
+        [child_class, child_class.to_s]
+      else
+        [child_class, reflection.name]
+      end
+    end.uniq
+  end
+
+  def self.walkables(klass)
+    # get all models associated with :has_many or :has_one that are walkable.
+    klass.reflections.values.select do |r|
+      r.macro.in? %i[has_one has_many] and not r.options.key?(:through)
+    end
+  end
+
+  def self.get_class(reflection)
+    child = reflection.name.to_s.singularize.classify
+    child = reflection.options[:class_name].to_s if reflection.options.key?(:class_name)
+    child.constantize
+  end
+
+  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
+    []
+  end
+
+  def self.dfs_descendants(opts, klass_name = nil)
+    return if klass_name.in? @descendants
+    @descendants.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
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: hierarchy-tree
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Victor Cordeiro Costa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.1'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: |-
+  hierarchy-tree is a gem that shows the whole hierarchy
+                                 and the associations related to a desired class.
+email:
+- victorcorcos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/hierarchy_tree.rb
+homepage: https://github.com/Victorcorcos/hierarchy-tree
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.9
+signing_key: 
+specification_version: 4
+summary: hierarchy-tree is a gem that shows the whole hierarchy and the associations
+  related to a desired class.
+test_files: []