acts_as_multipart_form 0.0.12 → 0.0.13

data/CHANGELOG

@@ -1,5 +1,11 @@
 == unreleased changes
 
+== 0.0.13
+
+* Major documentation updates
+* Added attr_accessible to the InProgressForm model for rails 3.2 compatibility
+* Updated failing tests
+
 == 0.0.12
 
 * Fixed an issue where a symbol was used as the value in a where clause, causing rails 3.1 to freak out.

data/README.rdoc

@@ -4,25 +4,45 @@ Create multipart forms in rails without using multiple routes.  A controller mix
 
 = How to use
 
-== Install the gem with
+== Add the gem to your gemfile
 
-    gem install acts_as_multipart_form
+    gem "acts_as_multipart_form"
 
-== Install the migration and config with
+== Install the migration and config
 
     rails generate acts_as_multipart_form:install
+    rake db:migrate
 
-== Add the mixin to your controller
+== Add the mixin and methods to your controller
 
-    acts_as_multipart_form :name => :hire_form, :parts => [:person_info, :job_info], :model => "Person", :form_route => "person_hire_form"
+    PeopleController < ApplicationController
+      acts_as_multipart_form :name => :hire_form, :parts => [:personal, :job]
 
-The parts correspond to methods in the controller and partials in the controller's views folder.  Additional methods called :person_info_update and :job_info_update are also necessary to handle saving the data.  
+    def hire_form
+      @form_subject.multipart_form_controller_action = params[:multipart_form_part]
+    end
 
-Each form has a polymorphic relationship with a single record.  This relationship is specified by the model key's value.  This is how the form is loaded on the index page and the only association it has with the rest of the system.
+    def personal
+    end
 
-Two routes can be specified for the form system. The form route corresponds to the route to the form itself.  It's default value is model_name_form_name.  In the example, the specified value would be the default value.  The show route, specified with the tag :show_route is redirected to after the last part of the multipart form is submitted and passes validations.  It defaults to model_name to correspond with the model's view page.
+    def personal_update
+      return { valid: @form_subject.update_attributes(params[:person])}
+    end
 
-Note that when you add the route to your route file, it must be able to match both get and post requests.
+    def job
+    end
+
+    def job_update
+      return { valid: @form_subject.update_attributes(params[:person])}
+    end
+
+This example splits the fields for the Person model across two parts.
+
+Each part needs two methods for the displayed form and data update steps.  The data update steps need to return a hash with the key valid set to true or false.  If part based validations are needed, the controller action must be set.  It can be done in either the main action, hire_form, or only on the actions that need it.
+
+Each form has a polymorphic relationship with a single record.  This relationship is specified by the model key's value.  This is how the form is loaded on the index page and the only association it has with the rest of the system.  The record is stored in the @form_subject variable.
+
+See MultipartFormInController for additional documentation.
 
 == Add the mixin to your model
 
@@ -30,19 +50,41 @@ Note that when you add the route to your route file, it must be able to match bo
 
 This is currently only used for validations.  If this is set, you can use a validation like this to only validate a field if the save is coming from a specific multipart form part.
 
-    validates_presence_of :name, :if => :hire_form_personal_info?
+    validates_presence_of :name, :if => :hire_form_personal_update?
+
+== Add the route
+
+    resources :people do
+      match 'edit', to: 'people#hire_form', :via => [:get, :post]
 
 == Setting up your form
 
-    <%= render "multipart_form/breadcrumb" %>
+These examples use formtastic but it is not required.
+
+app/views/people/hire_form.html.erb:
+
+    <%= render :partial => "multipart_form/breadcrumb" %>
 
-    <%= form_for @form_subject, :url => person_hire_form_path(:id => @form_subject.id, :multipart_form_part => @next_multipart_form_part), :html => {:method => :post} do |f| %>
-      <%= render "multipart_form/all_errors" %>
-      <%= render @multipart_form_part, :locals => {:form => f}  %>
+    <%= semantic_form_for @form_subject, :url => person_hire_form_path(:id => @form_subject.id, :multipart_form_part => @next_multipart_form_part), :html => { :method => :post } do |f| %>
+      <%= f.semantic_errors %>
+      <%= render :partial => @multipart_form_part, :locals => {:form => f}  %>
       <%= f.submit "Submit" %>
     <% end %>
 
-The breadcrumb adds links to the other multipart for parts.  The all_errors partial is a substitute for putting error handling on each individual partial.  The url and @form_subject instance variable are necessary to make the form submit and redirect correctly.
+app/views/people/_personal.html.erb:
+
+    <%= form.inputs do %>
+      <%= form.input :name %>
+      <%= form.input :address %>
+    <% end %>
+
+app/views/people/_job.html.erb:
+
+    <%= form.inputs do %>
+      <%= form.input :hire_date %>
+      <%= form.input :salary %>
+    <% end %>
+
 == Adding form part links to the index page
 
 === On the controller
@@ -56,7 +98,6 @@ The breadcrumb adds links to the other multipart for parts.  The all_errors part
 
 Creates links to each form part for the given form subject.  The load_multipart_form_index_links must be called to load the data for the links.  The configuration options in the initializer can be used to change the output of the partial.
 
-
 == Future work
 
 * Fix the index links loading so that the user does not have to explicitly call a method when they are needed
@@ -78,4 +119,3 @@ Creates links to each form part for the given form subject.  The load_multipart_
 
 Copyright (c) 2011 Jeremiah Hemphill. See LICENSE.txt for
 further details.
-

data/VERSION

@@ -1 +1 @@
-0.0.12
+0.0.13

data/acts_as_multipart_form.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "acts_as_multipart_form"
-  s.version = "0.0.12"
+  s.version = "0.0.13"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeremiah Hemphill", "Ethan Pemble"]
-  s.date = "2012-04-10"
+  s.date = "2012-05-09"
   s.description = "Multipart forms using custom routes"
   s.email = "jeremiah@cloudspace.com"
   s.extra_rdoc_files = [
@@ -102,7 +102,7 @@ Gem::Specification.new do |s|
     "spec/dummy/script/rails",
     "spec/in_progress_form_spec.rb",
     "spec/integration/navigation_spec.rb",
-    "spec/multipart_form_in_controller_integeration_spec.rb",
+    "spec/multipart_form_in_controller_integration_spec.rb",
     "spec/multipart_form_in_controller_spec.rb",
     "spec/multipart_form_in_model_integration_spec.rb",
     "spec/multipart_form_in_model_spec.rb",

data/app/models/multipart_form/in_progress_form.rb

@@ -12,6 +12,8 @@ module MultipartForm
     set_table_name "multipart_form_in_progress_forms"
     belongs_to :form_subject, :polymorphic => true
 
+    attr_accessible :form_subject, :form_subject_id, :form_subject_type, :form_name, :last_completed_step, :completed
+
     validates_presence_of :form_subject
     validates_presence_of :form_name
     validates_presence_of :last_completed_step

data/spec/dummy/app/controllers/people_controller.rb

@@ -2,39 +2,22 @@ class PeopleController < ApplicationController
   acts_as_multipart_form :name => :hire_form, :parts => [:person_info, :job_info], :model => "Person", :form_route => "person_hire_form"
 
   def person_info
-    @person = Person.find(params[:id])
   end
 
   def person_info_update
-    @person = Person.find(params[:id])
-    @person.multipart_form_controller_action = "person_info_update"
-    if params[:person] and params[:person][:person]
-      @person.update_attributes(params[:person][:person])
-      return { :valid => @person.valid? }
-    else
-      return { :valid => false }
-    end
-    
+    @form_subject.multipart_form_controller_action = "person_info_update"
+    return { :valid => @form_subject.update_attributes(params[:person]) }
   end
 
   def job_info
-    @person = Person.find(params[:id])
   end
 
   def job_info_update
-    @person = Person.find(params[:id])
-    @person.multipart_form_controller_action = "job_info_update"
-    if @person.update_attributes(params[:person])
-      return {:valid => true}
-    else
-      return {:valid => false }
-    end
+    @form_subject.multipart_form_controller_action = "job_info_update"
+    return { :valid => @form_subject.update_attributes(params[:person]) }
   end
 
   def hire_form
-    #puts "stub method for the hire form"
-    #@person = Person.find(params[:id])
-    
     respond_to do |format|
       format.html
     end

data/spec/dummy/app/models/person.rb

@@ -1,5 +1,7 @@
 class Person < ActiveRecord::Base
   multipart_formable :forms => [:hire_form]
 
+  attr_accessible :name
+
   validates_presence_of :name, :if => :hire_form_person_info_update?
 end

data/spec/dummy/app/views/people/_job_info.html.erb

@@ -3,6 +3,6 @@
 </p>
 
 <div class="field">
-  <%= locals[:form].label :name %><br />
-  <%= locals[:form].text_field :name %>
+  <%= form.label :name %><br />
+  <%= form.text_field :name %>
 </div>

data/spec/dummy/app/views/people/_person_info.html.erb

@@ -2,7 +2,7 @@
   This is the personal info multipart form partial.
 </p>
 
-<%= locals[:form].fields_for @person do |fp| %>
-  <%= fp.label :name %><br />
-  <%= fp.text_field :name %>
-<% end %>
+<div class="field">
+  <%= form.label :name %><br />
+  <%= form.text_field :name %>
+</div>

data/spec/dummy/app/views/people/hire_form.html.erb

@@ -2,10 +2,10 @@
   This is the hire form view
 </p>
 
-<%= render "multipart_form/breadcrumb" %>
+<%= render :partial => "multipart_form/breadcrumb" %>
 
 <%= form_for @form_subject, :url => person_hire_form_path(:id => @form_subject.id, :multipart_form_part => @next_multipart_form_part), :html => {:method => :post} do |f| %>
-  <%= render "multipart_form/all_errors" %>
-  <%= render @multipart_form_part, :locals => {:form => f}  %>
+  <%= render :partial => "multipart_form/all_errors" %>
+  <%= render :partial => @multipart_form_part, :locals => {:form => f}  %>
   <%= f.submit "Submit" %>
 <% end %>

data/spec/dummy/features/all_errors_partial.feature

@@ -4,7 +4,7 @@ Feature: I should be able to see error messages
     Given there are no People in the system
     And a person with an incomplete multipart form exists
     When I go to the person hire_form page for that person
-    And I fill in "person_person_name" with ""
+    And I fill in "person_name" with ""
     And I press "Submit"
     Then I should see "1 error prohibited this form from being saved:"
     And I should see "Person: Name can't be blank"
@@ -13,7 +13,7 @@ Feature: I should be able to see error messages
     Given there are no People in the system
     And a person with an incomplete multipart form exists
     When I go to the person hire_form page for that person
-    And I fill in "person_person_name" with "Jeremiah"
+    And I fill in "person_name" with "Jeremiah"
     And I press "Submit"
     Then I should not see "0 errors prohibited this form from being saved:"
     And I should not see "Person: Name can't be blank"

data/spec/dummy/features/form_submission.feature

@@ -8,7 +8,7 @@ Feature: I should be able to submit data using the multipart form system
     Given there are no People in the system
     And a person with an incomplete multipart form exists
     When I go to the person hire_form page for that person
-    And I fill in "person_person_name" with "Ethan"
+    And I fill in "person_name" with "Ethan"
     And I press "Submit"
     Then that person's information should have updated
     And I should be on the person hire_form page

metadata

@@ -2,7 +2,7 @@
 name: acts_as_multipart_form
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors: 
 - Jeremiah Hemphill
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-10 00:00:00 Z
+date: 2012-05-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rails
@@ -240,7 +240,7 @@ files:
 - spec/dummy/script/rails
 - spec/in_progress_form_spec.rb
 - spec/integration/navigation_spec.rb
-- spec/multipart_form_in_controller_integeration_spec.rb
+- spec/multipart_form_in_controller_integration_spec.rb
 - spec/multipart_form_in_controller_spec.rb
 - spec/multipart_form_in_model_integration_spec.rb
 - spec/multipart_form_in_model_spec.rb
@@ -258,7 +258,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -704243925010258065
+      hash: 1196884223902992685
       segments: 
       - 0
       version: "0"