sla 0.3.5 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0a57c3ece35437abab2fb3737be5b85568b1154a65716b7442fac76f93aace9
-  data.tar.gz: e9a05c9cab3a639800ec43a0502c9f75eece89e1cf24b86085f6df416c38a031
+  metadata.gz: 3df29353cfd95a9b0b5ae9edfe228aba3d653f0dfa0656c6f7d0aafda9301ebe
+  data.tar.gz: 304f2711c046fc307c939230365d89cd7a3bf832614f9410b4aec62a59dc6dee
 SHA512:
-  metadata.gz: fdd577b6843dc52f92cd99835e84df4eab460c45191fc592de35b64a41c706772b27e6371c2872e1fe353e0289d6e6d26455970ea0edb4d07c8c08cdc91b910d
-  data.tar.gz: 96b768f6bd64d1b6f8c4e280af5c6983ff079f60a0103de0f037bc45421377395bc1dc93e30461d2aa36c1d3075cc865473410bd89bf6ba5aaf1e167ca2a16a1
+  metadata.gz: 3c527a92e2e8c28d0e9c5f4bf4aa51c93a44058cd7c00ce2dfd0f8ed6c2176f78b252859b095478174e5a18b384c85f22cf098a7690dbbcd19406d16c95c1607
+  data.tar.gz: d79c49cadf1e3d0919853f4a535f1fca2e4d9a210d89d5fee8a1e095b40b1e6a7fa86552946a996d384bf4389ca7f54ef691dc1c829a1927fc1cb3213112b7c8

data/bin/sla

@@ -6,13 +6,10 @@ router = MisterBin::Runner.new handler: SLA::Command
 
 begin
   exit router.run ARGV
-
-rescue SLA::BrokenLinks => e
-  puts "(exit code 1)"
+rescue SLA::BrokenLinks
+  puts '(exit code 1)'
   exit 1
-
 rescue Interrupt
   puts "\nGoodbye"
   exit 1
-
 end

data/lib/sla/checker.rb

@@ -1,69 +1,69 @@
-module SLA
-  class Checker
-    attr_reader :max_depth, :ignore, :check_external
-
-    def initialize(max_depth: 5, ignore: nil, check_external: false)
-      @max_depth = max_depth
-      @ignore = ignore
-      @check_external = check_external
-    end
-
-    def check(page, &block)
-      return if skip? page
-
-      yield [:source, page] if block_given?
-
-      pages = page_list page
-
-      pages.each do |page|
-        if checked.has_key? page.url or ignore? page
-          yield [:skip, page] if block_given?
-        else
-          checked[page.url] = true
-          yield [:check, page] if block_given?
-        end
-      end
-
-      pages.each do |page|
-        next if deeply_checked.has_key? page.url
-        deeply_checked[page.url] = true
-        next if page.external?
-        check page, &block
-      end
-    end
-
-  private
-
-    def page_list(page)
-      if check_external
-        page.pages
-      else
-        page.pages.reject { |page| page.external? }
-      end
-    end
-
-    def skip?(page)
-      ignore?(page) or page.depth >= max_depth or !page.valid?
-    end
-
-    def ignore?(page)
-      return false unless ignore
-
-      ignore.each do |text|
-        return true if page.url.include? text
-      end
-
-      false
-    end
-
-    def deeply_checked
-      @deeply_checked ||= {}
-    end
-
-    def checked
-      @checked ||= {}
-    end
-
-  end
-end
-
+module SLA
+  class Checker
+    attr_reader :max_depth, :ignore, :check_external
+
+    def initialize(max_depth: 5, ignore: nil, check_external: false)
+      @max_depth = max_depth
+      @ignore = ignore
+      @check_external = check_external
+    end
+
+    def check(page, &block)
+      return if skip? page
+
+      yield [:source, page] if block
+
+      pages = page_list page
+
+      pages.each do |next_page|
+        if checked.has_key?(next_page.url) || ignore?(next_page)
+          yield [:skip, next_page] if block
+        else
+          checked[next_page.url] = true
+          yield [:check, next_page] if block
+        end
+      end
+
+      pages.each do |next_page|
+        next if deeply_checked.has_key? next_page.url
+
+        deeply_checked[next_page.url] = true
+        next if next_page.external?
+
+        check next_page, &block
+      end
+    end
+
+  private
+
+    def page_list(page)
+      if check_external
+        page.pages
+      else
+        page.pages.reject(&:external?)
+      end
+    end
+
+    def skip?(page)
+      ignore?(page) or page.depth >= max_depth or !page.valid?
+    end
+
+    def ignore?(page)
+      return false unless ignore
+
+      ignore.each do |text|
+        return true if page.url.include? text
+      end
+
+      false
+    end
+
+    def deeply_checked
+      @deeply_checked ||= {}
+    end
+
+    def checked
+      @checked ||= {}
+    end
+  end
+end

