access_kit 0.01 → 0.02

data/Gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+
+group :development do
+  gem 'bundler', '~> 1.0.7'
+end
+
+gemspec
+
+gem 'ruby-debug', :platform => :ruby_18, :require => 'ruby-debug'
+gem 'ruby-debug19', :platform => :ruby_19, :require => 'ruby-debug'

data/README

@@ -0,0 +1,3 @@
+AccessKit : the CSUN Accessibility Compliance Toolkit
+
+A series of tools built with ruby to help ensure HTML is accessible, including an automated evaluation tool and helpers to generate accessible output for common elements.

data/lib/access_kit/core_ext/url_helper.rb

@@ -0,0 +1,25 @@
+require 'rails/all'
+
+raise "ActionView::Helpers::UrlHelper not loaded!" unless defined?(ActionView::Helpers::UrlHelper)
+raise "AccessKit::UrlHelperAdditions not loaded!" unless defined?(AccessKit::UrlHelperAdditions)
+
+module ActionView
+  module Helpers
+    module UrlHelper    
+            
+      def link_to_with_supplement(*args, &block)
+        if !block_given? && AccessKit::UrlHelperAdditions.args_for_link_to_with_supplement?(*args)
+          new_opts = AccessKit::UrlHelperAdditions.process_options_for_link_to_with_supplement(*args)
+          new_name = AccessKit::UrlHelperAdditions.add_supplement_to_text(args[0], new_opts)
+          args.shift
+
+          link_to_without_supplement(new_name, *args)
+        else
+          link_to_without_supplement(*args, &block)
+        end
+      end
+
+      alias_method_chain :link_to, :supplement
+    end
+  end
+end

data/lib/access_kit/url_helper_additions.rb

@@ -0,0 +1,55 @@
+module AccessKit
+  module UrlHelperAdditions
+    extend ActiveSupport::Concern 
+      
+    class << self
+      DEFAULT_KEY_NAME_FOR_PRECEDING_TEXT = :intro
+      DEFAULT_KEY_NAME_FOR_FOLLOWING_TEXT = :outro
+      
+      def add_supplement_to_text(text, opts={})        
+        default_opts = {DEFAULT_KEY_NAME_FOR_PRECEDING_TEXT => nil, DEFAULT_KEY_NAME_FOR_FOLLOWING_TEXT => nil, :auto_pad => true}
+        opts = default_opts.merge(opts)
+      
+        padding = begin
+          if opts[:auto_pad] === true
+            ' '
+          elsif opts[:auto_pad] === false
+            ''
+          else
+            opts[:auto_pad].to_s
+          end        
+        end
+      
+        before_span = opts[DEFAULT_KEY_NAME_FOR_PRECEDING_TEXT].blank?  ? 
+          "" : 
+          span_tag(opts[DEFAULT_KEY_NAME_FOR_PRECEDING_TEXT] + padding)
+          
+        after_span  = opts[DEFAULT_KEY_NAME_FOR_FOLLOWING_TEXT].blank?  ? 
+          "" : 
+          span_tag(padding + opts[DEFAULT_KEY_NAME_FOR_FOLLOWING_TEXT])
+
+        "#{before_span}#{text}#{after_span}".html_safe
+      end
+
+      def args_for_link_to_with_supplement?(*args)
+        args[2].is_a?(Hash) && ( 
+          args[2].keys.include?(DEFAULT_KEY_NAME_FOR_PRECEDING_TEXT) || 
+          args[2].keys.include?(DEFAULT_KEY_NAME_FOR_FOLLOWING_TEXT) 
+        )
+      end
+      
+      def process_options_for_link_to_with_supplement(*args)
+        [ DEFAULT_KEY_NAME_FOR_PRECEDING_TEXT, DEFAULT_KEY_NAME_FOR_FOLLOWING_TEXT, :auto_pad ].inject({}) do |memo, k|
+          value = args[2].delete(k)
+          value.blank? ? memo : memo.merge( k => value )
+        end          
+      end
+
+      private 
+        # TODO: use Rails content_tag if available
+        def span_tag(content)
+          "<span>#{content}</span>"
+        end
+    end
+  end
+end

data/lib/access_kit/version.rb

@@ -1,3 +1,3 @@
 module AccessKit
-  VERSION="0.01"
+  VERSION="0.02"
 end

data/lib/access_kit.rb

@@ -1,4 +1,6 @@
 require 'access_kit/version'
+require 'access_kit/url_helper_additions'
+require 'access_kit/core_ext/url_helper'
 
 module AccessKit
   def find_errors(html)

data/spec/access_kit/semantics_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe AccessKit do
+  let(:valid_html) { IO.read( File.dirname(__FILE__) + '/../html_samples/valid.html') }
+  
+  describe "#check" do
+    it "should have no @errors for a valid HTML document" do
+      AccessKit.find_errors(valid_html).should be_empty
+    end
+  end
+end

