access_kit 0.03 → 0.04

data/lib/access_kit/url_helper_additions.rb

@@ -1,13 +1,19 @@
 module AccessKit
   module UrlHelperAdditions
     extend ActiveSupport::Concern 
-      
+    mattr_accessor :css_class
+    
     class << self
       DEFAULT_KEY_NAME_FOR_PRECEDING_TEXT = :intro
       DEFAULT_KEY_NAME_FOR_FOLLOWING_TEXT = :outro
+      DEFAULT_CSS_CLASS_FOR_SUPPLEMENT    = "access_kit"
       
       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}
+        default_opts = {  DEFAULT_KEY_NAME_FOR_PRECEDING_TEXT => nil, 
+                          DEFAULT_KEY_NAME_FOR_FOLLOWING_TEXT => nil, 
+                          :auto_pad => true, 
+                          :css_class_for_supplement => css_class_for_supplement
+        }
         opts = default_opts.merge(opts)
       
         padding = begin
@@ -19,15 +25,10 @@ module AccessKit
             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 = span_tag opts[DEFAULT_KEY_NAME_FOR_PRECEDING_TEXT], :padding_after => padding, :class => opts[:css_class_for_supplement]
+        after_span  = span_tag opts[DEFAULT_KEY_NAME_FOR_FOLLOWING_TEXT], :padding_before => padding, :class => opts[:css_class_for_supplement]
+        
         "#{before_span}#{text}#{after_span}".html_safe
       end
 
@@ -42,7 +43,7 @@ module AccessKit
       def process_options_for_link_to_with_supplement(*args)
         if args_for_link_to_with_supplement?(*args)
           # TODO: move to separate method: 'extract_supplement_opts'
-          supplement_opts = [ DEFAULT_KEY_NAME_FOR_PRECEDING_TEXT, DEFAULT_KEY_NAME_FOR_FOLLOWING_TEXT, :auto_pad ].inject({}) do |memo, k|
+          supplement_opts = [ DEFAULT_KEY_NAME_FOR_PRECEDING_TEXT, DEFAULT_KEY_NAME_FOR_FOLLOWING_TEXT, :auto_pad, :css_class_for_supplement ].inject({}) do |memo, k|
             value = args[2].delete(k)
             value.blank? ? memo : memo.merge( k => value )
           end
@@ -58,8 +59,22 @@ module AccessKit
 
       private 
         # TODO: use Rails content_tag if available
-        def span_tag(content)
-          "<span>#{content}</span>"
+        def span_tag(content, opts={} )
+          default_opts = {:padding_before => '', :padding_after => '', :class => ""}
+          opts = default_opts.merge(opts)
+          
+          if content.blank?
+            ""
+          else
+            class_str = opts[:class].blank? ? 
+              "" :
+              ' class="' + opts[:class] + '"'
+            "<span#{class_str}>#{opts[:padding_before]}#{content}#{opts[:padding_after]}</span>"
+          end
+        end
+        
+        def css_class_for_supplement
+          self.css_class || DEFAULT_CSS_CLASS_FOR_SUPPLEMENT
         end
     end
   end

data/lib/access_kit/version.rb

@@ -1,3 +1,3 @@
 module AccessKit
-  VERSION="0.03"
+  VERSION="0.04"
 end

data/spec/access_kit/url_helper_additions_spec.rb

@@ -1,74 +1,99 @@
 require 'spec_helper'
 
 module AccessKit
-  describe UrlHelperAdditions do    
-    context "#link_to_with_supplement" do
+  describe UrlHelperAdditions do  
+    describe "#link_to_with_supplement" do    
+      let(:args){  [ "unicorns", 
+                      '#unicorns', 
+                      { :intro => "Click to learn about" }
+                    ]        
+      }
+
       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
-      
-      context "#args_for_link_to_with_supplement?" do
-        context "should return true if :intro or :outro options are passed" do
-          UrlHelperAdditions.args_for_link_to_with_supplement?(
-            "unicorns", 
-            '#unicorns', 
-            :intro => "Click to learn about"
-          ).should == true
+      context "without a css class for supplementary text" do
+        # this is to keep the expected output shorter and easier to read
+        before do
+          ::AccessKit::UrlHelperAdditions.css_class = ""
         end
