simple-tooltip 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*~
+pkg/*
+*.gem
+.bundle
+craic

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011 Robert Jones, Craic Computing LLC
+
+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.markdown

@@ -0,0 +1,136 @@
+SimpleTooltip
+=============
+
+Simple and flexible Tooltip Help for Rails applications
+
+There are many JavaScript plugins that provide basic tooltip (popup) help for web pages. These work by including the 
+text of the help message directly in the content of each page.
+
+But this approach fails when the information requires more than one paragraph and when more than plain
+text is required. For example, the help message might require a link to an external web site.
+
+With SimpleTooltip you create tooltip help content in a web form and record it in the database via a Tooltip model.
+Content can be created in plain text, HTML, Markdown and Textile, allowing tooltips to use the
+full features of HTML, including links, CSS styling, etc.
+
+Tooltip links, typically small icons, are placed in your views with calls to a simple helper method that refer 
+to the related content by title.
+
+Tooltip records include a locale column that defines the language used for their content. Multiple tooltips can
+be created with the same title but different locales. When a given title is requested, the code tries to find
+a version that matches the user's current locale.
+
+SimpleTooltip helps bridge the gap between short, fixed tooltips and full help pages. 
+
+Tooltips are displayed via a [jQuery](http://jquery.com "jQuery"). They can be configured to appear transiently when a user hovers over a link icon,
+or to appear when the link icon is clicked, remaining until closed by a click within the tooltip.
+
+
+If the client browser does not have JavaScript enabled, the tooltip links take the user to a separate help 
+page.
+
+Developers can customize the styling of the tooltip content via CSS definitions and tooltip icons can be replaced with others.
+
+
+Prerequisites
+=============
+
+The initial release of SimpleTooltip works [Rails](http://rubyonrails.org "Rails 3") and [jQuery](http://jquery.com "jQuery"). It is not expected to work with Rails 2.
+
+
+Installation
+============
+
+SimpleTooltip is distributed as a Ruby Gem and is installed in an application via a Rails generator.
+
+1: Install the gem on your system
+
+	$ gem install simple-tooltip
+
+The gem is hosted at [Ruby Gems](https://rubygems.org "Ruby Gems")
+
+2: Within your Rails application, run the generator
+
+	$ rails generate simple_tooltip:install
+
+(note the underscore in the generator name - this seems to be a requirement of the Rails generator machinery)
+
+The generator creates the following items
+
+* A Tooltip model, controller and views and a database migration
+* A stylesheet, javascript file and icon image files
+* Tests
+
+3: Setup your gem dependencies
+
+Add this line to your Gemfile and run `$ bundle install`
+
+	gem 'simple-tooltip'
+
+4: Create the tooltips table in your database
+
+	$ rake db:migrate
+
+5: Include the JQuery file
+
+Make sure you have the jQuery JavaScript library installed (via jquery-rails)'
+	$ rails generate jquery:install
+
+Then add this line to `app/views/layouts/application.html.erb` after other JavaScript files
+	<%= javascript_include_tag 'simple_tooltip.js' %>
+
+The stylesheet should be included automatically.
+
+6: Now create some tooltips 
+
+Start your application and go to /tooltips/new
+
+7: In the views of other models, add links to your tooltip records
+
+For example:
+
+	<%= tooltip('email format', :hover) %>
+	<%= tooltip('privacy agreement', :click) %>
+
+
+Usage
+=====
+
+Tooltips are defined in your views with the tooltip helper method, found in `app/helpers/tooltip_helper.rb`
+
+Each tooltip record in the database should be given a title, preferably something informative such as 'phone number format'.
+This title is supplied to the tooltip helper in order to retrieve the matching record.
+
+Multiple calls to the helper can use the same title. They will operate independently.
+
+The tooltip 'popup' is displayed in one of two modes.
+
+The default `:hover` mode specifies that the tooltip will appear when the mouse is held over the help icon and will
+disappear when the mouse leaves that icon.
+
+With the `:click` mode, the tooltip appears then the icon is clicked. The tooltip remains in view until the `close` icon at the 
+top of the tooltip is clicked or until another tooltip help icon is clicked.
+
+This mode is used when the tooltip contains a link to another web page or when the content is extensive.
+
+
+Customizing
+===========
+
+Although the Tooltip model, etc use the word `tooltip`, the images and other asset files use the longer form `simple_tooltip`. This is
+intentional as a number of the JavaScript tooltip solutions use the shorter form.
+
+The help and close icons are found in `public/images/simple_tooltip_help_icon.png` and `public/images/simple_tooltip_close_icon.png`
+respectively. The images can be replaced as long as the file names stay the same. If you want to change the filenames you will
+need to modify them in the JavaScript file.
+
+The stylesheet is found at `public/stylesheets/simple_tooltip.css` and defines two class selectors that affect how the icons are displayed and an ID selector that defines how the 'popup'
+tooltip content is displayed.
+
+The jQuery JavaScript is found at `public/javascripts/simple_tooltip.js`. You should not need to modify this file.
+
+SimpleTooltip is written by [Rob Jones](http://github.com/craic "Rob Jones") at [Craic Computing](http://craic.com "Craic Computing") in Seattle. It is distributed freely under the MIT license.
+
+
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/TODO

@@ -0,0 +1,13 @@
+March 2011 - initial release
+
+- add instructions to README on adding tooltip links on static pages - explicit HTML
+
+- add an action that clones an existing tooltip with an alternate locale
+
+- include link to Google Translate to facilitate creation of tooltips in 
+  alternate locales
+
+- improve the styling of the tooltip popups - either directly with 'themes' or
+  through incorporating jQuery tooltip/popup plugins
+
+

data/lib/generators/simple_tooltip/install_generator.rb

@@ -0,0 +1,95 @@
+module SimpleTooltip
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+  
+      desc "This generator installs all the files necessary for the simple_tooltip gem"
+
+      
+      def copy_stylesheet_and_images
+        path = "public/stylesheets/simple_tooltip.css"
+        copy_file "./#{path}", path
+        path = "public/images/simple_tooltip_help_icon.png"
+        copy_file "./#{path}", path
+        path = "public/images/simple_tooltip_close_icon.png"
+        copy_file "./#{path}", path
+      end
+
+      def copy_javascript
+        path = "public/javascripts/simple_tooltip.js"
+        copy_file "./#{path}", path
+      end
+
+      def copy_migration
+        # Migration file name is preceded by the date/time string - UTC timestamp Time.now.gmtime.strftime("%Y%m%d%H%M%S")
+        copy_file "./db/migrate/create_tooltips.rb", 
+                  "db/migrate/#{Time.now.gmtime.strftime("%Y%m%d%H%M%S")}_create_tooltips.rb"
+      end
+  
+      def copy_app_files
+        path = "app/controllers/tooltips_controller.rb"
+        copy_file "./#{path}", path
+        path = "app/models/tooltip.rb"
+        copy_file "./#{path}", path
+        path = "app/helpers/tooltip_helper.rb"
+        copy_file "./#{path}", path
+        path = "app/views/tooltips"
+        directory "./#{path}", path
+      end
+  
+      def copy_tests
+        path = "test/unit/tooltip_test.rb"
+        copy_file "./#{path}", path
+        path = "test/unit/helpers/tooltips_helper_test.rb"
+        copy_file "./#{path}", path
+        path = "test/fixtures/tooltips.yml"
+        copy_file "./#{path}", path
+        path = "test/functional/tooltips_controller_test.rb"
+        copy_file "./#{path}", path
+      end
+
+      # Add this multi line definition to the routes file - but only a single call to route
+      # otherwise they are placed in reverse line order!
+      def setup_route
+        route "resources :tooltips do\n" +
+              "             collection do\n" +
+              "               get 'tooltip_content'\n" +
+              "             end\n" +
+              "           end"
+      end
+
+      # Output installation instructions for the user
+      def instructions
+        puts '---------------------------------------------------------------'
+        puts 'To complete your installation...'
+        puts ''
+        puts "1: Add this gem to your project Gemfile and run 'bundle install'"
+        puts ''
+        puts "   gem 'simple-tooltip'"
+        puts ''
+        puts '2: Run db:migrate to create the tooltips database table'
+        puts ''
+        puts "   $ rake db:migrate"
+        puts ''
+        puts '3: Make sure you have the jQuery JavaScript library installed (via jquery-rails)'
+        puts ''
+        puts '   $ rails generate jquery:install'
+        puts ''
+        puts '4: Check that these first two lines are in layouts/application.html.erb and add the third'
+        puts ''
+        puts '  <%= stylesheet_link_tag :all %>'
+        puts '  <%= javascript_include_tag :defaults %>'
+        puts "  <%= javascript_include_tag 'simple_tooltip.js' %>"
+        puts ''
+        puts '5: Create some tooltip entries in /tooltips and then add links'
+        puts '   to them in views of your other models'
+        puts "   <%= tooltip('tooltip title', :hover) %>"
+        puts ''
+        puts 'For more information see the project page on GitHub'
+        puts '   https://github.com/craic/simple_tooltip'
+        puts '---------------------------------------------------------------'
+      end
+      
+    end
+  end
+end

data/lib/generators/simple_tooltip/templates/app/controllers/tooltips_controller.rb

@@ -0,0 +1,117 @@
+class TooltipsController < ApplicationController
+  
+  # Add admin before_filter here - something like this (depends on your authorization solution)
+  # This prevents regular users from modifying the help pages
+  # before_filter admin?, :except => [ :tooltip_content ]
+  
+  # GET /tooltips
+  # GET /tooltips.xml
+  def index
+    @tooltips = Tooltip.all
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  { render :xml => @tooltips }
+    end
+  end
+
+  # GET /tooltips/1
+  # GET /tooltips/1.xml
+  def show
+    @tooltip = Tooltip.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.xml  { render :xml => @tooltip }
+    end
+  end
+
+  # GET /tooltips/new
+  # GET /tooltips/new.xml
+  def new
+    @tooltip = Tooltip.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.xml  { render :xml => @tooltip }
+    end
+  end
+
+  # GET /tooltips/1/edit
+  def edit
+    @tooltip = Tooltip.find(params[:id])
+  end
+
+  # POST /tooltips
+  # POST /tooltips.xml
+  def create
+    @tooltip = Tooltip.new(params[:tooltip])
+
+    respond_to do |format|
+      if @tooltip.save
+        format.html { redirect_to(@tooltip, :notice => 'Tooltip was successfully created.') }
+        format.xml  { render :xml => @tooltip, :status => :created, :location => @tooltip }
+      else
+        format.html { render :action => "new" }
+        format.xml  { render :xml => @tooltip.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /tooltips/1
+  # PUT /tooltips/1.xml
+  def update
+    @tooltip = Tooltip.find(params[:id])
+
+    respond_to do |format|
+      if @tooltip.update_attributes(params[:tooltip])
+        format.html { redirect_to(@tooltip, :notice => 'Tooltip was successfully updated.') }
+        format.xml  { head :ok }
+      else
+        format.html { render :action => "edit" }
+        format.xml  { render :xml => @tooltip.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /tooltips/1
+  # DELETE /tooltips/1.xml
+  def destroy
+    @tooltip = Tooltip.find(params[:id])
+    @tooltip.destroy
+
+    respond_to do |format|
+      format.html { redirect_to(tooltips_url) }
+      format.xml  { head :ok }
+    end
+  end
+  
+  
+  # fetch and return the content of the specified tooltip, taking into account user's locale where relevant
+  def tooltip_content
+
+    if params[:title]
+    
+      # find and display a specific tooltip
+      @tooltip = Tooltip.from_title_and_locale(params[:title])
+
+      if params[:js]
+        if @tooltip.blank?
+          data = "Sorry... unable to find that help content"
+        else
+          data = @tooltip.content_to_html
+        end
+        send_data(data, :type => 'text/plain', :disposition => 'inline')
+      else  
+        if @tooltip.blank?
+          flash[:notice] = "Sorry... unable to find that help content"
+        end
+      end
+      
+    else
+      # should be impossible to get here
+       flash[:notice] = "Sorry... no tooltip Title was provided"
+    end  
+  end
+    
+end

data/lib/generators/simple_tooltip/templates/app/helpers/tooltip_helper.rb

@@ -0,0 +1,25 @@
+module TooltipHelper
+
+  # tooltip helper for inclusion in views
+  # TODO - allow a custom class to be passed - e.g. twitter style - look at poshy tip
+  def tooltip(text='', mode=:hover)
+
+    return if text == ''
+    
+    tooltip_help_icon_file = "/images/simple_tooltip_help_icon.png"
+
+    class_str = "simple-tooltip-help-icon"    
+    if mode == :click
+      title = 'Click for help'
+      class_str << " simple-tooltip-clickable"
+    else
+      title = text
+    end
+
+    link_to(image_tag(tooltip_help_icon_file), 
+            tooltip_content_tooltips_path(:title => text),
+            :name => text, :title => title, 
+            :class => class_str)
+  end
+  
+end

data/lib/generators/simple_tooltip/templates/app/models/tooltip.rb

@@ -0,0 +1,81 @@
+# encoding: UTF-8
+
+require 'rdiscount'
+
+class Tooltip < ActiveRecord::Base
+
+  attr_accessible :title, :content, :markup, :locale
+    
+  validates_presence_of   :title
+  validates_presence_of   :content
+  validates_presence_of   :markup
+  
+  validates_format_of :locale,
+                      :with => /^[a-z][a-z]$/,
+                      :message => 'must be in ISO-639-1 two letter format (e.g. en, de, zh)',
+                      :allow_blank => true
+
+  validates_inclusion_of  :markup,
+                          :in => %w{ html markdown textile },
+                          :message => 'must be one of html, markdown or textile'
+                          
+  validate :validate_no_script_tags
+
+  validate :validate_unique_title_locale_combination, :on => :create
+
+
+  # find the tooltip that matches the title and locale
+  def self.from_title_and_locale(title, user_locale = I18n.locale.to_s)
+
+    tooltip = nil
+    tooltips = Tooltip.where(:title => title).all
+
+    if tooltips.count == 1
+      # there is only one, so use that
+      tooltip = tooltips.first
+
+    elsif tooltips.count > 1
+
+      # Try and match by locale
+      default_tooltip = nil
+      tooltips.each do |tooltip_i|
+        if tooltip_i.locale == user_locale
+          tooltip = tooltip_i
+          break
+        elsif tooltip_i.locale.nil? or tooltip_i.locale == I18n.default_locale.to_s
+          default_tooltip = tooltip_i
+        end
+      end
+      tooltip = default_tooltip if tooltip.blank?
+    end
+
+    tooltip
+  end
+
+
+  # Process content with RDiscount if needed
+  def content_to_html
+    if self.markup == 'markdown'
+      RDiscount.new(self.content, :autolink).to_html
+    elsif self.markup == 'textile'
+      RedCloth.new(self.content).to_html
+    else
+      self.content
+    end
+  end
+  
+  protected
+  
+  def validate_unique_title_locale_combination
+    if Tooltip.where(:title => self.title).where(:locale => self.locale).count > 0
+      errors.add(:title, 'and locale combination already exists')    
+    end
+  end
+  
+  def validate_no_script_tags
+    if self.content =~ /\<\s*script/im
+      errors.add(:content, 'must not contain <script> tags')
+    end
+  end
+  
+end

data/lib/generators/simple_tooltip/templates/app/views/tooltips/_form.html.erb

@@ -0,0 +1,41 @@
+<%= form_for(@tooltip) do |f| %>
+  <% if @tooltip.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@tooltip.errors.count, "error") %> prohibited this Tooltip from being saved:</h2>
+
+      <ul>
+      <% @tooltip.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :title %><br />
+    <%= f.text_field :title %>
+  </div>
+  <div class="field">
+    <%= f.label :content %><br />
+    <%= f.text_area :content %>
+  </div>
+  <div class="field">
+    <%= f.label :locale %><br />
+    <%= f.text_field :locale %> Use two letter ISO-639-1 code
+  </div>
+  <div class="field">
+    <%= f.label :markup %><br />
+    <%= f.radio_button :markup, 'markdown', :selected => true %> Markdown
+    <%= f.radio_button :markup, 'textile' %> Textile
+    <%= f.radio_button :markup, 'html' %> HTML / Plain Text &nbsp;
+<br/>
+<a href="http://en.wikipedia.org/wiki/Markdown">Markdown syntax</a>
+<br/>
+<a href="http://redcloth.org/textile">Textile syntax</a>
+
+  </div>
+
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>

data/lib/generators/simple_tooltip/templates/app/views/tooltips/edit.html.erb

@@ -0,0 +1,6 @@
+<h1>Editing Tooltip</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Show', @tooltip %> |
+<%= link_to 'Back', tooltips_path %>

data/lib/generators/simple_tooltip/templates/app/views/tooltips/index.html.erb

@@ -0,0 +1,29 @@
+<h1>Listing Tooltips</h1>
+
+<table>
+  <tr>
+    <th>Title</th>
+    <th>Locale</th>
+    <th>Markup</th>
+
+    <th></th>
+    <th></th>
+    <th></th>
+  </tr>
+
+<% @tooltips.each do |tooltip| %>
+  <tr>
+    <td><%= tooltip.title %></td>
+    <td><%= tooltip.locale %></td>
+    <td><%= tooltip.markup %></td>
+
+    <td><%= link_to 'Show', tooltip %></td>
+    <td><%= link_to 'Edit', edit_tooltip_path(tooltip) %></td>
+    <td><%= link_to 'Destroy', tooltip, :confirm => 'Are you sure?', :method => :delete %></td>
+  </tr>
+<% end %>
+</table>
+
+<br />
+
+<%= link_to 'New Tooltip', new_tooltip_path %>

data/lib/generators/simple_tooltip/templates/app/views/tooltips/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New Tooltip</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Back', tooltips_path %>

data/lib/generators/simple_tooltip/templates/app/views/tooltips/show.html.erb

@@ -0,0 +1,31 @@
+<p id="notice"><%= notice %></p>
+
+<% if @user_view %>
+
+  <%= raw(@tooltip.content_to_html) %>
+  <p><br/><%= link_to "Go Back", request.referer %></p>
+
+<% else %>
+<p>
+  <b>Title:</b>
+  <%= @tooltip.title %>
+</p>
+
+<p>
+  <b>Content:</b>
+  <%= raw(@tooltip.content_to_html) %>
+</p>
+
+<p>
+  <b>Markup:</b>
+  <%= @tooltip.markup %>
+</p>
+
+<p>
+  <b>Locale:</b>
+  <%= @tooltip.locale %>
+</p>
+
+<%= link_to 'Edit', edit_tooltip_path(@tooltip) %> |
+<%= link_to 'Back', tooltips_path %>
+<% end %>

data/lib/generators/simple_tooltip/templates/app/views/tooltips/tooltip_content.html.erb

@@ -0,0 +1,9 @@
+<h2>Tooltip Help</h2>
+<p id="notice"><%= notice %></p>
+
+<% unless @tooltip.blank? %>
+<%= raw(@tooltip.content_to_html) %>
+<% end %>
+
+<p><br/><%= link_to "Go Back", request.referer %></p>
+

data/lib/generators/simple_tooltip/templates/db/migrate/create_tooltips.rb

@@ -0,0 +1,15 @@
+class CreateTooltips < ActiveRecord::Migration
+  def self.up
+    create_table :tooltips do |t|
+      t.string   :title
+      t.text     :content
+      t.string   :markup,     :default => "markdown"
+      t.string   :locale
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :tooltips
+  end
+end

data/lib/generators/simple_tooltip/templates/public/javascripts/simple_tooltip.js

@@ -0,0 +1,68 @@
+// jQuery code for the simple_tooltip gem
+jQuery(document).ready(function() {
+
+	var close_icon_file = "/images/simple_tooltip_close_icon.png";
+	
+	jQuery('.simple-tooltip-help-icon').mouseenter(function(e) {
+		// remove any existing tooltip - should not be necessary, just a safety clause
+
+// this has the side efect of removing any other visible tooltip on entering any other icon
+		jQuery("#simple-tooltip").remove();
+		
+		// setup tooltip on hover
+		if(!jQuery(this).hasClass('simple-tooltip-clickable')) {
+			// Remove the 'title' attribute to prevent it appearing on hover
+			this.title = null;
+			
+			// get the content for this tooltip by ajax and create the popup 
+			jQuery.get("/tooltips/tooltip_content?js=true&title=" + this.name, function(data) {
+
+				jQuery("body").append("<div id='simple-tooltip'>" + data + "</div>");
+
+				// position the tooltip at the bottom right of mouse pointer
+				jQuery("#simple-tooltip").css("top",(e.pageY + 5) + "px").css("left",(e.pageX + 5) + "px").show();
+
+				// with fast mouse movements the tooltip can remain visible
+				// setup an action that if it is clicked then it is removed
+				// shouldn't be necessary but it seems to be...
+				jQuery('#simple-tooltip').click(function() {
+					 jQuery(this).remove(); 
+				});			
+			});
+		}
+
+	}).click(function(e) {
+		// prevent this event bubbling up to the link
+		e.preventDefault();
+		
+		// setup tooltip on click
+		if(jQuery(this).hasClass('simple-tooltip-clickable')) {
+
+			// get the content for this tooltip by ajax and create the popup 
+			jQuery.get("/tooltips/tooltip_content?js=true&title=" + this.name, function(data) {
+
+				// setup a close button within the tooltip at top right
+				var close_div = "<div id=\"simple-tooltip-close\" class=\"simple-tooltip-close\">" +
+								"<img src=\"" + close_icon_file + "\" alt=\"Close tooltip\"/></div>";
+
+				jQuery("body").append("<div id='simple-tooltip'>" + close_div + data + "</div>");
+				
+				// position the tooltip at the bottom right of mouse pointer
+				jQuery("#simple-tooltip").css("top",(e.pageY + 5) + "px").css("left",(e.pageX + 5) + "px").show();
+
+				// remove the tooltip when close button is clicked
+				jQuery('#simple-tooltip-close').click(function() {
+	 				jQuery("#simple-tooltip").remove(); 
+				});
+				// ?? remove tooltip if the tooltip_icon is clicked a second time ??
+				
+			});
+		}
+
+	}).mouseleave(function(e) {
+		// in :hover mode, remove the tooltip when the mouse leaves the tooltip icon
+		if(!jQuery(this).hasClass('simple-tooltip-clickable')) {
+			jQuery("#simple-tooltip").remove();
+		}
+	});
+});

data/lib/generators/simple_tooltip/templates/public/stylesheets/simple_tooltip.css

@@ -0,0 +1,27 @@
+
+.simple-tooltip-help-icon {
+	text-decoration: none;
+}
+
+.simple-tooltip-help-icon>img {
+	vertical-align: middle;
+}
+
+.simple-tooltip-help-icon:hover {
+	background: none;
+}
+
+.simple-tooltip-close {
+	text-align: right;
+}
+
+#simple-tooltip {
+	position:   absolute;
+	border:     1px solid #333;
+	background: #ffffd8;
+	padding:    2px 5px;
+	color:      #000;
+	display:    none;
+	text-align: left;
+}
+

data/lib/generators/simple_tooltip/templates/test/fixtures/tooltips.yml

@@ -0,0 +1,24 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+
+one:
+  title: MyString_1
+  content: MyText
+  markup: html
+  locale: en
+two:
+  title: MyString_2
+  content: MyText
+  markup: html
+  locale: en
+
+en_locale:
+  title: locale_test
+  content: Hello
+  markup: html
+  locale: en
+
+es_locale:
+  title: locale_test
+  content: Hola
+  markup: html
+  locale: es

data/lib/generators/simple_tooltip/templates/test/functional/tooltips_controller_test.rb

@@ -0,0 +1,59 @@
+require 'test_helper'
+
+class TooltipsControllerTest < ActionController::TestCase
+  setup do
+    @tooltip = tooltips(:one)
+  end
+
+  test "should get index" do
+    get :index
+    assert_response :success
+    assert_not_nil assigns(:tooltips)
+  end
+
+  test "should get new" do
+    get :new
+    assert_response :success
+  end
+
+  test "should create tooltip" do
+    assert_difference('Tooltip.count') do
+      tooltip = Tooltip.new({:title => 'foo', :content => 'bar'})
+      post :create, :tooltip => tooltip.attributes
+    end
+
+    assert_redirected_to tooltip_path(assigns(:tooltip))
+  end
+
+  test "should show tooltip" do
+    get :show, :id => @tooltip.to_param
+    assert_response :success
+  end
+
+  test "should get edit" do
+    get :edit, :id => @tooltip.to_param
+    assert_response :success
+  end
+
+  test "should update tooltip" do
+    put :update, :id => @tooltip.to_param, :tooltip => @tooltip.attributes
+    assert_redirected_to tooltip_path(assigns(:tooltip))
+  end
+
+  test "should destroy tooltip" do
+    assert_difference('Tooltip.count', -1) do
+      delete :destroy, :id => @tooltip.to_param
+    end
+
+    assert_redirected_to tooltips_path
+  end
+  
+  # Add tests for the ajax functions....
+  
+  # tooltip_content
+  test "should show tooltip content given a title" do
+    get :tooltip_content, :title => @tooltip.title
+    assert_response :success
+  end
+
+end

data/lib/generators/simple_tooltip/templates/test/unit/helpers/tooltips_helper_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+
+class TooltipsHelperTest < ActionView::TestCase
+
+# Need to add tests here
+
+end

data/lib/generators/simple_tooltip/templates/test/unit/tooltip_test.rb

@@ -0,0 +1,97 @@
+require 'test_helper'
+
+class TooltipTest < ActiveSupport::TestCase
+
+  
+  # test no script validation routine
+  
+  test "validate ok if content has no <script> tag" do
+    tooltip = Tooltip.new(:title => 'foo', :markup => 'html', 
+                                :content => "<p>all good here</p>")
+    assert tooltip.valid?
+  end
+
+  test "validate with error if content has <script> tag" do
+    tooltip = Tooltip.new(:title => 'foo', :markup => 'html', 
+                                :content => "foo <script> bad \n stuff </script> bar")
+    assert !tooltip.valid?
+    assert tooltip.errors[:content].any?    
+  end
+
+  test "validate with error if format of locale is not two letter" do
+    tooltip = Tooltip.new(:title => 'foo', :markup => 'html', :locale => 'locale', 
+                                :content => "text")
+    assert !tooltip.valid?
+    assert tooltip.errors[:locale].any?    
+  end
+
+  test "validate OK if format of locale is two letter" do
+    tooltip = Tooltip.new(:title => 'foo', :markup => 'html', :locale => 'en', 
+                                :content => "text")
+    assert tooltip.valid?
+  end
+
+
+  test "validate fails unless unique title and locale" do
+    tooltip0 = Tooltip.new(:title => 'foo', :markup => 'html', :locale => 'en',
+                                 :content => "<p>Here to help</p>")
+    tooltip0.save!
+    
+    tooltip1 = Tooltip.new(:title => 'foo', :markup => 'html', :locale => 'en',
+                                 :content => "<p>Here to help</p>")
+
+
+    assert !tooltip1.valid?
+    assert tooltip1.errors[:title].any?  
+  end
+
+
+  test "validate passes duplicate title but unique locale" do
+
+    tooltip0 = Tooltip.new(:title => 'foo', :markup => 'html', :locale => 'en',
+                                 :content => "<p>Here to help</p>")
+    tooltip0.save!
+    
+    tooltip1 = Tooltip.new(:title => 'foo', :markup => 'html', :locale => 'de',
+                                 :content => "<p>Here to help</p>")
+
+    assert tooltip1.valid?
+  end
+  
+  
+  test "content_to_html passes through html content" do
+    content = "<p>Here is some text in <span style=\"color: red;\">HTML</span> format.</p>"
+    tooltip = Tooltip.new(:title => 'foo', :markup => 'html', 
+                                :content => content)
+    assert_equal tooltip.content_to_html, content
+  end
+
+
+  test "content_to_html converts Markdown content to html" do
+    content = "<p>Here is some text in <strong>Markdown</strong> format</p>\n\n<p><a href=\"http://craic.com\">http://craic.com</a></p>\n"
+    markdown = "Here is some text in **Markdown** format\n\nhttp://craic.com"
+    tooltip = Tooltip.new(:title => 'foo', :markup => 'markdown', 
+                                :content => markdown)
+    assert_equal tooltip.content_to_html, content
+  end
+
+  test 'class method from_title_and_locale return the correct tooltip' do
+  
+    tooltip0 = Tooltip.new(:title => 'foo', :markup => 'html', :locale => 'en',
+                                 :content => "<p>English text</p>")
+    tooltip0.save!
+    
+    tooltip1 = Tooltip.new(:title => 'foo', :markup => 'html', :locale => 'de',
+                                 :content => "<p>German text</p>")
+
+    tooltip1.save!
+  
+  
+    tooltip_out = Tooltip.from_title_and_locale('foo', 'de')
+
+    assert_equal tooltip_out.content_to_html, "<p>German text</p>"
+    assert_equal tooltip_out.title, "foo"
+    assert_equal tooltip_out.locale, "de"
+  end
+
+end

data/lib/simple_tooltip.rb

@@ -0,0 +1,3 @@
+module SimpleTooltip
+  # Your code goes here...
+end

data/lib/simple_tooltip/version.rb

@@ -0,0 +1,3 @@
+module SimpleTooltip
+  VERSION = "0.0.1"
+end

data/simple_tooltip.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "simple_tooltip/version"
+
+Gem::Specification.new do |s|
+  s.name        = "simple-tooltip"
+  s.version     = SimpleTooltip::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Robert Jones"]
+  s.email       = ["jones@craic.com"]
+  s.homepage    = "http://rubygems.org/gems/simple-tooltip"
+  s.summary     = %q{Create and display Tooltip Help in view pages in Rails applications}
+  s.description = %q{Create and display Tooltip Help in view pages in Rails applications.
+    Uses jQuery to display tooltips, with fallback if Javascript is not available.
+    Makes use of help text in the user's locale if available.'}
+
+
+  s.add_dependency "rails", "~> 3.0"
+  s.add_dependency "jquery-rails"
+  s.add_dependency "rdiscount"
+  s.add_dependency "RedCloth"
+  s.add_dependency "thor",  "~>0.14.4"
+  s.add_development_dependency "bundler", "~> 1.0.0"
+
+  s.rubyforge_project = "simple-tooltip"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification 
+name: simple-tooltip
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Robert Jones
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-04 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jquery-rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: RedCloth
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 14
+        - 4
+        version: 0.14.4
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id006
+description: |-
+  Create and display Tooltip Help in view pages in Rails applications.
+      Uses jQuery to display tooltips, with fallback if Javascript is not available.
+      Makes use of help text in the user's locale if available.'
+email: 
+- jones@craic.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.markdown
+- Rakefile
+- TODO
+- lib/generators/simple_tooltip/install_generator.rb
+- lib/generators/simple_tooltip/templates/app/controllers/tooltips_controller.rb
+- lib/generators/simple_tooltip/templates/app/helpers/tooltip_helper.rb
+- lib/generators/simple_tooltip/templates/app/models/tooltip.rb
+- lib/generators/simple_tooltip/templates/app/views/tooltips/_form.html.erb
+- lib/generators/simple_tooltip/templates/app/views/tooltips/edit.html.erb
+- lib/generators/simple_tooltip/templates/app/views/tooltips/index.html.erb
+- lib/generators/simple_tooltip/templates/app/views/tooltips/new.html.erb
+- lib/generators/simple_tooltip/templates/app/views/tooltips/show.html.erb
+- lib/generators/simple_tooltip/templates/app/views/tooltips/tooltip_content.html.erb
+- lib/generators/simple_tooltip/templates/db/migrate/create_tooltips.rb
+- lib/generators/simple_tooltip/templates/public/images/simple_tooltip_close_icon.png
+- lib/generators/simple_tooltip/templates/public/images/simple_tooltip_help_icon.png
+- lib/generators/simple_tooltip/templates/public/javascripts/simple_tooltip.js
+- lib/generators/simple_tooltip/templates/public/stylesheets/simple_tooltip.css
+- lib/generators/simple_tooltip/templates/test/fixtures/tooltips.yml
+- lib/generators/simple_tooltip/templates/test/functional/tooltips_controller_test.rb
+- lib/generators/simple_tooltip/templates/test/unit/helpers/tooltips_helper_test.rb
+- lib/generators/simple_tooltip/templates/test/unit/tooltip_test.rb
+- lib/simple_tooltip.rb
+- lib/simple_tooltip/version.rb
+- simple_tooltip.gemspec
+has_rdoc: true
+homepage: http://rubygems.org/gems/simple-tooltip
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: simple-tooltip
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Create and display Tooltip Help in view pages in Rails applications
+test_files: []
+