surveyor 0.12.1 → 0.13.0

data/README.md

@@ -59,19 +59,19 @@ As a plugin:
 
     gem install haml
     gem install fastercsv
-    script/plugin install git://github.com/breakpointer/surveyor.git -r 'tag v0.12.0'
+    script/plugin install git://github.com/breakpointer/surveyor.git -r 'tag v0.13.0'
 
 Or as a gem:
   
     # in environment.rb
-    config.gem "surveyor", :version => '~> 0.12.0', :source => 'http://gemcutter.org'
+    config.gem "surveyor", :version => '~> 0.13.0', :source => 'http://gemcutter.org'
   
     rake gems:install
 
 Or as a gem (with bundler):
 
     # in environment.rb
-    gem "surveyor", '~> 0.12.0'
+    gem "surveyor", '~> 0.13.0'
 
     bundle install
 
@@ -89,88 +89,21 @@ 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:
+After you have run them start up your app and go to:
 
     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:
-
-- your own relative root for surveys ('/' is not recommended as any path will be interpreted as a survey name)
-- your own custom title (string) for the survey list page
-- your own custom layout file name, in your app/views/layouts folder
-- your own custom finish url for all surveys. you can give a string (a path), a symbol (the name of a method in ApplicationController)
-- if you would like surveys to require authorization via the restful_authentication plugin
-- if you would like to extend the surveyor_controller (see Extending Surveyor below)
-
-The initializer runs once, when the app starts. The block style is used to keep multiple options DRY (defaults below):
-
-    Surveyor::Config.run do |config|
-      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['authentication_method'] = :login_required # set to true to use restful authentication
-      config['extend'] = %w() # %w(survey surveyor_helper surveyor_controller)
-    end
-
-You can update surveyor's configuration at any time. Use the block style (above), or the individual style:
-
-    Surveyor::Config['default.title'] = "Cheese is great!"
-
-To look at the current surveyor configuration:
-    
-    Surveyor::Config.to_hash.inspect
-
-# Extending surveyor
+# Customizing surveyor
 
-Surveyor's models, helper, and controller can be extended from custom modules your app/models, app/helpers and app/controllers directories. To generate the sample files and sample layout, run:
+Surveyor's controller, models, and views may be customized via classes in your app/models, app/helpers and app/controllers directories. To generate a sample custom controller and layout, run:
 
-    script/generate extend_surveyor
+    script/rails generate surveyor:custom
 
-Any of surveyor's models class_eval, class methods, and instance methods can be modified. Include the following in config/initializers/surveyor.rb:
+and check out surveys/README\_FOR\_CUSTOM\_SURVEYOR.md
 
-    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:
-
-    require 'helpers/surveyor_helper_extensions' # Extend the surveyor helper
-
-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:
-
-    config['extend_controller'] = true
-
-# Sample layout
-
-    <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-    <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-    <head>
-      <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
-      <title>Survey: <%= controller.action_name %></title>
-      <%= surveyor_includes %>
-    </head>
-    <body>
-      <div id="flash"><%= flash[:notice] %></div>
-      <%= yield %>
-    </body>
-    </html>
-  
-The <code>surveyor\_includes</code> helper just calls <code>surveyor\_stylsheets + surveyor\_javascripts</code> which in turn call:
-
-    stylesheet_link_tag 'surveyor/reset', 'surveyor/surveyor', 'surveyor/ui.theme.css','surveyor/jquery-ui-slider-additions'
-
-    javascript_include_tag 'surveyor/jquery-1.2.6.js', 'surveyor/jquery-ui-personalized-1.5.3.js', 'surveyor/accessibleUISlider.jQuery.js','surveyor/jquery.form.js', 'surveyor/surveyor.js'
-    
 # Dependencices
 
 Surveyor depends on Ruby (1.8.7 - 1.9.1), Rails 2.3 and the SASS style sheet language, part of HAML (http://haml.hamptoncatlin.com/download). It also depends on fastercsv for csv exports. For running the test suite you will need rspec and have the rspec plugin installed in your application.
@@ -179,7 +112,6 @@ Surveyor depends on Ruby (1.8.7 - 1.9.1), Rails 2.3 and the SASS style sheet lan
 
 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.12.0

data/VERSION

@@ -1 +1 @@
-0.12.1
+0.13.0

data/app/controllers/surveyor_controller.rb

@@ -1,146 +1,6 @@
-# The Surveyor controller a user taking a survey. It is semi-RESTful since it does not have a concrete representation model.
+# Surveyor Controller allows a user to take a survey. It is semi-RESTful since it does not have a concrete representation model.
 # 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'].include?("surveyor_controller")
-  before_filter :extend_actions
-
-  # RESTful authentication
-  if Surveyor::Config['authentication_method']
-    before_filter Surveyor::Config['authentication_method']
-  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
-    @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
-      flash[:notice] = "Unable to find that survey"
-      redirect_to(available_surveys_path)
-    end
-  end
-
-  def show
-    @response_set = ResponseSet.find_by_access_code(params[:response_set_code], :include => {:responses => [:question, :answer]})
-    if @response_set
-      respond_to do |format|
-        format.html #{render :action => :show}
-        format.csv {
-          send_data(@response_set.to_csv, :type => 'text/csv; charset=utf-8; header=present',:filename => "#{@response_set.updated_at.strftime('%Y-%m-%d')}_#{@response_set.access_code}.csv")
-        }
-      end
-    else
-      flash[:notice] = "Unable to find your responses to the survey"
-      redirect_to(available_surveys_path)
-    end
-  end
-
-  def edit
-    @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
-      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
-      flash[:notice] = "Unable to find your responses to the survey"
-      redirect_to(available_surveys_path)
-    end
-  end
-
-  def update
-    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|
-      format.html do
-        if saved && params[:finish]
-          flash[:notice] = "Completed survey"
-          redirect_to surveyor_default(:finish)
-        else
-          flash[:notice] = "Unable to update survey" if !saved #and !saved.nil? # saved.nil? is true if there are no questions on the page (i.e. if it only contains a label)
-          redirect_to :action => "edit", :anchor => anchor_from(params[:section]), :params => {:section => section_id_from(params[:section])}
-        end
-      end
-      # No redirect needed if we're talking to the page via json
-      format.js do
-        render :json => @response_set.all_dependencies.to_json
-      end
-    end
-  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/
-    # http://www.skorks.com/2009/08/how-a-ruby-case-statement-works-and-what-you-can-do-with-it/
-    case arg = Surveyor::Config["default.#{type.to_s}"]
-    when String
-      return arg
-    when Symbol
-      return self.send(arg)
-    else
-      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'].include?("surveyor_controller") && defined? SurveyorControllerExtensions::Actions
-  end
-
-end
+  unloadable
+  include Surveyor::SurveyorControllerMethods
+end

data/app/helpers/surveyor_helper.rb

@@ -1,19 +1,11 @@
 module SurveyorHelper
-
-  # Extending surveyor
-  include SurveyorHelperExtensions if Surveyor::Config['extend'].include?("surveyor_helper")
-    
-  # Configuration
-  def surveyor_config
-    Surveyor::Config
-  end
   
   # Layout: stylsheets and javascripts
   def surveyor_includes
     surveyor_stylsheets + surveyor_javascripts    
   end
   def surveyor_stylsheets
-    stylesheet_link_tag 'surveyor/reset', 'surveyor/surveyor', 'surveyor/ui.theme.css','surveyor/jquery-ui-slider-additions'
+    stylesheet_link_tag 'surveyor/reset', 'surveyor', 'surveyor/ui.theme.css','surveyor/jquery-ui-slider-additions'
   end
   def surveyor_javascripts
     javascript_include_tag 'surveyor/jquery-1.2.6.js', 'surveyor/jquery-ui-personalized-1.5.3.js', 'surveyor/accessibleUISlider.jQuery.js','surveyor/jquery.form.js', 'surveyor/surveyor.js'

data/app/models/answer.rb

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

data/app/models/dependency.rb

@@ -1,8 +1,5 @@
 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,8 +1,5 @@
 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,8 +1,5 @@
 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,8 +1,5 @@
 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,8 +1,5 @@
 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,8 +1,5 @@
 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
@@ -28,12 +25,12 @@ class ResponseSet < ActiveRecord::Base
   
   def default_args
     self.started_at ||= Time.now
-    self.access_code = Surveyor.make_tiny_code
+    self.access_code = Surveyor::Common.make_tiny_code
   end
   
   def access_code=(val)
     while ResponseSet.find_by_access_code(val)
-      val = Surveyor.make_tiny_code
+      val = Surveyor::Common.make_tiny_code
     end
     super
   end

data/app/models/survey.rb

@@ -1,8 +1,5 @@
 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,8 +1,5 @@
 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,9 +1,5 @@
 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,8 +1,5 @@
 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/surveyor/new.html.haml

@@ -1,6 +1,6 @@
 #surveyor
   #header
-    .title= surveyor_config['default.title'] || "You can take these surveys:"
+    .title= @title
   %br
   #survey_list
     %ul

data/config/routes.rb

@@ -1,11 +1,9 @@
 ActionController::Routing::Routes.draw do |map|
-  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
-    s.view_my_survey    "#{root}:survey_code/:response_set_code.:format", :conditions => {:method => :get}, :action => "show", :format => "html"  # GET viewable/printable? survey
-    s.edit_my_survey    "#{root}:survey_code/:response_set_code/take",    :conditions => {:method => :get}, :action => "edit"                     # GET editable survey 
-    s.update_my_survey  "#{root}:survey_code/:response_set_code",         :conditions => {:method => :put}, :action => "update"                   # PUT edited survey 
+    s.available_surveys "surveys",                                        :conditions => {:method => :get}, :action => "new"                      # GET survey list
+    s.take_survey       "surveys/:survey_code",                            :conditions => {:method => :post}, :action => "create"                  # Only POST of survey to create
+    s.view_my_survey    "surveys/:survey_code/:response_set_code.:format", :conditions => {:method => :get}, :action => "show", :format => "html"  # GET viewable/printable? survey
+    s.edit_my_survey    "surveys/:survey_code/:response_set_code/take",    :conditions => {:method => :get}, :action => "edit"                     # GET editable survey 
+    s.update_my_survey  "surveys/:survey_code/:response_set_code",         :conditions => {:method => :put}, :action => "update"                   # PUT edited survey 
   end   
 end

data/features/surveyor.feature

@@ -1,4 +1,4 @@
-Story: Logging in
+Feature: Logging in
   As an anonymous user with an account
   I want to log in to my account
   So that I can be myself

data/generators/extend_surveyor/extend_surveyor_generator.rb

@@ -6,14 +6,13 @@ class ExtendSurveyorGenerator < Rails::Generator::Base
       m.file "EXTENDING_SURVEYOR", "surveys/EXTENDING_SURVEYOR"
           
       # Custom layout
+      m.directory "app/views/layouts"
       m.file "extensions/surveyor_custom.html.erb", "app/views/layouts/surveyor_custom.html.erb"
       
       # Model, helper, and controller extensions
       # http://www.redmine.org/boards/3/topics/4095#message-4136
       # http://blog.mattwynne.net/2009/07/11/rails-tip-use-polymorphism-to-extend-your-controllers-at-runtime/
-      m.file "extensions/survey_extensions.rb", "app/models/survey_extensions.rb" 
-      m.file "extensions/surveyor_helper_extensions.rb", "app/helpers/surveyor_helper_extensions.rb"
-      m.file "extensions/surveyor_controller_extensions.rb", "app/controllers/surveyor_controller_extensions.rb"
+      m.file "extensions/surveyor_controller.rb", "app/controllers/surveyor_controller.rb"
       
       m.readme "EXTENDING_SURVEYOR"
       

data/generators/extend_surveyor/templates/EXTENDING_SURVEYOR

@@ -1,17 +1,37 @@
+== SurveyorController
 
-= Extending Surveyor =
+The SurveyorController class just includes actions from Surveyor::SurveyorControllerMethods module. You may include your own module, and overwrite the methods or add to them using "super". A template for this customization is in your app/controllers/surveyor\_controller.rb. SurveyorController is "unloadable", so changes in development (and any environment that does not cache classes) will be reflected immediately without restarting the app.
 
-* 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.
+== Models
 
-Samples files have been generated at:
+Surveyor's models can all be customized:
 
-* 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:
+- answer
+- dependency_condition
+- dependency
+- question_group
+- question
+- response_set
+- response
+- survey_section
+- survey
+- validation_condition
+- validation
 
-  config['extend'] = %w(survey surveyor_helper surveyor_controller)
-  
+For example, create app/models/survey.rb with the following contents:
+
+    class Survey < ActiveRecord::Base
+      def title
+        "Custom #{super}"
+      end
+    end
+
+== SurveyorHelper
+
+== Views
+
+Surveyor's views can be overwritten by simply creating views in app/views/surveyor
+
+== Layout
+
+Create a custom SurveyorController as above, and specify your custom layout in it.

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

@@ -0,0 +1,39 @@
+module SurveyorControllerCustomMethods
+  def self.included(base)
+    # base.send :before_filter, :require_user   # AuthLogic
+    # base.send :before_filter, :login_required  # Restful Authentication
+    # base.send :layout, 'surveyor_custom'
+  end
+
+  # Actions
+  def new
+    super
+    # @title = "You can take these surveys"
+  end
+  def create
+    super
+  end
+  def show
+    super
+  end
+  def edit
+    super
+  end
+  def update
+    super
+  end
+  
+  # Paths
+  def surveyor_index
+    # most of the above actions redirect to this method
+    super # available_surveys_path
+  end
+  def surveyor_finish
+    # the update action redirects to this method if given params[:finish]
+    super # available_surveys_path
+  end
+end
+class SurveyorController < ApplicationController
+  include Surveyor::SurveyorControllerMethods
+  include SurveyorControllerCustomMethods
+end

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

@@ -10,4 +10,4 @@
   <div id="flash"><%= flash[:notice] %></div>
   <%= yield %>
 </body>
-</html>
+</html>

data/generators/surveyor/surveyor_generator.rb

@@ -16,10 +16,6 @@ class SurveyorGenerator < Rails::Generator::Base
         # http://ggr.com/how-to-include-a-gems-rake-tasks-in-your-rails-app.html
         logger.appended 'Rakefile'
       end
-                  
-      # HAML
-      m.file "initializers/surveyor.rb", "config/initializers/surveyor.rb"
-      m.file "initializers/haml.rb", "config/initializers/haml.rb"
       
       # Migrate 
       # not using m.migration_template because all migration timestamps end up the same, causing a collision when running rake db:migrate
@@ -38,10 +34,6 @@ class SurveyorGenerator < Rails::Generator::Base
         m.template("migrate/#{model}.rb", "db/migrate/#{(prev_migration_timestamp || Time.now.utc.strftime("%Y%m%d%H%M%S").to_i + i).to_s}_#{model}.rb")
       end
       
-      # Generate CSS
-      css_root = File.join(File.dirname(__FILE__), "templates", "assets", "stylesheets")
-      `sass #{css_root}/sass/surveyor.sass #{css_root}/surveyor.css`
-
       # Assets
       ["images", "javascripts", "stylesheets"].each do |asset_type|
         m.directory "public/#{asset_type}/surveyor"
@@ -49,6 +41,8 @@ class SurveyorGenerator < Rails::Generator::Base
           m.file "assets/#{asset_type}/#{filename}", "public/#{asset_type}/surveyor/#{filename}"
         end
       end
+      m.directory "public/stylesheets/sass"
+      m.file "assets/stylesheets/sass/surveyor.sass", "public/stylesheets/sass/surveyor.sass"
       
       # Surveys
       m.directory "surveys/fixtures"

data/lib/surveyor/common.rb

@@ -0,0 +1,24 @@
+module Surveyor
+  class Common
+    RAND_CHARS = [('a'..'z'), ('A'..'Z'), (0..9)].map{|r| r.to_a}.flatten.to_s
+
+    def self.make_tiny_code(len = 10)
+      if RUBY_VERSION < "1.8.7"
+        (1..len).to_a.map{|i| RAND_CHARS[rand(RAND_CHARS.size), 1] }.to_s
+      else
+        len.times.map{|i| RAND_CHARS[rand(RAND_CHARS.size), 1] }.to_s
+      end
+    end
+
+    def self.to_normalized_string(text)
+      words_to_omit = %w(a be but has have in is it of on or the to when)
+      col_text = text.gsub(/(<[^>]*>)|\n|\t/s, ' ') # Remove html tags
+      col_text.downcase!                            # Remove capitalization
+      col_text.gsub!(/\"|\'/, '')                   # Remove potential problem characters
+      col_text.gsub!(/\(.*?\)/,'')                  # Remove text inside parens
+      col_text.gsub!(/\W/, ' ')                     # Remove all other non-word characters      
+      cols = (col_text.split(' ') - words_to_omit)
+      (cols.size > 5 ? cols[-5..-1] : cols).join("_")
+    end
+  end
+end

data/lib/surveyor/surveyor_controller_methods.rb

@@ -0,0 +1,121 @@
+module Surveyor
+  module SurveyorControllerMethods
+    def self.included(base)
+      base.send :before_filter, :get_current_user, :only => [:new, :create]
+      base.send :layout, 'surveyor_default'
+    end
+    
+    # Actions
+    def new
+      @surveys = Survey.find(:all)
+      @title = "You can take these surveys"
+      redirect_to surveyor_index unless surveyor_index == available_surveys_path
+    end
+
+    def create
+      @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
+        flash[:notice] = "Unable to find that survey"
+        redirect_to surveyor_index
+      end
+    end
+
+    def show
+      @response_set = ResponseSet.find_by_access_code(params[:response_set_code], :include => {:responses => [:question, :answer]})
+      if @response_set
+        respond_to do |format|
+          format.html #{render :action => :show}
+          format.csv {
+            send_data(@response_set.to_csv, :type => 'text/csv; charset=utf-8; header=present',:filename => "#{@response_set.updated_at.strftime('%Y-%m-%d')}_#{@response_set.access_code}.csv")
+          }
+        end
+      else
+        flash[:notice] = "Unable to find your responses to the survey"
+        redirect_to surveyor_index
+      end
+    end
+
+    def edit
+      @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
+        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
+        flash[:notice] = "Unable to find your responses to the survey"
+        redirect_to surveyor_index
+      end
+    end
+
+    def update
+      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|
+        format.html do
+          if saved && params[:finish]
+            flash[:notice] = "Completed survey"
+            redirect_to surveyor_finish
+          else
+            flash[:notice] = "Unable to update survey" if !saved #and !saved.nil? # saved.nil? is true if there are no questions on the page (i.e. if it only contains a label)
+            redirect_to :action => "edit", :anchor => anchor_from(params[:section]), :params => {:section => section_id_from(params[:section])}
+          end
+        end
+        # No redirect needed if we're talking to the page via json
+        format.js do
+          render :json => @response_set.all_dependencies.to_json
+        end
+      end
+    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
+
+    def surveyor_index
+      available_surveys_path
+    end
+    def surveyor_finish
+      available_surveys_path
+    end
+  end
+end

data/lib/tasks/surveyor_tasks.rake

@@ -31,3 +31,17 @@ namespace :surveyor do
   end
 
 end
+
+namespace :spec do
+  namespace :plugins do
+    begin
+      require 'spec/rake/spectask'
+      desc "Runs the examples for surveyor"    
+      Spec::Rake::SpecTask.new(:surveyor) do |t|
+        t.spec_opts = ['--options', "\"#{RAILS_ROOT}/spec/spec.opts\""]
+        t.spec_files = FileList['vendor/plugins/surveyor/spec/**/*_spec.rb']
+      end
+    rescue MissingSourceFile
+    end
+  end  
+end

data/surveyor.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{surveyor}
-  s.version = "0.12.1"
+  s.version = "0.13.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-08-19}
+  s.date = %q{2010-08-23}
   s.email = %q{yoon@northwestern.edu}
   s.extra_rdoc_files = [
     "README.md"
@@ -49,10 +49,8 @@ Gem::Specification.new do |s|
      "features/surveyor.feature",
      "generators/extend_surveyor/extend_surveyor_generator.rb",
      "generators/extend_surveyor/templates/EXTENDING_SURVEYOR",
-     "generators/extend_surveyor/templates/extensions/survey_extensions.rb",
-     "generators/extend_surveyor/templates/extensions/surveyor_controller_extensions.rb",
+     "generators/extend_surveyor/templates/extensions/surveyor_controller.rb",
      "generators/extend_surveyor/templates/extensions/surveyor_custom.html.erb",
-     "generators/extend_surveyor/templates/extensions/surveyor_helper_extensions.rb",
      "generators/surveyor/surveyor_generator.rb",
      "generators/surveyor/templates/README",
      "generators/surveyor/templates/assets/images/222222_11x11_icon_arrows_leftright.gif",
@@ -105,10 +103,7 @@ Gem::Specification.new do |s|
      "generators/surveyor/templates/assets/stylesheets/jquery-ui-slider-additions.css",
      "generators/surveyor/templates/assets/stylesheets/reset.css",
      "generators/surveyor/templates/assets/stylesheets/sass/surveyor.sass",
-     "generators/surveyor/templates/assets/stylesheets/surveyor.css",
      "generators/surveyor/templates/assets/stylesheets/ui.theme.css",
-     "generators/surveyor/templates/initializers/haml.rb",
-     "generators/surveyor/templates/initializers/surveyor.rb",
      "generators/surveyor/templates/migrate/add_correct_answer_id_to_questions.rb",
      "generators/surveyor/templates/migrate/add_display_order_to_surveys.rb",
      "generators/surveyor/templates/migrate/add_index_to_response_sets.rb",
@@ -135,7 +130,9 @@ Gem::Specification.new do |s|
      "lib/fixtures_extensions.rb",
      "lib/surveyor.rb",
      "lib/surveyor/acts_as_response.rb",
+     "lib/surveyor/common.rb",
      "lib/surveyor/config.rb",
+     "lib/surveyor/surveyor_controller_methods.rb",
      "lib/tasks/surveyor_tasks.rake",
      "lib/xml_formatter.rb",
      "rails/init.rb",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: surveyor
 version: !ruby/object:Gem::Version 
-  hash: 45
+  hash: 43
   prerelease: false
   segments: 
   - 0
-  - 12
-  - 1
-  version: 0.12.1
+  - 13
+  - 0
+  version: 0.13.0
 platform: ruby
 authors: 
 - Brian Chamberlain
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-19 00:00:00 -05:00
+date: 2010-08-23 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -90,10 +90,8 @@ files:
 - features/surveyor.feature
 - generators/extend_surveyor/extend_surveyor_generator.rb
 - generators/extend_surveyor/templates/EXTENDING_SURVEYOR
-- generators/extend_surveyor/templates/extensions/survey_extensions.rb
-- generators/extend_surveyor/templates/extensions/surveyor_controller_extensions.rb
+- generators/extend_surveyor/templates/extensions/surveyor_controller.rb
 - generators/extend_surveyor/templates/extensions/surveyor_custom.html.erb
-- generators/extend_surveyor/templates/extensions/surveyor_helper_extensions.rb
 - generators/surveyor/surveyor_generator.rb
 - generators/surveyor/templates/README
 - generators/surveyor/templates/assets/images/222222_11x11_icon_arrows_leftright.gif
@@ -146,10 +144,7 @@ files:
 - generators/surveyor/templates/assets/stylesheets/jquery-ui-slider-additions.css
 - generators/surveyor/templates/assets/stylesheets/reset.css
 - generators/surveyor/templates/assets/stylesheets/sass/surveyor.sass
-- generators/surveyor/templates/assets/stylesheets/surveyor.css
 - generators/surveyor/templates/assets/stylesheets/ui.theme.css
-- generators/surveyor/templates/initializers/haml.rb
-- generators/surveyor/templates/initializers/surveyor.rb
 - generators/surveyor/templates/migrate/add_correct_answer_id_to_questions.rb
 - generators/surveyor/templates/migrate/add_display_order_to_surveys.rb
 - generators/surveyor/templates/migrate/add_index_to_response_sets.rb
@@ -176,7 +171,9 @@ files:
 - lib/fixtures_extensions.rb
 - lib/surveyor.rb
 - lib/surveyor/acts_as_response.rb
+- lib/surveyor/common.rb
 - lib/surveyor/config.rb
+- lib/surveyor/surveyor_controller_methods.rb
 - lib/tasks/surveyor_tasks.rake
 - lib/xml_formatter.rb
 - rails/init.rb

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

@@ -1,24 +0,0 @@
-module SurveyExtensions
-  def self.included(base)
-    base.extend(ClassMethods)
-    base.send(:include, InstanceMethods)
-    base.class_eval do
-      # Same as typing in the class
-      
-    end
-  end
-  
-  module ClassMethods
-  end
-  
-  module InstanceMethods
-    # def title
-    #   foo
-    # end
-    # def foo
-    #   "bar"
-    # end
-  end
-end
-
-# 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

@@ -1,28 +0,0 @@
-module SurveyorControllerExtensions
-  def self.included(base)
-    base.extend(ClassMethods)
-    base.send(:include, InstanceMethods)
-    base.class_eval do
-      # Same as typing in the class
-      # before_filter :pimp_my_ride
-    end
-  end
-  
-  module ClassMethods
-  end
-  
-  module InstanceMethods
-    # def pimp_my_ride
-    #   flash[:notice] = "pimped!"
-    # end
-  end
-  
-  module Actions
-    # Redefine the controller actions [index, new, create, show, update] here
-    # def new
-    #   render :text =>"surveys are down"
-    # end
-  end
-end
-
-# Add "surveyor_controller" to config['extend'] array in config/initializers/surveyor.rb to activate these extensions

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

@@ -1,17 +0,0 @@
-module SurveyorHelperExtensions
-  def self.included(base) # :nodoc:
-    base.send(:include, InstanceMethods)
-    base.class_eval do
-      # Same as typing in the module
-      # alias_method_chain :question_number_helper, :sauce
-    end
-  end
-  
-  module InstanceMethods
-    # def question_number_helper_with_sauce(number)
-    #   question_number_helper_without_sauce(number) + "Extra sauce"
-    # end
-  end
-end
-
-# Add "surveyor_helper" to config['extend'] array in config/initializers/surveyor.rb to activate these extensions

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

@@ -1,230 +0,0 @@
-body {
-  background-color: #dcdcdc;
-  font-family: Helvetica;
-  word-spacing: normal;
-  text-align: left;
-  letter-spacing: 0;
-  line-height: 1.1em;
-  font-size: 1em; }
-
-#flash {
-  background-color: transparent;
-  color: red;
-  width: 98%;
-  position: absolute;
-  top: 0;
-  left: 0;
-  z-index: 1000;
-  text-align: center; }
-
-#surveyor {
-  width: 960px;
-  padding: 1em;
-  margin: 0 auto;
-  background-color: #fffff4;
-  color: #213e00; }
-  #surveyor #survey_list ul {
-    padding-left: 2em;
-    margin-top: -2em; }
-  #surveyor #menu {
-    width: 11.9em;
-    margin: 0.65em -1em 0 0;
-    float: right; }
-    #surveyor #menu ul {
-      padding: 0;
-      margin: 0;
-      list-style-type: none;
-      border-style: solid;
-      border-width: 1px;
-      border-color: #bcbcbc;
-      border-bottom-width: 0;
-      border-right-width: 0;
-      background-color: #dcdcdc;
-      color: #666666; }
-      #surveyor #menu ul li {
-        border-bottom-style: solid;
-        border-bottom-width: 1px;
-        border-color: #bcbcbc; }
-      #surveyor #menu ul li.active, #surveyor #menu ul li.active input[type="submit"] {
-        background-color: #ebebcc;
-        color: #262626; }
-  #surveyor #header {
-    font-family: "Century Gothic";
-    padding: 0.5em 1em 1em 0.3em;
-    margin: 0;
-    font-size: 2em;
-    font-weight: bolid; }
-  #surveyor .previous_section {
-    font-size: 0.8em;
-    margin: -0.6em 0 0.5em -1em;
-    padding: 0; }
-    #surveyor .previous_section input {
-      background-color: #fffff4; }
-  #surveyor .next_section {
-    float: right;
-    margin: -2em 1em 0 0; }
-  #surveyor .survey_section {
-    margin: 0.5em 0.5em 0.5em -1em;
-    padding: 0.5em 0 0 0; }
-    #surveyor .survey_section .title {
-      font-weight: bold;
-      font-size: 1.2em;
-      margin: 0;
-      padding: 0.3em 0.5em 0.1em 1.4em;
-      background-color: #ebebcc; }
-  #surveyor p {
-    padding: 0.3em;
-    margin: 0.5em;
-    margin: 0.55em; }
-  #surveyor input[type="submit"] {
-    font-size: 1.0em;
-    border: 0px;
-    padding: 0.2em;
-    margin: 0.2em;
-    cursor: pointer;
-    background-color: #dcdcdc;
-    color: #464646; }
-  #surveyor input[type="text"], #surveyor textarea {
-    border: 2px inset #333;
-    border-color: #bcbcbc;
-    background-color: #fafafa;
-    padding: 0.1em;
-    margin: 0.1em;
-    font-size: 0.8em; }
-  #surveyor .disabled {
-    color: #dfdfd4; }
-    #surveyor .disabled input[type="text"], #surveyor .disabled textarea {
-      background-color: #efefe4; }
-  #surveyor input[type="submit"].add_row {
-    padding: 0.1em;
-    margin: 0em;
-    margin-left: -1em;
-    font-size: 0.7em;
-    border: 1px solid #333;
-    border-color: #bcbcbc; }
-  #surveyor .questions {
-    margin: 0;
-    padding: 1em 0.3em; }
-  #surveyor .question {
-    margin: 0 0 0.6em 0;
-    padding: 0.2em; }
-    #surveyor .question legend {
-      width: 940px;
-      white-space: normal; }
-      #surveyor .question legend span {
-        display: block; }
-    #surveyor .question .number {
-      padding: 0.2em;
-      font-weight: bold;
-      font-size: 1.2em;
-      letter-spacing: 0;
-      float: left; }
-    #surveyor .question .text {
-      padding-top: 0.2em;
-      font-size: 1.1em;
-      line-height: 1.2em; }
-    #surveyor .question .help {
-      font-size: 0.8em;
-      font-style: italic;
-      color: black;
-      display: none; }
-  #surveyor ol.answers {
-    list-style-type: none;
-    padding: 0.2em;
-    margin: 0 0 0.3em 1.5em; }
-    #surveyor ol.answers li.answer {
-      margin: 0.2em; }
-  #surveyor ol.answers_inline {
-    margin-left: 1.8em;
-    list-style-type: none; }
-    #surveyor ol.answers_inline li {
-      display: inline;
-      padding-right: 1.5em; }
-  #surveyor .label {
-    padding: 0.5em 1em;
-    margin: 0.5em 1em;
-    line-height: 1.4em; }
-  #surveyor #dependents {
-    background-color: #dfdfd4; }
-    #surveyor #dependents .title {
-      padding: 0.5em;
-      font-weight: bold; }
-  #surveyor .dependent {
-    background-color: #dfdfd4;
-    margin-left: 1.2em; }
-  #surveyor .hidden {
-    display: none; }
-  #surveyor .column_highlight {
-    background-color: #efefe4; }
-  #surveyor table.grid {
-    margin: 0.5em 0.2em 0.5em 1em; }
-    #surveyor table.grid th, #surveyor table.grid td {
-      padding: 0.2em 0.5em;
-      text-align: center; }
-    #surveyor table.grid td {
-      border-bottom: 2px dotted #999;
-      border-color: #bfbfb4; }
-    #surveyor table.grid th.question_prefix, #surveyor table.grid th.question_postfix {
-      padding: 0.2em 0.5em;
-      text-align: left;
-      padding: 0.2em; }
-  #surveyor .question_group {
-    margin: 0 0 0.6em 0;
-    padding: 0.2em 0.2em 1em 0.2em; }
-    #surveyor .question_group .head {
-      padding-bottom: 0.5em; }
-      #surveyor .question_group .head .number {
-        padding: 0.2em;
-        font-weight: bold;
-        font-size: 1.2em;
-        letter-spacing: 0;
-        float: left; }
-      #surveyor .question_group .head .text {
-        padding-top: 0.2em;
-        font-size: 1.1em;
-        line-height: 1.2em; }
-      #surveyor .question_group .head .help {
-        font-size: 0.8em;
-        font-style: italic;
-        color: black; }
-    #surveyor .question_group ul {
-      padding: 0.3em;
-      list-style-type: none; }
-      #surveyor .question_group ul li {
-        display: inline; }
-        #surveyor .question_group ul li .question {
-          display: inline; }
-          #surveyor .question_group ul li .question ol.answers {
-            display: inline;
-            margin: 0.2em; }
-    #surveyor .question_group ul.repeater {
-      list-style-type: none; }
-    #surveyor .question_group li.repeater {
-      display: block;
-      clear: left; }
-      #surveyor .question_group li.repeater .question {
-        float: left; }
-      #surveyor .question_group li.repeater ol {
-        margin: 0;
-        padding: 0; }
-      #surveyor .question_group li.repeater .question {
-        padding-left: 1.2em; }
-  #surveyor .inline {
-    display: inline; }
-  #surveyor .group_questions {
-    margin: 0.5em 0.2em 0.5em 1em; }
-    #surveyor .group_questions .question {
-      margin: 0;
-      padding: 0em 0.3em; }
-    #surveyor .group_questions .text {
-      font-size: 0.9em; }
-    #surveyor .group_questions .help {
-      font-size: 0.7em;
-      font-style: italic;
-      color: black; }
-    #surveyor .group_questions .number {
-      padding: 0.2em;
-      margin: 0 0 0.3em 0;
-      font-weight: bold;
-      font-size: 1em;
-      letter-spacing: 0; }

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

@@ -1,8 +0,0 @@
-begin
-  require File.join(File.dirname(__FILE__), 'lib', 'haml') # From here
-rescue LoadError
-  require 'haml' # From gem
-end
-
-# Load Haml and Sass
-Haml.init_rails(binding)

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

@@ -1,10 +0,0 @@
-# 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"
-  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'] = %w() # %w(survey surveyor_helper surveyor_controller)
-end