html-proofer 2.5.1 → 2.5.2

data/.gitignore

@@ -1,26 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-coverage
-InstalledFiles
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-
-Gemfile.lock
-out/
-sample.rb
-run_sample.rb
-src/
-docs/
-
-# YARD artifacts
-.yardoc
-_yardoc
-doc/
-.DS_Store

data/.travis.yml

@@ -1,14 +0,0 @@
-language: ruby
-rvm:
-  - 2.0
-  - 2.1
-  - 2.2
-env:
-  global:
-    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
-
-sudo: false
-cache: bundler
-
-git:
-  depth: 10

data/Gemfile

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

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2013 Garen Torikian
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,276 +0,0 @@
-# HTML::Proofer
-
-If you generate HTML files, _then this tool might be for you_.
-
-`HTML::Proofer` is a set of tests to validate your HTML output. These tests check if your image references are legitimate, if they have alt tags, if your internal links are working, and so on. It's intended to be an all-in-one checker for your output.
-
-[![Build Status](https://travis-ci.org/gjtorikian/html-proofer.svg?branch=master)](https://travis-ci.org/gjtorikian/html-proofer) [![Gem Version](https://badge.fury.io/rb/html-proofer.svg)](http://badge.fury.io/rb/html-proofer)
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'html-proofer'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install html-proofer
-
-**NOTE:** When installation speed matters, set `NOKOGIRI_USE_SYSTEM_LIBRARIES` to `true` in your environment. This is useful for increasing the speed of your Continuous Integration builds.
-
-## What's Tested?
-
-You can enable or disable most of the following checks.
-
-### Images
-
-`img` elements:
-
-* Whether all your images have alt tags
-* Whether your internal image references are not broken
-* Whether external images are showing
-
-### Links
-
-`a`, `link` elements:
-
-* Whether your internal links are working
-* Whether your internal hash references (`#linkToMe`) are working
-* Whether external links are working
-
-### Scripts
-
-`script` elements:
-
-* Whether your internal script references are working
-* Whether external scripts are loading
-
-### Favicon
-
-* Whether your favicons are valid.
-
-### HTML
-
-* Whether your HTML markup is valid. This is done via [Nokogiri, to ensure well-formed markup](http://www.nokogiri.org/tutorials/ensuring_well_formed_markup.html).
-
-## Usage
-
-### Using in a script
-
-Require the gem; generate some HTML; create a new instance of the `HTML::Proofer` on
-your output folder; then `run` it. Here's a simple example:
-
-```ruby
-require 'html/proofer'
-require 'html/pipeline'
-require 'find'
-
-# make an out dir
-Dir.mkdir("out") unless File.exist?("out")
-
-pipeline = HTML::Pipeline.new [
-  HTML::Pipeline::MarkdownFilter,
-  HTML::Pipeline::TableOfContentsFilter
-], :gfm => true
-
-# iterate over files, and generate HTML from Markdown
-Find.find("./docs") do |path|
-  if File.extname(path) == ".md"
-    contents = File.read(path)
-    result = pipeline.call(contents)
-
-    File.open("out/#{path.split("/").pop.sub('.md', '.html')}", 'w') { |file| file.write(result[:output].to_s) }
-  end
-end
-
-# test your out dir!
-HTML::Proofer.new("./out").run
-```
-
-### Using on the command-line
-
-You'll get a new program called `htmlproof` with this gem. Terrific!
-
-Use it like you'd expect to:
-
-``` bash
-htmlproof ./out --href-swap wow:cow,mow:doh --ext .html.erb --href-ignore www.github.com
-```
-
-Note: since `href_swap` is a bit special, you'll pass in a pair of `RegEx:String` values.
-`htmlproof` will figure out what you mean.
-
-### Using with Jekyll
-
-Want to use HTML Proofer with your Jekyll site? Awesome. Simply add `gem 'html-proofer'`
-to your `Gemfile` as described above, and add the following to your `Rakefile`,
-using `rake test` to execute:
-
-```ruby
-require 'html/proofer'
-
-task :test do
-  sh "bundle exec jekyll build"
-  HTML::Proofer.new("./_site").run
-end
-```
-
-Don't have or want a `Rakefile`? You can also do something like the following:
-
-```bash
-htmlproof ./_site
-```
-
-### Array of links
-
-Instead of a directory as the first argument, you can also pass in an array of links:
-
-``` ruby
-HTML::Proofer.new(["http://github.com", "http://jekyllrb.com"])
-```
-
-This configures Proofer to just test those links to ensure they are valid. Note that for the command-line, you'll need to pass a special `--as-links` argument:
-
-``` bash
-htmlproof www.google.com,www.github.com --as-links
-```
-
-## Ignoring content
-
-Add the `data-proofer-ignore` attribute to any tag to ignore it from every check.
-
-``` html
-<a href="http://notareallink" data-proofer-ignore>Not checked.</a>
-```
-
-## Configuration
-
-The `HTML::Proofer` constructor takes an optional hash of additional options:
-
-| Option | Description | Default |
-| :----- | :---------- | :------ |
-| `alt_ignore` | An array of Strings or RegExps containing `img`s whose missing `alt` tags are safe to ignore. | `[]` |
-| `empty_alt_ignore` | If `true`, ignores images with empty alt tags. | `false` |
-| `check_external_hash` | Checks whether external hashes exist (even if the website exists). This slows the checker down. | `false` |
-| `check_favicon` | Enables the favicon checker. | `false` |
-| `check_html` | Enables HTML validation errors from Nokogiri | `false` |
-|`checks_to_ignore`| An array of Strings indicating which checks you'd like to not perform. | `[]`
-| `directory_index_file` | Sets the file to look for when a link refers to a directory. | `index.html` |
-| `disable_external` | If `true`, does not run the external link checker, which can take a lot of time. | `false` |
-| `error_sort` | Defines the sort order for error output. Can be `:path`, `:desc`, or `:status`. | `:path`
-| `ext` | The extension of your HTML files including the dot. | `.html`
-| `file_ignore` | An array of Strings or RegExps containing file paths that are safe to ignore. | `[]` |
-| `href_ignore` | An array of Strings or RegExps containing `href`s that are safe to ignore. Note that non-HTTP(S) URIs are always ignored. **Will be renamed in a future release.** | `[]` |
-| `href_swap` | A hash containing key-value pairs of `RegExp => String`. It transforms links that match `RegExp` into `String` via `gsub`. **Will be renamed in a future release.** | `{}` |
-| `ignore_script_embeds` | When `check_html` is enabled, `script` tags containing markup [are reported as errors](http://git.io/vOovv). Enabling this option ignores those errors. | `false`
-| `only_4xx` | Only reports errors for links that fall within the 4xx status code range. | `false` |
-| `url_ignore` | An array of Strings or RegExps containing URLs that are safe to ignore. It affects all HTML attributes. Note that non-HTTP(S) URIs are always ignored. | `[]` |
-| `verbose` | If `true`, outputs extra information as the checking happens. Useful for debugging. **Will be deprecated in a future release.**| `false` |
-| `verbosity` | Sets the logging level, as determined by [Yell](https://github.com/rudionrails/yell). | `:info`
-
-### Configuring Typhoeus and Hydra
-
-[Typhoeus](https://github.com/typhoeus/typhoeus) is used to make fast, parallel requests to external URLs. You can pass in any of Typhoeus' options for the external link checks with the options namespace of `:typhoeus`. For example:
-
-``` ruby
-HTML::Proofer.new("out/", {:ext => ".htm", :typhoeus => { :verbose => true, :ssl_verifyhost => 2 } })
-```
-
-This sets `HTML::Proofer`'s extensions to use _.htm_, gives Typhoeus a configuration for it to be verbose, and use specific SSL settings. Check [the Typhoeus documentation](https://github.com/typhoeus/typhoeus#other-curl-options) for more information on what options it can receive.
-
-You can similarly pass in a `:hydra` option with a hash configuration for Hydra.
-
-The default value is `typhoeus => { :followlocation => true }`.
-
-### Configuring Parallel
-
-[Parallel](https://github.com/grosser/parallel) is used to speed internal file checks. You can pass in any of its options with the options namespace `:parallel`. For example:
-
-``` ruby
-HTML::Proofer.new("out/", {:ext => ".htm", :parallel => { :in_processes => 3} })
-```
-
-In this example, `:in_processes => 3` is passed into Parallel as a configuration option.
-
-## Logging
-
-HTML-Proofer can be as noisy or as quiet as you'd like. There are two ways to log information:
-
-* If you set the `:verbose` option to `true`, HTML-Proofer will provide some debug information.
-* If you set the `:verbosity` option, you can better define the level of logging. See the configuration table above for more information.
-
-`:verbosity` is newer and offers better configuration. `:verbose` will be deprecated in a future 3.x.x release.
-
-## Custom tests
-
-Want to write your own test? Sure! Just create two classes--one that inherits from `HTML::Proofer::Checkable`, and another that inherits from `HTML::Proofer::CheckRunner`.
-
-The `CheckRunner` subclass must define one method called `run`. This is called on your content, and is responsible for performing the validation on whatever elements you like. When you catch a broken issue, call `add_issue(message)` to explain the error.
-
-The `Checkable` subclass defines various helper methods you can use as part of your test. Usually, you'll want to instantiate it within `run`. You have access to all of your element's attributes.
-
-Here's an example custom test that protects against `mailto` links that point to `octocat@github.com`:
-
-``` ruby
-class OctocatLinkCheck < ::HTML::Proofer::Checkable
-  def mailto?
-    return false if @data_ignore_proofer || @href.nil? || @href.empty?
-    return @href.match /^mailto\:/
-  end
-
-  def octocat?
-    return @href.match /\:octocat@github.com\Z/
-  end
-
-end
-
-class MailToOctocat < ::HTML::Proofer::CheckRunner
-  def run
-    @html.css('a').each do |node|
-      link = OctocatLinkCheck.new(node, self)
-      line = node.line
-
-      if link.mailto? && link.octocat?
-        return add_issue("Don't email the Octocat directly!", line)
-      end
-    end
-  end
-end
-```
-
-## Troubleshooting
-
-### Certificates
-
-To ignore certificates, turn off Typhoeus' SSL verification:
-
-``` ruby
-HTML::Proofer.new("out/", {
-  :typhoeus => {
-    :ssl_verifypeer => false,
-    :ssl_verifyhost => 0}
-}).run
-```
-
-### User-Agent
-
-To change the User-Agent used by Typhoeus:
-
-``` ruby
-HTML::Proofer.new("out/", {
-  :typhoeus => {
-    :headers => { "User-Agent" => "Mozilla/5.0 (compatible; My New User-Agent)" }
-}}).run
-```
-
-## Real-life examples
-
-Project | Repository
-:--- | :---
-[Raspberry Pi documentation](http://www.raspberrypi.org/documentation/) | [raspberrypi/documentation]( https://github.com/raspberrypi/documentation)
-[Open Whisper Systems website](https://whispersystems.org/) | [WhisperSystems/whispersystems.org](https://github.com/WhisperSystems/whispersystems.org)
-[Jekyll website](http://jekyllrb.com/) | [jekyll/jekyll](https://github.com/jekyll/jekyll)

data/Rakefile

@@ -1,21 +0,0 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => [:spec, :proof_readme]
-
-task :proof_readme do
-  require 'html/proofer'
-  require 'redcarpet'
-
-  redcarpet = Redcarpet::Markdown.new Redcarpet::Render::HTML.new({}), {}
-  html = redcarpet.render File.read('README.md')
-
-  mkdir_p 'out'
-  File.write('out/README.html', html)
-
-  HTML::Proofer.new('./out').run
-end

data/html-proofer.gemspec

@@ -1,32 +0,0 @@
-# -*- encoding: utf-8 -*-
-$LOAD_PATH.push File.expand_path('../lib', __FILE__)
-require 'html/proofer/version'
-
-Gem::Specification.new do |gem|
-  gem.name          = 'html-proofer'
-  gem.version       = HTML::Proofer::VERSION
-  gem.authors       = ['Garen Torikian']
-  gem.email         = ['gjtorikian@gmail.com']
-  gem.description   = %(Test your rendered HTML files to make sure they're accurate.)
-  gem.summary       = %(A set of tests to validate your HTML output. These tests check if your image references are legitimate, if they have alt tags, if your internal links are working, and so on. It's intended to be an all-in-one checker for your documentation output.)
-  gem.homepage      = 'https://github.com/gjtorikian/html-proofer'
-  gem.license       = 'MIT'
-  gem.executables   = ['htmlproof']
-  gem.files         = `git ls-files -z`.split("\x0")
-  gem.test_files    = gem.files.grep(%r{^(spec)/})
-  gem.require_paths = ['lib']
-
-  gem.add_dependency 'mercenary',       '~> 0.3.2'
-  gem.add_dependency 'nokogiri',        '~> 1.5'
-  gem.add_dependency 'colored',         '~> 1.2'
-  gem.add_dependency 'typhoeus',        '~> 0.7'
-  gem.add_dependency 'yell',            '~> 2.0'
-  gem.add_dependency 'parallel',        '~> 1.3'
-  gem.add_dependency 'addressable',     '~> 2.3'
-
-  gem.add_development_dependency 'redcarpet'
-  gem.add_development_dependency 'rspec', '~> 3.1'
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'awesome_print'
-  gem.add_development_dependency 'vcr', '~> 2.9'
-end

data/script/bootstrap

@@ -1,5 +0,0 @@
-#!/bin/sh
-
-set -e
-
-bundle install "$@"

data/spec/html/proofer/checkable_spec.rb

@@ -1,47 +0,0 @@
-require 'spec_helper'
-
-describe HTML::Proofer::Checkable do
-  describe '#initialize' do
-    it 'accepts the xmlns attribute' do
-      nokogiri = Nokogiri::HTML '<a xmlns:cc="http://creativecommons.org/ns#">Creative Commons</a>'
-      checkable = HTML::Proofer::Checkable.new nokogiri.css('a').first, nil
-      expect(checkable.instance_variable_get(:@xmlns_cc)).to eq 'http://creativecommons.org/ns#'
-    end
-    it 'assignes the text node' do
-      nokogiri = Nokogiri::HTML '<p>One'
-      checkable = HTML::Proofer::Checkable.new nokogiri.css('p').first, nil
-      expect(checkable.instance_variable_get(:@text)).to eq 'One'
-    end
-    it 'accepts the content attribute' do
-      nokogiri = Nokogiri::HTML '<meta name="twitter:card" content="summary">'
-      checkable = HTML::Proofer::Checkable.new nokogiri.css('meta').first, nil
-      expect(checkable.instance_variable_get(:@content)).to eq 'summary'
-    end
-  end
-  describe '#ignores_pattern_check' do
-    it 'works for regex patterns' do
-      nokogiri = Nokogiri::HTML '<script src=/assets/main.js></script>'
-      checkable = HTML::Proofer::Checkable.new nokogiri.css('script').first, nil
-      expect(checkable.ignores_pattern_check([/\/assets\/.*(js|css|png|svg)/])).to eq true
-    end
-    it 'works for string patterns' do
-      nokogiri = Nokogiri::HTML '<script src=/assets/main.js></script>'
-      checkable = HTML::Proofer::Checkable.new nokogiri.css('script').first, nil
-      expect(checkable.ignores_pattern_check(['/assets/main.js'])).to eq true
-    end
-  end
-  describe '#url' do
-    it 'works for src attributes' do
-      nokogiri = Nokogiri::HTML '<img src=image.png />'
-      checkable = HTML::Proofer::Checkable.new nokogiri.css('img').first, nil
-      expect(checkable.url).to eq 'image.png'
-    end
-  end
-  describe '#ignore' do
-    it 'works for twitter cards' do
-      nokogiri = Nokogiri::HTML '<meta name="twitter:url" data-proofer-ignore content="http://example.com/soon-to-be-published-url">'
-      checkable = HTML::Proofer::Checkable.new nokogiri.css('meta').first, nil
-      expect(checkable.ignore?).to eq true
-    end
-  end
-end