jekyll-sanity-checker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c87617b0a35196dbf0935ed56672d5125d96ae6c
+  data.tar.gz: cfc830023fefb829707cd486de73e6bf64fdb5df
+SHA512:
+  metadata.gz: 0ceee07753ade7b5da1ebec8c12c82510a3fade2b670867ce7f2ec13b47072d2ae221f46990e48e0ef3149757e02d7de2377364ec7e82fe842585e9980b93d6d
+  data.tar.gz: 147e95264502c2073444b6aa18d904905675311518c0aa8b44c8eb90a62cbed573b0927d5f64dd85be0e324fe6806d78af24f143592533524352d161358d3fb8

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+# Generated by `rake`.
+spec/output/*

data/.rubocop.yml

@@ -0,0 +1,56 @@
+Style/RedundantReturn:
+  AllowMultipleReturnValues: true
+
+LineLength:
+  Enabled: false
+
+HashSyntax:
+  Enabled: false
+
+BracesAroundHashParameters:
+  Enabled: false
+
+BlockNesting:
+  Enabled: false
+
+AssignmentInCondition:
+  Enabled: false
+
+CollectionMethods:
+  Enabled: false
+
+CyclomaticComplexity:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+PerlBackrefs:
+  Enabled: false
+
+RescueModifier:
+  Enabled: false
+
+HandleExceptions:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+RegexpLiteral:
+  Enabled: false
+
+SignalException:
+  EnforcedStyle: only_raise
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/TrailingComma:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,21 @@
+Jekyll Sanity Checker
+-
+
+This is a little, *opinionated*, gem that will find mistakes in your HTML/CSS
+at `jekyll build` -time.
+
+Here are the things that this plugin enforces:
+
+* No internal broken links or images in HTML or CSS `url()`.
+* One sane style for URIs.
+
+Just drop `lib/jekyll_sanity_checker.rb` in your `_plugins` directory, or
+include `gems: [jekyll_sanity_checker]` in your `_config.yml`. See more
+instructions about Jekyll plugins at <http://jekyllrb.com/docs/plugins/>.
+
+How does it work?
+-
+
+This plugin does *not* use one of the standard mechanisms listed at
+<http://jekyllrb.com/docs/plugins/>. Instead, it prepends itself into the
+`Jekyll::Site` class and elaborates the `process` method.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'spec/**/*.rb'
+end

data/jekyll-sanity-checker.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'jekyll_sanity_checker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jekyll-sanity-checker'
+  spec.version       = JekyllSanityChecker::VERSION
+  spec.authors       = ['Edmund Huber']
+  spec.email         = 'edmund@fastly.com'
+  spec.license       = 'MIT'
+  spec.summary = spec.description = 'A Jekyll plugin that checks the generated HTML and CSS for common mistakes.'
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(/spec/)
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '> 1.9.3'
+
+  spec.add_dependency 'css_parser', '~> 1.3', '>= 1.3.5'
+  spec.add_dependency 'jekyll', '~> 2.4'
+  spec.add_dependency 'nokogiri', '~> 1.6', '>= 1.6.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop', '~> 0.25', '>= 0.25.0'
+end

data/lib/jekyll_sanity_checker.rb

@@ -0,0 +1,162 @@
+require 'addressable/uri'
+require 'css_parser'
+require 'nokogiri'
+
+module JekyllSanityChecker
+  class CheckFailed < StandardError
+  end
+
+  def process
+    super
+
+    # Check that the Jekyll config has the stuff we'll need.
+    begin
+      config['sanity_check']['host']
+    rescue
+      raise Jekyll::Errors::FatalException, 'need to fix up your Jekyll configuration for this plugin to work! Please see README.md'
+    end
+
+    JekyllSanityChecker.load_redirects(@config)
+
+    Jekyll.logger.info('checking for dumb mistakes!')
+
+    run_success = true
+
+    Dir.glob("#{dest}/**/*.html") do |html|
+      run_success = run_success && JekyllSanityChecker.check_html(@config, html)
+    end
+
+    Dir.glob("#{dest}/**/*.css") do |css|
+      run_success = run_success && JekyllSanityChecker.check_css(@config, css)
+    end
+
+    raise Jekyll::Errors::FatalException, 'checks failed' unless run_success
+  end
+
+  def check_html(config, page)
+    success = true
+    doc = Nokogiri::HTML::Document.parse File.read(page)
+    doc.css('a').each do |link|
+      begin
+        # Does the link have an href atttribute?
+        raise CheckFailed, 'no href on <a>' unless link.keys.include? 'href'
+
+        # If it's a hash-only URL then that's fine.
+        next if link['href'].start_with? '#'
+
+        check_resource(config, link['href'], %w(mailto), true)
+      rescue CheckFailed => e
+        Jekyll.logger.error("on #{page}, line #{link.line}, problem with '#{link}': #{e.message}")
+        success = false
+      end
+    end
+    doc.css('img').each do |img|
+      begin
+        # Does the img have a src attribute?
+        raise CheckFailed, 'no src on <img>' unless img.keys.include? 'src'
+        check_resource(config, img['src'], %w(data))
+      rescue CheckFailed => e
+        Jekyll.logger.error("on #{page}, line #{img.line}, problem with '#{img}': #{e.message}")
+        success = false
+      end
+    end
+    success
+  end
+  module_function :check_html
+
+  def check_css(config, stylesheet)
+    parser = CssParser::Parser.new
+    parser.load_file! stylesheet
+    success = true
+    parser.each_rule_set do |rule_set, _|
+      rule_set.each_declaration do |_, value, _|
+        match = /url\((.*?)\)/.match value
+        next if match.nil?
+        begin
+          check_resource(config, match[1].tr('\'"', ''), %w(data))
+        rescue CheckFailed => e
+          Jekyll.logger.error("in #{stylesheet}, problem with selector '#{rule_set.selectors.join ' '}': #{e.message}")
+          success = false
+        end
+      end
+    end
+    success
+  end
+  module_function :check_css
+
+  def load_redirects(config)
+    apache_redirects = nil
+    begin
+      apache_redirects = config['sanity_check']['apache_redirects']
+    rescue
+    end
+    @redirects = {}
+    unless apache_redirects.nil?
+      File.open(apache_redirects, 'r:UTF-8').each_line do |line|
+        m = /Redirect (\S+) (\S+) (\S+)/.match line
+        @redirects[m[2]] = m[3] unless m.nil?
+      end
+    end
+    @redirects
+  end
+  module_function :load_redirects
+
+  def self.check_resource(config, src, shortcircuit_valid_schemes = [], loose_html = false)
+    # Parse the URL,
+    begin
+      uri = Addressable::URI.parse(src)
+    rescue Addressable::URI::InvalidURIError
+      raise CheckFailed, 'not a URI'
+    end
+
+    # Maybe the scheme tells us that the URI is okay.
+    return if shortcircuit_valid_schemes.include? uri.scheme
+
+    # Otherwise the scheme should be http or https.
+    raise CheckFailed, 'not a valid scheme' unless [nil, 'http', 'https'].include? uri.scheme
+
+    # Only absolute URLs please.
+    this_host = config['sanity_check']['host']
+    raise CheckFailed, "fully-qualified URL back to #{this_host}" if uri.host == this_host
+
+    # Resolve redirects..
+    if @redirects.include? uri.path
+      redirect_uri = Addressable::URI.parse(@redirects[uri.path])
+      # .. if redirect is just a path, use that,
+      if redirect_uri.host.nil?
+        uri.path = redirect_uri.path
+      else
+        # otherwise use redirect host/path .
+        uri = redirect_uri
+      end
+    end
+
+    # And if it's a local resource,
+    if uri.host.nil?
+      # Check that it's not a relative url.
+      raise CheckFailed, 'relative URL' unless uri.path.start_with? '/'
+
+      parts = URI.unescape(uri.path).split('/').reject { |s| s.empty? }
+      path = ([File.expand_path(config['destination'])] + parts).join(File::SEPARATOR)
+
+      if loose_html
+        if File.directory?(path)
+          # We treat links to directories special: if there is a directory/index.html, it is ok.
+          raise CheckFailed, 'directory reference without an index.html' unless File.file? "#{path}/index.html"
+        else
+          # A bla.html can be referenced as bla.
+          raise CheckFailed, "file '#{path}' does not exist" unless File.file?(path) || File.file?("#{path}.html")
+        end
+      else
+        # Check that the file exists.
+        raise CheckFailed, "file '#{path}' does not exist" unless File.file? path
+      end
+    end
+  end
+end
+
+module Jekyll
+  class Site
+    prepend JekyllSanityChecker
+  end
+end

data/lib/jekyll_sanity_checker/version.rb

@@ -0,0 +1,3 @@
+module JekyllSanityChecker
+  VERSION = '1.0.0'
+end

data/spec/fixtures/a-invalid-uri/test.html

@@ -0,0 +1 @@
+<a href="http:"></a>

data/spec/fixtures/css-url-missing-file/test.css

@@ -0,0 +1,3 @@
+.a {
+    thing: url(/missing);
+}

data/spec/fixtures/fully-qualified-url/test.html

@@ -0,0 +1 @@
+<a href="http://www.computers.com/derp"></a>

data/spec/fixtures/img-fully-qualified-url/test.html

@@ -0,0 +1 @@
+<img src="http://www.computers.com/derp">

data/spec/fixtures/img-missing-file/test.html

@@ -0,0 +1 @@
+<img src="/missing">

data/spec/fixtures/img-missing-src/test.html

@@ -0,0 +1 @@
+<img>

data/spec/fixtures/img-relative-url/test.html

@@ -0,0 +1 @@
+<img src="thing">

data/spec/fixtures/missing-file/test.html

@@ -0,0 +1 @@
+<a href="/missing.html"></a>

data/spec/fixtures/no-index-html/test.html

@@ -0,0 +1 @@
+<a href="/no-index"></a>

data/spec/fixtures/relative-url/test.html

