icon_links 0.2.0 → 0.2.2

data/README.md

@@ -1,10 +1,53 @@
-IconLinks
-=========
-Easily link icons of your choosing with handy helpers.  Works great with Silk icons.
+Icon Links - Change boring Rails text links to sexy icon_to links
+=================================================================
+Rails comes with `link_to`, `link_to_remote`, and other helpers to easily create text links.  But it's 2010.  I remember being impressed by text links.  It was 1995.
 
+This gem enables you to easily create links using icons of your choosing.  It provides handy Rails view helper methods that encapsulate repetitive tasks, such as resolving image paths.  This gem works great with the venerable [Fam Fam Fam Silk Icons](http://www.famfamfam.com/lab/icons/silk/), but it also works equally well with any other icon set you have as well.
 
 Example
 =======
-Example goes here.
+If you download the [Silk Icons](http://www.famfamfam.com/lab/icons/silk/) and unzip them to `public/images/icons`, you then only need to change the standard Rails `link_to` idioms:
 
-Copyright (c) 2008-2010 [Nate Wiger](http://nateware.com), released under the MIT license.
+    link_to 'Show', post_path(@post)
+    link_to 'Edit', edit_post_path(@post)
+    link_to 'Destroy', post_path(@post), :confirm => 'Are you sure?', :method => :delete
+    link_to 'Back', post_path
+
+To use `icon_to`:
+
+    icon_to :show, post_path(@post)
+    icon_to :edit, edit_post_path(@post)
+    icon_to :delete, post_path(@post), :confirm => 'Are you sure?', :method => :delete
+    icon_to :back, posts_path
+
+And you'll get snazzy, linked silk icons that will make you cry.
+
+You can even go one fancier, and use REST route helpers with an `_icon` suffix:
+
+    post_icon(@post)
+    edit_post_icon(@post)
+    delete_post_icon(@post, :confirm => 'Are you sure?', :method => :delete)
+
+Yeah, this plugin is simple and sweet.  Sugary, like candy.
+
+If you want to relocate your icons or choose a different image type:
+
+    IconLinks.icon_image_url    = '/images/thingies'
+    IconLinks.icon_image_suffix = '.gif'
+
+You can also create completely custom mappings of icons to paths:
+
+    IconLinks.custom_icon_images = {
+      :loading => "/images/misc/loading.gif"
+    }
+
+Now, you can do:
+
+    icon_to :loading, loading_path
+
+And you will get your custom icon.
+
+Author
+======
+Copyright (c) 2008-2010 [Nate Wiger](http://nateware.com).  All Rights Reserved.
+Released under the MIT license.

data/lib/icon_links.rb

@@ -1,6 +1,5 @@
 # IconLinks
 require 'active_support/core_ext/module/attribute_accessors'
-
 module IconLinks
   # Relative path to the icons
   mattr_accessor :icon_image_url
@@ -29,7 +28,4 @@ module IconLinks
   end
 end
 
-require 'icon_links/view_helpers'
-require 'icon_links/method_missing'
-
-ActionView::Base.send :include, IconLinks if defined?(ActionView::Base)
+ActionView::Base.send :include, IconLinks if defined?(ActionView::Base)

data/lib/icon_links/method_missing.rb

@@ -32,25 +32,25 @@ module IconLinks
           url = send("new_#{meth}_path", options)
           #options[:rel] = "gb_page_center[600, 500]"   # greybox
           options[:title] ||= "Create a new #{label}"
-          return link_icon(icon, url, options)
+          return icon_to(icon, url, options)
 
         when 'ajaxnew'
           url = send("new_#{meth}_path", options)
           #options[:rel] = "gb_page_center[600, 500]"   # greybox
           options[:title] ||= "Create a new #{label}"
-          return link_icon(icon, url, options)
+          return icon_to(icon, url, options)
 
         when 'edit'
           url = send("edit_#{meth}_path", args)
           #options[:rel] = "gb_page_center[600, 500]"   # greybox
           options[:title] ||= "Edit this #{label}"
-          return link_icon(icon, url, options)
+          return icon_to(icon, url, options)
 
         when 'delete'
           url = send("#{meth}_path", args)
           options[:method] ||= :delete
           options[:title] ||= "Delete this #{label}"
-          return link_icon(icon, url, options)
+          return icon_to(icon, url, options)
 
         when 'ajaxdelete'
           # Delete a record with an id, ala user_path(user)
@@ -142,7 +142,7 @@ module IconLinks
           # main index, this does NOT have an id
           url = send("#{meth}_path", args)
           options[:title] ||= "View this #{label}"
-          return link_icon(icon, url, options)
+          return icon_to(icon, url, options)
         else
           # This generic handler handles all other actions
           options[:title] ||= "#{type.titleize} this #{label}"
@@ -164,7 +164,7 @@ module IconLinks
             options[:url] = url
             return link_to_remote(icon_tag(icon), options, htmlopt)
           else
-            return link_icon(icon, url, options)
+            return icon_to(icon, url, options)
           end
         end
       end
@@ -174,10 +174,9 @@ module IconLinks
 end
 
 # Override Rails CDATA JS wrapper because it kills AJAX requests (doh!)
-#module ActionView::Helpers::JavaScriptHelper
-#  def javascript_tag(content, html_options = {})
-#    content_tag("script", content,
-#                html_options.merge(:type => "text/javascript"))
-#  end
-#end
-
+module ActionView::Helpers::JavaScriptHelper
+  def javascript_tag(content, html_options = {})
+    content_tag("script", content,
+                html_options.merge(:type => "text/javascript"))
+  end
+end

data/lib/icon_links/view_helpers.rb

@@ -5,7 +5,7 @@ module IconLinks
 
     # This creates a link using the specified type of icon. The args
     # accepted are the exact same as the args for +link_to+.
-    def link_icon(text, *args)
+    def icon_to(text, *args)
       if args.first.is_a?(Hash)
         return icon_tag(:clear) unless args[0].delete(:if)
       end
@@ -14,20 +14,20 @@ module IconLinks
 
     # This creates a link using the specified type of icon. The args
     # accepted are the exact same as the args for +link_to_remote+.
-    def link_icon_remote(text, *args)
+    def icon_to_remote(text, *args)
       if args.first.is_a?(Hash)
         return icon_tag(:clear) unless args[0].delete(:if)
       end
       link_to_remote(icon_for(text), *args)
     end
 
-    # This is similar to link_icon, only it is designed to call a JS function
+    # This is similar to icon_to, only it is designed to call a JS function
     def function_icon(text, function)
       link_to(icon_for(text), '#', :onclick => function)
     end
 
     # This expands the text and returns the icon path. It is used internally
-    # by +link_icon+ and +link_icon_remote+ to render the link text.
+    # by +icon_to+ and +icon_to_remote+ to render the link text.
     def icon_for(text, excess=nil)
       link = nil
       if text.is_a? Array
@@ -61,7 +61,7 @@ module IconLinks
       }.update(options)
     end
 
-    # This returns a help link similar to +link_icon+, only using the help
+    # This returns a help link similar to +icon_to+, only using the help
     # from the system_help table. If no help is found, then an empty
     # string is returned (allowing you to randomly call this on any
     # object, without having to check if help exists first).

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Nate Wiger
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-07 00:00:00 -07:00
+date: 2010-05-10 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
         version: "2.3"
   type: :runtime
   version_requirements: *id001
-description: Easily replace text links with icons in Rails views with handy link_icon helpers.
+description: Easily replace boring Rails text links with sexy icons.  Includes handy icon_to helpers.
 email: nate@wiger.org
 executables: []
 
@@ -78,6 +78,6 @@ rubyforge_project: icon_links
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Replace text links with icons in Rails views with handy icon_links helpers.
+summary: Easily replace boring Rails text links with sexy icons.
 test_files: []