accessible_tooltip 1.0.0

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Daniel Vandersluis
+
+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,31 @@
+# AccessibleTooltip
+
+Rails helper for creating a balloon style tooltip that is WCAG compliant.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'accessible_tooltip'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install accessible_tooltip
+
+## Usage
+
+    <%= accessible_tooltip(:help, label: "Help Me", title: "Dogs & Foxes") do>
+      The quick brown fox jumped over the lazy dog.
+    <% end %>
+
+## 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 @@
+require "bundler/gem_tasks"

data/accessible_tooltip.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'accessible_tooltip/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "accessible_tooltip"
+  gem.version       = AccessibleTooltip::VERSION
+  gem.authors       = ["Daniel Vandersluis"]
+  gem.email         = ["dvandersluis@selfmgmt.com"]
+  gem.description   = %q{WCAG compliant balloon-style tooltip helper for Rails}
+  gem.summary       = %q{Accessible tooltip helper for Rails}
+  gem.homepage      = "https://github.com/dvandersluis/accessible_tooltip"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'rails', '>= 3.0.0'
+  gem.add_dependency 'sass-rails', '>= 3.0.0'
+end

data/app/assets/stylesheets/accessible_tooltip/styles.css.scss

@@ -0,0 +1,114 @@
+.accessible_tooltip {
+  a {
+    color: #000000;
+    font-weight: normal;
+    outline: none;
+    cursor: help;
+    text-decoration: none;
+    position: relative;
+    padding: auto;
+
+    &:hover, &:focus {
+      color: #000000;
+      text-decoration: none;
+
+      // Make the span visible
+      & > span.tooltip {
+        overflow: visible;
+        left: 1em;
+        top: 2em;
+        z-index: 99;
+        height: auto;
+        width: 250px;
+        padding: 0.5em 0.8em 0.8em 2em;
+        border-width: 1px;
+        border-style: solid;
+        // Clipping values will need to be adjusted if the large icon is moved
+        // clip: auto - Does not work properly in IE < 9 with negative positioning
+        clip: rect(-10px auto auto -55px);
+        clip: rect(-10px, auto, auto, -55px);
+      }
+    }
+
+    &:focus img.small-icon {
+      outline: 1px dashed #999;
+    }
+
+    & > span.tooltip {
+      @include border-radius(5px, 5px);
+      @include single-box-shadow(rgba(0, 0, 0, 0.1), 5px, 5px, 5px);
+      position: absolute;
+      font-weight: normal;
+      font-size: 12px;
+      color: #000000;
+      cursor: auto;
+    }
+
+    span.label {
+      border-bottom: 1px dotted #000000;
+      margin-right: 4px;
+    }
+
+    img.small-icon {
+      padding: 1px;
+      position: relative;
+      top: -2px;
+      border: 0;
+    }
+  }
+
+  ul {
+    margin-left: 1em;
+    margin-top: 10px;
+    padding: 0;
+  }
+
+  img.icon {
+    height: 48px;
+    width: 48px;
+    border: 0;
+    top: -5px;
+    left: -30px;
+    float: left;
+    position: absolute;
+  }
+
+  em {
+    font-size: 14px;
+    font-weight: bold;
+    display: block;
+    padding: 0.2em 0 0.6em 0;
+  }
+
+  * html a:hover { background: transparent; }
+  .classic {
+    padding: 0.8em 1em;
+    background: #FFFFAA;
+    border: 1px solid #FFAD33;
+  }
+  .critical { background: #FFCCAA; border-color: #FF3334; }
+  .help, .info { background: #9FDAEE; border-color: #2BB0D7; }
+  .warning { background: #FFFFAA; border-color: #FFAD33; }
+
+  &.left
+  {
+    a
+    {
+      &:hover, &:focus
+      {
+        img.icon
+        {
+          left:  auto;
+          right: -30px;
+        }
+
+        & > span.tooltip {
+          left: -230px;
+          padding: 0.5em 2em 0.8em 0.8em;
+          clip: rect(-10px 315px auto -55px);
+          clip: rect(-10px, 315px, auto, -55px);
+        }
+      }
+    }
+  }
+}

data/lib/accessible_tooltip/helpers.rb

@@ -0,0 +1,55 @@
+module AccessibleTooltip
+  module Helpers
+    def accessible_tooltip(type, *args, &block)
+      partial_name = (block_given? ? Time.now.to_i + rand : args.shift)
+      raise ArgumentError, "Either a block or a partial name must be specified" if !partial_name or partial_name.is_a?(Hash)
+      partial_name = partial_name.to_s
+
+      type = type.to_sym
+      types = [:critical, :info, :help, :warning]
+      raise ArgumentError, "type must be one of #{types.join(", ")}" unless types.include?(type)
+
+      if args.first.is_a? Hash
+        element = :span
+        options = args.shift || {}
+      else
+        element = args.shift.andand.to_sym || :span
+        options = args.shift || {}
+      end
+
+      html_options = options.delete(:html) || {}
+      link_options = options.delete(:link) || {}
+      link_options.reverse_merge!(onclick: "return false")
+      title = options.delete(:title)
+      label = options.delete(:label)
+      position = options.delete(:position)
+      container_class = ["accessible_tooltip"]
+      container_class << "left" if position == :left
+
+      content_tag(:span, class: container_class.join(" ")) do
+        link_to options.fetch(:url, "#"), link_options do
+
+          title = t(title) if title.is_a?(Symbol)
+          label = t(label) if label.is_a?(Symbol)
+          tooltip = (type == :help and !title.blank?) ? :tooltip_help_for : :"tooltip_#{type}"
+
+          out = ActiveSupport::SafeBuffer.new
+          out << content_tag(:span, label, class: "label") unless label.blank?
+          out << image_tag("tooltip_#{type}_small.png", alt: t(:tooltip_help), style: 'vertical-align: middle;', class: "small-icon") if options.fetch(:icon, true)
+          out << content_tag(:span, class: "custom #{type} tooltip") do
+            popup = ActiveSupport::SafeBuffer.new
+            popup << image_tag("tooltip_#{type}.png", alt: t(tooltip), class: "icon")
+            popup << content_tag(:em, title) unless title.blank?
+
+            if block_given?
+              popup << capture(&block)
+            else
+              # Try to find a partial with a _tooltip suffix, or just the given partial name if not found
+              popup << (render(:partial => "#{partial_name}_tooltip") rescue render(:partial => partial_name))
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/accessible_tooltip/version.rb

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

data/lib/accessible_tooltip.rb

@@ -0,0 +1,12 @@
+require 'accessible_tooltip/version'
+require 'accessible_tooltip/helpers'
+
+module AccessibleTooltip
+  class Engine < Rails::Engine
+    initializer 'accessible_tooltip.hook_into_action_view' do
+      ActiveSupport.on_load :action_view do
+        include AccessibleTooltip::Helpers
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: accessible_tooltip
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Daniel Vandersluis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    none: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    none: false
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    none: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    none: false
+description: WCAG compliant balloon-style tooltip helper for Rails
+email:
+- dvandersluis@selfmgmt.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- accessible_tooltip.gemspec
+- app/assets/images/tooltip_critical.png
+- app/assets/images/tooltip_critical_small.png
+- app/assets/images/tooltip_help.png
+- app/assets/images/tooltip_help_small.png
+- app/assets/images/tooltip_info.png
+- app/assets/images/tooltip_warning.png
+- app/assets/stylesheets/accessible_tooltip/styles.css.scss
+- lib/accessible_tooltip.rb
+- lib/accessible_tooltip/helpers.rb
+- lib/accessible_tooltip/version.rb
+homepage: https://github.com/dvandersluis/accessible_tooltip
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Accessible tooltip helper for Rails
+test_files: []
+has_rdoc: