yard_ghurt 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d6655a3fefa8677dd2b00ea73dbd7b87cf1c6d13b888ed67c29feb899f2555e
-  data.tar.gz: 52ffccc6f6a7d98e7865396b1c8c3e2b8c9a58452d3e724b0d0eb0c75e3495ab
+  metadata.gz: 1ba77aa5e6b3ec3b9467138381e4c0af1e3c7e2cd1b08f48b496b6ccbce682a7
+  data.tar.gz: 1343014b656ac37ca4639ee0ff4ec0f9efbdbff6c74cac272a733287ea2406ca
 SHA512:
-  metadata.gz: bcab8039ee10ff48858cd161483bbbc32ebe23a038f32303defe23081932ab4bc97b7e0d64a4de15307c14993cdf4d311d7385ed00a920af324b641b3e11d110
-  data.tar.gz: 31b278e7cbc842b3431eda53f8737bf957ff7068c4796ca984c0362040777b31f8542270e0844942b7a47906b464a41be7cf155712f4a9f1a05b2a41c391ad93
+  metadata.gz: e86568ddae7285e682359272e8376af0c0c72a3559e61be6db1e7f165f38117484bddcb137a978fd29ce6e2144d5d60ee3bd2ec717daee86aea9fa8254debfb8
+  data.tar.gz: aa4842125f2dfb966543b7bc78771d928da1de5d44cc6d7ad1b6bf1d57ad1096f6f07d5cfc4064bb80eac9556a20f77dd02ac30fd96ce7bf3c84b84e4f58cc14

data/CHANGELOG.md

@@ -1,8 +1,22 @@
 # Changelog | YardGhurt
 
