yard_ghurt 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09e5e44f79301b48fc0c128b2c28f92ed6214dde2e6ea95c4a251c658eba1c41'
-  data.tar.gz: 9ae774c08a531397baac550dd52facda1d82cbc3614ec74b5737dfd3940f4acf
+  metadata.gz: eabd1d16b12b7055c9ab9a5c0bdc460281cc3cfe63b7b4e207e086ed30de30a6
+  data.tar.gz: 200b03f7a0a22016a8634dcb3b4d3e0854d97eb9714933ec6a339bb9651b281a
 SHA512:
-  metadata.gz: 2bd582fde644bc58bf50734da87a79f3579b8c78563badd8b4dded47b234c93d54561f871563640f2a912f412d929a43dfc001bb8a721f711c23c19bba89b050
-  data.tar.gz: f803e9360a6205b5c8af74eb548e64e5c7e00ab5cd7b8a356733db0107c7d6c854f357a79bbc376ed67f7c571a6fa3068129f93b34222924e24ef3538390a712
+  metadata.gz: acd5ef0039f8a3fce2f5c3ecf89a25259d38d2988585ac33a6aa1ad5540bae27ec1eb2833325c793f36df403f0db936576fce26e964750aea97fb2e8d8e67b0b
+  data.tar.gz: b47d674b37f759696fa23bea3b5d145c7d2561679a104bf3335df1af06a2943174f4bcc9e998bb917c04e633b94c6d67d361d8b974e9b7200289e9cb26da675c

data/CHANGELOG.md

@@ -2,7 +2,19 @@
 
 Format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
-## [[Unreleased]](https://github.com/esotericpig/yard_ghurt/compare/v1.0.1...master)
+## [[Unreleased]](https://github.com/esotericpig/yard_ghurt/compare/v1.1.0...master)
+
+## [v1.1.0] - 2019-07-31
+### Added
+- Added environment var *dryrun* to GFMFixTask:
+    - rake yard_gfm_fix dryrun=true
+
+### Changed
+- Renamed GFMFixerTask to GFMFixTask
+    - lib/yard_ghurt/gfm_fixer_task.rb => lib/yard_ghurt/gfm_fix_task.rb
+- Renamed GHPSyncerTask to GHPSyncTask
+    - lib/yard_ghurt/ghp_syncer_task.rb => lib/yard_ghurt/ghp_sync_task.rb
+- Updated development dependency gems
 
 ## [v1.0.1] - 2019-07-28
 ### Changed

data/README.md

@@ -16,8 +16,8 @@
 
 - [Setup](#setup)
 - [Using](#using)
-    - [GFMFixerTask](#gfmfixertask)
-    - [GHPSyncerTask](#ghpsyncertask)
+    - [GFMFixTask](#gfmfixtask)
+    - [GHPSyncTask](#ghpsynctask)
     - [Util / YardGhurt](#util--yardghurt)
     - [AnchorLinks](#anchorlinks)
 - [Hacking](#hacking)
@@ -63,8 +63,8 @@ $ bundle exec rake install:local
 
 | Task | Description |
 | --- | --- |
-| [GFMFixerTask](#gfmfixertask) | Fix GitHub Flavored Markdown files |
-| [GHPSyncerTask](#ghpsyncertask) | Sync YARDoc to a local GitHub Pages repo. |
+| [GFMFixTask](#gfmfixtask) | Fix GitHub Flavored Markdown files |
+| [GHPSyncTask](#ghpsynctask) | Sync YARDoc to a local GitHub Pages repo. |
 
 **Helpers:**
 
@@ -73,14 +73,18 @@ $ bundle exec rake install:local
 | [Util / YardGhurt](#util--yardghurt) | Utility methods for tasks |
 | [AnchorLinks](#anchorlinks) | A “database” of anchor links |
 
-### [GFMFixerTask](#using)
+### [GFMFixTask](#using)
 
 Fix (find & replace) text in the GitHub Flavored Markdown (GFM) files in the YARDoc directory, for differences between the two formats.
 
+You can set *dry_run* on the command line:
+
+`$ rake yard_gfm_fix dryrun=true`
+
 **What I typically use:**
 
 ```Ruby
-YardGhurt::GFMFixerTask.new() do |task|
+YardGhurt::GFMFixTask.new() do |task|
   task.arg_names = [:dev]
   task.dry_run = false
   task.fix_code_langs = true
@@ -102,7 +106,7 @@ end
 **Using all options:**
 
 ```Ruby
-YardGhurt::GFMFixerTask.new(:yard_fix) do |task|
+YardGhurt::GFMFixTask.new(:yard_fix) do |task|
   task.anchor_db           = {'tests' => 'Testing'} # #tests => #Testing
   task.arg_names          << :name # Custom args
   task.css_styles         << '<link rel="stylesheet" href="css/my_css.css" />' # Inserted at </head>
@@ -128,14 +132,14 @@ YardGhurt::GFMFixerTask.new(:yard_fix) do |task|
 end
 ```
 
-### [GHPSyncerTask](#using)
+### [GHPSyncTask](#using)
 
 Sync YARDoc to a local GitHub Pages repo (uses `rsync` by default).
 
 **What I typically use:**
 
 ```Ruby
-YardGhurt::GHPSyncerTask.new() do |task|
+YardGhurt::GHPSyncTask.new() do |task|
   task.ghp_dir = '../esotericpig.github.io/docs/yard_ghurt/yardoc'
   task.sync_args << '--delete-after'
 end
@@ -145,7 +149,7 @@ end
 
 ```Ruby
 # Execute: rake ghp_doc[false,'Ruby']
-YardGhurt::GHPSyncerTask.new(:ghp_doc) do |task|
+YardGhurt::GHPSyncTask.new(:ghp_doc) do |task|
   task.arg_names   << :name                      # Custom args
   task.deps        << :yard                      # Custom dependencies
   task.description  = 'Rsync my_doc/ to my page'

data/Rakefile

@@ -47,7 +47,7 @@ desc 'Generate pristine YARDoc'
 task :yard_fresh => [:clobber,:yard,:yard_gfm_fix] do |task|
 end
 
-YardGhurt::GFMFixerTask.new() do |task|
+YardGhurt::GFMFixTask.new() do |task|
   task.arg_names = [:dev]
   task.dry_run = false
   task.fix_code_langs = true
@@ -62,7 +62,7 @@ YardGhurt::GFMFixerTask.new() do |task|
 end
 
 # Probably not useful for others.
-YardGhurt::GHPSyncerTask.new() do |task|
+YardGhurt::GHPSyncTask.new() do |task|
   task.ghp_dir = '../esotericpig.github.io/docs/yard_ghurt/yardoc'
   task.sync_args << '--delete-after'
 end

data/lib/yard_ghurt.rb

@@ -22,8 +22,8 @@
 
 
 require 'yard_ghurt/anchor_links'
-require 'yard_ghurt/gfm_fixer_task'
-require 'yard_ghurt/ghp_syncer_task'
+require 'yard_ghurt/gfm_fix_task'
+require 'yard_ghurt/ghp_sync_task'
 require 'yard_ghurt/util'
 require 'yard_ghurt/version'
 

data/lib/yard_ghurt/anchor_links.rb

@@ -74,7 +74,7 @@ module YardGhurt
   # @author Jonathan Bradley Whited (@esotericpig)
   # @since  1.0.0
   # 
-  # @see GFMFixerTask
+  # @see GFMFixTask
   ###
   class AnchorLinks
     # @return [Hash] the GFM-style anchor IDs pointing to their YARDoc ID equivalents that have been added

data/lib/yard_ghurt/{gfm_fixer_task.rb → gfm_fix_task.rb}

@@ -27,14 +27,18 @@ require 'set'
 require 'rake/tasklib'
 
 require 'yard_ghurt/anchor_links'
+require 'yard_ghurt/util'
 
 module YardGhurt
   ###
   # Fix (find & replace) text in the GitHub Flavored Markdown (GFM) files in the YARDoc directory,
   # for differences between the two formats.
   # 
+  # You can set {dry_run} on the command line:
+  #   rake yard_gfm_fix dryrun=true
+  # 
   # @example What I Use
-  #   YardGhurt::GFMFixerTask.new() do |task|
+  #   YardGhurt::GFMFixTask.new() do |task|
   #     task.arg_names = [:dev]
   #     task.dry_run = false
   #     task.fix_code_langs = true
@@ -53,7 +57,7 @@ module YardGhurt
   #   end
   # 
   # @example Using All Options
-  #   YardGhurt::GFMFixerTask.new(:yard_fix) do |task|
+  #   YardGhurt::GFMFixTask.new(:yard_fix) do |task|
   #     task.anchor_db           = {'tests' => 'Testing'} # #tests => #Testing
   #     task.arg_names          << :name # Custom args
   #     task.css_styles         << '<link rel="stylesheet" href="css/my_css.css" />' # Inserted at </head>
@@ -79,9 +83,9 @@ module YardGhurt
   #   end
   # 
   # @author Jonathan Bradley Whited (@esotericpig)
-  # @since  1.0.0
+  # @since  1.1.0
   ###
-  class GFMFixerTask < Rake::TaskLib
+  class GFMFixTask < Rake::TaskLib
     # This is important so that a subsequent call to this task will not write the CSS again.
     # 
     # @return [String] the comment tag of where to place {css_styles}
@@ -305,6 +309,12 @@ module YardGhurt
     def define()
       desc @description
       task @name,Array(@arg_names) => Array(@deps) do |task,args|
+        env_dryrun = ENV['dryrun']
+        
+        if !env_dryrun.nil?() && !(env_dryrun = env_dryrun.to_s().strip()).empty?()
+          @dry_run = Util.to_bool(env_dryrun)
+        end
+        
         @before.call(self,args) if @before.respond_to?(:call)
         
         @md_files.each do |md_file|

data/lib/yard_ghurt/{ghp_syncer_task.rb → ghp_sync_task.rb}

@@ -32,14 +32,14 @@ module YardGhurt
   # Sync YARDoc to a local GitHub Pages repo (uses +rsync+ by default).
   # 
   # @example What I Use
-  #   YardGhurt::GHPSyncerTask.new() do |task|
+  #   YardGhurt::GHPSyncTask.new() do |task|
   #     task.ghp_dir = '../esotericpig.github.io/docs/yard_ghurt/yardoc'
   #     task.sync_args << '--delete-after'
   #   end
   # 
   # @example Using All Options
   #   # Execute: rake ghp_doc[false,'Ruby']
-  #   YardGhurt::GHPSyncerTask.new(:ghp_doc) do |task|
+  #   YardGhurt::GHPSyncTask.new(:ghp_doc) do |task|
   #     task.arg_names   << :name                      # Custom args
   #     task.deps        << :yard                      # Custom dependencies
   #     task.description  = 'Rsync my_doc/ to my page'
@@ -54,9 +54,9 @@ module YardGhurt
   #   end
   # 
   # @author Jonathan Bradley Whited (@esotericpig)
-  # @since  1.0.0
+  # @since  1.1.0
   ###
-  class GHPSyncerTask < Rake::TaskLib
+  class GHPSyncTask < Rake::TaskLib
     # @return [Proc,nil] the Proc ( +respond_to?(:call)+ ) to call at the end of this task or +nil+;
     #                    default: +nil+
     attr_accessor :after

data/lib/yard_ghurt/util.rb

@@ -25,7 +25,7 @@ module YardGhurt
   ###
   # Utility methods in a separate module/mixin,
   # so that a programmer can require/load a sole task:
-  #   require 'yard_ghurt/gfm_fixer_task'
+  #   require 'yard_ghurt/gfm_fix_task'
   # 
   # Else, programmers would be required to always require/load the entire +yard_ghurt+ module:
   #   require 'yard_ghurt'
@@ -70,7 +70,7 @@ module YardGhurt
       # @return [true,false] the boolean value of +str+
       # 
       # @see TRUE_BOOLS
-      # @see GHPSyncerTask#arg_names
+      # @see GHPSyncTask#arg_names
       def to_bool(str)
         return TRUE_BOOLS.include?(str.to_s().downcase())
       end

data/lib/yard_ghurt/version.rb

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

data/yard_ghurt.gemspec

@@ -56,6 +56,6 @@ Gem::Specification.new() do |spec|
   
   spec.add_development_dependency 'bundler'  ,'~> 1.17'
   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 'redcarpet','~> 3.5'  # For Markdown for YARD (*.md)
   spec.add_development_dependency 'yard'     ,'~> 0.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard_ghurt
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Jonathan Bradley Whited (@esotericpig)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-28 00:00:00.000000000 Z
+date: 2019-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -58,14 +58,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
@@ -94,8 +94,8 @@ files:
 - Rakefile
 - lib/yard_ghurt.rb
 - lib/yard_ghurt/anchor_links.rb
-- lib/yard_ghurt/gfm_fixer_task.rb
-- lib/yard_ghurt/ghp_syncer_task.rb
+- lib/yard_ghurt/gfm_fix_task.rb
+- lib/yard_ghurt/ghp_sync_task.rb
 - lib/yard_ghurt/util.rb
 - lib/yard_ghurt/version.rb
 - yard/templates/default/layout/html/footer.erb