rubytree 1.0.0 → 1.0.2

data/lib/tree/utils/metrics_methods.rb

@@ -4,9 +4,9 @@
 #
 # Author::  Anupam Sengupta (anupamsg@gmail.com)
 #
-# Time-stamp: <2017-12-21 12:49:25 anupam>
+# Time-stamp: <2021-12-29 13:01:54 anupam>
 #
-# Copyright (C) 2013, 2015, 2017 Anupam Sengupta <anupamsg@gmail.com>
+# Copyright (C) 2013, 2015, 2017, 2021 Anupam Sengupta <anupamsg@gmail.com>
 #
 # All rights reserved.
 #
@@ -36,15 +36,13 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
 
-require_relative '../../../lib/tree'
 require 'structured_warnings'
 
 module Tree::Utils
   # Provides utility functions to measure various tree metrics.
   module TreeMetricsHandler
     # noinspection RubyUnusedLocalVariable
-    def self.included(base)
-
+    def self.included(_base)
       # @!group Metrics and Measures
 
       # @!attribute [r] size
@@ -56,7 +54,7 @@ module Tree::Utils
       #
       # @return [Integer] Total number of nodes in this (sub)tree.
       def size
-        inject(0) {|sum, node| sum + 1 if node}
+        inject(0) { |sum, node| sum + 1 if node }
       end
 
       # @!attribute [r] length
@@ -68,7 +66,7 @@ module Tree::Utils
       # @return [Integer] The total number of nodes in this (sub)tree.
       # @see #size
       def length
-        self.size
+        size
       end
 
       # @!attribute [r] node_height
@@ -82,6 +80,7 @@ module Tree::Utils
       # @return [Integer] Height of the node.
       def node_height
         return 0 if is_leaf?
+
         1 + @children.collect { |child| child.node_height }.max
       end
 
@@ -100,6 +99,7 @@ module Tree::Utils
       # @return [Integer] Depth of this node.
       def node_depth
         return 0 if is_root?
+
         1 + parent.node_depth
       end
 
@@ -134,6 +134,7 @@ module Tree::Utils
              'Please use node_depth() or node_height() instead (bug # 22535)'
 
         return 1 if is_leaf?
+
         1 + @children.collect { |child| child.depth }.max
       end
 

data/lib/tree/utils/path_methods.rb

@@ -4,9 +4,9 @@
 #
 # Author::  Marco Ziccardi and Anupam Sengupta (anupamsg@gmail.com)
 #
-# Time-stamp: <2015-05-30 16:04:00 anupam>
+# Time-stamp: <2021-12-29 13:01:58 anupam>
 #
-# Copyright (C) 2015 Anupam Sengupta <anupamsg@gmail.com>
+# Copyright (C) 2015, 2021 Anupam Sengupta <anupamsg@gmail.com>
 #
 # All rights reserved.
 #
@@ -36,14 +36,11 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
 
-require_relative '../../../lib/tree'
-
 module Tree::Utils
   # Provides utility methods for path extraction
   module TreePathHandler
     # noinspection RubyUnusedLocalVariable
-    def self.included(base)
-
+    def self.included(_base)
       # @!group Node Path
 
       # Returns the path of this node from the root as a string, with the node
@@ -90,5 +87,4 @@ module Tree::Utils
       # @!endgroup
     end # self.included
   end
-
 end

data/lib/tree/utils/tree_merge_handler.rb

@@ -40,7 +40,6 @@ require_relative '../../../lib/tree/utils/utils'
 # Provides utility methods to merge two {Tree::TreeNode} based trees.
 # @since 0.9.0
 module Tree::Utils::TreeMergeHandler
-
   # @!group Merging Trees
 
   # Merge two trees that share the same root node and returns <em>a new
@@ -62,7 +61,7 @@ module Tree::Utils::TreeMergeHandler
   #                        have the same root node as self.
   def merge(other_tree)
     check_merge_prerequisites(other_tree)
-    merge_trees(self.root.dup, other_tree.root)
+    merge_trees(root.dup, other_tree.root)
   end
 
   # Merge in another tree (that shares the same root node) into +this+ tree.
@@ -79,8 +78,8 @@ module Tree::Utils::TreeMergeHandler
   # @raise [ArgumentError] This exception is raised if _other_tree_ does not
   #                        have the same root node as self.
   def merge!(other_tree)