@@ -0,0 +1 @@
+<a href="relative"></a>

data/spec/fixtures/unrecognizable-scheme/test.html

@@ -0,0 +1 @@
+<a href="nonsense://www.fastly.com"></a>

data/spec/lib/sanity_checker.rb

@@ -0,0 +1,85 @@
+require 'jekyll'
+require 'jekyll_sanity_checker'
+require 'minitest/autorun'
+
+# A stub logger class for capturing errors from Jekyll.
+class CaptureError
+  attr_reader :captured
+
+  def initialize
+    @captured = nil
+  end
+
+  def error(message) # rubocop:disable Style/TrivialAccessors
+    @captured = message
+  end
+
+  def method_missing(_m, *_args, &_block)
+  end
+end
+
+# Install the stub logger.
+$capture_error = CaptureError.new # rubocop:disable Style/GlobalVars
+Jekyll.logger = $capture_error # rubocop:disable Style/GlobalVars
+Jekyll.logger.log_level = :error
+
+def refute_sane(page, error)
+  config_hash = {
+    'source' => "spec/fixtures/#{page}",
+    'destination' => 'spec/output',
+    'sanity_check' => {
+      'host' => 'www.computers.com'
+    }
+  }
+  site = Jekyll::Site.new(Jekyll.configuration(config_hash))
+  assert_raises Jekyll::Errors::FatalException do
+    site.process
+  end
+  assert_match error, $capture_error.captured # rubocop:disable Style/GlobalVars
+end
+
+describe 'Jekyll sanity checker' do
+  it 'warns about fully-qualified URLs' do
+    refute_sane 'fully-qualified-url', /fully-qualified URL back to/
+  end
+
+  it 'warns about unrecognizable schemes' do
+    refute_sane 'unrecognizable-scheme', /not a valid scheme/
+  end
+
+  it 'warns about relative URLs' do
+    refute_sane 'relative-url', /relative URL/
+  end
+
+  it 'warns about missing index.html' do
+    refute_sane 'no-index-html', /without an index\.html/
+  end
+
+  it 'warns about missing files' do
+    refute_sane 'missing-file', /does not exist/
+  end
+
+  it 'warns about <img> without src' do
+    refute_sane 'img-missing-src', /no src on <img>/
+  end
+
+  it 'warns about <img> with fully-qualified URL src' do
+    refute_sane 'img-fully-qualified-url', /fully-qualified URL back to/
+  end
+
+  it 'warns about <img> with relative URL src' do
+    refute_sane 'img-relative-url', /relative URL/
+  end
+
+  it 'warns about <img> with missing src' do
+    refute_sane 'img-missing-file', /does not exist/
+  end
+
+  it 'warns about CSS with missing url()' do
+    refute_sane 'css-url-missing-file', /does not exist/
+  end
+
+  it 'warns about malformed URLs in <a>' do
+    refute_sane 'a-invalid-uri', /not a URI/
+  end
+end

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-sanity-checker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Edmund Huber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: css_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.25'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.25.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.25'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.25.0
+description: A Jekyll plugin that checks the generated HTML and CSS for common mistakes.
+email: edmund@fastly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rubocop.yml
+- Gemfile
+- README.md
+- Rakefile
+- jekyll-sanity-checker.gemspec
+- lib/jekyll_sanity_checker.rb
+- lib/jekyll_sanity_checker/version.rb
+- spec/fixtures/a-invalid-uri/test.html
+- spec/fixtures/css-url-missing-file/test.css
+- spec/fixtures/fully-qualified-url/test.html
+- spec/fixtures/img-fully-qualified-url/test.html
+- spec/fixtures/img-missing-file/test.html
+- spec/fixtures/img-missing-src/test.html
+- spec/fixtures/img-relative-url/test.html
+- spec/fixtures/img-relative-url/thing
+- spec/fixtures/missing-file/test.html
+- spec/fixtures/no-index-html/no-index/crumb
+- spec/fixtures/no-index-html/test.html
+- spec/fixtures/relative-url/test.html
+- spec/fixtures/unrecognizable-scheme/test.html
+- spec/lib/sanity_checker.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>'
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: A Jekyll plugin that checks the generated HTML and CSS for common mistakes.
+test_files:
+- jekyll-sanity-checker.gemspec
+- spec/fixtures/a-invalid-uri/test.html
+- spec/fixtures/css-url-missing-file/test.css
+- spec/fixtures/fully-qualified-url/test.html
+- spec/fixtures/img-fully-qualified-url/test.html
+- spec/fixtures/img-missing-file/test.html
+- spec/fixtures/img-missing-src/test.html
+- spec/fixtures/img-relative-url/test.html
+- spec/fixtures/img-relative-url/thing
+- spec/fixtures/missing-file/test.html
+- spec/fixtures/no-index-html/no-index/crumb
+- spec/fixtures/no-index-html/test.html
+- spec/fixtures/relative-url/test.html
+- spec/fixtures/unrecognizable-scheme/test.html
+- spec/lib/sanity_checker.rb
+has_rdoc: