Remotipart¶ ↑

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.

Dependencies¶ ↑

• Rails 3

• jQuery

• The Rails jQuery driver (jquery-ujs) PLEASE NOTE - DUE TO RECENT REFACTORING IN THE MASTER BRANCH OF JQUERY-UJS, YOU MUST USE THE VERSION CURRENTLY DISTRIBUTED WITH THE GEM (0.2.6). A FIX IS ON THE WAY.

• The jQuery Form plugin

Installation¶ ↑

1. Install the Remotipart gem

gem install remotipart

1. Run the Remotipart generator to add jquery.remotipart.js to public/javascripts/

rails g remotipart

1. 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

<%= javascript_include_tag ‘jquery-1.4.4.min’, ‘rails’, ‘jquery.form’, ‘jquery.remotipart’ %>

Usage¶ ↑

• For multipart / forms with file inputs, set your form_for to remote as you would for a normal ajax form:

:remote => true

• When Javascript is enabled in the user’s browser, the form, including the file, will be submitted asynchronously to your controller with:

: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 %>

• The options available to the 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 %>

Example¶ ↑

sample_layout.html.erb

<%= form_for @sample, :html => { :multipart => true }, :remote => true do |f| %>
  <div class="field">
    <%= f.label :file %>
    <%= f.file_field :file %>
  </div>
  <div class="actions">
    <%= f.submit %>
  </div>
<% end %>

sample_controller.rb

def create
  respond_to do |format|
    if @sample.save
      format.js
    end
  end
end

create.js.erb

<%= remotipart_response do %>
  //Display a Javascript alert
  alert('success!');
<% end %>

Note on Patches/Pull Requests¶ ↑

• Fork the project.

• Make your feature addition or bug fix.

• Add tests for it. This is important so I don’t break it in a future version unintentionally.

• Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)

• Send me a pull request. Bonus points for topic branches.

Copyright¶ ↑

Copyright © 2011 Greg Leppert. See LICENSE for details.