psychgus 1.2.0 → 1.3.4

data/lib/psychgus/super_sniffer/parent.rb

@@ -1,77 +1,71 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
+# frozen_string_literal: true
 
 #--
 # This file is part of Psychgus.
-# Copyright (c) 2019 Jonathan Bradley Whited (@esotericpig)
-# 
-# Psychgus is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-# 
-# Psychgus is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-# 
-# You should have received a copy of the GNU Lesser General Public License
-# along with Psychgus.  If not, see <http://www.gnu.org/licenses/>.
+# Copyright (c) 2019-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 
+require 'delegate'
+
+
 module Psychgus
   class SuperSniffer
     ###
     # A container for the parent of a Psych::Nodes::Node.
-    # 
+    #
     # A parent is a Mapping, Sequence, or a Key (Scalar) of a Mapping.
-    # 
+    #
     # You can use the getters in this class in {Styler} to filter what to change.
-    # 
+    #
     # If a Node method has not been exposed, you can use {#node}:
     #   if parent.node_of?(:scalar)
     #     parent.value = 'FUBAR'
     #     parent.node.value = 'FUBAR' # Same as above
-    #     
+    #
     #     parent.fubar = true      # NoMethodError
     #     parent.node.fubar = true # Use some new Psych::Nodes::Node method not in this version
     #                              #   of Psychgus or that is not exposed by Parent
     #   end
-    # 
-    # @author Jonathan Bradley Whited (@esotericpig)
+    #
+    # @author Jonathan Bradley Whited
     # @since  1.0.0
-    # 
+    #
     # @see SuperSniffer
     # @see SuperSniffer#start_parent SuperSniffer#start_parent
     # @see SuperSniffer#end_parent SuperSniffer#end_parent
     # @see Styler
     ###
-    class Parent
+    class Parent < SimpleDelegator
       # Calling the getter is fine; calling the setter is *not* and could cause weird results.
-      # 
+      #
       # @return [Integer] the next child's position
       attr_accessor :child_position
-      
+
       # Calling the getter is fine; calling the setter is *not* and could cause weird results.
-      # 
+      #
       # @return [nil,:key,:value] the next child's Mapping type, if {#node} is a Mapping
       attr_accessor :child_type
-      
+
       # @return [:noface,Symbol,String] a tag (class name, value) for debugging; also used in {#to_s}
       attr_reader :debug_tag
-      
+
       attr_reader :level # @return [Integer] the level of this Node in the YAML
       attr_reader :node # @return [Psych::Nodes::Node] the Node of this parent
       attr_reader :position # @return [Integer] the position of this Node in the YAML
-      
+
       # Initialize this class with parent data.
-      # 
+      #
       # @param sniffer [SuperSniffer] the sniffer that contains this parent (not stored; used for data)
       # @param node [Psych::Nodes::Node] the node of this parent
       # @param debug_tag [:noface,Symbol,String] the tag (class name, value) used for debugging and in {#to_s}
       # @param child_type [nil,:key,:value] the next child's Mapping type, if +node+ is a Mapping
       def initialize(sniffer,node,debug_tag: nil,child_type: nil)
+        super(node)
+
         @child_position = 1
         @child_type = child_type
         @debug_tag = debug_tag
@@ -79,158 +73,63 @@ module Psychgus
         @node = node
         @position = sniffer.position
       end
-      
-      # @see Psych::Nodes::Alias#anchor=
-      # @see Psych::Nodes::Mapping#anchor=
-      # @see Psych::Nodes::Scalar#anchor=
-      # @see Psych::Nodes::Sequence#anchor=
-      def anchor=(anchor)
-        @node.anchor = anchor
-      end
-      
-      # @see Psych::Nodes::Scalar#plain=
-      def plain=(plain)
-        @node.plain = plain
-      end
-      
-      # @see Psych::Nodes::Scalar#quoted=
-      def quoted=(quoted)
-        @node.quoted = quoted
-      end
-      
-      # @see Psych::Nodes::Mapping#style=
-      # @see Psych::Nodes::Scalar#style=
-      # @see Psych::Nodes::Sequence#style=
-      def style=(style)
-        @node.style = style
-      end
-      
-      # @see Psych::Nodes::Node#tag=
-      def tag=(tag)
-        @node.tag = tag
-      end
-      
-      # @see Psych::Nodes::Scalar#value=
-      def value=(value)
-        @node.value = value
-      end
-      
-      # @see Psych::Nodes::Alias#anchor
-      # @see Psych::Nodes::Mapping#anchor
-      # @see Psych::Nodes::Scalar#anchor
-      # @see Psych::Nodes::Sequence#anchor
-      def anchor()
-        return @node.anchor
+
+      # @api private
+      def __getobj__
+        return @node
       end
-      
+
       # Check if the children of this parent are keys to a Mapping.
-      # 
+      #
       # @return [true,false] whether the children are keys to a Mapping
-      # 
+      #
       # @since 1.2.0
-      def child_key?()
+      def child_key?
         return @child_type == :key
       end
-      
+
       # Check if the children of this parent are values to a Mapping (i.e., values to a key).
-      # 
+      #
       # @return [true,false] whether the children are values to a Mapping (i.e., values to a key)
-      # 
+      #
       # @since 1.2.0
-      def child_value?()
+      def child_value?
         return @child_type == :value
       end
-      
-      # @see Psych::Nodes::Stream#encoding
-      def encoding()
-        return @node.encoding
-      end
-      
-      # @see Psych::Nodes::Node#end_column
-      def end_column()
-        return @node.end_column
-      end
-      
-      # @see Psych::Nodes::Node#end_line
-      def end_line()
-        return @node.end_line
-      end
-      
+
       # @see Psych::Nodes::Document#implicit
       # @see Psych::Nodes::Mapping#implicit
       # @see Psych::Nodes::Sequence#implicit
-      def implicit?()
+      def implicit?
         return @node.implicit
       end
-      
+
       # @see Psych::Nodes::Document#implicit_end
-      def implicit_end?()
+      def implicit_end?
         return @node.implicit_end
       end
-      
+
       # (see Ext::NodeExt#node_of?)
       def node_of?(*names)
         return @node.node_of?(*names)
       end
-      
+
       # @see Psych::Nodes::Scalar#plain
-      def plain?()
+      def plain?
         return @node.plain
       end
-      
+
       # @see Psych::Nodes::Scalar#quoted
-      def quoted?()
+      def quoted?
         return @node.quoted
       end
-      
-      # @see Psych::Nodes::Node#start_column
-      def start_column()
-        return @node.start_column
-      end
-      
-      # @see Psych::Nodes::Node#start_line
-      def start_line()
-        return @node.start_line
-      end
-      
-      # @see Psych::Nodes::Mapping#style
-      # @see Psych::Nodes::Scalar#style
-      # @see Psych::Nodes::Sequence#style
-      def style()
-        return @node.style
-      end
-      
-      # @see Psych::Nodes::Node#tag
-      def tag()
-        return @node.tag
-      end
-      
-      # @see Psych::Nodes::Document#tag_directives
-      def tag_directives()
-        return @node.tag_directives
-      end
-      
-      # @see Psych::Nodes::Scalar#value
-      def value()
-        return @node.value
-      end
-      
-      # @see Psych::Nodes::Document#version
-      def version()
-        return @node.version
-      end
-      
+
       # @note If this method is modified, then tests will fail
-      # 
+      #
       # @return [String] a String representation of this class for debugging and testing
-      def to_s()
+      def to_s
         return "<#{@debug_tag}:(#{@level}:#{@position}):#{@child_type}:(:#{@child_position})>"
       end
-      
-      alias_method :implicit,:implicit?
-      alias_method :implicit_end,:implicit_end?
-      alias_method :plain,:plain?
-      alias_method :quoted,:quoted?
     end
   end
 end

data/lib/psychgus/version.rb

@@ -1,27 +1,15 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
 # frozen_string_literal: true
 
 #--
 # This file is part of Psychgus.
-# Copyright (c) 2017-2019 Jonathan Bradley Whited (@esotericpig)
-# 
-# Psychgus is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-# 
-# Psychgus is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-# 
-# You should have received a copy of the GNU Lesser General Public License
-# along with Psychgus.  If not, see <http://www.gnu.org/licenses/>.
+# Copyright (c) 2017-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 
 module Psychgus
   # Version of this gem in "#.#.#" format
