rubytree 1.0.2 → 2.0.0

data/lib/tree/utils/json_converter.rb

@@ -4,9 +4,9 @@
 #
 # Author::  Anupam Sengupta (anupamsg@gmail.com)
 #
-# Time-stamp: <2015-05-30 14:20:20 anupam>
+# Time-stamp: <2022-06-20 22:16:46 anupam>
 #
-# Copyright (C) 2012, 2013, 2014, 2015 Anupam Sengupta <anupamsg@gmail.com>
+# Copyright (C) 2012, 2013, 2014, 2015, 2022 Anupam Sengupta <anupamsg@gmail.com>
 #
 # All rights reserved.
 #
@@ -34,93 +34,96 @@
 # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# frozen_string_literal: true
 
-require_relative '../utils/utils'
 require 'json'
 
-# Provides utility methods to convert a {Tree::TreeNode} to and from
-# JSON[http://flori.github.com/json/].
-module Tree::Utils::JSONConverter
-  def self.included(base)
-    base.extend(ClassMethods)
-  end
+module Tree
+  module Utils
+    # Provides utility methods to convert a {Tree::TreeNode} to and from
+    # JSON[http://flori.github.com/json/].
+    module JSONConverter
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
 
-  # @!group Converting to/from JSON
+      # @!group Converting to/from JSON
 
-  # Creates a JSON ready Hash for the #to_json method.
-  #
-  # @author Eric Cline (https://github.com/escline)
-  # @since 0.8.3
-  #
-  # @return A hash based representation of the JSON
-  #
-  # Rails uses JSON in ActiveSupport, and all Rails JSON encoding goes through
-  # +as_json+.
-  #
-  # @param [Object] options
-  #
-  # @see #to_json
-  # @see http://stackoverflow.com/a/6880638/273808
-  # noinspection RubyUnusedLocalVariable
-  def as_json(_options = {})
-    json_hash = {
-      name: name,
-      content: content,
-      JSON.create_id => self.class.name
-    }
+      # Creates a JSON ready Hash for the #to_json method.
+      #
+      # @author Eric Cline (https://github.com/escline)
+      # @since 0.8.3
+      #
+      # @return A hash based representation of the JSON
+      #
+      # Rails uses JSON in ActiveSupport, and all Rails JSON encoding goes through
+      # +as_json+.
+      #
+      # @param [Object] _options
+      #
+      # @see #to_json
+      # @see http://stackoverflow.com/a/6880638/273808
+      # noinspection RubyUnusedLocalVariable
+      def as_json(_options = {})
+        json_hash = {
+          name: name,
+          content: content,
+          JSON.create_id => self.class.name
+        }
 
-    json_hash['children'] = children if has_children?
+        json_hash['children'] = children if children?
 
-    json_hash
-  end
+        json_hash
+      end
 
-  # Creates a JSON representation of this node including all it's children.
-  # This requires the JSON gem to be available, or else the operation fails with
-  # a warning message.  Uses the Hash output of #as_json method.
-  #
-  # @author Dirk Breuer (http://github.com/railsbros-dirk)
-  # @since 0.7.0
-  #
-  # @return The JSON representation of this subtree.
-  #
-  # @see ClassMethods#json_create
-  # @see #as_json
-  # @see http://flori.github.com/json
-  def to_json(*a)
-    as_json.to_json(*a)
-  end
+      # Creates a JSON representation of this node including all it's children.
+      # This requires the JSON gem to be available, or else the operation fails with
+      # a warning message.  Uses the Hash output of #as_json method.
+      #
+      # @author Dirk Breuer (http://github.com/railsbros-dirk)
+      # @since 0.7.0
+      #
+      # @return The JSON representation of this subtree.
+      #
+      # @see ClassMethods#json_create
+      # @see #as_json
+      # @see http://flori.github.com/json
+      def to_json(*args)
+        as_json.to_json(*args)
+      end
 
-  # ClassMethods for the {JSONConverter} module. Will become class methods in
-  # the +include+ target.
-  module ClassMethods
-    # Helper method to create a Tree::TreeNode instance from the JSON hash
-    # representation.  Note that this method should *NOT* be called directly.
-    # Instead, to convert the JSON hash back to a tree, do:
-    #
-    #   tree = JSON.parse(the_json_hash)
-    #
-    # This operation requires the {JSON gem}[http://flori.github.com/json/] to
-    # be available, or else the operation fails with a warning message.
-    #
-    # @author Dirk Breuer (http://github.com/railsbros-dirk)
-    # @since 0.7.0
-    #
-    # @param [Hash] json_hash The JSON hash to convert from.
-    #
-    # @return [Tree::TreeNode] The created tree.
-    #
-    # @see #to_json
-    # @see http://flori.github.com/json
-    def json_create(json_hash)
-      node = new(json_hash['name'], json_hash['content'])
+      # ClassMethods for the {JSONConverter} module. Will become class methods in
+      # the +include+ target.
+      module ClassMethods
+        # Helper method to create a Tree::TreeNode instance from the JSON hash
+        # representation.  Note that this method should *NOT* be called directly.
+        # Instead, to convert the JSON hash back to a tree, do:
+        #
+        #   tree = JSON.parse(the_json_hash)
+        #
+        # This operation requires the {JSON gem}[http://flori.github.com/json/] to
+        # be available, or else the operation fails with a warning message.
+        #
+        # @author Dirk Breuer (http://github.com/railsbros-dirk)
+        # @since 0.7.0
+        #
+        # @param [Hash] json_hash The JSON hash to convert from.
+        #
+        # @return [Tree::TreeNode] The created tree.
+        #
+        # @see #to_json
+        # @see http://flori.github.com/json
+        def json_create(json_hash)
+          node = new(json_hash['name'], json_hash['content'])
 
-      if json_hash['children']
-        json_hash['children'].each do |child|
-          node << child
+          json_hash['children']&.each do |child|
+            node << child
+          end
+
+          node
         end
       end
-
-      node
     end
   end
 end

data/lib/tree/utils/metrics_methods.rb

@@ -4,9 +4,9 @@
 #
 # Author::  Anupam Sengupta (anupamsg@gmail.com)
 #
-# Time-stamp: <2021-12-29 13:01:54 anupam>
+# Time-stamp: <2022-06-20 22:17:00 anupam>
 #
-# Copyright (C) 2013, 2015, 2017, 2021 Anupam Sengupta <anupamsg@gmail.com>
+# Copyright (C) 2013, 2015, 2017, 2021, 2022 Anupam Sengupta <anupamsg@gmail.com>
 #
 # All rights reserved.
 #
@@ -35,14 +35,12 @@
 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
+# frozen_string_literal: true
 
-require 'structured_warnings'
-
-module Tree::Utils
-  # Provides utility functions to measure various tree metrics.
-  module TreeMetricsHandler
-    # noinspection RubyUnusedLocalVariable
-    def self.included(_base)
+module Tree
+  module Utils
+    # Provides utility functions to measure various tree metrics.
+    module TreeMetricsHandler
       # @!group Metrics and Measures
 
       # @!attribute [r] size
@@ -79,9 +77,9 @@ module Tree::Utils
       #
       # @return [Integer] Height of the node.
       def node_height
-        return 0 if is_leaf?
+        return 0 if leaf?
 
-        1 + @children.collect { |child| child.node_height }.max
+        1 + @children.collect(&:node_height).max
       end
 
       # @!attribute [r] node_depth
@@ -90,15 +88,11 @@ module Tree::Utils
       # Depth:: Length of the node's path to its root. Depth of a root node is
       # zero.
       #
-      # *Note* that the deprecated method {#depth} was incorrectly computing
-      # this value. Please replace all calls to the old method with
-      # {#node_depth} instead.
-      #
       # {#level} is an alias for this method.
       #
       # @return [Integer] Depth of this node.
       def node_depth
