psychgus 1.3.6 → 1.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01544ac84a4c500d36c933328b920f43bbe878609d10f60c615d6ccccf7ca9da
-  data.tar.gz: 2856f8d12ebe3881513acfbb4ec8da5af40fd98a35a36b9ec227260643c2193e
+  metadata.gz: ffadac29265886dcd2b06d12d45405cb7a204ca891dff23c2d67a5f8cdf2f454
+  data.tar.gz: e3648eebf1425c030b6dadfa580a4a41d1ef562b16e652204eb1ec4577e74f5c
 SHA512:
-  metadata.gz: d0e41a6e5b84bd23527583e6cbd46db820e8c53e67d241a85e08182770114ee1ee0e57d2b706ca87acd42367fe27001d1de61a67ae9e700211823948ff780c4f
-  data.tar.gz: 558601409148d719e718a4132f703ad46b06bbb7f19f0ce1d46befd3021051c714a4a6bc0613766ae7d05294f312764b4e1f6b82ba65c13da92a5990210ef136
+  metadata.gz: e6b41b74666b0de6f2cde69261f7958b113b4e030d35fe01cae9c11e3dc1a9a5738c777328bdc48497e831d8d8d0008c0e15562ed772487b09fd5cc0a3635283
+  data.tar.gz: eaa81c7b6b374aa09c9a959af0d788bdaa86567783eb78fc64e1a49b9d9d5a947a14feaf08912351b6030c5b16efc8de1e91627a000d8936be4165e5db887858

data/.yardopts

@@ -1,4 +1,3 @@
 --files 'LICENSE.txt,CHANGELOG.md'
 --protected
 --readme 'README.md'
---title 'Psychgus'

data/CHANGELOG.md

@@ -3,8 +3,10 @@
 - [Keep a Changelog v1.0.0](https://keepachangelog.com/en/1.0.0)
 - [Semantic Versioning v2.0.0](https://semver.org/spec/v2.0.0.html)
 
-## [Unreleased]
-- https://github.com/esotericpig/psychgus/compare/v1.3.6...HEAD
+
+## [v1.3.7] - 2025-05-01
+### Fixed
+- Fixed up code examples in README and doc.
 
 
 ## [v1.3.6] - 2025-05-01
@@ -15,7 +17,6 @@
 - Renamed `master` branch to `main`.
 - Applied RuboCop suggestions.
 - Refactored tests.
-- Removed `yard_ghurt` gem.
 
 
 ## [v1.3.5] - 2024-09-06

data/Gemfile

@@ -12,6 +12,7 @@ group(:development,:test) do
   gem 'rdoc'      ,'~> 6.13'  # RDoc (*.rb).
   gem 'redcarpet' ,'~> 3.6'   # Markdown (*.md).
   gem 'yard'      ,'~> 0.9'   # Doc.
+  gem 'yard_ghurt','~> 1.2'   # Rake tasks for fixing YARD.
 end
 
 group(:test) do

data/README.md

@@ -17,10 +17,7 @@ Turn this YAML...
 ---
 Psych Gus:
   Aliases:
-  - Longbranch Pennywhistle
   - Squirts Macintosh
-  - Clementine Woolysocks
-  - Lavender Gooms
   - Big Baby Burton
   - Chocolate Einstein
   - MC Clap Yo Handz
@@ -35,8 +32,7 @@ Into this:
 ```YAML
 ---
 Psych Gus:
-  Aliases: [Longbranch Pennywhistle, Squirts Macintosh, Clementine Woolysocks, Lavender
-      Gooms, Big Baby Burton, Chocolate Einstein, MC Clap Yo Handz]
+  Aliases: [Squirts Macintosh, Big Baby Burton, Chocolate Einstein, MC Clap Yo Handz]
   Skills: [The Blueberry, The Super Sniffer, Positive Work Attitude]
 ```
 
@@ -48,15 +44,12 @@ The Psychgus name comes from the well-styled character Gus from the TV show Psyc
 
 - [Setup](#setup)
 - [Using](#using)
+    - [Common Stylers](#common-stylers)
     - [Simple Example](#simple-example)
     - [Hash Example](#hash-example)
     - [Class Example](#class-example)
     - [Advanced Usage](#advanced-usage)
-    - [Common Stylers](#common-stylers)
-        - [Stylers Example](#stylers-example)
 - [Hacking](#hacking)
-    - [Testing](#testing)
-    - [Generating Doc](#generating-doc)
 - [License](#license)
 
 ## Setup
@@ -67,27 +60,24 @@ With the RubyGems CLI package manager:
 
 `$ gem install psychgus`
 
-In your *Gemspec* (*<project>.gemspec*):
+In your *.gemspec* file:
 
 ```Ruby
-# Pick one...
 spec.add_dependency 'psychgus', '~> X.X.X'
-spec.add_development_dependency 'psychgus', '~> X.X.X'
 ```
 
 In your *Gemfile*:
 
 ```Ruby
 # Pick one...
-gem 'psychgus', '~> X.X.X'
-gem 'psychgus', '~> X.X.X', :group => :development
-gem 'psychgus', :git => 'https://github.com/esotericpig/psychgus.git', :tag => 'vX.X.X'
+gem 'psychgus', '~> X.X.X', group: :development
+gem 'psychgus', git: 'https://github.com/esotericpig/psychgus.git', tag: 'vX.X.X'
 ```
 
 Manually:
 
 ```
-$ git clone 'https://github.com/esotericpig/psychgus.git'
+$ git clone --depth 1 'https://github.com/esotericpig/psychgus.git'
 $ cd psychgus
 $ bundle install
 $ bundle exec rake install:local
@@ -103,13 +93,70 @@ For classes, you can optionally include `Psychgus::Blueberry` and return the sty
 
 Instead of making your own styler, you can also use one of the [pre-defined stylers](#common-stylers).
 
-### Contents | Using
-
-[Simple Example](#simple-example)
+[Common Stylers](#common-stylers)
+| [Simple Example](#simple-example)
 | [Hash Example](#hash-example)
 | [Class Example](#class-example)
 | [Advanced Usage](#advanced-usage)
-| [Common Stylers](#common-stylers)
+
+### Common Stylers
+
+A collection of commonly-used [Stylers](https://esotericpig.github.io/docs/psychgus/yardoc/Psychgus/Stylers.html) and [Stylables](https://esotericpig.github.io/docs/psychgus/yardoc/Psychgus/Stylables.html) are included with Psychgus. They're the easiest & quickest way to get started.
+
+| Styler | Description |
+| --- | --- |
+| [CapStyler](https://esotericpig.github.io/docs/psychgus/yardoc/Psychgus/Stylers/CapStyler.html) | Capitalizer for Scalars |
+| [FlowStyler](https://esotericpig.github.io/docs/psychgus/yardoc/Psychgus/Stylers/FlowStyler.html) | FLOW style changer for Mappings & Sequences |
+| [MapFlowStyler](https://esotericpig.github.io/docs/psychgus/yardoc/Psychgus/Stylers/MapFlowStyler.html) | FLOW style changer for Mappings only |
+| [NoSymStyler](https://esotericpig.github.io/docs/psychgus/yardoc/Psychgus/Stylers/NoSymStyler.html) | Symbol remover for Scalars |
+| [NoTagStyler](https://esotericpig.github.io/docs/psychgus/yardoc/Psychgus/Stylers/NoTagStyler.html) | Tag remover for classes |
+| [SeqFlowStyler](https://esotericpig.github.io/docs/psychgus/yardoc/Psychgus/Stylers/SeqFlowStyler.html) | FLOW style changer for Sequences only |
+
+Example usage:
+
+```Ruby
+require 'psychgus'
+
+class EggCarton
+  def initialize
+    @eggs = {
+      styles: ['fried', 'scrambled', ['BBQ', 'ketchup & mustard']],
+      colors: ['brown', 'white', ['blue', 'green']],
+    }
+  end
+end
+
+puts EggCarton.new.to_yaml(
+  stylers: [
+    Psychgus::NoSymStyler.new,
+    Psychgus::NoTagStyler.new,
+    Psychgus::CapStyler.new,
+    Psychgus::FlowStyler.new(4),
+  ]
+)
+
+# Output:
+# ---
+# Eggs:
+#   Styles: [Fried, Scrambled, [BBQ, Ketchup & Mustard]]
+#   Colors: [Brown, White, [Blue, Green]]
+
+puts EggCarton.new.to_yaml
+
+# Output (without Stylers):
+# --- !ruby/object:EggCarton
+# eggs:
+#   :styles:
+#   - fried
+#   - scrambled
+#   - - BBQ
+#     - ketchup & mustard
+#   :colors:
+#   - brown
+#   - white
+#   - - blue
+#     - green
+```
 
 ### Simple Example
 
@@ -125,8 +172,8 @@ class CoffeeStyler
 end
 
 coffee = {
-  'Roast'=>['Light', 'Medium', 'Dark', 'Extra Dark'],
-  'Style'=>['Cappuccino', 'Espresso', 'Latte', 'Mocha']
+  'Roast' => ['Light', 'Medium', 'Dark', 'Extra Dark'],
+  'Style' => ['Cappuccino', 'Espresso', 'Latte', 'Mocha'],
 }
 
 puts coffee.to_yaml(stylers: CoffeeStyler.new)
@@ -165,59 +212,54 @@ require 'psychgus'
 class BurgerStyler
   include Psychgus::Styler # Mix in methods needed for styling
 
-  # Style maps (Psych::Nodes::Mapping)
-  # - Hashes (key/value pairs)
-  # - Example: "Burgers: Classic {}"
+  # Style hash maps (Psych::Nodes::Mapping).
   def style_mapping(sniffer,node)
     node.style = Psychgus::MAPPING_FLOW if sniffer.level >= 4
   end
 
-  # Style scalars (Psych::Nodes::Scalar)
-  # - Any text (non-alias)
+  # Style non-alias text (Psych::Nodes::Scalar).
   def style_scalar(sniffer,node)
-    # Remove colon (change symbols into strings)
+    # Remove colon (change symbols into strings).
     node.value = node.value.sub(':','')
 
     # Capitalize each word
     node.value = node.value.split(' ').map do |v|
       if v.casecmp('BBQ') == 0
-        v.upcase()
+        v.upcase
       else
-        v.capitalize()
+        v.capitalize
       end
     end.join(' ')
 
-    # Change lettuce to spinach
+    # Change lettuce to spinach.
     node.value = 'Spinach' if node.value == 'Lettuce'
   end
 
-  # Style sequences (Psych::Nodes::Sequence)
-  # - Arrays
-  # - Example: "[Lettuce, Onions, Pickles, Tomatoes]"
+  # Style arrays (Psych::Nodes::Sequence).
   def style_sequence(sniffer,node)
     node.style = Psychgus::SEQUENCE_FLOW if sniffer.level >= 4
   end
 end
 
 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]],
   ]
 }
-burgers[:favorite] = burgers[:burgers][:bbq] # Alias
+burgers[:favorite] = burgers[:burgers][:bbq] # Alias.
 
 puts burgers.to_yaml(indent: 3,stylers: BurgerStyler.new)
 
@@ -234,7 +276,7 @@ puts burgers.to_yaml(indent: 3,stylers: BurgerStyler.new)
 # Favorite: *1
 
 # Or pass in a Hash. Can also dereference aliases.
-puts burgers.to_yaml({:indent => 3,:stylers => BurgerStyler.new,:deref_aliases => true})
+puts burgers.to_yaml({indent: 3,stylers: BurgerStyler.new,deref_aliases: true})
 
 # Output:
 # ---
@@ -258,58 +300,53 @@ puts burgers.to_yaml({:indent => 3,:stylers => BurgerStyler.new,:deref_aliases =
 require 'psychgus'
 
 class BurgerStyler
-  include Psychgus::Styler # Mix in methods needed for styling
+  include Psychgus::Styler # Mix in methods needed for styling.
 
   def initialize(sniffer)
     @class_level    = sniffer.level
     @class_position = sniffer.position
   end
 
-  # Style all nodes (Psych::Nodes::Node)
+  # Style all nodes (Psych::Nodes::Node).
   def style(sniffer,node)
-    # Remove "!ruby/object:..." for Burger classes (not Burgers class)
+    # Remove `!ruby/object:...` for Burger classes (not Burgers class).
     node.tag = nil if node.node_of?(:mapping,:scalar,:sequence)
 
-    # This is another way to do the above
+    # This is another way to do the above.
     #node.tag = nil if node.respond_to?(:tag=)
   end
 
-  # Style maps (Psych::Nodes::Mapping)
-  # - Hashes (key/value pairs)
-  # - Example: "Burgers: Classic {}"
+  # Style hash maps (Psych::Nodes::Mapping).
   def style_mapping(sniffer,node)
     parent = sniffer.parent
 
-    if !parent.nil?()
+    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)
+  # Style non-alias text (Psych::Nodes::Scalar).
   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?()
+    # 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?
   end
 
-  # Style sequences (Psych::Nodes::Sequence)
-  # - Arrays
-  # - Example: "[Lettuce, Onions, Pickles, Tomatoes]"
+  # Style arrays (Psych::Nodes::Sequence).
   def style_sequence(sniffer,node)
     relative_level = (sniffer.level - @class_level) + 1
 
-    # "[Ketchup, Mustard]"
+    # `[Ketchup, Mustard]`
     node.style = Psychgus::SEQUENCE_FLOW if relative_level == 3
   end
 end
 
 class Burger
-  include Psychgus::Blueberry # Mix in methods needed to be stylable
+  include Psychgus::Blueberry # Mix in methods needed to be stylable.
 
   attr_accessor :bun
   attr_accessor :cheese
@@ -321,13 +358,13 @@ class Burger
     @sauce  = sauce
   end
 
-  # Return our styler(s)
+  # Return our styler(s).
   # - Can be an Array: [MyStyler1.new, MyStyler2.new]
   def psychgus_stylers(sniffer)
     return BurgerStyler.new(sniffer)
   end
 
-  # You can still use Psych's encode_with(), no problem
+  # You can still use Psych's encode_with(), no problem.
   def encode_with(coder)
     coder['Bun']    = @bun
     coder['Cheese'] = @cheese
@@ -340,23 +377,23 @@ class Burgers
   attr_accessor :toppings
   attr_accessor :favorite
 
-  def initialize()
+  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')
+      'Fancy'   => Burger.new('Spicy Wasabi'       ,'Smoked Gouda','Hawaiian'),
     }
 
     @toppings = [
       'Mushrooms',
-      %w(Lettuce Onions Pickles Tomatoes),
-      [%w(Ketchup Mustard),%w(Salt Pepper)]
+      %w[Lettuce Onions Pickles Tomatoes],
+      [%w[Ketchup Mustard],%w[Salt Pepper]],
     ]
 
     @favorite = @burgers['BBQ'] # Alias
   end
 
-  # You can still use Psych's encode_with(), no problem
+  # You can still use Psych's encode_with(), no problem.
   def encode_with(coder)
     coder['Burgers']  = @burgers
     coder['Toppings'] = @toppings
@@ -393,7 +430,7 @@ puts burgers.to_yaml(indent: 3)
 # Favorite: *1
 
 # Or pass in a Hash. Can also dereference aliases.
-puts burgers.to_yaml({:indent => 3,:deref_aliases => true})
+puts burgers.to_yaml({indent: 3,deref_aliases: true})
 
 # Output:
 # --- !ruby/object:Burgers
@@ -438,65 +475,80 @@ end
 
 coffee = {
   'Coffee' => {
-    'Roast'=>['Light', 'Medium', 'Dark', 'Extra Dark'],
-    'Style'=>['Cappuccino', 'Espresso', 'Latte', 'Mocha']
+    'Roast' => ['Light', 'Medium', 'Dark', 'Extra Dark'],
+    'Style' => ['Cappuccino', 'Espresso', 'Latte', 'Mocha'],
   }
 }
 eggs = {
   'Eggs' => {
-    'Color'=>['Brown', 'White', 'Blue', 'Olive'],
-    'Style'=>['Fried', 'Scrambled', 'Omelette', 'Poached']
+    'Color' => ['Brown', 'White', 'Blue', 'Olive'],
+    'Style' => ['Fried', 'Scrambled', 'Omelette', 'Poached'],
   }
 }
 
 filename = 'coffee-and-eggs.yaml'
 styler = MyStyler.new
-options = {:indentation=>3, :stylers=>styler, :deref_aliases=>true}
+options = {indentation: 3, stylers: styler, deref_aliases: true}
 
-coffee_yaml = coffee.to_yaml(options)
-coffee_and_eggs_yaml = Psychgus.dump_stream(coffee,eggs,options)
+coffee_yaml = coffee.to_yaml(**options)
+coffee_and_eggs_yaml = Psychgus.dump_stream(coffee,eggs,**options)
 
+# High-level emitting.
+puts '+=====================+'
+puts '| High-level emitting |'
+puts '+=====================+'
 
-# High-level emitting
-puts Psychgus.dump(coffee,options)
+puts Psychgus.dump(coffee,**options)
 puts
 
-Psychgus.dump_file(filename,coffee,eggs,options)
+Psychgus.dump_file(filename,coffee,eggs,**options)
 puts File.readlines(filename)
 puts
 
-puts Psychgus.dump_stream(coffee,eggs,options)
+puts Psychgus.dump_stream(coffee,eggs,**options)
 puts
 
-puts coffee.to_yaml(options)
+puts coffee.to_yaml(**options)
 puts
 
 # 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(coffee_and_eggs_yaml,options)
+# Mid-level emitting.
+puts '+====================+'
+puts '| Mid-level emitting |'
+puts '+====================+'
 
-puts stream.to_yaml()
+stream = Psychgus.parse_stream(coffee_and_eggs_yaml,**options)
+
+puts stream.to_yaml
 puts
 
-# Mid-level parsing
-puts Psychgus.parse(coffee_yaml,options).to_ruby
+# Mid-level parsing.
+puts '+===================+'
+puts '| Mid-level parsing |'
+puts '+===================+'
+
+puts Psychgus.parse(coffee_yaml,**options).to_ruby
 puts
 
-puts Psychgus.parse_file(filename,options).to_ruby
+puts Psychgus.parse_file(filename,**options).to_ruby
 puts
 
 i = 0
-Psychgus.parse_stream(coffee_and_eggs_yaml,options) do |doc|
+Psychgus.parse_stream(coffee_and_eggs_yaml,**options) do |doc|
   puts "Doc ##{i += 1}:"
   puts "  #{doc.to_ruby}"
 end
 puts
 
-# Low-level emitting
-tree_builder = Psychgus::StyledTreeBuilder.new(styler,options)
+# Low-level emitting.
+puts '+====================+'
+puts '| Low-level emitting |'
+puts '+====================+'
+
+tree_builder = Psychgus::StyledTreeBuilder.new(styler,**options)
 visitor = Psych::Visitors::YAMLTree.create(options,tree_builder)
 
 visitor << coffee
@@ -505,8 +557,12 @@ visitor << eggs
 puts visitor.tree.to_yaml
 puts
 
-# Low-level parsing
-parser = Psychgus.parser(options)
+# Low-level parsing.
+puts '+===================+'
+puts '| Low-level parsing |'
+puts '+===================+'
+
+parser = Psychgus.parser(**options)
 
 parser.parse(coffee_yaml)
 
@@ -514,63 +570,6 @@ puts parser.handler.root.to_ruby
 puts
 ```
 
-### Common Stylers
-
-A collection of commonly-used [Stylers](https://esotericpig.github.io/docs/psychgus/yardoc/Psychgus/Stylers.html) and [Stylables](https://esotericpig.github.io/docs/psychgus/yardoc/Psychgus/Stylables.html) are included with Psychgus.
-
-| Styler | Description |
-| --- | --- |
-| [CapStyler](https://esotericpig.github.io/docs/psychgus/yardoc/Psychgus/Stylers/CapStyler.html) | Capitalizer for Scalars |
-| [FlowStyler](https://esotericpig.github.io/docs/psychgus/yardoc/Psychgus/Stylers/FlowStyler.html) | FLOW style changer for Mappings & Sequences |
-| [MapFlowStyler](https://esotericpig.github.io/docs/psychgus/yardoc/Psychgus/Stylers/MapFlowStyler.html) | FLOW style changer for Mappings only |
-| [NoSymStyler](https://esotericpig.github.io/docs/psychgus/yardoc/Psychgus/Stylers/NoSymStyler.html) | Symbol remover for Scalars |
-| [NoTagStyler](https://esotericpig.github.io/docs/psychgus/yardoc/Psychgus/Stylers/NoTagStyler.html) | Tag remover for classes |
-| [SeqFlowStyler](https://esotericpig.github.io/docs/psychgus/yardoc/Psychgus/Stylers/SeqFlowStyler.html) | FLOW style changer for Sequences only |
-
-#### Stylers Example
-
-```Ruby
-require 'psychgus'
-
-class EggCarton
-  def initialize
-    @eggs = {
-      :styles => ['fried', 'scrambled', ['BBQ', 'ketchup & mustard']],
-      :colors => ['brown', 'white', ['blue', 'green']]
-    }
-  end
-end
-
-puts EggCarton.new.to_yaml(stylers: [
-  Psychgus::NoSymStyler.new,
-  Psychgus::NoTagStyler.new,
-  Psychgus::CapStyler.new,
-  Psychgus::FlowStyler.new(4)
-])
-
-# Output:
-# ---
-# Eggs:
-#   Styles: [Fried, Scrambled, [BBQ, Ketchup & Mustard]]
-#   Colors: [Brown, White, [Blue, Green]]
-
-puts EggCarton.new.to_yaml
-
-# Output (without Stylers):
-# --- !ruby/object:EggCarton
-# eggs:
-#   :styles:
-#   - fried
-#   - scrambled
-#   - - BBQ
-#     - ketchup & mustard
-#   :colors:
-#   - brown
-#   - white
-#   - - blue
-#     - green
-```
-
 ## Hacking
 
 ```
@@ -580,20 +579,12 @@ $ bundle install
 $ bundle exec rake -T
 ```
 
-### Testing
-
 Run tests:
 
 `$ bundle exec rake test`
 
-### Generating Doc
-
 Generate doc:
 
-`$ bundle exec rake doc`
-
-Clean &amp; generate pristine doc:
-
 `$ bundle exec rake clobber doc`
 
 ## License

data/Rakefile

@@ -4,6 +4,7 @@
 require 'bundler/gem_tasks'
 
 require 'yard'
+require 'yard_ghurt'
 
 require 'psychgus/version'
 require 'rake/clean'
@@ -12,22 +13,38 @@ require 'rake/testtask'
 task default: %i[test]
 
 CLEAN.exclude('.git/','stock/')
-CLOBBER.include('doc/')
+CLOBBER.include('.yardoc/','doc/')
 
 # Execute "rake clobber doc" for pristine docs.
 desc 'Generate documentation (YARDoc)'
-task doc: %i[yard]
+task doc: %i[yard yard_gfm_fix]
 
 # To test using different Gem versions:
 #   GST=1 bundle update && bundle exec rake test
 Rake::TestTask.new do |task|
   task.libs = ['lib','test']
-  task.pattern = File.join('test','**','*_test.rb')
+  task.pattern = 'test/**/*_test.rb'
   # task.options = '--verbose' # Execute "rake test TESTOPT=-v" instead.
   task.verbose = true
   task.warning = true
 end
 
 YARD::Rake::YardocTask.new do |task|
-  task.files = [File.join('lib','**','*.rb')]
+  task.files = ['lib/**/*.rb']
+  task.options += ['--title',"Psychgus v#{Psychgus::VERSION}"]
+end
+
+YardGhurt::GFMFixTask.new do |task|
+  task.arg_names = [:dev]
+  task.dry_run = false
+  task.fix_code_langs = true
+  task.md_files = ['index.html']
+
+  task.before = proc do |t2,_args|
+    # Delete this file as it's never used (index.html is an exact copy).
+    YardGhurt.rm_exist(File.join(t2.doc_dir,'file.README.html'))
+
+    t2.css_styles << '<link rel="stylesheet" type="text/css" href="/css/prism.css" />'
+    t2.js_scripts << '<script src="/js/prism.js"></script>'
+  end
 end

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)

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)
       #

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.6'
+  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).
@@ -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.
@@ -474,8 +212,8 @@ module Psychgus
 
     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
@@ -496,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]],
   #     ]
   #   }
   #
@@ -637,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
@@ -707,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)
@@ -752,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

data/psychgus.gemspec

@@ -27,9 +27,9 @@ Gem::Specification.new do |spec|
   spec.bindir                = 'bin'
 
   spec.files = [
-    Dir.glob(File.join("{#{spec.require_paths.join(',')}}",'**','*.{erb,rb}')),
-    Dir.glob(File.join(spec.bindir,'*')),
-    Dir.glob(File.join('{samples,test,yard}','**','*.{erb,rb}')),
+    Dir.glob("{#{spec.require_paths.join(',')}}/**/*.{erb,rb}"),
+    Dir.glob("#{spec.bindir}/*"),
+    Dir.glob('{samples,test,yard}/**/*.{erb,rb}'),
     %W[Gemfile #{spec.name}.gemspec Rakefile .yardopts],
     %w[LICENSE.txt CHANGELOG.md README.md],
   ].flatten

data/test/psychgus_test.rb

@@ -73,11 +73,11 @@ Toppings:
 
       data = Psych.load_file(file)
       refute_equal false,data
-      refute_equal nil,data
+      refute_nil data
 
       data = Psychgus.parse_file(file)
       refute_equal false,data
-      refute_equal nil,data
+      refute_nil data
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: psychgus
 version: !ruby/object:Gem::Version
-  version: 1.3.6
+  version: 1.3.7
 platform: ruby
 authors:
 - Bradley Whited
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-05-01 00:00:00.000000000 Z
+date: 2025-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych