checklinks 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9370e4ac12c05fc8906a579b52fb248045d010f9661bd72794ebdf11755b0632
-  data.tar.gz: 470a3371cd2f08ec0ec45457180686e3da0f7ebe78a75caadd63ac3c75ca52e4
+  metadata.gz: 28d7c06483db9186de6fac5d3793940d4fe8d0a215b084f8e86a5e6dd32f8ddd
+  data.tar.gz: 774bc7b6b15290bc6ef82db771ab9c9d1c1902d292b286768b1896dfe194794a
 SHA512:
-  metadata.gz: 88cb4b61dbbbbb53c37537bcdc21c4557b561f01904402046ed53049023b592d3bf0a4d2442b28528c3d1df5e805da5399bccb245863f2251f3efb974d76a315
-  data.tar.gz: f3efe8a2d9631bede466d934aa77b667656914be5e808bb57020f1814dad78b46b04cf6f5f4e66f518f870fa8785e54477c5ec750c77cbcc127382bcb87e86ff
+  metadata.gz: e1cda6ec6dcf171ced0102702b1a577976992e88f1fe0c0288485509bf0df44750904e7cb00a088e86640c313bbf90312e8e18068ed728bb9e815fed467cfe25
+  data.tar.gz: bc96babb64cddf2fc2540319a70e96a379b15af482db37739e721da075d17fb4c13067ade97933d6f0af0c1f05c0eecf4a020b6f5dffe4d200aa1268e6222754

data/.ruby-version

@@ -1 +1 @@
-2.5.8
+2.5.9

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    checklinks (1.0.0)
+    checklinks (1.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
 
 PLATFORMS
-  ruby
+  x86_64-darwin-20
 
 DEPENDENCIES
   checklinks!
 
 BUNDLED WITH
-   1.17.3
+   2.2.17

data/README.md

@@ -4,7 +4,7 @@ Checklinks finds broken or redirected links in a static webpage.
 
 ```
 % gem install checklinks
-% checklinks **/*.md
+% checklinks **.md
 ```
 
 It uses code from [awesome_bot](https://github.com/dkhamsing/awesome_bot), but the output is much more terse so it's easier to find which links are broken, and it also prints link locations which makes updating them easier.

data/bin/checklinks

@@ -19,9 +19,15 @@ until args.empty?
       config_file = args.shift
       raise unless config_file
       config = YAML.load(File.read(config_file))
+    when '--help'
+      puts "  checklinks [--config config.yaml] *.md"
+      exit 0
     else
-      raise
+      puts "unknown argument #{arg}"
+      exit 1
     end
+  elsif File.directory?(arg)
+    files.push *Dir.glob(File.join(arg, '**', '*.md'))
   else
     files.push arg
   end
@@ -52,6 +58,9 @@ file_worklist.process(Set.new) do |filename, found_urls|
       line_number += 1
     end
   end
+rescue => error
+  status_worklist.push [:error]
+  error_collector.push [:file, filename, error]
 end
 
 # Process URLs to produce status updates and errors
@@ -91,7 +100,7 @@ url_worklist.process_concurrently(16) do |url|
       next
     end
     status_worklist.push [:error]
-    error_collector.push [url, code, headers]
+    error_collector.push [:url, url, code, headers]
   end
 end
 
@@ -108,7 +117,6 @@ status_worklist.process({ok: 0, error: 0, ignored: 0, clear: 0}) do |message, st
     state[:ignored] += 1
   when :error
     state[:error] += 1
-    error_collector.push 
   end
   line = "[#{state[:ok].to_s.rjust(5)} ok, #{state[:ignored].to_s.rjust(5)} ignored, #{state[:error].to_s.rjust(5)} errors, #{file_worklist.size.to_s.rjust(5)} files left, #{url_worklist.size.to_s.rjust(5)} URLs left]"
   print line if $stdout.tty?
@@ -137,7 +145,7 @@ else
 
   # Create a map of errored URLs back to their locations
 
-  urls = errors.map(&:first).to_set
+  urls = errors.select { |error| error.first == :url }.map { |error| error[1] } .to_set
   url_links = {}
   links.each do |url, filename, line_number|
     next unless urls.include?(url)
@@ -151,16 +159,23 @@ else
 
   # Print each error
 
-  errors.each do |url, code, headers|
-    message = code
-    if (301..302).include?(code)
-      message = "#{code} -> #{headers['location']}"
-    else
+  errors.each do |token, *args|
+    case token
+    when :file
+      filename, error = *args
+      puts "  #{filename}: #{error}"
+    when :url 
+      url, code, headers = *args
       message = code
-    end
-    puts "  #{url} (#{message})"
-    url_links[url].each do |filename, line_number|
-      puts "    #{filename}:#{line_number}"
+      if (301..302).include?(code)
+        message = "#{code} -> #{headers['location']}"
+      else
+        message = code
+      end
+      puts "  #{url} (#{message})"
+      url_links[url].each do |filename, line_number|
+        puts "    #{filename}:#{line_number}"
+      end
     end
   end
 end

data/checklinks.gemspec

@@ -17,5 +17,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.5.8'
+  spec.required_ruby_version = '>= 2.5.9'
 end

data/lib/checklinks/version.rb

@@ -1,6 +1,6 @@
 module Checklinks
   MAJOR_VERSION = 1
-  MINOR_VERSION = 0
+  MINOR_VERSION = 1
   PATCH_VERSION = 0
   VERSION = "#{MAJOR_VERSION}.#{MINOR_VERSION}.#{PATCH_VERSION}"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: checklinks
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Chris Seaton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-14 00:00:00.000000000 Z
+date: 2021-06-22 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -42,15 +42,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.8
+      version: 2.5.9
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6.2
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Find broken links in your static website