psychgus 1.2.0 → 1.3.4

data/lib/psychgus/stylables.rb

@@ -1,22 +1,11 @@
-#!/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-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 
@@ -29,27 +18,27 @@ module Psychgus
   ###
   # A collection of commonly-used {Styler} mixins
   # that can be included in a class instead of {Styler}.
-  # 
-  # @author Jonathan Bradley Whited (@esotericpig)
+  #
+  # @author Jonathan Bradley Whited
   # @since  1.2.0
-  # 
+  #
   # @see Stylers
   # @see Styler
   ###
   module Stylables
     ###
     # A helper mixin for Stylables that change a node's style.
-    # 
+    #
     # There is no max level, because a parent's style will override all of its children.
     ###
     module StyleStylable
       include Styler
-      
+
       attr_accessor :min_level # @return [Integer] the minimum level (inclusive) to style
       attr_accessor :new_style # @return [Integer] the new style to set the nodes to
-      
+
       # +max_level+ is not defined because a parent's style will override all of its children.
-      # 
+      #
       # @param min_level [Integer] the minimum level (inclusive) to style
       # @param new_style [Integer] the new style to set the nodes to
       # @param kargs [Hash] capture extra keyword args, so no error for undefined args
@@ -57,212 +46,212 @@ module Psychgus
         @min_level = min_level
         @new_style = new_style
       end
-      
+
       # Change the style of +node+ to {new_style} if it is >= {min_level}.
       def change_style(sniffer,node)
         return unless node.respond_to?(:style=)
-        
+
         node.style = @new_style if sniffer.level >= @min_level
       end
     end
   end
-  
+
   module Stylables
     ###
     # (see Stylers::CapStyler)
     ###
     module CapStylable
       include Styler
-      
+
       attr_reader :delim # @return [String,Regexp] the delimiter to split on
       attr_accessor :each_word # @return [true,false] whether to capitalize each word separated by {delim}
       attr_accessor :new_delim # @return [nil,String] the replacement for each {delim} if not nil
-      
+
       # @param each_word [true,false] whether to capitalize each word separated by +delim+
       # @param new_delim [nil,String] the replacement for each +delim+ if not nil
       # @param delim [String,Regexp] the delimiter to split on
       # @param kargs [Hash] capture extra keyword args, so no error for undefined args
       def initialize(each_word: true,new_delim: nil,delim: /[\s_\-]/,**kargs)
-        delim = Regexp.quote(delim.to_s()) unless delim.is_a?(Regexp)
-        
-        @delim = Regexp.new("(#{delim.to_s()})")
+        delim = Regexp.quote(delim.to_s) unless delim.is_a?(Regexp)
+
+        @delim = Regexp.new("(#{delim})")
         @each_word = each_word
         @new_delim = new_delim
       end
-      
+
       # Capitalize an individual word (not words).
-      # 
+      #
       # This method can safely be overridden with a new implementation.
-      # 
+      #
       # @param word [nil,String] the word to capitalize
-      # 
+      #
       # @return [String] the capitalized word
       def cap_word(word)
-        return word if word.nil?() || word.empty?()
-        
+        return word if word.nil? || word.empty?
+
         # Already capitalized, good for all-capitalized words, like 'BBQ'
-        return word if word[0] == word[0].upcase()
-        
-        return word.capitalize()
+        return word if word[0] == word[0].upcase
+
+        return word.capitalize
       end
-      
+
       # Capitalize +node.value+.
-      # 
+      #
       # @see cap_word
       # @see Styler#style_scalar
       def style_scalar(sniffer,node)
-        if !@each_word || node.value.nil?() || node.value.empty?()
+        if !@each_word || node.value.nil? || node.value.empty?
           node.value = cap_word(node.value)
           return
         end
-        
+
         is_delim = false
-        
-        node.value = node.value.split(@delim).map() do |v|
+
+        node.value = node.value.split(@delim).map do |v|
           if is_delim
-            v = @new_delim unless @new_delim.nil?()
+            v = @new_delim unless @new_delim.nil?
           else
             v = cap_word(v)
           end
-          
+
           is_delim = !is_delim
           v
-        end.join()
+        end.join
       end
     end
-    
+
     ###
     # (see Stylers::HierarchyStyler)
     ###
     module HierarchyStylable
       include Styler
-      
+
       attr_accessor :io # @return [IO] the IO to write to; defaults to StringIO
       attr_accessor :verbose # @return [true,false] whether to be more verbose (e.g., write child info)
-      
+
       # @param io [IO] the IO to write to
       # @param verbose [true,false] whether to be more verbose (e.g., write child info)
       # @param kargs [Hash] capture extra keyword args, so no error for undefined args
-      def initialize(io: StringIO.new(),verbose: false,**kargs)
+      def initialize(io: StringIO.new,verbose: false,**kargs)
         @io = io
         @verbose = verbose
       end
-      
+
       # Write the hierarchy of +node+ to {io}.
-      # 
+      #
       # @see Styler#style
       def style(sniffer,node)
-        @io.print (' ' * (sniffer.level - 1))
-        
+        @io.print(' ' * (sniffer.level - 1))
+
         name = node.respond_to?(:value) ? node.value : node.class.name
         parent = sniffer.parent
-        
+
         @io.print "(#{sniffer.level}:#{sniffer.position}):#{name} - "
-        
+
         if @verbose
           @io.print parent
         else
           @io.print "<#{parent.debug_tag}:(#{parent.level}:#{parent.position})>"
         end
-        
+
         @io.puts
       end
-      
+
       # Convert {io} to a String if possible (e.g., StringIO).
-      # 
+      #
       # @return [String] the IO String result or just {io} as a String
-      def to_s()
-        return @io.respond_to?(:string) ? @io.string : @io.to_s()
+      def to_s
+        return @io.respond_to?(:string) ? @io.string : @io.to_s
       end
     end
-    
+
     ###
     # (see Stylers::MapFlowStyler)
     ###
     module MapFlowStylable
       include StyleStylable
-      
+
       # (see StyleStylable#initialize)
       # @!method initialize(min_level=0,new_style: nil,**kargs)
-      # 
+      #
       # If +new_style+ is nil (the default), then {MAPPING_FLOW} will be used.
       def initialize(*)
         super
-        
-        @new_style = MAPPING_FLOW if @new_style.nil?()
+
+        @new_style = MAPPING_FLOW if @new_style.nil?
       end
-      
+
       # Change the style of a Mapping to FLOW (or to the value of {new_style})
       # if it is >= {min_level}.
-      # 
+      #
       # @see change_style
       # @see Styler#style_mapping
       def style_mapping(sniffer,node)
         change_style(sniffer,node)
       end
     end
-    
+
     ###
     # (see Stylers::NoSymStyler)
     ###
     module NoSymStylable
       include Styler
-      
+
       attr_accessor :cap # @return [true,false] whether to capitalize the symbol
-      
+
       alias_method :cap?,:cap
-      
+
       # @param cap [true,false] whether to capitalize the symbol
       # @param kargs [Hash] capture extra keyword args, so no error for undefined args
       def initialize(cap: true,**kargs)
         @cap = cap
       end
-      
+
       # If +node.value+ is a symbol, change it into a string and capitalize it.
-      # 
+      #
       # @see Styler#style_scalar
       def style_scalar(sniffer,node)
-        return if node.value.nil?() || node.value.empty?()
+        return if node.value.nil? || node.value.empty?
         return if node.value[0] != ':'
-        
+
         node.value = node.value[1..-1]
-        node.value = node.value.capitalize() if @cap
+        node.value = node.value.capitalize if @cap
       end
     end
-    
+
     ###
     # (see Stylers::NoTagStyler)
     ###
     module NoTagStylable
       include Styler
-      
+
       # If +node.tag+ is settable, set it to nil.
-      # 
+      #
       # @see Styler#style
       def style(sniffer,node)
         node.tag = nil if node.respond_to?(:tag=)
       end
     end
-    
+
     ###
     # (see Stylers::SeqFlowStyler)
     ###
     module SeqFlowStylable
       include StyleStylable
-      
+
       # (see StyleStylable#initialize)
       # @!method initialize(min_level=0,new_style: nil,**kargs)
-      # 
+      #
       # If +new_style+ is nil (the default), then {SEQUENCE_FLOW} will be used.
       def initialize(*)
         super
-        
-        @new_style = SEQUENCE_FLOW if @new_style.nil?()
+
+        @new_style = SEQUENCE_FLOW if @new_style.nil?
       end
-      
+
       # Change the style of a Sequence to FLOW (or to the value of {new_style})
       # if it is >= {min_level}.
-      # 
+      #
       # @see change_style
       # @see Styler#style_sequence
       def style_sequence(sniffer,node)

data/lib/psychgus/styled_document_stream.rb

@@ -1,22 +1,11 @@
-#!/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-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 
@@ -27,36 +16,36 @@ require 'psychgus/styled_tree_builder'
 module Psychgus
   ###
   # Use this wherever Psych::Handlers::DocumentStream would have been used, to enable styling.
-  # 
-  # @author Jonathan Bradley Whited (@esotericpig)
+  #
+  # @author Jonathan Bradley Whited
   # @since  1.0.0
-  # 
+  #
   # @see Psychgus.parse_stream Psychgus.parse_stream
   # @see Psych::Handlers::DocumentStream
   ###
   class StyledDocumentStream < StyledTreeBuilder
     # Initialize this class with {Styler}(s) and a block.
-    # 
+    #
     # @param stylers [Styler] {Styler}(s) to use for styling this DocumentStream
     # @param deref_aliases [true,false] whether to dereference aliases; output the actual value
     #                                   instead of the alias
     # @param block [Proc] a block to call in {#end_document} to denote a new YAML document
     def initialize(*stylers,deref_aliases: false,**options,&block)
       super(*stylers,deref_aliases: deref_aliases,**options)
-      
+
       @block = block
     end
-    
+
     # This mimics the behavior of Psych::Handlers::DocumentStream#end_document.
-    # 
+    #
     # @see Psych::Handlers::DocumentStream#end_document
-    def end_document(implicit_end=!streaming?())
+    def end_document(implicit_end=!streaming?)
       @last.implicit_end = implicit_end
       @block.call(pop)
     end
-    
+
     # This mimics the behavior of Psych::Handlers::DocumentStream#start_document.
-    # 
+    #
     # @see Psych::Handlers::DocumentStream#start_document
     def start_document(version,tag_directives,implicit)
       node = Psych::Nodes::Document.new(version,tag_directives,implicit)

data/lib/psychgus/styled_tree_builder.rb

@@ -1,22 +1,11 @@
-#!/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-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 
@@ -28,10 +17,10 @@ require 'psychgus/super_sniffer'
 module Psychgus
   ###
   # Use this wherever Psych::TreeBuilder would have been used, to enable styling.
-  # 
-  # @author Jonathan Bradley Whited (@esotericpig)
+  #
+  # @author Jonathan Bradley Whited
   # @since  1.0.0
-  # 
+  #
   # @see Psychgus.parser Psychgus.parser
   # @see Psychgus.dump_stream Psychgus.dump_stream
   # @see Psych::TreeBuilder
@@ -40,254 +29,254 @@ module Psychgus
     # @return [true,false] whether to dereference aliases; output the actual value instead of the alias
     attr_accessor :deref_aliases
     alias_method :deref_aliases?,:deref_aliases
-    
+
     # @return [SuperSniffer] the {SuperSniffer} being used to sniff the YAML nodes, level, etc.
     attr_reader :sniffer
-    
+
     # @return [Array<Stylers>] the {Styler}(s) being used to style the YAML nodes
     attr_reader :stylers
-    
+
     # Initialize this class with {Styler}(s).
-    # 
+    #
     # @param stylers [Styler] {Styler}(s) to use for styling this TreeBuilder
     # @param deref_aliases [true,false] whether to dereference aliases; output the actual value
     #                                   instead of the alias
     def initialize(*stylers,deref_aliases: false,**options)
       super()
-      
+
       @deref_aliases = deref_aliases
-      @sniffer = SuperSniffer.new()
+      @sniffer = SuperSniffer.new
       @stylers = []
-      
+
       add_styler(*stylers)
     end
-    
+
     # Add {Styler}(s) onto the end of the data structure.
-    # 
+    #
     # @param stylers [Styler] {Styler}(s) to add
-    # 
+    #
     # @return [self] this class
     def add_styler(*stylers)
       @stylers.push(*stylers)
-      
+
       return self
     end
-    
+
     # Calls super, styler(s), and sniffer.
-    # 
+    #
     # @see Psych::TreeBuilder#alias
     # @see Styler#style
     # @see Styler#style_alias
     # @see SuperSniffer#add_alias
-    # 
+    #
     # @return [Psych::Nodes::Alias] the alias node created
     def alias(*)
       node = super
-      
+
       @stylers.each do |styler|
         styler.style(sniffer,node)
         styler.style_alias(sniffer,node)
       end
-      
+
       @sniffer.add_alias(node)
-      
+
       return node
     end
-    
+
     # Calls super and sniffer.
-    # 
+    #
     # @see Psych::TreeBuilder#end_document
     # @see SuperSniffer#end_document
     def end_document(*)
       result = super
-      
-      @sniffer.end_document()
-      
+
+      @sniffer.end_document
+
       return result
     end
-    
+
     # Calls super and sniffer.
-    # 
+    #
     # @see Psych::TreeBuilder#end_mapping
     # @see SuperSniffer#end_mapping
     def end_mapping(*)
       result = super
-      
-      @sniffer.end_mapping()
-      
+
+      @sniffer.end_mapping
+
       return result
     end
-    
+
     # Calls super and sniffer.
-    # 
+    #
     # @see Psych::TreeBuilder#end_sequence
     # @see SuperSniffer#end_sequence
     def end_sequence(*)
       result = super
-      
-      @sniffer.end_sequence()
-      
+
+      @sniffer.end_sequence
+
       return result
     end
-    
+
     # Calls super and sniffer.
