psychgus 1.3.5 → 1.3.7

data/lib/psychgus/blueberry.rb

@@ -24,7 +24,7 @@ module Psychgus
   #     attr_reader :my_hash
   #
   #     def initialize()
-  #       @my_hash = {:key1=>'val1',:key2=>'val2'}
+  #       @my_hash = {key1: 'val1',key2: 'val2'}
   #     end
   #
   #     def psychgus_stylers(sniffer)
@@ -88,7 +88,7 @@ module Psychgus
     #                               class/module/etc.
     #
     # @return [Styler,Array<Styler>,nil] {Styler}(s) for this class/module/etc.
-    def psychgus_stylers(sniffer)
+    def psychgus_stylers(_sniffer)
       return nil
     end
   end

data/lib/psychgus/ext/core_ext.rb

@@ -30,10 +30,11 @@ module Psychgus
       #   end
       #
       #   my_obj = {
-      #     :Foods => {
-      #       :Fruits  => %w(Apple Banana Blueberry Pear),
-      #       :Veggies => %w(Bean Carrot Celery Pea)
-      #   }}
+      #     Foods: {
+      #       Fruits:  %w[Apple Banana Blueberry Pear],
+      #       Veggies: %w[Bean Carrot Celery Pea],
+      #     }
+      #   }
       #
       #   puts my_obj.to_yaml(indentation: 5,stylers: MyStyler.new)
       #
@@ -51,7 +52,7 @@ module Psychgus
       # @return [String] the YAML generated from this Object
       #
       # @see Psychgus.dump
-      def to_yaml(options={})
+      def to_yaml(options = {})
         # NOTE: This method signature must use old-style `options={}` instead of `**options`!
         #       Because some Gems, like `Moneta`, depend on this.
 

data/lib/psychgus/ext/yaml_tree_ext.rb

@@ -33,7 +33,6 @@ module Psychgus
         else # 5.1.2+
           return unless key?(target)
 
-          @targets.delete(target)
           @obj_to_node.delete(target)
         end
       end
@@ -81,7 +80,7 @@ module Psychgus
           @st.psychgus_unregister(target) if @emitter.deref_aliases?
         end
 
-        result = super(target)
+        result = super(target) # rubocop:disable Style/SuperArguments
 
         # 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

data/lib/psychgus/stylables.rb

@@ -38,7 +38,7 @@ module Psychgus
       # @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
-      def initialize(min_level=0,new_style: nil,**kargs)
+      def initialize(min_level = 0,new_style: nil,**_kargs)
         @min_level = min_level
         @new_style = new_style
       end
@@ -67,7 +67,7 @@ module Psychgus
       # @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)
+      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})")
@@ -95,7 +95,7 @@ module Psychgus
       #
       # @see cap_word
       # @see Styler#style_scalar
-      def style_scalar(sniffer,node)
+      def style_scalar(_sniffer,node)
         if !@each_word || node.value.nil? || node.value.empty?
           node.value = cap_word(node.value)
           return
@@ -128,7 +128,7 @@ module Psychgus
       # @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
@@ -199,14 +199,14 @@ module Psychgus
 
       # @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)
+      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)
+      def style_scalar(_sniffer,node)
         return if node.value.nil? || node.value.empty?
         return if node.value[0] != ':'
 
@@ -224,7 +224,7 @@ module Psychgus
       # If +node.tag+ is settable, set it to nil.
       #
       # @see Styler#style
-      def style(sniffer,node)
+      def style(_sniffer,node)
         node.tag = nil if node.respond_to?(:tag=)
       end
     end

data/lib/psychgus/styled_document_stream.rb

@@ -35,7 +35,7 @@ module Psychgus
     # 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

data/lib/psychgus/styled_tree_builder.rb

@@ -37,7 +37,7 @@ module Psychgus
     # @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)
+    def initialize(*stylers,deref_aliases: false,**_options)
       super()
 
       @deref_aliases = deref_aliases
