sla 0.3.0 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 408ec43b2728bd5d2a1461b747b487506976e020894684d8270154a5e9b807a1
-  data.tar.gz: 8620e841cde6cc02ba87e2c35a32d278c197f65363e85fad6fd4adec3adcbf1e
+  metadata.gz: b7ab0a2c8232984458067a9d9a501011c50c4e6e3c500631a516b2f495b02fa6
+  data.tar.gz: 3d1af9be056a2cabc8dbf39dc37d14795b549f4f4e19803be82663d761eb7e5e
 SHA512:
-  metadata.gz: d7b55730a4502b09df9c59ca8a3f0b49aa2986a2b6b548f8f26e8a8e5650075497acaef75f020e93354eb2f33d0538c6176ad3d3d070e11b0600e8ca6eddab34
-  data.tar.gz: 94eeaa6c32a22a8f894bf6c65b0b74084120a071897028d4888952ac7d7dd28d10dcfe289a5230bd053c06b2a307ee32ddcf96e50f8bfc900c94eaa03b60a4ca
+  metadata.gz: 10d4a3dd2bcffcba10b4866ab5200dd9ded805c73bc196666efbe827005ea10620180d61667d02e9aa28c809dba07e4ca6d6dd7f2f6fd8668d3c741d526c332f
+  data.tar.gz: 9998c057a56599449bb8077c1fdfba755d70a4877d83a6cbe9d25b243248d6b588d08bdc2c8cb9db87b6ecbf90852a8efde1eb31871e13ed7705d220bbc2484c

data/README.md

@@ -1,8 +1,7 @@
-Site Link Analyzer
-==================================================
+# Site Link Analyzer
 
 [![Gem Version](https://badge.fury.io/rb/sla.svg)](https://badge.fury.io/rb/sla)
-[![Build Status](https://travis-ci.com/DannyBen/sla.svg?branch=master)](https://travis-ci.com/DannyBen/sla)
+[![Build Status](https://github.com/DannyBen/sla/workflows/Test/badge.svg)](https://github.com/DannyBen/sla/actions?query=workflow%3ATest)
 [![Maintainability](https://api.codeclimate.com/v1/badges/f78192aead8a74535a24/maintainability)](https://codeclimate.com/github/DannyBen/sla/maintainability)
 
 ---
@@ -11,45 +10,58 @@ SLA is a simple broken links checker, with built in caching.
 
 ![SLA Demo](demo/cast.svg "SLA Demo")
 
-Install
---------------------------------------------------
+## Install
 
-```
+### Install using Ruby
+
+```shell
 $ gem install sla
 ```
 
+### Install using Docker
+
+```shell
+alias sla='docker run --rm -it --network host -v /tmp/sla_cache:/app/cache dannyben/sla'
+```
+
+The `--network host` flag is only necessary if you intend to check links on `localhost`.
 
-Features
---------------------------------------------------
+## Features
 
 - Easy to use command line interface.
 - Built in caching, to avoid overtaxing the server.
 - Show and save list of broken links to a log file.
 - Exits with non zero code on failure, for CI integration.
 
-
-Usage
---------------------------------------------------
+## Usage
 
 ```
 $ sla --help
-SLA
+Site Link Analyzer
 
 Usage:
-  sla check DOMAIN [options]
-  sla (-h|--help|--version)
+  sla URL [options]
+  sla --help | -h | --version
 
-Commands:
-  check
-    Start checking for broken links on a given domain.
-  
 Options:
+  --verbose, -v
+    Show detailed output
+
+  --simple, -s
+    Show simple output of errors only
+
   --depth, -d DEPTH
-    Set crawling depth [default: 5].
+    Set crawling depth [default: 5]
+
+  --external, -x
+    Also check external links
+
+  --ignore, -i URLS
+    Specify a list of space delimited patterns to skip
+    URLs that contain any of the strings in this list will be skipped
 
   --cache, -c LIFE
-    Set cache life [default: 1d]. LIFE can be in any of the 
-    following formats:
+    Set cache life [default: 1d]. LIFE can be in any of the following formats:
       10  = 10 seconds
       20s = 20 seconds
       10m = 10 minutes
@@ -57,24 +69,38 @@ Options:
       10d = 10 days
 
   --cache-dir DIR
-    Set the cache directory.
+    Set the cache directory
 
-  --external, -x
-    Also check external links.
+  -h --help
+    Show this help
 
-  --log, -l LOGFILE
-    Save errors to log file.
+  --version
+    Show version number
 
-  --ignore, -i URLS
-    Specify a list of space delimited URLs to skip.
-    URLs that start with the strings in this list will be skipped.
+Parameters:
+  URL
+    URL to scan
+
+Environment Variables:
+  SLA_SLEEP
+    Set number of seconds to sleep between calls (for debugging purposes)
 
 Examples:
-  sla check example.com
-  sla check example.com -c10m -d10
-  sla check example.com --cache-dir my_cache
-  sla check example.com --depth 10 --log my_log.log
-  sla check example.com --cache 30d
-  sla check example.com --ignore "/admin /customer/login"
+  sla example.com
+  sla example.com -c10m -d10
+  sla example.com --cache-dir my_cache
+  sla example.com --depth 10
+  sla example.com --cache 30d --external
+  sla example.com --simple > out.log
+  sla example.com --ignore "/admin /customer/login"
 
 ```
+
+## Contributing / Support
+
+If you experience any issue, have a question or a suggestion, or if you wish
+to contribute, feel free to [open an issue][issues].
+
+---
+
+[issues]: https://github.com/DannyBen/sla/issues

data/lib/sla/checker.rb

@@ -8,23 +8,12 @@ module SLA
       @check_external = check_external
     end
 
-    def deeply_checked
-      @deeply_checked ||= {}
-    end
-
-    def checked
-      @checked ||= {}
-    end
-
     def check(page, &block)
-      return if ignore? page
-      return if page.depth >= max_depth
-      return unless page.valid?
+      return if skip? page
 
       yield [:source, page] if block_given?
 
-      pages = page.pages
-      pages.reject! { |page| page.external? } if !check_external
+      pages = page_list page
 
       pages.each do |page|
         if checked.has_key? page.url or ignore? page
@@ -45,6 +34,18 @@ module SLA
 
   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
 
@@ -55,6 +56,14 @@ module SLA
       false
     end
 
+    def deeply_checked
+      @deeply_checked ||= {}
+    end
+
+    def checked
+      @checked ||= {}
+    end
+
   end
 end
 

data/lib/sla/formatters/base.rb

@@ -6,12 +6,11 @@ module SLA
       attr_accessor :count, :failed
 
       def initialize
-        @count = 0
-        @failed = 0
+        @count, @failed = 0, 0
       end
 
       def success?
-        failed == 0
+        count > 0 and failed == 0
       end
 
       def handle(action, page)

data/lib/sla/formatters/simple.rb

@@ -10,15 +10,21 @@ module SLA
         @count += 1
 
         return if page.valid?
-
         @failed += 1
 
+        show_status page
+      end
+
+    private
+
+      def show_status(page)
         if last_source
           say "!txtpur!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
       end
 
     end

data/lib/sla/formatters/tty.rb

@@ -1,16 +1,25 @@
 module SLA
   module Formatters
     class TTY < Base
-      attr_reader :last_source
+      attr_reader :last_source, :screen_width
 
       def handle(action, page)
-        screen_width = terminal_width
-
+        @screen_width = terminal_width
         @last_source = page.url if action == :source
 
         return unless action == :check
         @count += 1
 
+        show_status page
+      end
+
+      def footer_prefix
+        terminal? ? "\033[2K\n" : "\n"
+      end
+
+    private
+
+      def show_status(page)
         if page.valid?
           status = "PASS"
           color = "!txtgrn!"
@@ -25,6 +34,7 @@ module SLA
           end
 
           resay "  !txtred!FAIL!txtrst!  #{page.depth}  #{page.url}"
+          resay "   !txtred!#{page.code}!txtrst!  #{page.error}" unless page.code == 404
         end
 
         message = "[#{failed}/#{count} @ #{page.depth}] #{status}"
@@ -33,11 +43,6 @@ module SLA
         resay "[#{failed}/#{count} @ #{page.depth}] #{color}#{status}!txtrst! #{url} "
       end
 
-      def footer_prefix
-        terminal? ? "\033[2K\n" : "\n"
-      end
-
-
     end
   end
-end
+end

data/lib/sla/formatters/verbose.rb

@@ -5,26 +5,37 @@ module SLA
         case action
         when :source
           say "\n!txtpur!SOURCE  #{page.url}"
-        
+       
         when :check
-          @count += 1
-
-          if page.valid?
-            status = "PASS"
-            color = "!txtgrn!"
-          else
-            @failed += 1
-            status = "FAIL"
-            color = "!txtred!"
-          end
-
-          say "  #{color}#{status}!txtrst!  #{page.depth}  #{page.url}"
+          show_check_status page
 
         when :skip
           say "  !txtblu!SKIP!txtrst!  #{page.depth}  #{page.url}"
 
         end
       end
+
+    private
+
+      def show_check_status(page)
+        @count += 1
+
+        show_error = false
+
+        if page.valid?
+          status = "PASS"
+          color = "!txtgrn!"
+        else
+          @failed += 1
+          status = "FAIL"
+          color = "!txtred!"
+          show_error = page.code != 404
+        end
+
+        say "  #{color}#{status}!txtrst!  #{page.depth}  #{page.url}"
+        say "   !txtred!#{page.code}!txtrst!  #{page.error}" if show_error
+      end
+
     end
   end
 end

data/lib/sla/page.rb

@@ -1,83 +1,88 @@
-class Page
-  attr_reader :uri, :parent, :depth
-
-  def initialize(uri, parent: nil, depth: 0)
-    if uri.is_a? String
-      uri = "http://#{uri}" unless uri.start_with? 'http'
-      uri = URI.parse uri
-      uri.fragment = false
+module SLA
+  class Page
+    attr_reader :uri, :parent, :depth
+
+    def initialize(uri, parent: nil, depth: 0)
+      if uri.is_a? String
+        uri = "http://#{uri}" unless uri.start_with? 'http'
+        uri = URI.parse uri
+        uri.fragment = false
+      end
+
+      @uri, @parent, @depth = uri, parent, depth
     end
 
-    @uri, @parent, @depth = uri, parent, depth
-  end
+    def error
+      response.error
+    end
 
-  def error
-    response.error
-  end
+    def code
+      response.code || 'ERR'
+    end
 
-  def external?
-    byebug unless uri.respond_to? :host
-    uri.host != parent.uri.host
-  end
+    def external?
+      parent ? (uri.host != parent.uri.host) : false
+    end
 
-  def inspect
-    "#<Page url: #{url}, depth: #{depth}>"
-  end
+    def inspect
+      "#<Page url: #{url}, depth: #{depth}>"
+    end
 
-  def pages
-    @pages ||= pages!
-  end
+    def pages
+      @pages ||= pages!
+    end
 
-  def url
-    uri.to_s
-  end
+    def url
+      uri.to_s
+    end
 
-  def valid?
-    !response.error
-  end
+    def valid?
+      !response.error
+    end
 
-private
+  private
 
-  def anchors
-    @anchors ||= dom.css('a[href]')
-  end
+    def anchors
+      @anchors ||= dom.css('a[href]')
+    end
 
-  def content
-    @content ||= response.content
-  end
+    def content
+      @content ||= response.content
+    end
 
-  def dom
-    @dom ||= Nokogiri::HTML content
-  end
+    def dom
+      @dom ||= Nokogiri::HTML content
+    end
 
-  def normalize_url(new_url)
-    new_url = URI.parse new_url
-    new_url.fragment = false
+    def normalize_url(new_url)
+      new_url = URI.parse new_url
+      new_url.fragment = false
 
-    result = new_url.absolute? ? new_url : URI.join(url, new_url)
+      result = new_url.absolute? ? new_url : URI.join(url, new_url)
 
-    result.scheme =~ /^http/ ? result.to_s : nil
-  end
+      result.scheme =~ /^http/ ? result.to_s : nil
+    end
 
-  def pages!
-    result = {}
-    anchors.each do |a|
-      url = normalize_url a['href']
-      next unless url
-      page = Page.new url, parent: self, depth: depth+1
-      result[url] = page
+    def pages!
+      result = {}
+      anchors.each do |a|
+        url = normalize_url a['href']
+        next unless url
+        page = Page.new url, parent: self, depth: depth+1
+        result[url] = page
+      end
+      result.values
     end
-    result.values
-  end
 
-  def response
-    @response ||= response!
-  end
+    def response
+      @response ||= response!
+    end
 
-  def response!
-    response = WebCache.get url
-    @uri = response.base_uri
-    response
-  end
+    def response!
+      response = WebCache.get url
+      @uri = response.base_uri
+      response
+    end
 
-end
+  end
+end

data/lib/sla/version.rb

@@ -1,3 +1,3 @@
 module SLA
-  VERSION = "0.3.0"
+  VERSION = "0.3.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sla
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.4
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-28 00:00:00.000000000 Z
+date: 2021-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -110,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.16
 signing_key: 
 specification_version: 4
 summary: Command Line Site Link Analyzer