psychgus 1.0.0

data/psychgus.gemspec

@@ -0,0 +1,121 @@
+# 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/>.
+#++
+
+
+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.licenses = ['LGPL-3.0-or-later']
+  
+  spec.metadata = {
+    'bug_tracker_uri'   => 'https://github.com/esotericpig/psychgus/issues',
+    '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.homepage    = 'https://github.com/esotericpig/psychgus'
+  spec.summary     = %q(Easily style YAML files using Psych, like Sequence/Mapping Flow style.)
+  spec.description = <<-EOS
+Easily style YAML files using Psych, like Sequence/Mapping Flow style.
+
+Simple example:
+  class CoffeeStyler
+    include Psychgus::Styler
+    
+    def style_sequence(sniffer,node)
+      node.style = Psychgus::SEQUENCE_FLOW
+    end
+  end
+  
+  coffee = {
+    'Roast'=>['Light', 'Medium', 'Dark', 'Extra Dark'],
+    'Style'=>['Cappuccino', 'Espresso', 'Latte', 'Mocha']}
+  
+  puts coffee.to_yaml(stylers: CoffeeStyler.new)
+  
+  # Output:
+  # ---
+  # Roast: [Light, Medium, Dark, Extra Dark]
+  # Style: [Cappuccino, Espresso, Latte, Mocha]
+
+Class example:
+  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
+  end
+  
+  puts Coffee.new.to_yaml
+  
+  # Output:
+  # --- !ruby/object:Coffee
+  # roast: [Light, Medium, Dark, Extra Dark]
+  # style: [Cappuccino, Espresso, Latte, Mocha]
+
+The produced YAML without Psychgus styling (i.e., without CoffeeStyler):
+  # ---
+  # Roast:
+  # - Light
+  # - Medium
+  # - Dark
+  # - Extra Dark
+  # Style:
+  # - Cappuccino
+  # - Espresso
+  # - Latte
+  # - Mocha
+  EOS
+  
+  spec.files         = Dir.glob("{lib,test,yard}/**/*") + %w(
+                         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
+end

data/test/blueberry_test.rb

@@ -0,0 +1,141 @@
+#!/usr/bin/env ruby
+# 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/>.
+#++
+
+
+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
+end
+
+class Burgers
+  attr_accessor :burgers
+  attr_accessor :toppings
+  
+  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)]
+    ]
+  end
+  
+  def encode_with(coder)
+    coder['Burgers'] = @burgers
+    coder['Toppings'] = @toppings
+  end
+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?()
+      # 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()
+  end
+  
+  def test_blueberry()
+    expected = <<-EOY
+    |--- !ruby/object:Burgers
+    |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
+    |- - Lettuce
+    |  - Onions
+    |  - Pickles
+    |  - Tomatoes
+    |- - - Ketchup
+    |    - Mustard
+    |  - - Salt
+    |    - Pepper
+    EOY
+    expected = self.class.lstrip_pipe(expected)
+    
+    assert_equal expected,@burgers.to_yaml()
+  end
+end

data/test/psychgus_test.rb

@@ -0,0 +1,142 @@
+#!/usr/bin/env ruby
+# 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/>.
+#++
+
+
+require 'psychgus_tester'
+
+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
+---
+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
+- [Lettuce, Onions, Pickles, Tomatoes]
+- [[Ketchup, Mustard], [Salt, Pepper]]
+  EOY
+  
+  def setup()
+    @flow_styler = FlowStyler.new()
+  end
+  
+  def test_alias()
+    expected = <<-EOY
+    |---
+    |Dolphins:
+    |  Common: {Length: "~2.5m", Weight: "~235kg"}
+    |  Bottlenose: {Length: "~4m", Weight: "~300kg"}
+    |  Dusky: {Length: "~1.7m", Weight: "~78kg"}
+    |  Orca: {Length: "~7m", Weight: "~3600kg"}
+    |Popular:
+    |- {Length: "~4m", Weight: "~300kg"}
+    |- {Length: "~7m", Weight: "~3600kg"}
+    EOY
+    expected = self.class.lstrip_pipe(expected)
+    
+    assert_equal expected,DOLPHINS_DATA.to_yaml(deref_aliases: true,stylers: @flow_styler)
+  end
+  
+  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()
+    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()
+      assert_equal EXPECTED_BURGERS,lines
+      
+      file.rewind()
+      data = Psych.load_file(file)
+      refute_equal false,data
+    end
+  end
+  
+  def test_indent()
+    # Indent of 3 spaces
+    expected = <<-EOY
+    |---
+    |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
+    |- [Lettuce, Onions, Pickles, Tomatoes]
+    |- [[Ketchup, Mustard], [Salt, Pepper]]
+    EOY
+    expected = self.class.lstrip_pipe(expected)
+    
+    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})
+  end
+  
+  def test_node_consts()
+    assert_equal Psych::Nodes::Mapping::FLOW,Psychgus::MAPPING_FLOW
+    assert_equal Psych::Nodes::Scalar::FOLDED,Psychgus::SCALAR_FOLDED
+    assert_equal Psych::Nodes::Sequence::FLOW,Psychgus::SEQUENCE_FLOW
+    assert_equal Psych::Nodes::Stream::UTF8,Psychgus::STREAM_UTF8
+  end
+  
+  def test_parse()
+    parser = Psychgus.parser(stylers: @flow_styler)
+    parser.parse(BURGERS_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 = "---\n#{yaml}"
+    assert_equal EXPECTED_BURGERS,yaml
+  end
+end

data/test/psychgus_tester.rb

@@ -0,0 +1,90 @@
+#!/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/>.
+#++
+
+
+require 'minitest/autorun'
+
+require 'psychgus'
+
+# Changing the YAML/data will break tests
+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()
+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
+  - [Lettuce, Onions, Pickles, Tomatoes]
+  - [[Ketchup,Mustard], [Salt,Pepper]]
+  EOY
+  BURGERS_DATA = Psych.load(BURGERS_YAML).freeze()
+  
+  COURSES_YAML = <<-EOY.freeze()
+Courses:
+  COSC: [470,'Computer Science']
+  MUSC: [340,'Music']
+  ARTS: [250,'The Arts']
+Schedule:
+- {Course: COSC,Time: '08:00'}
+- {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()
+Dolphins:
+  Common:     &com {Length: ~2.5m, Weight:  ~235kg}
+  Bottlenose: &bot {Length:   ~4m, Weight:  ~300kg}
+  Dusky:      &dus {Length: ~1.7m, Weight:   ~78kg}
+  Orca:       &orc {Length:   ~7m, Weight: ~3600kg}
+Popular:
+  - *bot
+  - *orc
+  EOY
+  DOLPHINS_DATA = Psych.load(DOLPHINS_YAML).freeze()
+  
+  # This is for "<<-" heredoc
+  # - Purposely not using "<<~" (tilde) for older Ruby versions
+  def self.lstrip_pipe(str)
+    return str.gsub(/^\s*\|/,'')
+  end
+end