-        return 0 if is_root?
+        return 0 if root?
 
         1 + parent.node_depth
       end
@@ -111,33 +105,6 @@ module Tree::Utils
         node_depth
       end
 
-      # @!attribute [r] depth
-      # Depth of the tree from this node. A single leaf node has a depth of 1.
-      #
-      # This method is *DEPRECATED* and may be removed in the subsequent
-      # releases. Note that the value returned by this method is actually the:
-      #
-      # _height_ + 1 of the node, *NOT* the _depth_.
-      #
-      # For correct and conventional behavior, please use {#node_depth} and
-      # {#node_height} methods instead.
-      #
-      # @return [Integer] depth of the node.
-      #
-      # @deprecated This method returns an incorrect value. Use the
-      # {#node_depth} method instead.
-      #
-      # @see #node_depth
-      def depth
-        warn StructuredWarnings::DeprecatedMethodWarning,
-             'This method is deprecated.  '\
-             'Please use node_depth() or node_height() instead (bug # 22535)'
-
-        return 1 if is_leaf?
-
-        1 + @children.collect { |child| child.depth }.max
-      end
-
       # @!attribute [r] breadth
       # Breadth of the tree at this node's level.
       # A single node without siblings has a breadth of 1.
@@ -148,7 +115,7 @@ module Tree::Utils
       #
       # @return [Integer] breadth of the node's level.
       def breadth
-        is_root? ? 1 : parent.children.size
+        root? ? 1 : parent.children.size
       end
 
       # @!attribute [r] in_degree
@@ -163,7 +130,7 @@ module Tree::Utils
       #
       # @return [Integer] The in-degree of this node.
       def in_degree
-        is_root? ? 0 : 1
+        root? ? 0 : 1
       end
 
       # @!attribute [r] out_degree
@@ -174,10 +141,10 @@ module Tree::Utils
       #
       # @return [Integer] The out-degree of this node.
       def out_degree
-        is_leaf? ? 0 : children.size
+        leaf? ? 0 : children.size
       end
 
       # @!endgroup
-    end # self.included
+    end
   end
 end

data/lib/tree/utils/path_methods.rb

@@ -4,9 +4,9 @@
 #
 # Author::  Marco Ziccardi and Anupam Sengupta (anupamsg@gmail.com)
 #
-# Time-stamp: <2021-12-29 13:01:58 anupam>
+# Time-stamp: <2022-06-20 02:00:11 anupam>
 #
-# Copyright (C) 2015, 2021 Anupam Sengupta <anupamsg@gmail.com>
+# Copyright (C) 2015, 2021, 2022 Anupam Sengupta <anupamsg@gmail.com>
 #
 # All rights reserved.
 #
@@ -35,12 +35,12 @@
 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
+# frozen_string_literal: true
 
-module Tree::Utils
-  # Provides utility methods for path extraction
-  module TreePathHandler
-    # noinspection RubyUnusedLocalVariable
-    def self.included(_base)
+module Tree
+  module Utils
+    # Provides utility methods for path extraction
+    module TreePathHandler
       # @!group Node Path
 
       # Returns the path of this node from the root as a string, with the node
@@ -75,16 +75,16 @@ module Tree::Utils
       def get_path_name_array(current_array_path = [])
         path_array = current_array_path + [name]
 
-        if !parent              # If detached node or root node.
+        if parent               # Recurse to parent node.
+          parent.get_path_name_array(path_array)
+        else                    # else If detached node or root node.
           path_array
-        else                    # Else recurse to parent node.
-          path_array = parent.get_path_name_array(path_array)
         end
       end
 
       protected :get_path_name_array
 
       # @!endgroup
-    end # self.included
+    end
   end
 end

data/lib/tree/utils/tree_merge_handler.rb

