rdoc_link_checker 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77d49154c855b923e70e92faf6e9206627a1e1793d3f93e9a6bf24c137c203f5
-  data.tar.gz: c93421e52ad4f531ba57ab1cfd47e4996016621ec7f281b30a50ca4c76136c23
+  metadata.gz: e341b7558f0ff7fdd60949c48e74b40b3510203760c66959f35f3950170b84ca
+  data.tar.gz: 07aeb18242f468ba7279cbd889a691de5fb350ff7846e052a0f69758a0354dc9
 SHA512:
-  metadata.gz: f7e745ab474bec8a54e49ffc259a3f91a58231166f8c723c352e2235dba33fe1ef2db56b9f918d784b0f0caca6a145aacad5b669cd3c49b3d90fd6179684d2ff
-  data.tar.gz: da062b580efb28b8fce02ab8b30f58270b4e08aabeab86a8441b7de68cd172a5fe13aa59274d6da2219e35cfd1bc0817308237f71d570db144a0a5ccb892e3f7
+  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,11 +4,12 @@ require 'getoptlong'
 require_relative '../lib/rdoc_link_checker'
 
 options = GetoptLong.new(
-  ['--html_dirpath', '-d', GetoptLong::REQUIRED_ARGUMENT],
-  ['--onsite_only', '-l', GetoptLong::NO_ARGUMENT],
-  ['--no_toc',      '-n', GetoptLong::NO_ARGUMENT],
-  ['--version',     '-v', GetoptLong::NO_ARGUMENT],
-  ['--help',        '-h', 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]
 )
 
 def help
@@ -16,6 +17,10 @@ def help
   dirname = File.dirname(File.dirname(path))
   filepath = File.join(dirname, 'doc', 'help.txt')
   puts File.read(filepath)
+  filepath = File.join(dirname, 'config', 'ruby.json')
+  File.readlines(filepath).each do |line|
+    puts "    #{line}"
+  end
   exit
 end
 
@@ -24,14 +29,24 @@ def version
   exit
 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 = 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'
@@ -53,6 +68,8 @@ 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
 ).check

data/config/ruby.json

@@ -0,0 +1,10 @@
+{
+  "options": {
+    "onsite_only": false,
+    "no_toc": true
+  },
+  "source_file_omits": [
+    "^LEGAL",
+    "^NEWS"
+  ]
+}

data/doc/help.txt

@@ -7,10 +7,36 @@ of RDoc-generated HTML files, such as those generated by command
   rdoc --visibility=private --op html . # Note the trailing dot.
 
 Options:
-  --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).
-  --version       Print the version and exit.
-  --help          Print this help and exit.
+  --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;
+                      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.
 
 The output is file <html_dirpath>/Report.htm, which reports broken links.
+
+The configuration file must be a JSON object
+(see https://docs.ruby-lang.org/en/master/JSON.html)
+consisting of name/value pairs;
+the names may include:
+
+- "options": a JSON object consisting of option-name/value pairs;
+  the option-names may include:
+
+  - "onsite_only": the value must be true or false (not quoted),
+    which sets the onsite_only value.
+  - "no_toc": the value must be true or false (not quoted),
+    which sets the no_toc value.
+
+- "source_file_omits": a JSON array consisting of double-quoted strings,
+  each of which will be used to create a Regexp object;
+  a source filepath that matches any of those regexps will not be checked
+  for bad links.
+
+
+

data/lib/rdoc_link_checker/version.rb

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