image_button_to 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 José Pablo Fernández Silva
+
+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.rdoc

@@ -0,0 +1,111 @@
+= Image Button To
+
+Ruby on Rails provides the following helpers:
+
+* +button_to+
+
+* +button_to_function+
+
+* +button_to_remote+
+
+which wrap a form around a +submit_tag+ to easily create buttons pointing to 
+some action.
+
+What Ruby on Rails doesn't provide is a counterpart for +image_submit_tag+. This
+gem provides that. It basically contains three helpers:
+
+* +image_button_to+
+
+* +image_button_to_remote+
+
+* +image_button_to_function+
+
+== Installation
+
+This gem is provided through Gemcutter so you need to have gem configured to
+pull gems from Gemcutter.
+
+=== Enabling Gemcutter
+
+A properly configured environment would be like this:
+
+  $ gem sources
+  *** CURRENT SOURCES ***
+  
+  http://gemcutter.org
+  http://gems.rubyforge.org/
+  http://gems.github.com
+
+If you don't have http://gemcutter.org in your sources then you need to add. I
+know two ways to do. One is installing Gemcutter and running gem tumble:
+
+  $ sudo gem install gemcutter
+  $ gem tumble
+
+Be careful that gem tumble will remove Gemcutter from your repositories if it's
+already there.
+
+The other way is by hand like this:
+
+  $ gem source -a http://gemcutter.org
+
+I'm not sure if there's any difference. I think there isn't one.
+
+=== Installing image_button_to by hand
+
+It's simple a matter of running:
+
+  $ gem install image_button_to
+
+and that's it. Let me know if something breaks.
+
+=== Installing through your Ruby on Rails project
+
+In the +environment.rb+ file of your Ruby on Rails project you'll have some
+commented out lines like this:
+
+  # config.gem "bj"
+  # config.gem "hpricot", :version => '0.6', :source => "http://code.whytheluckystiff.net"
+  # config.gem "sqlite3-ruby", :lib => "sqlite3"
+  # config.gem "aws-s3", :lib => "aws/s3"
+
+After those you can just add
+
+  config.gem "image_button_to"
+
+and then run
+
+  $ rake gems:install
+
+and you'll get this and all the gems your Rails project need installed.
+Configuring your Rails project like that is something you'll need anyway, so
+this is my recommended way.
+
+== Using the helpers
+
+Be sure to have you Rails project properly configured to load this gem like it's
+explained in the previous section, in "Installing through your Ruby on Rails
+project". After that, using each of the methods is equivalent to using the
+non-image provided by Ruby on Rails, but passing the path to the image instead
+of the text.
+
+The path to the image is treated in the same way image_submit_tags treat it
+(appending "images/" and whatnot). Some examples from
+http://isitsciencefiction.com (where this code was born):
+
+  <%= image_button_to "yes-up.png", vote_up_item_url(:id => @item.id) %>
+  <%= image_button_to "no-up.png", vote_down_item_url(:id => @item.id) %>
+  <%= image_button_to_remote "yes-up-small.png", :update => item.slug, :url => vote_up_item_url(:id => item.id) %>
+  <%= image_button_to_remote "no-up-small.png", :update => item.slug, :url => vote_down_item_url(:id => item.id) %>
+
+Check the documentation for image_button_tag and button_to, this is just a 
+merge.
+
+== Documentation
+
+Up to date documentation should be automatically generated on
+http://rdoc.info/projects/pupeno/image_button_to
+
+== Copyright
+
+Copyright (c) 2009 José Pablo Fernández Silva. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+# Copyright (c) 2009 José Pablo Fernández Silva. See LICENSE for details.
+
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "image_button_to"
+    gem.summary = "Image equivalent to Rails button_to"
+    gem.description = "Ruby on Rails provides a series of methods called button_to and image_submit_tag, but no image_button_to. This gem provides that."
+    gem.email = "pupeno@pupeno.com"
+    gem.homepage = "http://github.com/pupeno/image_button_to"
+    gem.authors = ["J. Pablo Fernández"]
+    #gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_dependency "actionpack", ">= 2.0.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Image Button To #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('LICENSE')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.options << '--charset' << 'utf-8' 
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/image_button_to.rb

@@ -0,0 +1,122 @@
+# Copyright (c) 2009 José Pablo Fernández Silva. See LICENSE for details.
+
+module ImageButtonTo
+
+  # Generates a form containing a single image button that submits to the URL
+  # created by the set of +options+. This is the safest method to ensure links
+  # that cause changes to your data are not triggered by search bots or
+  # accelerators.
+  #
+  # The generated form element has a class name of <tt>image-button-to</tt> to
+  # allow styling of the form itself and its children. You can control the
+  # form submission and input element behavior using +html_options+. This
+  # method accepts the <tt>:method</tt> and <tt>:confirm</tt> modifiers
+  # described in the +link_to+ documentation. If no <tt>:method</tt> modifier
+  # is given, it will default to performing a POST operation. You can also
+  # disable the button by passing <tt>:disabled => true</tt> in
+  # +html_options+. If you are using RESTful routes, you can pass the
+  # <tt>:method</tt> to change the HTTP verb used to submit the form.
+  #
+  # ==== Options
+  # The +options+ hash accepts the same options as url_for.
+  #
+  # There are a few special +html_options+:
+  # * <tt>:method</tt> - Specifies the anchor name to be appended to the path.
+  # * <tt>:disabled</tt> - Specifies the anchor name to be appended to the
+  #   path.
+  # * <tt>:confirm</tt> - This will add a JavaScript confirm prompt with the
+  #   question specified. If the user accepts, the link is processed normally,
+  #   otherwise no action is taken.
+  #
+  # ==== Examples
+  #   <%= button_to "new.png", :action => "new" %>
+  #   # => "<form method="post" action="/controller/new" class="image-button-to">
+  #   #      <div><input src="/images/new.png?1257839010" type="image" /></div>
+  #   #    </form>"
+  #
+  #   button_to "delete.png", { :action => "delete", :id => @image.id },
+  #             :confirm => "Are you sure?", :method => :delete
+  #   # => "<form method="post" action="/images/delete/1" class="image-button-to">
+  #   #      <div>
+  #   #        <input type="hidden" name="_method" value="delete" />
+  #   #        <input onclick="return confirm('Are you sure?');"
+  #   #              src="/images/new.png?1257839010" type="image" />
+  #   #      </div>
+  #   #    </form>"
+  def image_button_to(source, options = {}, html_options = {})
+    html_options = html_options.stringify_keys
+    convert_boolean_attributes!(html_options, %w( disabled ))
+    
+    method_tag = ''
+    if (method = html_options.delete('method')) && %w{put delete}.include?(method.to_s)
+      method_tag = tag('input', :type => 'hidden', :name => '_method', :value => method.to_s)
+    end
+    
+    form_method = method.to_s == 'get' ? 'get' : 'post'
+    
+    request_token_tag = ''
+    if form_method == 'post' && protect_against_forgery?
+      request_token_tag = tag(:input, :type => "hidden", :name => request_forgery_protection_token.to_s, :value => form_authenticity_token)
+    end
+    
+    if confirm = html_options.delete("confirm")
+      html_options["onclick"] = "return #{confirm_javascript_function(confirm)};"
+    end
+    
+    url = options.is_a?(String) ? options : self.url_for(options)
+    
+    "<form method=\"#{form_method}\" action=\"#{escape_once url}\" class=\"image-button-to\"><div>" +
+    method_tag + image_submit_tag(source, html_options) + request_token_tag + "</div></form>"
+  end
+  
+  # Creates an image button with an onclick event which calls a remote action
+  # via XMLHttpRequest
+  #
+  # The options for specifying the target with :url and defining
+  # callbacks is the same as link_to_remote except that +source+ is the path
+  # for an image.
+  def image_button_to_remote(source, options = {}, html_options = {})
+    image_button_to_function(source, remote_function(options), html_options)
+  end
+  
+  # Returns an image button with the given +name+ text that'll trigger a
+  # JavaScript +function+ using the onclick handler.
+  #
+  # The first argument +source+ is the filename of the button as treated by
+  # +image_submit_tag+, that is, passed to AssetTagHelper#image_path.
+  #
+  # The next arguments are optional and may include the javascript function
+  # definition and a hash of html_options.
+  #
+  # The +function+ argument can be omitted in favor of an +update_page+ block,
+  # which evaluates to a string when the template is rendered (instead of
+  # making an Ajax request first).
+  #
+  # The +html_options+ will accept a hash of html attributes for the link tag.
+  # Some examples are :class => "nav_button", :id => "articles_nav_button"
+  #
+  # Note: if you choose to specify the javascript function in a block, but
+  # would like to pass html_options, set the +function+ parameter to nil
+  #
+  # Examples:
+  #   button_to_function "greeting.png", "alert('Hello world!')"
+  #   button_to_function "delete.png", "if (confirm('Really?')) do_delete()"
+  #   button_to_function "details.png" do |page|
+  #     page[:details].visual_effect :toggle_slide
+  #   end
+  #   button_to_function "details.png", :class => "details_button" do |page|
+  #     page[:details].visual_effect :toggle_slide
+  #   end
+  def image_button_to_function(source, *args, &block)
+    html_options = args.extract_options!.symbolize_keys
+    
+    function = block_given? ? update_page(&block) : args[0] || ''
+    onclick = "#{"#{html_options[:onclick]}; " if html_options[:onclick]}#{function};"
+    
+    image_submit_tag(source, html_options.merge(:onclick => onclick))
+  end
+end
+
+ActionController::Base.class_eval do
+  helper ImageButtonTo
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'image_button_to'
+
+class Test::Unit::TestCase
+end

data/test/test_image_button_to.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestImageButtonTo < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: image_button_to
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "J. Pablo Fern\xC3\xA1ndez"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-24 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+    version: 
+description: Ruby on Rails provides a series of methods called button_to and image_submit_tag, but no image_button_to. This gem provides that.
+email: pupeno@pupeno.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/image_button_to.rb
+- test/helper.rb
+- test/test_image_button_to.rb
+has_rdoc: true
+homepage: http://github.com/pupeno/image_button_to
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Image equivalent to Rails button_to
+test_files: 
+- test/helper.rb
+- test/test_image_button_to.rb