-Format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+All notable changes to this project will be documented in this file.
+
+Format is based on [Keep a Changelog v1.0.0](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning v2.0.0](https://semver.org/spec/v2.0.0.html).
+
+## [[Unreleased]](https://github.com/esotericpig/yard_ghurt/compare/v1.2.1...HEAD)
+-
+
+
+## [v1.2.1] - 2021-06-16
+### Fixed
+- Fixed to work with YARD v0.9.25+
+    - From v0.9.25, YARD changed to use RedCarpert's method of trying to create GitHub-style anchor links. RedCarpet does NOT match GitHub's algorithm exactly, so it all got messed up. I changed the code to grab the new `id="..."` field from `<h\d+...` tags and use that as the YARD ID. I tried recreating RedCarpert's C code (`rndr_header_anchor()` in `ext/redcarpet/html.c`) but this failed miserably, so resorted to just this. All that matters is that it works!
+
+### Changed
+- Formatted code using RuboCop.
 
-## [[Unreleased]](https://github.com/esotericpig/yard_ghurt/compare/v1.2.0...master)
 
 ## [v1.2.0] - 2020-02-29
 ### Added
@@ -18,6 +32,7 @@ Format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 - In AnchorLinks, don't use obsolete method URI.escape()/encode()
     - This outputted a lot of warnings
 
+
 ## [v1.1.0] - 2019-07-31
 ### Added
 - Added environment var *dryrun* to GFMFixTask:
@@ -30,6 +45,7 @@ Format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
     - 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
 - Some minor comments/doc
@@ -38,6 +54,7 @@ Format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ### Fixed
 - In GFMFixerTask, ignore empty lines
 
+
 ## [v1.0.0] - 2019-07-23
 ### Added
 - .gitignore

data/Gemfile

@@ -1,24 +1,6 @@
 # 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'
 

data/README.md

@@ -2,10 +2,10 @@
 
 [![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)
+[![Changelog](https://img.shields.io/badge/changelog-md-%23A0522D.svg)](CHANGELOG.md)
+[![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
 
@@ -60,6 +60,8 @@ $ bundle exec rake install:local
 
 ## [Using](#contents)
 
+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 |
@@ -78,6 +80,16 @@ $ bundle exec rake install:local
 
 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:
+
+```Ruby
+spec.add_development_dependency 'redcarpet','~> X.X' # For YARDoc Markdown (*.md)
+```
+
+Else, you'll get a bunch of `label-*` relative links.
+
 You can set *dry_run* on the command line:
 
 `$ rake yard_gfm_fix dryrun=true`
@@ -90,16 +102,16 @@ YardGhurt::GFMFixTask.new() do |task|
   task.dry_run = false
   task.fix_code_langs = true
   task.md_files = ['index.html']
-  
-  task.before = Proc.new() do |task,args|
+
+  task.before = Proc.new() do |t2,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'))
-    
+    YardGhurt.rm_exist(File.join(t2.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>)
+    ghp_root_dir = YardGhurt.to_bool(args.dev) ? '../../esotericpig.github.io' : '../../..'
+
+    t2.css_styles << %Q(<link rel="stylesheet" type="text/css" href="#{ghp_root_dir}/css/prism.css" />)
+    t2.js_scripts << %Q(<script src="#{ghp_root_dir}/js/prism.js"></script>)
   end
 end
 ```
@@ -126,7 +138,7 @@ YardGhurt::GFMFixTask.new(:yard_fix) do |task|
   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}!"}
@@ -159,7 +171,7 @@ YardGhurt::GHPSyncTask.new(:ghp_doc) do |task|
   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}!"}
 end
@@ -276,6 +288,7 @@ Usage: yard_ghurt [options]
 
 ```
 $ git clone 'https://github.com/esotericpig/yard_ghurt.git'
+$ cd yard_ghurt
 $ bundle install
 $ bundle exec rake -T
 ```
@@ -352,7 +365,7 @@ Newline
 [GNU LGPL v3+](LICENSE.txt)
 
 > YardGhurt (<https://github.com/esotericpig/yard_ghurt>)  
-> Copyright (c) 2019-2020 Jonathan Bradley Whited (@esotericpig)  
+> Copyright (c) 2019-2021 Jonathan 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,55 @@
 # 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: [:doc]
 
 CLEAN.exclude('.git/','stock/')
 CLOBBER.include('doc/')
 
-YARD::Rake::YardocTask.new() do |task|
+
+desc 'Generate documentation (YARDoc)'
+task :doc,%i[] => %i[ yard yard_gfm_fix ] do |task|
+  # pass
+end
+
+YARD::Rake::YardocTask.new do |task|
   task.files = [File.join('lib','**','*.rb')]
-  
-  task.options += ['--files','CHANGELOG.md,LICENSE.txt']
+
+  task.options += ['--files','CHANGELOG.md,LICENSE.txt,TODO.md']
   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
 
-desc 'Generate pristine YARDoc'
-task :yard_fresh => [:clobber,:yard,:yard_gfm_fix] do |task|
-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|
+
+  task.before = proc do |t2,args|
+    # 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' : '../../..'
-    
-    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>)
+    ghp_root_dir = YardGhurt.to_bool(args.dev) ? '../../esotericpig.github.io' : '../../..'
+
+    t2.css_styles << %Q(<link rel="stylesheet" type="text/css" href="#{ghp_root_dir}/css/prism.css" />)
+    t2.js_scripts << %Q(<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

data/bin/yard_ghurt

@@ -4,20 +4,9 @@
 
 #--
 # This file is part of YardGhurt.
-# Copyright (c) 2020 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/>.
+# Copyright (c) 2020-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 
@@ -25,5 +14,5 @@ require 'yard_ghurt'
 
 
 # @since 1.2.0
-yg = YardGhurt::App.new()
-yg.run()
+yg = YardGhurt::App.new
+yg.run

data/lib/yard_ghurt.rb

@@ -1,23 +1,11 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
 # frozen_string_literal: true
 
 #--
 # This file is part of YardGhurt.
-# Copyright (c) 2019-2020 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/>.
+# Copyright (c) 2019-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 
@@ -31,58 +19,58 @@ require 'yard_ghurt/version'
 
 ###
 # YARDoc GitHub Rake Tasks
-# 
-# @author Jonathan Bradley Whited (@esotericpig)
+#
+# @author Jonathan Bradley Whited
 # @since  1.0.0
 ###
 module YardGhurt
   # Internal code should use +Util.+!
   # See {Util} for details.
   include Util
-  
+
   ###
   # A simple CLI app used in file +bin/yard_ghurt+.
-  # 
+  #
   # Mainly for getting GitHub/YARDoc anchor link IDs.
-  # 
-  # @author Jonathan Bradley Whited (@esotericpig)
+  #
+  # @author Jonathan Bradley Whited
   # @since  1.2.0
   ###
   class App
     attr_reader :args
-    
+
     def initialize(args=ARGV)
       super()
-      
+
       @args = args
     end
-    
-    def run()
-      parser = OptionParser.new() do |op|
+
+    def run
+      parser = OptionParser.new do |op|
         op.program_name = 'yard_ghurt'
         op.version = VERSION
-        
+
         op.banner = "Usage: #{op.program_name} [options]"
-        
+
         op.on('-a','--anchor <string>','Print GitHub & YARDoc anchor link IDs of <string>') do |str|
-          al = AnchorLinks.new()
+          al = AnchorLinks.new
           puts "GitHub: #{al.to_github_anchor_id(str)}"
           puts "YARDoc: #{al.to_yard_anchor_id(str)}"
           exit
         end
         op.on('-g','--github <string>','Print GitHub anchor link ID of <string>') do |str|
-          al = AnchorLinks.new()
+          al = AnchorLinks.new
           puts al.to_github_anchor_id(str)
           exit
         end
         op.on('-y','--yard <string>','Print YARDoc anchor link ID of <string>') do |str|
-          al = AnchorLinks.new()
+          al = AnchorLinks.new
           puts al.to_yard_anchor_id(str)
           exit
         end
-        
+
         op.separator op.summary_indent + '---'
-        
+
         op.on_tail('-h','--help','Print this help') do
           puts op
           exit
@@ -92,7 +80,7 @@ module YardGhurt
           exit
         end
       end
-      
+
       parser.parse!(@args)
       puts parser # Print help if nothing was parsed
     end

data/lib/yard_ghurt/anchor_links.rb

@@ -1,23 +1,11 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
 # frozen_string_literal: true
 
 #--
 # This file is part of YardGhurt.
-# Copyright (c) 2019-2020 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/>.
+# Copyright (c) 2019-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 
@@ -27,249 +15,252 @@ require 'uri'
 module YardGhurt
   ###
   # A "database" of anchor links specific to GitHub Flavored Markdown (GFM) & YARDoc.
-  # 
+  #
   # You can use this by itself to view what anchor IDs would be generated:
   #   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_
-  # 
+  #
   # 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:
   #   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_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
-  #   
+  #
   #   # 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
-  #   
+  #
   #   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
-  #   
+  #
   #   # 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
-  #   
+  #
   #   puts al.to_github_anchor_id(name) # this-is-another-test-1
   #   puts al.to_github_anchor_id(name) # this-is-another-test-1
-  # 
-  # @author Jonathan Bradley Whited (@esotericpig)
+  #
+  # @author Jonathan Bradley Whited
   # @since  1.0.0
-  # 
+  #
   # @see GFMFixTask
   ###
   class AnchorLinks
     # @return [Hash] the GFM-style anchor IDs pointing to their YARDoc ID equivalents that have been added
     attr_reader :anchor_ids
-    
+
     # @return [Set] the YARDoc anchor IDs that have been added
     attr_accessor :yard_anchor_ids
-    
+
     # @return [Integer] the next YARDoc number to use if there is a duplicate anchor ID
     attr_accessor :yard_dup_num
-    
-    def initialize()
-      reset()
+
+    def initialize
+      super()
+      reset
     end
-    
+
     # Reset the database back to its fresh, pristine self,
     # including common numbers for duplicates.
-    def reset()
+    def reset
       @anchor_ids = {}
-      @yard_anchor_ids = Set.new()
+      @yard_anchor_ids = Set.new
       @yard_dup_num = 0
     end
-    
+
     # (see #add_anchor)
     def <<(name)
       return add_anchor(name)
     end
-    
+
     # (see #store_anchor)
     def []=(github_anchor_id,yard_anchor_id)
-      return store_anchor(github_anchor_id,yard_anchor_id)
+      store_anchor(github_anchor_id,yard_anchor_id)
     end
-    
+
     # Convert +name+ (header text) to a GFM and YARDoc anchor ID and add the IDs to the database.
-    # 
-    # @param name [String] the name (header text) to convert to anchor IDs and add to the database
-    # 
+    #
+    # @note +yard_id:+ was added in v1.2.1 for YARD v0.9.25+.
+    #
+    # @param  name [String] the name (header text) to convert to anchor IDs and add to the database
     # @return [self]
-    def add_anchor(name)
-      store_anchor(to_github_anchor_id(name),to_yard_anchor_id(name))
-      
+    def add_anchor(name,yard_id: nil)
+      yard_id = to_yard_anchor_id(name) if yard_id.nil?
+
+      store_anchor(to_github_anchor_id(name),yard_id)
+
       return self
     end
-    
+
     # Escape +str+ for the web (e.g., "%20" for a space).
-    # 
+    #
     # Mainly used for non-English languages.
-    # 
+    #
     # @param str [String] the string to escape
-    # 
+    #
     # @return [String] the escaped string
-    # 
+    #
     # @since  1.2.0
     def self.escape(str)
       # URI.escape()/encode() is obsolete
       return URI.encode_www_form_component(str)
     end
-    
+
     # Merge +anchor_ids+ with {anchor_ids} and {yard_anchor_ids}.
-    # 
+    #
     # @param anchor_ids [Hash] the anchor IDs (of GFM anchor IDs to YARDoc anchor IDs) to merge
     def merge_anchor_ids!(anchor_ids)
       @anchor_ids.merge!(anchor_ids)
       @yard_anchor_ids.merge(anchor_ids.values)
-      
+
       return @anchor_ids
     end
-    
+
     # Store & associate key +github_anchor_id+ with value +yard_anchor_id+,
     # and add +yard_anchor_id+ to the YARDoc anchor IDs.
-    # 
+    #
     # @param github_anchor_id [String] the GitHub anchor ID; the key
     # @param yard_anchor_id [String] the YARDoc anchor ID; the value
-    # 
+    #
     # @return [String] the +yard_anchor_id+ added
     def store_anchor(github_anchor_id,yard_anchor_id)
       @anchor_ids[github_anchor_id] = yard_anchor_id
       @yard_anchor_ids << yard_anchor_id
-      
+
       return yard_anchor_id
     end
-    
+
     def anchor_ids=(anchor_ids)
       @anchor_ids = anchor_ids
       @yard_anchor_ids.merge(anchor_ids.values)
-      
-      return @anchor_ids
     end
-    
+
     # (see #anchor_id)
     def [](github_anchor_id)
       return anchor_id(github_anchor_id)
     end
-    
+
     # Get the YARDoc anchor ID associated with this +github_anchor_id+.
-    # 
+    #
     # @param github_anchor_id [String] the GitHub anchor ID key to look up
-    # 
+    #
     # @return [String,nil] the YARDoc anchor ID associated with +github_anchor_id+
     def anchor_id(github_anchor_id)
       return @anchor_ids[github_anchor_id]
     end
-    
+
     # Check if +id+ exists in the database of YARDoc anchor IDs
-    # 
+    #
     # @param id [String] the YARDoc anchor ID to check
-    # 
+    #
     # @return [true,false] whether this ID exists in the database of YARDoc anchor IDs
     def yard_anchor_id?(id)
       return @yard_anchor_ids.include?(id)
     end
-    
+
     # Convert +name+ (header text) to a GitHub anchor ID.
-    # 
+    #
     # If the converted ID already exists in the database,
     # then the ID will be updated according to GFM rules.
-    # 
+    #
     # @param name [String] the name (header text) to convert
-    # 
+    #
     # @return [String] the converted GitHub anchor ID for this database
-    # 
+    #
     # @see https://gist.github.com/asabaylus/3071099#gistcomment-2834467
     # @see https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/toc_filter.rb
     def to_github_anchor_id(name)
-      id = name.dup()
-      
-      id.strip!()
+      id = name.dup
+
+      id.strip!
       id.gsub!(/&[^;]+;/,'') # Remove entities: &...;
       id.gsub!(/[^\p{Word}\- ]/u,'')
       id.tr!(' ','-')
-      
+
       if RUBY_VERSION >= '2.4'
         id.downcase!(:ascii)
       else
-        id.downcase!()
+        id.downcase!
       end
-      
+
       id = self.class.escape(id) # For non-English languages
-      
+
       # Duplicates
       dup_num = 1
-      orig_id = id.dup()
-      
+      orig_id = id.dup
+
       while @anchor_ids.key?(id)
         id = "#{orig_id}-#{dup_num}"
         dup_num += 1
       end
-      
+
       return id
     end
-    
+
     # Dumps the key-value database of GFM & YARDoc anchor IDs.
-    # 
+    #
     # @return [String] the database of anchor IDs as a String
-    def to_s()
-      s = ''.dup()
-      
-      @anchor_ids.keys.sort_by{|key| key.to_s()}.each do |key|
+    def to_s
+      s = ''.dup
+
+      @anchor_ids.keys.sort_by(&:to_s).each do |key|
         s << "[#{key}] => '#{@anchor_ids[key]}'\n"
       end
-      
+
       return s
     end
-    
+
     # Convert +name+ (header text) to a YARDoc anchor ID.
-    # 
+    #
     # If the converted ID already exists in the database,
     # then the ID will be updated according to YARDoc rules,
     # which requires incrementing a common number variable.
-    # 
-    # The logic for this is pulled from +doc/app.js#generateTOC()+,
-    # which you can generate using +rake yard+ or +yardoc+ on the command line.
-    # 
+    #
+    # The logic for this is pulled from +doc/app.js#generateTOC()+
+    # (or +doc/js/app.js+), which you can generate using +rake yard+
+    # or +yardoc+ on the command line.
+    #
     # @note Be aware that this will increment a common number variable
     #       every time you call this with a duplicate.
-    # 
+    #
     # @param name [String] the name (header text) to convert
-    # 
+    #
     # @return [String] the converted YARDoc anchor ID for this database
     def to_yard_anchor_id(name)
-      id = name.dup()
-      
-      id.strip!()
+      id = name.dup
+
+      id.strip!
       id.gsub!(/&[^;]+;/,'_') # Replace entities: &...;
       id.gsub!(/[^a-z0-9-]/i,'_')
       id = self.class.escape(id) # For non-English languages
-      
+
       # Duplicates
-      orig_id = id.dup()
-      
+      orig_id = id.dup
+
       while @yard_anchor_ids.include?(id)
         id = "#{orig_id}#{@yard_dup_num}"
         @yard_dup_num += 1
       end
-      
+
       return id
     end
   end