surveyor 0.9.10 → 0.10.0

data/README.md

@@ -2,17 +2,68 @@
 
 Surveyor is a rails (gem) plugin, that brings surveys to your rails app. Before Rails 2.3, it was implemented as a Rails Engine. Surveys are written in a DSL (Domain Specific Language), with examples available in the "kitchen sink" survey.
 
+## Why you might want to use Surveyor
+
+If you have to have a part of your Rails app that asks users questions as part of a survey, quiz, or questionnaire then you should consider using Surveyor. This plugin was designed out of the need to deliver clinical research surveys to large populations of people but it can be used for any type of survey. It has an easy to use DSL to define the questions, response dependencies (if user answers 'A' to question 1 then show question 1a, etc...), and structure (different sections of longer questionnaires).
+
+To build your questionnaire you define it using a custom DSL. Having a DSL instead of a GUI makes it significantly easier to import long surveys (no more endless clicking and typing into tiny text boxes). It also means that you can let your customer write out the survey, edit, re-edit, tweak, throw out and start over, any number of surveys without having to change a single line of code in your app. 
+
+## DSL example
+
+Our DSL supports a wide range of question types (too many to list here) and varying dependency logic. Here are the first few questions of the "kitchen_sink" survey which should give you and idea of how the DSL works. The full example with all the types of questions is in the plugin and available if you run the installation instructions below.
+
+    survey "“Kitchen Sink” survey" do
+    
+      section "Basic questions" do
+        # A label is a question that accepts no answers
+        label "These questions are examples of the basic supported input types"
+    
+        # A basic question with radio buttons
+        question_1 "What is your favorite color?", :pick => :one
+        answer "red"
+        answer "blue"
+        answer "green"
+        answer "yellow"
+        answer :other
+    
+        # A basic question with checkboxes
+        # "question" and "answer" may be abbreviated as "q" and "a"
+        q_2 "Choose the colors you don't like", :pick => :any
+        a_1 "red"
+        a_2 "blue"
+        a_3 "green"
+        a_4 "yellow"
+        a :omit
+    
+        # A dependent question, with conditions and rule to logically join them  
+        # the question's reference identifier is "2a", and the answer's reference_identifier is "1"
+        # question reference identifiers used in conditions need to be unique on a survey for the lookups to work
+        q_2a "Please explain why you don't like this color?"
+        a_1 "explanation", :text
+        dependency :rule => "A or B or C or D"
+        condition_A :q_2, "==", :a_1
+        condition_B :q_2, "==", :a_2
+        condition_C :q_2, "==", :a_3
+        condition_D :q_2, "==", :a_4
+    
+        # ... other question, sections and such. See kitchen_sink_survey.rb for more.
+     end 
+    
+    end
+   
+The survey above shows a couple simple question types. The first one is a "pick one" type with the "other" custom entry. The second question is a "pick any" type with the option to "omit". It also has a dependency where you can ask a follow up question based on how the user answered the previous question. Notice the way the dependency is defined as a string. This implementation supports any number of complex dependency rules so not just "A or B or C or D" but "A and (B or C) and D" or "!A or ((B and !C) or D)". The conditions are the letters used they are evaluated separately using the operators defined for "==","<>", ">=","<", (the usual stuff) the plugged in to the dependency rule and evaluated. See the example survey for more details.
+
 # Installation
 
 As a plugin:
 
     gem install haml
-    script/plugin install git://github.com/breakpointer/surveyor.git -r 'tag v0.9.10'
+    script/plugin install git://github.com/breakpointer/surveyor.git -r 'tag v0.10.0'
 
 Or as a gem plugin:
   
     # in environment.rb
-    config.gem "surveyor", :version => '>=0.9.10', :source => 'http://gemcutter.org'
+    config.gem "surveyor", :version => '~> 0.10.0', :source => 'http://gemcutter.org'
   
     rake gems:install
 
@@ -29,6 +80,18 @@ The rake surveyor task overwrites previous surveys by default, but can append in
 
     rake surveyor FILE=surveys/kitchen_sink_survey.rb APPEND=true
 
+The rake tasks above generate surveys in our custom survey DSL (which is a great format for end users and stakeholders to use). 
+After you have run them start up your app:
+    
+    script/server
+
+(or however you normally start your app) and goto:
+
+    http://localhost:3000/surveys
+
+Try taking the survey and compare it to the contents of the DSL file kitchen\_sink\_survey.rb. See how each type of
+DSL question maps to the resulting rendered view of the question.
+
 # Configuration
 
 The surveyor generator creates config/initializers/surveyor.rb. There, you can specify:
@@ -103,10 +166,26 @@ The <code>surveyor\_includes</code> helper just calls <code>surveyor\_stylsheets
     
 # Dependencices
 
-Surveyor depends on Rails 2.3 and the SASS style sheet language, part of HAML (http://haml.hamptoncatlin.com/download)
+Surveyor depends on Rails 2.3 and the SASS style sheet language, part of HAML (http://haml.hamptoncatlin.com/download). For running the test suite you will need rspec and have the rspec plugin installed in your application.
+
+# Test Suite and Development
+
+To work on the plugin code (for enhancements, and bug fixes, etc...) fork this github project. Then clone the project under the vendor/plugins directory in a Rails app used only for development:
+
 
 # Changes
 
+0.9.11
+
+* adding rails init.rb to make gem loading work. thanks mike gurley. closes #52.
+* Repeater changed to only have +1, not +3 as previous
+* added locking and transaction to surveyor update action. Prevents bug that caused duplicated answers
+* some light re-factoring and code readability changes
+* some code formatting changes
+* added require statement to specs so the factory_girl test dependency was more clear
+* spiced up the readme... may have some typos
+* readme update
+
 0.9.10
 
 * styles, adding labels for dates, correcting labels for radio buttons

data/VERSION

@@ -1 +1 @@
-0.9.10
+0.10.0

data/app/controllers/surveyor_controller.rb

@@ -2,31 +2,34 @@
 # The "resource" is a survey attempt/session populating a response set.
 
 class SurveyorController < ApplicationController
-  
+
   # Layout
   layout Surveyor::Config['default.layout'] || 'surveyor_default'
-  
+
   # Extending surveyor
-  include SurveyorControllerExtensions if Surveyor::Config['extend_controller']
+  include SurveyorControllerExtensions if Surveyor::Config['extend'].include?("surveyor_controller")
   before_filter :extend_actions
-  
+
   # RESTful authentication
   if Surveyor::Config['use_restful_authentication']
     include AuthenticatedSystem
     before_filter :login_required
   end
-  
+
   # Get the response set or current_user
   # before_filter :get_response_set, :except => [:new, :create]
   before_filter :get_current_user, :only => [:new, :create]
-  
+
   # Actions
   def new
     @surveys = Survey.find(:all)
     redirect_to surveyor_default(:index) unless available_surveys_path == surveyor_default(:index)
   end
+
   def create
-    if (@survey = Survey.find_by_access_code(params[:survey_code])) && (@response_set = ResponseSet.create(:survey => @survey, :user_id => (@current_user.nil? ? @current_user : @current_user.id)))
+    @survey = Survey.find_by_access_code(params[:survey_code])
+    @response_set = ResponseSet.create(:survey => @survey, :user_id => (@current_user.nil? ? @current_user : @current_user.id))
+    if (@survey && @response_set)
       flash[:notice] = "Survey was successfully started."
       redirect_to(edit_my_survey_path(:survey_code => @survey.access_code, :response_set_code  => @response_set.access_code))
     else
@@ -34,13 +37,20 @@ class SurveyorController < ApplicationController
       redirect_to(available_surveys_path)
     end
   end
+
   def show
   end
+
   def edit
-    if @response_set = ResponseSet.find_by_access_code(params[:response_set_code], :include => {:responses => [:question, :answer]})
+    @response_set = ResponseSet.find_by_access_code(params[:response_set_code], :include => {:responses => [:question, :answer]})
+    if @response_set
       @survey = Survey.with_sections.find_by_id(@response_set.survey_id)
       @sections = @survey.sections
-      @section = params[:section] ? @sections.with_includes.find(section_id_from(params[:section])) || @sections.with_includes.first : @sections.with_includes.first
+      if params[:section]  
+        @section = @sections.with_includes.find(section_id_from(params[:section])) || @sections.with_includes.first 
+      else
+        @section = @sections.with_includes.first
+      end
       @questions = @section.questions
       @dependents = (@response_set.unanswered_dependencies - @section.questions) || []
     else
@@ -48,20 +58,25 @@ class SurveyorController < ApplicationController
       redirect_to(available_surveys_path)
     end
   end
+
   def update
-    if @response_set = ResponseSet.find_by_access_code(params[:response_set_code], :include => {:responses => :answer})
-      @response_set.current_section_id = params[:current_section_id]
-    else
-      flash[:notice] = "Unable to find your responses to the survey"
-      redirect_to(available_surveys_path) and return
-    end
-    
-    if params[:responses] or params[:response_groups]
-      @response_set.clear_responses
-      saved = @response_set.update_attributes(:response_attributes => (params[:responses] || {}).dup , :response_group_attributes => (params[:response_groups] || {}).dup) #copy (dup) to preserve params because we manipulate params in the response_set methods
-      if (saved && params[:finish])
-        @response_set.complete!
-        saved = @response_set.save!
+    saved = nil
+    ActiveRecord::Base.transaction do 
+      if @response_set = ResponseSet.find_by_access_code(params[:response_set_code], :include => {:responses => :answer},:lock => true)
+        @response_set.current_section_id = params[:current_section_id]
+      else
+        flash[:notice] = "Unable to find your responses to the survey"
+        redirect_to(available_surveys_path) and return
+      end
+
+      if params[:responses] or params[:response_groups]
+        @response_set.clear_responses
+        saved = @response_set.update_attributes(:response_attributes => (params[:responses] || {}).dup ,
+                                                :response_group_attributes => (params[:response_groups] || {}).dup) #copy (dup) to preserve params because we manipulate params in the response_set methods
+        if (saved && params[:finish])
+          @response_set.complete!
+          saved = @response_set.save!
+        end
       end
     end
     respond_to do |format|
@@ -82,21 +97,22 @@ class SurveyorController < ApplicationController
   end
 
   private
-  
+
   # Filters
   def get_current_user
     @current_user = self.respond_to?(:current_user) ? self.current_user : nil
   end
-  
+
   # Params: the name of some submit buttons store the section we'd like to go to. for repeater questions, an anchor to the repeater group is also stored
   # e.g. params[:section] = {"1"=>{"question_group_1"=>"<= add row"}}
   def section_id_from(p)
     p.respond_to?(:keys) ? p.keys.first : p
   end
+
   def anchor_from(p)
     p.respond_to?(:keys) && p[p.keys.first].respond_to?(:keys) ? p[p.keys.first].keys.first : nil
   end
-  
+
   # Extending surveyor
   def surveyor_default(type = :finish)
     # http://www.postal-code.com/mrhappy/blog/2007/02/01/ruby-comparing-an-objects-class-in-a-case-statement/
@@ -110,10 +126,10 @@ class SurveyorController < ApplicationController
       return available_surveys_path
     end
   end
-  
+
   def extend_actions
     # http://blog.mattwynne.net/2009/07/11/rails-tip-use-polymorphism-to-extend-your-controllers-at-runtime/
-    self.extend SurveyorControllerExtensions::Actions if Surveyor::Config['extend_controller'] && defined? SurveyorControllerExtensions::Actions
+    self.extend SurveyorControllerExtensions::Actions if Surveyor::Config['extend'].include?("surveyor_controller") && defined? SurveyorControllerExtensions::Actions
   end
 
 end

data/app/helpers/surveyor_helper.rb

@@ -1,5 +1,8 @@
 module SurveyorHelper
-  
+
+  # Extending surveyor
+  include SurveyorHelperExtensions if Surveyor::Config['extend'].include?("surveyor_helper")
+    
   # Configuration
   def surveyor_config
     Surveyor::Config

data/app/models/answer.rb

@@ -1,4 +1,7 @@
 class Answer < ActiveRecord::Base
+
+  # Extending surveyor
+  include "#{self.name}Extensions".constantize if Surveyor::Config['extend'].include?(self.name.underscore)
   
   # Associations
   belongs_to :question

data/app/models/dependency.rb

@@ -1,4 +1,8 @@
 class Dependency < ActiveRecord::Base
+
+  # Extending surveyor
+  include "#{self.name}Extensions".constantize if Surveyor::Config['extend'].include?(self.name.underscore)
+
   # Associations
   belongs_to :question
   belongs_to :question_group

data/app/models/dependency_condition.rb

@@ -1,4 +1,8 @@
 class DependencyCondition < ActiveRecord::Base
+
+  # Extending surveyor
+  include "#{self.name}Extensions".constantize if Surveyor::Config['extend'].include?(self.name.underscore)
+
   # Constants
   OPERATORS = %w(== != < > <= >=) # CONSTANT or @@class_variable when validations listed before class method
 

data/app/models/question.rb

@@ -1,5 +1,8 @@
 class Question < ActiveRecord::Base
-  
+
+  # Extending surveyor
+  include "#{self.name}Extensions".constantize if Surveyor::Config['extend'].include?(self.name.underscore)
+    
   # Associations
   belongs_to :survey_section
   belongs_to :question_group

data/app/models/question_group.rb

@@ -1,5 +1,8 @@
 class QuestionGroup < ActiveRecord::Base
-  
+
+  # Extending surveyor
+  include "#{self.name}Extensions".constantize if Surveyor::Config['extend'].include?(self.name.underscore)
+    
   has_many :questions
   has_one :dependency
   

data/app/models/response.rb

@@ -1,4 +1,8 @@
 class Response < ActiveRecord::Base
+
+  # Extending surveyor
+  include "#{self.name}Extensions".constantize if Surveyor::Config['extend'].include?(self.name.underscore)
+  
   include ActionView::Helpers::SanitizeHelper
          
   # Associations

data/app/models/response_set.rb

@@ -1,5 +1,8 @@
 class ResponseSet < ActiveRecord::Base
 
+  # Extending surveyor
+  include "#{self.name}Extensions".constantize if Surveyor::Config['extend'].include?(self.name.underscore)
+  
   # Associations
   belongs_to :survey
   belongs_to :user

data/app/models/survey.rb

@@ -1,5 +1,8 @@
 class Survey < ActiveRecord::Base
-  
+
+  # Extending surveyor
+  include "#{self.name}Extensions".constantize if Surveyor::Config['extend'].include?(self.name.underscore)
+
   # Associations
   has_many :sections, :class_name => "SurveySection", :order => 'display_order'
   has_many :sections_with_questions, :include => :questions, :class_name => "SurveySection", :order => 'display_order'

data/app/models/survey_section.rb

@@ -1,5 +1,8 @@
 class SurveySection < ActiveRecord::Base
   
+  # Extending surveyor
+  include "#{self.name}Extensions".constantize if Surveyor::Config['extend'].include?(self.name.underscore)
+    
   # Associations
   has_many :questions, :order => "display_order ASC"
   belongs_to :survey

data/app/models/validation.rb

@@ -1,4 +1,9 @@
 class Validation < ActiveRecord::Base
+
+  # Extending surveyor
+  include "#{self.name}Extensions".constantize if Surveyor::Config['extend'].include?(self.name.underscore)
+
+  
   # Associations
   belongs_to :answer
   has_many :validation_conditions

data/app/models/validation_condition.rb

@@ -1,4 +1,8 @@
 class ValidationCondition < ActiveRecord::Base
+
+  # Extending surveyor
+  include "#{self.name}Extensions".constantize if Surveyor::Config['extend'].include?(self.name.underscore)
+  
   # Constants
   OPERATORS = %w(== != < > <= >= =~)
 

data/app/views/partials/_question_group.html.haml

@@ -25,7 +25,7 @@
               %th{:class => "#{cycle("column_highlight", "", :name => "column_highlight")}"}= answer.text
   - when :repeater
     %ul.repeater
-      - (response_set.count_group_responses(group_questions) + 3).times do |group_number|
+      - (response_set.count_group_responses(group_questions) + 1).times do |group_number|
         %li.repeater
           - group_questions.each do |question|
             = render(:partial => question.custom_renderer || "/partials/question", :locals => locals.merge({:question => question, :response_group => group_number, :disabled => false}))

data/config/routes.rb

@@ -1,5 +1,6 @@
 ActionController::Routing::Routes.draw do |map|
-  root = Surveyor::Config['default.relative_url_root'] || "surveys/"
+  root = Surveyor::Config['default.relative_url_root'] || "surveys"
+  root = (root << "/").gsub(/\/+/, "/")
   map.with_options :controller => 'surveyor' do |s|
     s.available_surveys "#{root}",                                       :conditions => {:method => :get}, :action => "new"      # GET survey list
     s.take_survey       "#{root}:survey_code",                           :conditions => {:method => :post}, :action => "create"  # Only POST of survey to create

data/features/step_definitions/web_steps.rb

@@ -0,0 +1,273 @@
+# IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
+# It is recommended to regenerate this file in the future when you upgrade to a 
+# newer version of cucumber-rails. Consider adding your own code to a new file 
+# instead of editing this one. Cucumber will automatically load all features/**/*.rb
+# files.
+
+
+require 'uri'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths"))
+
+# Commonly used webrat steps
+# http://github.com/brynary/webrat
+
+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 )follow "([^\"]*)" within "([^\"]*)"$/ do |link, parent|
+  click_link_within(parent, 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
+
+# Use this step in conjunction with Rail's datetime_select helper. For example:
+# When I select "December 25, 2008 10:00" as the date and time
+When /^(?:|I )select "([^\"]*)" as the date and time$/ do |time|
+  select_datetime(time)
+end
+
+# Use this step when using multiple datetime_select helpers on a page or
+# you want to specify which datetime to select. Given the following view:
+#   <%= f.label :preferred %><br />
+#   <%= f.datetime_select :preferred %>
+#   <%= f.label :alternative %><br />
+#   <%= f.datetime_select :alternative %>
+# The following steps would fill out the form:
+# When I select "November 23, 2004 11:20" as the "Preferred" date and time
+# And I select "November 25, 2004 10:30" as the "Alternative" date and time
+When /^(?:|I )select "([^\"]*)" as the "([^\"]*)" date and time$/ do |datetime, datetime_label|
+  select_datetime(datetime, :from => datetime_label)
+end
+
+# Use this step in conjunction with Rail's time_select helper. For example:
+# When I select "2:20PM" as the time
+# Note: Rail's default time helper provides 24-hour time-- not 12 hour time. Webrat
+# will convert the 2:20PM to 14:20 and then select it.
+When /^(?:|I )select "([^\"]*)" as the time$/ do |time|
+  select_time(time)
+end
+
+# Use this step when using multiple time_select helpers on a page or you want to
+# specify the name of the time on the form.  For example:
+# When I select "7:30AM" as the "Gym" time
+When /^(?:|I )select "([^\"]*)" as the "([^\"]*)" time$/ do |time, time_label|
+  select_time(time, :from => time_label)
+end
+
+# Use this step in conjunction with Rail's date_select helper.  For example:
+# When I select "February 20, 1981" as the date
+When /^(?:|I )select "([^\"]*)" as the date$/ do |date|
+  select_date(date)
+end
+
+# Use this step when using multiple date_select helpers on one page or
+# you want to specify the name of the date on the form. For example:
+# When I select "April 26, 1982" as the "Date of Birth" date
+When /^(?:|I )select "([^\"]*)" as the "([^\"]*)" date$/ do |date, date_label|
+  select_date(date, :from => date_label)
+end
+
+When /^(?:|I )check "([^\"]*)"$/ do |field|
+  check(field)
+end
+
+When /^(?:|I )uncheck "([^\"]*)"$/ do |field|
+  uncheck(field)
+end
+
+When /^(?:|I )choose "([^\"]*)"$/ do |field|
+  choose(field)
+end
+
+# Adds support for validates_attachment_content_type. Without the mime-type getting
+# passed to attach_file() you will get a "Photo file is not one of the allowed file types."
+# error message 
+When /^(?:|I )attach the file "([^\"]*)" to "([^\"]*)"$/ do |path, field|
+  type = path.split(".")[1]
+
+  case type
+  when "jpg"
+    type = "image/jpg" 
+  when "jpeg"
+    type = "image/jpeg" 
+  when "png"
+    type = "image/png" 
+  when "gif"
+    type = "image/gif"
+  end
+  
+  attach_file(field, path, type)
+end
+
+Then /^(?:|I )should see "([^\"]*)"$/ do |text|
+  if defined?(Spec::Rails::Matchers)
+    response.should contain(text)
+  else
+    assert_contain text
+  end
+end
+
+Then /^(?:|I )should see "([^\"]*)" within "([^\"]*)"$/ do |text, selector|
+  within(selector) do |content|
+    if defined?(Spec::Rails::Matchers)
+      content.should contain(text)
+    else
+      hc = Webrat::Matchers::HasContent.new(text)
+      assert hc.matches?(content), hc.failure_message
+    end
+  end
+end
+
+Then /^(?:|I )should see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+  if defined?(Spec::Rails::Matchers)
+    response.should contain(regexp)
+  else
+    assert_match(regexp, response_body)
+  end
+end
+
+Then /^(?:|I )should see \/([^\/]*)\/ within "([^\"]*)"$/ do |regexp, selector|
+  within(selector) do |content|
+    regexp = Regexp.new(regexp)
+    if defined?(Spec::Rails::Matchers)
+      content.should contain(regexp)
+    else
+      assert_match(regexp, content)
+    end
+  end
+end
+
+Then /^(?:|I )should not see "([^\"]*)"$/ do |text|
+  if defined?(Spec::Rails::Matchers)
+    response.should_not contain(text)
+  else
+    assert_not_contain(text)
+  end
+end
+
+Then /^(?:|I )should not see "([^\"]*)" within "([^\"]*)"$/ do |text, selector|
+  within(selector) do |content|
+    if defined?(Spec::Rails::Matchers)
+      content.should_not contain(text)
+    else
+      hc = Webrat::Matchers::HasContent.new(text)
+      assert !hc.matches?(content), hc.negative_failure_message
+    end
+  end
+end
+
+Then /^(?:|I )should not see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+  if defined?(Spec::Rails::Matchers)
+    response.should_not contain(regexp)
+  else
+    assert_not_contain(regexp)
+  end
+end
+
+Then /^(?:|I )should not see \/([^\/]*)\/ within "([^\"]*)"$/ do |regexp, selector|
+  within(selector) do |content|
+    regexp = Regexp.new(regexp)
+    if defined?(Spec::Rails::Matchers)
+      content.should_not contain(regexp)
+    else
+      assert_no_match(regexp, content)
+    end
+  end
+end
+
+Then /^the "([^\"]*)" field should contain "([^\"]*)"$/ do |field, value|
+  if defined?(Spec::Rails::Matchers)
+    field_labeled(field).value.should =~ /#{value}/
+  else
+    assert_match(/#{value}/, field_labeled(field).value)
+  end
+end
+
+Then /^the "([^\"]*)" field should not contain "([^\"]*)"$/ do |field, value|
+  if defined?(Spec::Rails::Matchers)
+    field_labeled(field).value.should_not =~ /#{value}/
+  else
+    assert_no_match(/#{value}/, field_labeled(field).value)
+  end
+end
+
+Then /^the "([^\"]*)" checkbox should be checked$/ do |label|
+  if defined?(Spec::Rails::Matchers)
+    field_labeled(label).should be_checked
+  else
+    assert field_labeled(label).checked?
+  end
+end
+
+Then /^the "([^\"]*)" checkbox should not be checked$/ do |label|
+  if defined?(Spec::Rails::Matchers)
+    field_labeled(label).should_not be_checked
+  else
+    assert !field_labeled(label).checked?
+  end
+end
+
+Then /^(?:|I )should be on (.+)$/ do |page_name|
+  if defined?(Spec::Rails::Matchers)
+    URI.parse(current_url).path.should == path_to(page_name)
+  else
+    assert_equal path_to(page_name), URI.parse(current_url).path
+  end
+end
+
+Then /^(?:|I )should have the following query string:$/ do |expected_pairs|
+  actual_params   = CGI.parse(URI.parse(current_url).query)
+  expected_params = Hash[expected_pairs.rows_hash.map{|k,v| [k,[v]]}]
+ 
+  if defined?(Spec::Rails::Matchers)
+    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

data/features/support/env.rb

@@ -1,24 +1,57 @@
-# Sets up the Rails environment for Cucumber
+# IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
+# It is recommended to regenerate this file in the future when you upgrade to a 
+# newer version of cucumber-rails. Consider adding your own code to a new file 
+# instead of editing this one. Cucumber will automatically load all features/**/*.rb
+# files.
+
 ENV["RAILS_ENV"] ||= "cucumber"
 require File.expand_path(File.dirname(__FILE__) + '/../../../../../config/environment')
-require 'cucumber/rails/world'
-
-# Comment out the next line if you don't want Cucumber Unicode support
-require 'cucumber/formatter/unicode'
 
-# Comment out the next line if you don't want transactions to
-# open/roll back around each scenario
-Cucumber::Rails.use_transactional_fixtures
-
-# Comment out the next line if you want Rails' own error handling
-# (e.g. rescue_action_in_public / rescue_responses / rescue_from)
-Cucumber::Rails.bypass_rescue
+require 'cucumber/formatter/unicode' # Remove this line if you don't want Cucumber Unicode support
+require 'cucumber/rails/world'
+require 'cucumber/rails/active_record'
+require 'cucumber/web/tableish'
 
 require 'webrat'
+require 'webrat/core/matchers'
 
 Webrat.configure do |config|
   config.mode = :rails
+  config.open_error_files = false # Set to true if you want error pages to pop up in the browser
 end
 
-require 'cucumber/rails/rspec'
-require 'webrat/core/matchers'
+
+# If you set this to false, any error raised from within your app will bubble 
+# up to your step definition and out to cucumber unless you catch it somewhere
+# on the way. You can make Rails rescue errors and render error pages on a
+# per-scenario basis by tagging a scenario or feature with the @allow-rescue tag.
+#
+# If you set this to true, Rails will rescue all errors and render error
+# pages, more or less in the same way your application would behave in the
+# default production environment. It's not recommended to do this for all
+# of your scenarios, as this makes it hard to discover errors in your application.
+ActionController::Base.allow_rescue = false
+
+# If you set this to true, each scenario will run in a database transaction.
+# You can still turn off transactions on a per-scenario basis, simply tagging 
+# a feature or scenario with the @no-txn tag. If you are using Capybara,
+# tagging with @culerity or @javascript will also turn transactions off.
+#
+# If you set this to false, transactions will be off for all scenarios,
+# regardless of whether you use @no-txn or not.
+#
+# Beware that turning transactions off will leave data in your database 
+# after each scenario, which can lead to hard-to-debug failures in 
+# subsequent scenarios. If you do this, we recommend you create a Before
+# block that will explicitly put your database in a known state.
+Cucumber::Rails::World.use_transactional_fixtures = true
+
+# How to clean your database when transactions are turned off. See
+# http://github.com/bmabey/database_cleaner for more info.
+if defined?(ActiveRecord::Base)
+  begin
+    require 'database_cleaner'
+    DatabaseCleaner.strategy = :truncation
+  rescue LoadError => ignore_if_database_cleaner_not_present
+  end
+end

data/features/support/paths.rb

@@ -3,16 +3,16 @@ module NavigationHelpers
   #
   #   When /^I go to (.+)$/ do |page_name|
   #
-  # step definition in webrat_steps.rb
+  # step definition in web_steps.rb
   #
   def path_to(page_name)
     case page_name
     
-    when /the homepage/
+    when /the home\s?page/
       '/'
     
     # Add more mappings here.
-    # Here is a more fancy example:
+    # Here is an example that pulls values out of the Regexp:
     #
     #   when /^(.*)'s profile page$/i
     #     user_profile_path(User.find_by_login($1))
@@ -22,6 +22,4 @@ module NavigationHelpers
         "Now, go and add a mapping in #{__FILE__}"
     end
   end
-end
-
-World(NavigationHelpers)
+end

data/generators/extend_surveyor/templates/EXTENDING_SURVEYOR

@@ -1,12 +1,17 @@
 
-Any of surveyor's models class_eval, class methods, and instance methods can be modified. Include the following in config/initializers/surveyor.rb:
+= Extending Surveyor =
 
-    require 'models/survey_extensions' # Extended the survey model
-    
-SurveyorHelper class_eval and instance methods can be modified. Include the following in config/initializers/surveyor.rb:
+* Any of surveyor model class_eval, class methods, and instance methods may be modified.
+* SurveyorHelper class_eval and instance methods may be modified.
+* SurveyorController class_eval, class methods, instance methods, and actions can be modified. Action methods should be specified separately in the Actions submodule.
 
-    require 'helpers/surveyor_helper_extensions' # Extend the surveyor helper
+Samples files have been generated at:
 
-SurveyorController class_eval, class methods, instance methods, and actions can be modified. Action methods should be specified separately in the Actions submodule. Set the following option in config/initializers/surveyor.rb Surveyor::Config block:
+* app/models/survey_extensions.rb
+* app/helpers/surveyor_helper_extensions.rb
+* app/controllers/surveyor_controller_extensions.rb
+ 
+To activate, add the config['extend'] array in config/initializers/surveyor.rb:
 
-    config['extend_controller'] = true
+  config['extend'] = %w(survey surveyor_helper surveyor_controller)
+  

data/generators/extend_surveyor/templates/extensions/survey_extensions.rb

@@ -4,6 +4,7 @@ module SurveyExtensions
     base.send(:include, InstanceMethods)
     base.class_eval do
       # Same as typing in the class
+      
     end
   end
   
@@ -11,8 +12,13 @@ module SurveyExtensions
   end
   
   module InstanceMethods
+    # def title
+    #   foo
+    # end
+    # def foo
+    #   "bar"
+    # end
   end
 end
 
-# Add module to Survey
-Survey.send(:include, SurveyExtensions)
+# Add "survey" to config['extend'] array in config/initializers/surveyor.rb to activate these extensions

data/generators/extend_surveyor/templates/extensions/surveyor_controller_extensions.rb

@@ -25,4 +25,4 @@ module SurveyorControllerExtensions
   end
 end
 
-# Set config['extend_controller'] = true in config/initializers/surveyor.rb to activate these extensions
+# Add "surveyor_controller" to config['extend'] array in config/initializers/surveyor.rb to activate these extensions

data/generators/extend_surveyor/templates/extensions/surveyor_custom.html.erb

@@ -4,7 +4,7 @@
 <head>
   <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
   <title>Survey: <%= controller.action_name %></title>
-  <%= surveyor_includes # calls surveyor_javascripts + surveyor_stylesheets %>
+  <%= surveyor_includes %>
 </head>
 <body>
   <div id="flash"><%= flash[:notice] %></div>

data/generators/extend_surveyor/templates/extensions/surveyor_helper_extensions.rb

@@ -14,5 +14,4 @@ module SurveyorHelperExtensions
   end
 end
 
-# Add module to SurveyorHelper
-SurveyorHelper.send(:include, SurveyorHelperExtensions)
+# Add "surveyor_helper" to config['extend'] array in config/initializers/surveyor.rb to activate these extensions

data/generators/surveyor/templates/assets/stylesheets/surveyor.css

@@ -201,7 +201,7 @@ body {
       list-style-type: none; }
     #surveyor .question_group li.repeater {
       display: block;
-      clear: both; }
+      clear: left; }
       #surveyor .question_group li.repeater .question {
         float: left; }
       #surveyor .question_group li.repeater ol {

data/generators/surveyor/templates/initializers/surveyor.rb

@@ -1,12 +1,10 @@
+# Loaded once. Restart your app (even in development) to apply changes made here
 Surveyor::Config.run do |config|
-  config['default.relative_url_root'] = nil # "surveys/" # should end with '/'
+  config['default.relative_url_root'] = nil # "surveys"
   config['default.title'] = nil # "You can take these surveys:"
   config['default.layout'] = nil # "surveyor_default"
   config['default.index'] =  nil # "/surveys" # or :index_path_method
   config['default.finish'] =  nil # "/surveys" # or :finish_path_method
   config['use_restful_authentication'] = false # set to true to use restful authentication
-  config['extend_controller'] = false # set to true to extend SurveyorController
-end
-
-# require 'models/survey_extensions' # Extended the survey model
-# require 'helpers/surveyor_helper_extensions' # Extend the surveyor helper
+  config['extend'] = %w() # %w(survey surveyor_helper surveyor_controller)
+end

data/rails/init.rb

@@ -0,0 +1 @@
+# Init hook code here

data/spec/factories.rb

@@ -1,4 +1,6 @@
 # http://github.com/thoughtbot/factory_girl/tree/master
+require 'rubygems'
+require 'factory_girl'
 
 Factory.define :survey do |s|
   s.title         {"Simple survey"}
@@ -138,4 +140,4 @@ Factory.define :validation_condition do |v|
   v.string_value      {}
   v.response_other    {}
   v.regexp            {}
-end
+end

data/spec/models/survey_section_spec.rb

@@ -19,9 +19,7 @@ end
 
 describe SurveySection, "with questions" do
   before(:each) do
-    @survey = mock_model(Survey)
-    @valid_attributes={:title => "Rhymes", :survey => @survey, :display_order => 4}
-    @survey_section = SurveySection.create(@valid_attributes)
+    @survey_section = Factory(:survey_section, :title => "Rhymes", :display_order => 4)
     @q1 = @survey_section.questions.create(:text => "Peep", :display_order => 3)
     @q2 = @survey_section.questions.create(:text => "Little", :display_order => 1)
     @q3 = @survey_section.questions.create(:text => "Bo", :display_order => 2)

data/surveyor.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# 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{surveyor}
-  s.version = "0.9.10"
+  s.version = "0.10.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Chamberlain", "Mark Yoon"]
-  s.date = %q{2010-01-20}
+  s.date = %q{2010-04-05}
   s.email = %q{yoon@northwestern.edu}
   s.extra_rdoc_files = [
     "README.md"
@@ -43,7 +43,7 @@ Gem::Specification.new do |s|
      "app/views/surveyor/show.html.haml",
      "config/routes.rb",
      "features/step_definitions/surveyor_steps.rb",
-     "features/step_definitions/webrat_steps.rb",
+     "features/step_definitions/web_steps.rb",
      "features/support/env.rb",
      "features/support/paths.rb",
      "features/surveyor.feature",
@@ -135,6 +135,7 @@ Gem::Specification.new do |s|
      "lib/surveyor/config.rb",
      "lib/tasks/surveyor_tasks.rake",
      "lib/xml_formatter.rb",
+     "rails/init.rb",
      "script/surveyor/answer.rb",
      "script/surveyor/base.rb",
      "script/surveyor/dependency.rb",
@@ -176,7 +177,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/breakpointer/surveyor}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{A rails (gem) plugin to enable surveys in your application}
   s.test_files = [
     "spec/controllers/surveyor_controller_spec.rb",
@@ -209,3 +210,4 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<haml>, [">= 0"])
   end
 end
