Removed the is_ and has_ prefixes from predicate methods.

This is to comply with the Ruby method naming convention for predicate methods
(the ones ending with `?`). Rest of the code base has been updated to use the
new method names.

However, for backward compatibility, `aliases` with the old method names have
been defined to the new names so that current client code can continue to work.

Author: evolve75

.rubocop_todo.yml

@@ -37,18 +37,6 @@ Metrics/MethodLength:
 Metrics/PerceivedComplexity:
   Max: 9
 
-# Offense count: 9
-# Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros.
-# NamePrefix: is_, has_, have_
-# ForbiddenPrefixes: is_, has_, have_
-# AllowedMethods: is_a?
-# MethodDefinitionMacros: define_method, define_singleton_method
-Naming/PredicateName:
-  Exclude:
-    - 'spec/**/*'
-    - 'lib/tree.rb'
-    - 'lib/tree/binarytree.rb'
-
 # Offense count: 5
 Security/MarshalLoad:
   Exclude:

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.

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

lib/tree.rb

@@ -130,38 +130,44 @@ class TreeNode
     # @return [Tree::TreeNode] Root of the (sub)tree.
     def root
       root = self
-      root = root.parent until root.is_root?
+      root = root.parent until root.root?
       root
     end
 
-    # @!attribute [r] is_root?
+    # @!attribute [r] root?
     # Returns +true+ if this is a root node.  Note that
     # orphaned children will also be reported as root nodes.
     #
     # @return [Boolean] +true+ if this is a root node.
-    def is_root?
+    def root?
       @parent.nil?
     end
 
-    # @!attribute [r] has_content?
+    alias is_root? root? # @todo: Aliased for eventual replacement
+
+    # @!attribute [r] content?
     # +true+ if this node has content.
     #
     # @return [Boolean] +true+ if the node has content.
-    def has_content?
+    def content?
       @content != nil
     end
 
-    # @!attribute [r] is_leaf?
+    alias has_content? content? # @todo: Aliased for eventual replacement
+
+    # @!attribute [r] leaf?
     # +true+ if this node is a _leaf_ - i.e., one without
     # any children.
     #
     # @return [Boolean] +true+ if this is a leaf node.
     #
-    # @see #has_children?
-    def is_leaf?
-      !has_children?
+    # @see #children?
+    def leaf?
+      !children?
     end
 
+    alias is_leaf? leaf? # @todo: Aliased for eventual replacement
+
     # @!attribute [r] parentage
     # An array of ancestors of this node in reversed order
     # (the first element is the immediate parent of this node).
@@ -171,7 +177,7 @@ def is_leaf?
     # @return [Array<Tree::TreeNode>] An array of ancestors of this node
     # @return [nil] if this is a root node.
     def parentage
-      return nil if is_root?
+      return nil if root?
 
       parentage_array = []
       prev_parent = parent
@@ -182,16 +188,18 @@ def parentage
       parentage_array
     end
 
-    # @!attribute [r] has_children?
+    # @!attribute [r] children?
     # +true+ if the this node has any child node.
     #
     # @return [Boolean] +true+ if child nodes exist.
     #
-    # @see #is_leaf?
-    def has_children?
+    # @see #leaf?
+    def children?
       !@children.empty?
     end
 
+    alias has_children? children? # @todo: Aliased for eventual replacement
+
     # @!group Node Creation
 
     # Creates a new node with a name and optional content.
@@ -266,7 +274,7 @@ def marshal_dump
     # a hash.
     def create_dump_rep # :nodoc:
       { name: @name,
-        parent: (is_root? ? nil : @parent.name),
+        parent: (root? ? nil : @parent.name),
         content: Marshal.dump(@content) }
     end
 
@@ -311,7 +319,7 @@ def marshal_load(dumped_tree_array)
     # @return [String] A string representation of the node.
     def to_s
       "Node Name: #{@name} Content: #{@content.to_s || '<Empty>'} " \