@@ -143,7 +143,7 @@ module Psychgus
     # @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)
+    def pop_styler(count = 1)
       return nil if count == 0
       return @stylers.pop if count == 1
 

data/lib/psychgus/stylers.rb

@@ -20,21 +20,23 @@ module Psychgus
   #   class EggCarton
   #     def initialize
   #       @eggs = {
-  #         :styles => ['fried', 'scrambled', ['BBQ', 'ketchup & mustard']],
-  #         :colors => ['brown', 'white', ['blue', 'green']]
+  #         styles: ['fried', 'scrambled', ['BBQ', 'ketchup & mustard']],
+  #         colors: ['brown', 'white', ['blue', 'green']],
   #       }
   #     end
   #   end
   #
   #   hierarchy = Psychgus::HierarchyStyler.new(io: $stdout)
   #
-  #   puts EggCarton.new.to_yaml(stylers: [
-  #     Psychgus::NoSymStyler.new,
-  #     Psychgus::NoTagStyler.new,
-  #     Psychgus::CapStyler.new,
-  #     Psychgus::FlowStyler.new(4),
-  #     hierarchy
-  #   ])
+  #   puts EggCarton.new.to_yaml(
+  #     stylers: [
+  #       Psychgus::NoSymStyler.new,
+  #       Psychgus::NoTagStyler.new,
+  #       Psychgus::CapStyler.new,
+  #       Psychgus::FlowStyler.new(4),
+  #       hierarchy,
+  #     ]
+  #   )
   #
   #   # Output:
   #   # ---
@@ -78,8 +80,9 @@ module Psychgus
     #       'BBQ eggs',
     #       'hard-boiled eggs',
     #       'soft_boiled eggs',
-    #       'fried@eggs'
-    #   ]}
+    #       'fried@eggs',
+    #     ]
+    #   }
     #
     #   seq_flow = Psychgus::SeqFlowStyler.new
     #
@@ -205,10 +208,11 @@ module Psychgus
     #   require 'psychgus'
     #
     #   data = {
-    #     :eggs => {
-    #       :styles => ['Fried', 'Scrambled', ['BBQ', 'Ketchup']],
-    #       :colors => ['Brown', 'White', ['Blue', 'Green']]
-    #   }}
+    #     eggs: {
+    #       styles: ['Fried', 'Scrambled', ['BBQ', 'Ketchup']],
+    #       colors: ['Brown', 'White', ['Blue', 'Green']],
+    #     }
+    #   }
     #
     #   flow = Psychgus::FlowStyler.new(4)
     #

data/lib/psychgus/version.rb

@@ -10,5 +10,5 @@
 
 module Psychgus
   # Version of this gem in "#.#.#" format.
-  VERSION = '1.3.5'
+  VERSION = '1.3.7'
 end

data/lib/psychgus.rb

@@ -22,7 +22,6 @@ require 'psychgus/version'
 require 'psychgus/ext/core_ext'
 require 'psychgus/ext/node_ext'
 require 'psychgus/ext/yaml_tree_ext'
-
 require 'psychgus/super_sniffer/parent'
 
 ###
@@ -31,267 +30,6 @@ require 'psychgus/super_sniffer/parent'
 # Thank you to the people that worked and continue to work hard on that project.
 #
 # The name comes from the well-styled character Gus from the TV show Psych.
