broken_link_finder 0.9.3 → 0.11.1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: broken_link_finder
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.11.1
 platform: ruby
 authors:
 - Michael Telford
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-20 00:00:00.000000000 Z
+date: 2020-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -100,42 +100,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.3
+        version: '0.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.3
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: thread
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: wgit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: '0.9'
 description: Finds a website's broken links using the 'wgit' gem and reports back
   to you with a summary.
 email: michael.telford@live.com
@@ -159,7 +159,10 @@ files:
 - exe/broken_link_finder
 - lib/broken_link_finder.rb
 - lib/broken_link_finder/finder.rb
-- lib/broken_link_finder/reporter.rb
+- lib/broken_link_finder/link_manager.rb
+- lib/broken_link_finder/reporter/html_reporter.rb
+- lib/broken_link_finder/reporter/reporter.rb
+- lib/broken_link_finder/reporter/text_reporter.rb
 - lib/broken_link_finder/version.rb
 - lib/broken_link_finder/wgit_extensions.rb
 - load.rb
@@ -168,6 +171,9 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/michaeltelford/broken-link-finder
+  changelog_uri: https://github.com/michaeltelford/broken-link-finder/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/michaeltelford/broken-link-finder/issues
+  documentation_uri: https://www.rubydoc.info/gems/broken_link_finder
   allowed_push_host: https://rubygems.org
 post_install_message: Added the executable 'broken_link_finder' to $PATH
 rdoc_options: []
@@ -184,8 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Finds a website's broken links and reports back to you with a summary.

data/lib/broken_link_finder/reporter.rb

@@ -1,116 +0,0 @@
-# frozen_string_literal: true
-
-module BrokenLinkFinder
-  class Reporter
-    # The amount of pages/links to display when verbose is false.
-    NUM_VALUES = 3
-
-    # Creates a new Reporter instance.
-    # stream is any Object that responds to :puts.
-    def initialize(stream, sort, broken_links, ignored_links)
-      raise 'stream must respond_to? :puts' unless stream.respond_to?(:puts)
-      raise "sort by either :page or :link, not #{sort}" \
-      unless %i[page link].include?(sort)
-
-      @stream        = stream
-      @sort          = sort
-      @broken_links  = broken_links
-      @ignored_links = ignored_links
-    end
-
-    # Pretty print a report detailing the link summary.
-    def pretty_print_link_report(broken_verbose: true, ignored_verbose: false)
-      report_broken_links(verbose: broken_verbose)
-      report_ignored_links(verbose: ignored_verbose)
-
-      nil
-    end
-
-    private
-
-    # Report a summary of the broken links.
-    def report_broken_links(verbose: true)
-      if @broken_links.empty?
-        print 'Good news, there are no broken links!'
-      else
-        num_pages, num_links = get_hash_stats(@broken_links)
-        print "Found #{num_links} broken link(s) across #{num_pages} page(s):"
-
-        @broken_links.each do |key, values|
-          msg = sort_by_page? ?
-            "The following broken links were found on '#{key}':" :
-            "The broken link '#{key}' was found on the following pages:"
-          nprint msg
-
-          if verbose || (values.length <= NUM_VALUES)
-            values.each { |value| print value }
-          else # Only print N values and summarise the rest.
-            NUM_VALUES.times { |i| print values[i] }
-
-            objects = sort_by_page? ? 'link(s)' : 'page(s)'
-            print "+ #{values.length - NUM_VALUES} other #{objects}, remove --concise to see them all"
-          end
-        end
-      end
-    end
-
-    # Report a summary of the ignored links.
-    def report_ignored_links(verbose: false)
-      if @ignored_links.any?
-        num_pages, num_links = get_hash_stats(@ignored_links)
-        nprint "Ignored #{num_links} unsupported link(s) across #{num_pages} page(s), which you should check manually:"
-
-        @ignored_links.each do |key, values|
-          msg = sort_by_page? ?
-            "The following links were ignored on '#{key}':" :
-            "The link '#{key}' was ignored on the following pages:"
-          nprint msg
-
-          if verbose || (values.length <= NUM_VALUES)
-            values.each { |value| print value }
-          else # Only print N values and summarise the rest.
-            NUM_VALUES.times { |i| print values[i] }
-
-            objects = sort_by_page? ? 'link(s)' : 'page(s)'
-            print "+ #{values.length - NUM_VALUES} other #{objects}, use --verbose to see them all"
-          end
-        end
-      end
-    end
-
-    # Return true if the sort is by page.
-    def sort_by_page?
-      @sort == :page
-    end
-
-    # Returns the key/value statistics of hash e.g. the number of keys and
-    # combined values. The hash should be of the format: { 'str' => [...] }.
-    # Use like: `num_pages, num_links = get_hash_stats(links)`.
-    def get_hash_stats(hash)
-      num_keys   = hash.keys.length
-      values     = hash.values.flatten
-      num_values = sort_by_page? ? values.length : values.uniq.length
-
-      sort_by_page? ?
-        [num_keys, num_values] :
-        [num_values, num_keys]
-    end
-
-    # Prints the text + \n. Defaults to a blank line.
-    def print(text = '')
-      @stream.puts(text)
-    end
-
-    # Prints text + \n\n.
-    def printn(text)
-      print(text)
-      print
-    end
-
-    # Prints \n + text + \n.
-    def nprint(text)
-      print
-      print(text)
-    end
-  end
-end