psychgus 1.0.1 → 1.2.0

data/lib/psychgus/super_sniffer.rb

@@ -89,7 +89,7 @@ module Psychgus
   # Then the levels and positions will be as follows:
   #   # (level:position):current_node - <parent:(parent_level:parent_position)>
   #   
-  #   (1:1):Psych::Nodes::Stream - <nil>
+  #   (1:1):Psych::Nodes::Stream - <root:(0:0)>
   #   (1:1):Psych::Nodes::Document - <stream:(1:1)>
   #   (1:1):Psych::Nodes::Mapping - <doc:(1:1)>
   #    (2:1):Burgers - <map:(1:1)>
@@ -168,15 +168,18 @@ module Psychgus
     def initialize()
       @aliases = []
       @documents = []
-      @level = 1
+      @level = 0
       @mappings = []
       @nodes = []
       @parent = nil
       @parents = []
-      @position = 1
+      @position = 0
       @scalars = []
       @sequences = []
       @streams = []
+      
+      # Do not pass in "top_level: true"
+      start_parent(nil,debug_tag: :root)
     end
     
     # Add a Psych::Nodes::Alias to this class only (not to the YAML).
@@ -406,7 +409,7 @@ module Psychgus
       @parent = Parent.new(self,node,**extra)
       
       @parents.push(@parent)
-      @nodes.push(node)
+      @nodes.push(node) unless node.nil?()
       
       if top_level
         @level = 1

data/lib/psychgus/super_sniffer/parent.rb

@@ -85,34 +85,34 @@ module Psychgus
       # @see Psych::Nodes::Scalar#anchor=
       # @see Psych::Nodes::Sequence#anchor=
       def anchor=(anchor)
-        node.anchor = anchor
+        @node.anchor = anchor
       end
       
       # @see Psych::Nodes::Scalar#plain=
       def plain=(plain)
-        node.plain = plain
+        @node.plain = plain
       end
       
       # @see Psych::Nodes::Scalar#quoted=
       def quoted=(quoted)
-        node.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
+        @node.style = style
       end
       
       # @see Psych::Nodes::Node#tag=
       def tag=(tag)
-        node.tag = tag
+        @node.tag = tag
       end
       
       # @see Psych::Nodes::Scalar#value=
       def value=(value)
-        node.value = value
+        @node.value = value
       end
       
       # @see Psych::Nodes::Alias#anchor
@@ -120,86 +120,104 @@ module Psychgus
       # @see Psych::Nodes::Scalar#anchor
       # @see Psych::Nodes::Sequence#anchor
       def anchor()
-        return node.anchor
+        return @node.anchor
+      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?()
+        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?()
+        return @child_type == :value
       end
       
       # @see Psych::Nodes::Stream#encoding
       def encoding()
-        return node.encoding
+        return @node.encoding
       end
       
       # @see Psych::Nodes::Node#end_column
       def end_column()
-        return node.end_column
+        return @node.end_column
       end
       
       # @see Psych::Nodes::Node#end_line
       def end_line()
-        return node.end_line
+        return @node.end_line
       end
       
       # @see Psych::Nodes::Document#implicit
       # @see Psych::Nodes::Mapping#implicit
       # @see Psych::Nodes::Sequence#implicit
       def implicit?()
-        return node.implicit
+        return @node.implicit
       end
       
       # @see Psych::Nodes::Document#implicit_end
       def implicit_end?()
-        return node.implicit_end
+        return @node.implicit_end
       end
       
       # (see Ext::NodeExt#node_of?)
       def node_of?(*names)
-        return node.node_of?(*names)
+        return @node.node_of?(*names)
       end
       
       # @see Psych::Nodes::Scalar#plain
       def plain?()
-        return node.plain
+        return @node.plain
       end
       
       # @see Psych::Nodes::Scalar#quoted
       def quoted?()
-        return node.quoted
+        return @node.quoted
       end
       
       # @see Psych::Nodes::Node#start_column
       def start_column()
