psychgus 1.2.0 → 1.3.4

data/lib/psychgus/styler.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
 #++
 
 
@@ -26,47 +15,47 @@ module Psychgus
   module Styler
     ###
     # An empty {Styler} as a class.
-    # 
-    # @author Jonathan Bradley Whited (@esotericpig)
+    #
+    # @author Jonathan Bradley Whited
     # @since  1.0.0
     ###
     class Empty
       include Styler
     end
   end
-  
+
   ###
   # Mix in (include) this module to make a class/module/etc. a styler for YAML.
-  # 
+  #
   # Although it's unnecessary (because of Duck Typing), it's the recommended practice in case a new method is
   # added in the future, and also so you don't have to define methods that you don't use.
-  # 
+  #
   # You can either use this as is (see example) or inside of a class (see {Blueberry}).
-  # 
+  #
   # @example
   #   class MyStyler
   #     include Psychgus::Styler
-  #     
+  #
   #     def style_sequence(sniffer,node)
   #       node.style = Psychgus::SEQUENCE_FLOW if sniffer.level == 3
   #     end
   #   end
-  #   
+  #
   #   hash = {'Coffee'=>{
   #             'Roast'=>['Light','Medium','Dark','Extra Dark'],
   #             'Style'=>['Cappuccino','Espresso','Latte','Mocha']
   #          }}
   #   puts hash.to_yaml(stylers: MyStyler.new())
-  #   
+  #
   #   # Output:
   #   # ---
   #   # Coffee:
   #   #   Roast: [Light, Medium, Dark, Extra Dark]
   #   #   Style: [Cappuccino, Espresso, Latte, Mocha]
-  # 
-  # @author Jonathan Bradley Whited (@esotericpig)
+  #
+  # @author Jonathan Bradley Whited
   # @since  1.0.0
-  # 
+  #
   # @see Psychgus
   # @see Ext::ObjectExt#to_yaml
   # @see Blueberry
@@ -75,51 +64,51 @@ module Psychgus
   # @see Ext::YAMLTreeExt#accept
   ###
   module Styler
-    EMPTY = Empty.new().freeze()
-    
+    EMPTY = Empty.new.freeze
+
     # Style a node of any type.
-    # 
+    #
     # You can use {Ext::NodeExt#node_of?} to determine its type:
     #   puts node.value if node.node_of?(:scalar)
-    # 
+    #
     # @param sniffer [SuperSniffer] passed in from {StyledTreeBuilder}
     # @param node [Psych::Nodes::Node] passed in from {StyledTreeBuilder}
-    # 
+    #
     # @see Ext::NodeExt#node_of?
     def style(sniffer,node) end
-    
+
     # Style a node guaranteed to be of type Psych::Nodes::Alias, to avoid if statements.
-    # 
+    #
     # @param sniffer [SuperSniffer] passed in from {StyledTreeBuilder}
     # @param node [Psych::Nodes::Alias] of type Alias passed in from {StyledTreeBuilder}
     def style_alias(sniffer,node) end
-    
+
     # Style a node guaranteed to be of type Psych::Nodes::Document, to avoid if statements.
-    # 
+    #
     # @param sniffer [SuperSniffer] passed in from {StyledTreeBuilder}
     # @param node [Psych::Nodes::Document] of type Document passed in from {StyledTreeBuilder}
     def style_document(sniffer,node) end
-    
+
     # Style a node guaranteed to be of type Psych::Nodes::Mapping, to avoid if statements.
-    # 
+    #
     # @param sniffer [SuperSniffer] passed in from {StyledTreeBuilder}
     # @param node [Psych::Nodes::Mapping] of type Mapping passed in from {StyledTreeBuilder}
     def style_mapping(sniffer,node) end
-    
+
     # Style a node guaranteed to be of type Psych::Nodes::Scalar, to avoid if statements.
-    # 
+    #
     # @param sniffer [SuperSniffer] passed in from {StyledTreeBuilder}
     # @param node [Psych::Nodes::Scalar] of type Scalar passed in from {StyledTreeBuilder}
     def style_scalar(sniffer,node) end
-    
+
     # Style a node guaranteed to be of type Psych::Nodes::Sequence, to avoid if statements.
-    # 
+    #
     # @param sniffer [SuperSniffer] passed in from {StyledTreeBuilder}
     # @param node [Psych::Nodes::Sequence] of type Sequence passed in from {StyledTreeBuilder}
     def style_sequence(sniffer,node) end
-    
+
     # Style a node guaranteed to be of type Psych::Nodes::Stream, to avoid if statements.
-    # 
+    #
     # @param sniffer [SuperSniffer] passed in from {StyledTreeBuilder}
     # @param node [Psych::Nodes::Stream] of type Stream passed in from {StyledTreeBuilder}
     def style_stream(sniffer,node) end

data/lib/psychgus/stylers.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
 #++
 
 
@@ -25,10 +14,10 @@ require 'psychgus/stylables'
 module Psychgus
   ###
   # A collection of commonly-used {Styler} classes.
-  # 
+  #
   # @example
   #   require 'psychgus'
-  #   
+  #
   #   class EggCarton
   #     def initialize
   #       @eggs = {
@@ -37,9 +26,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 +36,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 +62,20 @@ 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)
+  #
+  # @author Jonathan Bradley Whited
   # @since  1.2.0
-  # 
+  #
   # @see Stylables
   # @see Styler
   ###
   module Stylers
     ###
     # A Capitalizer for Scalars.
-    # 
+    #
     # @example
     #   require 'psychgus'
-    #   
+    #
     #   data = {
     #     'eggs' => [
     #       'omelette',
@@ -95,78 +84,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 +167,7 @@ module Psychgus
     #   #   - Brown
     #   #   - White
     #   #   - [Blue, Green]
-    # 
+    #
     # @see Stylables::MapFlowStylable
     # @see Stylables::SeqFlowStylable
     ###
@@ -186,118 +175,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
     ###