site_health 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 251746b898058b968e3e9f5a50406a9e6d4ab4d3
-  data.tar.gz: 6889e72c9f4d2b925381d9f41ef28a5acf0e84d6
+SHA256:
+  metadata.gz: 58954b6231e7ac87ca9708ed7ab494fea6c40dc0e9be354c94c8d42abdafa48a
+  data.tar.gz: 32943cf9511a5bcfcfb9677c33a7f36da093121f654d5947fe380e7670976eb2
 SHA512:
-  metadata.gz: c06a8679ef7fc7ebb6f9b926b8730119201ff4ad07439fae7b5e38fb15499ec51c11cca6664be80cb1d4dbde3a63d65c6d2861fcd0e567f9041908b39fa46b02
-  data.tar.gz: af62e5459f0882e659da7a2e9e7b47b12aaf8d87d1835acf621dbdc3234999002f5e25ade7ed64da93ec9c95d2231aa0671adddb22ad7896447b2bc2a91be8c9
+  metadata.gz: 033e88ed85ee9582298722df6098575a1a3526788b1e174c78723175e63ba729e82102aef0771e680c1c5fbbbde2bc08bf33b8c35800949c358a92d0d2fc78f9
+  data.tar.gz: cba191702784f73c3fa78980204157ab62d53afc2a0351e9ab6b75e528599d907f78fa4b04f2944e9300722a9417acb19f1fc497adb9eb5eaabf756f0a9c3f49

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/doc/
 
 Gemfile.lock
 
@@ -13,3 +14,5 @@ Gemfile.lock
 .rspec_status
 
 .byebug_history
+
+NOTES.md

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_from: .ruby-style-guide.yml
+AllCops:
+  UseCache: true
+  CacheRootDirectory: tmp
+  Exclude:
+    - 'tmp/*.rb'
+    - 'db/schema.rb'

data/.ruby-style-guide.yml

@@ -0,0 +1,263 @@
+Rails:
+  Enabled: false
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - "vendor/**/*"
+  UseCache: true
+Style/CollectionMethods:
+  Description: Preferred collection methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size
+  Enabled: true
+  PreferredMethods:
+    collect: map
+    collect!: map!
+    find: detect
+    find_all: select
+    reduce: inject
+Style/RedundantFreeze:
+  Description: "Checks usages of Object#freeze on immutable objects."
+  Enabled: false
+Layout/DotPosition:
+  Description: Checks the position of the dot in multi-line method calls.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains
+  Enabled: true
+  EnforcedStyle: trailing
+  SupportedStyles:
+  - leading
+  - trailing
+Naming/FileName:
+  Description: Use snake_case for source file names.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-files
+  Enabled: false
+  Exclude: []
+Naming/MemoizedInstanceVariableName:
+  Description: Memoized method name should match memo instance variable name.
+  Enabled: false
+Naming/UncommunicativeMethodParamName:
+  Description: >-
+                Checks for method parameter names that contain capital letters,
+                end in numbers, or do not meet a minimal length.
+  Enabled: false
+Style/GuardClause:
+  Description: Check for conditionals that can be replaced with guard clauses
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
+  Enabled: true
+  MinBodyLength: 3
+Style/IfUnlessModifier:
+  Description: Favor modifier if/unless usage when you have a single-line body.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier
+  Enabled: false
+Style/OptionHash:
+  Description: Don't use option hashes when you can use keyword arguments.
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  Description: Use `%`-literal delimiters consistently
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-literal-braces
+  Enabled: false
+  PreferredDelimiters:
+    "%": "()"
+    "%i": "()"
+    "%q": "()"
+    "%Q": "()"
+    "%r": "{}"
+    "%s": "()"
+    "%w": "()"
+    "%W": "()"
+    "%x": "()"
+Naming/PredicateName:
+  Description: Check the names of predicate methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark
+  Enabled: true
+  NamePrefix:
+  - is_
+  - has_
+  - have_
+  NamePrefixBlacklist:
+  - is_
+  Exclude:
+  - spec/**/*
+Style/RaiseArgs:
+  Description: Checks the arguments passed to raise/fail.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#exception-class-messages
+  Enabled: false
+  EnforcedStyle: exploded
+  SupportedStyles:
+  - compact
+  - exploded
+Style/SignalException:
+  Description: Checks for proper usage of fail and raise.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method
+  Enabled: false
+  EnforcedStyle: semantic
+  SupportedStyles:
+  - only_raise
+  - only_fail
+  - semantic
+Style/SingleLineBlockParams:
+  Description: Enforces the names of some block params.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#reduce-blocks
+  Enabled: false
+  Methods:
+  - reduce:
+    - a
+    - e
+  - inject:
+    - a
+    - e
+Style/TrivialAccessors:
+  Enabled: false
+Style/SingleLineMethods:
+  Description: Avoid single-line methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-single-line-methods
+  Enabled: false
+  AllowIfMethodIsEmpty: true
+Style/StringLiterals:
+  Description: Checks if uses of quotes match the configured preference.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals
+  Enabled: true
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/MixinUsage:
+  Enabled: true
+  Exclude:
+    - exe/*
+Style/StringLiteralsInInterpolation:
+  Description: Checks if uses of quotes inside expressions in interpolated strings
+    match the configured preference.
+  Enabled: true
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/TrailingCommaInArrayLiteral:
+  Description: Checks for trailing comma in parameter lists and literals.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInHashLiteral:
+  Description: Checks for trailing comma in parameter lists and literals.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas
+  Enabled: true
+  EnforcedStyleForMultiline: comma
+Metrics/AbcSize:
+  Description: A calculated magnitude based on number of assignments, branches, and
+    conditions.
+  Enabled: false
+  Max: 15
+Metrics/ClassLength:
+  Description: Avoid classes longer than 100 lines of code.
+  Enabled: false
+  CountComments: false
+  Max: 100
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 100
+  Description: Avoid modules longer than 100 lines of code.
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Description: A complexity metric that is strongly correlated to the number of test
+    cases needed to validate a method.
+  Enabled: false
+  Max: 6
+Metrics/MethodLength:
+  Description: Avoid methods longer than 10 lines of code.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
+  Enabled: false
+  CountComments: false
+  Max: 10
+Metrics/ParameterLists:
+  Description: Avoid parameter lists longer than three or four parameters.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params
+  Enabled: false
+  Max: 5
+  CountKeywordArgs: true
+Metrics/PerceivedComplexity:
+  Description: A complexity metric geared towards measuring complexity for a human
+    reader.
+  Enabled: false
+  Max: 7
+Metrics/LineLength:
+  Description: Maximum line length
+  Enabled: true
+  Max: 95
+  Exclude:
+  - Gemfile
+  - site_health.gemspec
+  - spec/**/*
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+  - site_health.gemspec
+  - spec/**/*
+Lint/AssignmentInCondition:
+  Description: Don't use assignment in conditions.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition
+  Enabled: false
+  AllowSafeAssignment: true
+Style/InlineComment:
+  Description: Avoid inline comments.
+  Enabled: false
+Naming/AccessorMethodName:
+  Description: Check the naming of accessor methods for get_/set_.
+  Enabled: false
+Style/Alias:
+  Description: Use alias_method instead of alias.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#alias-method
+  Enabled: false
+Style/Documentation:
+  Description: Document classes and non-namespace modules.
+  Enabled: false
+Style/DoubleNegation:
+  Description: Checks for uses of double negation (!!).
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-bang-bang
+  Enabled: false
+Style/EachWithObject:
+  Description: Prefer `each_with_object` over `inject` or `reduce`.
+  Enabled: false
+Style/EmptyLiteral:
+  Description: Prefer literals to Array.new/Hash.new/String.new.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#literal-array-hash
+  Enabled: false
+Style/ModuleFunction:
+  Description: Checks for usage of `extend self` in modules.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#module-function
+  Enabled: false
+Style/OneLineConditional:
+  Description: Favor the ternary operator(?:) over if/then/else/end constructs.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#ternary-operator
+  Enabled: false
+Style/PerlBackrefs:
+  Description: Avoid Perl-style regex back references.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers
+  Enabled: false
+Style/Send:
+  Description: Prefer `Object#__send__` or `Object#public_send` to `send`, as `send`
+    may overlap with existing methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#prefer-public-send
+  Enabled: false
+Style/SpecialGlobalVars:
+  Description: Avoid Perl-style global variables.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms
+  Enabled: false
+Style/VariableInterpolation:
+  Description: Don't interpolate global, instance and class variables directly in
+    strings.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#curlies-interpolate
+  Enabled: false
+Style/WhenThen:
+  Description: Use when x then ... for one-line cases.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#one-line-cases
+  Enabled: false
+Lint/EachWithObjectArgument:
+  Description: Check for immutable argument given to each_with_object.
+  Enabled: true
+Lint/HandleExceptions:
+  Description: Don't suppress exception.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
+  Enabled: false
+Lint/LiteralInInterpolation:
+  Description: Checks for literals used in interpolation.
+  Enabled: false

