psychgus 1.2.0 → 1.3.4

data/test/psychgus_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
 #++
 
 
@@ -26,18 +15,18 @@ require 'tempfile'
 
 class FlowStyler
   include Psychgus::Styler
-  
+
   def style_mapping(sniffer,node)
     node.style = Psychgus::MAPPING_FLOW if sniffer.level >= 4
   end
-  
+
   def style_sequence(sniffer,node)
     node.style = Psychgus::SEQUENCE_FLOW if sniffer.level >= 4
   end
 end
 
 class PsychgusTest < PsychgusTester
-  EXPECTED_BURGERS = <<-EOY
+  EXPECTED_BURGERS = <<-YAML
 ---
 Burgers:
   Classic: {Sauce: [Ketchup, Mustard], Cheese: American, Bun: Sesame Seed}
@@ -47,14 +36,14 @@ Toppings:
 - Mushrooms
 - [Lettuce, Onions, Pickles, Tomatoes]
 - [[Ketchup, Mustard], [Salt, Pepper]]
-  EOY
-  
-  def setup()
-    @flow_styler = FlowStyler.new()
+  YAML
+
+  def setup
+    @flow_styler = FlowStyler.new
   end
-  
-  def test_alias()
-    expected = <<-EOY
+
+  def test_alias
+    expected = <<-YAML
     |---
     |Dolphins:
     |  Common: {Length: "~2.5m", Weight: "~235kg"}
@@ -64,43 +53,56 @@ Toppings:
     |Popular:
     |- {Length: "~4m", Weight: "~300kg"}
     |- {Length: "~7m", Weight: "~3600kg"}
-    EOY
+    YAML
     expected = self.class.lstrip_pipe(expected)
-    
+
     assert_equal expected,DOLPHINS_DATA.to_yaml(deref_aliases: true,stylers: @flow_styler)
   end
-  
-  def test_dump()
+
+  def test_dump
     assert_equal EXPECTED_BURGERS,Psychgus.dump(BURGERS_DATA,stylers: @flow_styler)
     assert_equal EXPECTED_BURGERS,Psychgus.dump_stream(BURGERS_DATA,stylers: @flow_styler)
     assert_equal EXPECTED_BURGERS,BURGERS_DATA.to_yaml(stylers: @flow_styler)
   end
-  
+
   # Execute "rake test_all" if you update Psychgus.dump_file()/load_file()
-  def test_file()
+  def test_file
     if !TEST_ALL
       skip(TEST_ALL_SKIP_MSG)
       return # Justin Case
     end
-    
+
     Tempfile.create(['Psychgus','.yaml']) do |file|
       puts "Testing #{self.class.name} w/ temp file: #{file.path}"
-      
-      Psychgus.dump_file(file,BURGERS_DATA,stylers: @flow_styler)
-      
-      file.rewind()
-      lines = file.readlines().join()
+
+      Psychgus.dump_file(file,BURGERS_DATA,
+        mode: File::CREAT | File::RDWR,
+        opt: {textmode: true},
+        #perm: 644, # Unix only
+        stylers: @flow_styler,
+      )
+
+      file.rewind
+
+      lines = file.readlines.join
       assert_equal EXPECTED_BURGERS,lines
-      
-      file.rewind()
+
+      file.rewind
+      file.close
+
       data = Psych.load_file(file)
       refute_equal false,data
+      refute_equal nil,data
+
+      data = Psychgus.parse_file(file)
+      refute_equal false,data
+      refute_equal nil,data
     end
   end
-  
-  def test_indent()
+
+  def test_indent
     # Indent of 3 spaces
-    expected = <<-EOY
+    expected = <<-YAML
     |---
     |Burgers:
     |   Classic: {Sauce: [Ketchup, Mustard], Cheese: American, Bun: Sesame Seed}