-    check_merge_prerequisites( other_tree )
-    merge_trees( self.root, other_tree.root )
+    check_merge_prerequisites(other_tree)
+    merge_trees(root, other_tree.root)
   end
 
   private
@@ -97,7 +96,7 @@ module Tree::Utils::TreeMergeHandler
             'You can only merge in another instance of Tree::TreeNode'
     end
 
-    unless self.root.name == other_tree.root.name
+    unless root.name == other_tree.root.name
       raise ArgumentError,
             'Unable to merge trees as they do not share the same root'
     end
@@ -121,10 +120,9 @@ module Tree::Utils::TreeMergeHandler
     end
 
     tree1.children.each do |child|
-      merge_trees( child, tree2[child.name] ) unless tree2[child.name].nil?
+      merge_trees(child, tree2[child.name]) unless tree2[child.name].nil?
     end
 
     tree1
   end
-
 end

data/lib/tree/utils/utils.rb

@@ -4,9 +4,9 @@
 #
 # Author::  Anupam Sengupta (anupamsg@gmail.com)
 #
-# Time-stamp: <2015-05-30 14:25:57 anupam>
+# Time-stamp: <2021-12-29 13:02:08 anupam>
 #
-# Copyright (C) 2012, 2015 Anupam Sengupta <anupamsg@gmail.com>
+# Copyright (C) 2012, 2015, 2021 Anupam Sengupta <anupamsg@gmail.com>
 #
 # All rights reserved.
 #
@@ -37,8 +37,6 @@
 
 # Provides utilities and mixin modules for RubyTree.
 
-require_relative '../../../lib/tree'
-
 module Tree::Utils
   # Empty module.  Being used as a namespace.
 end

data/lib/tree/version.rb

@@ -4,7 +4,7 @@
 #
 # Author:: Anupam Sengupta (anupamsg@gmail.com)
 #
-# Copyright (c) 2012, 2013, 2014, 2015, 2017 Anupam Sengupta
+# Copyright (c) 2012, 2013, 2014, 2015, 2017, 2020, 2021 Anupam Sengupta
 #
 # All rights reserved.
 #
@@ -34,8 +34,7 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
 
-#
 module Tree
   # Rubytree Package Version
-  VERSION = '1.0.0'
+  VERSION = '1.0.2'.freeze
 end

data/lib/tree.rb

@@ -9,7 +9,7 @@
 # Author:: Anupam Sengupta (anupamsg@gmail.com)
 #
 
-# Copyright (c) 2006-2015, 2017 Anupam Sengupta
+# Copyright (c) 2006-2021 Anupam Sengupta
 #
 # All rights reserved.
 #
@@ -47,7 +47,6 @@ require 'tree/tree_deps'
 # This module also acts as the namespace for all classes in the *RubyTree*
 # package.
 module Tree
-
   # == TreeNode Class Description
   #
   # This class models the nodes for an *N-ary* tree data structure. The
@@ -109,11 +108,11 @@ module Tree
     # +content+ attribute for any non-unique node requirements.
     #
     # If you want to change the name, you probably want to call +rename+
-    # instead.
+    # instead. Note that +name=+ is a protected method.
     #
     # @see content
     # @see rename
-    attr_reader   :name
+    attr_accessor :name
 
     # @!attribute [rw] content
     # Content of this node.  Can be +nil+.  Note that there is no
@@ -177,7 +176,7 @@ module Tree
       return nil if is_root?
 
       parentage_array = []
-      prev_parent = self.parent
+      prev_parent = parent
       while prev_parent
         parentage_array << prev_parent
         prev_parent = prev_parent.parent
@@ -216,18 +215,20 @@ module Tree
     #
     # @see #[]
     def initialize(name, content = nil)
-      raise ArgumentError, 'Node name HAS to be provided!' if name == nil
-      @name, @content = name, content
+      raise ArgumentError, 'Node name HAS to be provided!' if name.nil?
+
+      @name = name
+      @content = content
 
-      if name.kind_of?(Integer)
+      if name.is_a?(Integer)
         warn StructuredWarnings::StandardWarning,
              'Using integer as node name.'\
              ' Semantics of TreeNode[] may not be what you expect!'\
              " #{name} #{content}"
       end
 
-      self.set_as_root!
-      @children_hash = Hash.new
+      set_as_root!
+      @children_hash = {}
       @children = []
     end
 