-        return node.start_column
+        return @node.start_column
       end
       
       # @see Psych::Nodes::Node#start_line
       def start_line()
-        return node.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
+        return @node.style
       end
       
       # @see Psych::Nodes::Node#tag
       def tag()
-        return node.tag
+        return @node.tag
       end
       
       # @see Psych::Nodes::Document#tag_directives
       def tag_directives()
-        return node.tag_directives
+        return @node.tag_directives
       end
       
       # @see Psych::Nodes::Scalar#value
       def value()
-        return node.value
+        return @node.value
       end
       
       # @see Psych::Nodes::Document#version
       def version()
-        return node.version
+        return @node.version
       end
       
       # @note If this method is modified, then tests will fail

data/lib/psychgus/version.rb

@@ -23,5 +23,5 @@
 
 module Psychgus
   # Version of this gem in "#.#.#" format
-  VERSION = '1.0.1'
+  VERSION = '1.2.0'
 end

data/psychgus.gemspec

@@ -26,30 +26,32 @@ $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.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.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.metadata = {
     '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.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.files         = Dir.glob("{lib,test,yard}/**/*") + %w(
-                         Gemfile
-                         LICENSE.txt
-                         psychgus.gemspec
-                         Rakefile
-                         README.md
-                       )
+  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'

data/test/sniffer_test.rb

@@ -24,46 +24,20 @@ require 'psychgus_tester'
 
 require 'stringio'
 
-class IOStyler
-  include Psychgus::Styler
-  
-  attr_reader :io
-  
-  def initialize(io=StringIO.new())
-    @io = io
-  end
-  
-  def style(sniffer,node)
-    (1...sniffer.level).each do
-      @io.print ' '
-    end
-    
-    name = node.node_of?(:scalar) ? node.value : node.class.name
-    parent = sniffer.parent
-    
-    @io.print "(#{sniffer.level}:#{sniffer.position}):#{name} - "
-    @io.print parent.nil?() ? '<nil>' : parent
-    @io.puts
-  end
-end
-
 class SnifferTest < PsychgusTester
   def setup()
   end
   
-  def assert_hierarchy(data,expected)
+  def assert_hierarchy(*data,expected)
     expected = self.class.lstrip_pipe(expected)
-    io_styler = IOStyler.new()
-    
-    data.to_yaml(stylers: io_styler)
-    hierarchy = io_styler.io.string
+    hierarchy = Psychgus.hierarchy(*data,verbose: true)
     
     assert_equal expected,hierarchy
   end
   
   def test_multi_doc()