data/.travis.yml

@@ -1,5 +1,6 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.16.0.pre.2
+  - 2.3.0
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# HEAD
+
+## v0.2.0
+
+- Add post analysis steps for more issues - [#25](https://github.com/buren/site_health/pull/25)
+- Add simple CLI – [#24](https://github.com/buren/site_health/pull/24)
+
+## v0.1.0
+
+Is history..

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in site_health.gemspec
 gemspec

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Jacob Burenstam
+Copyright (c) 2018 Jacob Burenstam Linder
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,20 +1,22 @@
-# SiteHealth
+# SiteHealth [![Build Status](https://travis-ci.org/buren/site_health.svg?branch=master)](https://travis-ci.org/buren/site_health)
 
 :warning: Project is still experimental, API will change (a lot) without notice.
 
 Crawl a site and check various health indicators, such as:
 
-- HTTP error status
-- Invalid HTML/CSS/XML
-- Missing HTML page title
-- Broken links
+- Server errors
+- HTTP errors
+- Invalid HTML/XML/JSON
+- Missing HTML title/description
+- Missing image alt-attribute
+- Google Pagespeed
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'site_health'
+gem "site_health"
 ```
 
 And then execute:
@@ -27,31 +29,162 @@ Or install it yourself as:
 
 ## Usage
 
+[CLI usage](#cli).
+
+Crawl and check site
+
+```ruby
+nurse = SiteHealth.check("https://example.com")
+```
+
+Check list of URLs
+```ruby
+nurse = SiteHealth.check_urls(["https://example.com"])
+```
+
+Write raw JSON result to file
+```ruby
+nurse = SiteHealth.check("https://example.com")
+json = JSON.pretty_generate(nurse.journal)
+
+File.write("result.json", json)
+```
+
+Each issue
+
+```ruby
+SiteHealth.check_urls(urls) do |nurse|
+  nurse.clerk do |clerk|
+    clerk.every_issue { |issue| puts "#{issue.severity}, #{issue.title}" }
+  end
+end
+```
+
+Simple issue reports
+```ruby
+nurse = SiteHealth.check("https://example.com")
+report = SiteHealth::IssuesReport.new(nurse.issue) do |r|
+  r.fields = %i[url title detail] # issue fields
+  r.select { |issue| issue.url.include?('blog/') }
+end
+
+report.to_a
+report.to_csv
+report.to_json
+```
+
+Event handlers
+
+```ruby
+urls = ["https://example.com"]
+nurse = SiteHealth.check_urls(urls) do |nurse|
+  nurse.clerk do |clerk|
+    clerk.every_journal do |journal, page|
+      time_in_seconds = journal[:runtime_in_seconds]
+      puts "Found page #{page.title} - #{page.url} (checks took #{time_in_seconds})"
+    end
+
+    clerk.every_check do |check|
+      puts "Ran check: #{check.name}"
+    end
+
+    clerk.every_failed_url do |url|
+      puts "Failed to fetch: #{url}"
+    end
+  end
+end
+```
+
+Write page speed summary CSV
+
 ```ruby
-journal = SiteHealth.check('https://example.com')
+nurse = SiteHealth.check("https://example.com")
+summary = SiteHealth::PageSpeedSummarizer.new(nurse.journal)
+File.write("page_size_summary.csv", summary.to_csv)
+```
 
-# HTML
-journal.missing_html_title # List of URLs that are missing the HTML title
-journal.html_error_urls # List of URLs with HTML errors in them
+## Configuration
 
-# CSS
-journal.css_error_urls # List of URLs with CSS errors in them
+All configuration is optional.
 
-# XML
-journal.xml_error_urls # List of URLs with XML errors in them
+```ruby
+SiteHealth.configure do |config|
+  # Override default checkers
+  config.checkers = [:json_syntax, :html]
+
+  # Configure logger
+  config.logger = Logger.new(STDOUT).tap do |logger|
+    logger.progname = 'SiteHealth'
+    logger.level = Logger::INFO
+  end
+
+  # Configure HTMLProofer
+  config.html_proofer do |proofer_config|
+    proofer_config.log_level = :info
+    proofer_config.check_opengraph = false
+  end
+
+  # Configure W3C HTML/CSS validator
+  config.w3c_validators do |w3c_config|
+    w3c_config.css_uri = 'http://localhost:8888/check'
+    w3c_config.html_uri = 'http://localhost:8888/check'
+  end
+end
+```
 
-# Broken URLs
-broken = journal.broken_urls.first
-broken.url # The URL that failed
-broken.exists_on # Array of URLs where the broken URL was present
+__Load non-default checkers__:
 
-# HTTP
-journal.http_error_urls # All URLs with HTTP status code >= 400
+A few of the non-default checkers available in this gem require 3rd-party dependencies which aren't installed by default.
+
+| Checker name       | Gem                |
+| ------------------ | ------------------ |
+| google_page_speed  | google-api-client  |
+| html_proofer       | html-proofer       |
+| w3c_html           | w3c_validators     |
+| w3c_css            | w3c_validators     |
+
+If you intend to use any of those checkers make sure to install the gem first. For example to use the `google_page_speed` checker add `google-api-client` to your Gemfile or install it manually with `gem install google-api-client`. Then you register the checker for use.
+
+```ruby
+SiteHealth.config.register_checker :google_page_speed
+# LoadError is raised if google-api-client is *not* installed
+```
+
+__Add your own checker__:
+
+```ruby
+class ProfanityChecker < SiteHealth::Checker
+  name "profanity"
+  types %i[html json xml css javascript]
+
+  def check
+    add_data(profanity: {
+      damn: page.body.include?(" damn "),
+      shit: page.body.include?(" shit ")
+    })
+  end
+end
+
+# Then register it
+SiteHealth.configure do |config|
+  config.register_checker ProfanityChecker
+end
+```
+
+## CLI
+
+```
+Usage: site_health --help
+        --url=val0
+        --fields=priority,title,url  Issue fields to include - by default all fields are included
+        --output=result.csv          Output format, .csv or .json
+        --[no-]progress
+    -h, --help                       How to use
 ```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
@@ -62,3 +195,14 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/buren/
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+---
+
+## TODO
+
+- Good way to render result/reports data
+- Improve logger support
+- Checkers
+  * canonical URL
+  * http vs https links
+  * links matching a pattern