psychgus 1.2.0 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b9e7e5d21e498f39d61b2b83765879dd6c564cc2742b121dfdeb9f5b8051578
-  data.tar.gz: 13ef8c78dc13bcce6596534e2b94557033438289a86e459834b4d7acf0afb9c1
+  metadata.gz: 91a1bbacfcd8d1a658b07bfad787182c7a789b0d0b2fb3ab51a30b9954572484
+  data.tar.gz: 6afd3dba752a30d76bd694d3d5866765522605757c5826f3c366c51d7a19cc0f
 SHA512:
-  metadata.gz: abfc0427ed29d4e3d811476a2c957f7961a85fbb0445b558d3b1356f018b12b52026a6b268b9f23384aa0a9fd20e3c720a30091448ea1659c8ddb8298e5c3b74
-  data.tar.gz: ef2db56b9b41bc3aa3f81f3a033e5aaf9508578d9aa63e5de10e978950fa9c860f77ca39ffa8c0077409149f87059faa515b51080290bf59f8e9a53dc74d366a
+  metadata.gz: d01c30c222b5da77b34a3c4fd0f97f6d1685fea13a9a4addb4fd91ff178733326aabc57ae72a1e8d4511b11a021210ba4aeb9eec7498b81f23310a7dfa307fd8
+  data.tar.gz: 0d4deeab277e4894124f8fec33f8e1064a5f95c1bd684dd2f09d612427094c3540452608068cd6076080df8545c395d2b9ab55e04437188f164b416bba8568d4

data/.yardopts

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

data/CHANGELOG.md

@@ -1,11 +1,65 @@
 # 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.2.0...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.2.0] - 2019-07-11
+## [[Unreleased]](https://github.com/esotericpig/psychgus/compare/v1.3.4...HEAD)
+-
+
+
+## [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
+### Changed
+- SuperSniffer::Parent
+    - Changed to use Delegator to delegate all methods of `node`
+- Psychgus.dump_file()/parse_file()
+    - Changed `opt` to expect a Hash
+
+### Fixed
+- Fixed some Ruby 2.7 warnings in tests
 
+
+## [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
+### Added
+- Use of YardGhurt gem for Rakefile tasks
+
+### Changed
+- Some comments/doc in SuperSniffer, README
+- yard_fix task in Rakefile to be cleaner
+- Test constants in PsychgusTest
+- Summary & files in Gemspec
+
+### Fixed
+- Updated gems
+
+
+## [v1.2.0] - 2019-07-11
 ### Added
 - Commonly-used Stylers and Stylables
 - Changelog
@@ -20,6 +74,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,24 +1,6 @@
 # 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'
 

data/README.md

