Automatic formatting fixes using rubocop.

Author: evolve75

.rubocop.yml

@@ -0,0 +1 @@
+# Local configuration for the rubocop linter.

Rakefile

@@ -64,7 +64,7 @@ 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.
     require 'rdoc/task'
@@ -98,8 +98,7 @@ end
 desc 'Run the test cases'
 task :test => 'test:unit'
 
-namespace :test do              # ................................ Test related
-
+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,7 +143,7 @@ rescue LoadError
   # Cannot load rspec.
 end
 
- namespace :tag do               # ................................ Emacs Tags
+namespace :tag do # ................................ Emacs Tags
   begin
     require 'rtagstask'
     RTagsTask.new(:tags) do |rd|
@@ -155,7 +153,7 @@ end
   rescue LoadError
     # Oh well. Can't have everything.
   end
- end
+end
 
 namespace :gem do               # ................................ Gem related
   require 'rubygems/package_task'

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')

lib/tree.rb

@@ -47,7 +47,6 @@
 # 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
@@ -267,10 +266,9 @@ def marshal_dump
     # 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)
-      }
+      { name: @name,
+        parent: (is_root? ? nil : @parent.name),
+        content: Marshal.dump(@content) }
     end
 
     protected :create_dump_rep
@@ -285,7 +283,7 @@ def create_dump_rep # :nodoc:
     #       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]
@@ -381,7 +379,7 @@ def add(child, at_index = -1)
       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
@@ -408,7 +406,7 @@ def add(child, at_index = -1)
     # 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
 
@@ -444,7 +442,7 @@ def rename_child(old_name, new_name)
             unless @children_hash.key?(old_name)
 
       @children_hash[new_name] = @children_hash.delete(old_name)
-      @children_hash[new_name].name=new_name
+      @children_hash[new_name].name = new_name
     end
 
     # Protected method to set the name of this node.
@@ -558,7 +556,7 @@ def set_as_root! # :nodoc:
     # 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
@@ -598,7 +596,7 @@ def freeze_tree!
     #
     # @see #add
     # @see #initialize
-    def [](name_or_index, num_as_name=false)
+    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.is_a?(Integer) && !num_as_name
@@ -628,21 +626,20 @@ def [](name_or_index, num_as_name=false)
     # @return [Enumerator] an enumerator on this tree, if a block is *not* given
     # noinspection RubyUnusedLocalVariable
     def each(&block) # :yields: node
+      return to_enum unless block_given?
 
-     return 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
-     end
+      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
+      end
 
-     self if block_given?
+      self if block_given?
     end
 
     # Traverses the (sub)tree rooted at this node in pre-ordered sequence.
@@ -684,7 +681,7 @@ def postordered_each(&block)
           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
@@ -738,7 +735,7 @@ def breadth_each(&block)
     #                                 is given.
     def children
       if block_given?
-        @children.each {|child| yield child}
+        @children.each { |child| yield child }
         self
       else
         @children.clone
@@ -887,8 +884,9 @@ def siblings
         return [] if is_root?
 
         siblings = []
-        parent.children {|my_sibling|
-                         siblings << my_sibling if my_sibling != self}
+        parent.children { |my_sibling|
+          siblings << my_sibling if my_sibling != self
+        }
         siblings
       end
     end
@@ -963,7 +961,8 @@ def <=>(other)
     # @param [Proc] block optional block to use for rendering
     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?
@@ -983,8 +982,8 @@ def print_tree(level = node_depth, max_depth = nil,
 
       children { |child|
         child&.print_tree(level + 1,
-                         max_depth, block) } # Child might be 'nil'
+                          max_depth, block)
+      }       # Child might be 'nil'
     end
-
   end
 end

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 @@ def right_child
     # @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 @@ def is_left_child?
     # @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 @@ def add(child)
       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 @@ def add(child)
     def add_from_hash(hashed_subtree)
       raise ArgumentError, 'Too many children'\
                            if hashed_subtree.size + @children.size > 2
+
       super(hashed_subtree)
     end
 
@@ -171,7 +171,6 @@ def add_from_hash(hashed_subtree)
     # @see #postordered_each
     # noinspection RubyUnusedLocalVariable
     def inordered_each(&block)
-
       return self.to_enum unless block_given?
 
       node_stack = []
@@ -189,7 +188,6 @@ def inordered_each(&block)
       end
 
       self if block_given?
-
     end
 
     # A protected method to allow insertion of child nodes at the specified
@@ -247,7 +245,5 @@ def right_child=(child)
     def swap_children
       self.left_child, self.right_child = self.right_child, self.left_child
     end
-
   end
-
 end

lib/tree/utils/camel_case_method_handler.rb

@@ -66,14 +66,13 @@ def method_missing(meth, *args, &blk)
       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