+

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: surveyor
 version: !ruby/object:Gem::Version 
-  version: 0.9.10
+  prerelease: false
+  segments: 
+  - 0
+  - 10
+  - 0
+  version: 0.10.0
 platform: ruby
 authors: 
 - Brian Chamberlain
@@ -10,19 +15,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-20 00:00:00 -06:00
+date: 2010-04-05 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: haml
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 description: 
 email: yoon@northwestern.edu
 executables: []
@@ -60,7 +67,7 @@ files:
 - app/views/surveyor/show.html.haml
 - config/routes.rb
 - features/step_definitions/surveyor_steps.rb
-- features/step_definitions/webrat_steps.rb
+- features/step_definitions/web_steps.rb
 - features/support/env.rb
 - features/support/paths.rb
 - features/surveyor.feature
@@ -152,6 +159,7 @@ files:
 - lib/surveyor/config.rb
 - lib/tasks/surveyor_tasks.rake
 - lib/xml_formatter.rb
+- rails/init.rb
 - script/surveyor/answer.rb
 - script/surveyor/base.rb
 - script/surveyor/dependency.rb
@@ -202,18 +210,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A rails (gem) plugin to enable surveys in your application

data/features/step_definitions/webrat_steps.rb

@@ -1,119 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths"))
-
-# Commonly used webrat steps
-# http://github.com/brynary/webrat
-
-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 select "([^\"]*)" from "([^\"]*)"$/ do |value, field|
-  select(value, :from => field) 
-end
-
-# Use this step in conjunction with Rail's datetime_select helper. For example:
-# When I select "December 25, 2008 10:00" as the date and time 
-When /^I select "([^\"]*)" as the date and time$/ do |time|
-  select_datetime(time)
-end
-
-# Use this step when using multiple datetime_select helpers on a page or 
-# you want to specify which datetime to select. Given the following view:
-#   <%= f.label :preferred %><br />
-#   <%= f.datetime_select :preferred %>
-#   <%= f.label :alternative %><br />
-#   <%= f.datetime_select :alternative %>
-# The following steps would fill out the form:
-# When I select "November 23, 2004 11:20" as the "Preferred" date and time
-# And I select "November 25, 2004 10:30" as the "Alternative" date and time
-When /^I select "([^\"]*)" as the "([^\"]*)" date and time$/ do |datetime, datetime_label|
-  select_datetime(datetime, :from => datetime_label)
-end
-
-# Use this step in conjunction with Rail's time_select helper. For example:
-# When I select "2:20PM" as the time
-# Note: Rail's default time helper provides 24-hour time-- not 12 hour time. Webrat
-# will convert the 2:20PM to 14:20 and then select it. 
-When /^I select "([^\"]*)" as the time$/ do |time|
-  select_time(time)
-end
-
-# Use this step when using multiple time_select helpers on a page or you want to
-# specify the name of the time on the form.  For example:
-# When I select "7:30AM" as the "Gym" time
-When /^I select "([^\"]*)" as the "([^\"]*)" time$/ do |time, time_label|
-  select_time(time, :from => time_label)
-end
-
-# Use this step in conjunction with Rail's date_select helper.  For example:
-# When I select "February 20, 1981" as the date
-When /^I select "([^\"]*)" as the date$/ do |date|
-  select_date(date)
-end
-
-# Use this step when using multiple date_select helpers on one page or
-# you want to specify the name of the date on the form. For example:
-# When I select "April 26, 1982" as the "Date of Birth" date
-When /^I select "([^\"]*)" as the "([^\"]*)" date$/ do |date, date_label|
-  select_date(date, :from => date_label)
-end
-
-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 at "([^\"]*)" to "([^\"]*)"$/ do |path, field|
-  attach_file(field, path)
-end
-
-Then /^I should see "([^\"]*)"$/ do |text|
-  response.should contain(text)
-end
-
-Then /^I should not see "([^\"]*)"$/ do |text|
-  response.should_not contain(text)
-end
-
-Then /^the "([^\"]*)" field should contain "([^\"]*)"$/ do |field, value|
-  field_labeled(field).value.should =~ /#{value}/
-end
-
-Then /^the "([^\"]*)" field should not contain "([^\"]*)"$/ do |field, value|
-  field_labeled(field).value.should_not =~ /#{value}/
-end
-    
-Then /^the "([^\"]*)" checkbox should be checked$/ do |label|
-  field_labeled(label).should be_checked
-end
-
-Then /^the "([^\"]*)" checkbox should not be checked$/ do |label|
-  field_labeled(label).should_not be_checked
-end
-
-Then /^I should be on (.+)$/ do |page_name|
-  URI.parse(current_url).path.should == path_to(page_name)
-end