data/spec/access_kit/url_helper_additions_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+module AccessKit
+  describe UrlHelperAdditions do    
+    context "#link_to_with_supplement" do
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::UrlHelper
+      
+      it "should extend link_to" do
+        link_to(
+          "unicorns", 
+          '#unicorns', 
+          :intro => "Click to learn about"
+        ).should == "<a href=\"#unicorns\"><span>Click to learn about </span>unicorns</a>"
+      end
+    end
+    
+    context "#add_supplement_to_text" do
+      it "should add before" do
+        UrlHelperAdditions.add_supplement_to_text( 
+          "unicorns", 
+          :intro => "Click to learn more about"
+        ).should == "<span>Click to learn more about </span>unicorns"
+      end
+      
+      it "should add after" do
+        UrlHelperAdditions.add_supplement_to_text( 
+          "Learn more", 
+          :outro => "about unicorns"
+        ).should == "Learn more<span> about unicorns</span>"
+      end
+      
+      it "should add both before and after" do
+        UrlHelperAdditions.add_supplement_to_text( 
+          "unicorns", 
+          :intro => "Learn more about",
+          :outro => "by clicking here"
+        ).should == "<span>Learn more about </span>unicorns<span> by clicking here</span>"
+      end      
+      
+      it "should handle blank values" do
+        UrlHelperAdditions.add_supplement_to_text("unicorns").should == "unicorns"
+        UrlHelperAdditions.add_supplement_to_text("unicorns", :intro => nil).should == "unicorns"
+        UrlHelperAdditions.add_supplement_to_text("unicorns", :outro => nil).should == "unicorns"
+        
+        UrlHelperAdditions.add_supplement_to_text(
+          "unicorns", 
+          :outro => '', 
+          :intro => ''
+        ).should == "unicorns"        
+      end
+      
+      context "auto_pad" do
+        it "should pad with one space by default" do
+          UrlHelperAdditions.add_supplement_to_text( 
+            "unicorn", 
+            :intro => "Run",
+            :outro => "run!"
+          ).should == "<span>Run </span>unicorn<span> run!</span>"          
+        end
+
+
+        it "should add no padding" do
+          UrlHelperAdditions.add_supplement_to_text( 
+            "unicorns", 
+            :intro => "Learn more about",
+            :outro => "by clicking here",
+            :auto_pad => false
+          ).should == "<span>Learn more about</span>unicorns<span>by clicking here</span>"          
+        end
+        
+        it "should add custom padding" do
+          UrlHelperAdditions.add_supplement_to_text( 
+            "unicorns", 
+            :intro => "Learn more about",
+            :outro => "by clicking here",
+            :auto_pad => "&nbsp;"
+          ).should == "<span>Learn more about&nbsp;</span>unicorns<span>&nbsp;by clicking here</span>"          
+        end
+      end
+    end    
+    
+  end
+end

data/spec/html_samples/valid.html

@@ -0,0 +1,16 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+	<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+
+	<title>This is a sample valid document for testing purposes</title>
+
+</head>
+
+<body>
+
+
+</body>
+</html>

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'supermodel'
+require 'ruby-debug'
+require 'rails/all'   # overkill, but lots of headaches trying to pick and choose needed actionpack components
+require 'access_kit'
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: access_kit
 version: !ruby/object:Gem::Version 
-  hash: 9
-  prerelease: false
+  hash: 15
+  prerelease: 
   segments: 
   - 0
-  - 1
-  version: "0.01"
+  - 2
+  version: "0.02"
 platform: ruby
 authors: 
 - Mani Tadayon
@@ -14,55 +14,57 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-31 00:00:00 -08:00
+date: 2011-02-25 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: nokogiri
+  name: rake
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 49
         segments: 
         - 0
-        version: "0"
-  type: :runtime
+        - 8
+        - 7
+        version: 0.8.7
+  type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rake
+  name: supermodel
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 49
+        hash: 3
         segments: 
         - 0
-        - 8
-        - 7
-        version: 0.8.7
+        version: "0"
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: supermodel
+  name: rspec
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 3
         segments: 
+        - 2
+        - 3
         - 0
-        version: "0"
+        version: 2.3.0
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: rspec-rails
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -78,9 +80,25 @@ dependencies:
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: cucumber
+  name: rails
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -90,7 +108,7 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
 description: A series of tools built with ruby to help ensure HTML is accessibile, including an automated evaluation tool and helpers to generate accessible output for common elements.
 email: mani.tadayon@csun.edu
 executables: []
@@ -100,9 +118,17 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- Rakefile
+- lib/access_kit/core_ext/url_helper.rb
+- lib/access_kit/url_helper_additions.rb
 - lib/access_kit/version.rb
 - lib/access_kit.rb
+- spec/access_kit/semantics_spec.rb
+- spec/access_kit/url_helper_additions_spec.rb
+- spec/html_samples/valid.html
+- spec/spec_helper.rb
+- Gemfile
+- Rakefile
+- README
 has_rdoc: true
 homepage: https://github.com/csun-student-affairs/access_kit
 licenses: []
@@ -126,14 +152,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 23
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: CSUN Accessibility Compliance Toolkit.