@@ -110,32 +112,49 @@ Toppings:
     |- Mushrooms
     |- [Lettuce, Onions, Pickles, Tomatoes]
     |- [[Ketchup, Mustard], [Salt, Pepper]]
-    EOY
+    YAML
     expected = self.class.lstrip_pipe(expected)
-    
+
+    # rubocop:disable Style/HashSyntax
     assert_equal expected,BURGERS_DATA.to_yaml(indent: 3,stylers: @flow_styler)
-    assert_equal expected,BURGERS_DATA.to_yaml({:indent=>3,:stylers=>@flow_styler})
+    assert_equal expected,BURGERS_DATA.to_yaml(**{:indent => 3,:stylers => @flow_styler})
     assert_equal expected,BURGERS_DATA.to_yaml(indentation: 3,stylers: @flow_styler)
-    assert_equal expected,BURGERS_DATA.to_yaml({:indentation=>3,:stylers=>@flow_styler})
+    assert_equal expected,BURGERS_DATA.to_yaml(**{:indentation => 3,:stylers => @flow_styler})
+    # rubocop:enable all
   end
-  
-  def test_node_consts()
+
+  def test_node_consts
+    assert_equal Psych::Nodes::Mapping::ANY,Psychgus::MAPPING_ANY
+    assert_equal Psych::Nodes::Mapping::BLOCK,Psychgus::MAPPING_BLOCK
     assert_equal Psych::Nodes::Mapping::FLOW,Psychgus::MAPPING_FLOW
+
+    assert_equal Psych::Nodes::Scalar::ANY,Psychgus::SCALAR_ANY
+    assert_equal Psych::Nodes::Scalar::PLAIN,Psychgus::SCALAR_PLAIN
+    assert_equal Psych::Nodes::Scalar::SINGLE_QUOTED,Psychgus::SCALAR_SINGLE_QUOTED
+    assert_equal Psych::Nodes::Scalar::DOUBLE_QUOTED,Psychgus::SCALAR_DOUBLE_QUOTED
+    assert_equal Psych::Nodes::Scalar::LITERAL,Psychgus::SCALAR_LITERAL
     assert_equal Psych::Nodes::Scalar::FOLDED,Psychgus::SCALAR_FOLDED
+
+    assert_equal Psych::Nodes::Sequence::ANY,Psychgus::SEQUENCE_ANY
+    assert_equal Psych::Nodes::Sequence::BLOCK,Psychgus::SEQUENCE_BLOCK
     assert_equal Psych::Nodes::Sequence::FLOW,Psychgus::SEQUENCE_FLOW
+
+    assert_equal Psych::Nodes::Stream::ANY,Psychgus::STREAM_ANY
     assert_equal Psych::Nodes::Stream::UTF8,Psychgus::STREAM_UTF8
+    assert_equal Psych::Nodes::Stream::UTF16LE,Psychgus::STREAM_UTF16LE
+    assert_equal Psych::Nodes::Stream::UTF16BE,Psychgus::STREAM_UTF16BE
   end
-  
-  def test_parse()
+
+  def test_parse
     parser = Psychgus.parser(stylers: @flow_styler)
     parser.parse(BURGERS_YAML)
-    yaml = "---\n" + parser.handler.root.to_yaml()
+    yaml = "---\n" + parser.handler.root.to_yaml
     assert_equal EXPECTED_BURGERS,yaml
-    
+
     node = Psychgus.parse(BURGERS_YAML,stylers: @flow_styler)
     refute_equal false,node
-    
-    yaml = Psychgus.parse_stream(BURGERS_YAML,stylers: @flow_styler).to_yaml()
+
+    yaml = Psychgus.parse_stream(BURGERS_YAML,stylers: @flow_styler).to_yaml
     yaml = "---\n#{yaml}"
     assert_equal EXPECTED_BURGERS,yaml
   end

data/test/psychgus_tester.rb

@@ -1,23 +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
 #++
 
 