-#
-# == Create a Styler
-#
-# First, we will create a {Styler}.
-#
-# All you need to do is add +include Psychgus::Styler+ to a class.
-#
-# Here is a complex {Styler} for the examples below:
-#   require 'psychgus'
-#
-#   class BurgerStyler
-#     # Mix in methods needed for styling
-#     include Psychgus::Styler
-#
-#     def initialize(sniffer=nil)
-#       if sniffer.nil?()
-#         @class_level = 0
-#         @class_position = 0
-#       else
-#         # For the Class Example
-#         @class_level = sniffer.level
-#         @class_position = sniffer.position
-#       end
-#     end
-#
-#     # Style all nodes (Psych::Nodes::Node)
-#     def style(sniffer,node)
-#       # Remove "!ruby/object:..." for classes
-#       node.tag = nil if node.node_of?(:mapping,:scalar,:sequence)
-#
-#       # This is another way to do the above
-#       #node.tag = nil if node.respond_to?(:tag=)
-#     end
-#
-#     # Style aliases (Psych::Nodes::Alias)
-#     def style_alias(sniffer,node)
-#     end
-#
-#     # Style maps (Psych::Nodes::Mapping)
-#     # - Hashes (key/value pairs)
-#     # - Example: "Burgers: Classic {}"
-#     def style_mapping(sniffer,node)
-#       parent = sniffer.parent
-#
-#       if !parent.nil?()
-#         # BBQ
-#         node.style = Psychgus::MAPPING_FLOW if parent.node_of?(:scalar) &&
-#                                                parent.value.casecmp('BBQ') == 0
-#       end
-#     end
-#
-#     # Style scalars (Psych::Nodes::Scalar)
-#     # - Any text (non-alias)
-#     def style_scalar(sniffer,node)
-#       parent = sniffer.parent
-#
-#       # Single quote scalars that are not keys to a map
-#       # - "child_key?" is the same as "child_type == :key"
-#       node.style = Psychgus::SCALAR_SINGLE_QUOTED unless parent.child_key?()
-#
-#       # Remove colon (change symbols into strings)
-#       node.value = node.value.sub(':','')
-#
-#       # Change lettuce to spinach
-#       node.value = 'Spinach' if node.value.casecmp('Lettuce') == 0
-#
-#       # Capitalize each word
-#       node.value = node.value.split(' ').map do |v|
-#         if v.casecmp('BBQ') == 0
-#           v.upcase()
-#         else
-#           v.capitalize()
-#         end
-#       end.join(' ')
-#     end
-#
-#     # Style sequences (Psych::Nodes::Sequence)
-#     # - Arrays
-#     # - Example: "[Lettuce, Onions, Pickles, Tomatoes]"
-#     def style_sequence(sniffer,node)
-#       relative_level = (sniffer.level - @class_level) + 1
-#
-#       node.style = Psychgus::SEQUENCE_FLOW if sniffer.level >= 4
-#
-#       # Make "[Ketchup, Mustard]" a block for the Class Example
-#       node.style = Psychgus::SEQUENCE_BLOCK if relative_level == 7
-#     end
-#   end
-#
-# @example Hash example
-#   require 'psychgus'
-#
-#   burgers = {
-#     :Burgers => {
-#       :Classic => {
-#         :Sauce  => %w(Ketchup Mustard),
-#         :Cheese => 'American',
-#         :Bun    => 'Sesame Seed'
-#       },
-#       :BBQ => {
-#         :Sauce  => 'Honey BBQ',
-#         :Cheese => 'Cheddar',
-#         :Bun    => 'Kaiser'
-#       },
-#       :Fancy => {
-#         :Sauce  => 'Spicy Wasabi',
-#         :Cheese => 'Smoked Gouda',
-#         :Bun    => 'Hawaiian'
-#       }
-#     },
-#     :Toppings => [
-#       'Mushrooms',
-#       %w(Lettuce Onions Pickles Tomatoes),
-#       [%w(Ketchup Mustard), %w(Salt Pepper)]
-#     ]
-#   }
-#   burgers[:Favorite] = burgers[:Burgers][:BBQ] # Alias
-#
-#   puts burgers.to_yaml(indent: 3,stylers: BurgerStyler.new,deref_aliases: true)
-#
-#   # Output:
-#   # ---
-#   # Burgers:
-#   #    Classic:
-#   #       Sauce: ['Ketchup', 'Mustard']
-#   #       Cheese: 'American'
-#   #       Bun: 'Sesame Seed'
-#   #    BBQ: {Sauce: 'Honey BBQ', Cheese: 'Cheddar', Bun: 'Kaiser'}
-#   #    Fancy:
-#   #       Sauce: 'Spicy Wasabi'
-#   #       Cheese: 'Smoked Gouda'
-#   #       Bun: 'Hawaiian'
-#   # Toppings:
-#   # - 'Mushrooms'
-#   # - ['Spinach', 'Onions', 'Pickles', 'Tomatoes']
-#   # - [['Ketchup', 'Mustard'], ['Salt', 'Pepper']]
-#   # Favorite:
-#   #    Sauce: 'Honey BBQ'
-#   #    Cheese: 'Cheddar'
-#   #    Bun: 'Kaiser'
-#
-# @example Class example
-#   require 'psychgus'
-#
-#   class Burger
-#     attr_accessor :bun
-#     attr_accessor :cheese
-#     attr_accessor :sauce
-#
-#     def initialize(sauce,cheese,bun)
-#       @bun = bun
-#       @cheese = cheese
-#       @sauce = sauce
-#     end
-#
-#     # You can still use Psych's encode_with(), no problem
-#     #def encode_with(coder)
-#     #  coder['Bun'] = @bun
-#     #  coder['Cheese'] = @cheese
-#     #  coder['Sauce'] = @sauce
-#     #end
-#   end
-#
-#   class Burgers
-#     include Psychgus::Blueberry
-#
-#     attr_accessor :burgers
-#     attr_accessor :toppings
-#     attr_accessor :favorite
-#
-#     def initialize()
-#       @burgers = {
-#         'Classic' => Burger.new(['Ketchup','Mustard'],'American','Sesame Seed'),
-#         'BBQ'     => Burger.new('Honey BBQ','Cheddar','Kaiser'),
-#         'Fancy'   => Burger.new('Spicy Wasabi','Smoked Gouda','Hawaiian')
-#       }
-#
-#       @toppings = [
-#         'Mushrooms',
-#         %w(Lettuce Onions Pickles Tomatoes),
-#         [%w(Ketchup Mustard),%w(Salt Pepper)]
-#       ]
-#
-#       @favorite = @burgers['BBQ'] # Alias
-#     end
-#
-#     def psychgus_stylers(sniffer)
-#       return BurgerStyler.new(sniffer)
-#     end
-#
-#     # You can still use Psych's encode_with(), no problem
-#     #def encode_with(coder)
-#     #  coder['Burgers'] = @burgers
-#     #  coder['Toppings'] = @toppings
-#     #  coder['Favorite'] = @favorite
-#     #end
-#   end
-#
-#   burgers = Burgers.new
-#   puts burgers.to_yaml(indent: 3,deref_aliases: true)
-#
-#   # Output:
-#   # ---
-#   # Burgers:
-#   #    Classic:
-#   #       Bun: 'Sesame Seed'
-#   #       Cheese: 'American'
-#   #       Sauce:
-#   #       - 'Ketchup'
-#   #       - 'Mustard'
-#   #    BBQ: {Bun: 'Kaiser', Cheese: 'Cheddar', Sauce: 'Honey BBQ'}
-#   #    Fancy:
-#   #       Bun: 'Hawaiian'
-#   #       Cheese: 'Smoked Gouda'
-#   #       Sauce: 'Spicy Wasabi'
-#   # Toppings:
-#   # - 'Mushrooms'
-#   # - ['Spinach', 'Onions', 'Pickles', 'Tomatoes']
-#   # - [['Ketchup', 'Mustard'], ['Salt', 'Pepper']]
-#   # Favorite:
-#   #    Bun: 'Kaiser'
-#   #    Cheese: 'Cheddar'
-#   #    Sauce: 'Honey BBQ'
-#
-# @example Emitting / Parsing examples
-#   styler = BurgerStyler.new()
-#   options = {:indentation=>3,:stylers=>styler,:deref_aliases=>true}
-#   yaml = burgers.to_yaml(options)
-#
-#   # High-level emitting
-#   Psychgus.dump(burgers,options)
-#   Psychgus.dump_file('burgers.yaml',burgers,options)
-#   burgers.to_yaml(options)
-#
-#   # High-level parsing
-#   # - Because to_ruby() will be called, just use Psych:
-#   #   - load(), load_file(), load_stream(), safe_load()
-#
-#   # Mid-level emitting
-#   stream = Psychgus.parse_stream(yaml,stylers: styler,deref_aliases: true)
-#
-#   stream.to_yaml()
-#
-#   # Mid-level parsing
-#   Psychgus.parse(yaml,stylers: styler,deref_aliases: true)
-#   Psychgus.parse_file('burgers.yaml',stylers: styler,deref_aliases: true)
-#   Psychgus.parse_stream(yaml,stylers: styler,deref_aliases: true)
-#
-#   # Low-level emitting
-#   tree_builder = Psychgus::StyledTreeBuilder.new(styler,deref_aliases: true)
-#   visitor = Psych::Visitors::YAMLTree.create(options,tree_builder)
-#
-#   visitor << burgers
-#   visitor.tree.to_yaml
-#
-#   # Low-level parsing
-#   parser = Psychgus.parser(stylers: styler,deref_aliases: true)
-#
-#   parser.parse(yaml)
-#   parser.handler
-#   parser.handler.root
 ###
 module Psychgus
   # Include these in the top namespace for convenience (i.e., less typing).
