psychgus 1.3.3 → 1.3.5

data/lib/psychgus/stylers.rb

@@ -1,34 +1,22 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
+# frozen_string_literal: true
 
 #--
 # This file is part of Psychgus.
-# Copyright (c) 2019 Jonathan Bradley Whited (@esotericpig)
-# 
-# Psychgus is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-# 
-# Psychgus is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-# 
-# You should have received a copy of the GNU Lesser General Public License
-# along with Psychgus.  If not, see <http://www.gnu.org/licenses/>.
+# Copyright (c) 2019 Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
-
 require 'psychgus/stylables'
 
 module Psychgus
   ###
   # A collection of commonly-used {Styler} classes.
-  # 
+  #
   # @example
   #   require 'psychgus'
-  #   
+  #
   #   class EggCarton
   #     def initialize
   #       @eggs = {
@@ -37,9 +25,9 @@ module Psychgus
   #       }
   #     end
   #   end
-  #   
+  #
   #   hierarchy = Psychgus::HierarchyStyler.new(io: $stdout)
-  #   
+  #
   #   puts EggCarton.new.to_yaml(stylers: [
   #     Psychgus::NoSymStyler.new,
   #     Psychgus::NoTagStyler.new,
@@ -47,13 +35,13 @@ module Psychgus
   #     Psychgus::FlowStyler.new(4),
   #     hierarchy
   #   ])
-  #   
+  #
   #   # Output:
   #   # ---
   #   # Eggs:
   #   #   Styles: [Fried, Scrambled, [BBQ, Ketchup & Mustard]]
   #   #   Colors: [Brown, White, [Blue, Green]]
-  #   
+  #
   #   # (1:1):Psych::Nodes::Stream - <root:(0:0)>
   #   # (1:1):Psych::Nodes::Document - <stream:(1:1)>
   #   # (1:1):Psych::Nodes::Mapping - <doc:(1:1)>
@@ -73,20 +61,17 @@ module Psychgus
   #   #      (6:3):Psych::Nodes::Sequence - <seq:(5:1)>
   #   #       (7:1):Blue - <seq:(6:3)>
   #   #       (7:2):Green - <seq:(6:3)>
-  # 
-  # @author Jonathan Bradley Whited (@esotericpig)
-  # @since  1.2.0
-  # 
+  #
   # @see Stylables
   # @see Styler
   ###
   module Stylers
     ###
     # A Capitalizer for Scalars.
-    # 
+    #
     # @example
     #   require 'psychgus'
-    #   
+    #
     #   data = {
     #     'eggs' => [
     #       'omelette',
@@ -95,78 +80,78 @@ module Psychgus
     #       'soft_boiled eggs',
     #       'fried@eggs'
     #   ]}
-    #   
+    #
     #   seq_flow = Psychgus::SeqFlowStyler.new
-    #   
+    #
     #   puts data.to_yaml(stylers: [Psychgus::CapStyler.new,seq_flow])
-    #   
+    #
     #   # Output:
     #   # ---
     #   # Eggs: [Omelette, BBQ Eggs, Hard-Boiled Eggs, Soft_Boiled Eggs, Fried@eggs]
-    #   
+    #
     #   puts data.to_yaml(stylers: [Psychgus::CapStyler.new(each_word: false),seq_flow])
-    #   
+    #
     #   # Output:
     #   # ---
     #   # Eggs: [Omelette, BBQ eggs, Hard-boiled eggs, Soft_boiled eggs, Fried@eggs]
-    #   
+    #
     #   puts data.to_yaml(stylers: [Psychgus::CapStyler.new(new_delim: '(o)'),seq_flow])
-    #   
+    #
     #   # Output:
     #   # ---
     #   # Eggs: [Omelette, BBQ(o)Eggs, Hard(o)Boiled(o)Eggs, Soft(o)Boiled(o)Eggs, Fried@eggs]
-    #   
+    #
     #   class Cappie
     #     include Psychgus::CapStylable
-    #     
+    #
     #     def cap_word(word)
     #       return 'bbq' if word.casecmp('BBQ') == 0
-    #       
+    #
     #       super(word)
     #     end
     #   end
-    #   
+    #
     #   puts data.to_yaml(stylers: [Cappie.new(new_delim: '*',delim: /[\s@]/),seq_flow])
-    #   
+    #
     #   # Output:
     #   # ---
     #   # Eggs: [Omelette, bbq*Eggs, Hard-boiled*Eggs, Soft_boiled*Eggs, Fried*Eggs]
-    # 
+    #
     # @see Stylables::CapStylable
     ###
     class CapStyler
       include Stylables::CapStylable
     end
-    
+
     ###
     # A FLOW style changer for Mappings & Sequences.
-    # 
+    #
     # @example
     #   require 'psychgus'
-    #   
+    #
     #   data = {
     #     'Eggs' => {
     #       'Styles' => ['Fried', 'Scrambled', ['BBQ', 'Ketchup']],
     #       'Colors' => ['Brown', 'White', ['Blue', 'Green']]
     #   }}
-    #   
+    #
     #   puts data.to_yaml(stylers: Psychgus::FlowStyler.new)
-    #   
+    #
     #   # Output:
     #   # --- {Eggs: {Styles: [Fried, Scrambled, [BBQ, Ketchup]], Colors: [Brown, White, [Blue, Green]]}}
-    #   
+    #
     #   # >= level 4 (see Psychgus.hierarchy)
     #   puts data.to_yaml(stylers: Psychgus::FlowStyler.new(4))
-    #   
+    #
     #   # Output:
     #   # ---
     #   # Eggs:
     #   #   Styles: [Fried, Scrambled, [BBQ, Ketchup]]
     #   #   Colors: [Brown, White, [Blue, Green]]
-    #   
+    #
     #   # >= level 6 (see Psychgus.hierarchy)
     #   puts data.to_yaml(stylers: Psychgus::FlowStyler.new(6))
-    #   
+    #
     #   # Output:
     #   # ---
     #   # Eggs:
@@ -178,7 +163,7 @@ module Psychgus
     #   #   - Brown
     #   #   - White
     #   #   - [Blue, Green]
-    # 
+    #
     # @see Stylables::MapFlowStylable
     # @see Stylables::SeqFlowStylable
     ###
@@ -186,118 +171,118 @@ module Psychgus
       include Stylables::MapFlowStylable
       include Stylables::SeqFlowStylable
     end
-    
+
     ###
     # A visual hierarchy writer of the levels.
-    # 
+    #
     # This is useful for determining the correct level/position when writing a {Styler}.
-    # 
+    #
     # The default IO is StringIO, but can specify a different one.
-    # 
+    #
     # See {Psychgus.hierarchy} for more details.
-    # 
+    #
     # @see Psychgus.hierarchy
     # @see Stylables::HierarchyStylable
     ###
     class HierarchyStyler
       include Stylables::HierarchyStylable
     end
-    
+
     ###
     # A FLOW style changer for Mappings only.
-    # 
+    #
     # @see FlowStyler
     # @see Stylables::MapFlowStylable
     ###
     class MapFlowStyler
       include Stylables::MapFlowStylable
     end
-    
+
     ###
     # A Symbol remover for Scalars.
-    # 
+    #
     # @example
     #   require 'psychgus'
-    #   
+    #
     #   data = {
     #     :eggs => {
     #       :styles => ['Fried', 'Scrambled', ['BBQ', 'Ketchup']],
     #       :colors => ['Brown', 'White', ['Blue', 'Green']]
     #   }}
-    #   
+    #
     #   flow = Psychgus::FlowStyler.new(4)
-    #   
+    #
     #   puts data.to_yaml(stylers: [Psychgus::NoSymStyler.new,flow])
-    #   
+    #
     #   # Output:
     #   # ---
     #   # Eggs:
     #   #   Styles: [Fried, Scrambled, [BBQ, Ketchup]]
     #   #   Colors: [Brown, White, [Blue, Green]]
-    #   
+    #
     #   puts data.to_yaml(stylers: [Psychgus::NoSymStyler.new(cap: false),flow])
-    #   
+    #
     #   # ---
     #   # eggs:
     #   #   styles: [Fried, Scrambled, [BBQ, Ketchup]]
     #   #   colors: [Brown, White, [Blue, Green]]
-    # 
+    #
     # @see Stylables::NoSymStylable
     ###
     class NoSymStyler
       include Stylables::NoSymStylable
     end
-    
+
     ###
     # A Tag remover for classes.
-    # 
+    #
     # @example
     #   require 'psychgus'
-    #   
+    #
     #   class Eggs
     #     def initialize
     #       @styles = ['Fried', 'Scrambled', ['BBQ', 'Ketchup']]
     #       @colors = ['Brown', 'White', ['Blue', 'Green']]
     #     end
     #   end
-    #   
+    #
     #   class EggCarton
     #     include Psychgus::Blueberry
-    #     
+    #
     #     def initialize
     #       @eggs = Eggs.new
     #     end
-    #     
+    #
     #     def psychgus_stylers(sniffer)
     #       Psychgus::FlowStyler.new(4)
     #     end
     #   end
-    #   
+    #
     #   puts EggCarton.new.to_yaml
-    #   
+    #
     #   # Output:
     #   # --- !ruby/object:EggCarton
     #   # eggs: !ruby/object:Eggs
     #   #   styles: [Fried, Scrambled, [BBQ, Ketchup]]
     #   #   colors: [Brown, White, [Blue, Green]]
-    #   
+    #
     #   puts EggCarton.new.to_yaml(stylers: Psychgus::NoTagStyler.new)
-    #   
+    #
     #   # Output:
     #   # ---
     #   # eggs:
     #   #   styles: [Fried, Scrambled, [BBQ, Ketchup]]
     #   #   colors: [Brown, White, [Blue, Green]]
-    # 
+    #
     # @see Stylables::NoTagStylable
     ###
     class NoTagStyler
       include Stylables::NoTagStylable
     end
-    
+
     ###
     # A FLOW style changer for Sequences only.
