psychgus 1.3.3 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e694ed2c4e320e06a0d0e5c5db16c0472e736e09bac0efef2f5fac0461362c1b
-  data.tar.gz: 231599a639053718de167143ede822d24c839ddd8ed152bb298bc12fbcb61bdc
+  metadata.gz: aa00bfe0768a30b9679056fe748769e53827b254d8899bcaacc032fc236e5791
+  data.tar.gz: 46a834b2f517190e9c6b28e6f87964a186c69b7b2bdaf45465d59f2ac1f06603
 SHA512:
-  metadata.gz: 9cea5c31be2934dfb29cd5416c9fbc91aaf4588edf816c2cccef1e5b2290bca7e2f19ae6660979fd5927aa90f97b57a777d3d2268f6154bc6838e344b4a94fff
-  data.tar.gz: 369236b14dd097f5d7fc29b564cc01cda079a3ccf21145e94d4737cb7958e684f6d7c07bc81fc8ca5a3e18612ae7111584bb97074a15c08fac7a4b502cb6feab
+  metadata.gz: 3bcbf539c47cfb64273682b0d1fa76c3745e523e0a792f2a9dec92e1df80352c6c987762edcebd9fc21bccc36450619b42572f5e37fe66e5002ffad2e2e15eb6
+  data.tar.gz: 338ffe5daaafb1ddc79fac1f939058928d839f64f96bd3c8198bbda7f8426da0fea04ab6fead6b114628d64466901499c844bdc14fa55d8795f05d34b89d11ec

data/.yardopts

@@ -0,0 +1,5 @@
+--files 'LICENSE.txt,CHANGELOG.md'
+--protected
+--readme 'README.md'
+--template-path 'yard/templates'
+--title 'Psychgus'

data/CHANGELOG.md

@@ -1,18 +1,42 @@
 # Changelog | Psychgus
 
-Format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+All notable changes to this project will be documented in this file.
 