-              
-        it "should return false if neither :intro nor :outro options are passed" do
-          UrlHelperAdditions.args_for_link_to_with_supplement?(
-            "unicorns", 
-            '#unicorns'
-          ).should == false
+        
+        it "should extend link_to" do
+          link_to(*args).should == "<a href=\"#unicorns\"><span>Click to learn about </span>unicorns</a>"
         end
+      
+        describe "#args_for_link_to_with_supplement?" do        
+          it "should return true if :intro or :outro options are passed" do
+            UrlHelperAdditions.args_for_link_to_with_supplement?(*args).should == true
+          end
+              
+          it "should return false if neither :intro nor :outro options are passed" do  
+            UrlHelperAdditions.args_for_link_to_with_supplement?("unicorns", '#unicorns').should == false
+          end
         
-        it "should return false if a block is given" do
-          some_block = lambda{ 'link_name' }
-          UrlHelperAdditions.args_for_link_to_with_supplement?(
-            '#unicorns',
-            :intro => "Click to learn about",
-            &some_block
-          ).should == false          
+          # TODO: why not allow blocks to be passed?
+          it "should return false if a block is given" do
+            some_block = lambda{ 'link_name' }
+            UrlHelperAdditions.args_for_link_to_with_supplement?(args, &some_block).should == false          
+          end
         end
-      end
       
-      context "#process_options_for_link_to_with_supplement" do
-        context "args_for_link_to_with_supplement? is true" do
-          it "should return hash with new name" do
-            UrlHelperAdditions.process_options_for_link_to_with_supplement(
-              "unicorns", 
-              '#unicorns', 
-              :intro => "Click to learn about",
-              :class => 'mythical'              
-            ).should == ["<span>Click to learn about </span>unicorns",
-                          '#unicorns', 
-                          { :class => 'mythical' }
-            ]
+        describe "#process_options_for_link_to_with_supplement" do
+          context "args_for_link_to_with_supplement? is true" do
+            it "should return hash with new name" do
+              args.last[:class] = 'mythical'
+              UrlHelperAdditions.process_options_for_link_to_with_supplement(*args).should == 
+                [ "<span>Click to learn about </span>unicorns",
+                  '#unicorns', 
+                  { :class => 'mythical' }
+                ]
             
+            end
           end
-        end
         
-        context "args_for_link_to_with_supplement? is false" do
-          it "should return nil" do
-            UrlHelperAdditions.process_options_for_link_to_with_supplement(
-              "unicorns", 
-              '#unicorns'
-            ).should be_nil     
+          context "args_for_link_to_with_supplement? is false" do
+            it "should return nil" do
+              UrlHelperAdditions.process_options_for_link_to_with_supplement(
+                "unicorns", 
+                '#unicorns'
+              ).should be_nil     
+            end
           end
+        
+        end
+      end
+
+      context "with a css class for supplementary text" do
+        before do
+          # wipe out any custom settings from previous examples
+          ::AccessKit::UrlHelperAdditions.css_class = nil
+        end        
+        it "should use 'access_kit' as the default css class" do
+          link_to(*args).should == "<a href=\"#unicorns\"><span class=\"access_kit\">Click to learn about </span>unicorns</a>"
+        end      
+
+        it "should allow a custom css class to be set" do
+          args.last[:css_class_for_supplement] = 'hidden_text for_accessibility'
+          link_to(*args).should == "<a href=\"#unicorns\"><span class=\"hidden_text for_accessibility\">Click to learn about </span>unicorns</a>"
         end
         
+        it "should allow the default css class to be customized" do
+          AccessKit::UrlHelperAdditions.css_class = 'foo'
+          link_to(*args).should == "<a href=\"#unicorns\"><span class=\"foo\">Click to learn about </span>unicorns</a>"
+        end        
+
       end
+
     end
         
-    context "#add_supplement_to_text" do
+
+        
+    describe "#add_supplement_to_text" do
+      # this is to keep the expected output shorter and easier to read
+      before do
+        ::AccessKit::UrlHelperAdditions.css_class = ""
+      end      
+      
       it "should add before" do
         UrlHelperAdditions.add_supplement_to_text( 
           "unicorns", 

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification 
 name: access_kit
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 3
   prerelease: 
   segments: 
   - 0
-  - 3
-  version: "0.03"
+  - 4
+  version: "0.04"
 platform: ruby
 authors: 
 - Mani Tadayon
+- Brian Miller
 autorequire: 
 bindir: bin
 cert_chain: []