Module: LibraryTree

Defined in:

lib/library_tree.rb,
lib/library_tree/node.rb,
lib/library_tree/version.rb,
lib/library_tree/watcher.rb,
lib/library_tree/registry.rb

Defined Under Namespace

Modules: Registry, Version, Watcher Classes: Error, Node

Class Method Summary

• .nodes ⇒ Array<LibraryTree::Node>

  Return all nodes currently tracked in the registry.

• .render ⇒ String

  Render the forest as a string.

• .reset! ⇒ void

  Testing/utility: reset the registry.

• .roots ⇒ Array<LibraryTree::Node>

  Return array of root nodes (modules without parents).

Class Method Details

.nodes ⇒ Array<LibraryTree::Node>

Return all nodes currently tracked in the registry

Returns:

• (Array<LibraryTree::Node>) —

  all known nodes

# File 'lib/library_tree.rb', line 26

def nodes
  Registry.all
end

.render ⇒ String

Render the forest as a string

Returns:

• (String) —

  a textual tree representation of all roots and their descendants

# File 'lib/library_tree.rb', line 32

def render
  roots.map { |r| r.render }.join
end

.reset! ⇒ void

This method returns an undefined value.

Testing/utility: reset the registry

# File 'lib/library_tree.rb', line 38

def reset!
  Registry.reset!
end

.roots ⇒ Array<LibraryTree::Node>

Return array of root nodes (modules without parents)

Returns:

• (Array<LibraryTree::Node>) —

  an array of nodes that have no parents

# File 'lib/library_tree.rb', line 20

def roots
  Registry.roots
end