Merge pull request #88 from evolve75/rubocop-fixes

Various Rubocop fixes

Author: evolve75

.rubocop.yml

@@ -1 +1,12 @@
 # Local configuration for the rubocop linter.
+
+# Inherit from the working file.
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Lint/UselessAssignment:
+  Exclude:
+    - 'examples/example_basic.rb'

.rubocop_todo.yml

@@ -0,0 +1,45 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-06-20 06:06:47 UTC using RuboCop version 1.24.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 47
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 97
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+# IgnoredMethods: refine
+Metrics/BlockLength:
+  Max: 119
+
+# Offense count: 3
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 1066
+
+# Offense count: 2
+# Configuration parameters: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 47
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+Metrics/MethodLength:
+  Max: 45
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods.
+Metrics/PerceivedComplexity:
+  Max: 9
+
+# Offense count: 5
+Security/MarshalLoad:
+  Exclude:
+    - 'lib/tree.rb'
+    - 'spec/tree_spec.rb'
+    - 'test/test_tree.rb'

API-CHANGES.md

@@ -20,6 +20,14 @@ smooth transition to the new APIs.
 * Use of integers as node-names now no longer requires the optional
   `num_as_name` method argument.
 
+* The predicate methods beginning with `is_` or `has_` are now aliases to the
+  real methods **without** these prefixes. For example,
+  `Tree::TreeNode#is_root?` is now aliased to `Tree::TreeNode#root?`. This is to
+  comply with the Ruby standard. These original prefixed method names should be
+  considered as deprecated and the corresponding non-prefixed method names
+  should be used instead. it is possible that the old prefixed method names
+  might be removed in the future.
+
 * [structured_warnings][] has been **removed** from the code-base and is no
   longer a dependency. This was a long-standing point of friction for many
   users.

Gemfile

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 gemspec

History.md

@@ -10,6 +10,14 @@
 
 * Support for `CamelCase` methods has been dropped.
 