-## [[Unreleased]](https://github.com/esotericpig/psychgus/compare/v1.3.3...master)
+Format is based on [Keep a Changelog v1.0.0](https://keepachangelog.com/en/1.0.0),
+and this project adheres to [Semantic Versioning v2.0.0](https://semver.org/spec/v2.0.0.html).
 
-## [v1.3.3] - 2020-04-25
+## [[Unreleased]](https://github.com/esotericpig/psychgus/compare/v1.3.5...HEAD)
+
+
+## [v1.3.5] - 2024-09-06
+### Fixed
+- Fixed to_yaml() to work with older-style gems.
+  - Example Gem: moneta
+- Fixed deref aliases to work with Psych v5.1.2.
+
+### Changed
+- Updated min Ruby to v2.2.
+- Updated Gems.
+
+
+## [v1.3.4] - 2021-06-20
+### Fixed
+- Fixed test file to use `unsafe_load()` for Psych v4+.
+
+### Changed
+- Changed `SuperSniffer::Parent` to use `SimpleDelegator`.
+- Updated Gems.
+- Formatted files with RuboCop.
 
+
+## [v1.3.3] - 2020-04-25
 ### Fixed
 - SuperSniffer::Parent
     - Added require of `delegate` for Delegator
     - Rake test task didn't catch this (must already include it)
 
-## [v1.3.2] - 2020-04-23
 
+## [v1.3.2] - 2020-04-23
 ### Changed
 - SuperSniffer::Parent
     - Changed to use Delegator to delegate all methods of `node`
@@ -22,16 +46,16 @@ Format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ### Fixed
 - Fixed some Ruby 2.7 warnings in tests
 
-## [v1.2.2] - 2020-03-15
 
+## [v1.2.2] - 2020-03-15
 ### Fixed
 - Fixed Psych version to be >= 3.0 for `to_yaml/encode_with` warnings
     - This is mainly for Windows
     - [Ruby-lang Bug #13115](https://bugs.ruby-lang.org/issues/13115)
     - [GitHub Psych Commit](https://github.com/ruby/psych/commit/712a65a53f3c15105cd86e8ad3ee3c779050ada4)
 
-## [v1.2.1] - 2019-12-18
 
+## [v1.2.1] - 2019-12-18
 ### Added
 - Use of YardGhurt gem for Rakefile tasks
 
@@ -44,8 +68,8 @@ Format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ### Fixed
 - Updated gems
 
-## [v1.2.0] - 2019-07-11
 
+## [v1.2.0] - 2019-07-11
 ### Added
 - Commonly-used Stylers and Stylables
 - Changelog
@@ -60,6 +84,7 @@ Format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ### Fixed
 - Psychgus.dump_stream() if you only pass in a Hash w/ symbols as keys (options would be set to it, instead of objects)
 
+
 ## [v1.0.0] - 2019-07-03
 ### Added
 ### Changed

data/Gemfile

@@ -1,25 +1,22 @@
 # 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/>.
-#++
+source 'https://rubygems.org'
 
+group(:development) do
+  # Build.
+  gem 'bundler'   ,'~> 2.5'
+  gem 'rake'      ,'~> 13.2'
 
-source 'https://rubygems.org'
+  # Doc.
+  gem 'rdoc'      ,'~> 6.7'   # RDoc for YARD (*.rb).
+  gem 'redcarpet' ,'~> 3.6'   # Markdown for YARD (*.md).
+  gem 'yard'      ,'~> 0.9'   # Doc.
+  gem 'yard_ghurt','~> 1.2'   # YARD GitHub rake tasks.
+end
+
+group(:test) do
+  gem 'minitest'  ,'~> 5.25'
+end
 
 gemspec

data/README.md

@@ -1,7 +1,7 @@
 # Psychgus
 
 [![Gem Version](https://badge.fury.io/rb/psychgus.svg)](https://badge.fury.io/rb/psychgus)
-[![Build Status](https://travis-ci.org/esotericpig/psychgus.svg?branch=master)](https://travis-ci.org/esotericpig/psychgus)
+[![CI Status](https://github.com/esotericpig/psychgus/actions/workflows/ci.yml/badge.svg)](https://github.com/esotericpig/psychgus/actions/workflows/ci.yml)
 [![Doc Coverage](http://inch-ci.org/github/esotericpig/psychgus.svg?branch=master)](https://inch-ci.org/github/esotericpig/psychgus)
 
 [![Documentation](https://img.shields.io/badge/doc-yard-%23A0522D.svg)](https://esotericpig.github.io/docs/psychgus/yardoc/index.html)
@@ -40,7 +40,7 @@ Psych Gus:
   Skills: [The Blueberry, The Super Sniffer, Positive Work Attitude]
 ```
 
-Thank you to the people that worked and continue to work hard on the Psych project.
+Thank you to the people that work hard on the Psych project.
 
 The Psychgus name comes from the well-styled character Gus from the TV show Psych.
 
@@ -59,7 +59,7 @@ The Psychgus name comes from the well-styled character Gus from the TV show Psyc
     - [Generating Doc](#generating-doc)
 - [License](#license)
 
-## [Setup](#contents)
+## [//](#contents) Setup
 
 Pick your poison...
 
@@ -71,7 +71,7 @@ In your *Gemspec* (*<project>.gemspec*):
 
 ```Ruby
 # Pick one...
-spec.add_runtime_dependency 'psychgus', '~> X.X.X'
+spec.add_dependency 'psychgus', '~> X.X.X'
 spec.add_development_dependency 'psychgus', '~> X.X.X'
 ```
 
@@ -93,7 +93,7 @@ $ bundle install
 $ bundle exec rake install:local
 ```
 
-## [Using](#contents)
+## [//](#contents) Using
 
 Documentation (YARDoc) is available on my [GitHub Page](https://esotericpig.github.io/docs/psychgus/yardoc/index.html) and on [RubyDoc.info](https://www.rubydoc.info/gems/psychgus).
 
@@ -111,14 +111,14 @@ Instead of making your own styler, you can also use one of the [pre-defined styl
 | [Advanced Usage](#advanced-usage)
 | [Common Stylers](#common-stylers)
 
-### [Simple Example](#using)
+### [//](#using) Simple Example
 
 ```Ruby
 require 'psychgus'
 
 class CoffeeStyler
   include Psychgus::Styler
-  
+
   def style_sequence(sniffer,node)
     node.style = Psychgus::SEQUENCE_FLOW
   end
@@ -138,12 +138,12 @@ puts coffee.to_yaml(stylers: CoffeeStyler.new)
 
 class Coffee
   include Psychgus::Blueberry
-  
+
   def initialize
     @roast = ['Light', 'Medium', 'Dark', 'Extra Dark']
     @style = ['Cappuccino', 'Espresso', 'Latte', 'Mocha']
   end
-  
+
   def psychgus_stylers(sniffer)
     CoffeeStyler.new
   end
@@ -157,27 +157,27 @@ puts Coffee.new.to_yaml
 # style: [Cappuccino, Espresso, Latte, Mocha]
 ```
 
-### [Hash Example](#using)
+### [//](#using) Hash Example
 
 ```Ruby
 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 {}"
   def style_mapping(sniffer,node)
     node.style = Psychgus::MAPPING_FLOW if sniffer.level >= 4
   end
-  
+
   # Style scalars (Psych::Nodes::Scalar)
   # - Any text (non-alias)
   def style_scalar(sniffer,node)
     # 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
@@ -186,11 +186,11 @@ class BurgerStyler
         v.capitalize()
       end
     end.join(' ')
-    
+
     # Change lettuce to spinach
     node.value = 'Spinach' if node.value == 'Lettuce'
   end
-  
+
   # Style sequences (Psych::Nodes::Sequence)
   # - Arrays
   # - Example: "[Lettuce, Onions, Pickles, Tomatoes]"
@@ -252,57 +252,57 @@ puts burgers.to_yaml({:indent => 3,:stylers => BurgerStyler.new,:deref_aliases =
 #    Bun: Kaiser
 ```
 
-### [Class Example](#using)
+### [//](#using) Class Example
 
 ```Ruby
 require 'psychgus'
 
 class BurgerStyler
   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)
   def style(sniffer,node)
     # 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
     #node.tag = nil if node.respond_to?(:tag=)
   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?()
   end
-  
+
   # Style sequences (Psych::Nodes::Sequence)
   # - Arrays
   # - Example: "[Lettuce, Onions, Pickles, Tomatoes]"
   def style_sequence(sniffer,node)
     relative_level = (sniffer.level - @class_level) + 1
-    
+
     # "[Ketchup, Mustard]"
     node.style = Psychgus::SEQUENCE_FLOW if relative_level == 3
   end
@@ -310,23 +310,23 @@ end
 
 class Burger
   include Psychgus::Blueberry # Mix in methods needed to be stylable
-  
+
   attr_accessor :bun
   attr_accessor :cheese
   attr_accessor :sauce
-  
+
   def initialize(sauce,cheese,bun)
     @bun    = bun
     @cheese = cheese
     @sauce  = sauce
   end
-  
+
   # 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
   def encode_with(coder)
     coder['Bun']    = @bun
@@ -339,23 +339,23 @@ class Burgers
   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
-  
+
   # You can still use Psych's encode_with(), no problem
   def encode_with(coder)
     coder['Burgers']  = @burgers
@@ -423,14 +423,14 @@ puts burgers.to_yaml({:indent => 3,:deref_aliases => true})
 #    Sauce: 'Honey BBQ'
 ```
 
-### [Advanced Usage](#using)
+### [//](#using) Advanced Usage
 
 ```Ruby
 require 'psychgus'
 
 class MyStyler
   include Psychgus::Styler
-  
+
   def style_sequence(sniffer,node)
     node.style = Psychgus::SEQUENCE_FLOW
   end
@@ -514,7 +514,7 @@ puts parser.handler.root.to_ruby
 puts
 ```
 
-### [Common Stylers](#using)
+### [//](#using) 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.
 
@@ -527,7 +527,7 @@ A collection of commonly-used [Stylers](https://esotericpig.github.io/docs/psych
 | [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](#common-stylers)
+#### [//](#common-stylers) Stylers Example
 
 ```Ruby
 require 'psychgus'
@@ -571,7 +571,7 @@ puts EggCarton.new.to_yaml
 #     - green
 ```
 
-## [Hacking](#contents)
+## [//](#contents) Hacking
 
 ```
 $ git clone 'https://github.com/esotericpig/psychgus.git'
@@ -580,17 +580,13 @@ $ bundle install
 $ bundle exec rake -T
 ```
 
-### [Testing](#hacking)
+### [//](#hacking) Testing
 
-Run tests, excluding tests that create temp files:
+Run tests:
 
 `$ bundle exec rake test`
 
-Run all tests:
-
-`$ bundle exec rake test_all`
-
-### [Generating Doc](#hacking)
+### [//](#hacking) Generating Doc
 
 Generate doc:
 
@@ -600,12 +596,12 @@ Clean & generate pristine doc:
 
 `$ bundle exec rake clobber doc`
 
-## [License](#contents)
+## [//](#contents) License
 
 [GNU LGPL v3+](LICENSE.txt)
 
 > Psychgus (<https://github.com/esotericpig/psychgus>)  
-> Copyright (c) 2017-2020 Jonathan Bradley Whited (@esotericpig)  
+> Copyright (c) 2017-2024 Bradley Whited  
 > 
 > 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  

data/Rakefile

@@ -1,23 +1,5 @@
 # encoding: UTF-8
-
-#--
-# This file is part of Psychgus.
-# Copyright (c) 2019-2020 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 <https://www.gnu.org/licenses/>.
-#++
-
+# frozen_string_literal: true
 
 require 'bundler/gem_tasks'
 
@@ -29,64 +11,43 @@ require 'psychgus/version'
 require 'rake/clean'
 require 'rake/testtask'
 
-
 task default: [:test]
 
 CLEAN.exclude('.git/','stock/')
 CLOBBER.include('doc/')
 
-
-# Execute "rake clobber doc" for pristine docs
+# Execute "rake clobber doc" for pristine docs.
 desc 'Generate documentation (YARDoc)'
-task :doc => [:yard,:yard_gfm_fix] do |task|
-end
+task doc: %i[yard yard_gfm_fix]
 
-Rake::TestTask.new() do |task|
+# 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.description += " ('#{task.pattern}')"
-  #task.options = '--verbose' # Execute "rake test TESTOPT=-v" instead
+  #task.options = '--verbose' # Execute "rake test TESTOPT=-v" instead.
   task.verbose = true
   task.warning = true
 end
 
-desc 'Run all tests (including writing to temp files, etc.)'
-task :test_all do |task|
-  ENV['PSYCHGUS_TEST'] = 'all'
-  
-  test_task = Rake::Task[:test]
-  
-  test_task.reenable()
-  test_task.invoke()
-end
-
-YARD::Rake::YardocTask.new() do |task|
+YARD::Rake::YardocTask.new do |task|
   task.files = [File.join('lib','**','*.rb')]
-  
-  task.options += ['--files','CHANGELOG.md,LICENSE.txt']
-  task.options += ['--readme','README.md']
-  
-  task.options << '--protected' # Show protected methods
-  task.options += ['--template-path',File.join('yard','templates')]
-  task.options += ['--title',"Psychgus v#{Psychgus::VERSION} Doc"]
 end
 
-YardGhurt::GFMFixTask.new() do |task|
+YardGhurt::GFMFixTask.new do |task|
   task.description = 'Fix (find & replace) text in the YARD files for GitHub differences'
-  
+
   task.arg_names = [:dev]
   task.dry_run = false
   task.fix_code_langs = true
   task.md_files = ['index.html']
-  
-  task.before = Proc.new() do |task,args|
+
+  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(task.doc_dir,'file.README.html'))
-    
-    # Root dir of my GitHub Page for CSS/JS
-    GHP_ROOT = YardGhurt.to_bool(args.dev) ? '../../esotericpig.github.io' : '../../..'
-    
-    task.css_styles << %Q(<link rel="stylesheet" type="text/css" href="#{GHP_ROOT}/css/prism.css" />)
-    task.js_scripts << %Q(<script src="#{GHP_ROOT}/js/prism.js"></script>)
+    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