rubytree 0.9.5 → 1.0.2

data/lib/tree/utils/camel_case_method_handler.rb

@@ -4,9 +4,9 @@
 #
 # Author::  Anupam Sengupta (anupamsg@gmail.com)
 #
-# Time-stamp: <2015-05-30 14:14:09 anupam>
+# Time-stamp: <2021-12-29 13:02:04 anupam>
 #
-# Copyright (C) 2012, 2013, 2015 Anupam Sengupta <anupamsg@gmail.com>
+# Copyright (C) 2012, 2013, 2015, 2017, 2021 Anupam Sengupta <anupamsg@gmail.com>
 #
 # All rights reserved.
 #
@@ -42,38 +42,36 @@ module Tree::Utils
   # Provides utility functions to handle CamelCase methods, and redirect
   # invocation of such methods to the snake_case equivalents.
   module CamelCaseMethodHandler
-    def self.included(base)
+    def self.included(_base)
       # @!visibility private
       # Allow the deprecated CamelCase method names.  Display a warning.
       # :nodoc:
       def method_missing(meth, *args, &blk)
-        if self.respond_to?(new_method_name = to_snake_case(meth))
-          warn DeprecatedMethodWarning,
-               "The camelCased methods are deprecated. "\
+        if respond_to?((new_method_name = to_snake_case(meth)))
+          warn StructuredWarnings::DeprecatedMethodWarning,
+               'The camelCased methods are deprecated. ' +
                "Please use #{new_method_name} instead of #{meth}"
-          return send(new_method_name, *args, &blk)
+          send(new_method_name, *args, &blk)
         else
           super
         end
       end
 
-      private
-
       # @!visibility private
       # Convert a CamelCasedWord to a underscore separated camel_cased_word.
       #
       # @param [String] camel_cased_word The word to be converted to snake_case.
       # @return [String] the snake_cased_word.
       def to_snake_case(camel_cased_word)
-        word = camel_cased_word.to_s.dup
+        word = camel_cased_word.to_s
         word.gsub!(/::/, '/')
-        word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-        word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-        word.tr!("-", "_")
+        word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+        word.tr!('-', '_')
         word.downcase!
         word
       end
-
+      protected :to_snake_case
     end # self.included
   end
 end

data/lib/tree/utils/hash_converter.rb

@@ -37,8 +37,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.
 
-module Tree::Utils::HashConverter
+require_relative '../../../lib/tree/utils/utils'
 
+module Tree::Utils::HashConverter
   def self.included(base)
     base.extend(ClassMethods)
   end
@@ -47,7 +48,6 @@ module Tree::Utils::HashConverter
   # class methods on any class mixing in the {Tree::Utils::HashConverter}
   # module.
   module ClassMethods
-
     # Factory method builds a {Tree::TreeNode} from a +Hash+.
     #
     # This method will interpret each key of your +Hash+ as a {Tree::TreeNode}.
@@ -92,84 +92,82 @@ module Tree::Utils::HashConverter
     #                        values that are not hashes or nils.
 
     def from_hash(hash)
-      raise ArgumentError, "Argument must be a type of hash"\
+      raise ArgumentError, 'Argument must be a type of hash'\
                            unless hash.is_a?(Hash)
 
-      raise ArgumentError, "Hash must have one top-level element"\
+      raise ArgumentError, 'Hash must have one top-level element'\
                            if hash.size != 1
 
       root, children = hash.first
 
-      unless [Hash, NilClass].include?(children.class)
-        raise ArgumentError, "Invalid child. Must be nil or hash."
-      end
+      raise ArgumentError, 'Invalid child. Must be nil or hash.' unless [Hash, NilClass].include?(children.class)
 
-      node = self.new(*root)
+      node = new(*root)
       node.add_from_hash(children) unless children.nil?
       node
     end
   end
 