data/lib/sla/command.rb

@@ -2,32 +2,42 @@ module SLA
   class Command < MisterBin::Command
     include Colsole
 
-    help "Site Link Analyzer"
+    help 'Site Link Analyzer'
 
     version VERSION
 
-    usage "sla URL [options]"
-    usage "sla --help | -h | --version"
+    usage 'sla URL [options]'
+    usage 'sla --help | -h | --version'
 
-    param "URL", "URL to scan"
+    param 'URL', 'URL to scan'
 
-    option "--verbose, -v", "Show detailed output"
-    option "--simple, -s", "Show simple output of errors only"
-    option "--depth, -d DEPTH", "Set crawling depth [default: 5]"
-    option "--external, -x", "Also check external links"
-    option "--ignore, -i URLS", "Specify a list of space delimited patterns to skip\nURLs that contain any of the strings in this list will be skipped"
-    option "--cache, -c LIFE", "Set cache life [default: 1d]. LIFE can be in any of the following formats:\n  10  = 10 seconds\n  20s = 20 seconds\n  10m = 10 minutes\n  10h = 10 hours\n  10d = 10 days"
-    option "--cache-dir DIR", "Set the cache directory"
+    option '--verbose, -v', 'Show detailed output'
+    option '--simple, -s', 'Show simple output of errors only'
+    option '--depth, -d DEPTH', 'Set crawling depth [default: 5]'
+    option '--external, -x', 'Also check external links'
+    option '--ignore, -i URLS', <<~USAGE
+      Specify a list of space delimited patterns to skip
+      URLs that contain any of the strings in this list will be skipped
+    USAGE
+    option '--cache, -c LIFE', <<~USAGE
+      Set cache life [default: 1d]. LIFE can be in any of the following formats:
+        10  = 10 seconds
+        20s = 20 seconds
+        10m = 10 minutes
+        10h = 10 hours
+        10d = 10 days
+    USAGE
+    option '--cache-dir DIR', 'Set the cache directory'
 
-    example "sla example.com"
-    example "sla example.com -c10m -d10"
-    example "sla example.com --cache-dir my_cache"
-    example "sla example.com --depth 10"
-    example "sla example.com --cache 30d --external"
-    example "sla example.com --simple > out.log"
-    example "sla example.com --ignore \"/admin /customer/login\""
+    example 'sla example.com'
+    example 'sla example.com -c10m -d10'
+    example 'sla example.com --cache-dir my_cache'
+    example 'sla example.com --depth 10'
+    example 'sla example.com --cache 30d --external'
+    example 'sla example.com --simple > out.log'
+    example 'sla example.com --ignore "/admin /customer/login"'
 
-    environment "SLA_SLEEP", "Set number of seconds to sleep between calls (for debugging purposes)"
+    environment 'SLA_SLEEP', 'Set number of seconds to sleep between calls (for debugging purposes)'
 
     def run
       WebCache.life = args['--cache']
@@ -36,13 +46,13 @@ module SLA
       max_depth = args['--depth'].to_i
       url = args['URL']
       ignore = args['--ignore']
-      ignore = ignore.split " " if ignore
+      ignore = ignore.split if ignore
       check_external = args['--external']
 
       checker = Checker.new max_depth: max_depth,
         ignore: ignore, check_external: check_external
 
-      formatter = if args['--verbose'] 
+      formatter = if args['--verbose']
         Formatters::Verbose.new
       elsif args['--simple']
         Formatters::Simple.new
@@ -54,17 +64,17 @@ module SLA
     end
 
     def run!(url, checker, formatter)
-      page = Page.new url
-      checker.check page do |action, page|
-        success = formatter.handle action, page
+      initial_page = Page.new url
+      checker.check initial_page do |action, page|
+        formatter.handle action, page
         sleep ENV['SLA_SLEEP'].to_f if ENV['SLA_SLEEP']
       end
 
       formatter.footer
 
-      unless formatter.success? or ENV['SLA_ALLOW_FAILS']
-        raise BrokenLinks
-      end
+      return if formatter.success? || ENV['SLA_ALLOW_FAILS']
+
+      raise BrokenLinks
     end
   end
-end
+end

data/lib/sla/exceptions.rb

@@ -1,3 +1,3 @@
 module SLA
   class BrokenLinks < StandardError; end
-end
+end

data/lib/sla/formatters/base.rb

@@ -6,11 +6,12 @@ module SLA
       attr_accessor :count, :failed
 
       def initialize
-        @count, @failed = 0, 0
+        @count = 0
+        @failed = 0
       end
 
       def success?
-        count > 0 and failed == 0
+        count.positive? and failed.zero?
       end
 
       def handle(action, page)
@@ -24,10 +25,9 @@ module SLA
       end
 
       def footer
-        color = success? ? '!txtgrn!' : '!txtred!'
-        say "#{footer_prefix}#{color}Checked #{count} pages with #{failed} failures"
+        color = success? ? 'g' : 'r'
+        say "#{footer_prefix}#{color}`Checked #{count} pages with #{failed} failures`"
       end
-
     end
   end
 end

data/lib/sla/formatters/simple.rb

@@ -7,9 +7,11 @@ module SLA
         @last_source = page.url if action == :source
 
         return unless action == :check
+
         @count += 1
 
         return if page.valid?
+
         @failed += 1
 
         show_status page
@@ -19,14 +21,13 @@ module SLA
 
       def show_status(page)
         if last_source
-          say "!txtpur!SOURCE  #{last_source}"
+          say "m`SOURCE  #{last_source}`"
           @last_source = nil
         end
 
-        say "  !txtred!FAIL!txtrst!  #{page.depth}  #{page.url}"
-        say "   !txtred!#{page.code}!txtrst!  #{page.error}" unless page.code == 404
+        say "  r`FAIL`  #{page.depth}  #{page.url}"
+        say "   r`#{page.code}`  #{page.error}" unless page.code == 404
       end
-
     end
   end
-end
+end

data/lib/sla/formatters/tty.rb

@@ -8,6 +8,7 @@ module SLA
         @last_source = page.url if action == :source
 
         return unless action == :check
+
         @count += 1
 
         show_status page
@@ -21,28 +22,27 @@ module SLA
 
       def show_status(page)
         if page.valid?
-          status = "PASS"
-          color = "!txtgrn!"
+          status = 'PASS'
+          color = 'g'
         else
           @failed += 1
-          status = "FAIL"
-          color = "!txtred!"
+          status = 'FAIL'
+          color = 'r'
 
           if last_source
-            resay "!txtpur!SOURCE  #{last_source}"
+            say "m`SOURCE  #{last_source}`", replace: true
             @last_source = nil
           end
 
-          resay "  !txtred!FAIL!txtrst!  #{page.depth}  #{page.url}"
-          resay "   !txtred!#{page.code}!txtrst!  #{page.error}" unless page.code == 404
+          say "  r`FAIL`  #{page.depth}  #{page.url}", replace: true
+          say "   r`#{page.code}`  #{page.error}", replace: true unless page.code == 404
         end
 
         message = "[#{failed}/#{count} @ #{page.depth}] #{status}"
         remaining_width = screen_width - message.size - 4
         url = page.url[0..remaining_width]
-        resay "[#{failed}/#{count} @ #{page.depth}] #{color}#{status}!txtrst! #{url} "
+        say "[#{failed}/#{count} @ #{page.depth}] #{color}`#{status}` #{url} ", replace: true
       end
-
     end
   end
 end

data/lib/sla/formatters/verbose.rb

@@ -4,13 +4,13 @@ module SLA
       def handle(action, page)
         case action
         when :source
-          say "\n!txtpur!SOURCE  #{page.url}"
-       
+          say "\nm`SOURCE  #{page.url}`"
+
         when :check
           show_check_status page
 
         when :skip
-          say "  !txtblu!SKIP!txtrst!  #{page.depth}  #{page.url}"
+          say "  b`SKIP`  #{page.depth}  #{page.url}"
 
         end
       end
@@ -23,19 +23,18 @@ module SLA
         show_error = false
 
         if page.valid?
-          status = "PASS"
-          color = "!txtgrn!"
+          status = 'PASS'
+          color = 'g'
         else
           @failed += 1
-          status = "FAIL"
-          color = "!txtred!"
+          status = 'FAIL'
+          color = 'r'
           show_error = page.code != 404
         end
 
-        say "  #{color}#{status}!txtrst!  #{page.depth}  #{page.url}"
-        say "   !txtred!#{page.code}!txtrst!  #{page.error}" if show_error
+        say "  #{color}`#{status}`  #{page.depth}  #{page.url}"
+        say "   r`#{page.code}`  #{page.error}" if show_error
       end
-
     end
   end
-end
+end

data/lib/sla/page.rb

@@ -9,7 +9,9 @@ module SLA
         uri.fragment = false
       end
 
-      @uri, @parent, @depth = uri, parent, depth
+      @uri = uri
+      @parent = parent
+      @depth = depth
     end
 
     def error
@@ -60,7 +62,7 @@ module SLA
 
       result = new_url.absolute? ? new_url : URI.join(url, new_url)
 
-      result.scheme =~ /^http/ ? result.to_s : nil
+      /^http/.match?(result.scheme) ? result.to_s : nil
     end
 
     def pages!
@@ -68,7 +70,8 @@ module SLA
       anchors.each do |a|
         url = normalize_url a['href']
         next unless url
-        page = Page.new url, parent: self, depth: depth+1
+
+        page = Page.new url, parent: self, depth: depth + 1
         result[url] = page
       end
       result.values
@@ -83,6 +86,5 @@ module SLA
       @uri = response.base_uri
       response
     end
-
   end
-end
+end

data/lib/sla/version.rb

@@ -1,3 +1,3 @@
 module SLA
-  VERSION = "0.3.5"
-end
+  VERSION = '0.3.7'
+end

data/lib/sla.rb

@@ -22,4 +22,4 @@ if ENV['BYEBUG']
   require 'byebug'
   require 'lp'
   # :nocov:
-end
+end

metadata

@@ -1,71 +1,77 @@
 --- !ruby/object:Gem::Specification
 name: sla
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.7
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-16 00:00:00.000000000 Z
+date: 2023-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.2
+        version: 0.8.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: mister_bin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: webcache
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '1.10'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: webcache
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0.8'
 description: Check for broken links on a website
 email: db@dannyben.com
 executables:
@@ -88,7 +94,8 @@ files:
 homepage: https://github.com/DannyBen/sla
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -104,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.3
+rubygems_version: 3.4.5
 signing_key: 
 specification_version: 4
 summary: Command Line Site Link Analyzer