acts_as_multipart_form 0.0.1

data/spec/dummy/config/initializers/acts_as_multipart_form.rb

@@ -0,0 +1,6 @@
+ActsAsMultipartForm.configure do |config|
+  # config.show_completed = false
+  # config.show_incomplete_parts = false
+  config.use_numbered_parts_on_index = false
+  # config.show_previous_next_links = true
+end

data/spec/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/spec/dummy/config/initializers/inflections.rb

@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end

data/spec/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/spec/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Dummy::Application.config.secret_token = '0a102f4a26e48b284a15de73420d2d98ff59d8ddc4f8af5500f54c92f7c331cfb8d8cae6af25980ec3639c895fd19e29f495d0ec931eefa7a33fbd84980720f5'

data/spec/dummy/config/initializers/session_store.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, :key => '_dummy_session'
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rails generate session_migration")
+# Dummy::Application.config.session_store :active_record_store

data/spec/dummy/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/spec/dummy/config/routes.rb

@@ -0,0 +1,66 @@
+Dummy::Application.routes.draw do
+
+
+  match "people/hire_form/:id/:multipart_form_part", :to => "people#hire_form", :as => "person_hire_form"
+  match "people/hire_form/:id", :to => "people#hire_form", :as => "person_hire_form"
+  match "people/hire_form", :to => "people#hire_form", :as => "person_hire_form"
+
+  resources :people
+
+  # The priority is based upon order of creation:
+  # first created -> highest priority.
+
+  # Sample of regular route:
+  #   match 'products/:id' => 'catalog#view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   resources :products
+
+  # Sample resource route with options:
+  #   resources :products do
+  #     member do
+  #       get 'short'
+  #       post 'toggle'
+  #     end
+  #
+  #     collection do
+  #       get 'sold'
+  #     end
+  #   end
+
+  # Sample resource route with sub-resources:
+  #   resources :products do
+  #     resources :comments, :sales
+  #     resource :seller
+  #   end
+
+  # Sample resource route with more complex sub-resources
+  #   resources :products do
+  #     resources :comments
+  #     resources :sales do
+  #       get 'recent', :on => :collection
+  #     end
+  #   end
+
+  # Sample resource route within a namespace:
+  #   namespace :admin do
+  #     # Directs /admin/products/* to Admin::ProductsController
+  #     # (app/controllers/admin/products_controller.rb)
+  #     resources :products
+  #   end
+
+  # You can have the root of your site routed with "root"
+  # just remember to delete public/index.html.
+  # root :to => "welcome#index"
+
+  # See how all your routes lay out with "rake routes"
+
+  # This is a legacy wild controller route that's not recommended for RESTful applications.
+  # Note: This route will make all actions in every controller accessible via GET requests.
+  # match ':controller(/:action(/:id(.:format)))'
+end

data/spec/dummy/db/migrate/20110715180834_create_people.rb

@@ -0,0 +1,13 @@
+class CreatePeople < ActiveRecord::Migration
+  def self.up
+    create_table :people do |t|
+      t.string :name
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :people
+  end
+end

data/spec/dummy/db/migrate/20110722130249_create_multipart_form_tables.rb

@@ -0,0 +1,17 @@
+class CreateMultipartFormTables < ActiveRecord::Migration
+  def self.up
+    create_table :multipart_form_in_progress_forms do |t|
+      t.string :form_subject_type
+      t.integer :form_subject_id
+      t.string :form_name
+      t.string :last_completed_step
+      t.boolean :completed
+
+      t.timestamps
+    end
+  end
+  
+  def self.down
+    drop_table :multipart_form_in_progress_forms
+  end
+end

data/spec/dummy/db/schema.rb

@@ -0,0 +1,31 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20110722130249) do
+
+  create_table "multipart_form_in_progress_forms", :force => true do |t|
+    t.string   "form_subject_type"
+    t.integer  "form_subject_id"
+    t.string   "form_name"
+    t.string   "last_completed_step"
+    t.boolean  "completed"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "people", :force => true do |t|
+    t.string   "name"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+end

data/spec/dummy/features/form_breadcrumb.feature

@@ -0,0 +1,75 @@
+Feature: I should be able to navigate usin ght einformation in the form breadcrumb
+
+  Background:
+    Given show_previous_next_links is set to true
+    And show_incomplete_parts is set to true
+
+  Scenario: I should be able to see all of the links if the form is complete
+    Given there are no People in the system
+    And a person with a complete multipart form exists
+    When I go to the person hire_form first page for that person
+    Then I should see "Person Info"
+    And I should see "Job Info"
+
+  Scenario: I should not be able to see links to parts that are not complete if the show incomplete parts config option is set to false
+    Given there are no People in the system
+    And a person with an incomplete multipart form exists
+    And show_incomplete_parts is set to false
+    When I go to the person hire_form first page for that person
+    Then I should see "Person Info"
+    And I should not see "Job Info"
+
+  Scenario: I should be able to see links to parts that are not complete if the show incomplete parts config option is set to true
+    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 first page for that person
+    Then I should see "Person Info"
+    And I should see "Job Info"
+
+  Scenario: I should be able to see a next link if the show_previous_next_links is set to true
+    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 first page for that person
+    Then I should see "Next"
+    
+  Scenario: I should not be able to see a next link if the show_previous_next_links is set to false
+    Given there are no People in the system
+    And a person with an incomplete multipart form exists
+    And show_previous_next_links is set to false
+    When I go to the person hire_form first page for that person
+    Then I should not see "Next"
+    
+  Scenario: I should be able to see a previous link if the show_previous_next_links is set to true
+    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 first page for that person
+    Then I should see "Previous"
+    
+  Scenario: I should not be able to see a previous link if the show_previous_next_links is set to false
+    Given there are no People in the system
+    And a person with an incomplete multipart form exists
+    And show_previous_next_links is set to false
+    When I go to the person hire_form first page for that person
+    Then I should not see "Previous"
+    
+  Scenario: When I click on a form part link, I should be taken to that page
+    Given there are no People in the system
+    And a person with an incomplete multipart form exists
+    And I am on the person hire_form first page for that person
+    When I follow "Job Info"
+    Then I should be on the person hire_form page
+    
+  Scenario: When I click on a previous link, I should be taken to the previous page
+    Given there are no People in the system
+    And a person with an incomplete multipart form exists
+    And I am on the person hire_form first page for that person
+    When I follow "Previous"
+    Then I should be on the person hire_form page
+    
+  Scenario: When I click on a next link, I should be taken to the next page
+    Given there are no People in the system
+    And a person with an incomplete multipart form exists
+    And I am on the person hire_form first page for that person
+    When I follow "Next"
+    Then I should be on the person hire_form page
+    

data/spec/dummy/features/form_submission.feature

@@ -0,0 +1,23 @@
+Feature: I should be able to submit data using the multipart form system
+
+  Background:
+    Given show_previous_next_links is set to true
+    And show_incomplete_parts is set to true
+
+  Scenario: Submitting on the first first page
+    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_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
+    
+  Scenario: Submitting on the last page
+    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 last page for that person
+    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 show page for that person

data/spec/dummy/features/index_links.feature

@@ -0,0 +1,56 @@
+Feature: I should be able to navigate using the information in the index links partial
+
+  Background:
+    Given show_incomplete_parts is set to false
+    And use_numbered_parts_on_index is set to false
+
+  Scenario: I should see complete is the form is complete
+    Given there are no People in the system
+    And a person with a complete multipart form exists
+    When I go to the people index page
+    Then I should see "Complete"
+    And I should not see "Incomplete"
+
+  Scenario: I shold see incomplete if the form is incomplete
+    Given there are no People in the system
+    And a person with an incomplete multipart form exists
+    When I go to the people index page
+    Then I should not see "Complete"
+    And I should see "Incomplete"
+
+  Scenario: If the form is complete, I should see all the form parts
+    Given there are no People in the system
+    And a person with a complete multipart form exists
+    When I go to the people index page
+    Then I should see "Person Info"
+    And I should see "Job Info"
+
+  Scenario: If the form is incomplete, I should not see all the form parts
+    Given there are no People in the system
+    And a person with an incomplete multipart form exists
+    When I go to the people index page
+    Then I should see "Person Info"
+    And I should not see "Job Info"
+
+  Scenario: I should not see any form parts after the last completed step fo the in progress form object
+    Given there are no People in the system
+    And a person with an incomplete multipart form exists
+    When I go to the people index page
+    Then I should see "Person Info"
+    And I should not see "Job Info"
+
+  Scenario: Clicking on a form part should take me to that form, that part, for that record
+    Given there are no People in the system
+    And a person with an incomplete multipart form exists
+    When I go to the people index page
+    And I follow "Person Info"
+    Then I should be on the person hire_form page
+
+  Scenario: I should see numbered links if the config options include numbered links
+    Given there are no People in the system
+    And a person with a complete multipart form exists
+    And use_numbered_parts_on_index is set to true
+    When I go to the people index page
+    Then I should see "1"
+    And I should see "2"
+

data/spec/dummy/features/step_definitions/acts_as_multipart_form_steps.rb

@@ -0,0 +1,30 @@
+Given /^there are no People in the system$/ do
+  Person.all.each do |p|
+    p.destroy
+  end
+end
+
+Given /^a person with a complete multipart form exists$/ do
+  p = Person.create(:name => "Jeremiah")
+  ipf = MultipartForm::InProgressForm.create(
+    :form_subject_type => "Person", 
+    :form_subject_id => p.id, 
+    :form_name => "hire_form", 
+    :completed => true, 
+    :last_completed_step => "job_info_update")
+end
+
+Given /^a person with an incomplete multipart form exists$/ do
+  p = Person.create(:name => "Jeremiah")
+  ipf = MultipartForm::InProgressForm.create(
+    :form_subject_type => "Person", 
+    :form_subject_id => p.id, 
+    :form_name => "hire_form", 
+    :completed => false, 
+    :last_completed_step => "person_info_update")
+end
+
+Then(/^that person's information should have updated$/) do
+  p = Person.last
+  p.name.should == "Ethan"
+end

data/spec/dummy/features/step_definitions/config_steps.rb

@@ -0,0 +1,23 @@
+Given(/^use_numbered_parts_on_index is set to true$/) do
+  ActsAsMultipartForm.config.use_numbered_parts_on_index = true
+end
+
+Given(/^use_numbered_parts_on_index is set to false$/) do
+  ActsAsMultipartForm.config.use_numbered_parts_on_index = false
+end
+
+Given /^show_previous_next_links is set to true$/ do
+  ActsAsMultipartForm.config.show_previous_next_links = true
+end
+
+Given /^show_previous_next_links is set to false$/ do
+  ActsAsMultipartForm.config.show_previous_next_links = false
+end
+
+Given /^show_incomplete_parts is set to true$/ do
+  ActsAsMultipartForm.config.show_incomplete_parts = true
+end
+
+Given /^show_incomplete_parts is set to false$/ do
+  ActsAsMultipartForm.config.show_incomplete_parts = false
+end

data/spec/dummy/features/step_definitions/web_steps.rb

@@ -0,0 +1,214 @@
+# TL;DR: YOU SHOULD DELETE THIS FILE
+#
+# This file was generated by Cucumber-Rails and is only here to get you a head start
+# These step definitions are thin wrappers around the Capybara/Webrat API that lets you
+# visit pages, interact with widgets and make assertions about page content.
+#
+# If you use these step definitions as basis for your features you will quickly end up
+# with features that are:
+#
+# * Hard to maintain
+# * Verbose to read
+#
+# A much better approach is to write your own higher level step definitions, following
+# the advice in the following blog posts:
+#
+# * http://benmabey.com/2008/05/19/imperative-vs-declarative-scenarios-in-user-stories.html
+# * http://dannorth.net/2011/01/31/whose-domain-is-it-anyway/
+# * http://elabs.se/blog/15-you-re-cuking-it-wrong
+#
+
+
+require 'uri'
+require 'cgi'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths"))
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "selectors"))
+
+module WithinHelpers
+  def with_scope(locator)
+    locator ? within(*selector_for(locator)) { yield } : yield
+  end
+end
+World(WithinHelpers)
+
+# Single-line step scoper
+When /^(.*) within (.*[^:])$/ do |step, parent|
+  with_scope(parent) { When step }
+end
+
+# Multi-line step scoper
+When /^(.*) within (.*[^:]):$/ do |step, parent, table_or_string|
+  with_scope(parent) { When "#{step}:", table_or_string }
+end
+
+Given /^(?:|I )am on (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^(?:|I )go to (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^(?:|I )press "([^"]*)"$/ do |button|
+  click_button(button)
+end
+
+When /^(?:|I )follow "([^"]*)"$/ do |link|
+  click_link(link)
+end
+
+When /^(?:|I )fill in "([^"]*)" with "([^"]*)"$/ do |field, value|
+  fill_in(field, :with => value)
+end
+
+When /^(?:|I )fill in "([^"]*)" for "([^"]*)"$/ do |value, field|
+  fill_in(field, :with => value)
+end
+
+# Use this to fill in an entire form with data from a table. Example:
+#
+#   When I fill in the following:
+#     | Account Number | 5002       |
+#     | Expiry date    | 2009-11-01 |
+#     | Note           | Nice guy   |
+#     | Wants Email?   |            |
+#
+# TODO: Add support for checkbox, select og option
+# based on naming conventions.
+#
+When /^(?:|I )fill in the following:$/ do |fields|
+  fields.rows_hash.each do |name, value|
+    When %{I fill in "#{name}" with "#{value}"}
+  end
+end
+
+When /^(?:|I )select "([^"]*)" from "([^"]*)"$/ do |value, field|
+  select(value, :from => field)
+end
+
+# moved to maniuplation steps
+When /^(?:|I )check "([^"]*)"$/ do |field|
+  check(field)
+end
+
+When /^(?:|I )uncheck "([^"]*)"$/ do |field|
+  uncheck(field)
+end
+
+When /^(?:|I )choose "([^"]*)"$/ do |field|
+  choose(field)
+end
+
+When /^(?:|I )attach the file "([^"]*)" to "([^"]*)"$/ do |path, field|
+  attach_file(field, File.expand_path(path))
+end
+
+Then /^(?:|I )should see "([^"]*)"$/ do |text|
+  if page.respond_to? :should
+    page.should have_content(text)
+  else
+    assert page.has_content?(text)
+  end
+end
+
+Then /^(?:|I )should see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+
+  if page.respond_to? :should
+    page.should have_xpath('//*', :text => regexp)
+  else
+    assert page.has_xpath?('//*', :text => regexp)
+  end
+end
+
+Then /^(?:|I )should not see "([^"]*)"$/ do |text|
+  if page.respond_to? :should
+    page.should have_no_content(text)
+  else
+    assert page.has_no_content?(text)
+  end
+end
+
+Then /^(?:|I )should not see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+
+  if page.respond_to? :should
+    page.should have_no_xpath('//*', :text => regexp)
+  else
+    assert page.has_no_xpath?('//*', :text => regexp)
+  end
+end
+
+Then /^the "([^"]*)" field(?: within (.*))? should contain "([^"]*)"$/ do |field, parent, value|
+  with_scope(parent) do
+    field = find_field(field)
+    field_value = (field.tag_name == 'textarea') ? field.text : field.value
+    if field_value.respond_to? :should
+      field_value.should =~ /#{value}/
+    else
+      assert_match(/#{value}/, field_value)
+    end
+  end
+end
+
+Then /^the "([^"]*)" field(?: within (.*))? should not contain "([^"]*)"$/ do |field, parent, value|
+  with_scope(parent) do
+    field = find_field(field)
+    field_value = (field.tag_name == 'textarea') ? field.text : field.value
+    if field_value.respond_to? :should_not
+      field_value.should_not =~ /#{value}/
+    else
+      assert_no_match(/#{value}/, field_value)
+    end
+  end
+end
+
+# moved to generic steps
+Then /^the "([^"]*)" checkbox(?: within (.*))? should be checked$/ do |label, parent|
+  with_scope(parent) do
+    field_checked = find_field(label)['checked']
+    if field_checked.respond_to? :should
+      field_checked.should be_true
+    else
+      assert field_checked
+    end
+  end
+end
+
+# moved to generic steps
+Then /^the "([^"]*)" checkbox(?: within (.*))? should not be checked$/ do |label, parent|
+  with_scope(parent) do
+    field_checked = find_field(label)['checked']
+    if field_checked.respond_to? :should
+      field_checked.should be_false
+    else
+      assert !field_checked
+    end
+  end
+end
+ 
+Then /^(?:|I )should be on (.+)$/ do |page_name|
+  current_path = URI.parse(current_url).path
+  if current_path.respond_to? :should
+    current_path.should == path_to(page_name)
+  else
+    assert_equal path_to(page_name), current_path
+  end
+end
+
+Then /^(?:|I )should have the following query string:$/ do |expected_pairs|
+  query = URI.parse(current_url).query
+  actual_params = query ? CGI.parse(query) : {}
+  expected_params = {}
+  expected_pairs.rows_hash.each_pair{|k,v| expected_params[k] = v.split(',')} 
+  
+  if actual_params.respond_to? :should
+    actual_params.should == expected_params
+  else
+    assert_equal expected_params, actual_params
+  end
+end
+
+Then /^show me the page$/ do
+  save_and_open_page
+end