psychgus 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b9e7e5d21e498f39d61b2b83765879dd6c564cc2742b121dfdeb9f5b8051578
-  data.tar.gz: 13ef8c78dc13bcce6596534e2b94557033438289a86e459834b4d7acf0afb9c1
+  metadata.gz: 45e44e424ed93bfb0d7bfc839e749576112b893f11d7e92a013fad608a95fc00
+  data.tar.gz: 0fea838c43246424d747dd778d834c8e879cffcf265bdbcd136c9b8d170c8537
 SHA512:
-  metadata.gz: abfc0427ed29d4e3d811476a2c957f7961a85fbb0445b558d3b1356f018b12b52026a6b268b9f23384aa0a9fd20e3c720a30091448ea1659c8ddb8298e5c3b74
-  data.tar.gz: ef2db56b9b41bc3aa3f81f3a033e5aaf9508578d9aa63e5de10e978950fa9c860f77ca39ffa8c0077409149f87059faa515b51080290bf59f8e9a53dc74d366a
+  metadata.gz: b434a4da0294268f31a7452f267901f93deb686eeb92ae16b9049cf2a143902aa2e09c3c73464dc077109edfd1b2afda5fc045c9e25344d54d9bfa86b73926ec
+  data.tar.gz: 49df65fe217e187e00564e8df18730e7cb8afbdf432a58173787a93ff775218300677b7fbe5b0133d34ddc6ab3a254cd0d034d075efb09c152de26a1254aa813

data/CHANGELOG.md

@@ -2,7 +2,21 @@
 
 Format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
-## [[Unreleased]](https://github.com/esotericpig/psychgus/compare/v1.2.0...master)
+## [[Unreleased]](https://github.com/esotericpig/psychgus/compare/v1.2.1...master)
+
+## [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
 

data/README.md

@@ -3,6 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/psychgus.svg)](https://badge.fury.io/rb/psychgus)
 
 [![Documentation](https://img.shields.io/badge/doc-yard-%23A0522D.svg?style=for-the-badge)](https://esotericpig.github.io/docs/psychgus/yardoc/index.html)
+[![Source Code](https://img.shields.io/badge/source-github-%23A0522D.svg?style=for-the-badge)](https://github.com/esotericpig/psychgus)
 [![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)
 
@@ -92,7 +93,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.
 

data/Rakefile

@@ -15,13 +15,14 @@
 # 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/>.
+# along with Psychgus.  If not, see <https://www.gnu.org/licenses/>.
 #++
 
 
 require 'bundler/gem_tasks'
 
 require 'yard'
+require 'yard_ghurt'
 
 require 'psychgus/version'
 
@@ -33,34 +34,18 @@ 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
+YardGhurt::GHPSyncTask.new(:ghp_doc) do |task|
+  task.description = %q(Rsync "doc/" to my GitHub Page's repo; not useful for others)
   
-  if !args.deploy
-    puts
-    puts 'Execute "rake ghp_doc[true]" for actually deploying (non-dry-run)'
-  end
+  task.ghp_dir = '../esotericpig.github.io/docs/psychgus/yardoc'
+  task.sync_args << '--delete-after'
 end
 
 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
@@ -78,83 +63,33 @@ end
 
 # Execute "rake clobber yard" for pristine docs
 YARD::Rake::YardocTask.new() do |task|
-  task.files = ['lib/**/*.rb']
+  task.files = [File.join('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/']
+  task.options += ['--template-path',File.join('yard','templates')]
   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')
+YardGhurt::GFMFixTask.new(:yard_fix) do |task|
+  task.description = 'Fix (find & replace) text in the YARD files for GitHub differences'
   
-  ['doc/index.html'].each do |filename|
-    puts "File [#{filename}]:"
-    
-    lines = []
-    write = false
+  task.arg_names = [:dev]
+  task.dry_run = false
+  task.fix_code_langs = true
+  task.md_files = ['index.html']
+  
+  task.before = Proc.new() do |task,args|
+    # Delete this file as it's never used (index.html is an exact copy)
+    YardGhurt.rm_exist(File.join(task.doc_dir,'file.README.html'))
     
-    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
+    # Root dir of my GitHub Page for CSS/JS
+    GHP_ROOT = YardGhurt.to_bool(args.dev) ? '../../esotericpig.github.io' : '../../..'
     
-    if write
-      File.open(filename,'w') do |file|
-        file.puts lines
-      end
-    end
+    task.css_styles << %Q(<link rel="stylesheet" type="text/css" href="#{GHP_ROOT}/css/prism.css" />)
+    task.js_scripts << %Q(<script src="#{GHP_ROOT}/js/prism.js"></script>)
   end
 end
 

data/lib/psychgus.rb

@@ -311,10 +311,8 @@ require 'psychgus/super_sniffer/parent'
 ###
 module Psychgus
   # Include these in the top namespace for convenience (i.e., less typing).
-  # 
-  # @since 1.2.0
-  include Stylables
-  include Stylers
+  include Stylables # @since 1.2.0
+  include Stylers # @since 1.2.0
   
   NODE_CLASS_ALIASES = {:Doc => :Document,:Map => :Mapping,:Seq => :Sequence}
   OPTIONS_ALIASES = {:canon => :canonical,:indent => :indentation}

data/lib/psychgus/super_sniffer.rb

@@ -52,16 +52,18 @@ module Psychgus
   # 
   # Most information is straightforward:
   # - {#aliases}   # Array of Psych::Nodes::Alias processed so far
+  # - {#documents} # Array of Psych::Nodes::Document processed so far
   # - {#mappings}  # Array of Psych::Nodes::Mapping processed so far
-  # - {#nodes}     # Array of all Psych::Nodes::Node processed so far
+  # - {#nodes}     # Array of Psych::Nodes::Node processed so far
   # - {#scalars}   # Array of Psych::Nodes::Scalar processed so far
   # - {#sequences} # Array of Psych::Nodes::Sequence processed so far
+  # - {#streams}   # Array of Psych::Nodes::Stream processed so far
   # 
   # {#parent} is the current {SuperSniffer::Parent} of the node being processed,
-  # which is nil for the first node.
+  # which is an empty Parent for the first node (not nil).
   # 
   # {#parents} are all of the (grand){SuperSniffer::Parent}(s) for the current node,
-  # which is empty for the first node.
+  # which is an Array that just contains an empty Parent for the first node.
   # 
   # A parent is a Mapping or Sequence, or a Key (Scalar) in a Mapping.
   # 
@@ -136,7 +138,7 @@ module Psychgus
   #        (6:1):Salt - <seq:(5:2)>
   #        (6:2):Pepper - <seq:(5:2)>
   # 
-  # The "Super Sniffer" is the nickname for Gus's nose from the TV show Psych
+  # "The Super Sniffer" is the nickname for Gus's nose from the TV show Psych
   # because he has a very refined sense of smell.
   # 
   # @note You should never call the methods that are not readers, like {#add_alias}, {#start_mapping}, etc.
@@ -152,17 +154,17 @@ module Psychgus
   class SuperSniffer
     EMPTY = Empty.new().freeze()
     
-    attr_reader :aliases
-    attr_reader :documents
-    attr_reader :level
-    attr_reader :mappings
-    attr_reader :nodes
-    attr_reader :parent
-    attr_reader :parents
-    attr_reader :position
-    attr_reader :scalars
-    attr_reader :sequences
-    attr_reader :streams
+    attr_reader :aliases # @return [Array<Psych::Nodes::Alias>] the aliases processed so far
+    attr_reader :documents # @return [Array<Psych::Nodes::Document>] the documents processed so far
+    attr_reader :level # @return [Integer] the current level
+    attr_reader :mappings # @return [Array<Psych::Nodes::Mapping>] the mappings processed so far
+    attr_reader :nodes # @return [Array<Psych::Nodes::Node>] the nodes processed so far
+    attr_reader :parent # @return [Parent] the current parent
+    attr_reader :parents # @return [Array<Parent>] the current (grand)parents
+    attr_reader :position # @return [Integer] the current position
+    attr_reader :scalars # @return [Array<Psych::Nodes::Scalar>] the scalars processed so far
+    attr_reader :sequences # @return [Array<Psych::Nodes::Sequence>] the sequences processed so far
+    attr_reader :streams # @return [Array<Psych::Nodes::Stream>] the streams processed so far
     
     # Initialize this class for sniffing.
     def initialize()

data/lib/psychgus/version.rb

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

data/psychgus.gemspec

@@ -16,7 +16,7 @@
 # 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/>.
+# along with Psychgus.  If not, see <https://www.gnu.org/licenses/>.
 #++
 
 
@@ -25,14 +25,14 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'psychgus/version'
 
-Gem::Specification.new do |spec|
+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.homepage    = 'https://github.com/esotericpig/psychgus'
-  spec.summary     = %q(Easily style YAML files using Psych, like Sequence/Mapping Flow style.)
+  spec.summary     = %q(Easily style YAML files using Psych.)
   spec.description = %q(Easily style YAML files using Psych, like Sequence/Mapping Flow style.)
   
   spec.metadata = {
@@ -43,25 +43,22 @@ Gem::Specification.new do |spec|
     '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.files = Dir.glob(File.join("{#{spec.require_paths.join(',')}}",'**','*.{erb,rb}')) +
+               Dir.glob(File.join('{test,yard}','**','*.{erb,rb}')) +
+               %W( Gemfile #{spec.name}.gemspec Rakefile ) +
+               %w( CHANGELOG.md LICENSE.txt README.md )
+  
   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.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.5'  # For Markdown for YARD (*.md)
+  spec.add_development_dependency 'yard'      ,'~> 0.9'  # For documentation
+  spec.add_development_dependency 'yard_ghurt','~> 1.1'  # For YARD GitHub rake tasks
 end

data/test/psychgus_test.rb

@@ -120,10 +120,25 @@ Toppings:
   end
   
   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()

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: psychgus
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Jonathan Bradley Whited (@esotericpig)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-11 00:00:00.000000000 Z
+date: 2019-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard_ghurt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 description: Easily style YAML files using Psych, like Sequence/Mapping Flow style.
 email:
 - bradley@esotericpig.com
@@ -166,8 +180,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.1
 signing_key: 
 specification_version: 4
-summary: Easily style YAML files using Psych, like Sequence/Mapping Flow style.
+summary: Easily style YAML files using Psych.
 test_files: []