@@ -254,22 +255,21 @@ module Tree
     # Alias for {Tree::TreeNode#detached_subtree_copy}
     #
     # @see Tree::TreeNode#detached_subtree_copy
-    alias :dup :detached_subtree_copy
+    alias dup detached_subtree_copy
 
     # Returns a {marshal-dump}[http://ruby-doc.org/core-1.8.7/Marshal.html]
     # representation of the (sub)tree rooted at this node.
     #
     def marshal_dump
-      self.collect { |node| node.create_dump_rep }
+      collect { |node| node.create_dump_rep }
     end
 
     # Creates a dump representation of this node and returns the same as
     # a hash.
-    def create_dump_rep           # :nodoc:
-      {name: @name,
-       parent: (is_root? ? nil : @parent.name),
-       content: Marshal.dump(@content)
-      }
+    def create_dump_rep # :nodoc:
+      { name: @name,
+        parent: (is_root? ? nil : @parent.name),
+        content: Marshal.dump(@content) }
     end
 
     protected :create_dump_rep
@@ -284,7 +284,7 @@ module Tree
     #       self and makes itself the root.
     #
     def marshal_load(dumped_tree_array)
-      nodes = { }
+      nodes = {}
       dumped_tree_array.each do |node_hash|
         name        = node_hash[:name]
         parent_name = node_hash[:parent]
@@ -297,7 +297,7 @@ module Tree
           # This is the root node, hence initialize self.
           initialize(name, content)
 
-          nodes[name] = self    # Add self to the list of nodes
+          nodes[name] = self # Add self to the list of nodes
         end
       end
     end
@@ -309,7 +309,7 @@ module Tree
     #
     # @return [String] A string representation of the node.
     def to_s
-      "Node Name: #{@name} Content: #{(@content.to_s || '<Empty>')} Parent: #{(is_root? ? '<None>' : @parent.name.to_s)} Children: #{@children.length} Total Nodes: #{size}"
+      "Node Name: #{@name} Content: #{@content.to_s || '<Empty>'} Parent: #{is_root? ? '<None>' : @parent.name.to_s} Children: #{@children.length} Total Nodes: #{size}"
     end
 
     # @!group Structure Modification
@@ -377,19 +377,18 @@ module Tree
     # @see #<<
     def add(child, at_index = -1)
       # Only handles the immediate child scenario
-      raise ArgumentError,
-            'Attempting to add a nil node' unless child
-      raise ArgumentError,
-            'Attempting add node to itself' if self.equal?(child)
-      raise ArgumentError,
-            'Attempting add root as a child' if child.equal?(root)
-
-      # Lazy mans unique test, won't test if children of child are unique in
+      raise ArgumentError, 'Attempting to add a nil node' unless child
+
+      raise ArgumentError, 'Attempting add node to itself' if equal?(child)
+
+      raise ArgumentError, 'Attempting add root as a child' if child.equal?(root)
+
+      # Lazy man's unique test, won't test if children of child are unique in
       # this tree too.
       raise "Child #{child.name} already added!"\
             if @children_hash.include?(child.name)
 
-      child.parent.remove! child if child.parent # Detach from the old parent
+      child.parent&.remove! child # Detach from the old parent
 
       if insertion_range.include?(at_index)
         @children.insert(at_index, child)
@@ -400,7 +399,7 @@ module Tree
               "#{insertion_range.min} to #{insertion_range.max} exist."
       end
 
-      @children_hash[child.name]  = child
+      @children_hash[child.name] = child
       child.parent = self
       child
     end
@@ -408,7 +407,7 @@ module Tree
     # Return a range of valid insertion positions.  Used in the #add method.
     def insertion_range
       max = @children.size
-      min = -(max+1)
+      min = -(max + 1)
       min..max
     end
 
@@ -424,7 +423,7 @@ module Tree
       old_name = @name
 
       if is_root?
-        self.name=(new_name)
+        self.name = new_name
       else
         @parent.rename_child old_name, new_name
       end
@@ -441,20 +440,10 @@ module Tree
     #   pass a String (Integer names may cause *surprises*)
     def rename_child(old_name, new_name)
       raise ArgumentError, "Invalid child name specified: #{old_name}"\