@@ -332,7 +70,7 @@ module Psychgus
   # @return [Integer,Object] the constant value from the class (usually an int)
   #
   # @see .node_class
-  def self.node_const(class_name,const_name,lenient=true)
+  def self.node_const(class_name,const_name,lenient: true)
     node_class = node_class(class_name)
     const_name = const_name.to_sym.upcase
 
@@ -378,7 +116,7 @@ module Psychgus
   #
   # @see .dump_stream
   # @see Psych.dump_stream
-  def self.dump(object,io=nil,**options)
+  def self.dump(object,io = nil,**options)
     return dump_stream(object,io: io,**options)
   end
 
@@ -443,7 +181,7 @@ module Psychgus
     # then options will be set to the Hash, instead of objects.
     #
     # For example, the below will be stored in options, not objects:
-    # - dump_stream({:coffee => {:roast => [],:style => []}})
+    # - dump_stream({coffee: {roast: [],style: []}})
     #
     # This if-statement is guaranteed because dump_stream([]) and dump_stream(nil)
     # will produce [[]] and [nil], which are not empty.
@@ -467,13 +205,15 @@ module Psychgus
       end
     end
 
-    visitor = Psych::Visitors::YAMLTree.create(options,StyledTreeBuilder.new(*stylers,
-      deref_aliases: deref_aliases))
+    visitor = Psych::Visitors::YAMLTree.create(
+      options,
+      StyledTreeBuilder.new(*stylers,deref_aliases: deref_aliases)
+    )
 
     if objects.empty?
       # Else, will throw a cryptic NoMethodError:
-      # - "psych/tree_builder.rb:in `set_end_location':
-      #    undefined method `end_line=' for nil:NilClass (NoMethodError)"
+      #   psych/tree_builder.rb:in `set_end_location':
+      #   undefined method `end_line=' for nil:NilClass (NoMethodError)
       #
       # This should never occur because of the if-statement at the top of this method.
       visitor << nil
@@ -494,21 +234,21 @@ module Psychgus
   #   require 'psychgus'
   #
   #   burgers = {
-  #     :burgers => {
-  #       :classic => {:sauce  => %w(Ketchup Mustard),
-  #                    :cheese => 'American',
-  #                    :bun    => 'Sesame Seed'},
-  #       :bbq     => {:sauce  => 'Honey BBQ',
-  #                    :cheese => 'Cheddar',
-  #                    :bun    => 'Kaiser'},
-  #       :fancy   => {:sauce  => 'Spicy Wasabi',
-  #                    :cheese => 'Smoked Gouda',
-  #                    :bun    => 'Hawaiian'}
+  #     burgers: {
+  #       classic: {sauce:  %w[Ketchup Mustard],
+  #                 cheese: 'American',
+  #                 bun:    'Sesame Seed'},
+  #       bbq:     {sauce:  'Honey BBQ',
+  #                 cheese: 'Cheddar',
+  #                 bun:    'Kaiser'},
+  #       fancy:   {sauce:  'Spicy Wasabi',
+  #                 cheese: 'Smoked Gouda',
+  #                 bun:    'Hawaiian'},
   #     },
