term_utils 0.3.2 → 0.5.0

data/lib/term_utils/property_tree_node.rb

@@ -1,4 +1,6 @@
-# Copyright (C) 2019 Thomas Baron
+# frozen_string_literal: true
+
+# Copyright (C) 2023 Thomas Baron
 #
 # This file is part of term_utils.
 #
@@ -13,19 +15,21 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with term_utils.  If not, see <https://www.gnu.org/licenses/>.
+
 module TermUtils
   # Represents a general-purpose tree node that holds a key-value pair.
   class PropertyTreeNode
-    # @return [TermUtils::PropertyTreeNode]
+    # @return [PropertyTreeNode]
     attr_accessor :parent_node
-    # @return [Array<TermUtils::PropertyTreeNode>]
+    # @return [Array<PropertyTreeNode>]
     attr_accessor :child_nodes
     # @return [Object]
     attr_accessor :key
     # @return [Object]
     attr_accessor :value
-    # Creates a new node.
-    # @param opts [Hash<Symbol, Object>]
+
+    # Creates a new PropertyTreeNode.
+    # @param opts [Hash]
     # option opts [Object] :key
     # option opts [Object] :value
     def initialize(opts = {}, &block)
@@ -35,6 +39,7 @@ module TermUtils
       @value = opts.fetch(:value, nil)
       block.call(self) if block
     end
+
     # For dup method.
     def initialize_dup(other)
       @parent_node = nil
@@ -48,27 +53,33 @@ module TermUtils
       end
       super
     end
+
     # Tests whether this one is the head of the tree (i.e. has no parent).
     # @return [Boolean]
     def head?
       @parent_node == nil
     end
+
     # Tests whether this one is a leaf of the tree (i.e. has no child).
     # @return [Boolean]
     def leaf?
       @child_nodes == nil
     end
+
     # Returns the child node identified by a given key.
     # @param key [Object]
-    # @return [TermUtils::PropertyTreeNode, nil]
+    # @return [PropertyTreeNode, nil]
     def child_node(key)
       if @child_nodes
         @child_nodes.find { |n| n.key == key }
       end
     end
+
     # Creates a new node and adds it as a child.
-    # @param opts [Hash<Symbol,Object>] key value
-    # @return [TermUtils::PropertyTreeNode]
+    # @param opts [Hash]
+    # @option opts [Object] :key
+    # @option opts [Object] :value
+    # @return [PropertyTreeNode]
     def define_node(opts = {}, &block)
       new_node = TermUtils::PropertyTreeNode.new(opts)
       new_node.parent_node = self
@@ -77,6 +88,7 @@ module TermUtils
       block.call(new_node) if block
       new_node
     end
+
     # Builds the path of keys.
     # @return [Array<Object>]
     def path
@@ -84,12 +96,15 @@ module TermUtils
       p << @key if @key
       p
     end
+
     # Iterates over every node.
-    # @param opts [Hash<Symbol,Object>] `:path`, `:leaf_only`
+    # @param opts [Hash]
+    # @option opts [Array] :path
+    # @option opts [Boolean] :leaf_only
     # @return [nil]
     def each_node(opts = {}, &block)
       rpath = nil
-      if opts.has_key? :path
+      if opts.key? :path
         rpath = opts[:path].dup
       end
       dive = true
@@ -105,15 +120,15 @@ module TermUtils
             hide = true
           end
         end
-        unless hide or (opts[:leaf_only] and @child_nodes)
-          if opts.has_key? :block
+        unless hide || (opts[:leaf_only] && @child_nodes)
+          if opts.key? :block
             opts[:block].call(self)
           elsif block
             block.call(self)
           end
         end
       end # if @key
-      if dive and @child_nodes
+      if dive && @child_nodes
         ropts = opts.dup
         if rpath
           if rpath.empty?
@@ -131,9 +146,12 @@ module TermUtils
       end
       nil
     end
+
     # Collects nodes.
-    # @param opts [Hash<Symbol,Object>] `:path`, `:leaf_only`
-    # @return [Array<TermUtils::PropertyTreeNode>]
+    # @param opts [Hash]
+    # @option opts [Array] :path
+    # @option opts [Boolean] :leaf_only
+    # @return [Array<PropertyTreeNode>]
     def collect_nodes(opts = {})
       nodes = []
       each_node(opts) do |n|
@@ -141,8 +159,11 @@ module TermUtils
       end
       nodes
     end
+
     # Collects node paths.
-    # @param opts [Hash<Symbol,Object>] `:path`, `:leaf_only`
+    # @param opts [Hash]
+    # @option opts [Array] :path
+    # @option opts [Boolean] :leaf_only
     # @return [Array<Array<Object>>]
     def collect_paths(opts = {})
       paths = []
@@ -151,8 +172,11 @@ module TermUtils
       end
       paths
     end
+
     # Collect node values.
-    # @param opts [Hash<Symbol,Object>] `:path`, `:leaf_only`
+    # @param opts [Hash]
+    # @option opts [Array] :path
+    # @option opts [Boolean] :leaf_only
     # @return [Array<Object>]
     def collect_values(opts = {})
       vals = []
@@ -161,23 +185,26 @@ module TermUtils
       end
       vals
     end
+
     # Finds the node identified by a given path of keys.
     # @param path [Array<Object>]
-    # @return [TermUtils::PropertyTreeNode]
+    # @return [PropertyTreeNode]
     def find_node(path)
       catch :found do
-        each_node(:path => path) do |n|
+        each_node(path: path) do |n| # rubocop:disable Lint/UnreachableLoop
           throw :found, n
         end
         nil
       end
     end
+
     # Tests whether the node identified by a given path of keys exists.
     # @param path [Array<Object>]
     # @return [Boolean]
     def node_exists?(path)
       find_node(path) != nil
     end
+
     # Evaluates the total number of nodes in the tree represented by this one.
     # @param path [Array<Object>]
     # @return [Integer]
@@ -187,6 +214,7 @@ module TermUtils
         node.child_nodes ? node.child_nodes.length : 0
       end
     end
+
     # Finds the node identified by a given path of keys and returns its value.
     # @param path [Array<Object>]
     # @return [Object]