@@ -1,10 +1,12 @@
 # Psychgus
 
 [![Gem Version](https://badge.fury.io/rb/psychgus.svg)](https://badge.fury.io/rb/psychgus)
+[![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?style=for-the-badge)](https://esotericpig.github.io/docs/psychgus/yardoc/index.html)
-[![Changelog](https://img.shields.io/badge/changelog-md-%23A0522D.svg?style=for-the-badge)](CHANGELOG.md)
-[![License](https://img.shields.io/github/license/esotericpig/psychgus.svg?color=%23A0522D&style=for-the-badge)](LICENSE.txt)
+[![Documentation](https://img.shields.io/badge/doc-yard-%23A0522D.svg)](https://esotericpig.github.io/docs/psychgus/yardoc/index.html)
+[![Source Code](https://img.shields.io/badge/source-github-%23211F1F.svg)](https://github.com/esotericpig/psychgus)
+[![Changelog](https://img.shields.io/badge/changelog-md-%23A0522D.svg)](CHANGELOG.md)
+[![License](https://img.shields.io/github/license/esotericpig/psychgus.svg)](LICENSE.txt)
 
 Psychgus uses the core standard library [Psych](https://github.com/ruby/psych) for working with [YAML](https://yaml.org) and extends it so that developers can easily style the YAML according to their needs.
 
@@ -92,7 +94,7 @@ $ bundle exec rake install:local
 
 ## [Using](#contents)
 
-Documentation (YARDoc) is available on my [GitHub Page](https://esotericpig.github.io/docs/psychgus/yardoc/index.html) and RubyDoc.info ([[/gems]](https://www.rubydoc.info/gems/psychgus) or [[/github]](https://www.rubydoc.info/github/esotericpig/psychgus/master)).
+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).
 
 To begin styling, create a class and mix in (include) `Psychgus::Styler`. Then pass it in as a keyword arg (`stylers: MyStyler.new` or `stylers: [MyStyler1.new,MyStyler2.new]`) into one of the Psychgus methods.
 
@@ -115,7 +117,7 @@ require 'psychgus'
 
 class CoffeeStyler
   include Psychgus::Styler
-  
+
   def style_sequence(sniffer,node)
     node.style = Psychgus::SEQUENCE_FLOW
   end
@@ -135,12 +137,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
@@ -161,20 +163,20 @@ 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
@@ -183,11 +185,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]"
@@ -256,50 +258,50 @@ 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
@@ -307,23 +309,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
@@ -336,23 +338,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
@@ -427,7 +429,7 @@ require 'psychgus'
 
 class MyStyler
   include Psychgus::Styler
-  
+
   def style_sequence(sniffer,node)
     node.style = Psychgus::SEQUENCE_FLOW
   end
@@ -572,6 +574,7 @@ puts EggCarton.new.to_yaml
 
 ```
 $ git clone 'https://github.com/esotericpig/psychgus.git'
+$ cd psychgus
 $ bundle install
 $ bundle exec rake -T
 ```
@@ -588,28 +591,20 @@ Run all tests:
 
 ### [Generating Doc](#hacking)
 
-Generate basic doc:
-
-`$ bundle exec rake yard`
-
-Fix GitHub-specific differences:
-
-`$ bundle exec rake yard_fix`
-
-Clean doc & run all of the above:
+Generate doc:
 
-`$ bundle exec rake yard_fresh`
+`$ bundle exec rake doc`
 
-Deploy doc to my GitHub Page (not useful for others):
+Clean & generate pristine doc:
 
-`$ bundle exec rake ghp_doc`
+`$ bundle exec rake clobber doc`
 
 ## [License](#contents)
 
 [GNU LGPL v3+](LICENSE.txt)
 
 > Psychgus (<https://github.com/esotericpig/psychgus>)  
-> Copyright (c) 2017-2019 Jonathan Bradley Whited (@esotericpig)  
+> Copyright (c) 2017-2021 Jonathan 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,66 +1,33 @@
 # encoding: UTF-8
-
-#--
-# 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/>.
-#++
+# frozen_string_literal: true
 
 
 require 'bundler/gem_tasks'
 
 require 'yard'
+require 'yard_ghurt'
 
 require 'psychgus/version'
 
 require 'rake/clean'
 require 'rake/testtask'
 
+
 task default: [:test]
 
 CLEAN.exclude('.git/','stock/')
 CLOBBER.include('doc/')
 
-module PsychgusRake
-  # Remove if exists
-  def self.rm_exist(filename,output=true)
-    if File.exist?(filename)
-      puts "Delete [#{filename}]" if output
-      File.delete(filename)
-    end
-  end
-end
 
-# Execute "rake ghp_doc" for a dry run
-# Execute "rake ghp_doc[true]" for actually deploying
-desc %q(Rsync "doc/" to my GitHub Page's repo; not useful for others)
-task :ghp_doc,[:deploy] do |task,args|
-  dry_run = args.deploy ? '' : '--dry-run'
-  rsync_cmd = "rsync -ahv --delete-after --progress #{dry_run} 'doc/' '../esotericpig.github.io/docs/psychgus/yardoc/'"
-  
-  sh rsync_cmd
-  
-  if !args.deploy
-    puts
-    puts 'Execute "rake ghp_doc[true]" for actually deploying (non-dry-run)'
-  end
-end
+# Execute "rake clobber doc" for pristine docs
+desc 'Generate documentation (YARDoc)'
+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 = 'test/**/*_test.rb'
+  task.pattern = File.join('test','**','*_test.rb')
   task.description += " ('#{task.pattern}')"
   #task.options = '--verbose' # Execute "rake test TESTOPT=-v" instead
   task.verbose = true
@@ -70,94 +37,34 @@ 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()
+
+  test_task.reenable
+  test_task.invoke
 end
 
-# Execute "rake clobber yard" for pristine docs
-YARD::Rake::YardocTask.new() do |task|
-  task.files = ['lib/**/*.rb']
-  
-  task.options += ['--files','CHANGELOG.md,LICENSE.txt']
-  task.options += ['--readme','README.md']
-  
-  task.options << '--protected' # Show protected methods
-  task.options += ['--template-path','yard/templates/']
+YARD::Rake::YardocTask.new do |task|
+  task.files = [File.join('lib','**','*.rb')]
   task.options += ['--title',"Psychgus v#{Psychgus::VERSION} Doc"]
 end
 
-desc 'Fix (find & replace) text in the YARD files for GitHub differences'
-task :yard_fix,[:dev] do |task,args|
-  # Delete this file as it's never used (index.html is an exact copy)
-  PsychgusRake.rm_exist('doc/file.README.html')
-  
-  ['doc/index.html'].each do |filename|
-    puts "File [#{filename}]:"
-    
-    lines = []
-    write = false
-    
-    File.open(filename,'r') do |file|
-      file.each_line do |line|
-        out = false
-        
-        # CSS
-        if line =~ /^\s*\<\/head\>\s*$/i
-          line = '<link href="'
-          line << (args.dev ? '../../esotericpig.github.io/' : '../../../')
-          line << 'css/prism.css" rel="stylesheet" /> </head>'
-          
-          out = true
-        end
-        
-        # JS
-        if line =~ /^\s*\<\/body\>\s*$/i
-          line = '<script src="'
-          line << (args.dev ? '../../esotericpig.github.io/' : '../../../')
-          line << 'js/prism.js"></script> </body>'
-          
-          out = true
-        end
-        
-        # Anchor links
-        tag = 'href="#'
-        quoted_tag = Regexp.quote(tag)
-        
-        if !(i = line.index(Regexp.new(quoted_tag + '[a-z]'))).nil?()
-          line = line.gsub(Regexp.new(quoted_tag + '[a-z][^"]*"')) do |href|
-            link = href[tag.length..-2]
-            link = link.split('-').map(&:capitalize).join('_')
-            
-            %Q(#{tag}#{link}")
-          end
-          
-          out = true
-        end
-        
-        out = !line.gsub!('href="CHANGELOG.md"','href="file.CHANGELOG.html"').nil?() || out
-        out = !line.gsub!('href="LICENSE.txt"','href="file.LICENSE.html"').nil?() || out
-        out = !line.gsub!('code class="Ruby"','code class="language-ruby"').nil?() || out
-        out = !line.gsub!('code class="YAML"','code class="language-yaml"').nil?() || out
-        
-        if out
-          puts "  #{line}"
-          write = true
-        end
-        
-        lines << line
-      end
-    end
-    
-    if write
-      File.open(filename,'w') do |file|
-        file.puts lines
-      end
-    end
-  end
-end
+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']
 
-desc 'Generate pristine YARDoc'
-task :yard_fresh => [:clobber,:yard,:yard_fix] do |task|
+  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'))
+
+    # Root dir of my GitHub Page for CSS/JS
+    ghp_root = YardGhurt.to_bool(args.dev) ? '../../esotericpig.github.io' : '../../..'
+
+    t2.css_styles << %Q(<link rel="stylesheet" type="text/css" href="#{ghp_root}/css/prism.css" />)
+    t2.js_scripts << %Q(<script src="#{ghp_root}/js/prism.js"></script>)
+  end
 end