+* The predicate methods beginning with `is_` or `has_` are now aliases to real
+  methods **without** these prefixes. For example, `Tree::TreeNode#is_root?` is
+  now aliased to `Tree::TreeNode#root?`. This is to comply with the Ruby
+  standard. The original prefixed method names should be considered as
+  deprecated and the corresponding non-prefixed method names should be used
+  instead. it is possible that the old prefixed method names might be removed in
+  the future.
+
 * RubyTree now supports MRI Ruby versions `2.6.x`, `2.7.x`, and `3.0.x`.
 
 * Explicit support for `rbx` Ruby has been removed (_might_ still work, but not

Rakefile

@@ -31,9 +31,13 @@
 # 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 'rubygems'
-GEM_SPEC = eval(File.read('./rubytree.gemspec')) # Load the gemspec.
+
+# @todo: Check if Bundler needs to be `require`d.
+GEM_SPEC = Bundler.load_gemspec(File.join(__dir__, 'rubytree.gemspec'))
 
 PKG_NAME = GEM_SPEC.name
 PKG_VER  = GEM_SPEC.version
@@ -55,6 +59,7 @@ task :version do
 end
 
 require 'rake/clean'
+desc 'Remove all generated files.'
 task clean: 'gem:clobber_package'
 CLEAN.include('coverage')
 task clobber: [:clean, 'doc:clobber_rdoc', 'doc:clobber_yard']
@@ -70,8 +75,8 @@ namespace :doc do # ................................ Documentation
     require 'rdoc/task'
     Rake::RDocTask.new do |rdoc|
       rdoc.rdoc_dir = 'rdoc'
-      rdoc.title    = "#{PKG_NAME}-#{PKG_VER}"
-      rdoc.main     = 'README.rdoc'
+      rdoc.title    = "RubyTree Documenation: #{PKG_NAME}-#{PKG_VER}"
+      rdoc.main     = 'README.md'
       rdoc.rdoc_files.include(GEM_SPEC.extra_rdoc_files)
       rdoc.rdoc_files.include('./lib/**/*.rb')
     end
@@ -98,7 +103,8 @@ end
 desc 'Run the unit tests'
 task test: %w[test:unit]
 
-namespace :test do # ................................ Test related
+# ................................ Test related
+namespace :test do
   desc 'Run all the tests'
   task all: %w[test:unit test:spec test:examples]
 
@@ -109,7 +115,8 @@ namespace :test do # ................................ Test related
     test.verbose = false
   end
 
-  begin # ................................ rspec tests
+  # ................................ rspec tests
+  begin
     require 'rspec/core/rake_task'
 
     RSpec::Core::RakeTask.new(:spec) do |t|
@@ -146,7 +153,8 @@ namespace :test do # ................................ Test related
   end
 end
 
-namespace :tag do # ................................ Emacs Tags
+# ................................ Emacs Tags
+namespace :tag do
   require 'rtagstask'
   RTagsTask.new(:tags) do |rd|
     rd.vi = false
@@ -156,7 +164,8 @@ rescue LoadError
   # Oh well. Can't have everything.
 end
 
-namespace :gem do               # ................................ Gem related
+# ................................ Gem related
+namespace :gem do
   require 'rubygems/package_task'
   Gem::PackageTask.new(GEM_SPEC) do |pkg|
     pkg.need_zip = true
@@ -169,7 +178,8 @@ namespace :gem do               # ................................ Gem related
   end
 end
 
-require 'rubocop/rake_task'     # ................................ Ruby linting
+# ................................ Ruby linting
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new(:rubocop) do |t|
   t.options = ['--display-cop-names']

examples/example_basic.rb

@@ -3,8 +3,8 @@
 # example_basic.rb:: Basic usage of the tree library.
 #
 # Author:  Anupam Sengupta
-# Time-stamp: <2015-12-31 22:17:30 anupam>
-# Copyright (C) 2013, 2015 Anupam Sengupta <anupamsg@gmail.com>
+# Time-stamp: <2022-06-19 22:52:29 anupam>
+# Copyright (C) 2013, 2015, 2022 Anupam Sengupta <anupamsg@gmail.com>
 #
 # The following example implements this tree structure:
 #
@@ -21,22 +21,29 @@
 #    +-------+-------+
 #    | GRANDCHILD 1  |
 #    +---------------+
+#
+# frozen_string_literal: true
 
 # ..... Example starts.
 require 'tree' # Load the library
 
-# ..... Create the root node first.  Note that every node has a name and an optional content payload.
+# ..... 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')
 root_node.print_tree
 
-# ..... Now insert the child nodes.  Note that you can "chain" the child insertions for a given path to any depth.
-root_node << Tree::TreeNode.new('CHILD1', 'Child1 Content') << Tree::TreeNode.new('GRANDCHILD1', 'GrandChild1 Content')
+# ..... Now insert the child nodes. Note that you can "chain" the child
+# ..... insertions for a given path to any depth.
+root_node << Tree::TreeNode.new('CHILD1', 'Child1 Content') \
+          << Tree::TreeNode.new('GRANDCHILD1', 'GrandChild1 Content')
 root_node << Tree::TreeNode.new('CHILD2', 'Child2 Content')
 
-# ..... Lets print the representation to stdout.  This is primarily used for debugging purposes.
+# ..... Lets print the representation to stdout. This is primarily used for
+# ..... debugging purposes.
 root_node.print_tree
 
-# ..... Lets directly access children and grandchildren of the root.  The can be "chained" for a given path to any depth.
+# ..... Lets directly access children and grandchildren of the root. The can be
+# ..... "chained" for a given path to any depth.
 child1       = root_node['CHILD1']
 grand_child1 = root_node['CHILD1']['GRANDCHILD1']
 

lib/rubytree.rb

@@ -8,9 +8,7 @@
 #
 # Author:: Anupam Sengupta (anupamsg@gmail.com)
 #
-# Copyright (c) 2012, 2015 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:
@@ -37,5 +35,6 @@
 # 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 'tree'