-    expected = <<-EOH
-    |(1:1):Psych::Nodes::Stream - <nil>
+    assert_hierarchy(BURGERS_DATA,COURSES_DATA,DOLPHINS_DATA,<<-EOH
+    |(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)>
     | (2:1):Burgers - <map:(1:1):key:(:1)>
@@ -180,19 +154,12 @@ class SnifferTest < PsychgusTester
     |   (4:1):Psych::Nodes::Alias - <seq:(3:1)::(:1)>
     |   (4:2):Psych::Nodes::Alias - <seq:(3:1)::(:2)>
     EOH
-    
-    expected = self.class.lstrip_pipe(expected)
-    io_styler = IOStyler.new()
-    
-    Psychgus.dump_stream(BURGERS_DATA,COURSES_DATA,DOLPHINS_DATA,stylers: io_styler)
-    hierarchy = io_styler.io.string
-    
-    assert_equal expected,hierarchy
+    )
   end
   
   def test_single_docs()
     assert_hierarchy(BURGERS_DATA,<<-EOH
-    |(1:1):Psych::Nodes::Stream - <nil>
+    |(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)>
     | (2:1):Burgers - <map:(1:1):key:(:1)>
@@ -242,7 +209,7 @@ class SnifferTest < PsychgusTester
     )
     
     assert_hierarchy(COURSES_DATA,<<-EOH
-    |(1:1):Psych::Nodes::Stream - <nil>
+    |(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)>
     | (2:1):Courses - <map:(1:1):key:(:1)>

data/test/stylers_test.rb

@@ -0,0 +1,93 @@
+#!/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 EggCarton
+  include Psychgus::Blueberry
+  
+  def initialize()
+    @eggs = {
+      :styles => ['omelette','BBQ eggs','hard-boiled eggs','soft_boiled eggs','fried@eggs'],
+      :colors => ['brown','white',['blue','green']]
+    }
+  end
+  
+  def psychgus_stylers(sniffer)
+    return Psychgus::FlowStyler.new(4)
+  end
+end
+
+###
+# @since 1.2.0
+###
+class StylersTest < PsychgusTester
+  def setup()
+    @egg_carton = EggCarton.new()
+  end
+  
+  def test_capstyler()
+    actual = @egg_carton.to_yaml(stylers: Psychgus::CapStyler.new(each_word: false))
+    expected = <<-EOY
+    |--- !ruby/object:EggCarton
+    |Eggs:
+    |  :styles: [Omelette, BBQ eggs, Hard-boiled eggs, Soft_boiled eggs, Fried@eggs]
+    |  :colors: [Brown, White, [Blue, Green]]
+    EOY
+    
+    assert_equal self.class.lstrip_pipe(expected),actual
+    
+    actual = @egg_carton.to_yaml(stylers: Psychgus::CapStyler.new(new_delim: '+',delim: /[\s_\-@]/))
+    expected = <<-EOY
+    |--- !ruby/object:EggCarton
+    |Eggs:
+    |  :styles: [Omelette, BBQ+Eggs, Hard+Boiled+Eggs, Soft+Boiled+Eggs, Fried+Eggs]
+    |  :colors: [Brown, White, [Blue, Green]]
+    EOY
+    
+    assert_equal self.class.lstrip_pipe(expected),actual
+  end
+  
+  def test_nosymstyler()
+    actual = @egg_carton.to_yaml(stylers: Psychgus::NoSymStyler.new())
+    expected = <<-EOY
+    |--- !ruby/object:EggCarton
+    |eggs:
+    |  Styles: [omelette, BBQ eggs, hard-boiled eggs, soft_boiled eggs, fried@eggs]
+    |  Colors: [brown, white, [blue, green]]
+    EOY
+    
+    assert_equal self.class.lstrip_pipe(expected),actual
+  end
+  
+  def test_notagstyler()
+    actual = @egg_carton.to_yaml(stylers: Psychgus::NoTagStyler.new())
+    expected = <<-EOY
+    |---
+    |eggs:
+    |  :styles: [omelette, BBQ eggs, hard-boiled eggs, soft_boiled eggs, fried@eggs]
+    |  :colors: [brown, white, [blue, green]]
+    EOY
+    
+    assert_equal self.class.lstrip_pipe(expected),actual
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: psychgus
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Jonathan Bradley Whited (@esotericpig)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-03 00:00:00.000000000 Z
+date: 2019-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -115,6 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -125,9 +126,11 @@ files:
 - lib/psychgus/ext/core_ext.rb
 - lib/psychgus/ext/node_ext.rb
 - lib/psychgus/ext/yaml_tree_ext.rb
+- lib/psychgus/stylables.rb
 - lib/psychgus/styled_document_stream.rb
 - lib/psychgus/styled_tree_builder.rb
 - lib/psychgus/styler.rb
+- lib/psychgus/stylers.rb
 - lib/psychgus/super_sniffer.rb
 - lib/psychgus/super_sniffer/parent.rb
 - lib/psychgus/version.rb
@@ -137,12 +140,14 @@ files:
 - test/psychgus_tester.rb
 - test/sniffer_test.rb
 - test/styler_test.rb
+- test/stylers_test.rb
 - yard/templates/default/layout/html/footer.erb
 homepage: https://github.com/esotericpig/psychgus
 licenses:
 - LGPL-3.0-or-later
 metadata:
   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