yard_ghurt 1.2.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d6655a3fefa8677dd2b00ea73dbd7b87cf1c6d13b888ed67c29feb899f2555e
-  data.tar.gz: 52ffccc6f6a7d98e7865396b1c8c3e2b8c9a58452d3e724b0d0eb0c75e3495ab
+  metadata.gz: c2bfcf160b53592d1c17718a1811ade25bc5b9ca1a873f87f86cfecaa8978bb7
+  data.tar.gz: 927542fe06f6dd0945a172d7e5abf5118bd1cb712aeb0f04162d691f47c600dd
 SHA512:
-  metadata.gz: bcab8039ee10ff48858cd161483bbbc32ebe23a038f32303defe23081932ab4bc97b7e0d64a4de15307c14993cdf4d311d7385ed00a920af324b641b3e11d110
-  data.tar.gz: 31b278e7cbc842b3431eda53f8737bf957ff7068c4796ca984c0362040777b31f8542270e0844942b7a47906b464a41be7cf155712f4a9f1a05b2a41c391ad93
+  metadata.gz: b0b9ba1d972051bf73f3c36e6042ed40c150e4f7c98f55a2c2fcb4b43beae191f6a92da951f73494a7949e6dea3828d4ba6fb841bff43796ed0d937c04b06e53
+  data.tar.gz: 41bc4528945c3b394434f8926ae5bff3a5e965b8c402bbaf60cb510efaa10fd8061795a409a05b3e902a67cbc28f7a26aa471bd525af4b10c595dfb7eb77ceee

data/.yardopts

@@ -0,0 +1,5 @@
+--charset 'UTF-8'
+--embed-mixins
+--files 'LICENSE.txt,TODO.md'
+--protected
+--readme 'README.md'

data/Gemfile

@@ -1,25 +1,17 @@
 # encoding: UTF-8
 # frozen_string_literal: true
 
-#--
-# This file is part of YardGhurt.
-# Copyright (c) 2019 Jonathan Bradley Whited (@esotericpig)
-# 
-# YardGhurt 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.
-# 
-# YardGhurt 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 YardGhurt.  If not, see <https://www.gnu.org/licenses/>.
-#++
-
-
 source 'https://rubygems.org'
 
 gemspec
+
+group :development,:test do
+  gem 'bundler'  ,'~> 2.6'
+
+  gem 'rdoc'     ,'~> 6.14'  # For RDoc for YARD (*.rb).
+  gem 'redcarpet','~> 3.6'   # For Markdown for YARD (*.md).
+end
+
+group :test do
+  # gem 'minitest' ,'~> 5.25'
+end

data/README.md

