acop 1.0.0

data/.gitignore

@@ -0,0 +1 @@
+acop-1.0.0.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# gem's dependencies in the tagfu gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2013 by Avinash Padmanabhan
+
+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,69 @@
+acop - enforcing accessibility for web pages
+============================================
+
+Acop
+----
+
+[Acop](http://eveningsamurai.github.io/acop/)
+
+Description
+-----------
+
+acop is a command line utility for verifying accessibility in web pages
+
+With acop, you can specify a url you want to test for accessibility and acop would run through a checklist of accessibility concerns and return any issues found
+
+Installation
+------------
+
+`gem install acop`
+
+Synopsis
+--------
+
+Access the command line help
+
+`acop --help`
+
+Specify the url you want accessibility tested
+
+`acop -u http://www.google.com`
+
+Checkpoints
+-----------
+### Images  
+`<input type='image'...`  
+*   Image inputs elements should have alt attributes  
+*   Image inputs elements should not have alt attributes empty
+
+`<img...`  
+*   Image elements should have alt attributes  
+*   Image elements should not have alt attributes empty  
+
+`<a><img...`  
+*   Image elements inside anchor tags should have empty alt attributes  
+
+### Title
+`<title></title>`  
+*   Page title element should not be empty  
+
+`<!DOCTYPE Resource SYSTEM 'foo.dtd'>`
+*   doctype should be specified if frame or iframe elements exist on the page
+
+`<frameset><frame title=""...`  
+*   Frame elements should have title attributes  
+*   Frame elements should not have title attributes empty  
+
+`<iframe title=""...`
+*   iFrame elements should have title attributes  
+*   iFrame elements should not have title attributes empty  
+
+Bugs
+----
+Report bugs and requests at [the Github page](https://github.com/eveningsamurai/acop).
+
+
+Copyright
+---------
+
+Copyright 2013 by [Avinash Padmanabhan](http://eveningsamurai.wordpress.com) under the MIT license (see the LICENSE file).

data/acop.gemspec

@@ -0,0 +1,24 @@
+require './lib/acop/version.rb'
+
+Gem::Specification.new do |s|
+  s.name        = 'acop'
+  s.version     = Acop::VERSION
+  s.date        = '2013-04-22'
+  s.summary     = "Accessibility Cop"
+  s.description = "A gem to enforce accessibility testing of urls'"
+  s.authors     = ["Avinash Padmanabhan"]
+  s.email       = ['avinashpadmanabhan@gmail.com']
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = ['spec/acop_spec.rb']
+  s.homepage    = "https://github.com/eveningsamurai/acop"
+
+  s.add_development_dependency "OptionParser"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "nokogiri"
+  s.add_development_dependency "webmock"
+  s.require_paths = ["lib"]
+
+  s.executables << 'acop'
+
+  s.post_install_message = "Thanks for installing Accessibility Cop(acop)!"
+end

data/bin/acop

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'acop'
+
+Acop.run(*ARGV)

data/lib/acop.rb

@@ -0,0 +1,41 @@
+require 'optparse'
+require 'open-uri'
+require_relative 'acop/accessibility.rb'
+
+module Acop
+   def self.run(*args)
+		options = {}
+
+		option_parser = OptionParser.new do |opts|
+			opts.banner = 'Usage: acop -u URL'
+
+			opts.on('-u', '--url URL', 'Url to be accessibility tested') do |tag|
+				options[:url] = tag
+			end
+		end
+
+		begin
+			option_parser.parse!
+			raise OptionParser::MissingArgument, "Url should be provided!" if options.keys.empty?
+			raise OptionParser::InvalidArgument, "Url cannot be resolved!" unless valid_url?(options[:url])
+		rescue OptionParser::ParseError => e
+			puts e.message
+			puts
+			puts option_parser
+			exit -1
+		end
+
+		Enforcer.new(options).accessibility_checks
+	end
+
+   def self.valid_url?(url)
+      begin
+			url = "http://" + url unless url.include?("http")
+         contents = open(url)
+         return true
+      rescue Exception => e
+         return false
+      end
+   end
+
+end

data/lib/acop/accessibility.rb

@@ -0,0 +1,114 @@
+require 'open-uri'
+require 'nokogiri'
+require 'rexml/document'
+
+module Acop
+	class Enforcer
+		attr_reader :ah, :source, :contents
+
+		def initialize(options={})
+			@ah = Helpers.new
+			url = options[:url]
+			url = "http://" + options[:url] unless options[:url].include?("http")
+			@source = open(url)
+			@contents = Nokogiri::HTML(@source)
+		end
+
+		def accessibility_checks
+			error_messages = []
+
+			self.methods.each do |method|
+				error_messages << (self.public_send(method)) if method[0..5] == "check_"
+			end
+
+			puts error_messages
+		end
+
+		def check_image_input_alt(source=@contents)
+			input_elements = source.css('input')
+			image_inputs   = input_elements.select {|image_input| image_input['type'] =~ /image/i}
+			error_messages = []
+			image_inputs.each do |input|
+				if (@ah.attribute_empty_or_nil(input, "alt") and input.parent.name != "a")
+					error_messages.push("Missing alt text/attribute for image button with id/name: " + (input['name'] || input['id'] || ""))
+				end
+			end
+			error_messages
+		end
+
+		def check_image_alt(source=@contents)
+			image_elements = source.css('img')
+			error_messages = []
+			image_elements.each do |element|
+				if (@ah.attribute_empty_or_nil(element, "alt") and element.parent.name != "a")
+					error_messages.push("Missing alt text/attribute for image with src: " + element['src'])
+				end
+			end
+			error_messages
+		end
+
+		def check_image_links(source=@contents)
+			link_elements = source.css('a img')
+			error_messages = []
+			image_links = []
+			link_elements.each do |link_element|
+				if(link_element['alt'] != "")
+					error_messages.push("Alt Text not empty or nil for image link with src: " + link_element['src'])
+				end
+			end
+			error_messages
+		end
+
+		def check_page_title(source=@contents)
+			title_element = source.css('title')
+			error_messages = []
+			error_messages.push("Missing title element") if title_element.empty?
+			error_messages.push("Empty title element") if(title_element.first and title_element.first.text == "")
+			error_messages.push("More than 1 title element") if title_element.length > 1
+
+			error_messages
+		end
+
+		def check_doctype(source=@contents)
+			frame_elements = source.css("frame")
+			iframe_elements = source.css("iframe")
+			error_messages = []
+			if(frame_elements.length > 0 or iframe_elements.length > 0)
+				doctype = REXML::Document.new(@source.string).doctype
+				error_messages.push("Frames/iFrames present but doctype is missing") unless doctype
+			end
+			error_messages
+		end
+
+		def check_frame_title(source=@contents)
+			return [] if source.css("frameset").length < 1
+			frame_elements = source.css("frame")
+			error_messages = []
+			frame_elements.each do |frame|
+				error_messages.push("Missing frame title element") unless frame['title']
+				error_messages.push("Empty frame title element") if frame['title'] == ""
+			end
+			error_messages
+		end
+
+		def check_iframe_title(source=@contents)
+			iframe_elements = source.css("iframe")
+			error_messages = []
+			iframe_elements.each do |iframe|
+				error_messages.push("Missing iframe title element") unless iframe['title']
+				error_messages.push("Empty iframe title element") if iframe['title'] == ""
+			end
+			error_messages
+		end
+	end
+
+	class Helpers
+		def attribute_empty_or_nil(element, attribute)
+			if(element[attribute] == nil || element[attribute] == "")
+				return true
+			end
+			false
+		end
+	end
+
+end

data/lib/acop/version.rb

@@ -0,0 +1,3 @@
+module Acop
+	VERSION = "1.0.0"
+end

data/spec/acop_spec.rb

@@ -0,0 +1,155 @@
+require '../lib/acop/accessibility.rb'
+require 'rspec/expectations'
+require 'webmock/rspec'
+require 'open-uri'
+
+RSpec.configure do |config|
+	config.before(:all) do
+	end
+
+	config.after(:all) do
+	end
+
+	describe Acop::Enforcer do
+		it "should not return error messages when no issues with image tags" do
+			stub_request(:any, "www.example.com").to_return(:body => "<html><body><input type='image' alt='alt text'/></body></html>", :status => 200)
+			enf = Acop::Enforcer.new({:url => "www.example.com"})
+			error_messages = enf.check_image_input_alt
+			error_messages.should be_empty
+		end
+
+		it "should return error messages when alt tags absent from input image elements" do
+			stub_request(:any, "www.example.com").to_return(:body => "<html><body><input type='image'/></body></html>", :status => 200)
+			enf = Acop::Enforcer.new({:url => "www.example.com"})
+			error_messages = enf.check_image_input_alt
+			error_messages.should_not be_empty
+			error_messages[0].should match("Missing alt text/attribute for image button")
+		end
+
+		it "should return error messages when alt tags empty in input image elements" do
+			stub_request(:any, "www.example.com").to_return(:body => "<html><body><input type='image' alt=''/></body></html>", :status => 200)
+			enf = Acop::Enforcer.new({:url => "www.example.com"})
+			error_messages = enf.check_image_input_alt
+			error_messages.should_not be_empty
+			error_messages[0].should match("Missing alt text/attribute for image button")
+		end
+
+		it "should return error messages when alt tags absent from image elements" do
+			stub_request(:any, "www.example.com").to_return(:body => "<html><body><img src='www.intuit.com'></body></html>", :status => 200)
+			enf = Acop::Enforcer.new({:url => "www.example.com"})
+			error_messages = enf.check_image_alt
+			error_messages.should_not be_empty
+			error_messages[0].should match("Missing alt text/attribute for image with src")
+		end
+
+		it "should return error messages when alt tags empty in image elements" do
+			stub_request(:any, "www.example.com").to_return(:body => "<html><body><img alt='' src='www.intuit.com'></body></html>", :status => 200)
+			enf = Acop::Enforcer.new({:url => "www.example.com"})
+			error_messages = enf.check_image_alt
+			error_messages.should_not be_empty
+			error_messages[0].should match("Missing alt text/attribute for image with src")
+		end
+
+		it "should return error messages when alt tags absent from image links" do
+			stub_request(:any, "www.example.com").to_return(:body => "<html><body><img src='www.intuit.com'></body></html>", :status => 200)
+			enf = Acop::Enforcer.new({:url => "www.example.com"})
+			error_messages = enf.check_image_alt
+			error_messages.should_not be_empty
+			error_messages[0].should match("Missing alt text/attribute for image with src")
+		end
+
+		it "should have alt tags empty in image links" do
+			stub_request(:any, "www.example.com").to_return(:body => "<a class='visually-hidden'><img id='img_link' src='\/try_qbo_free.png' alt=''/>Try QuickBooks Online for Free</a>", :status => 200)
+			enf = Acop::Enforcer.new({:url => "www.example.com"})
+			error_messages = enf.check_image_links
+			error_messages.should be_empty
+		end
+
+		it "should return error messages when alt tags not empty in image links" do
+			stub_request(:any, "www.example.com").to_return(:body => "<a class='visually-hidden'><img id='img_link' src='\/try_qbo_free.png' alt='bla bla'/>Try QuickBooks Online for Free</a>", :status => 200)
+			enf = Acop::Enforcer.new({:url => "www.example.com"})
+			error_messages = enf.check_image_links
+			error_messages.should_not be_empty
+			error_messages[0].should match("Alt Text not empty or nil for image link with src")
+		end
+
+		it "should return error messages when alt tags nil in image links" do
+			stub_request(:any, "www.example.com").to_return(:body => "<a class='visually-hidden'><img id='img_link' src='\/try_qbo_free.png' alt='bla bla'/>Try QuickBooks Online for Free</a>", :status => 200)
+			enf = Acop::Enforcer.new({:url => "www.example.com"})
+			error_messages = enf.check_image_links
+			error_messages.should_not be_empty
+			error_messages[0].should match("Alt Text not empty or nil for image link with src")
+		end
+
+		it "should return error messages when title not present" do
+			stub_request(:any, "www.example.com").to_return(:body => "<html><head></head></html>", :status => 200)
+			enf = Acop::Enforcer.new({:url => "www.example.com"})
+			error_messages = enf.check_page_title
+			error_messages.should_not be_empty
+			error_messages[0].should match("Missing title element")
+		end
+
+		it "should return error messages when title element empty" do
+			stub_request(:any, "www.example.com").to_return(:body => "<html><head><title></title></head></html>", :status => 200)
+			enf = Acop::Enforcer.new({:url => "www.example.com"})
+			error_messages = enf.check_page_title
+			error_messages.should_not be_empty
+			error_messages[0].should match("Empty title element")
+		end
+
+		it "should return error messages when more than 1 title element" do
+			stub_request(:any, "www.example.com").to_return(:body => "<html><head><title>Some Title</title><title>Another title</title></head></html>", :status => 200)
+			enf = Acop::Enforcer.new({:url => "www.example.com"})
+			error_messages = enf.check_page_title
+			error_messages.should_not be_empty
+			error_messages[0].should match("More than 1 title element")
+		end
+
+		it "should return no error messages when frameset is not present" do
+			stub_request(:any, "www.example.com").to_return(:body => "<frame src='frame_a.htm' title=''><frame src='frame_b.htm' title='bla'>", :status => 200)
+			enf = Acop::Enforcer.new({:url => "www.example.com"})
+			error_messages = enf.check_frame_title
+			error_messages.should be_empty
+		end
+
+		it "should return error messages when frame/iframe present but no doctype" do
+			stub_request(:any, "www.example.com").to_return(:body => "<!DOCTYPE Resource SYSTEM 'foo.dtd'><frameset cols='50%,50%'><frame src='frame_a.htm'/><frame src='frame_b.htm'/></frameset>", :status => 200)
+			enf = Acop::Enforcer.new({:url => "www.example.com"})
+			error_messages = enf.check_doctype
+			puts error_messages
+			error_messages.should be_empty
+		end
+
+		it "should return error messages when frame does not have a title" do
+			stub_request(:any, "www.example.com").to_return(:body => "<frameset cols='50%,50%'><frame src='frame_a.htm'><frame src='frame_b.htm'></frameset>", :status => 200)
+			enf = Acop::Enforcer.new({:url => "www.example.com"})
+			error_messages = enf.check_frame_title
+			error_messages.should_not be_empty
+			error_messages[0].should match("Missing frame title element")
+		end
+
+		it "should return error messages when frame title is empty" do
+			stub_request(:any, "www.example.com").to_return(:body => "<frameset cols='50%,50%'><frame src='frame_a.htm' title=''><frame src='frame_b.htm' title='bla'></frameset>", :status => 200)
+			enf = Acop::Enforcer.new({:url => "www.example.com"})
+			error_messages = enf.check_frame_title
+			error_messages.should_not be_empty
+			error_messages[0].should match("Empty frame title element")
+		end
+
+		it "should return error messages when iframe does not have a title" do
+			stub_request(:any, "www.example.com").to_return(:body => "<iframe src='www.google.com'></iframe>", :status => 200)
+			enf = Acop::Enforcer.new({:url => "www.example.com"})
+			error_messages = enf.check_iframe_title
+			error_messages.should_not be_empty
+			error_messages[0].should match("Missing iframe title element")
+		end
+
+		it "should return error messages when iframe title is empty" do
+			stub_request(:any, "www.example.com").to_return(:body => "<iframe title='' src='www.google.com'></iframe>", :status => 200)
+			enf = Acop::Enforcer.new({:url => "www.example.com"})
+			error_messages = enf.check_iframe_title
+			error_messages.should_not be_empty
+			error_messages[0].should match("Empty iframe title element")
+		end
+	end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: acop
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Avinash Padmanabhan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: OptionParser
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem to enforce accessibility testing of urls'
+email:
+- avinashpadmanabhan@gmail.com
+executables:
+- acop
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- acop.gemspec
+- bin/acop
+- lib/acop.rb
+- lib/acop/accessibility.rb
+- lib/acop/version.rb
+- spec/acop_spec.rb
+homepage: https://github.com/eveningsamurai/acop
+licenses: []
+post_install_message: Thanks for installing Accessibility Cop(acop)!
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Accessibility Cop
+test_files:
+- spec/acop_spec.rb