-  VERSION = '1.2.0'
+  VERSION = '1.3.4'
 end

data/psychgus.gemspec

@@ -1,67 +1,64 @@
 # 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/>.
-#++
 
+require_relative 'lib/psychgus/version'
 
-lib = File.expand_path('../lib',__FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'psychgus/version'
 
 Gem::Specification.new do |spec|
   spec.name        = 'psychgus'
   spec.version     = Psychgus::VERSION
-  spec.authors     = ['Jonathan Bradley Whited (@esotericpig)']
-  spec.email       = ['bradley@esotericpig.com']
+  spec.authors     = ['Jonathan Bradley Whited']
+  spec.email       = ['code@esotericpig.com']
   spec.licenses    = ['LGPL-3.0-or-later']
   spec.homepage    = 'https://github.com/esotericpig/psychgus'
-  spec.summary     = %q(Easily style YAML files using Psych, like Sequence/Mapping Flow style.)
-  spec.description = %q(Easily style YAML files using Psych, like Sequence/Mapping Flow style.)
-  
+  spec.summary     = 'Easily style YAML files using Psych.'
+  spec.description = 'Easily style YAML files using Psych, like Sequence/Mapping Flow style.'
+
   spec.metadata = {
+    'homepage_uri'      => 'https://github.com/esotericpig/psychgus',
+    'source_code_uri'   => 'https://github.com/esotericpig/psychgus',
     'bug_tracker_uri'   => 'https://github.com/esotericpig/psychgus/issues',
     'changelog_uri'     => 'https://github.com/esotericpig/psychgus/blob/master/CHANGELOG.md',
     'documentation_uri' => 'https://esotericpig.github.io/docs/psychgus/yardoc/index.html',
-    'homepage_uri'      => 'https://github.com/esotericpig/psychgus',
-    'source_code_uri'   => 'https://github.com/esotericpig/psychgus'
   }
-  
-  spec.files = Dir.glob(File.join('{lib,test,yard}','**','*.{erb,rb}')) +
-               %w(
-                 CHANGELOG.md
-                 Gemfile
-                 LICENSE.txt
-                 psychgus.gemspec
-                 Rakefile
-                 README.md
-               )
-  spec.require_paths = ['lib']
-  
+
   spec.required_ruby_version = '>= 2.1.10'
-  
-  spec.add_runtime_dependency 'psych','>= 2.0.5'
-  
-  spec.add_development_dependency 'bundler'  ,'~> 1.16'
-  spec.add_development_dependency 'minitest' ,'~> 5.11' # For testing
-  spec.add_development_dependency 'rake'     ,'~> 12.3'
-  spec.add_development_dependency 'rdoc'     ,'~> 6.1'  # For RDoc for YARD (*.rb)
-  spec.add_development_dependency 'redcarpet','~> 3.4'  # For Markdown for YARD (*.md)
-  spec.add_development_dependency 'yard'     ,'~> 0.9'  # For documentation
+  spec.require_paths         = ['lib']
+  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}')),
+    %W[ Gemfile #{spec.name}.gemspec Rakefile .yardopts ],
+    %w[ LICENSE.txt CHANGELOG.md README.md ],
+  ].flatten
+
+  # Test using different Gem versions:
+  #   GST=1 bundle update && bundle exec rake test_all
+  gemspec_test = ENV.fetch('GST','').to_s.strip
+  psych_gemv = false
+
+  if !gemspec_test.empty?
+    case gemspec_test
+    when '1' then psych_gemv = '~> 3.0'
+    end
+
+    puts 'Using Gem versions:'
+    puts "  psych: #{psych_gemv.inspect}"
+  end
+
+  # 3.0 is needed for this issue:
+  # - https://bugs.ruby-lang.org/issues/13115
+  # - https://github.com/ruby/psych/commit/712a65a53f3c15105cd86e8ad3ee3c779050ada4
+  spec.add_runtime_dependency 'psych',psych_gemv || '>= 3.0'
+
+  spec.add_development_dependency 'bundler'   ,'~> 2.2'
+  spec.add_development_dependency 'minitest'  ,'~> 5.14' # For testing
+  spec.add_development_dependency 'rake'      ,'~> 13.0'
+  spec.add_development_dependency 'rdoc'      ,'~> 6.3'  # For RDoc for YARD (*.rb)
+  spec.add_development_dependency 'redcarpet' ,'~> 3.5'  # For Markdown for YARD (*.md)
+  spec.add_development_dependency 'yard'      ,'~> 0.9'  # For documentation
+  spec.add_development_dependency 'yard_ghurt','~> 1.2'  # For YARD GitHub rake tasks
 end