-    # 
+    #
     # @see FlowStyler
     # @see Stylables::SeqFlowStylable
     ###

data/lib/psychgus/super_sniffer/parent.rb

@@ -1,80 +1,66 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
+# frozen_string_literal: true
 
 #--
 # This file is part of Psychgus.
-# Copyright (c) 2019 Jonathan Bradley Whited (@esotericpig)
-# 
-# Psychgus is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-# 
-# Psychgus is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-# 
-# You should have received a copy of the GNU Lesser General Public License
-# along with Psychgus.  If not, see <http://www.gnu.org/licenses/>.
+# Copyright (c) 2019 Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
-
 require 'delegate'
 
-
 module Psychgus
   class SuperSniffer
     ###
     # A container for the parent of a Psych::Nodes::Node.
-    # 
+    #
     # A parent is a Mapping, Sequence, or a Key (Scalar) of a Mapping.
-    # 
+    #
     # You can use the getters in this class in {Styler} to filter what to change.
-    # 
+    #
     # If a Node method has not been exposed, you can use {#node}:
     #   if parent.node_of?(:scalar)
     #     parent.value = 'FUBAR'
     #     parent.node.value = 'FUBAR' # Same as above
-    #     
+    #
     #     parent.fubar = true      # NoMethodError
     #     parent.node.fubar = true # Use some new Psych::Nodes::Node method not in this version
     #                              #   of Psychgus or that is not exposed by Parent
     #   end
-    # 
-    # @author Jonathan Bradley Whited (@esotericpig)
-    # @since  1.0.0
-    # 
+    #
     # @see SuperSniffer
     # @see SuperSniffer#start_parent SuperSniffer#start_parent
     # @see SuperSniffer#end_parent SuperSniffer#end_parent
     # @see Styler
     ###
-    class Parent < Delegator
+    class Parent < SimpleDelegator
       # Calling the getter is fine; calling the setter is *not* and could cause weird results.
-      # 
+      #
       # @return [Integer] the next child's position
       attr_accessor :child_position
-      
+
       # Calling the getter is fine; calling the setter is *not* and could cause weird results.
-      # 
+      #
       # @return [nil,:key,:value] the next child's Mapping type, if {#node} is a Mapping
       attr_accessor :child_type
-      
+
       # @return [:noface,Symbol,String] a tag (class name, value) for debugging; also used in {#to_s}
       attr_reader :debug_tag
-      
+
       attr_reader :level # @return [Integer] the level of this Node in the YAML
       attr_reader :node # @return [Psych::Nodes::Node] the Node of this parent
       attr_reader :position # @return [Integer] the position of this Node in the YAML
-      
+
       # Initialize this class with parent data.
-      # 
+      #
       # @param sniffer [SuperSniffer] the sniffer that contains this parent (not stored; used for data)
       # @param node [Psych::Nodes::Node] the node of this parent
       # @param debug_tag [:noface,Symbol,String] the tag (class name, value) used for debugging and in {#to_s}
       # @param child_type [nil,:key,:value] the next child's Mapping type, if +node+ is a Mapping
       def initialize(sniffer,node,debug_tag: nil,child_type: nil)
+        super(node)
+
         @child_position = 1
         @child_type = child_type
         @debug_tag = debug_tag
@@ -82,61 +68,57 @@ module Psychgus
         @node = node
         @position = sniffer.position
       end
-      
+
       # @api private
       def __getobj__
         return @node
       end
-      
+
       # Check if the children of this parent are keys to a Mapping.
-      # 
+      #
       # @return [true,false] whether the children are keys to a Mapping
-      # 
-      # @since 1.2.0
-      def child_key?()
+      def child_key?
         return @child_type == :key
       end
-      
+
       # Check if the children of this parent are values to a Mapping (i.e., values to a key).
-      # 
+      #
       # @return [true,false] whether the children are values to a Mapping (i.e., values to a key)
-      # 
-      # @since 1.2.0
-      def child_value?()
+      def child_value?
         return @child_type == :value
       end
-      
+
       # @see Psych::Nodes::Document#implicit
       # @see Psych::Nodes::Mapping#implicit
       # @see Psych::Nodes::Sequence#implicit
-      def implicit?()
+      def implicit?
         return @node.implicit
       end
-      
+
       # @see Psych::Nodes::Document#implicit_end
-      def implicit_end?()
+      def implicit_end?
         return @node.implicit_end
       end
-      
+
       # (see Ext::NodeExt#node_of?)
       def node_of?(*names)
         return @node.node_of?(*names)
       end
-      
+
       # @see Psych::Nodes::Scalar#plain
-      def plain?()
+      def plain?
         return @node.plain
       end
-      
+
       # @see Psych::Nodes::Scalar#quoted
-      def quoted?()
+      def quoted?
         return @node.quoted
       end
-      
+
       # @note If this method is modified, then tests will fail
-      # 
+      #
       # @return [String] a String representation of this class for debugging and testing
-      def to_s()
+      def to_s
         return "<#{@debug_tag}:(#{@level}:#{@position}):#{@child_type}:(:#{@child_position})>"
       end
     end