access_lint 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6888daa724299ad8681eb1c902ab0c38b3286094
-  data.tar.gz: fa5edfcfbd39d1e5f66fdec961610c6e23599e40
+  metadata.gz: c24905f58182a273d81c472cb6039096550665b5
+  data.tar.gz: 64e9ae9282bf3b4a81094952d7a089c3204cbe00
 SHA512:
-  metadata.gz: 9d5b4368da29009d9705a0c721278ec8f9bf4fc98f59e26d684ca462c709445b6c557c310c4b00506716f39657844d5e58f32ba0c22e1eea0d804b9a28e700ae
-  data.tar.gz: d2811c4a2fa89d60ba646e776c831d440901ef67636c7f2aed788819c8f4911d7ebe4f99b01c46cfbb58414b481cc74499996d3fafc19f2a8662e38e55d6136c
+  metadata.gz: d92d4c4aaa4e064ca6e246d97bf17748f4a78d6530c2f8e71d37e5c464b42d8a9aef3bc0df1c27f58a883a6c5cb15040894c4dd20f7151353f8652ecefb7c417
+  data.tar.gz: 9356133444a1c5ab3eed241a6823f1f411fd72d35b29224ba677cb38135d211632474828f2d2f9fa89e5d05d1415e252f33036eb06831da58529eeeabe4146f2

data/README.md

@@ -1,44 +1,61 @@
 # AccessLint
-Command line runner for Google Accessibility Developer Tools.
 
-## Installation
+Run accessibility audits on web pages from the command line.
 
-Install phantomjs:
+## About
 
-    $ brew install phantomjs
+AccessLint uses the [Accessibility Developer Tools](https://github.com/GoogleChrome/accessibility-developer-tools) javascript library to make assertions on the DOM via PhantomJS.
 
-Add this line to your application's Gemfile:
+## Installation
 
-    gem 'access_lint'
+    $ brew install phantomjs
 
-And then execute:
+    $ gem install access_lint
 
-    $ bundle
+    $ access_lint audit <url-or-filename>
 
-## Usage
+## Command Line Usage
 
-    $ bundle exec access_lint <url-or-filename>
+Running the `audit` command will return an array of stringified JSON objects to stdout:
 
-### Example
+    $ access_lint audit TARGET  # TARGET can be a url or a path to a file
 
-    $ bundle exec access_lint http://github.com
-    > *** Begin accessibility audit results ***
-    An accessibility audit found
-    Warnings:
-    Warning: AX_FOCUS_01 (These elements are focusable but either invisible or obscured by another element) failed on the following element:
-    body > .container > .site-footer > A
-    See https://code.google.com/p/accessibility-developer-tools/wiki/AuditRules#AX_FOCUS_01:_These_elements_are_focusable_but_either_invisible_o for more information.
+The JSON structure looks like:
 
-    Warning: AX_COLOR_01 (Text elements should have a reasonable contrast ratio) failed on the following elements (1 - 5 of 15):
-    #site-container > .marketing-section.marketing-benefits > .container > .row > .one-third.column:nth-of-type(3) > P > A
-    #site-container > .marketing-section.marketing-desktop > .container > .marketing-header > .show-mac.show-linux > .text-muted
-    #site-container > .marketing-section.marketing-desktop > .container > .marketing-header > .show-mac.show-linux > .text-muted > A
-    body > .container > .site-footer > .site-footer-links.right > LI > A
-    body > .container > .site-footer > .site-footer-links.right > LI:nth-of-type(2) > A
-    See https://code.google.com/p/accessibility-developer-tools/wiki/AuditRules#AX_COLOR_01:_Text_elements_should_have_a_reasonable_contrast_rat for more information.
+    [
+        { 
+        "element_names": ["<p class=\"foo\">relevant element</p>"], # array of string values for applicable DOM nodes
+        "elements": [DOM node],                                     # array of failing nodes as DOM objects.
+        "severity": "WARNING",                                      # string for the severity of the failure.
+        "status": "PASS",                                           # 'PASS', 'FAIL', or 'NA'
+        "title": "Some description"                                 # string description of the failure.
+        }
+    ]
 
+### Example
 
-    *** End accessibility audit results ***
+    $ access_lint audit http://ckundo.com
+    
+    [{"element_names": ["<span class=\"blogger-gear\"></span>"], "elements": [DOM node], "severity"=>"Warning", "status"=>"FAIL", "title"=>"Meaningful images should not be used in element backgrounds"}, ...]
+
+## Rules
+
+For full descriptions of the audit rules, visit the [Accessibility Developer Tools project wiki](https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules)
+
+* Audio elements should have controls
+* ARIA state and property values must be valid
+* Elements with ARIA roles must use a valid, non-abstract ARIA role
+* Controls and media elements should have labels
+* These elements are focusable but either invisible or obscured by another element
+* Images should have an alt attribute
+* The purpose of each link should be clear from the link text
+* Text elements should have a reasonable contrast ratio
+* role=main should only appear on significant elements
+* Meaningful images should not be used in element backgrounds
+* aria-labelledby attributes should refer to an element which exists in the DOM
+* The web page should have a title that describes topic or purpose
+* Elements with ARIA roles must have all required attributes for that role
+* Video elements should use <track> elements to provide captions
 
 ## Contributing
 

data/lib/access_lint.rb

@@ -1,5 +1,10 @@
 require "access_lint/version"
 
 module AccessLint
-  autoload :Audit, 'access_lint/audit'
+  autoload :Audit, 'access_lint/runner'
+  autoload :Runner, 'access_lint/audit'
+
+  class Error < StandardError; end
+  class AuditError < Error; end
+  class ParserError < Error; end
 end

data/lib/access_lint/audit.rb

@@ -3,17 +3,34 @@ require 'json'
 
 module AccessLint
   class Audit
-    RUNNER_PATH = File.expand_path("../../../vendor/access-lint/bin/auditor.js", __FILE__)
+    attr_reader :target
 
     def initialize(target)
       @target = target
     end
 
     def run
-      result = `phantomjs #{RUNNER_PATH} #{@target}`
-      if !result.nil?
-        JSON.parse(result)
-      end
+      perform_audit
+    end
+
+    def runner
+      @runner ||= Runner.new(@target)
+    end
+
+    private
+
+    def perform_audit
+      runner.run
+      @output = runner.output
+      parse_output
+    end
+
+    def parse_output
+      raw_results = JSON.parse(@output)
+      raw_results.map { |result| result.delete('elements') }
+      @results = raw_results.group_by { |result| result['status'] }
+    rescue Exception => e
+      raise AccessLint::ParserError.new(e.message)
     end
   end
 end

data/lib/access_lint/runner.rb

@@ -0,0 +1,31 @@
+module AccessLint
+  class Runner
+    RUNNER_PATH = File.expand_path("../../../vendor/access-lint/bin/auditor.js", __FILE__)
+    attr_reader :output
+
+    def initialize(target)
+      @target = target
+    end
+
+    def run
+      @output = `phantomjs #{RUNNER_PATH} #{@target}`
+      return if audit_success?
+
+      if !phantomjs_installed?
+        raise AccessLint::RunnerError.new("Please install PhantomJS. Visit http://phantomjs.org/ for instructions.")
+      else
+        raise AccessLint::RunnerError.new("PhantomJS exited without success: #{@output}")
+      end
+    end
+
+    private
+
+    def audit_success?
+      $?.success?
+    end
+
+    def phantomjs_installed?
+      $?.exitstatus != 127
+    end
+  end
+end

data/lib/access_lint/version.rb

@@ -1,3 +1,3 @@
 module AccessLint
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end

data/spec/access_lint/audit_spec.rb

@@ -2,14 +2,16 @@ require 'spec_helper'
 
 module AccessLint
   describe Audit do
-    let(:target) { double(:target) }
 
     describe '#run' do
-      let(:audit) { Audit.new(target) }
+      it 'return a parsed set of results' do
+        target = double
+        output = JSON.generate([{status: 'passing', foo: 'bar'}])
 
-      it 'runs phantomjs' do
-        audit.should_receive(:`).with(/^phantomjs.*/)
-        audit.run
+        audit = Audit.new(target)
+        audit.stub(:runner) { double(:runner, output: output, run: double) }
+
+        expect(audit.run).to eq "passing"=>[{"status"=>"passing", "foo"=>"bar"}]
       end
     end
   end

data/spec/access_lint/runner_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+module AccessLint
+  describe Runner do
+    it 'runs phantomjs' do
+      target = double
+      runner = Runner.new(target)
+
+      expect(runner).to receive(:`).with(/^phantomjs.*/)
+      runner.run
+    end
+  end
+end

data/vendor/access-lint/bin/auditor.js

@@ -10,6 +10,10 @@ page.onResourceTimeout = function(e) {
   phantom.exit(1);
 };
 
+page.onError = function(message) {
+  // suppress errors
+};
+
 if (system.args.length !== 2) {
   console.log('Usage: phantomjs auditor.js URL');
   phantom.exit();

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: access_lint
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Cameron Cundiff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-23 00:00:00.000000000 Z
+date: 2014-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -86,9 +86,11 @@ files:
 - lib/access_lint.rb
 - lib/access_lint/audit.rb
 - lib/access_lint/cli.rb
+- lib/access_lint/runner.rb
 - lib/access_lint/version.rb
 - spec/access_lint/audit_spec.rb
 - spec/access_lint/cli_spec.rb
+- spec/access_lint/runner_spec.rb
 - spec/spec_helper.rb
 - vendor/access-lint/README.md
 - vendor/access-lint/bin/auditor.js
@@ -122,4 +124,5 @@ summary: AccessLint runs Google Accessibility Developer Tools assertions on a pa
 test_files:
 - spec/access_lint/audit_spec.rb
 - spec/access_lint/cli_spec.rb
+- spec/access_lint/runner_spec.rb
 - spec/spec_helper.rb