site-inspector 3.1.0 → 3.1.1

data/lib/site-inspector/version.rb

@@ -1,3 +1,3 @@
 class SiteInspector
-  VERSION = "3.1.0"
+  VERSION = '3.1.1'
 end

data/script/cibuild

@@ -2,8 +2,10 @@
 
 set -e
 
-echo "Pa11y version: $(pa11y --version)"
+script/pa11y-version
 
 bundle exec rake spec
 
+bundle exec rubocop 
+
 gem build site-inspector.gemspec

data/script/pa11y-version

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require './lib/site-inspector'
+
+if SiteInspector::Endpoint::Accessibility.pa11y?
+  puts "Pa11y version: #{SiteInspector::Endpoint::Accessibility.pa11y_version}"
+else
+  puts '**RUNNING TESTS WITHOUT PA11Y**'
+end

data/site-inspector.gemspec

@@ -1,35 +1,35 @@
-require File.expand_path "./lib/site-inspector/version", File.dirname(__FILE__)
+require File.expand_path './lib/site-inspector/version', File.dirname(__FILE__)
 
 Gem::Specification.new do |s|
-
-  s.name                  = "site-inspector"
+  s.name                  = 'site-inspector'
   s.version               = SiteInspector::VERSION
-  s.summary               = "A Ruby port and v2 of Site Inspector (https://github.com/benbalter/site-inspector)"
+  s.summary               = 'A Ruby port and v2 of Site Inspector (https://github.com/benbalter/site-inspector)'
   s.description           = "Returns information about a domain's technology and capabilities"
-  s.authors               = "Ben Balter"
-  s.email                 = "ben@balter.com"
-  s.homepage              = "https://github.com/benbalter/site-inspector"
-  s.license               = "MIT"
+  s.authors               = 'Ben Balter'
+  s.email                 = 'ben@balter.com'
+  s.homepage              = 'https://github.com/benbalter/site-inspector'
+  s.license               = 'MIT'
 
   s.files                 = `git ls-files -z`.split("\x0")
   s.executables           = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.test_files            = s.files.grep(%r{^(test|spec|features)/})
-  s.require_paths         = ["lib"]
+  s.require_paths         = ['lib']
 
-  s.add_dependency("nokogiri", "~> 1.6")
-  s.add_dependency("public_suffix", "~> 1.4")
-  s.add_dependency("gman", "~> 4.1")
-  s.add_dependency("dnsruby", "~> 1.56")
-  s.add_dependency("sniffles", "~> 0.2")
-  s.add_dependency("typhoeus", "~> 0.7")
-  s.add_dependency("oj", "~> 2.11")
-  s.add_dependency("mercenary", "~> 0.3")
-  s.add_dependency("colorator", "~> 0.1")
-  s.add_dependency("cliver", "~> 0.3")
-  s.add_dependency("parallel", "~> 1.6")
-  s.add_development_dependency("pry", "~> 0.10")
-  s.add_development_dependency( "rake", "~> 10.4" )
-  s.add_development_dependency( "rspec", "~> 3.2")
-  s.add_development_dependency( "bundler", "~> 1.6" )
-  s.add_development_dependency( "webmock", "~> 1.2" )
+  s.add_dependency('nokogiri', '~> 1.6')
+  s.add_dependency('public_suffix', '~> 1.4')
+  s.add_dependency('gman', '~> 4.1')
+  s.add_dependency('dnsruby', '~> 1.56')
+  s.add_dependency('sniffles', '~> 0.2')
+  s.add_dependency('typhoeus', '~> 0.7')
+  s.add_dependency('oj', '~> 2.11')
+  s.add_dependency('mercenary', '~> 0.3')
+  s.add_dependency('colorator', '~> 0.1')
+  s.add_dependency('cliver', '~> 0.3')
+  s.add_dependency('parallel', '~> 1.6')
+  s.add_development_dependency('pry', '~> 0.10')
+  s.add_development_dependency('rake', '~> 10.4')
+  s.add_development_dependency('rspec', '~> 3.2')
+  s.add_development_dependency('bundler', '~> 1.6')
+  s.add_development_dependency('webmock', '~> 1.2')
+  s.add_development_dependency('rubocop', '~> 0.35')
 end

