rdoc_link_checker 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb872be04882f5f7d1766531b096683198244ac46f1997e896e65e7f79cb3f47
-  data.tar.gz: 47768288623da2a9bf3610c4404ef5bdf704098a6572daeecae5400ab7e81987
+  metadata.gz: e341b7558f0ff7fdd60949c48e74b40b3510203760c66959f35f3950170b84ca
+  data.tar.gz: 07aeb18242f468ba7279cbd889a691de5fb350ff7846e052a0f69758a0354dc9
 SHA512:
-  metadata.gz: 743c976e0ad98d6f624d3d7856504944ce82c0455a94fe693bf4b508eb9dada4b1c3f8d1d19211a8d9dbff96c6ff25e708ed1193afd8bc0cf036ca3eff614cc4
-  data.tar.gz: 7f670d5f69e16259d1f6eeb555f38a2631eb6e8b53be91ab5a5d7a78f33e5fff40533c4438fe6024c465ddd894f876759097a099020c5860cd9843285bfdf0a2
+  metadata.gz: 26e31a6ceaab63b7d0e4ca4aaf4cb22c30a358ceec0b8f7be7a588fac2ecf63d894c2c52ca91777692c96a66a28b54e0d1b8a1fa811c6122327caca59868f254
+  data.tar.gz: 8aa4c40edd1cf78162c90ac3e184a5845157a21781a7a8988bce335e08ebe2f3db3c2fd6394d48d066d36ae44c0803109107bf8158420c98f18d56b4d5d5d800

data/README.md

@@ -1,28 +1,19 @@
-# RDocLinkChecker
-
-A gem to find broken links in HTML files generated by Ruby RDoc.
-
-Reports a link as broken if:
-
-- The target page given by +href+ is not found.
-- The target page is found, but the fragment given by +href+
-  is not a link target (element with attribute <tt>id</tt>) on that page;
-  this usually causes a browser to open at the top of the page
-  instead of at the given fragment.
-
-  Some browsers are forgiving, and will open the target
-  page at a link target similar to the given fragment;
-  for example, fragment ```#bar``` may be opened at an element
-  with id ```foobar```.
-
-See the [help text](doc/help.txt).
-
-<b>Note</b>: An RDoc bug that was fixed recently
-(PR https://github.com/ruby/rdoc/pull/1002)
-caused many (make that many, many) broken links TOC section
-https://docs.ruby-lang.org/en/master/table_of_contents.html#classes.
-Unless you have a recent Ruby version installed (one that has the bug fix),
-the RDocLinkChecker will find and report all those broken links.
-
-<b>Workaround</b>:  Use option <tt>--no_toc</tt>, which suppresses checking
-for those links.
+# RDocLinkChecker
+
+A gem to find broken links in HTML files generated by Ruby RDoc.
+
+Reports a link as broken if:
+
+- The target page given by +href+ is not found.
+- The target page is found, but the fragment given by +href+
+  is not a link target (element with attribute <tt>id</tt>) on that page;
+  this usually causes a browser to open at the top of the page
+  instead of at the given fragment.
+
+  Some browsers are forgiving, and will open the target
+  page at a link target similar to the given fragment;
+  for example, fragment ```#bar``` may be opened at an element
+  with id ```foobar```.
+
+See the [help text](doc/help.txt).
+

data/bin/rdoc_link_checker

@@ -4,9 +4,10 @@ require 'getoptlong'
 require_relative '../lib/rdoc_link_checker'
 
 options = GetoptLong.new(
-  ['--config', GetoptLong::REQUIRED_ARGUMENT],
-  ['--onsite_only', GetoptLong::NO_ARGUMENT],
-  ['--no_toc',      GetoptLong::NO_ARGUMENT],
+  ['--ruby_core',   GetoptLong::REQUIRED_ARGUMENT],
+  ['--config',      GetoptLong::REQUIRED_ARGUMENT],
+  ['--onsite_only', GetoptLong::REQUIRED_ARGUMENT],
+  ['--no_toc',      GetoptLong::REQUIRED_ARGUMENT],
   ['--version',     GetoptLong::NO_ARGUMENT],
   ['--help',        GetoptLong::NO_ARGUMENT]
 )
@@ -30,18 +31,22 @@ end
 
 config_filepath = nil
 onsite_only = false
-no_toc = false
+no_toc = true
+ruby_core = true
 options.each do |option, argument|
   case option
+  when '--ruby_core'
+    ruby_core = argument == 'false' ? false : true
+    break
   when '--config'
     config_filepath = argument
     onsite_only = false
-    no_toc = false
+    no_toc = true
     break
   when '--onsite_only'
-    onsite_only = true
+    onsite_only = argument == 'false' ? false : true
   when '--no_toc'
-    no_toc = true
+    no_toc = argument == 'false' ? false : true
   when '--help'
     help
   when '--version'
@@ -63,6 +68,7 @@ raise ArgumentError.new(message) if message
 html_dirpath = ARGV[0]
 RDocLinkChecker.new(
   html_dirpath,
+  ruby_core: ruby_core,
   config_filepath: config_filepath,
   onsite_only: onsite_only,
   no_toc: no_toc

data/doc/help.txt

@@ -7,10 +7,14 @@ of RDoc-generated HTML files, such as those generated by command
   rdoc --visibility=private --op html . # Note the trailing dot.
 
 Options:
+  --ruby_core         Set all options for reading Ruby core docs;
+                      default is true (its primary use).
   --config filepath   Read configuration from file.  See below.
   --onsite_only       Check link targets only on pages in the file tree at <html_dirpath>,
-                      and not those on other local pages or those on the web.
-  --no_toc            Do not check links on the TOC page (table_of_contents.html).
+                      and not those on other local pages or those on the web;
+                      default is false.
+  --no_toc            Do not check links on the TOC page (table_of_contents.html);
+                      default is true.
   --version           Print the version and exit.
   --help              Print this help and exit.
 
@@ -34,7 +38,5 @@ the names may include:
   a source filepath that matches any of those regexps will not be checked
   for bad links.
 
-  Example:
-
 
 

data/lib/rdoc_link_checker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class RDocLinkChecker
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/lib/rdoc_link_checker.rb

@@ -13,13 +13,19 @@ class RDocLinkChecker
 
   include REXML
 
-  attr_accessor :html_dirpath, :config_filepath, :onsite_only, :no_toc,
+  attr_accessor :html_dirpath, :ruby_core, :config_filepath, :onsite_only, :no_toc,
                 :source_file_omits
 
   attr_accessor :source_paths, :pages
 
+  RUBY_CORE_OMITS = [
+    "^LEGAL",
+    "^NEWS"
+  ]
+
   def initialize(
     html_dirpath,
+    ruby_core: true,
     config_filepath: nil,
     onsite_only: false,
     no_toc: false
@@ -28,7 +34,7 @@ class RDocLinkChecker
     self.config_filepath = config_filepath
     self.onsite_only = onsite_only
     self.no_toc = no_toc
-    self.source_file_omits = []
+    self.source_file_omits = ruby_core ? RUBY_CORE_OMITS : []
     if config_filepath
       config = JSON.parse(File.read(config_filepath))
       options = config['options']
@@ -572,7 +578,7 @@ EOT
 
       # For off-site, gather all ids, regardless of element.
       if RDocLinkChecker.offsite?(path)
-        ok = path.match('homepages')
+        path.match('homepages')
         doc.xpath("//*[@id]").each do |element|
           id = element.attr('id')
           ids.push(id)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc_link_checker
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Burdette Lamar
@@ -90,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Tool to check links in RDoc-generated HTML files.
 test_files: []