entree 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ea2fc0302c380e238bf85c53b6431547992282d
+  data.tar.gz: 41b7226457ea08c5ebe0535cfaa4346a7fadedbc
+SHA512:
+  metadata.gz: 14dc75f4f7648e7145e0a7050d44d208703780386c683565781d1acfcbc90ac14ecfa956a3793b23f8e19d475b9438277949162f60346563e2b0b971e8a1d9ee
+  data.tar.gz: a676c99e4fad9e4a56e4a6b475173b98040f8ecbf7a6e7d6cfbc4baf0abcc4108348335da00d855648ec279e2fbb14159234821b58b25b6ea27e9101b5dfbceb

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# entree Changelog
+
+## v0.0.1
+
+* Rename from accesslint.rb to entree.rb

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in entree.gemspec
+gemspec
+
+group :development do
+  gem "minitest"
+  gem "pry"
+  gem "thor"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Cameron Cundiff
+
+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

@@ -0,0 +1,128 @@
+# entree.rb
+
+Entree is a ruby gem allowing accessibility audits to be run on URLs or files,
+from the command line or within your Ruby applications.
+
+This library was copied from Cameron Cundiff's (@ckundo) excellent
+[access_lint.rb](https://github.com/accesslint/accesslint.rb) project. It has
+been renamed to reflect what it's attempting to provide: entrance to the web for
+everyone.
+
+## About
+
+Entree uses the
+[HTML_CodeSniffer](https://github.com/squizlabs/HTML_CodeSniffer) client-side JS
+application to make assertions on the DOM via PhantomJS. The rules that are applied are [listed below](#rules).
+
+## Installation
+
+First, install PhantomJS ([full guide](http://phantomjs.org/)). On OS X:
+
+    $ brew install phantomjs
+
+Then install the rubygem:
+
+    $ gem install entree
+
+## Usage
+
+### Command Line
+
+From the command line, specify a url or filename to be audited:
+
+    $ entree audit http://archaccessibility.com # url or a path to a file
+    # results ...
+
+### Ruby
+
+Run the audit from a Ruby application like so
+
+    $ irb
+    > require 'entree'
+    => true
+    > Entree::Audit.new('http://archaccessibility.com').run
+    => results ...
+
+### Results Object
+
+    {
+        "PASS": [                                                           # Status group
+            {
+                "element_names": ["<p class=\"foo\">relevant element</p>"], # applicable DOM elements
+                "severity": "WARNING",                                      # 'WARNING' or 'SEVERE'
+                "status": "PASS",                                           # 'PASS', 'FAIL', or 'NA'
+                "title": "Some description"                                 # rule description
+            },
+            { ... }
+        ],
+        "NA": [ { ... } ],
+        "FAIL": [ { ... }]
+    ]
+
+## 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).
+
+Code                       | Title
+---------------------------|----------------------------------------------------
+[AX_ARIA_01][AX_ARIA_01]   | Elements with ARIA roles must use a valid, non-abstract ARIA role.
+[AX_ARIA_02][AX_ARIA_02]   | ARIA attributes which refer to other elements by ID should refer to elements which exist in the DOM.
+[AX_ARIA_03][AX_ARIA_03]   | Elements with ARIA roles must have all required attributes for that role.
+[AX_ARIA_04][AX_ARIA_04]   | ARIA state and property values must be valid.
+[AX_ARIA_05][AX_ARIA_05]   | role=main should only appear on significant elements.
+[AX_ARIA_06][AX_ARIA_06]   | aria-owns should not be used if ownership is implicit in the DOM.
+[AX_ARIA_07][AX_ARIA_07]   | An element's ID must not be present in more that one aria-owns attribute at any time.
+[AX_ARIA_08][AX_ARIA_08]   | Elements with ARIA roles must ensure required owned elements are present.
+[AX_ARIA_09][AX_ARIA_09]   | Elements with ARIA roles must be in the correct scope.
+[AX_ARIA_10][AX_ARIA_10]   | This element has an unsupported ARIA attribute.
+[AX_ARIA_11][AX_ARIA_11]   | This element has an invalid ARIA attribute.
+[AX_ARIA_12][AX_ARIA_12]   | This element does not support ARIA roles, states and properties.
+[AX_AUDIO_01][AX_AUDIO_01] | Audio elements should have controls.
+[AX_COLOR_01][AX_COLOR_01] | Text elements should have a reasonable contrast ratio.
+[AX_FOCUS_01][AX_FOCUS_01] | These elements are focusable but either invisible or obscured by another element.
+[AX_FOCUS_02][AX_FOCUS_02] | Elements with onclick handlers must be focusable.
+[AX_FOCUS_03][AX_FOCUS_03] | Avoid positive integer values for tabIndex.
+[AX_HTML_01][AX_HTML_01]   | The web page should have the content's human language indicated in the markup.
+[AX_HTML_02][AX_HTML_02]   | An element's ID must be unique in the DOM.
+[AX_IMAGE_01][AX_IMAGE_01] | Meaningful images should not be used in element backgrounds.
+[AX_TEXT_01][AX_TEXT_01]   | Controls and media elements should have labels.
+[AX_TEXT_02][AX_TEXT_02]   | Images should have an alt attribute.
+[AX_TEXT_04][AX_TEXT_04]   | The purpose of each link should be clear from the link text.
+[AX_TITLE_01][AX_TITLE_01] | The web page should have a title that describes topic or purpose.
+[AX_VIDEO_01][AX_VIDEO_01] | Video elements should use <track> elements to provide captions.
+
+[AX_ARIA_01]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_aria_01
+[AX_ARIA_02]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_aria_02
+[AX_ARIA_03]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_aria_03
+[AX_ARIA_04]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_aria_04
+[AX_ARIA_05]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_aria_05
+[AX_ARIA_06]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_aria_06
+[AX_ARIA_07]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_aria_07
+[AX_ARIA_08]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_aria_08
+[AX_ARIA_09]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_aria_09
+[AX_ARIA_10]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_aria_10
+[AX_ARIA_11]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_aria_11
+[AX_ARIA_12]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_aria_12
+[AX_AUDIO_01]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_audio_01
+[AX_COLOR_01]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_color_01
+[AX_FOCUS_01]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_focus_01
+[AX_FOCUS_02]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_focus_02
+[AX_FOCUS_03]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_focus_03
+[AX_HTML_01]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_html_01
+[AX_HTML_02]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_html_02
+[AX_IMAGE_01]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_image_01
+[AX_TEXT_01]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_text_01
+[AX_TEXT_02]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_text_02
+[AX_TEXT_04]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_text_04
+[AX_TITLE_01]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_title_01
+[AX_VIDEO_01]: https://github.com/GoogleChrome/accessibility-developer-tools/wiki/Audit-Rules#ax_video_01
+
+## Roadmap
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,31 @@
+# require "bundler/gem_tasks"
+# require 'rspec/core/rake_task'
+
+# # RSpec::Core::RakeTask.new do |t|
+# #   t.pattern = "spec/**/*_spec.rb"
+# # end
+
+# desc "Default: run all specs"
+# task :default => [:spec]
+
+# task :build => ["axs:make"]
+
+# desc "Google Accessibility Developer Tools"
+# namespace :axs do
+#   desc "Generate Accessibility Developer Tools axs_testing.js"
+#   task :make do
+#     system "cd vendor/accessibility-developer-tools/ && make"
+#   end
+# end
+require 'rake/testtask'
+
+lib_dir = File.expand_path('lib')
+test_dir = File.expand_path('test')
+
+Rake::TestTask.new(:test) do |t|
+  t.libs = [lib_dir, test_dir]
+  t.pattern = 'test/**/*rb'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/entree

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+$: << File.expand_path("../lib/", __FILE__)
+
+Signal.trap("INT") { exit 1 } #
+
+require 'entree'
+require 'entree/cli'
+
+Entree::CLI.start(ARGV)

data/entree.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'entree/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "entree"
+  spec.version       = Entree::VERSION
+  spec.authors       = ["Samuel Mullen"]
+  spec.email         = ["samullen@gmail.com"]
+  spec.description   = %q{Run an accessibility audit on a file or URL from the command line.}
+  spec.summary       = %q{Entree runs HTML_CodeSniffer assertions on a page via PhantomJS}
+  spec.homepage      = "https://github.com/samullen/entree"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+  spec.executables   = ['entree']
+
+  spec.add_dependency "thor", "~> 0.19"
+  spec.add_dependency "awesome_print", "~> 1.6"
+  spec.add_dependency "command_line_reporter", "~> 3.3"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 11"
+  spec.add_development_dependency "oj", "~> 2.17"
+end

data/lib/entree/audit.rb

@@ -0,0 +1,45 @@
+require 'entree'
+require 'oj'
+
+module Entree
+  class Audit
+    attr_reader :target
+
+    def initialize(target)
+      @target = target
+    end
+
+    def run
+      perform_audit
+    end
+
+    def runner
+      @runner ||= Runner.new(self.target)
+    end
+
+    private
+
+    def perform_audit
+      runner.run
+      @output = runner.output
+      parse_output
+    end
+
+    def parse_output
+      # refactor into new class
+      raw_results = Oj.load(@output).map {|record|
+        if record["code"][0..3] == "WCAG"
+          record["code"].match /(WCAG2A+\.\w+?\.Guideline(\d_\d)\.\2_\d)\.((?:[A-Z]+\d+,?)+)/
+          record["code"] = $1
+          record["techniques"] = $3.split /,/
+        end
+
+        record
+      }
+
+      @results = raw_results.group_by { |result| result['type'] }
+    rescue Exception => e
+      raise Entree::ParserError.new(e.message)
+    end
+  end
+end

data/lib/entree/cli.rb

@@ -0,0 +1,16 @@
+require 'thor'
+require 'command_line_reporter'
+require 'awesome_print'
+
+module Entree
+  class CLI < Thor
+    include CommandLineReporter
+
+    desc 'audit', 'audit TARGET'
+    def audit(target)
+      report(message: "auditing #{target}", color: "blue") do
+        ap Audit.new(target).run, index: false
+      end
+    end
+  end
+end

data/lib/entree/runner.rb

@@ -0,0 +1,31 @@
+module Entree
+  class Runner
+    RUNNER_PATH = File.expand_path("../../../vendor/HTML_CodeSniffer/Contrib/PhantomJS/HTMLCS_Run.js", __FILE__)
+    attr_reader :output
+
+    def initialize(target)
+      @target = target
+    end
+
+    def run
+      @output = `phantomjs #{RUNNER_PATH} #{@target} WCAG2AA json`
+      return if audit_success?
+
+      if !phantomjs_installed?
+        fail Entree::RunnerError.new("Please install PhantomJS. Visit http://phantomjs.org/ for instructions.")
+      else
+        fail Entree::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/entree/version.rb

@@ -0,0 +1,3 @@
+module Entree
+  VERSION = "0.0.1"
+end

data/lib/entree.rb

@@ -0,0 +1,11 @@
+require "entree/version"
+
+module Entree
+  autoload :Audit, 'entree/runner'
+  autoload :Runner, 'entree/audit'
+
+  class Error < StandardError; end
+  class AuditError < Error; end
+  class ParserError < Error; end
+  class RunnerError < Error; end
+end

data/test/entree/audit_test.rb

@@ -0,0 +1,30 @@
+require "minitest/autorun"
+require "entree"
+
+describe Entree::Audit do
+  describe "Initialization" do
+    it "requires a target to audit" do
+      Entree::Audit.new("http://example.com").must_be_instance_of Entree::Audit
+    end
+  end
+
+  describe '#run' do
+    it 'return a parsed set of results' do
+      skip
+      # target = double
+      # output = JSON.generate([{status: 'passing', foo: 'bar'}])
+
+      # audit = Entree::Audit.new(target)
+      # audit.stub(:runner) { double(:runner, output: output, run: double) }
+
+      # expect(audit.run).to eq "passing"=>[{"status"=>"passing", "foo"=>"bar"}]
+    end
+  end
+
+  describe "#runner" do
+    it "returns an Entree::Runner object" do
+      audit = Entree::Audit.new("http://example.com")
+      audit.runner.must_be_instance_of Entree::Runner
+    end
+  end
+end

data/test/entree/cli_test.rb

@@ -0,0 +1,11 @@
+# Commenting out until I can fix command_line_reporter conflicts with minitest
+
+# require "minitest/autorun"
+# require "entree/cli"
+
+# describe Entree::CLI do
+#   it "creates an audit" do
+#     skip
+#     # expect { CLI.start([]) }.to_not raise_error
+#   end
+# end

data/test/entree/runner_test.rb

@@ -0,0 +1,13 @@
+require "minitest/autorun"
+require "entree"
+
+describe Entree::Runner do
+  it 'runs phantomjs' do
+    skip
+    target = double
+    runner = Runner.new(target)
+
+    expect(runner).to receive(:`).with(/^phantomjs.*/)
+    runner.run
+  end
+end

data/vendor/HTML_CodeSniffer/Contrib/PhantomJS/HTMLCS_Run.js

@@ -0,0 +1,180 @@
+var page = require('webpage').create(),
+    system = require('system'),
+    address, standard, reportType, cwd;
+var messages = {
+    'ERROR': [],
+    'WARNING': [],
+    'NOTICE': []
+};
+
+if (system.args.length < 3 || system.args.length > 4) {
+    console.log('Usage: phantomjs HTMLCS_Run.js URL standard [report]');
+    console.log('  available standards: "WCAG2A", "WCAG2AA", "WCAG2AAA", "Section508"');
+    console.log('  available reports: "default" (default if omitted), "table", "json"');
+    phantom.exit();
+} else {
+    address    = system.args[1];
+    standard   = system.args[2];
+    reportType = 'default';
+    if (system.args.length > 3) {
+        reportType = system.args[3];
+    }
+
+    // Get the absolute working directory from the PWD var and
+    // and the command line $0 argument.
+    cwd = system.env['PWD'];
+    if (system.args[0].substr(0, 1) === '/') {
+        cwd = system.args[0];
+    } else {
+        cwd += '/' + system.args[0];
+    }
+
+    cwd = cwd.substr(0, cwd.lastIndexOf('/'));
+
+    // Default reporter.
+    var reportDefaultFn = function(cb) {
+        var levels = ['ERROR', 'WARNING', 'NOTICE'];
+        for (var lvl = 0; lvl < levels.length; lvl++) {
+            for (var i = 0; i < messages[levels[lvl]].length; i++) {
+                var thisMsg = messages[levels[lvl]][i];
+                var line    = thisMsg.join('|');
+                console.log(line);
+            }
+        }
+
+        cb();
+    }
+
+    // Table reporter.
+    var reportTableFn = function(cb) {
+        console.log('LEVEL   | MESSAGE CODE                             | NODE NAME  | ELEMENT ID');
+        console.log('--------+------------------------------------------+------------+---------------------');
+        var levels = ['ERROR', 'WARNING', 'NOTICE'];
+        for (var lvl = 0; lvl < levels.length; lvl++) {
+            for (var i = 0; i < messages[levels[lvl]].length; i++) {
+                var thisMsg = messages[levels[lvl]][i];
+                var line    = '';
+                var stdMsg  = thisMsg[1].split('.');
+                stdMsg.splice(0, 3);
+                stdMsg = stdMsg.join('.');
+                if (stdMsg.length > 40) {
+                    stdMsg = '...' + stdMsg.substr(stdMsg.length - 37);
+                }
+
+                line += (thisMsg[0] + Array(8).join(' ')).substr(0, 7) + ' | ';
+                line += (stdMsg + Array(41).join(' ')).substr(0, 40) + ' | ';
+                line += (thisMsg[2] + Array(11).join(' ')).substr(0, 10) + ' | ';
+                line += (thisMsg[3] + Array(21).join(' ')).substr(0, 20);
+                console.log(line);
+
+                var remText = thisMsg[4];
+                while (remText.length > 0) {
+                    line  = '';
+                    line += (Array(8).join(' ')).substr(0, 7) + ' | ';
+                    
+                    if (remText.length < 75) {
+                        line += remText;
+                        console.log(line);
+                        break;
+                    } else {
+                        var lastSpace = remText.substr(0, 75).lastIndexOf(' ');
+                        line += remText.substr(0, lastSpace);
+                        console.log(line);
+                        remText = remText.substr(lastSpace + 1);
+                    }
+                }
+
+                console.log('--------+------------------------------------------+------------+---------------------');
+                
+            }
+        }
+
+        console.log('');
+        console.log('Errors: ' + messages['ERROR'].length + ', Warnings: ' + messages['WARNING'].length +
+            ', Notices: ' + messages['NOTICE'].length);
+        cb();
+    }
+
+    var reportJSONFn = function(cb) {
+        var reportJSONData = [];
+        var levels = ['ERROR', 'WARNING', 'NOTICE'];
+        for (var lvl = 0; lvl < levels.length; lvl++) {
+            for (var i = 0; i < messages[levels[lvl]].length; i++) {
+                var thisMsg = messages[levels[lvl]][i];
+                reportJSONData.push({
+                    type: thisMsg[0],
+                    code: thisMsg[1],
+                    nodeName: thisMsg[2],
+                    id: thisMsg[3],
+                    msg: thisMsg[4],
+                    outerHTML: thisMsg[5]
+                });
+            }
+        }
+
+        console.log('[');
+        reportJSONData.forEach(function(report, i) {
+            console.log(JSON.stringify(report, null, '    '));
+            if (i < reportJSONData.length-1) {
+                console.log(',');
+            }
+        });
+        console.log(']');
+        cb();
+    };
+
+    page.open(address, function (status) {
+        if (status !== 'success') {
+            console.log('Unable to load the address!');
+            phantom.exit();
+        } else {
+            window.setTimeout(function () {
+
+                // Override onConsoleMessage function for outputting.
+                page.onConsoleMessage = function (msg) {
+                    var thisMsg;
+                    if (msg.indexOf('[HTMLCS] ') === 0) {
+                        thisMsg = msg.substr(9, msg.length).split('|');
+                        messages[thisMsg[0]].push(thisMsg);
+                    } else if (msg === 'done') {
+                        var cb = function() {
+                            phantom.exit();
+                        }
+                        switch (reportType.toLowerCase()) {
+                            case 'table':
+                                reportTableFn(cb);
+                            break;
+
+                            case 'json':
+                                reportJSONFn(cb);
+                            break;
+
+                            default:
+                                reportDefaultFn(cb);
+                            break;
+                        }
+                    } else {
+                        console.log(msg);
+                    }
+                };
+
+                page.injectJs(cwd + '/../../build/HTMLCS.js');
+
+                // Now Run. Note that page.evaluate() function is sanboxed to
+                // the loaded page's context. We can't pass any variable to it.
+                switch (standard) {
+                    case 'WCAG2A':
+                    case 'WCAG2AA':
+                    case 'WCAG2AAA':
+                    case 'Section508':
+                        page.evaluate(function(standard) {HTMLCS_RUNNER.run(standard);}, standard);
+                    break;
+                    default:
+                        console.log('Unknown standard.');
+                        phantom.exit();
+                    break;
+                }
+            }, 200);
+        }//end if
+    });//end
+}//end if