-    # Instantiate and insert child nodes from data in a Ruby +Hash+
-    #
-    # This method is used in conjunction with from_hash to provide a
-    # convenient way of building and inserting child nodes present in a Ruby
-    # hashes.
-    #
-    # This method will instantiate a node instance for each top-
-    # level key of the input hash, to be inserted as children of the receiver
-    # instance.
-    #
-    # Nested hashes are expected and further child nodes will be created and
-    # added accordingly. If a hash key is a single value that value will be
-    # used as the name for the node.  If a hash key is an Array, both node
-    # name and content will be populated.
-    #
-    # A leaf element of the tree should be represented as a hash key with
-    # corresponding value +nil+ or {}.
-    #
-    # @example
-    #   root = Tree::TreeNode.new(:A, "Root content!")
-    #   root.add_from_hash({:B => {:D => {}}, [:C, "C content!"] => {}})
-    #
-    # @author Jen Hamon (http://www.github.com/jhamon)
-    # @param [Hash] children The hash of child subtrees.
-    # @raise [ArgumentError] This exception is raised if a non-hash is passed.
-    # @return [Array] Array of child nodes added
-    # @see ClassMethods#from_hash
-    def add_from_hash(children)
-      raise ArgumentError, "Argument must be a type of hash"\
-                           unless children.is_a?(Hash)
-
-      child_nodes = []
-      children.each do |child, grandchildren|
-        child_node = self.class.from_hash({child => grandchildren})
-        child_nodes << child_node
-        self << child_node
-      end
+  # Instantiate and insert child nodes from data in a Ruby +Hash+
+  #
+  # This method is used in conjunction with from_hash to provide a
+  # convenient way of building and inserting child nodes present in a Ruby
+  # hashes.
+  #
+  # This method will instantiate a node instance for each top-
+  # level key of the input hash, to be inserted as children of the receiver
+  # instance.
+  #
+  # Nested hashes are expected and further child nodes will be created and
+  # added accordingly. If a hash key is a single value that value will be
+  # used as the name for the node.  If a hash key is an Array, both node
+  # name and content will be populated.
+  #
+  # A leaf element of the tree should be represented as a hash key with
+  # corresponding value +nil+ or {}.
+  #
+  # @example
+  #   root = Tree::TreeNode.new(:A, "Root content!")
+  #   root.add_from_hash({:B => {:D => {}}, [:C, "C content!"] => {}})
+  #
+  # @author Jen Hamon (http://www.github.com/jhamon)
+  # @param [Hash] children The hash of child subtrees.
+  # @raise [ArgumentError] This exception is raised if a non-hash is passed.
+  # @return [Array] Array of child nodes added
+  # @see ClassMethods#from_hash
+  def add_from_hash(children)
+    raise ArgumentError, 'Argument must be a type of hash'\
+                         unless children.is_a?(Hash)
 
-      child_nodes
+    child_nodes = []
+    children.each do |child, grandchildren|
+      child_node = self.class.from_hash({ child => grandchildren })
+      child_nodes << child_node
+      self << child_node
     end
 
-    # Convert a node and its subtree into a Ruby hash.
-    #
-    # @example
-    #    root = Tree::TreeNode.new(:root, "root content")
-    #    root << Tree::TreeNode.new(:child1, "child1 content")
-    #    root << Tree::TreeNode.new(:child2, "child2 content")
-    #    root.to_h # => {[:root, "root content"] =>
-    #                         { [:child1, "child1 content"] =>
-    #                                    {}, [:child2, "child2 content"] => {}}}
-    # @author Jen Hamon (http://www.github.com/jhamon)
-    # @return [Hash] Hash representation of tree.
-    def to_h
-      key = has_content? ? [name, content] : name
+    child_nodes
+  end
 
-      children_hash = {}
-      children do |child|
-        children_hash.merge! child.to_h
-      end
+  # Convert a node and its subtree into a Ruby hash.
+  #
+  # @example
+  #    root = Tree::TreeNode.new(:root, "root content")
+  #    root << Tree::TreeNode.new(:child1, "child1 content")
+  #    root << Tree::TreeNode.new(:child2, "child2 content")
+  #    root.to_h # => {[:root, "root content"] =>
+  #                         { [:child1, "child1 content"] =>
+  #                                    {}, [:child2, "child2 content"] => {}}}
+  # @author Jen Hamon (http://www.github.com/jhamon)
+  # @return [Hash] Hash representation of tree.
+  def to_h
+    key = has_content? ? [name, content] : name
 
-      { key => children_hash }
+    children_hash = {}
+    children do |child|
+      children_hash.merge! child.to_h
     end
+
+    { key => children_hash }
+  end
 end

data/lib/tree/utils/json_converter.rb

@@ -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.
 
+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
@@ -57,22 +57,21 @@ module Tree::Utils::JSONConverter
   # 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
-  def as_json(options = {})
-
+  # noinspection RubyUnusedLocalVariable
+  def as_json(_options = {})
     json_hash = {
-      "name"         => name,
-      "content"      => content,
+      name: name,
+      content: content,
       JSON.create_id => self.class.name
     }
 
-    if has_children?
-      json_hash["children"] = children
-    end
-
-    return json_hash
+    json_hash['children'] = children if has_children?
 
+    json_hash
   end
 
   # Creates a JSON representation of this node including all it's children.
@@ -113,15 +112,15 @@ module Tree::Utils::JSONConverter
     # @see #to_json
     # @see http://flori.github.com/json
     def json_create(json_hash)
+      node = new(json_hash['name'], json_hash['content'])
 
-      node = new(json_hash["name"], json_hash["content"])
-
-      json_hash["children"].each do |child|
-        node << child
-      end if json_hash["children"]
-
-      return node
+      if json_hash['children']
+        json_hash['children'].each do |child|
+          node << child
+        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: <2015-05-30 14:23:23 anupam>
+# Time-stamp: <2021-12-29 13:01:54 anupam>
 #
-# Copyright (C) 2013, 2015 Anupam Sengupta <anupamsg@gmail.com>
+# Copyright (C) 2013, 2015, 2017, 2021 Anupam Sengupta <anupamsg@gmail.com>
 #
 # All rights reserved.
 #
@@ -41,8 +41,8 @@ require 'structured_warnings'
 module Tree::Utils
   # Provides utility functions to measure various tree metrics.
   module TreeMetricsHandler
-    def self.included(base)
-
+    # noinspection RubyUnusedLocalVariable
+    def self.included(_base)
       # @!group Metrics and Measures
 
       # @!attribute [r] size
@@ -54,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
@@ -66,7 +66,7 @@ module Tree::Utils
       # @return [Integer] The total number of nodes in this (sub)tree.
       # @see #size
       def length
-        size()
+        size
       end
 
       # @!attribute [r] node_height
@@ -80,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
 
@@ -98,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
 
@@ -127,11 +129,12 @@ module Tree::Utils
       #
       # @see #node_depth
       def depth
-        warn DeprecatedMethodWarning,
-             "This method is deprecated.  "\
-             "Please use node_depth() or node_height() instead (bug # 22535)"
+        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
 

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.
 #
@@ -39,8 +39,8 @@
 module Tree::Utils
   # Provides utility methods for path extraction
   module TreePathHandler
-    def self.included(base)
-
+    # noinspection RubyUnusedLocalVariable
+    def self.included(_base)
       # @!group Node Path
 
       # Returns the path of this node from the root as a string, with the node
@@ -53,7 +53,7 @@ module Tree::Utils
       # @return [String] The node path with names separated using the specified
       #                  separator.
       def path_as_string(separator = '=>')
-        path_as_array().join(separator)
+        path_as_array.join(separator)
       end
 
       # Returns the node-names from this node to the root as an array. The first
@@ -61,8 +61,8 @@ module Tree::Utils
       #
       # @return [Array] The array containing the node names for the path to this
       # node
-      def path_as_array()
-        get_path_name_array().reverse
+      def path_as_array
+        get_path_name_array.reverse
       end
 
       # @!visibility private
@@ -76,10 +76,9 @@ module Tree::Utils
         path_array = current_array_path + [name]
 
         if !parent              # If detached node or root node.
-          return path_array
+          path_array
         else                    # Else recurse to parent node.
           path_array = parent.get_path_name_array(path_array)
-          return path_array
         end
       end
 
@@ -88,5 +87,4 @@ module Tree::Utils
       # @!endgroup
     end # self.included
   end
-
 end

data/lib/tree/utils/tree_merge_handler.rb

@@ -35,10 +35,11 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
 
+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
@@ -60,8 +61,7 @@ module Tree::Utils::TreeMergeHandler
   #                        have the same root node as self.
   def merge(other_tree)
     check_merge_prerequisites(other_tree)
-    new_tree = merge_trees(self.root.dup, other_tree.root)
-    return new_tree
+    merge_trees(root.dup, other_tree.root)
   end
 
   # Merge in another tree (that shares the same root node) into +this+ tree.
@@ -78,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
@@ -96,13 +96,13 @@ 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
   end
 
-  # Utility function to recursivley merge two subtrees.
+  # Utility function to recursively merge two subtrees.
   #
   # @author Darren Oakley (https://github.com/dazoakley)
   #
@@ -120,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
 
-    return tree1
+    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.
 #
@@ -36,6 +36,7 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 # Provides utilities and mixin modules for RubyTree.
+
 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 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 = '0.9.5'
+  VERSION = '1.0.2'.freeze
 end