data/test/blueberry_test.rb

@@ -1,22 +1,11 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
+# frozen_string_literal: true
 
 #--
 # This file is part of Psychgus.
-# Copyright (c) 2019 Jonathan Bradley Whited (@esotericpig)
-# 
-# Psychgus is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-# 
-# Psychgus is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-# 
-# You should have received a copy of the GNU Lesser General Public License
-# along with Psychgus.  If not, see <http://www.gnu.org/licenses/>.
+# Copyright (c) 2019-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 
@@ -24,23 +13,23 @@ require 'psychgus_tester'
 
 class Burger
   include Psychgus::Blueberry
-  
+
   attr_accessor :bun
   attr_accessor :cheese
   attr_accessor :sauce
-  
+
   def initialize(sauce,cheese,bun)
     @bun = bun
     @cheese = cheese
     @sauce = sauce
   end
-  
+
   def encode_with(coder)
     coder['Bun'] = @bun
     coder['Cheese'] = @cheese
     coder['Sauce'] = @sauce
   end
-  
+
   def psychgus_stylers(sniffer)
     return BurgerStyler.new(sniffer)
   end
@@ -49,21 +38,21 @@ end
 class Burgers
   attr_accessor :burgers
   attr_accessor :toppings
-  
-  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')
     }
-    
+
     @toppings = [
       'Mushrooms',
-      %w(Lettuce Onions Pickles Tomatoes),
-      [%w(Ketchup Mustard),%w(Salt Pepper)]
+      %w[Lettuce Onions Pickles Tomatoes],
+      [%w[Ketchup Mustard],%w[Salt Pepper]]
     ]
   end
-  
+
   def encode_with(coder)
     coder['Burgers'] = @burgers
     coder['Toppings'] = @toppings
@@ -72,46 +61,46 @@ end
 
 class BurgerStyler
   include Psychgus::Styler
-  
+
   def initialize(sniffer)
     @level = sniffer.level
     @position = sniffer.position
   end
-  
+
   def style(sniffer,node)
     # Remove ugly and unsafe "!ruby/object:Burger"
     node.tag = nil if node.respond_to?(:tag)
   end
-  
+
   def style_mapping(sniffer,node)
     parent = sniffer.parent
-    
-    if !parent.nil?()
+
+    if !parent.nil?
       # BBQ
       node.style = Psychgus::MAPPING_FLOW if parent.respond_to?(:value) && parent.value.casecmp('BBQ') == 0
     end
   end
-  
+
   def style_scalar(sniffer,node)
     # Only for Burgers
     node.style = Psychgus::SCALAR_SINGLE_QUOTED
   end
-  
+
   def style_sequence(sniffer,node)
     relative_level = (sniffer.level - @level) + 1
-    
+
     # [Ketchup, Mustard]
     node.style = Psychgus::SEQUENCE_FLOW if relative_level == 3
   end
 end
 
 class BlueberryTest < PsychgusTester
-  def setup()
-    @burgers = Burgers.new()
+  def setup
+    @burgers = Burgers.new
   end
-  
-  def test_blueberry()
-    expected = <<-EOY
+
+  def test_blueberry
+    expected = <<-YAML
     |--- !ruby/object:Burgers
     |Burgers:
     |  Classic:
@@ -133,9 +122,9 @@ class BlueberryTest < PsychgusTester
     |    - Mustard
     |  - - Salt
     |    - Pepper
-    EOY
+    YAML
     expected = self.class.lstrip_pipe(expected)
-    
-    assert_equal expected,@burgers.to_yaml()
+
+    assert_equal expected,@burgers.to_yaml
   end
 end