remotipart 0.2.1 → 0.3.1

data/.gitignore

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

data/History.rdoc

@@ -1,5 +1,11 @@
 = History
 
+=== 0.3.0 / 2011-02-24
+
+* New Features
+  * Added support for all data-type ajax submissions, not just 'script'. 
+  * Made a little more flexible, so that separate js.erb response templates are no longer needed between remotipart (i.e. multipart) ajax form submissions and regular ajax form submissions, so multiple versions of the same form can now submit to the same action. 
+
 === 0.2.1 / 2011-01-16
 
 * Minor Enhancements
@@ -18,4 +24,4 @@
 
 === 0.1.0 / 2010-04-09
 
-* Initial Release
+* Initial Release

data/README.rdoc

@@ -7,18 +7,22 @@ This gem augments the native Rails jQuery remote form function enabling asynchro
 
 * {Rails 3}[http://github.com/rails/rails]
 * {jQuery}[http://jquery.com]
-* {The Rails jQuery driver}[http://github.com/rails/jquery-ujs]
+* {The jquery-rails gem}[http://rubygems.org/gems/jquery-rails], which really just installs {the Rails jQuery driver (jquery-ujs)}[https://github.com/rails/jquery-ujs]
+
+  <b>PLEASE NOTE - DUE TO RECENT REFACTORING IN THE MASTER BRANCH OF JQUERY-UJS, SEE PREREQUISITE BELOW. A FIX IS ON THE WAY.</b>
 * {The jQuery Form plugin}[http://jquery.malsup.com/form/]
 
 == Installation
 
+<b>Prerequisite: Make sure you have a supported jquery-ujs (rails.js) version. To be certain, replace public/javascripts/rails.js with {this version}[https://github.com/rails/jquery-ujs/raw/51272c68714748420d8c35984b3e2532ab14f748/src/rails.js] of rails.js.</b>
+
 1. Install the Remotipart gem
 
 	gem install remotipart
 
 2. Run the Remotipart generator to add jquery.remotipart.js to public/javascripts/
 
-	rails g remotipart
+	  rails g remotipart
 
 3. Add the Javascript files for jQuery, the Rails jQuery driver, jQuery Form plugin, and Remotipart to your template, making sure to include jquery.remotipart.js *after* jQuery and the Rails jQuery driver
 
@@ -32,11 +36,25 @@ This gem augments the native Rails jQuery remote form function enabling asynchro
 	:format == 'js'
 * In the JS response template for your controller action, wrap all of your response code in one remotipart_response block:
 	<%= remotipart_response do %> All Javascript response code goes here <% end %>
-
-== Advanced Usage
-
 * The options available to the text_area_tag[http://api.rubyonrails.org/classes/ActionView/Helpers/FormTagHelper.html#method-i-text_area_tag] can be passed to remotipart_response for further control over the response. For instance:
 	<%= remotipart_response({:escape => false}) do %> All Javascript response code goes here <% end %>
+* UPDATE: As of v0.3.0, anything inside the +remotipart_response+ block will be rendered normally, unless the request actually did come from a remotipart-submitted form. So <tt>js.erb</tt> responses can be shared between remotipart and non-remotipart forms.
+    <%= remotipart_response do %>
+      if params[:remotipart_submitted]
+        // do one thing
+      else
+        // do another
+      end
+    <% end %>
+* If you need to determine if a particular request was made via a remotipart-enabled form...
+  * from your Rails controller or view:
+
+      if params[:remotipart_submitted]
+  * from your javascript:
+
+      $(form).bind("ajax:success", function(){
+        if ( $(this).data('remotipartSubmitted') )
+      });
 
 === Example
 

data/Rakefile

@@ -10,9 +10,9 @@ begin
     This gem augments the native Rails jQuery remote form function enabling asynchronous file uploads with little to no modification to your application.
     It requires jQuery (http://jquery.com), the Rails jQuery driver (http://github.com/rails/jquery-ujs), and the jQuery Form plugin (http://jquery.malsup.com/form/).
     }
-    gem.email = "greg@formasfunction.com"
+    gem.email = %w{greg@formasfunction.com steve@alfajango.com}
     gem.homepage = "http://github.com/formasfunction/remotipart"
-    gem.authors = ["Greg Leppert"]
+    gem.authors = ["Greg Leppert", "Steve Schwartz"]
     gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.1

data/lib/generators/templates/jquery.remotipart.js

@@ -1,24 +1,37 @@
-jQuery(function ($) {
+(function ($) {
     $.fn.extend({
 		/**
 	     * Handles execution of remote calls involving file uploads, firing overridable events along the way
 	     */
 	    callRemotipart: function () {
 	        var el      = this,
-	            url     = el.attr('action');
+	            url     = el.attr('action'),
+              dataType = el.attr('data-type') || 'script';
 
 	        if (url === undefined) {
 	          throw "No URL specified for remote call (action must be present).";
 	        } else {
-	            if (el.triggerAndReturn('ajax:before')) {
+              // Since iframe-submitted form is submitted normal-style and cannot set custom headers,
+              // we'll add a custom hidden input to keep track and let the server know this was still
+              // an AJAX form, we'll also make it easy to tell from our jQuery element object.
+              el
+                .append($('<input />', {
+                  type: "hidden",
+                  name: "remotipart_submitted",
+                  value: true
+                }))
+                .data('remotipartSubmitted', dataType);
 
+	            if (el.triggerAndReturn('ajax:before')) {
+              if (dataType == 'script') {
 		          	url = url.split('?'); // split on GET params
-					if(url[0].substr(-3) != '.js') url[0] += '.js'; // force rails to respond to respond to the request with :format = js
-					url = url.join('?'); // join on GET params
+					      if(url[0].substr(-3) != '.js') url[0] += '.js'; // force rails to respond to respond to the request with :format = js
+					      url = url.join('?'); // join on GET params
+              }
 					
 	                el.ajaxSubmit({
 	                    url: url,
-	                    dataType: 'script',
+	                    dataType: dataType,
 	                    beforeSend: function (xhr) {
 	                        el.trigger('ajax:loading', xhr);
 	                    },
@@ -46,5 +59,4 @@ jQuery(function ($) {
 			}
 		}
 	});
-
-});
+})(jQuery);

data/lib/remotipart.rb

@@ -1,11 +1,15 @@
 module Remotipart
   def remotipart_response(options = {}, &block)
-    response.content_type = Mime::HTML
     content = with_output_buffer(&block)
-    text_area_tag('remotipart_response', String.new(content), options)
+    if params[:remotipart_submitted]
+      response.content_type = Mime::HTML
+      text_area_tag('remotipart_response', String.new(content), options)
+    else
+      content
+    end
   end
 end
 
 class ActionView::Base
   include Remotipart
-end
+end

data/remotipart.gemspec

@@ -1,45 +1,47 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{remotipart}
-  s.version = "0.2.1"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Greg Leppert"]
-  s.date = %q{2011-01-16}
+  s.authors = ["Greg Leppert", "Steve Schwartz"]
+  s.date = %q{2011-03-15}
   s.description = %q{Remotipart is a Ruby on Rails gem enabling remote multipart forms (AJAX style file uploads) with jQuery.
     This gem augments the native Rails jQuery remote form function enabling asynchronous file uploads with little to no modification to your application.
     It requires jQuery (http://jquery.com), the Rails jQuery driver (http://github.com/rails/jquery-ujs), and the jQuery Form plugin (http://jquery.malsup.com/form/).
     }
-  s.email = %q{greg@formasfunction.com}
+  s.email = ["greg@formasfunction.com", "steve@alfajango.com"]
   s.extra_rdoc_files = [
     "LICENSE",
-    "README.rdoc"
+     "README.rdoc"
   ]
   s.files = [
     ".document",
-    "History.rdoc",
-    "LICENSE",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "lib/generators/remotipart_generator.rb",
-    "lib/generators/templates/jquery.remotipart.js",
-    "lib/remotipart.rb",
-    "remotipart.gemspec",
-    "test/helper.rb",
-    "test/test_remotipart.rb"
+     ".gitignore",
+     "History.rdoc",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/generators/remotipart_generator.rb",
+     "lib/generators/templates/jquery.remotipart.js",
+     "lib/remotipart.rb",
+     "remotipart.gemspec",
+     "test/helper.rb",
+     "test/test_remotipart.rb"
   ]
   s.homepage = %q{http://github.com/formasfunction/remotipart}
+  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Remotipart is a Ruby on Rails gem enabling remote multipart forms (AJAX style file uploads) with jQuery.}
   s.test_files = [
     "test/helper.rb",
-    "test/test_remotipart.rb"
+     "test/test_remotipart.rb"
   ]
 
   if s.respond_to? :specification_version then

metadata

@@ -1,20 +1,22 @@
 --- !ruby/object:Gem::Specification 
 name: remotipart
 version: !ruby/object:Gem::Version 
+  hash: 17
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 1
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Greg Leppert
+- Steve Schwartz
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-01-16 00:00:00 -06:00
+date: 2011-03-15 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,13 +27,16 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
   type: :development
   version_requirements: *id001
 description: "Remotipart is a Ruby on Rails gem enabling remote multipart forms (AJAX style file uploads) with jQuery.\n    This gem augments the native Rails jQuery remote form function enabling asynchronous file uploads with little to no modification to your application.\n    It requires jQuery (http://jquery.com), the Rails jQuery driver (http://github.com/rails/jquery-ujs), and the jQuery Form plugin (http://jquery.malsup.com/form/).\n    "
-email: greg@formasfunction.com
+email: 
+- greg@formasfunction.com
+- steve@alfajango.com
 executables: []
 
 extensions: []
@@ -41,6 +46,7 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
+- .gitignore
 - History.rdoc
 - LICENSE
 - README.rdoc
@@ -57,8 +63,8 @@ homepage: http://github.com/formasfunction/remotipart
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -66,6 +72,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -74,6 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"