-        "Parent: #{is_root? ? '<None>' : @parent.name.to_s} "       \
+        "Parent: #{root? ? '<None>' : @parent.name.to_s} "       \
         "Children: #{@children.length} Total Nodes: #{size}"
     end
 
@@ -425,7 +433,7 @@ def insertion_range
     def rename(new_name)
       old_name = @name
 
-      if is_root?
+      if root?
         self.name = new_name
       else
         @parent.rename_child old_name, new_name
@@ -519,7 +527,7 @@ def parent=(parent) # :nodoc:
     #
     # @see #remove_all!
     def remove_from_parent!
-      @parent.remove!(self) unless is_root?
+      @parent.remove!(self) unless root?
     end
 
     # Removes all children from this node. If an independent reference exists to
@@ -657,7 +665,7 @@ def postordered_each
 
       until node_stack.empty?
         peek_node = node_stack[0]
-        if peek_node.node.has_children? && !peek_node.visited
+        if peek_node.node.children? && !peek_node.visited
           peek_node.visited = true
           # Add the children to the stack. Use the marking structure.
           marked_children =
@@ -737,10 +745,10 @@ def children(&block)
     # noinspection RubyUnusedLocalVariable
     def each_leaf
       if block_given?
-        each { |node| yield(node) if node.is_leaf? }
+        each { |node| yield(node) if node.leaf? }
         self
       else
-        self.select(&:is_leaf?)
+        self.select(&:leaf?)
       end
     end
 
@@ -798,22 +806,24 @@ def last_child
     #
     # @return [Tree::TreeNode] The first sibling node.
     #
-    # @see #is_first_sibling?
+    # @see #first_sibling?
     # @see #last_sibling
     def first_sibling
-      is_root? ? self : parent.children.first
+      root? ? self : parent.children.first
     end
 
     # Returns +true+ if this node is the first sibling at its level.
     #
     # @return [Boolean] +true+ if this is the first sibling.
     #
-    # @see #is_last_sibling?
+    # @see #last_sibling?
     # @see #first_sibling
-    def is_first_sibling?
+    def first_sibling?
       first_sibling == self
     end
 
+    alias is_first_sibling? first_sibling? # @todo: Aliased for eventual replacement
+
     # Last sibling of this node.  If this is the root node, then returns
     # itself.
     #
@@ -824,22 +834,24 @@ def is_first_sibling?
     #
     # @return [Tree::TreeNode] The last sibling node.
     #
-    # @see #is_last_sibling?
+    # @see #last_sibling?
     # @see #first_sibling
     def last_sibling
-      is_root? ? self : parent.children.last
+      root? ? self : parent.children.last
     end
 
     # Returns +true+ if this node is the last sibling at its level.
     #
     # @return [Boolean] +true+ if this is the last sibling.
     #
-    # @see #is_first_sibling?
+    # @see #first_sibling?
     # @see #last_sibling
-    def is_last_sibling?
+    def last_sibling?
       last_sibling == self
     end
 
+    alias is_last_sibling? last_sibling? # @todo: Aliased for eventual replacement
+
     # An array of siblings for this node. This node is excluded.
     #
     # If a block is provided, yields each of the sibling nodes to the block.
@@ -859,7 +871,7 @@ def siblings
         parent.children.each { |sibling| yield sibling if sibling != self }
         self
       else
-        return [] if is_root?
+        return [] if root?
 
         siblings = []
         parent.children do |my_sibling|
@@ -876,10 +888,12 @@ def siblings
     # @return [Boolean] +true+ if this is the only child of its parent.
     #
     # @see #siblings
-    def is_only_child?
-      is_root? ? true : parent.children.size == 1
+    def only_child?
+      root? ? true : parent.children.size == 1
     end
 
+    alias is_only_child? only_child? # @todo: Aliased for eventual replacement
+
     # Next sibling for this node.
     # The _next_ node is defined as the node to right of this node.
     #