data/spec/checks/site_inspector_endpoint_accessibility_spec.rb

@@ -1,81 +1,82 @@
 require 'spec_helper'
 
 describe SiteInspector::Endpoint::Accessibility do
-
   subject do
-    endpoint = SiteInspector::Endpoint.new("http://example.com")
+    endpoint = SiteInspector::Endpoint.new('http://example.com')
     SiteInspector::Endpoint::Accessibility.new(endpoint)
   end
 
   it "retrieve's pa11y's version" do
+    pending('Pa11y not installed') unless SiteInspector::Endpoint::Accessibility.pa11y?
     expect(subject.class.pa11y_version).to match(/\d\.\d\.\d/)
   end
 
-  it "responds to valid standards" do
+  it 'responds to valid standards' do
     expect(subject.respond_to?(:section508)).to eql(true)
   end
 
-  it "knows the level" do
+  it 'knows the level' do
     expect(subject.level).to eql(:error)
   end
 
-  it "allows the user to set the level" do
+  it 'allows the user to set the level' do
     subject.level = :warning
     expect(subject.level).to eql(:warning)
   end
 
-  it "errors on invalid levels" do
-    expect{subject.level="foo"}.to raise_error(ArgumentError)
+  it 'errors on invalid levels' do
+    expect { subject.level = 'foo' }.to raise_error(ArgumentError)
   end
 
-  it "knows the standard" do
+  it 'knows the standard' do
     expect(subject.standard).to eql(:section508)
   end
 
-  it "allows the user to set the standard" do
+  it 'allows the user to set the standard' do
     subject.standard = :wcag2a
     expect(subject.standard).to eql(:wcag2a)
   end
 
-  it "errors on invalid standards" do
-    expect{subject.standard=:foo}.to raise_error(ArgumentError)
+  it 'errors on invalid standards' do
+    expect { subject.standard = :foo }.to raise_error(ArgumentError)
   end
 
-  context "with pa11y installed" do
-
+  context 'with pa11y installed' do
     before do
-      stub_request(:head, "http://example.com/").to_return(:status => 200 )
+      stub_request(:head, 'http://example.com/').to_return(status: 200)
     end
-
   end
 
   context "with pa11y stub'd" do
-
     before do
       output = '[{"code":"Section508.L.NoContentAnchor","context":"<a href=\"foo\"></a>","message":"Anchor element found with a valid href attribute, but no link content has been supplied.","selector":"html > body > a","type":"error","typeCode":1}]'
       allow(subject).to receive(:run_command) { [output, 2] }
     end
 
-    it "knows if pa11y is installed" do
-      expect(subject.class.pa11y?).to eql(true)
-    end
-
-    it "knows if a site is valid" do
-      expect(subject.valid?).to eql(false)
+    it 'knows if a site is valid' do
+      with_env 'SKIP_PA11Y_CHECK', 'true' do
+        expect(subject.valid?).to eql(false)
+      end
     end
 
-    it "counts the errors" do
-      expect(subject.errors).to eql(1)
+    it 'counts the errors' do
+      with_env 'SKIP_PA11Y_CHECK', 'true' do
+        expect(subject.errors).to eql(1)
+      end
     end
 
-    it "runs the check" do
-      expect(subject.check[:valid]).to eql(false)
-      expect(subject.check[:results].first["code"]).to eql("Section508.L.NoContentAnchor")
+    it 'runs the check' do
+      with_env 'SKIP_PA11Y_CHECK', 'true' do
+        expect(subject.check[:valid]).to eql(false)
+        expect(subject.check[:results].first['code']).to eql('Section508.L.NoContentAnchor')
+      end
     end
 
-    it "runs a named check" do
-      expect(subject.check[:valid]).to eql(false)
-      expect(subject.check[:results].first["code"]).to eql("Section508.L.NoContentAnchor")
+    it 'runs a named check' do
+      with_env 'SKIP_PA11Y_CHECK', 'true' do
+        expect(subject.check[:valid]).to eql(false)
+        expect(subject.check[:results].first['code']).to eql('Section508.L.NoContentAnchor')
+      end
     end
   end
 end

data/spec/checks/site_inspector_endpoint_check_spec.rb

@@ -1,38 +1,37 @@
 require 'spec_helper'
 
 describe SiteInspector::Endpoint::Check do
-
   subject do
-    stub_request(:head, "http://example.com/").to_return(:status => 200)
-    endpoint = SiteInspector::Endpoint.new("http://example.com")
+    stub_request(:head, 'http://example.com/').to_return(status: 200)
+    endpoint = SiteInspector::Endpoint.new('http://example.com')
     SiteInspector::Endpoint::Check.new(endpoint)
   end
 
-  it "returns the endpoint" do
+  it 'returns the endpoint' do
     expect(subject.endpoint.class).to eql(SiteInspector::Endpoint)
   end
 
-  it "returns the response" do
+  it 'returns the response' do
     expect(subject.response.class).to eql(Typhoeus::Response)
   end
 
-  it "returns the request" do
+  it 'returns the request' do
     expect(subject.request.class).to eql(Typhoeus::Request)
   end
 
-  it "returns the host" do
-    expect(subject.host).to eql("example.com")
+  it 'returns the host' do
+    expect(subject.host).to eql('example.com')
   end
 
-  it "returns its name" do
+  it 'returns its name' do
     expect(subject.name).to eql(:check)
   end
 
-  it "returns the instance name" do
+  it 'returns the instance name' do
     expect(SiteInspector::Endpoint::Check.name).to eql(:check)
   end
 
-  it "enables and disables the check" do
+  it 'enables and disables the check' do
     expect(SiteInspector::Endpoint::Check.enabled?).to eql(true)
     SiteInspector::Endpoint::Check.enabled = false
     expect(SiteInspector::Endpoint::Check.enabled?).to eql(false)

data/spec/checks/site_inspector_endpoint_content_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe SiteInspector::Endpoint::Content do
-
   subject do
     body = <<-eos
     <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
@@ -12,97 +11,97 @@ describe SiteInspector::Endpoint::Content do
       </html>
     eos
 
-    stub_request(:get, "http://example.com/").
-      to_return(:status => 200, :body => body )
-      stub_request(:head, "http://example.com/").
-        to_return(:status => 200 )
-    endpoint = SiteInspector::Endpoint.new("http://example.com")
+    stub_request(:get, 'http://example.com/')
+      .to_return(status: 200, body: body)
+    stub_request(:head, 'http://example.com/')
+      .to_return(status: 200)
+    endpoint = SiteInspector::Endpoint.new('http://example.com')
     SiteInspector::Endpoint::Content.new(endpoint)
   end
 
-  it "returns the doc" do
+  it 'returns the doc' do
     expect(subject.document.class).to eql(Nokogiri::HTML::Document)
-    expect(subject.document.css("h1").text).to eql("Some page")
+    expect(subject.document.css('h1').text).to eql('Some page')
   end
 
-  it "returns the body" do
-    expect(subject.body).to match("<h1>Some page</h1>")
+  it 'returns the body' do
+    expect(subject.body).to match('<h1>Some page</h1>')
   end
 
-  it "returns the doctype" do
-    expect(subject.doctype).to eql("-//W3C//DTD XHTML 1.0 Transitional//EN")
+  it 'returns the doctype' do
+    expect(subject.doctype).to eql('-//W3C//DTD XHTML 1.0 Transitional//EN')
   end
 
-  it "knows when robots.txt exists" do
-    stub_request(:head, /http\:\/\/example.com\/[a-z0-9]{32}/i).to_return(:status => 404)
+  it 'knows when robots.txt exists' do
+    stub_request(:head, %r{http\://example.com/[a-z0-9]{32}}i).to_return(status: 404)
 
-    stub_request(:head, "http://example.com/robots.txt").
-      to_return(:status => 200)
+    stub_request(:head, 'http://example.com/robots.txt')
+      .to_return(status: 200)
     expect(subject.robots_txt?).to eql(true)
   end
 
   it "knows when robots.txt doesn't exist" do
-    stub_request(:head, /http\:\/\/example.com\/[a-z0-9]{32}/i).to_return(:status => 404)
+    stub_request(:head, %r{http\://example.com/[a-z0-9]{32}}i).to_return(status: 404)
 
-    stub_request(:head, "http://example.com/robots.txt").
-      to_return(:status => 404)
+    stub_request(:head, 'http://example.com/robots.txt')
+      .to_return(status: 404)
     expect(subject.robots_txt?).to eql(false)
   end
 
-  it "knows when sitemap.xml exists" do
-    stub_request(:head, /http\:\/\/example.com\/[a-z0-9]{32}/i).to_return(:status => 404)
+  it 'knows when sitemap.xml exists' do
+    stub_request(:head, %r{http\://example.com/[a-z0-9]{32}}i).to_return(status: 404)
 
-    stub_request(:head, "http://example.com/sitemap.xml").
-      to_return(:status => 200)
+    stub_request(:head, 'http://example.com/sitemap.xml')
+      .to_return(status: 200)
     expect(subject.sitemap_xml?).to eql(true)
   end
 
-  it "knows when sitemap.xml exists" do
-    stub_request(:head, /http\:\/\/example.com\/[a-z0-9]{32}/i).to_return(:status => 404)
+  it 'knows when sitemap.xml exists' do
+    stub_request(:head, %r{http\://example.com/[a-z0-9]{32}}i).to_return(status: 404)
 
-    stub_request(:head, "http://example.com/sitemap.xml").
-      to_return(:status => 404)
+    stub_request(:head, 'http://example.com/sitemap.xml')
+      .to_return(status: 404)
     expect(subject.sitemap_xml?).to eql(false)
   end
 
-  it "knows when humans.txt exists" do
-    stub_request(:head, /http\:\/\/example.com\/[a-z0-9]{32}/i).to_return(:status => 404)
+  it 'knows when humans.txt exists' do
+    stub_request(:head, %r{http\://example.com/[a-z0-9]{32}}i).to_return(status: 404)
 
-    stub_request(:head, "http://example.com/humans.txt").
-      to_return(:status => 200)
+    stub_request(:head, 'http://example.com/humans.txt')
+      .to_return(status: 200)
     expect(subject.humans_txt?).to eql(true)
   end
 
   it "knows when humans.txt doesn't exist" do
-    stub_request(:head, /http\:\/\/example.com\/[a-z0-9]{32}/i).to_return(:status => 404)
+    stub_request(:head, %r{http\://example.com/[a-z0-9]{32}}i).to_return(status: 404)
 
-    stub_request(:head, "http://example.com/humans.txt").
-      to_return(:status => 200)
+    stub_request(:head, 'http://example.com/humans.txt')
+      .to_return(status: 200)
     expect(subject.humans_txt?).to eql(true)
   end
 
-  context "404s" do
-    it "knows when an endpoint returns a proper 404" do
-      stub_request(:head, /http\:\/\/example.com\/.*/).
-        to_return(:status => 404)
+  context '404s' do
+    it 'knows when an endpoint returns a proper 404' do
+      stub_request(:head, %r{http\://example.com/.*})
+        .to_return(status: 404)
       expect(subject.proper_404s?).to eql(true)
     end
 
     it "knows when an endpoint doesn't return a proper 404" do
-      stub_request(:head, /http\:\/\/example.com\/[a-z0-9]{32}/i).
-        to_return(:status => 200)
+      stub_request(:head, %r{http\://example.com/[a-z0-9]{32}}i)
+        .to_return(status: 200)
       expect(subject.proper_404s?).to eql(false)
     end
 
-    it "generates a random path" do
+    it 'generates a random path' do
       path = subject.send(:random_path)
-      expect(path).to match /[a-z0-9]{32}/i
+      expect(path).to match(/[a-z0-9]{32}/i)
       expect(subject.send(:random_path)).to eql(path)
     end
 
     it "doesn't say something exists when there are no 404s" do
-      stub_request(:head, /http\:\/\/example.com\/[a-z0-9]{32}/i).to_return(:status => 200)
-      stub_request(:head, "http://example.com/humans.txt").to_return(:status => 200)
+      stub_request(:head, %r{http\://example.com/[a-z0-9]{32}}i).to_return(status: 200)
+      stub_request(:head, 'http://example.com/humans.txt').to_return(status: 200)
       expect(subject.humans_txt?).to eql(nil)
     end
   end

data/spec/checks/site_inspector_endpoint_cookies_spec.rb

@@ -1,51 +1,50 @@
 require 'spec_helper'
 
 describe SiteInspector::Endpoint::Cookies do
-
-  context "without cookies" do
+  context 'without cookies' do
     subject do
-      stub_request(:head, "http://example.com/").
-        to_return(:status => 200, :body => "" )
-      endpoint = SiteInspector::Endpoint.new("http://example.com")
+      stub_request(:head, 'http://example.com/')
+        .to_return(status: 200, body: '')
+      endpoint = SiteInspector::Endpoint.new('http://example.com')
       SiteInspector::Endpoint::Cookies.new(endpoint)
     end
 
-    it "knows when there are no cookies" do
+    it 'knows when there are no cookies' do
       expect(subject.cookies?).to eql(false)
       expect(subject.all).to eql(nil)
     end
   end
 
-  context "with cookies" do
+  context 'with cookies' do
     subject do
       cookies = [
-        CGI::Cookie::new(
-          "name"   => "foo",
-          "value"  => "bar",
-          "domain" => "example.com",
-          "path"   => "/"
+        CGI::Cookie.new(
+          'name'   => 'foo',
+          'value'  => 'bar',
+          'domain' => 'example.com',
+          'path'   => '/'
         ),
-        CGI::Cookie::new(
-          "name"   => "foo2",
-          "value"  => "bar2",
-          "domain" => "example.com",
-          "path"   => "/"
+        CGI::Cookie.new(
+          'name'   => 'foo2',
+          'value'  => 'bar2',
+          'domain' => 'example.com',
+          'path'   => '/'
         )
-      ].map { |c| c.to_s }
+      ].map(&:to_s)
 
-      stub_request(:head, "http://example.com/").
-        to_return(:status => 200, :body => "", :headers => { "set-cookie" => cookies })
-      endpoint = SiteInspector::Endpoint.new("http://example.com")
+      stub_request(:head, 'http://example.com/')
+        .to_return(status: 200, body: '', headers: { 'set-cookie' => cookies })
+      endpoint = SiteInspector::Endpoint.new('http://example.com')
       SiteInspector::Endpoint::Cookies.new(endpoint)
     end
 
-    it "knows when there are cookies" do
+    it 'knows when there are cookies' do
       expect(subject.cookies?).to eql(true)
       expect(subject.all.count).to eql(2)
     end
 
-    it "returns a cookie by name" do
-      expect(subject["foo"].to_s).to match(/foo=bar/)
+    it 'returns a cookie by name' do
+      expect(subject['foo'].to_s).to match(/foo=bar/)
     end
 
     it "knows cookies aren't secure" do
@@ -53,19 +52,19 @@ describe SiteInspector::Endpoint::Cookies do
     end
   end
 
-  context "with secure cookies" do
+  context 'with secure cookies' do
     subject do
       cookies = [
-        "foo=bar; domain=example.com; path=/; secure; HttpOnly",
-        "foo2=bar2; domain=example.com; path=/"
+        'foo=bar; domain=example.com; path=/; secure; HttpOnly',
+        'foo2=bar2; domain=example.com; path=/'
       ]
-      stub_request(:head, "http://example.com/").
-        to_return(:status => 200, :body => "", :headers => { "set-cookie" => cookies })
-      endpoint = SiteInspector::Endpoint.new("http://example.com")
+      stub_request(:head, 'http://example.com/')
+        .to_return(status: 200, body: '', headers: { 'set-cookie' => cookies })
+      endpoint = SiteInspector::Endpoint.new('http://example.com')
       SiteInspector::Endpoint::Cookies.new(endpoint)
     end
 
-    it "knows cookies are secure" do
+    it 'knows cookies are secure' do
       expect(subject.secure?).to eql(true)
     end
   end