psychgus 1.2.0 → 1.3.4

data/lib/psychgus/blueberry.rb

@@ -1,107 +1,96 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
+# frozen_string_literal: true
 
 #--
 # This file is part of Psychgus.
-# Copyright (c) 2017-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) 2017-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 
 module Psychgus
   ###
   # This is the OOP way to style your classes/modules/etc.
-  # 
+  #
   # Even though it's unnecessary to mix in (include) this module, it's recommended because new methods may be
   # added in the future, so this pseudo-guarantees your class won't break in a new version.
-  # 
+  #
   # A complete example:
   #   require 'psychgus'
-  #   
+  #
   #   class MyClass
   #     include Psychgus::Blueberry
-  #     
+  #
   #     attr_reader :my_hash
-  #     
+  #
   #     def initialize()
   #       @my_hash = {:key1=>'val1',:key2=>'val2'}
   #     end
-  #     
+  #
   #     def psychgus_stylers(sniffer)
   #       return MyClassStyler.new(sniffer)
   #     end
   #   end
-  #   
+  #
   #   class MyClassStyler
   #     include Psychgus::Styler
-  #     
+  #
   #     def initialize(sniffer)
   #       @level = sniffer.level
   #     end
-  #     
+  #
   #     def style_mapping(sniffer,node)
   #       node.style = Psychgus::MAPPING_FLOW
-  #       
+  #
   #       relative_level = sniffer.level - @level
   #     end
   #   end
-  #   
+  #
   #   my_class = MyClass.new()
   #   puts my_class.to_yaml()
-  # 
+  #
   # Alternatively, MyClass could have been the {Blueberry} and the {Styler}, without the need for
   # MyClassStyler:
   #   class MyClass
   #     include Psychgus::Blueberry
   #     include Psychgus::Styler
-  #     
+  #
   #     # ...
-  #     
+  #
   #     def psychgus_stylers(sniffer)
   #       @level = sniffer.level # This will be included in the output of to_yaml()
-  #       
+  #
   #       return self
   #     end
-  #     
+  #
   #     def style_mapping(sniffer,node)
   #       # ...
   #     end
   #   end
-  # 
+  #
   # However, it's best to put the styling logic inside of a separate class (or inner class) away from the main
   # logic. This also prevents extra helper vars, like @level, from showing up in the output.
-  # 
+  #
   # After your class and its children have been processed, the styler(s) will be removed from the logic for
   # the next sibling object(s). Therefore, you can safely do class-specific checks on level, etc. without it
   # affecting the sibling object(s). See {Ext::YAMLTreeExt} and {Ext::YAMLTreeExt#accept} for details.
-  # 
+  #
   # "The Blueberry" is the name of Gus's car from the TV show Psych.
-  # 
-  # @author Jonathan Bradley Whited (@esotericpig)
+  #
+  # @author Jonathan Bradley Whited
   # @since  1.0.0
-  # 
+  #
   # @see Ext::YAMLTreeExt
   # @see Ext::YAMLTreeExt#accept
   ###
   module Blueberry
     # Duck Type this method to return the {Styler}(s) for your class/module/etc.
-    # 
+    #
     # @param sniffer [SuperSniffer] passed in from {StyledTreeBuilder}; use this for storing the level,
     #                               position, etc. for styling your instance variables later relative to your
     #                               class/module/etc.
-    # 
+    #
     # @return [Styler,Array<Styler>,nil] {Styler}(s) for this class/module/etc.
     def psychgus_stylers(sniffer)
       return nil

data/lib/psychgus/ext.rb

@@ -1,30 +1,19 @@
-#!/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
 #++
 
 
 module Psychgus
   ###
   # Contains all of the extensions (monkey patching) to core/Psych classes/modules.
-  # 
-  # @author Jonathan Bradley Whited (@esotericpig)
+  #
+  # @author Jonathan Bradley Whited
   # @since  1.0.0
   ###
   module Ext

data/lib/psychgus/ext/core_ext.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
 #++
 
 
@@ -24,47 +13,47 @@ module Psychgus
   module Ext
     ###
     # Core extensions to Object.
-    # 
-    # @author Jonathan Bradley Whited (@esotericpig)
+    #
+    # @author Jonathan Bradley Whited
     # @since  1.0.0
-    # 
+    #
     # @see https://github.com/ruby/psych/blob/master/lib/psych/core_ext.rb
     ###
     module ObjectExt
       # Convert an Object to YAML.
-      # 
+      #
       # +options+ can also be a Hash, so can be a drop-in-replacement for Psych.
-      # 
+      #
       # @example
       #   class MyStyler
       #     include Psychgus::Styler
-      #     
+      #
       #     def style_sequence(sniffer,node)
       #       node.style = Psychgus::SEQUENCE_FLOW
       #     end
       #   end
-      #   
+      #
       #   my_obj = {
       #     :Foods => {
       #       :Fruits  => %w(Apple Banana Blueberry Pear),
       #       :Veggies => %w(Bean Carrot Celery Pea)
       #   }}
-      #   
+      #
       #   puts my_obj.to_yaml(indentation: 5,stylers: MyStyler.new)
-      #   
+      #
       #   # Or, pass in a Hash:
       #   #puts my_obj.to_yaml({:indentation=>5,:stylers=>MyStyler.new})
-      #   
+      #
       #   # Output:
       #   # ---
       #   # :Foods:
       #   #      :Fruits: [Apple, Banana, Blueberry, Pear]
       #   #      :Veggies: [Bean, Carrot, Celery, Pea]
-      # 
+      #
       # @param options [Hash] the options (or keyword args) to pass to {Psychgus.dump}
-      # 
+      #
       # @return [String] the YAML generated from this Object
-      # 
+      #
       # @see Psychgus.dump
       def to_yaml(**options)
         # Do not use Psych.dump() if no Stylers, because a class might be a Blueberry

data/lib/psychgus/ext/node_ext.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,21 +15,21 @@ module Psychgus
   module Ext
     ###
     # Extensions to Psych::Nodes::Node.
-    # 
-    # @author Jonathan Bradley Whited (@esotericpig)
+    #
+    # @author Jonathan Bradley Whited
     # @since  1.0.0
     ###
     module NodeExt
       # Check if this Node is of a certain type (Alias, Mapping, Scalar, Sequence, etc.).
-      # 
+      #
       # New versions of Psych have alias?(), mapping?(), etc., so this is for old versions.
-      # 
+      #
       # This is equivalent to the following (with less typing):
       #   node.is_a?(Psych::Nodes::Alias)
       #   node.is_a?(Psych::Nodes::Mapping)
       #   node.is_a?(Psych::Nodes::Scalar)
       #   node.is_a?(Psych::Nodes::Sequence)
-      # 
+      #
       # @example
       #   node.node_of?(:alias)
       #   node.node_of?(:mapping)
@@ -48,17 +37,17 @@ module Psychgus
       #   node.node_of?(:sequence)
       #   node.node_of?(:alias,:mapping,:scalar,:sequence) # OR
       #   node.node_of?(:doc,:map,:seq) # OR
-      # 
+      #
       # @param names [Symbol,String] the type(s) to check using OR
-      # 
+      #
       # @return [true,false] true if this Node is one of the +names+ type, else false
-      # 
+      #
       # @see Psychgus.node_class
       def node_of?(*names)
         names.each do |name|
           return true if is_a?(Psychgus.node_class(name))
         end
-        
+
         return false
       end
     end

data/lib/psychgus/ext/yaml_tree_ext.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,41 +17,41 @@ module Psychgus
   module Ext
     ###
     # Extensions to Psych::Visitors::YAMLTree::Registrar.
-    # 
-    # @author Jonathan Bradley Whited (@esotericpig)
+    #
+    # @author Jonathan Bradley Whited
     # @since  1.0.0
     ###
     module RegistrarExt
       # Remove +target+ from this Registrar to prevent it becoming an alias.
-      # 
+      #
       # @param target [Object] the Object to remove from this Registrar
       def remove_alias(target)
         @obj_to_node.delete(target.object_id)
       end
     end
-    
+
     ###
     # Extensions to Psych::Visitors::YAMLTree.
-    # 
-    # @author Jonathan Bradley Whited (@esotericpig)
+    #
+    # @author Jonathan Bradley Whited
     # @since  1.0.0
     ###
     module YAMLTreeExt
       # Accepts a new Object to convert to YAML.
-      # 
+      #
       # This is roughly the same place where Psych checks if +target+ responds to +:encode_with+.
-      # 
+      #
       # 1. Check if +@emitter+ is a {StyledTreeBuilder}.
       # 2. If #1 and +target+ is a {Blueberry}, get the {Styler}(s) from +target+ and add them to +@emitter+.
       # 3. If #1 and +@emitter.deref_aliases?+, prevent +target+ from becoming an alias.
       # 4. Call +super+ and store the result.
       # 5. If #2, remove the {Styler}(s) from +@emitter+.
       # 6. Return the result of +super+.
-      # 
+      #
       # @param target [Object] the Object to pass to super
-      # 
+      #
       # @return the result of super
-      # 
+      #
       # @see Psych::Visitors::YAMLTree
       # @see Blueberry
       # @see Blueberry#psychgus_stylers
@@ -70,29 +59,29 @@ module Psychgus
       # @see StyledTreeBuilder
       def accept(target)
         styler_count = 0
-        
+
         if @emitter.is_a?(StyledTreeBuilder)
           # Blueberry?
           if target.respond_to?(:psychgus_stylers)
             stylers = target.psychgus_stylers(@emitter.sniffer)
             stylers_old_len = @emitter.stylers.length
-            
+
             @emitter.add_styler(*stylers)
-            
+
             styler_count = @emitter.stylers.length - stylers_old_len
           end
-          
+
           # Dereference aliases?
-          if @emitter.deref_aliases?()
+          if @emitter.deref_aliases?
             @st.remove_alias(target) if target.respond_to?(:object_id) && @st.key?(target)
           end
         end
-        
+
         result = super(target)
-        
+
         # Check styler_count because @emitter may not be a StyledTreeBuilder and target may not be a Blueberry
         @emitter.pop_styler(styler_count) if styler_count > 0
-        
+
         return result
       end
     end