-            unless @children_hash.has_key?(old_name)
+            unless @children_hash.key?(old_name)
 
       @children_hash[new_name] = @children_hash.delete(old_name)
-      @children_hash[new_name].name=(new_name)
-    end
-
-    # Protected method to set the name of this node.
-    # This method should *NOT* be invoked by client code.
-    #
-    # @param [Object] new_name The node Name to set.
-    #
-    # @return [Object] The new name.
-    def name=(new_name)
-      @name = new_name
+      @children_hash[new_name].name = new_name
     end
 
     # Replaces the specified child node with another child node on this node.
@@ -510,7 +499,7 @@ module Tree
     # @param [Tree::TreeNode] parent The parent node.
     #
     # @return [Tree::TreeNode] The parent node.
-    def parent=(parent)         # :nodoc:
+    def parent=(parent) # :nodoc:
       @parent = parent
       @node_depth = nil
     end
@@ -549,7 +538,7 @@ module Tree
     # Protected method which sets this node as a root node.
     #
     # @return +nil+.
-    def set_as_root!              # :nodoc:
+    def set_as_root! # :nodoc:
       self.parent = nil
     end
 
@@ -560,7 +549,7 @@ module Tree
     # The nodes become immutable after this operation.  In effect, the entire tree's
     # structure and contents become _read-only_ and cannot be changed.
     def freeze_tree!
-      each {|node| node.freeze}
+      each { |node| node.freeze }
     end
 
     # @!endgroup
@@ -600,14 +589,13 @@ module Tree
     #
     # @see #add
     # @see #initialize
-    def [](name_or_index, num_as_name=false)
-      raise ArgumentError,
-            'Name_or_index needs to be provided!' if name_or_index == nil
+    def [](name_or_index, num_as_name = false)
+      raise ArgumentError, 'Name_or_index needs to be provided!' if name_or_index.nil?
 
-      if name_or_index.kind_of?(Integer) and not num_as_name
+      if name_or_index.is_a?(Integer) && !num_as_name
         @children[name_or_index]
       else
-        if num_as_name and not name_or_index.kind_of?(Integer)
+        if num_as_name && !name_or_index.is_a?(Integer)
           warn StructuredWarnings::StandardWarning,
                'Redundant use of the `num_as_name` flag for non-integer node name'
         end
@@ -630,19 +618,18 @@ module Tree
     # @return [Tree::TreeNode] this node, if a block if given
     # @return [Enumerator] an enumerator on this tree, if a block is *not* given
     # noinspection RubyUnusedLocalVariable
-    def each(&block)             # :yields: node
+    def each # :yields: node
+      return to_enum unless block_given?
 
-     return self.to_enum unless block_given?
-
-      node_stack = [self]   # Start with this node
+      node_stack = [self] # Start with this node
 
       until node_stack.empty?
-        current = node_stack.shift    # Pop the top-most node
-        if current                    # Might be 'nil' (esp. for binary trees)
-          yield current               # and process it
-          # Stack children of the current node at top of the stack
-          node_stack = current.children.concat(node_stack)
-        end
+        current = node_stack.shift # Pop the top-most node
+        next unless current # Might be 'nil' (esp. for binary trees)
+
+        yield current # and process it
+        # Stack children of the current node at top of the stack
+        node_stack = current.children.concat(node_stack)
       end
 
       self if block_given?
@@ -658,7 +645,7 @@ module Tree
     #
     # @return [Tree::TreeNode] this node, if a block if given
     # @return [Enumerator] an enumerator on this tree, if a block is *not* given
-    def preordered_each(&block)  # :yields: node
+    def preordered_each(&block) # :yields: node
       each(&block)
     end
 
@@ -672,8 +659,8 @@ module Tree
     # @return [Tree::TreeNode] this node, if a block if given
     # @return [Enumerator] an enumerator on this tree, if a block is *not* given
     # noinspection RubyUnusedLocalVariable
-    def postordered_each(&block)
-      return self.to_enum(:postordered_each) unless block_given?
+    def postordered_each
+      return to_enum(:postordered_each) unless block_given?
 
       # Using a marked node in order to skip adding the children of nodes that
       # have already been visited. This allows the stack depth to be controlled,
@@ -683,15 +670,15 @@ module Tree
 
       until node_stack.empty?
         peek_node = node_stack[0]
-        if peek_node.node.has_children? and not peek_node.visited
+        if peek_node.node.has_children? && !peek_node.visited
           peek_node.visited = true
           # Add the children to the stack. Use the marking structure.
           marked_children =
-            peek_node.node.children.map {|node| marked_node.new(node, false)}
+            peek_node.node.children.map { |node| marked_node.new(node, false) }
           node_stack = marked_children.concat(node_stack)
           next
         else
-          yield node_stack.shift.node           # Pop and yield the current node
+          yield node_stack.shift.node # Pop and yield the current node
         end
       end
 
@@ -711,10 +698,10 @@ module Tree
     # @return [Tree::TreeNode] this node, if a block if given
     # @return [Enumerator] an enumerator on this tree, if a block is *not* given
     # noinspection RubyUnusedLocalVariable
-    def breadth_each(&block)
-      return self.to_enum(:breadth_each) unless block_given?
+    def breadth_each
+      return to_enum(:breadth_each) unless block_given?
 
-      node_queue = [self]       # Create a queue with self as the initial entry
+      node_queue = [self] # Create a queue with self as the initial entry
 
       # Use a queue to do breadth traversal
       until node_queue.empty?
@@ -739,9 +726,9 @@ module Tree
     #
     # @return [Array<Tree::TreeNode>] An array of the child nodes, if no block
     #                                 is given.
-    def children
+    def children(&block)
       if block_given?
-        @children.each {|child| yield child}
+        @children.each(&block)
         self
       else
         @children.clone
@@ -763,15 +750,37 @@ module Tree
     # @return [Tree::TreeNode] this node, if a block if given
     # @return [Array<Tree::TreeNode>] An array of the leaf nodes
     # noinspection RubyUnusedLocalVariable
-    def each_leaf(&block)
+    def each_leaf
       if block_given?
-        self.each { |node| yield(node) if node.is_leaf? }
+        each { |node| yield(node) if node.is_leaf? }
         self
       else
         self.select { |node| node.is_leaf? }
       end
     end
 
+    # Yields every level of the (sub)tree rooted at this node to the
+    # specified block.
+    #
+    # Will yield this node as well since it is considered the first level.
+    #
+    # @yieldparam level [Array<Tree::TreeNode>] All nodes in the level
+    #
+    # @return [Tree::TreeNode] this node, if a block if given
+    # @return [Enumerator] an enumerator on this tree, if a block is *not* given
+    def each_level
+      if block_given?
+        level = [self]
+        until level.empty?
+          yield level
+          level = level.map(&:children).flatten
+        end
+        self
+      else
+        each
+      end
+    end
+
     # @!endgroup
 
     # @!group Navigating the Child Nodes
@@ -866,9 +875,11 @@ module Tree
         self
       else
         return [] if is_root?
+
         siblings = []
-        parent.children {|my_sibling|
-                         siblings << my_sibling if my_sibling != self}
+        parent.children do |my_sibling|
+          siblings << my_sibling if my_sibling != self
+        end
         siblings
       end
     end
@@ -930,8 +941,9 @@ module Tree
     #                   this node is a 'predecessor'. Returns 'nil' if the other
     #                   object is not a 'Tree::TreeNode'.
     def <=>(other)
-      return nil if other == nil || other.class != Tree::TreeNode
-      self.name <=> other.name
+      return nil if other.nil? || other.class != Tree::TreeNode
+
+      name <=> other.name
     end
 
     # Pretty prints the (sub)tree rooted at this node.
@@ -940,9 +952,10 @@ module Tree
     # @param [Integer] max_depth optional maximum depth at which the printing
     #                            with stop.
     # @param [Proc] block optional block to use for rendering
-    def print_tree(level = self.node_depth, max_depth = nil,
+    def print_tree(level = node_depth, max_depth = nil,
                    block = lambda { |node, prefix|
-                     puts "#{prefix} #{node.name}" })
+                             puts "#{prefix} #{node.name}"
+                           })
       prefix = ''
 
       if is_root?
@@ -960,10 +973,11 @@ module Tree
       # Exit if the max level is defined, and reached.
       return unless max_depth.nil? || level < max_depth
 
-      children { |child|
-        child.print_tree(level + 1,
-                         max_depth, block) if child } # Child might be 'nil'
+      # Child might be 'nil'
+      children do |child|
+        child&.print_tree(level + 1,
+                          max_depth, block)
+      end
     end
-
   end
 end