rubytree 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e70b5e24e0c6438962d8f5efe4badb962ab27819
-  data.tar.gz: 66ea286ac3ae28957cee7fdcf41d7dd007962afa
+SHA256:
+  metadata.gz: e9977428c2a28cf7d3a31ccc91047f646ec88c4f0da90663e9596dfb006ce0c6
+  data.tar.gz: 0e3a42cf9214d95e5f9deed0511c6728c5204a03a319b30a80d96daf3f20f505
 SHA512:
-  metadata.gz: 4f269fac16de633c54ac933d6ec87af7530295f59c1a5f47d2130c822ce50f6560446532546ee0bed3b6171523ccb8a180dac720b41524d810f0e54a2df9dadf
-  data.tar.gz: aa174da1e492764079f63aac6cf91b4b931dcc05feb9cc0fedd765e62c57d9202372d191ee16926a977ae8836f6884231e251885fa5abb27c95058086cf64a25
+  metadata.gz: f311eec1cf9a9710cb5905e5c7c691344bd60beb57b472462d40a81e12af475bb6bf328a6502aa8bbb9af17d5d350b163b5d8d36888835866c473b9ea6e13953
+  data.tar.gz: fdc9890aaf6e298d4400ee6f84398ced73dfdaf93c6fe87a4981dd35c5f17934e2a01e803d44351724c615f11e075fbf3181403cbb4343005452ee47fdfbe25e

data/Gemfile

@@ -3,13 +3,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in rubytree.gemspec
 gemspec
 
-group :development, :test do
-  gem 'rake', '~> 10.4'
-  gem 'test-unit', '~> 3.0'
-  gem 'coveralls', '>= 0.7', :require => false, :platforms => :mri_21
-  gem 'rspec', '>= 3.4'
-end
-
 # Local Variables:
 # mode: ruby
 # End:

data/Gemfile.lock

@@ -1,68 +1,97 @@
 PATH
   remote: .
   specs:
-    rubytree (1.0.0)
-      json (~> 2.1)
-      structured_warnings (~> 0.3)
+    rubytree (1.0.2)
+      json (~> 2.6.1)
+      structured_warnings (~> 0.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coveralls (0.8.21)
+    ast (2.4.2)
+    coveralls (0.8.23)
       json (>= 1.8, < 3)
-      simplecov (~> 0.14.1)
+      simplecov (~> 0.16.1)
       term-ansicolor (~> 1.3)
-      thor (~> 0.19.4)
+      thor (>= 0.19.4, < 2.0)
       tins (~> 1.6)
-    diff-lcs (1.3)
-    docile (1.1.5)
-    json (2.1.0)
-    power_assert (1.1.1)
-    rake (10.5.0)
-    rdoc (6.0.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.0)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    json (2.6.1)
+    parallel (1.21.0)
+    parser (3.0.3.2)
+      ast (~> 2.4.1)
+    power_assert (2.0.1)
+    psych (4.0.3)
+      stringio
+    rainbow (3.0.0)
+    rake (13.0.6)
+    rdoc (6.4.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
     rtags (0.97)
     rtagstask (0.0.4)
       rtags (> 0.0.0)
-    simplecov (0.14.1)
-      docile (~> 1.1.0)
+    rubocop (1.24.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    structured_warnings (0.3.0)
-    term-ansicolor (1.6.0)
+    stringio (3.0.1)
+    structured_warnings (0.4.0)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
       tins (~> 1.0)
-    test-unit (3.2.7)
+    test-unit (3.5.3)
       power_assert
-    thor (0.19.4)
-    tins (1.16.3)
-    yard (0.9.12)
+    thor (1.1.0)
+    tins (1.30.0)
+      sync
+    unicode-display_width (2.1.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
-  coveralls (>= 0.7)
-  rake (~> 10.4)
-  rdoc (~> 6.0)
-  rspec (>= 3.4)
-  rtagstask (~> 0.0)
+  bundler (~> 2.3.4)
+  coveralls (>= 0.8.23)
+  rake (>= 13.0.6)
+  rdoc (>= 6.4.0)
+  rspec (~> 3.10.0)
+  rtagstask (~> 0.0.4)
+  rubocop (>= 1.24.0)
   rubytree!
-  test-unit (~> 3.0)
-  yard (~> 0.9)
+  test-unit (>= 3.5.3)
+  yard (~> 0.9.27)
 
 BUNDLED WITH
-   1.16.0
+   2.3.4

data/LICENSE.md

@@ -1,7 +1,6 @@
 [RubyTree][]  is licensed under the [BSD][] license.
 
-Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015
-Anupam Sengupta (<anupamsg@gmail.com>).
+Copyright (c) 2006-2021 Anupam Sengupta (<anupamsg@gmail.com>).
 
 All rights reserved.
 

data/README.md

@@ -1,14 +1,13 @@
 <!--
   README.md
 
-  Copyright (C) 2006-2017 Anupam Sengupta (anupamsg@gmail.com)
+  Copyright (C) 2006-2017, 2020 Anupam Sengupta (anupamsg@gmail.com)
 
 -->
 # **RubyTree** #
 
 [![Gem Version](https://badge.fury.io/rb/rubytree.png)](http://badge.fury.io/rb/rubytree)
 [![Travis Build Status](https://secure.travis-ci.org/evolve75/RubyTree.png)](http://travis-ci.org/evolve75/rubytree)
-[![Dependency Status](https://gemnasium.com/evolve75/RubyTree.png)](https://gemnasium.com/evolve75/RubyTree)
 [![Code Climate](https://codeclimate.com/github/evolve75/RubyTree.png)](https://codeclimate.com/github/evolve75/RubyTree)
 [![Coverage Status](https://coveralls.io/repos/evolve75/RubyTree/badge.png)](https://coveralls.io/r/evolve75/RubyTree)
 

data/Rakefile

@@ -2,7 +2,7 @@
 #
 # Rakefile - This file is part of the RubyTree package.
 #
-# Copyright (c) 2006-2015  Anupam Sengupta
+# Copyright (c) 2006-2021  Anupam Sengupta
 #
 # All rights reserved.
 #
@@ -55,18 +55,18 @@ task :version do
 end
 
 require 'rake/clean'
-task :clean => 'gem:clobber_package'
+task clean: 'gem:clobber_package'
 CLEAN.include('coverage')
-task :clobber => [:clean, 'doc:clobber_rdoc', 'doc:clobber_yard']
+task clobber: [:clean, 'doc:clobber_rdoc', 'doc:clobber_yard']
 
 desc 'Open an irb session preloaded with this library'
 task :console do
   sh 'irb -rubygems -r ./lib/tree.rb'
 end
 
-namespace :doc do               # ................................ Documentation
+namespace :doc do # ................................ Documentation
   begin
-    gem 'rdoc', '>= 2.4.2' # To get around a stupid bug in Ruby 1.9.2 Rake.
+    gem 'rdoc', '>= 6.4.0' # To get around a stupid bug in Ruby 1.9.2 Rake.
     require 'rdoc/task'
     Rake::RDocTask.new do |rdoc|
       rdoc.rdoc_dir = 'rdoc'
@@ -83,7 +83,7 @@ namespace :doc do               # ................................ Documentation
     require 'yard'
     YARD::Rake::YardocTask.new do |t|
       t.files   = ['lib/**/*.rb', '-', GEM_SPEC.extra_rdoc_files]
-      t.options = %w(--no-private --embed-mixins)
+      t.options = %w[--no-private --embed-mixins]
     end
   rescue LoadError
     # Oh well.
@@ -96,10 +96,9 @@ namespace :doc do               # ................................ Documentation
 end
 
 desc 'Run the test cases'
-task :test => 'test:unit'
-
-namespace :test do              # ................................ Test related
+task test: 'test:unit'
 
+namespace :test do # ................................ Test related
   require 'rake/testtask'
   Rake::TestTask.new(:unit) do |test|
     test.libs << 'lib' << 'test'
@@ -131,10 +130,9 @@ namespace :test do              # ................................ Test related
   rescue LoadError
     # Oh well. Can't have everything.
   end
-
 end
 
-begin                            # ................................ rspec tests
+begin # ................................ rspec tests
   require 'rspec/core/rake_task'
 
   RSpec::Core::RakeTask.new(:spec) do |t|
@@ -145,17 +143,15 @@ rescue LoadError
   # Cannot load rspec.
 end
 
- namespace :tag do               # ................................ Emacs Tags
-  begin
-    require 'rtagstask'
-    RTagsTask.new(:tags) do |rd|
-      rd.vi = false
-      CLEAN.include('TAGS')
-    end
-  rescue LoadError
-    # Oh well. Can't have everything.
+namespace :tag do # ................................ Emacs Tags
+  require 'rtagstask'
+  RTagsTask.new(:tags) do |rd|
+    rd.vi = false
+    CLEAN.include('TAGS')
   end
- end
+rescue LoadError
+  # Oh well. Can't have everything.
+end
 
 namespace :gem do               # ................................ Gem related
   require 'rubygems/package_task'
@@ -165,7 +161,7 @@ namespace :gem do               # ................................ Gem related
   end
 
   desc 'Push the gem into the Rubygems repository'
-  task :push => :gem do
+  task push: :gem do
     sh "gem push pkg/#{GEM_NAME}"
   end
 end

data/examples/example_basic.rb

@@ -23,7 +23,7 @@
 #    +---------------+
 
 # ..... Example starts.
-require 'tree'                 # Load the library
+require 'tree' # Load the library
 
 # ..... Create the root node first.  Note that every node has a name and an optional content payload.
 root_node = Tree::TreeNode.new('ROOT', 'Root Content')

data/lib/rubytree.rb

@@ -38,4 +38,4 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #
 
-require 'tree.rb'
+require 'tree'

data/lib/tree/binarytree.rb

@@ -41,7 +41,6 @@
 require_relative '../tree'
 
 module Tree
-
   # Provides a Binary tree implementation. This node allows only two child nodes
   # (left and right child). It also provides direct access to the left or right
   # child, including assignment to the same.
@@ -51,7 +50,6 @@ module Tree
   # @author Anupam Sengupta
   #
   class BinaryTreeNode < TreeNode
-
     # @!group Core Attributes
 
     # @!attribute [rw] left_child
@@ -85,6 +83,7 @@ module Tree
     # @return [Boolean] +true+ if this is the left child of its parent.
     def is_left_child?
       return false if is_root?
+
       self == parent.left_child
     end
 
@@ -95,6 +94,7 @@ module Tree
     # @return [Boolean] +true+ if this is the right child of its parent.
     def is_right_child?
       return false if is_root?
+
       self == parent.right_child
     end
 
@@ -119,7 +119,6 @@ module Tree
       super(child)
     end
 
-
     # Instantiate and insert child nodes from data in a Ruby +Hash+
     #
     # This method is used in conjunction with {Tree::TreeNode.from_hash} to
@@ -152,6 +151,7 @@ module Tree
     def add_from_hash(hashed_subtree)
       raise ArgumentError, 'Too many children'\
                            if hashed_subtree.size + @children.size > 2
+
       super(hashed_subtree)
     end
 
@@ -170,14 +170,13 @@ module Tree
     # @see #preordered_each
     # @see #postordered_each
     # noinspection RubyUnusedLocalVariable
-    def inordered_each(&block)
-
-      return self.to_enum unless block_given?
+    def inordered_each
+      return to_enum unless block_given?
 
       node_stack = []
       current_node = self
 
-      until node_stack.empty? and current_node == nil
+      until node_stack.empty? and current_node.nil?
         if current_node
           node_stack.push(current_node)
           current_node = current_node.left_child
@@ -189,7 +188,6 @@ module Tree
       end
 
       self if block_given?
-
     end
 
     # A protected method to allow insertion of child nodes at the specified
@@ -245,9 +243,7 @@ module Tree
 
     # Swaps the left and right child nodes of the receiver node with each other.
     def swap_children
-      self.left_child, self.right_child = self.right_child, self.left_child
+      self.left_child, self.right_child = right_child, left_child
     end
-
   end
-
 end

data/lib/tree/utils/camel_case_method_handler.rb

@@ -4,9 +4,9 @@
 #
 # Author::  Anupam Sengupta (anupamsg@gmail.com)
 #
-# Time-stamp: <2017-12-21 13:42:15 anupam>
+# Time-stamp: <2021-12-29 13:02:04 anupam>
 #
-# Copyright (C) 2012, 2013, 2015, 2017 Anupam Sengupta <anupamsg@gmail.com>
+# Copyright (C) 2012, 2013, 2015, 2017, 2021 Anupam Sengupta <anupamsg@gmail.com>
 #
 # All rights reserved.
 #
@@ -36,19 +36,18 @@
 # 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 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)))
+        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}"
@@ -58,8 +57,6 @@ module Tree::Utils
         end
       end
 
-      protected
-
       # @!visibility private
       # Convert a CamelCasedWord to a underscore separated camel_cased_word.
       #
@@ -68,13 +65,13 @@ module Tree::Utils
       def to_snake_case(camel_cased_word)
         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.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

@@ -40,7 +40,6 @@
 require_relative '../../../lib/tree/utils/utils'
 
 module Tree::Utils::HashConverter
-
   def self.included(base)
     base.extend(ClassMethods)
   end
@@ -49,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}.
@@ -102,76 +100,74 @@ module Tree::Utils::HashConverter
 
       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
-
-      child_nodes
+  # 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
 
-    # 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
-
-      children_hash = {}
-      children do |child|
-        children_hash.merge! child.to_h
-      end
+    child_nodes
+  end
 
-      { key => children_hash }
+  # 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
+
+    children_hash = {}
+    children do |child|
+      children_hash.merge! child.to_h
     end
+
+    { key => children_hash }
+  end
 end

data/lib/tree/utils/json_converter.rb

@@ -41,7 +41,6 @@ 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
@@ -63,20 +62,16 @@ module Tree::Utils::JSONConverter
   # @see #to_json
   # @see http://stackoverflow.com/a/6880638/273808
   # noinspection RubyUnusedLocalVariable
-  def as_json(options = {})
-
+  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
-    end
+    json_hash['children'] = children if has_children?
 
     json_hash
-
   end
 
   # Creates a JSON representation of this node including all it's children.
@@ -117,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'])
 
-      json_hash['children'].each do |child|
-        node << child
-      end if json_hash['children']
+      if json_hash['children']
+        json_hash['children'].each do |child|
+          node << child
+        end
+      end
 
       node
-
     end
   end
 end