@@ -30,13 +18,13 @@ class PsychgusTester < Minitest::Test
   # If true, will...
   # - Run tests that create temp file(s).
   #   - I don't like creating temp file(s) every time I run tests (which is a lot).
-  # 
+  #
   # To do this, execute:
   #   rake test_all
-  TEST_ALL = (ENV['PSYCHGUS_TEST'].to_s().strip().casecmp('all') == 0)
-  TEST_ALL_SKIP_MSG = %q(Execute "rake test_all" for this test)
-  
-  BURGERS_YAML = <<-EOY.freeze()
+  TEST_ALL = (ENV['PSYCHGUS_TEST'].to_s.strip.casecmp('all') == 0)
+  TEST_ALL_SKIP_MSG = 'Execute "rake test_all" for this test'
+
+  BURGERS_YAML = <<-YAML
 Burgers:
   Classic:
     Sauce:  [Ketchup,Mustard]
@@ -54,10 +42,10 @@ Toppings:
   - Mushrooms
   - [Lettuce, Onions, Pickles, Tomatoes]
   - [[Ketchup,Mustard], [Salt,Pepper]]
-  EOY
-  BURGERS_DATA = Psych.load(BURGERS_YAML).freeze()
-  
-  COURSES_YAML = <<-EOY.freeze()
+  YAML
+  BURGERS_DATA = Psych.load(BURGERS_YAML).freeze
+
+  COURSES_YAML = <<-YAML
 Courses:
   COSC: [470,'Computer Science']
   MUSC: [340,'Music']
@@ -67,10 +55,10 @@ Schedule:
 - {Course: MUSC,Time: '10:30'}
 - {Course: ARTS,Time: '15:10'}
 - {Course: COSC,Time: '13:10'}
-  EOY
-  COURSES_DATA = Psych.load(COURSES_YAML).freeze()
-  
-  DOLPHINS_YAML = <<-EOY.freeze()
+  YAML
+  COURSES_DATA = Psych.load(COURSES_YAML).freeze
+
+  DOLPHINS_YAML = <<-YAML
 Dolphins:
   Common:     &com {Length: ~2.5m, Weight:  ~235kg}
   Bottlenose: &bot {Length:   ~4m, Weight:  ~300kg}
@@ -79,9 +67,13 @@ Dolphins:
 Popular:
   - *bot
   - *orc
-  EOY
-  DOLPHINS_DATA = Psych.load(DOLPHINS_YAML).freeze()
-  
+  YAML
+  # Psych v4+ uses safe_load() by default for load(),
+  #   so use unsafe_load() to have aliases turned on.
+  # Don't do 'aliases: true' because that doesn't exist
+  #   in older versions of Psych.
+  DOLPHINS_DATA = Psych.unsafe_load(DOLPHINS_YAML).freeze
+
   # This is for "<<-" heredoc
   # - Purposely not using "<<~" (tilde) for older Ruby versions
   def self.lstrip_pipe(str)

data/test/sniffer_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
 #++
 
 
@@ -25,18 +14,18 @@ require 'psychgus_tester'
 require 'stringio'
 
 class SnifferTest < PsychgusTester
-  def setup()
+  def setup
   end
-  
+
   def assert_hierarchy(*data,expected)
     expected = self.class.lstrip_pipe(expected)
     hierarchy = Psychgus.hierarchy(*data,verbose: true)
-    
+
     assert_equal expected,hierarchy
   end
-  
-  def test_multi_doc()
-    assert_hierarchy(BURGERS_DATA,COURSES_DATA,DOLPHINS_DATA,<<-EOH
+
+  def test_multi_doc
+    assert_hierarchy(BURGERS_DATA,COURSES_DATA,DOLPHINS_DATA,<<-HIER)
     |(1:1):Psych::Nodes::Stream - <root:(0:0)::(:1)>
     |(1:1):Psych::Nodes::Document - <stream:(1:1)::(:1)>
     |(1:1):Psych::Nodes::Mapping - <doc:(1:1)::(:1)>
@@ -153,12 +142,11 @@ class SnifferTest < PsychgusTester
     |  (3:1):Psych::Nodes::Sequence - <Popular:(2:2):value:(:1)>
     |   (4:1):Psych::Nodes::Alias - <seq:(3:1)::(:1)>
     |   (4:2):Psych::Nodes::Alias - <seq:(3:1)::(:2)>
-    EOH
-    )
+    HIER
   end
-  
-  def test_single_docs()
-    assert_hierarchy(BURGERS_DATA,<<-EOH
+
+  def test_single_docs
+    assert_hierarchy(BURGERS_DATA,<<-HIER)
     |(1:1):Psych::Nodes::Stream - <root:(0:0)::(:1)>
     |(1:1):Psych::Nodes::Document - <stream:(1:1)::(:1)>
     |(1:1):Psych::Nodes::Mapping - <doc:(1:1)::(:1)>
@@ -205,10 +193,9 @@ class SnifferTest < PsychgusTester
     |    (5:2):Psych::Nodes::Sequence - <seq:(4:3)::(:2)>
     |     (6:1):Salt - <seq:(5:2)::(:1)>
     |     (6:2):Pepper - <seq:(5:2)::(:2)>
-    EOH
-    )
-    
-    assert_hierarchy(COURSES_DATA,<<-EOH
+    HIER
+
+    assert_hierarchy(COURSES_DATA,<<-HIER)
     |(1:1):Psych::Nodes::Stream - <root:(0:0)::(:1)>
     |(1:1):Psych::Nodes::Document - <stream:(1:1)::(:1)>
     |(1:1):Psych::Nodes::Mapping - <doc:(1:1)::(:1)>
@@ -248,7 +235,6 @@ class SnifferTest < PsychgusTester
     |     (6:1):COSC - <Course:(5:1):value:(:1)>
     |    (5:2):Time - <map:(4:4):key:(:2)>
     |     (6:1):13:10 - <Time:(5:2):value:(:1)>
-    EOH
-    )
+    HIER
   end
 end

data/test/styler_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,45 +13,45 @@ require 'psychgus_tester'
 
 class MyStyler
   include Psychgus::Styler
-  
+
   def style(sniffer,node)
   end
-  
+
   def style_alias(sniffer,node)
   end
-  
+
   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
-      
+
       # Fancy
       node.style = Psychgus::MAPPING_FLOW if parent.level == 4 && parent.position == 3
     end
   end
-  
+
   def style_scalar(sniffer,node)
     node.style = Psychgus::SCALAR_SINGLE_QUOTED if node.value.casecmp('Mushrooms') == 0
     node.value = 'Spinach' if node.value.casecmp('Lettuce') == 0
   end
-  
+
   def style_sequence(sniffer,node)
     node.style = Psychgus::SEQUENCE_FLOW if sniffer.level >= 3
-    
+
     # Burgers=>Classic=>Sauce and Mushrooms
     node.style = Psychgus::SEQUENCE_BLOCK if sniffer.position == 1
   end
 end
 
 class StylerTest < PsychgusTester
-  def setup()
-    @styler = MyStyler.new()
+  def setup
+    @styler = MyStyler.new
   end
-  
-  def test_styler()
-    expected = <<-EOY
+
+  def test_styler
+    expected = <<-YAML
     |---
     |Burgers:
     |  Classic:
@@ -77,9 +66,9 @@ class StylerTest < PsychgusTester
     |- 'Mushrooms'
     |- [Spinach, Onions, Pickles, Tomatoes]
     |- [[Ketchup, Mustard], [Salt, Pepper]]
-    EOY
+    YAML
     expected = self.class.lstrip_pipe(expected)
-    
+
     assert_equal expected,BURGERS_DATA.to_yaml(stylers: @styler)
   end
 end