@@ -1,189 +1,201 @@
 # YardGhurt
 
 [![Gem Version](https://badge.fury.io/rb/yard_ghurt.svg)](https://badge.fury.io/rb/yard_ghurt)
-
-[![Documentation](https://img.shields.io/badge/doc-yard-%23A0522D.svg?style=for-the-badge)](https://esotericpig.github.io/docs/yard_ghurt/yardoc/index.html)
-[![Source Code](https://img.shields.io/badge/source-github-%23A0522D.svg?style=for-the-badge)](https://github.com/esotericpig/yard_ghurt)
-[![Changelog](https://img.shields.io/badge/changelog-md-%23A0522D.svg?style=for-the-badge)](CHANGELOG.md)
-[![License](https://img.shields.io/github/license/esotericpig/yard_ghurt.svg?color=%23A0522D&style=for-the-badge)](LICENSE.txt)
+[![Documentation](https://img.shields.io/badge/doc-yard-%23A0522D.svg)](https://esotericpig.github.io/docs/yard_ghurt/yardoc/index.html)
+[![Source Code](https://img.shields.io/badge/source-github-%23211F1F.svg)](https://github.com/esotericpig/yard_ghurt)
+[![License](https://img.shields.io/github/license/esotericpig/yard_ghurt.svg)](LICENSE.txt)
 
 <u>YARD</u>oc <u>G</u>it<u>Hu</u>b <u>R</u>ake <u>T</u>asks
 
 - Fix GitHub Flavored Markdown files.
 - Sync YARDoc to a local GitHub Pages repo.
 
-## Contents
+## // Contents
 
-- [Setup](#setup)
-- [Using](#using)
-    - [GFMFixTask](#gfmfixtask)
-    - [GHPSyncTask](#ghpsynctask)
-    - [Util / YardGhurt](#util--yardghurt)
-    - [AnchorLinks](#anchorlinks)
-- [CLI App](#cli-app)
-- [Hacking](#hacking)
-    - [Testing](#testing)
-- [Tests](#tests)
-- [License](#license)
+- [Setup](#-setup)
+- [Using](#-using)
+  - [GFMFixTask](#-gfmfixtask)
+  - [GHPSyncTask](#-ghpsynctask)
+  - [Util / YardGhurt](#-util--yardghurt)
+  - [AnchorLinks](#-anchorlinks)
+- [CLI App](#-cli-app)
+- [Hacking](#-hacking)
+  - [Testing](#-testing)
+- [Tests](#-tests)
+- [License](#-license)
 
-## [Setup](#contents)
+## [//](#-contents) Setup
 
 Pick your poison...
 
 With the RubyGems CLI package manager:
 
-`$ gem install yard_ghurt`
+```bash
+gem install yard_ghurt
+```
 
-In your *Gemspec* (*&lt;project&gt;.gemspec*):
+In your *Gemspec*:
 
-```Ruby
+```ruby
 spec.add_development_dependency 'yard_ghurt', '~> X.X.X'
 ```
 
 In your *Gemfile*:
 
-```Ruby
-gem 'yard_ghurt', '~> X.X.X', :group => [:development, :test]
+```ruby
+gem 'yard_ghurt', '~> X.X.X', group: %i[development test]
 # or...
-gem 'yard_ghurt', :git => 'https://github.com/esotericpig/yard_ghurt.git',
-                  :tag => 'vX.X.X', :group => [:development, :test]
+gem 'yard_ghurt', git: 'https://github.com/esotericpig/yard_ghurt.git',
+                  branch: main, group: %i[development test]
 ```
 
-Manually:
+From source:
 
-```
-$ git clone 'https://github.com/esotericpig/yard_ghurt.git'
-$ cd yard_ghurt
-$ bundle install
-$ bundle exec rake install:local
+```bash
+git clone --depth 1 'https://github.com/esotericpig/yard_ghurt.git'
+cd yard_ghurt
+bundle install
+bundle exec rake install:local
 ```
 
-## [Using](#contents)
+## [//](#-contents) Using
+
+Currently, you can't use this project as a YARDoc Plugin, but planning on it for v2.0. Read the [TODO](TODO.md) for more info.
 
 **Rake Tasks:**
 
-| Task | Description |
-| --- | --- |
-| [GFMFixTask](#gfmfixtask) | Fix GitHub Flavored Markdown files |
-| [GHPSyncTask](#ghpsynctask) | Sync YARDoc to a local GitHub Pages repo. |
+| Task                         | Description                               |
+|------------------------------|-------------------------------------------|
+| [GFMFixTask](#-gfmfixtask)   | Fix GitHub Flavored Markdown files.       |
+| [GHPSyncTask](#-ghpsynctask) | Sync YARDoc to a local GitHub Pages repo. |
 
 **Helpers:**
 
-| Helper | Description |
-| --- | --- |
-| [Util / YardGhurt](#util--yardghurt) | Utility methods for tasks |
-| [AnchorLinks](#anchorlinks) | A “database” of anchor links |
+| Helper                                | Description                   |
+|---------------------------------------|-------------------------------|
+| [Util / YardGhurt](#-util--yardghurt) | Utility methods for tasks.    |
+| [AnchorLinks](#-anchorlinks)          | A “database” of anchor links. |
 
-### [GFMFixTask](#using)
+### [//](#-contents) GFMFixTask
 
 Fix (find & replace) text in the GitHub Flavored Markdown (GFM) files in the YARDoc directory, for differences between the two formats.
 
+**Very Important!**
+
+In order for this to work, you must also add `redcarpet` as a dependency (per YARDoc's documentation), else, you'll get a bunch of `label-*` relative links.
+
+```ruby
+gem 'redcarpet','~> X.X' # For YARDoc Markdown (*.md).
+```
+
 You can set *dry_run* on the command line:
 
-`$ rake yard_gfm_fix dryrun=true`
+```bash
+rake yard_gfm_fix dryrun=true
+```
 
 **What I typically use:**
 
-```Ruby
-YardGhurt::GFMFixTask.new() do |task|
-  task.arg_names = [:dev]
+```ruby
+YardGhurt::GFMFixTask.new do |task|
+  task.arg_names = %i[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'))
-    
-    # Root dir of my GitHub Page for CSS/JS
-    GHP_ROOT_DIR = YardGhurt.to_bool(args.dev) ? '../../esotericpig.github.io' : '../../..'
-    
-    task.css_styles << %Q(<link rel="stylesheet" type="text/css" href="#{GHP_ROOT_DIR}/css/prism.css" />)
-    task.js_scripts << %Q(<script src="#{GHP_ROOT_DIR}/js/prism.js"></script>)
+
+  task.before = proc do |task2,args|
+    # Delete this file as it's never used (`index.html` is an exact copy).
+    YardGhurt.rm_exist(File.join(task2.doc_dir,'file.README.html'))
+
+    # Root dir of my GitHub Page for CSS/JS.
+    ghp_root_dir = YardGhurt.to_bool(args.dev) ? '../../esotericpig.github.io' : '../../..'
+
+    task2.css_styles << %(<link rel="stylesheet" type="text/css" href="#{ghp_root_dir}/css/prism.css" />)
+    task2.js_scripts << %(<script src="#{ghp_root_dir}/js/prism.js"></script>)
   end
 end
 ```
 
-**Using all options:**
+**All options:**
 
-```Ruby
+```ruby
 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>
-  task.css_styles         << '<style>body{ background-color: linen; }</style>'
-  task.custom_gsub         = Proc.new() {|line| !line.gsub!('YardGhurt','YARD GHURT!').nil?()}
+  task.anchor_db           = {'tests' => 'Testing'} # Anchor links `#tests` become `#Testing`.
+  task.arg_names          << :name # Custom args.
+  task.css_styles         << '<link rel="stylesheet" href="css/my_css.css" />' # Inserted at `</head>`.
+  task.css_styles         << '<style>body { background-color: linen; }</style>'
+  task.custom_gsub         = proc { |line| !line.gsub!('YardGhurt','YARD GHURT!').nil? }
   task.custom_gsubs       << [/newline/i,'Do you smell what The Rock is cooking?']
-  task.deps               << :yard # Custom dependencies
+  task.deps               << :yard # Custom dependencies.
   task.description         = 'Fix it'
   task.doc_dir             = 'doc'
-  task.dry_run             = false
+  task.dry_run             = true
   task.exclude_code_langs  = Set['ruby']
   task.fix_anchor_links    = true
   task.fix_code_langs      = true
   task.fix_file_links      = true
-  task.js_scripts         << '<script src="js/my_js.js"></script>' # Inserted at </body>
+  task.js_scripts         << '<script src="js/my_js.js"></script>' # Inserted at `</body>`.
   task.js_scripts         << '<script>document.write("Hello World!");</script>'
   task.md_files            = ['index.html']
   task.verbose             = false
-  
-  task.before = Proc.new() {|task,args| puts "Hi, #{args.name}!"}
-  task.during = Proc.new() {|task,args,file| puts "#{args.name} can haz #{file}?"}
-  task.after  = Proc.new() {|task,args| puts "Goodbye, #{args.name}!"}
+
+  task.before = proc { |_task2,args| puts "Hi, #{args.name}!" }
+  task.during = proc { |_task2,args,file| puts "#{args.name} can haz #{file}?" }
+  task.after  = proc { |_task2,args| puts "Goodbye, #{args.name}!" }
 end
 ```
 
-### [GHPSyncTask](#using)
+### [//](#-contents) GHPSyncTask
 
 Sync YARDoc to a local GitHub Pages repo (uses `rsync` by default).
 
 **What I typically use:**
 
-```Ruby
-YardGhurt::GHPSyncTask.new() do |task|
+```ruby
+YardGhurt::GHPSyncTask.new do |task|
   task.ghp_dir = '../esotericpig.github.io/docs/yard_ghurt/yardoc'
   task.sync_args << '--delete-after'
 end
 ```
 
-**Using all options:**
+**All options:**
 
-```Ruby
-# Execute: rake ghp_doc[false,'Ruby']
+```ruby
+# Execute: rake ghp_doc[false,'Custom']
 YardGhurt::GHPSyncTask.new(:ghp_doc) do |task|
-  task.arg_names   << :name                      # Custom args
-  task.deps        << :yard                      # Custom dependencies
+  task.arg_names   << :name                      # Custom args ('Custom').
+  task.deps        << :yard                      # Custom dependencies.
   task.description  = 'Rsync my_doc/ to my page'
-  task.doc_dir      = 'my_doc'                   # YARDoc directory of generated files
+  task.doc_dir      = 'my_doc'                   # YARDoc directory of generated files.
   task.ghp_dir      = '../dest_dir/my_page'
-  task.strict       = true                       # Fail if doc_dir doesn't exist
+  task.strict       = true                       # Fail if doc_dir doesn't exist.
   task.sync_args   << '--delete-after'
   task.sync_cmd     = '/usr/bin/rsync'
-  
-  task.before = Proc.new() {|task,args| puts "Hi, #{args.name}!"}
-  task.after  = Proc.new() {|task,args| puts "Goodbye, #{args.name}!"}
+
+  task.before = proc { |_task2,args| puts "Hi, #{args.name}!" }
+  task.after  = proc { |_task2,args| puts "Goodbye, #{args.name}!" }
 end
 ```
 
-### [Util / YardGhurt](#using)
+### [//](#-contents) Util / YardGhurt
 
 Utility methods for tasks.
 
-```Ruby
+```ruby
 require 'yard_ghurt/util'
 
-# If the file exists, delete it, and if +output+ is true, log it to stdout
+# 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::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
+# Convert an Object to true or false.
+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
 ```
 
-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*.
+For convenience, *Util*'s methods are also included in the top module *YardGhurt*. However, this will also include all the Tasks and Helpers, so *Util* is preferred, unless you're already requiring *yard_ghurt*.
 
 ```Ruby
 require 'yard_ghurt'
@@ -192,64 +204,62 @@ YardGhurt.rm_exist('doc/file.README.html')
 puts YardGhurt.to_bool('true')
 ```
 
-### [AnchorLinks](#using)
+### [//](#-contents) AnchorLinks
+
 A “database” of anchor links specific to GitHub Flavored Markdown (GFM) and YARDoc.
 
 You can use this by itself to view what anchor IDs would be generated:
 
-```Ruby
+```ruby
 require 'yard_ghurt/anchor_links'
 
-al = YardGhurt::AnchorLinks.new()
+al = YardGhurt::AnchorLinks.new
 
-puts al.to_github_anchor_id('This is a test!')
-puts al.to_yard_anchor_id('This is a test!')
-
-# Output:
-# ---
-# this-is-a-test
-# This_is_a_test_
+puts al.to_github_anchor_id('This is a test!') #=> this-is-a-test
+puts al.to_yard_anchor_id('This is a test!')   #=> This_is_a_test_
 ```
 
-Be aware that YARDoc depends on a common number that will be incremented for all duplicates, while GFM's number is only local to each specific duplicate:
+Be aware that YARDoc depends on a common number that will be incremented for all duplicates, while GFM's number is only local to each duplicate:
 
-```Ruby
-al = YardGhurt::AnchorLinks.new()
+```ruby
+al = YardGhurt::AnchorLinks.new
 name = 'This is a test!'
 
-puts al.to_yard_anchor_id(name)   # This_is_a_test_
-puts al.to_yard_anchor_id(name)   # This_is_a_test_
+puts al.to_yard_anchor_id(name)   #=> This_is_a_test_
+puts al.to_yard_anchor_id(name)   #=> This_is_a_test_
 
-puts al.to_github_anchor_id(name) # this-is-a-test
-puts al.to_github_anchor_id(name) # this-is-a-test
+puts al.to_github_anchor_id(name) #=> this-is-a-test
+puts al.to_github_anchor_id(name) #=> this-is-a-test
 
-al << name # Officially add it to the database
+al << name # Officially add it to the database.
 
-# Instead of being 0 & 0, will be 0 & 1 (incremented),
-#   even without being added to the database
-puts al.to_yard_anchor_id(name)   # This_is_a_test_0
-puts al.to_yard_anchor_id(name)   # This_is_a_test_1
+# Instead of being 0 & 0, it will be 0 & 1 (incremented),
+#   even without being added to the database.
+puts al.to_yard_anchor_id(name)   #=> This_is_a_test_0
+puts al.to_yard_anchor_id(name)   #=> This_is_a_test_1
 
-puts al.to_github_anchor_id(name) # this-is-a-test-1
-puts al.to_github_anchor_id(name) # this-is-a-test-1
+puts al.to_github_anchor_id(name) #=> this-is-a-test-1
+puts al.to_github_anchor_id(name) #=> this-is-a-test-1
 
 name = 'This is another test!'
-al << name # Officially add it to the database
+al << name # Officially add it to the database.
 
-# Instead of being 0 & 1, will be 2 & 3 (global increment),
-#   even without being added to the database
-puts al.to_yard_anchor_id(name)   # This_is_another_test_2
-puts al.to_yard_anchor_id(name)   # This_is_another_test_3
+# Instead of being 0 & 1, it will be 2 & 3 (global increment),
+#   even without being added to the database.
+puts al.to_yard_anchor_id(name)   #=> This_is_another_test_2
+puts al.to_yard_anchor_id(name)   #=> This_is_another_test_3
 
-puts al.to_github_anchor_id(name) # this-is-another-test-1
-puts al.to_github_anchor_id(name) # this-is-another-test-1
+puts al.to_github_anchor_id(name) #=> this-is-another-test-1
+puts al.to_github_anchor_id(name) #=> this-is-another-test-1
 ```
 
-## [CLI App](#contents)
+## [//](#-contents) CLI App
+
 A CLI app has been added for convenience for when writing your own README.
 
 On the command line:
-```
+
+```bash
 $ yard_ghurt -g "What's this ID?"
 # => whats-this-id
 
@@ -262,6 +272,7 @@ $ yard_ghurt -a "What's this ID?"
 ```
 
 Help:
+
 ```
 Usage: yard_ghurt [options]
     -a, --anchor <string>            Print GitHub & YARDoc anchor link IDs of <string>
@@ -272,23 +283,28 @@ Usage: yard_ghurt [options]
     -v, --version                    Print the version
 ```
 
-## [Hacking](#contents)
+## [//](#-contents) Hacking
 
-```
-$ git clone 'https://github.com/esotericpig/yard_ghurt.git'
-$ bundle install
-$ bundle exec rake -T
+```bash
+git clone 'https://github.com/esotericpig/yard_ghurt.git'
+cd yard_ghurt
+bundle install
+bundle exec rake -T
 ```
 
-### [Testing](#hacking)
+### [//](#-contents) Testing
 
 First, execute this:
 
-`$ bundle exec rake clobber yard yard_gfm_fix[true]`
+```bash
+bundle exec rake clobber yard yard_gfm_fix[true]
+```
 
 Then execute this and make sure there are no warnings and no changes:
 
-`$ bundle exec rake yard_gfm_fix[true]`
+```bash
+bundle exec rake yard_gfm_fix[true]
+```
 
 It should output this:
 
@@ -299,13 +315,15 @@ It should output this:
 = Nothing written (up-to-date)
 ```
 
-Then open up **doc/index.html** and check all of  the [anchor links](#tests), [local file links](#license), etc.
+Then open up [doc/index.html](doc/index.html) and check all the [anchor links](#-tests), [local file links](#-license), etc.
 
 Lastly, the 2 files should be almost identical, except for 1 line:
 
-`$ diff doc/index.html doc/file.README.html`
+```bash
+diff doc/index.html doc/file.README.html
+```
 
-## [Tests](#contents)
+## [//](#-contents) Tests
 
 These are actual tests for this gem.
 
@@ -321,17 +339,17 @@ These are actual tests for this gem.
 - [中文？](#中文)
 - [汉语？](#汉语)
 
-### [This is Test #1](#tests)
-### [This-is-Test-#2](#tests)
-### [This_is_Test_#3](#tests)
-### ["This is Test #4"](#tests)
-### ["This is Test #4"](#tests)
-### [this is test #5](#tests)
-### [THIS IS TEST #6](#tests)
-### [日本語？](#tests)
-### [テスト？](#tests)
-### [中文？](#tests)
-### [汉语？](#tests)
+### [This is Test #1](#-tests)
+### [This-is-Test-#2](#-tests)
+### [This_is_Test_#3](#-tests)
+### ["This is Test #4"](#-tests)
+### ["This is Test #4"](#-tests)
+### [this is test #5](#-tests)
+### [THIS IS TEST #6](#-tests)
+### [日本語？](#-tests)
+### [テスト？](#-tests)
+### [中文？](#-tests)
+### [汉语？](#-tests)
 
 ```
 Newline
@@ -347,12 +365,12 @@ Newline
 Newline
 ```
 
-## [License](#contents)
+## [//](#-contents) License
 
 [GNU LGPL v3+](LICENSE.txt)
 
 > YardGhurt (<https://github.com/esotericpig/yard_ghurt>)  
-> Copyright (c) 2019-2020 Jonathan Bradley Whited (@esotericpig)  
+> Copyright (c) 2019-2025 Bradley Whited  
 > 
 > YardGhurt is free software: you can redistribute it and/or modify  
 > it under the terms of the GNU Lesser General Public License as published by  

data/Rakefile

@@ -1,68 +1,45 @@
 # encoding: UTF-8
 # frozen_string_literal: true
 
-#--
-# This file is part of YardGhurt.
-# Copyright (c) 2019 Jonathan Bradley Whited (@esotericpig)
-# 
-# YardGhurt 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.
-# 
-# YardGhurt 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 YardGhurt.  If not, see <https://www.gnu.org/licenses/>.
-#++
-
-
 require 'bundler/gem_tasks'
 
+require 'rake/clean'
 require 'yard'
 require 'yard_ghurt'
 
-require 'rake/clean'
-
-task default: [:yard,:yard_gfm_fix]
+task default: %i[doc]
 
-CLEAN.exclude('.git/','stock/')
+CLEAN.exclude('.git/','.github/','.idea/','stock/')
 CLOBBER.include('doc/')
 
-YARD::Rake::YardocTask.new() do |task|
-  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',File.join('yard','templates')]
-  task.options += ['--title',"YardGhurt v#{YardGhurt::VERSION} Doc"]
-end
+# TEST: To test using different Gem versions:
+#         GST=1 bundle update && bundle exec rake doc
+desc 'Generate doc'
+task doc: %i[yard yard_gfm_fix]
 
-desc 'Generate pristine YARDoc'
-task :yard_fresh => [:clobber,:yard,:yard_gfm_fix] do |task|
+YARD::Rake::YardocTask.new do |task|
+  task.files = ['lib/**/*.rb']
+  task.options.push('--title',"YardGhurt v#{YardGhurt::VERSION}")
 end
 
-YardGhurt::GFMFixTask.new() do |task|
-  task.arg_names = [:dev]
+YardGhurt::GFMFixTask.new do |task|
+  task.arg_names = %i[dev]
   task.dry_run = false
   task.fix_code_langs = true
-  
-  task.before = Proc.new() do |task,args|
-    # Root dir of my GitHub Page for CSS/JS
-    GHP_ROOT_DIR = YardGhurt.to_bool(args.dev) ? '../../esotericpig.github.io' : '../../..'
-    
-    task.css_styles << %Q(<link rel="stylesheet" type="text/css" href="#{GHP_ROOT_DIR}/css/prism.css" />)
-    task.js_scripts << %Q(<script src="#{GHP_ROOT_DIR}/js/prism.js"></script>)
+
+  task.before = proc do |task2,args|
+    # NOTE: Do not delete `file.README.html`, as we need it for testing.
+
+    # Root dir of my GitHub Page for CSS/JS.
+    ghp_root_dir = YardGhurt.to_bool(args.dev) ? '../../esotericpig.github.io' : '../../..'
+
+    task2.css_styles << %(<link rel="stylesheet" type="text/css" href="#{ghp_root_dir}/css/prism.css" />)
+    task2.js_scripts << %(<script src="#{ghp_root_dir}/js/prism.js"></script>)
   end
 end
 
 # Probably not useful for others.
-YardGhurt::GHPSyncTask.new() do |task|
+YardGhurt::GHPSyncTask.new do |task|
   task.ghp_dir = '../esotericpig.github.io/docs/yard_ghurt/yardoc'
   task.sync_args << '--delete-after'
 end