-  #     :toppings => [
+  #     toppings: [
   #       'Mushrooms',
-  #       %w(Lettuce Onions Pickles Tomatoes),
-  #       [%w(Ketchup Mustard), %w(Salt Pepper)]
+  #       %w[Lettuce Onions Pickles Tomatoes],
+  #       [%w[Ketchup Mustard], %w[Salt Pepper]],
   #     ]
   #   }
   #
@@ -635,17 +375,17 @@ module Psychgus
   # and the styler(s) will do nothing for you.
   #
   # @example
-  #   burgers = <<EOY
-  #   ---
-  #   Burgers:
-  #     Classic:
-  #       BBQ: {Sauce: Honey BBQ, Cheese: Cheddar, Bun: Kaiser}
-  #   ---
-  #   Toppings:
-  #   - [Mushrooms, Mustard]
-  #   - [Salt, Pepper, Pickles]
-  #   ---
-  #   `Invalid`
+  #   burgers = <<~EOY
+  #     ---
+  #     Burgers:
+  #       Classic:
+  #         BBQ: {Sauce: Honey BBQ, Cheese: Cheddar, Bun: Kaiser}
+  #     ---
+  #     Toppings:
+  #     - [Mushrooms, Mustard]
+  #     - [Salt, Pepper, Pickles]
+  #     ---
+  #     `Invalid`
   #   EOY
   #
   #   i = 0
@@ -681,8 +421,9 @@ module Psychgus
   # @see Psych::SyntaxError
   def self.parse_stream(yaml,filename: nil,stylers: nil,deref_aliases: false,**options,&block)
     if block_given?
-      parser = Psych::Parser.new(StyledDocumentStream.new(*stylers,deref_aliases: deref_aliases,**options,
-        &block))
+      parser = Psych::Parser.new(
+        StyledDocumentStream.new(*stylers,deref_aliases: deref_aliases,**options,&block)
+      )
 
       return parser.parse(yaml,filename)
     else
@@ -704,16 +445,16 @@ module Psychgus
   #     end
   #   end
   #
-  #   coffee = <<EOY
-  #   Coffee:
-  #     Roast:
-  #       - Light
-  #       - Medium
-  #       - Dark
-  #     Style:
-  #       - Cappuccino
-  #       - Latte
-  #       - Mocha
+  #   coffee = <<~EOY
+  #     Coffee:
+  #       Roast:
+  #         - Light
+  #         - Medium
+  #         - Dark
+  #       Style:
+  #         - Cappuccino
+  #         - Latte
+  #         - Mocha
   #   EOY
   #
   #   parser = Psychgus.parser(stylers: CoffeeStyler.new)
@@ -749,7 +490,7 @@ module Psychgus
   #
   # Private methods of Psych are not defined.
   #
-  # @note For devs/hacking: because extend is used, do not prefix methods with "self."
+  # @note For devs/hacking: because extend is used, do not prefix methods with `self.`.
   ###
   module PsychDropIn
     # @see Psych.add_builtin_type