-    # 
+    #
     # @see Psych::TreeBuilder#end_stream
     # @see SuperSniffer#end_stream
     def end_stream(*)
       result = super
-      
-      @sniffer.end_stream()
-      
+
+      @sniffer.end_stream
+
       return result
     end
-    
+
     # Insert {Styler}(s) at +index+ into the data structure.
-    # 
+    #
     # @param stylers [Styler] {Styler}(s) to insert
-    # 
+    #
     # @return [self] this class
     def insert_styler(index,*stylers)
       @stylers.insert(index,*stylers)
-      
+
       return self
     end
-    
+
     # Remove the last {Styler}(s) from the data structure.
-    # 
+    #
     # @param count [Integer] the optional amount of tail elements to pop
-    # 
+    #
     # @return [Styler,Array<Styler>,nil] the last {Styler}(s), or if empty or count==0, nil
     def pop_styler(count=1)
       return nil if count == 0
-      return @stylers.pop() if count == 1
-      
+      return @stylers.pop if count == 1
+
       return @stylers.pop(count)
     end
-    
+
     # Remove the {Styler} that matches +styler+ from the data structure.
-    # 
+    #
     # An optional +block+ can return a default value if not found.
-    # 
+    #
     # @param styler [Styler] the {Styler} to find and remove
     # @param block [Proc] an optional block to call when +styler+ is not found
-    # 
+    #
     # @return [Styler,nil] the last {Styler}, or if not found, nil or the result of +block+
     def remove_styler(styler,&block)
       return @stylers.delete(styler,&block)
     end
-    
+
     # Remove the {Styler} at +index+ from the data structure.
-    # 
+    #
     # @param index [Integer] the index of the {Styler} to remove
-    # 
+    #
     # @return [Styler,nil] the {Styler} removed or nil if empty
     def remove_styler_at(index)
       return @stylers.delete_at(index)
     end
-    
+
     # Calls super, styler(s), and sniffer.
-    # 
+    #
     # @see Psych::TreeBuilder#scalar
     # @see Styler#style
     # @see Styler#style_scalar
     # @see SuperSniffer#add_scalar
-    # 
+    #
     # @return [Psych::Nodes::Scalar] the scalar node created
     def scalar(*)
       node = super
-      
+
       @stylers.each do |styler|
         styler.style(sniffer,node)
         styler.style_scalar(sniffer,node)
       end
-      
+
       @sniffer.add_scalar(node)
-      
+
       return node
     end
-    
+
     # Calls super, styler(s), and sniffer.
-    # 
+    #
     # @see Psych::TreeBuilder#start_document
     # @see Styler#style
     # @see Styler#style_document
     # @see SuperSniffer#start_document
-    # 
+    #
     # @return [Psych::Nodes::Document] the document node created
     def start_document(*)
       node = super
-      
+
       @stylers.each do |styler|
         styler.style(sniffer,node)
         styler.style_document(sniffer,node)
       end
-      
+
       @sniffer.start_document(node)
-      
+
       return node
     end
-    
+
     # Calls super, styler(s), and sniffer.
-    # 
+    #
     # @see Psych::TreeBuilder#start_mapping
     # @see Styler#style
     # @see Styler#style_mapping
     # @see SuperSniffer#start_mapping
-    # 
+    #
     # @return [Psych::Nodes::Mapping] the mapping node created
     def start_mapping(*)
       node = super
-      
+
       @stylers.each do |styler|
         styler.style(sniffer,node)
         styler.style_mapping(sniffer,node)
       end
-      
+
       @sniffer.start_mapping(node)
-      
+
       return node
     end
-    
+
     # Calls super, styler(s), and sniffer.
-    # 
+    #
     # @see Psych::TreeBuilder#start_sequence
     # @see Styler#style
     # @see Styler#style_sequence
     # @see SuperSniffer#start_sequence
-    # 
+    #
     # @return [Psych::Nodes::Sequence] the sequence node created
     def start_sequence(*)
       node = super
-      
+
       @stylers.each do |styler|
         styler.style(sniffer,node)
         styler.style_sequence(sniffer,node)
       end
-      
+
       @sniffer.start_sequence(node)
-      
+
       return node
     end
-    
+
     # Calls super, styler(s), and sniffer.
-    # 
+    #
     # @see Psych::TreeBuilder#start_stream
     # @see Styler#style
     # @see Styler#style_stream
     # @see SuperSniffer#start_stream
-    # 
+    #
     # @return [Psych::Nodes::Stream] the stream node created
     def start_stream(*)
       node = super
-      
+
       @stylers.each do |styler|
         styler.style(sniffer,node)
         styler.style_stream(sniffer,node)
       end
-      
+
       @sniffer.start_stream(node)
-      
+
       return node
     end
   end