rubytree 0.9.7 → 1.0.0

data/lib/tree/binarytree.rb

@@ -38,7 +38,7 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
 
-require 'tree'
+require_relative '../tree'
 
 module Tree
 
@@ -114,7 +114,7 @@ module Tree
     # @raise [ArgumentError] This exception is raised if two children are
     #                        already present.
     def add(child)
-      raise ArgumentError, "Already has two child nodes" if @children.size == 2
+      raise ArgumentError, 'Already has two child nodes' if @children.size == 2
 
       super(child)
     end
@@ -150,12 +150,12 @@ module Tree
     # @raise [ArgumentError] This exception is raised if a non-hash is passed.
     # @return [Array] Array of child nodes added
     def add_from_hash(hashed_subtree)
-      raise ArgumentError, "Too many children"\
+      raise ArgumentError, 'Too many children'\
                            if hashed_subtree.size + @children.size > 2
       super(hashed_subtree)
     end
 
-    # Performs inorder traversal (including this node).
+    # Performs in-order traversal (including this node).
     #
     # @yieldparam node [Tree::BinaryTreeNode]  Each node (in-order).
     #
@@ -164,9 +164,12 @@ module Tree
     #
     # @since 0.9.0
     #
+    # @param [Object] block
+    #
     # @see #each
     # @see #preordered_each
     # @see #postordered_each
+    # noinspection RubyUnusedLocalVariable
     def inordered_each(&block)
 
       return self.to_enum unless block_given?
@@ -179,13 +182,13 @@ module Tree
           node_stack.push(current_node)
           current_node = current_node.left_child
         else
-          current_node = node_stack.pop()
+          current_node = node_stack.pop
           yield current_node
           current_node = current_node.right_child
         end
       end
 
-      return self if block_given?
+      self if block_given?
 
     end
 
@@ -201,7 +204,7 @@ module Tree
     #
     # @raise [ArgumentError] If the index is out of limits.
     def set_child_at(child, at_index)
-      raise ArgumentError "A binary tree cannot have more than two children."\
+      raise ArgumentError 'A binary tree cannot have more than two children.'\
                           unless (0..1).include? at_index
 
       @children[at_index]        = child

data/lib/tree/tree_deps.rb

@@ -2,7 +2,7 @@
 #
 # = rubytree_deps.rb - Dependencies for RubyTree
 #
-# Centralizes and lists the dependencies forthe RubyTree gem.
+# Centralizes and lists the dependencies for the RubyTree gem.
 #
 # Author:: Anupam Sengupta (anupamsg@gmail.com)
 #
@@ -40,10 +40,10 @@
 require 'structured_warnings'
 require 'json'
 
-require 'tree/version'
-require 'tree/utils/metrics_methods'
-require 'tree/utils/path_methods'
-require 'tree/utils/camel_case_method_handler'
-require 'tree/utils/json_converter'
-require 'tree/utils/tree_merge_handler'
-require 'tree/utils/hash_converter'
+require_relative '../tree/version'
+require_relative '../tree/utils/metrics_methods'
+require_relative '../tree/utils/path_methods'
+require_relative '../tree/utils/camel_case_method_handler'
+require_relative '../tree/utils/json_converter'
+require_relative '../tree/utils/tree_merge_handler'
+require_relative '../tree/utils/hash_converter'

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: <2017-12-21 13:42:15 anupam>
 #
-# Copyright (C) 2012, 2013, 2015 Anupam Sengupta <anupamsg@gmail.com>
+# Copyright (C) 2012, 2013, 2015, 2017 Anupam Sengupta <anupamsg@gmail.com>
 #
 # All rights reserved.
 #
@@ -36,6 +36,7 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
 
+require_relative '../../../lib/tree'
 require 'structured_warnings'
 
 module Tree::Utils
@@ -47,17 +48,17 @@ module Tree::Utils
       # 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 self.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
+      protected
 
       # @!visibility private
       # Convert a CamelCasedWord to a underscore separated camel_cased_word.
@@ -65,11 +66,11 @@ module Tree::Utils
       # @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.tr!('-', '_')
         word.downcase!
         word
       end

data/lib/tree/utils/hash_converter.rb

@@ -37,6 +37,8 @@
 # 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'
+
 module Tree::Utils::HashConverter
 
   def self.included(base)
@@ -92,16 +94,16 @@ 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."
+        raise ArgumentError, 'Invalid child. Must be nil or hash.'
       end
 
       node = self.new(*root)
@@ -138,7 +140,7 @@ module Tree::Utils::HashConverter
     # @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"\
+      raise ArgumentError, 'Argument must be a type of hash'\
                            unless children.is_a?(Hash)
 
       child_nodes = []

data/lib/tree/utils/json_converter.rb

@@ -35,6 +35,7 @@
 # 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
@@ -57,21 +58,24 @@ 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
+  # noinspection RubyUnusedLocalVariable
   def as_json(options = {})
 
     json_hash = {
-      "name"         => name,
-      "content"      => content,
-      JSON.create_id => self.class.name
+        name: name,
+        content: content,
+        JSON.create_id => self.class.name
     }
 
     if has_children?
-      json_hash["children"] = children
+      json_hash['children'] = children
     end
 