@@ -891,7 +905,7 @@ def is_only_child?
     # @see #previous_sibling
     # @see #siblings
     def next_sibling
-      return nil if is_root?
+      return nil if root?
 
       idx = parent.children.index(self)
       parent.children.at(idx + 1) if idx
@@ -908,7 +922,7 @@ def next_sibling
     # @see #next_sibling
     # @see #siblings
     def previous_sibling
-      return nil if is_root?
+      return nil if root?
 
       idx = parent.children.index(self)
       parent.children.at(idx - 1) if idx&.positive?
@@ -943,14 +957,14 @@ def print_tree(level = node_depth, max_depth = nil,
                            })
       prefix = ''.dup # dup NEEDs to be invoked to make this mutable.
 
-      if is_root?
+      if root?
         prefix << '*'
       else
-        prefix << '|' unless parent.is_last_sibling?
+        prefix << '|' unless parent.last_sibling?
         prefix << (' ' * (level - 1) * 4)
-        prefix << (is_last_sibling? ? '+' : '|')
+        prefix << (last_sibling? ? '+' : '|')
         prefix << '---'
-        prefix << (has_children? ? '+' : '>')
+        prefix << (children? ? '+' : '>')
       end
 
       block.call(self, prefix)

lib/tree/binarytree.rb

@@ -75,28 +75,32 @@ def right_child
       children[1]
     end
 
-    # @!attribute is_left_child?
+    # @!attribute left_child?
     # +true+ if the receiver node is the left child of its parent.
     # Always returns +false+ if it is a root node.
     #
     # @return [Boolean] +true+ if this is the left child of its parent.
-    def is_left_child?
-      return false if is_root?
+    def left_child?
+      return false if root?
 
       self == parent.left_child
     end
 
-    # @!attribute [r] is_right_child?
+    alias is_left_child? left_child? # @todo: Aliased for eventual replacement
+
+    # @!attribute [r] right_child?
     # +true+ if the receiver node is the right child of its parent.
     # Always returns +false+ if it is a root node.
     #
     # @return [Boolean] +true+ if this is the right child of its parent.
-    def is_right_child?
-      return false if is_root?
+    def right_child?
+      return false if root?
 
       self == parent.right_child
     end
 
+    alias is_right_child? right_child? # @todo: Aliased for eventual replacement
+
     # @!group Structure Modification
 
     # Adds the specified child node to the receiver node. The child node's

lib/tree/utils/hash_converter.rb

@@ -5,7 +5,7 @@
 #
 # Author::  Jen Hamon (http://www.github.com/jhamon)
 #
-# Time-stamp: <2022-06-20 01:20:34 anupam>
+# Time-stamp: <2022-06-20 22:16:39 anupam>
 #
 # Copyright (C) 2014, 2015, 2022, 2022 Jen Hamon (http://www.github.com/jhamon) and
 #                    Anupam Sengupta <anupamsg@gmail.com>
@@ -167,7 +167,7 @@ def add_from_hash(children)
       # @author Jen Hamon (http://www.github.com/jhamon)
       # @return [Hash] Hash representation of tree.
       def to_h
-        key = has_content? ? [name, content] : name
+        key = content? ? [name, content] : name
 
         children_hash = {}
         children do |child|

lib/tree/utils/json_converter.rb

@@ -4,7 +4,7 @@
 #
 # Author::  Anupam Sengupta (anupamsg@gmail.com)
 #
-# Time-stamp: <2022-06-20 01:18:54 anupam>
+# Time-stamp: <2022-06-20 22:16:46 anupam>
 #
 # Copyright (C) 2012, 2013, 2014, 2015, 2022 Anupam Sengupta <anupamsg@gmail.com>
 #
@@ -72,7 +72,7 @@ def as_json(_options = {})
           JSON.create_id => self.class.name
         }
 
-        json_hash['children'] = children if has_children?
+        json_hash['children'] = children if children?
 
         json_hash
       end