remotipart 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 Greg Leppert
+
+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,71 @@
+= 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}[http://github.com/rails/rails]
+* {jQuery}[http://jquery.com]
+* {The Rails jQuery driver}[http://github.com/rails/jquery-ujs]
+* {The jQuery Form plugin}[http://jquery.malsup.com/form/]
+
+== Installation
+
+1. Install the Remotipart gem
+  gem install remotipart
+2. Run the Remotipart generator to add jquery.remotipart.js to public/javascripts/
+  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* the jQuery and the Rails jQuery driver
+  <%= javascript_include_tag 'jquery-1.4.2.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 %>
+
+=== 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 (c) 2010 Greg Leppert. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "remotipart"
+    gem.summary = %Q{Remotipart is a Ruby on Rails gem enabling remote multipart forms (AJAX style file uploads) with jQuery.}
+    gem.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/).
+    }
+    gem.email = "greg@formasfunction.com"
+    gem.homepage = "http://github.com/formasfunction/remotipart"
+    gem.authors = ["Greg Leppert"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 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 = "remotipart #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/generators/remotipart_generator.rb

@@ -0,0 +1,14 @@
+require 'rails/generators'
+
+class RemotipartGenerator < Rails::Generators::Base
+  def self.source_root
+    File.join(File.dirname(__FILE__), 'templates')
+  end
+  
+  def install_remotipart
+    copy_file(
+      'jquery.remotipart.js',
+      'public/javascripts/jquery.remotipart.js'
+    )
+  end
+end

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

@@ -0,0 +1,47 @@
+jQuery(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');
+
+	        if (url === undefined) {
+	          throw "No URL specified for remote call (action must be present).";
+	        } else {
+	            if (el.triggerAndReturn('ajax:before')) {
+					if(url.substr(-3) != '.js') url += '.js'; //force rails to respond to respond to the request with :format = js
+	                el.ajaxSubmit({
+	                    url: url,
+	                    dataType: 'script',
+	                    beforeSend: function (xhr) {
+	                        el.trigger('ajax:loading', xhr);
+	                    },
+	                    success: function (data, status, xhr) {
+							console.log(data);
+	                        el.trigger('ajax:success', [data, status, xhr]);
+	                    },
+	                    complete: function (xhr) {
+	                        el.trigger('ajax:complete', xhr);
+	                    },
+	                    error: function (xhr, status, error) {
+	                        el.trigger('ajax:failure', [xhr, status, error]);
+	                    }
+	                });
+	            }
+
+	            el.trigger('ajax:after');
+	        }
+		},
+		_callRemote: $.fn.callRemote, //store the original rails callRemote
+		callRemote: function(){ //override the rails callRemote and check for a file input
+			if(this.find('input:file').length){
+				this.callRemotipart();
+			} else {
+				this._callRemote();
+			}
+		}
+	});
+
+});

data/lib/remotipart.rb

@@ -0,0 +1,11 @@
+module Remotipart
+  def remotipart_response(&block)
+    response.content_type = Mime::HTML
+    content = with_output_buffer(&block)
+    text_area_tag 'remotipart_response', content
+  end
+end
+
+class ActionView::Base
+  include Remotipart
+end

data/remotipart.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# 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.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Greg Leppert"]
+  s.date = %q{2010-04-09}
+  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.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "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.6}
+  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"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+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 'remotipart'
+
+class Test::Unit::TestCase
+end

data/test/test_remotipart.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestRemotipart < 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,86 @@
+--- !ruby/object:Gem::Specification 
+name: remotipart
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Greg Leppert
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-09 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        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
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- 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
+has_rdoc: true
+homepage: http://github.com/formasfunction/remotipart
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Remotipart is a Ruby on Rails gem enabling remote multipart forms (AJAX style file uploads) with jQuery.
+test_files: 
+- test/helper.rb
+- test/test_remotipart.rb