-    return json_hash
+    json_hash
 
   end
 
@@ -114,13 +118,13 @@ module Tree::Utils::JSONConverter
     # @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|
+      json_hash['children'].each do |child|
         node << child
-      end if json_hash["children"]
+      end if json_hash['children']
 
-      return node
+      node
 
     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: <2017-12-21 12:49:25 anupam>
 #
-# Copyright (C) 2013, 2015 Anupam Sengupta <anupamsg@gmail.com>
+# Copyright (C) 2013, 2015, 2017 Anupam Sengupta <anupamsg@gmail.com>
 #
 # All rights reserved.
 #
@@ -36,11 +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)
 
       # @!group Metrics and Measures
@@ -66,7 +68,7 @@ module Tree::Utils
       # @return [Integer] The total number of nodes in this (sub)tree.
       # @see #size
       def length
-        size()
+        self.size
       end
 
       # @!attribute [r] node_height
@@ -127,9 +129,9 @@ 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

data/lib/tree/utils/path_methods.rb

@@ -36,9 +36,12 @@
 # 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)
 
       # @!group Node Path
@@ -53,7 +56,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 +64,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 +79,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
 

data/lib/tree/utils/tree_merge_handler.rb

@@ -35,6 +35,8 @@
 # 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
@@ -60,8 +62,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(self.root.dup, other_tree.root)
   end
 
   # Merge in another tree (that shares the same root node) into +this+ tree.
@@ -102,7 +103,7 @@ module Tree::Utils::TreeMergeHandler
     end
   end
 
-  # Utility function to recursivley merge two subtrees.
+  # Utility function to recursively merge two subtrees.
   #
   # @author Darren Oakley (https://github.com/dazoakley)
   #
@@ -123,7 +124,7 @@ module Tree::Utils::TreeMergeHandler
       merge_trees( child, tree2[child.name] ) unless tree2[child.name].nil?
     end
 
-    return tree1
+    tree1
   end
 
 end

data/lib/tree/utils/utils.rb

@@ -36,6 +36,9 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 # 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 Anupam Sengupta
+# Copyright (c) 2012, 2013, 2014, 2015, 2017 Anupam Sengupta
 #
 # All rights reserved.
 #
@@ -37,5 +37,5 @@
 #
 module Tree
   # Rubytree Package Version
-  VERSION = '0.9.7'
+  VERSION = '1.0.0'
 end

data/spec/spec_helper.rb

@@ -7,4 +7,4 @@
 # Copyright (C) 2015 Anupam Sengupta <anupamsg@gmail.com>
 #
 
-require "tree"
+require 'tree'

data/spec/tree_spec.rb

@@ -7,12 +7,12 @@
 # Copyright (C) 2015 Anupam Sengupta <anupamsg@gmail.com>
 #
 
-require "rspec"
-require "spec_helper"
+require 'rspec'
+require 'spec_helper'
 
 describe Tree do
 
-  shared_examples_for "any detached node" do
+  shared_examples_for 'any detached node' do
     it 'should not equal "Object.new"' do
       expect(@tree).not_to eq(Object.new)
     end
@@ -22,53 +22,53 @@ describe Tree do
     it 'identifies itself as a root node' do
       expect(@tree.is_root?).to eq(true)
     end
-    it "does not have a parent node" do
+    it 'does not have a parent node' do
       expect(@tree.parent).to eq(nil)
     end
 
   end
-  context "#initialize", "with empty name and nil content" do
+  context '#initialize', 'with empty name and nil content' do
     before(:each) do
-      @tree = Tree::TreeNode.new("")
+      @tree = Tree::TreeNode.new('')
     end
     it 'creates the tree node with name as ""' do
-      expect(@tree.name).to eq("")
+      expect(@tree.name).to eq('')
     end
     it "has 'nil' content" do
       expect(@tree.content).to eq(nil)
     end
 
-    it_behaves_like "any detached node"
+    it_behaves_like 'any detached node'
   end
 
-  context "#initialize", "with name 'A' and nil content" do
+  context '#initialize', "with name 'A' and nil content" do
     before(:each) do
-      @tree = Tree::TreeNode.new("A")
+      @tree = Tree::TreeNode.new('A')
     end
 
     it 'creates the tree node with name as "A"' do
-      expect(@tree.name).to eq("A")
+      expect(@tree.name).to eq('A')
     end
     it "has 'nil' content" do
       expect(@tree.content).to eq(nil)
     end
 
-    it_behaves_like "any detached node"
+    it_behaves_like 'any detached node'
   end
 
-  context "#initialize", "with node name 'A' and some content" do
+  context '#initialize', "with node name 'A' and some content" do
     before(:each) do
-      @sample = "sample"
-      @tree = Tree::TreeNode.new("A", @sample)
+      @sample = 'sample'
+      @tree = Tree::TreeNode.new('A', @sample)
     end
 
     it 'creates the tree node with name as "A"' do
-      expect(@tree.name).to eq("A")
+      expect(@tree.name).to eq('A')
     end
     it "has some content #{@sample}" do
       expect(@tree.content).to eq(@sample)
     end
 
-    it_behaves_like "any detached node"
+    it_behaves_like 'any detached node'
   end
 end