@@ -3,9 +3,9 @@
 # tree_merge_handler.rb
 #
 # Author:  Anupam Sengupta
-# Time-stamp: <2015-05-30 16:06:18 anupam>
+# Time-stamp: <2022-06-20 22:17:12 anupam>
 #
-# Copyright (C) 2013, 2015 Anupam Sengupta (anupamsg@gmail.com)
+# Copyright (C) 2013, 2015, 2022 Anupam Sengupta (anupamsg@gmail.com)
 #
 # All rights reserved.
 #
@@ -34,95 +34,95 @@
 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
-
-require_relative '../../../lib/tree/utils/utils'
+# frozen_string_literal: true
 
 # Provides utility methods to merge two {Tree::TreeNode} based trees.
 # @since 0.9.0
-module Tree::Utils::TreeMergeHandler
-  # @!group Merging Trees
+module Tree
+  module Utils
+    # Handles merging of two trees.
+    module TreeMergeHandler
+      # @!group Merging Trees
 
-  # Merge two trees that share the same root node and returns <em>a new
-  # tree</em>.
-  #
-  # The new tree contains the contents of the merge between _other_tree_ and
-  # self. Duplicate nodes (coming from _other_tree_) will *NOT* be overwritten
-  # in self.
-  #
-  # @author Darren Oakley (https://github.com/dazoakley)
-  #
-  # @param [Tree::TreeNode] other_tree The other tree to merge with.
-  # @return [Tree::TreeNode] the resulting tree following the merge.
-  #
-  # @raise [TypeError] This exception is raised if _other_tree_ is not a
-  #                    {Tree::TreeNode}.
-  #
-  # @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(root.dup, other_tree.root)
-  end
+      # Merge two trees that share the same root node and returns <em>a new
+      # tree</em>.
+      #
+      # The new tree contains the contents of the merge between _other_tree_ and
+      # self. Duplicate nodes (coming from _other_tree_) will *NOT* be overwritten
+      # in self.
+      #
+      # @author Darren Oakley (https://github.com/dazoakley)
+      #
+      # @param [Tree::TreeNode] other_tree The other tree to merge with.
+      # @return [Tree::TreeNode] the resulting tree following the merge.
+      #
+      # @raise [TypeError] This exception is raised if _other_tree_ is not a
+      #                    {Tree::TreeNode}.
+      #
+      # @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(root.dup, other_tree.root)
+      end
 
-  # Merge in another tree (that shares the same root node) into +this+ tree.
-  # Duplicate nodes (coming from _other_tree_) will NOT be overwritten in
-  # self.
-  #
-  # @author Darren Oakley (https://github.com/dazoakley)
-  #
-  # @param [Tree::TreeNode] other_tree The other tree to merge with.
-  #
-  # @raise [TypeError] This exception is raised if _other_tree_ is not a
-  #                    {Tree::TreeNode}.
-  #
-  # @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(root, other_tree.root)
-  end
+      # Merge in another tree (that shares the same root node) into +this+ tree.
+      # Duplicate nodes (coming from _other_tree_) will NOT be overwritten in
+      # self.
+      #
+      # @author Darren Oakley (https://github.com/dazoakley)
+      #
+      # @param [Tree::TreeNode] other_tree The other tree to merge with.
+      #
+      # @raise [TypeError] This exception is raised if _other_tree_ is not a
+      #                    {Tree::TreeNode}.
+      #
+      # @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(root, other_tree.root)
+      end
 
-  private
+      private
 
-  # Utility function to check that the conditions for a tree merge are met.
-  #
-  # @author Darren Oakley (https://github.com/dazoakley)
-  #
-  # @see #merge
-  # @see #merge!
-  def check_merge_prerequisites(other_tree)
-    unless other_tree.is_a?(Tree::TreeNode)
-      raise TypeError,
-            'You can only merge in another instance of Tree::TreeNode'
-    end
+      # Utility function to check that the conditions for a tree merge are met.
+      #
+      # @author Darren Oakley (https://github.com/dazoakley)
+      #
+      # @see #merge
+      # @see #merge!
+      def check_merge_prerequisites(other_tree)
+        raise TypeError, 'You can only merge in another instance of Tree::TreeNode' \
+          unless other_tree.is_a?(Tree::TreeNode)
 
-    unless root.name == other_tree.root.name
-      raise ArgumentError,
-            'Unable to merge trees as they do not share the same root'
-    end
-  end
+        raise ArgumentError, 'Unable to merge trees as they do not share the same root' \
+          unless root.name == other_tree.root.name
+      end
 
-  # Utility function to recursively merge two subtrees.
-  #
-  # @author Darren Oakley (https://github.com/dazoakley)
-  #
-  # @param [Tree::TreeNode] tree1 The target tree to merge into.
-  # @param [Tree::TreeNode] tree2 The donor tree (that will be merged
-  #                               into target).
-  # @raise [Tree::TreeNode] The merged tree.
-  def merge_trees(tree1, tree2)
-    names1 = tree1.has_children? ? tree1.children.map { |child| child.name } : []
-    names2 = tree2.has_children? ? tree2.children.map { |child| child.name } : []
+      # Utility function to recursively merge two subtrees.
+      #
+      # @author Darren Oakley (https://github.com/dazoakley)
+      #
+      # @param [Tree::TreeNode] tree1 The target tree to merge into.
+      # @param [Tree::TreeNode] tree2 The donor tree (that will be merged
+      #                               into target).
+      # @raise [Tree::TreeNode] The merged tree.
+      def merge_trees(tree1, tree2)
+        names1 = tree1.children? ? tree1.children.map(&:name) : []
+        names2 = tree2.children? ? tree2.children.map(&:name) : []
 
-    names_to_merge = names2 - names1
-    names_to_merge.each do |name|
-      tree1 << tree2[name].detached_subtree_copy
-    end
+        names_to_merge = names2 - names1
+        names_to_merge.each do |name|
+          tree1 << tree2[name].detached_subtree_copy
+        end
 
-    tree1.children.each do |child|
-      merge_trees(child, tree2[child.name]) unless tree2[child.name].nil?
-    end
+        tree1.children.each do |child|
+          merge_trees(child, tree2[child.name]) unless tree2[child.name].nil?
+        end
 
-    tree1
+        tree1
+      end
+    end
   end
 end

data/lib/tree/utils/utils.rb

@@ -4,11 +4,9 @@
 #
 # Author::  Anupam Sengupta (anupamsg@gmail.com)
 #
-# Time-stamp: <2021-12-29 13:02:08 anupam>
+# Time-stamp: <2022-06-20 01:21:38 anupam>
 #
-# Copyright (C) 2012, 2015, 2021 Anupam Sengupta <anupamsg@gmail.com>
-#
-# All rights reserved.
+# Copyright (C) 2012-2022 Anupam Sengupta. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -34,9 +32,13 @@
 # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# frozen_string_literal: true
 
 # Provides utilities and mixin modules for RubyTree.
-
-module Tree::Utils
-  # Empty module.  Being used as a namespace.
+module Tree
+  # Provides various utilities for the TreeNode class.
+  module Utils
+    # Empty module.  Being used as a namespace.
+  end
 end

data/lib/tree/version.rb

@@ -4,9 +4,7 @@
 #
 # Author:: Anupam Sengupta (anupamsg@gmail.com)
 #
-# Copyright (c) 2012, 2013, 2014, 2015, 2017, 2020, 2021 Anupam Sengupta
-#
-# All rights reserved.
+# Copyright (c) 2012-2022 Anupam Sengupta. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -33,8 +31,9 @@
 # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
+# frozen_string_literal: true
 
 module Tree
   # Rubytree Package Version
-  VERSION = '1.0.2'.freeze
+  VERSION = '2.0.0'
 end