accessibility 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f47f50275fb37bc7744979cabbc85b598189706
+  data.tar.gz: b7011b70d3e17b3857318f348497c0fcfbc1f089
+SHA512:
+  metadata.gz: caccd7b5ee1186a3dc5745e2965ae93d5d2a52d4c0edbc678769c7d3bacff85565455633283c8545eac4d6d85d7432626ae2d320d7d207d676492ce4aed3c072
+  data.tar.gz: bef521edb760d52ccbfe168c954a7d11769dc86a9784436ddb21941360dc8a36973dd07e4e3a8171d507085f4f6e519f6f04ca68700dc75115277c9ad4f2b54c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in accessibility.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jaime Iniesta
+
+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,114 @@
+# Accessibility [![travis build status](https://secure.travis-ci.org/sitevalidator/accessibility.png?branch=master)](http://travis-ci.org/sitevalidator/accessibility) [![Code Climate](https://codeclimate.com/github/sitevalidator/accessibility/badges/gpa.svg)](https://codeclimate.com/github/sitevalidator/accessibility) [![Dependency Status](https://gemnasium.com/sitevalidator/accessibility.png)](https://gemnasium.com/sitevalidator/accessibility)
+
+Accessibility is a Ruby gem that lets you check for accessibility issues on web pages.
+
+It's a wrapper around the great [AccessLint](https://github.com/accesslint/access_lint) gem, which in turn is a wrapper around the awesome [Accessibility Developer Tools](https://github.com/GoogleChrome/accessibility-developer-tools).
+
+## Why so many wrappers?
+
+The Accessibility Developer Tools, ADT for short, is a JavaScript library developed by the [Google Chrome team](https://github.com/GoogleChrome), which can be used as a [Google Chrome extension](https://chrome.google.com/webstore/detail/accessibility-developer-t/fpkknkljclfencbdbgkenhalefipecmb), or from the command line via [PhantomJS](http://phantomjs.org/).
+
+What the AccessLint gem does is wrap this JS library in a Ruby gem, so that you can easily run it on your Ruby projects in a convenient way.
+
+I found that using the AccessLint gem directly on my Ruby projects had some drawbacks:
+
+1. It introduced a dependency on PhantomJS, and this is a quite heavy dependency. PhantomJS can be hard to compile and it takes a lot of memory.
+2. To get the results, AccessLint executes phantom JS via a [shell command](https://github.com/accesslint/access_lint/blob/master/lib/access_lint/runner.rb#L11), which is something I don't feel very comfortable with.
+3. The AccessLint returns a raw JSON with the results, and I'd prefer to add a more friendly API over it.
+
+## Enter access-lint-server
+
+I prefer to move this heavy dependency out of my projects, so I released the [access-lint-server](https://github.com/sitevalidator/access-lint-server), which is a lightweight server based on Sinatra, that you can easily set up (for example in Heroku), to have a microservice in charge of doing the A11Y checks with the AccessLint gem. That's where the dependency on PhantomJS now resides, and not on your main project.
+
+Also, it allows for easy scaling. ADT can take several seconds (or tens of seconds) to respond, so a suggested approach is having several access-lint-server instances and a load balancer in front of them.
+
+To make it easier to process the raw JSON response, Accessibility is a Ruby client that uses an access-lint-server instance and gives you the results in a more friendly way.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'accessibility'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install accessibility
+
+## Usage
+
+To check accessibility on a web page, just pass Accessibility the URL to check, like this:
+
+```ruby
+a11y = Accessibility.check('http://validationhell.com')
+```
+
+Now you can get the errors and warnings like this:
+
+```ruby
+a11y.errors
+a11y.warnings
+```
+
+Each of these methods will return an array of audit rules that your web page failed to comply with. Each rule has its details, let's see for example:
+
+```ruby
+a11y = Accessibility.check('http://validationhell.com')
+
+warning = a11y.warnings.last
+warning.title         # "Text elements should have a reasonable contrast ratio"
+warning.element_names # ["<a href=\"/pages/why\">Why nobody validates</a>", "<a href=\"/pages/circle/1\">Limbo</a>"]
+```
+
+## Audit Rules
+
+Currently, AccessLint has a [list of 17 audit rules](https://github.com/accesslint/access_lint#rules). Each of these will be checked on your documents, and
+you can inspect them like this:
+
+```ruby
+a11y = Accessibility.check('http://validationhell.com')
+
+a11y.rules.all            # all the checked rules
+a11y.rules.not_applicable # rules that were not applicable to the checked page
+a11y.rules.passed         # rules that passed on the checked document
+a11y.rules.failed         # rules that failed on the checked document
+a11y.errors               # rules that failed with a severity of "Severe"
+a11y.warnings             # rules that failed with a severity of "Warning"
+```
+
+Each rule has the following attributes:
+
+attribute     | description
+--------------|-----------------------------------------------------------------
+status        | "NA" (not applicable), "PASS", or "FAIL"
+severity      | "Severe" or "Warning"
+title         | a description of the rule
+element_names | an array of strings, each of them being a snippet of the document where the issue was found
+
+## Using your own access-lint-server instance
+
+By default, Accessibility will use a demo instance of access-lint-server, which is intended only for demo purposes and not ready for production.
+
+You're encouraged to [install your own instance](https://github.com/sitevalidator/access-lint-server) and use it like this:
+
+```ruby
+a11y = Accessibility::Checker.new( 'http://validationhell.com',
+                                   checker_uri: 'http://mychecker.com' )
+```
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. Then, run `bundle console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+1. Fork it ( https://github.com/sitevalidator/accessibility/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new :spec
+
+task :default  => :spec

data/accessibility.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'accessibility/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "accessibility"
+  spec.version       = Accessibility::VERSION
+  spec.authors       = ["Jaime Iniesta"]
+  spec.email         = ["jaimeiniesta@gmail.com"]
+
+  spec.summary       = %q{Ruby client for the access-lint-server JSON API.}
+  spec.description   = %q{Ruby client to check for accessibility issues using
+                          Chrome's Accessibility Developer Tools on an
+                          access-lint-server instance.}
+  spec.homepage      = "https://github.com/sitevalidator/accessibility"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency     "httparty", "~> 0.13"
+
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rspec",   "~> 3.2"
+  spec.add_development_dependency "webmock", "~> 1.20"
+end

data/lib/accessibility.rb

@@ -0,0 +1,11 @@
+require "forwardable"
+require "accessibility/version"
+require "accessibility/checker"
+require "accessibility/audit"
+require "accessibility/rule"
+
+module Accessibility
+  def self.check(url, options = {})
+    Accessibility::Checker.new(url, options)
+  end
+end

data/lib/accessibility/audit.rb

@@ -0,0 +1,50 @@
+module Accessibility
+
+  ####
+  # An Accessibility::Audit is in charge of parsing the rules found on
+  # the raw response from the access-lint-server, available on the Checker,
+  # and filtering them by different criteria.
+  #
+  class Audit
+    def initialize(checker)
+      @checker = checker
+    end
+
+    extend Forwardable
+    delegate :raw => :@checker
+
+    def rules
+      self
+    end
+
+    # Returns all the rules
+    def all
+      @rules ||= raw.values.flatten.map { |rule| Accessibility::Rule.new(rule) }
+    end
+
+    # Returns the rules that were not applicable to the checked document
+    def not_applicable
+      @not_applicable ||= all.select { |rule| rule.status == "NA" }
+    end
+
+    # Returns the rules that passed on the checked document
+    def passed
+      @passed ||= all.select { |rule| rule.status == "PASS" }
+    end
+
+    # Returns the rules that failed on the checked document
+    def failed
+      @failed ||= all.select { |rule| rule.status == "FAIL" }
+    end
+
+    # Returns the rules that failed with a severity of "Severe"
+    def errors
+      @errors ||= failed.select { |rule| rule.severity == "Severe" }
+    end
+
+    # Returns the rules that failed with a severity of "Warning"
+    def warnings
+      @warnings ||= failed.select { |rule| rule.severity == "Warning" }
+    end
+  end
+end

data/lib/accessibility/checker.rb

@@ -0,0 +1,59 @@
+require 'httparty'
+require 'json'
+
+module Accessibility
+
+  ####
+  # An Accessibility::Checker is initialized by passing it the URL of the
+  # web page to check.
+  #
+  # It is in charge of making the request to the access-lint-server, which
+  # will perform the accessibility audit using the AccessLint gem and return
+  # the results as JSON.
+  #
+  # It delegates the results parsing to an Accessibility::Audit, which in
+  # turn will consult the raw JSON from this checker to generate the collections
+  # of audit rules.
+  #
+  # Example:
+  #
+  #   a11y = Accessibility::Checker.new('http://validationhell.com')
+  #
+  # You can (and should) specify the URL where your access-lint-server
+  # instance is to be found, as the default value is not a production-ready server,
+  # which might be under heavy load:
+  #
+  #   a11y = Accessibility::Checker.new( 'http://validationhell.com',
+  #                                      checker_uri: 'http://mychecker.com' )
+  #
+  # For brevity, you can use the convenience shortcut on the top-level module:
+  #
+  #   a11y = Accessibility.check('http://validationhell.com')
+  #
+  class Checker
+    attr_reader :url, :checker_uri
+
+    def initialize(url, options = {})
+      options = defaults.merge(options)
+
+      @url         = url
+      @checker_uri = options[:checker_uri]
+
+      @audit       = Accessibility::Audit.new(self)
+    end
+
+    # Returns the parsed JSON from the response of the access-lint-server
+    def raw
+      @raw ||= JSON.parse HTTParty.get("#{checker_uri}/check?url=#{url}").body
+    end
+
+    extend Forwardable
+    delegate [:rules, :errors, :warnings] => :@audit
+
+    private
+
+    def defaults
+      { checker_uri: 'https://access-lint-server-demo.herokuapp.com' }
+    end
+  end
+end

data/lib/accessibility/rule.rb

@@ -0,0 +1,24 @@
+module Accessibility
+  class Rule
+    attr_reader :element_names, :severity, :status, :title
+
+    ####
+    # An Accessibility::Rule represents a single Accessibility Developer Tools
+    # audit rule that is checked on the document.
+    #
+    # A Rule has the following attributes:
+    #
+    #   * status, which can be "NA" (not applicable), "PASS", or "FAIL"
+    #   * severity, which can be "Severe" or "Warning"
+    #   * title, which is a description of the rule
+    #   * element_names, an array of strings, each of them being a snippet of
+    #                    the document where the issue was found
+    # 
+    def initialize(data)
+      @element_names = data['element_names']
+      @severity      = data['severity']
+      @status        = data['status']
+      @title         = data['title']
+    end
+  end
+end

data/lib/accessibility/version.rb

@@ -0,0 +1,3 @@
+module Accessibility
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: accessibility
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jaime Iniesta
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+description: |-
+  Ruby client to check for accessibility issues using
+                            Chrome's Accessibility Developer Tools on an
+                            access-lint-server instance.
+email:
+- jaimeiniesta@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- accessibility.gemspec
+- lib/accessibility.rb
+- lib/accessibility/audit.rb
+- lib/accessibility/checker.rb
+- lib/accessibility/rule.rb
+- lib/accessibility/version.rb
+homepage: https://github.com/sitevalidator/accessibility
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby client for the access-lint-server JSON API.
+test_files: []