yard_ghurt 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1d7c4b6840acda446635ca65f73e5dcd8c07b1ea4faa61b7024eb7b13641f99
-  data.tar.gz: c5e06179e90a77d8c485c9772f5f8d9c8ddd6ac63aabd659fd845ebdc643b659
+  metadata.gz: '09e5e44f79301b48fc0c128b2c28f92ed6214dde2e6ea95c4a251c658eba1c41'
+  data.tar.gz: 9ae774c08a531397baac550dd52facda1d82cbc3614ec74b5737dfd3940f4acf
 SHA512:
-  metadata.gz: 5171490ed25ff1746a6c0b2fb4b606450e59075e3d2fa03d3d3cb159a25a323e106ced97096a431796f98aa106b6e891d5ec757ecec8ebd431b732c9c2d6714d
-  data.tar.gz: 11c61d3c8e1a89cda1259a2a9b67f946e7c927793cf1c49ec511da0e368e46d18cc02dcdb46edc3578a13d0156fc6bd90faea4d96fe3e1452be653a25a59520f
+  metadata.gz: 2bd582fde644bc58bf50734da87a79f3579b8c78563badd8b4dded47b234c93d54561f871563640f2a912f412d929a43dfc001bb8a721f711c23c19bba89b050
+  data.tar.gz: f803e9360a6205b5c8af74eb548e64e5c7e00ab5cd7b8a356733db0107c7d6c854f357a79bbc376ed67f7c571a6fa3068129f93b34222924e24ef3538390a712

data/CHANGELOG.md

@@ -2,7 +2,15 @@
 
 Format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
-## [[Unreleased]](https://github.com/esotericpig/yard_ghurt/compare/v1.0.0...master)
+## [[Unreleased]](https://github.com/esotericpig/yard_ghurt/compare/v1.0.1...master)
+
+## [v1.0.1] - 2019-07-28
+### Changed
+- Some minor comments/doc
+- Refactored the Gemspec (minor)
+
+### Fixed
+- In GFMFixerTask, ignore empty lines
 
 ## [v1.0.0] - 2019-07-23
 ### Added

data/README.md

@@ -18,7 +18,7 @@
 - [Using](#using)
     - [GFMFixerTask](#gfmfixertask)
     - [GHPSyncerTask](#ghpsyncertask)
-    - [YardGhurt / Util](#yardghurt--util)
+    - [Util / YardGhurt](#util--yardghurt)
     - [AnchorLinks](#anchorlinks)
 - [Hacking](#hacking)
     - [Testing](#testing)
@@ -70,7 +70,7 @@ $ bundle exec rake install:local
 
 | Helper | Description |
 | --- | --- |
-| [YardGhurt / Util](#yardghurt--util) | Utility methods for tasks |
+| [Util / YardGhurt](#util--yardghurt) | Utility methods for tasks |
 | [AnchorLinks](#anchorlinks) | A “database” of anchor links |
 
 ### [GFMFixerTask](#using)
@@ -160,30 +160,31 @@ YardGhurt::GHPSyncerTask.new(:ghp_doc) do |task|
 end
 ```
 
-### [YardGhurt / Util](#using)
+### [Util / YardGhurt](#using)
 
 Utility methods for tasks.
 
 ```Ruby
-require 'yard_ghurt'
+require 'yard_ghurt/util'
 
-# If the file exists, delete it, and if output is true, log it to stdout
-YardGhurt.rm_exist('doc/file.README.html')
-YardGhurt.rm_exist('doc/file.README.html',false)
+# If the file exists, delete it, and if +output+ is true, log it to stdout
+YardGhurt::Util.rm_exist('doc/file.README.html')
+YardGhurt::Util.rm_exist('doc/file.README.html',false)
 
 # Convert an Object to true or false
-puts YardGhurt.to_bool('true') # true
-puts YardGhurt.to_bool('on')   # true
-puts YardGhurt.to_bool('yes')  # true
+puts YardGhurt::Util.to_bool('true') # true
+puts YardGhurt::Util.to_bool('on')   # true
+puts YardGhurt::Util.to_bool('yes')  # true
+puts YardGhurt::Util.to_bool(nil)    # false
 ```
 
-If you don't want to include all of the Tasks and Helpers, then you should include and use `yard_ghurt/util` instead:
+For convenience, *Util*'s methods are also included in the top module *YardGhurt*. However, this will also include all of the Tasks and Helpers, so *Util* is preferred, unless you're already requiring *yard_ghurt*.
 
 ```Ruby
-require 'yard_ghurt/util'
+require 'yard_ghurt'
 
-YardGhurt::Util.rm_exist('doc/file.README.html')
-puts YardGhurt::Util.to_bool('true')
+YardGhurt.rm_exist('doc/file.README.html')
+puts YardGhurt.to_bool('true')
 ```
 
 ### [AnchorLinks](#using)

data/lib/yard_ghurt/gfm_fixer_task.rb

@@ -340,6 +340,9 @@ module YardGhurt
           next if line !~ /<h\d+>/i
           
           line.gsub!(/<[^>]+>/,'') # Remove tags: <...>
+          line.strip!()
+          
+          next if line.empty?()
           
           @anchor_links << line
         end
@@ -367,6 +370,12 @@ module YardGhurt
       
       File.open(filename,'r') do |file|
         file.each_line do |line|
+          if line.strip().empty?()
+            lines << line
+            
+            next
+          end
+          
           has_change = false
           
           # Standard
@@ -476,9 +485,9 @@ module YardGhurt
       tag = 'href="#'
       
       line.gsub!(Regexp.new(Regexp.quote(tag) + '[^"]*"')) do |href|
-        link = href[tag.length..-2]
+        link = href[tag.length..-2].strip()
         
-        if @anchor_links.yard_anchor_id?(link)
+        if link.empty?() || @anchor_links.yard_anchor_id?(link)
           href
         else
           yard_link = @anchor_links[link]
@@ -523,9 +532,9 @@ module YardGhurt
       tag = 'code class="'
       
       line.gsub!(Regexp.new(Regexp.quote(tag) + '[^"]*"')) do |code_class|
-        lang = code_class[tag.length..-2]
+        lang = code_class[tag.length..-2].strip()
         
-        if lang =~ /^language\-/ || @exclude_code_langs.include?(lang)
+        if lang.empty?() || lang =~ /^language\-/ || @exclude_code_langs.include?(lang)
           code_class
         else
           has_change = true
@@ -576,15 +585,15 @@ module YardGhurt
       tag = 'href="'
       
       line.gsub!(Regexp.new(Regexp.quote(tag) + '[^#][^"]*"')) do |href|
-        link = href[tag.length..-2]
+        link = href[tag.length..-2].strip()
         
-        if File.exist?(link)
+        if link.empty?() || !File.exist?(link)
+          href
+        else
           link = File.basename(link,'.*')
           has_change = true
           
           %Q(#{tag}file.#{link}.html")
-        else
-          href
         end
       end
       

data/lib/yard_ghurt/ghp_syncer_task.rb

@@ -149,7 +149,7 @@ module YardGhurt
           raise ArgumentError,"#{self.class}.ghp_dir must be set"
         end
         
-        sh *build_sh_cmd(deploy)
+        sh(*build_sh_cmd(deploy))
         
         if !deploy
           puts

data/lib/yard_ghurt/util.rb

@@ -32,7 +32,8 @@ module YardGhurt
   # 
   # All internal code should use this module.
   # 
-  # All external code should use {YardGhurt}, which includes this module as a mixin.
+  # External code can either use this module or {YardGhurt},
+  # which includes this module as a mixin.
   # 
   # @author Jonathan Bradley Whited (@esotericpig)
   # @since  1.0.0

data/lib/yard_ghurt/version.rb

@@ -22,5 +22,5 @@
 
 
 module YardGhurt
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/lib/yard_ghurt.rb

@@ -35,7 +35,6 @@ require 'yard_ghurt/version'
 ###
 module YardGhurt
   # Internal code should use +Util.+!
-  # External code should use +YardGhurt.+, but can also use +YardGhurt::Util.+.
   # See {Util} for details.
   include Util
 end

data/yard_ghurt.gemspec

@@ -20,7 +20,7 @@
 #++
 
 
-lib = File.expand_path('../lib',__FILE__)
+lib = File.expand_path(File.join('..','lib'),__FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'yard_ghurt/version'
@@ -33,7 +33,7 @@ Gem::Specification.new() do |spec|
   spec.licenses    = ['LGPL-3.0-or-later']
   spec.homepage    = 'https://github.com/esotericpig/yard_ghurt'
   spec.summary     = 'YARDoc GitHub Rake Tasks'
-  spec.description = 'YARDoc GitHub Rake Tasks. Fix GitHub Flavored Markdown (GFM) files.'
+  spec.description = "#{spec.summary}. Fix GitHub Flavored Markdown (GFM) files."
   
   spec.metadata = {
     'bug_tracker_uri'   => 'https://github.com/esotericpig/yard_ghurt/issues',
@@ -45,7 +45,8 @@ Gem::Specification.new() do |spec|
   
   spec.require_paths = ['lib']
   
-  spec.files = Dir.glob(File.join("{#{spec.require_paths.join(',')},test,yard}",'**','*.{erb,rb}')) +
+  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 )
   

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard_ghurt
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jonathan Bradley Whited (@esotericpig)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-22 00:00:00.000000000 Z
+date: 2019-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake