icon_links 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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,10 @@
+IconLinks
+=========
+Easily link icons of your choosing with handy helpers.  Works great with Silk icons.
+
+
+Example
+=======
+Example goes here.
+
+Copyright (c) 2008-2010 [Nate Wiger](http://nateware.com), released under the MIT license.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the icon_links plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the icon_links plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'IconLinks'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/icon_links/method_missing.rb

@@ -0,0 +1,182 @@
+module IconLinks
+  module MethodMissing
+    include ViewHelpers
+
+    # Handle missing methods so we can do fancy URL hooks.
+    # This is what gives us "edit_player_icon" and "new_game_icon"
+    def method_missing_with_icon_links(method_id, *args)
+      method = method_id.to_s
+
+      # special catch for "run_icon", where it really means "run_run_icon"
+      method = "#{$1}_#{$1}_icon" if method =~ /^([a-z]+)_icon$/
+      if method =~ /^([a-z]+)_(.+)_icon$/
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        if options.has_key?(:if)
+          return icon_tag(:clear) unless options.delete(:if)
+        end
+        type = $1
+        meth = $2
+        icon = options.delete(:icon) || type
+        unless label = options.delete(:label)
+          label = meth.dup
+          IconLinks.remove_prefixes_for_labels.each {|prefix| break if label.sub!(/^#{prefix}_/, '')}
+          label = label.titleize
+        end
+
+        # Note: We pass *either* args OR options to a given xxx_path() method,
+        # depending on whether it's a collection or member method.
+        url  = ''
+        case type
+
+        when 'new'
+          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)
+
+        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)
+
+        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)
+
+        when 'delete'
+          url = send("#{meth}_path", args)
+          options[:method] ||= :delete
+          options[:title] ||= "Delete this #{label}"
+          return link_icon(icon, url, options)
+
+        when 'ajaxdelete'
+          # Delete a record with an id, ala user_path(user)
+          # Fancy AJAX, so that it deletes the row in-place
+          options[:url]      ||= send("#{meth}_path", args)
+          options[:method]   ||= 'delete'
+          show = options.delete(:show) || args.first
+          target = show.is_a?(ActiveRecord::Base) ? "#{show.class.name.to_s.underscore}_#{show.to_param}" : "#{show.to_param}"
+          #options[:update]   ||= target
+          options[:success] ||= "$('#{options[:update]}').hide;alert('success');"
+
+          # I hate that sometimes in Rails, you need a fucking :html subelement
+          htmlopt = {:title => "Delete this #{label}"}
+
+          # If no condition, set a toggle so that we tell if we have clicked
+          # on the button, and can collapse it appropriately.
+          unless options[:condition]
+            options[:id] = "#{options[:update]}_icon"
+          end
+          return link_to_remote(icon_tag(type, :id => options[:id]), options, htmlopt)
+
+        when 'list'
+          # Main index, this does NOT have an id, ie users_path
+          # Fancy AJAX, so that it expands/collapses a sub-row
+          options_without_update = options.dup
+          options_without_update.delete(:update)
+          url = send("#{meth.pluralize}_path", options_without_update)
+          show = options.delete(:show) || options.values.first
+          target = show.is_a?(ActiveRecord::Base) ? "show_#{show.class.name.to_s.underscore}_#{show.to_param}" : "show_#{show.to_param}"
+          options[:update]   ||= target
+          options[:url]      ||= url
+          options[:method]   ||= 'get'
+          options[:complete] ||= "$('#{options[:update]}').show();"
+
+          # I hate that sometimes in Rails, you need a fucking :html subelement
+          htmlopt = {:title => "List #{label.pluralize}"}
+
+          # If no condition, set a toggle so that we tell if we have clicked
+          # on the button, and can collapse it appropriately.
+          extra_js = ''
+          unless options[:condition]
+            options[:id] = "#{options[:update]}_icon"
+            var = "loaded_#{options[:update]}"
+            options[:before] =
+                "#{var} = !#{var};" +
+                " if (#{var}) { $('#{options[:update]}').hide();"+
+                " $('#{options[:id]}').src = '#{icon_url(:show)}'; return false }"+
+                " else { $('#{options[:id]}').src = '#{icon_url(:loading)}' }"
+            options[:complete]  += "$('#{options[:id]}').src = '#{icon_url(:hide)}';"
+            # Don't use javascript_tag or, ironically, Prototype chokes
+            extra_js = '<script type="text/javascript">' +
+                       "#{var} = true;" + '</script>'
+          end
+          return extra_js + link_to_remote(icon_tag(:show, :id => options[:id]), options, htmlopt)
+
+        when 'show'
+          # Show a record with an id, ala user_path(user)
+          # Fancy AJAX, so that it expands/collapses a sub-row
+          options[:url]      ||= send("#{meth}_path", args)
+          options[:method]   ||= 'get'
+          show = options.delete(:show) || args.first
+          target = show.is_a?(ActiveRecord::Base) ? "show_#{show.class.name.to_s.underscore}_#{show.to_param}" : "show_#{show.to_param}"
+          options[:update]   ||= target
+          options[:complete] ||= "$('#{options[:update]}').show();"
+
+          # I hate that sometimes in Rails, you need a fucking :html subelement
+          htmlopt = {:title => "Show more about this #{label}"}
+
+          # If no condition, set a toggle so that we tell if we have clicked
+          # on the button, and can collapse it appropriately.
+          extra_js = ''
+          unless options[:condition]
+            options[:id] = "#{options[:update]}_icon"
+            var = "loaded_#{options[:update]}"
+            options[:before] =
+                "#{var} = !#{var};" +
+                " if (#{var}) { $('#{options[:update]}').hide();"+
+                " $('#{options[:id]}').src = '#{icon_url(:show)}'; return false }"+
+                " else { $('#{options[:id]}').src = '#{icon_url(:loading)}' }"
+            options[:complete]  += "$('#{options[:id]}').src = '#{icon_url(:hide)}';"
+            # Don't use javascript_tag or, ironically, Prototype chokes
+            extra_js = '<script type="text/javascript">' +
+                       "#{var} = true;" + '</script>'
+          end
+          return extra_js + link_to_remote(icon_tag(type, :id => options[:id]), options, htmlopt)
+
+        when 'view'
+          # Like "show", but we changed it to "view" to indicate new page
+          # main index, this does NOT have an id
+          url = send("#{meth}_path", args)
+          options[:title] ||= "View this #{label}"
+          return link_icon(icon, url, options)
+        else
+          # This generic handler handles all other actions
+          options[:title] ||= "#{type.titleize} this #{label}"
+          if options[:url]
+            url = options.delete(:url)
+            url[:controller] ||= meth.pluralize if url.is_a? Hash
+            url[:id] ||= args[:id] if url.is_a? Hash and args.is_a? Hash
+          elsif type == meth
+            # call "run_path" for "run_run_icon"
+            url = send("#{meth}_path", args)
+          else
+            # call "review_revision_path" for "review_revision_icon"
+            url = send("#{type}_#{meth}_path", args)
+          end
+          if options[:remote]
+            htmlopt = {}
+            htmlopt[:title] = options.delete(:title) if options.has_key?(:title)
+            htmlopt[:id] = options.delete(:id) if options.has_key?(:id)
+            options[:url] = url
+            return link_to_remote(icon_tag(icon), options, htmlopt)
+          else
+            return link_icon(icon, url, options)
+          end
+        end
+      end
+      method_missing_without_icon_links(method_id, args)
+    end
+  end
+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

data/lib/icon_links/view_helpers.rb

@@ -0,0 +1,154 @@
+# methods for making links and help stuff
+module IconLinks
+  module ViewHelpers
+    @@icon_url_cache = {}
+
+    # 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)
+      if args.first.is_a?(Hash)
+        return icon_tag(:clear) unless args[0].delete(:if)
+      end
+      link_to(icon_for(text), *args)
+    end
+
+    # 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)
+      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
+    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.
+    def icon_for(text, excess=nil)
+      link = nil
+      if text.is_a? Array
+        # array
+        icon = icon_tag(text.first)
+        link = cat(icon, text.last)
+      else
+        link = icon_tag(text)
+      end
+      link += excess if excess
+      link
+    end
+
+    # Can't normalize this with above because calls to this want to exclude help
+    def icon_url(type)
+      name = type.to_s
+      return @@icon_url_cache[name] if @@icon_url_cache[name]
+      # Can't normalize this with above because calls to this want to exclude help
+      @@icon_url_cache[name] ||= IconLinks.custom_icon_images[name] ||
+               File.join(IconLinks.icon_image_url, name + IconLinks.icon_image_suffix)
+    end
+
+    # This retrieves the assigned icon from the System object,
+    # then returns suitably-formatted HTML. It does some simple
+    # caching for each icon URL as well.
+    def icon_tag(type, options={})
+      name = type.to_s
+      png_image_tag icon_url(type), {
+        :class => 'icon', :border => 0, :alt => name.humanize,
+        :width => 16, :height => 16
+      }.update(options)
+    end
+
+    # This returns a help link similar to +link_icon+, 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).
+    def help_for(help_topic, icon=:help)
+      help = help_text(help_topic)
+      help == '' ? '' : help_icon(help, icon)
+    end
+
+    # Return help text, suitable for use as a help tooltip box thingy
+    # Note: Comma escaping is a workaround for a workaround, in the
+    # hacks to dhtmlXGrid to support "img:[/path Plain Text],b" <-- comma
+    def help_text(help_topic)
+      help = SystemHelp.topic(help_topic)
+      help ? help.help_text.to_s.gsub('&','&amp;').
+              gsub('"','&quot;').gsub('<','&lt;').
+              gsub('>','&gt;').gsub(',','&#044;') : ''
+    end
+
+    # Creates the icon to pop up the help bubble
+    def help_icon(help_text, icon=:help)
+      return '' unless help_text
+      return %Q(<a href="#" title="#{help_text}" onclick="return false">#{icon_tag(icon, :class => 'help')}</a>)
+    end
+
+    # This is similar to help_for(), but it instead looks up the description
+    # for a field on a per-table basis. For example, desc_of :life_cycle, 'QA'
+    # would look up life_cycles where life_cycle = 'QA' and return life_cycle.description
+    def desc_of(class_symbol, field_val)
+      class_name = class_symbol.to_s.camelize
+      row = nil
+      eval "row = #{class_name}.find(:first, :conditions => ['name = ?', field_val])"
+      return '' unless row
+      help_icon row.description
+    end
+
+    # This is a hack needed for IE, adapted from http://koivi.com/ie-png-transparency/
+    def png_image_tag(image, options={})
+      image = icon_url image if image.is_a?(Symbol)
+      begin
+        # When called from table_form_builder, request does not exist and raises exception
+        if image =~ /\.png$/i && request.user_agent.downcase =~ /msie\s+(5\.[5-9]|[6]\.[0-9]*).*(win)/
+          options[:style] ||= ''
+          options[:style] += "filter: progid:DXImageTransform.Microsoft.AlphaImageLoader" +
+                             "(src=&quot;#{image}&quot;,sizingMethod=&quot;scale&quot;);"
+          image = System.clear_png_url    # reset image to clear png
+        end
+      rescue
+        # In FormBuilder, so write it to the builder
+        @template.image_tag image, options
+      else
+        # Return a string
+        image_tag image, options
+      end
+    end
+
+    # Creates an expandable toggleable div
+    def expandable_tag(type, options)
+      toggle_tag(type, options, :expand, :collapse)
+    end
+
+    # Creates a collapsible div
+    def collapsible_tag(type, options)
+      toggle_tag(type, options, :collapse, :expand)
+    end
+
+    # "Raw" function that can be used to create an expand/collapse tag
+    def toggle_tag(type, options, first_icon, alt_icon)
+
+      target = options[:id]
+      if !target
+        if options.has_key?(:show)
+          show = options[:show]
+          target = show.is_a?(ActiveRecord::Base) ? "show_#{show.class.name.to_s.underscore}_#{show.to_param}" \
+                                                  : "show_#{show.to_param}"
+        else
+          target = 'toggle'
+        end
+      end
+
+      options[:style] = 'display:none;' + (options[:style]||'')
+      var = "toggle_#{target}"
+      img = "icon_for_#{var}"
+      %(<script type="text/javascript">#{var} = true;</script>) +
+      %(<a href="#" onclick="#{var} = !#{var}; $('#{target}').toggle();) +
+      %( if (#{var}) { $('#{img}').src = '#{icon_url(first_icon)}'; })+
+      %( else { $('#{img}').src = '#{icon_url(alt_icon)}'; }) +
+      %(">#{icon_tag(first_icon, :id => img)}#{options[:label]||''}</a>)
+    end
+  end
+end

data/lib/icon_links.rb

@@ -0,0 +1,31 @@
+# IconLinks
+require 'active_support/core_ext/module/attribute_accessors'
+module IconLinks
+  # Relative path to the icons
+  mattr_accessor :icon_image_url
+  @@icon_image_url = '/images/icons'
+
+  # Full suffix including the "."
+  mattr_accessor :icon_image_suffix
+  @@icon_image_suffix = '.png'
+
+  # Special icons
+  mattr_accessor :custom_icon_images
+  @@custom_icon_images = {
+    'loading' => "#{@@icon_image_url}/loading.gif"
+  }
+
+  # Prefixes to automagically remove within auto-generated labels e.g. 'admin_'
+  mattr_accessor :remove_prefixes_for_labels
+  @@remove_prefixes_for_labels = []
+
+  def self.included(base)
+    base.class_eval do
+      include ::IconLinks::ViewHelpers
+      include ::IconLinks::MethodMissing
+      alias_method_chain :method_missing, :icon_links
+    end
+  end
+end
+
+ActionView::Base.send :include, IconLinks if defined?(ActionView::Base)

data/tasks/icon_links_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :icon_links do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: icon_links
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Nate Wiger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-05 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :runtime
+  version_requirements: *id001
+description: Easily replace text links with icons in Rails views with handy link_icon helpers.
+email: nate@wiger.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MIT-LICENSE
+- Rakefile
+- README.md
+files: 
+- lib/icon_links/method_missing.rb
+- lib/icon_links/view_helpers.rb
+- lib/icon_links.rb
+- tasks/icon_links_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+has_rdoc: true
+homepage: http://github.com/nateware/icon_links
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- Icon Links -- Easily link with icons in Rails views
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: 
+- activesupport v2.3.x
+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.
+test_files: []
+