breakpointer-surveyor 0.2.0

data/app/controllers/sections_controller.rb

@@ -0,0 +1,87 @@
+class SectionsController < ApplicationController
+  
+  # GET /sections
+   # GET /sections.xml
+   def index
+     @sections = SurveySection.find(:all)
+
+     respond_to do |format|
+       format.html # index.html.erb
+       format.xml  { render :xml => @sections }
+     end
+   end
+
+   # GET /sections/1
+   # GET /sections/1.xml
+   def show
+     @section = SurveySection.find(params[:id])
+
+     respond_to do |format|
+       format.html # show.html.erb
+       format.xml  { render :xml => @section.to_xml(:include => :questions) }
+     end
+   end
+
+   # GET /sections/new
+   # GET /sections/new.xml
+   def new
+     @section = SurveySection.new
+
+     respond_to do |format|
+       format.html # new.html.erb
+       format.xml  { render :xml => @section }
+     end
+   end
+
+   # GET /sections/1/edit
+   def edit
+     @section = SurveySection.find(params[:id])
+   end
+
+   # POST /sections
+   # POST /sections.xml
+   def create
+     @section = SurveySection.new(params[:section])
+
+     respond_to do |format|
+       if @section.save
+         flash[:notice] = 'Section was successfully created.'
+         format.html { redirect_to(@section) }
+         format.xml  { render :xml => @section, :status => :created, :location => @section }
+       else
+         format.html { render :action => "new" }
+         format.xml  { render :xml => @section.errors, :status => :unprocessable_entity }
+       end
+     end
+   end
+
+   # PUT /sections/1
+   # PUT /sections/1.xml
+   def update
+     @section = SurveySection.find(params[:id])
+
+     respond_to do |format|
+       if @section.update_attributes(params[:section])
+         flash[:notice] = 'Section was successfully updated.'
+         format.html { redirect_to(@section) }
+         format.xml  { head :ok }
+       else
+         format.html { render :action => "edit" }
+         format.xml  { render :xml => @section.errors, :status => :unprocessable_entity }
+       end
+     end
+   end
+
+   # DELETE /sections/1
+   # DELETE /sections/1.xml
+   def destroy
+     @section = SurveySection.find(params[:id])
+     @section.destroy
+
+     respond_to do |format|
+       format.html { redirect_to(sections_url) }
+       format.xml  { head :ok }
+     end
+   end
+  
+end

data/app/controllers/surveying_controller.rb

@@ -0,0 +1,139 @@
+
+# The Surveying controller handles the process of a user taking a survey.
+# It is semi-restful since it does not have a concrete representation model.
+# The "resource" could be considered a survey attempt or survey session.
+# It is actually the union of a user filling out a survey and populating a response set.
+
+class SurveyingController < ActionController::Base
+  layout 'layouts/surveys'
+  
+  include UserManager
+  include SurveyingHelper
+  before_filter :current_user
+  before_filter :get_response_set, :except => [:new, :create]
+
+  def index
+    @surveys = Survey.find(:all) 
+  end
+
+  def new
+    @surveys = Survey.find(:all)
+    respond_to do |format|
+      format.html # new.html.erb
+      # format.xml  { render :xml => @surveys }
+    end
+  end
+
+  def create
+    @survey = Survey.find_by_access_code(params[:survey_code])
+    unless @survey
+      flash[:notice] = "Unable to find that survey"
+      redirect_to(available_surveys_path)
+    else
+      @response_set = ResponseSet.new(:survey => @survey, :user_id => 123)
+      respond_to do |format|
+        if @response_set.save!
+          flash[:notice] = 'Survey was successfully created.'
+          format.html { redirect_to(edit_my_survey_path(:survey_code => @survey.access_code, :response_set_code  => @response_set.access_code)) }
+          # format.xml  { render :xml => @response_set, :status => :created, :location => @response_set }
+        else
+          format.html { redirect_to(available_surveys_path)}
+          # format.xml  { render :xml => @response_set.errors, :status => :unprocessable_entity }
+        end
+      end
+    end
+  end
+
+  def show
+    respond_to do |format|
+      format.html # show.html.erb
+      # format.xml  { render :xml => @survey}
+    end
+  end
+
+  def edit
+    # Checking from the questions on the page (which are in the response hash) if there are any dependent questions to show
+    dependent_hash = dependents(@response_set)
+    @dependents = dependent_hash[:show]
+    respond_to do |format|
+      format.html do
+        render
+      end
+      format.json do
+        render :json => {:show => dependent_hash[:show].map{|q| question_id_helper(q)}, :hide => dependent_hash[:hide].map{|q| question_id_helper(q)} }.to_json
+      end
+    end
+  end
+
+  def update
+    if params[:responses] or params[:response_groups]
+      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
+    end
+    respond_to do |format|
+      format.html do
+        flash[:notice] = saved ? "Updated survey" : "Unable to update survey" unless saved.nil? # Saved is nil if there are no questions on the page (ie if it only contains a label)
+        redirect_to :action => "edit", :anchor => @anchor, :params => {:section => @section.id}
+      end
+      # No redirect needed if we're talking to the page via json
+      format.json do
+          dependent_hash = dependents(@response_set)
+          @dependents = dependent_hash[:show]
+          render :json => {:show => dependent_hash[:show].map{|q| question_id_helper(q)}, :hide => dependent_hash[:hide].map{|q| question_id_helper(q)} }.to_json
+      end
+    end
+
+  end
+  
+
+  def finish
+    respond_to do |format|
+      format.html do
+        flash[:notice] = @response_set.complete! ? "Completed survey" : "Unable to complete survey"
+        render :action => 'edit'
+      end
+    end
+  end
+
+  private
+  # Returns the dependent questions that need to be answered based on the current progress of the response set
+  # it also returns the dependent questions that need to be hidden
+  def dependents(response_set)
+    show = []
+    hide = []
+    question_ids = response_set.responses.map(&:question_id).uniq # returning a list of all answered questions (only the ids)
+    dependencies = DependencyCondition.find_all_by_question_id(question_ids).map(&:dependency).uniq
+    dependencies.each do |dep|
+      if dep.met?(response_set) and response_set.has_not_answered_question?(dep.question)
+        show << dep.question
+      else
+        hide << dep.question
+      end
+    end
+    {:show => show, :hide => hide}
+  end
+  
+
+
+  def get_response_set
+    @response_set = ResponseSet.find_by_access_code(params[:response_set_code])
+    if @response_set 
+      @survey = @response_set.survey
+      found = nil
+      @anchor = nil
+      unless params[:section].nil?
+        # The section to display is passed to us either in the url of a GET request or form params in a POST request
+        # Defaulting to look at the posted form params first, then as a url param.
+        section_id = (params[:section].respond_to?(:keys))? params[:section].keys.first.split("_").first.to_i : params[:section]
+        found = @survey.sections.find_by_id(section_id)
+        @anchor = (params[:section].respond_to?(:keys) and params[:section].keys.first.split("_").size > 1)? params[:section].keys.first.split("_").last : nil
+        
+      end
+      
+      @section = found || @survey.sections.first
+      @dependents = []
+    else
+      flash[:notice] = "Unable to find your responses to the survey"
+      redirect_to(available_surveys_path)
+    end
+  end
+end

data/app/controllers/surveys_controller.rb

@@ -0,0 +1,87 @@
+class SurveysController < ApplicationController
+  
+  # GET /surveys
+   # GET /surveys.xml
+   def index
+     @surveys = Survey.find(:all)
+
+     respond_to do |format|
+       format.html # index.html.erb
+       format.xml  { render :xml => @surveys }
+     end
+   end
+
+   # GET /surveys/1
+   # GET /surveys/1.xml
+   def show
+     @survey = Survey.find(params[:id])
+
+     respond_to do |format|
+       format.html # show.html.erb
+       format.xml  { render :xml => @survey.to_xml(:include => :sections) }
+     end
+   end
+
+   # GET /surveys/new
+   # GET /surveys/new.xml
+   def new
+     @survey = Survey.new
+
+     respond_to do |format|
+       format.html # new.html.haml
+       format.xml  { render :xml => @survey }
+     end
+   end
+
+   # GET /surveys/1/edit
+   def edit
+     @survey = Survey.find(params[:id])
+   end
+
+   # POST /surveys
+   # POST /surveys.xml
+   def create
+     @survey = Survey.new(params[:survey])
+
+     respond_to do |format|
+       if @survey.save
+         flash[:notice] = 'Survey was successfully created.'
+         format.html { redirect_to(@survey) }
+         format.xml  { render :xml => @survey, :status => :created, :location => @survey }
+       else
+         format.html { render :action => "new" }
+         format.xml  { render :xml => @survey.errors, :status => :unprocessable_entity }
+       end
+     end
+   end
+
+   # PUT /surveys/1
+   # PUT /surveys/1.xml
+   def update
+     @survey = Survey.find(params[:id])
+
+     respond_to do |format|
+       if @survey.update_attributes(params[:survey])
+         flash[:notice] = 'Survey was successfully updated.'
+         format.html { redirect_to(@survey) }
+         format.xml  { head :ok }
+       else
+         format.html { render :action => "edit" }
+         format.xml  { render :xml => @survey.errors, :status => :unprocessable_entity }
+       end
+     end
+   end
+
+   # DELETE /surveys/1
+   # DELETE /surveys/1.xml
+   def destroy
+     @survey = Survey.find(params[:id])
+     @survey.destroy
+
+     respond_to do |format|
+       format.html { redirect_to(surveys_url) }
+       format.xml  { head :ok }
+     end
+   end
+  
+end

data/app/helpers/answers_helper.rb

@@ -0,0 +1,2 @@
+module AnswersHelper
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/app/helpers/questions_helper.rb

@@ -0,0 +1,2 @@
+module QuestionsHelper
+end

data/app/helpers/sections_helper.rb

@@ -0,0 +1,2 @@
+module SectionsHelper
+end

data/app/helpers/survey_form_builder.rb

@@ -0,0 +1,38 @@
+class SurveyFormBuilder < ActionView::Helpers::FormBuilder 
+  def survey_check_box(method, options = {}, checked_value = "1", unchecked_value = "0")
+    fields = @template.survey_check_box(@object_name, method, options.merge(:object => @object), checked_value, unchecked_value)
+    fields[1]
+  end
+end
+  
+module ActionView
+  module Helpers
+    module FormHelper
+      def survey_check_box(object_name, method, options = {}, checked_value = "1", unchecked_value = "0")
+        if (Rails::VERSION::STRING.to_f > 2.1)
+          InstanceTag.new(object_name, method, self, options.delete(:object)).to_survey_check_box_tag(options, checked_value, unchecked_value)
+        else
+          InstanceTag.new(object_name, method, self, nil, options.delete(:object)).to_survey_check_box_tag(options, checked_value, unchecked_value)
+        end
+      end
+    end
+
+    class InstanceTag
+    
+      def to_survey_check_box_tag(options = {}, checked_value = "1", unchecked_value = "0")
+        options = options.stringify_keys
+        options["type"]     = "checkbox"
+        options["value"]    = checked_value
+        if options.has_key?("checked")
+          cv = options.delete "checked"
+          checked = cv == true || cv == "checked"
+        else
+          checked = self.class.check_box_checked?(value(object), checked_value)
+        end
+        options["checked"] = "checked" if checked
+        add_default_name_and_id(options)
+        [tag("input", "name" => options["name"], "type" => "hidden", "value" => unchecked_value), tag("input", options)]
+      end
+    end
+  end
+end

data/app/helpers/survey_importer_helper.rb

@@ -0,0 +1,2 @@
+module SurveyImporterHelper
+end

data/app/helpers/surveying_helper.rb

@@ -0,0 +1,91 @@
+module SurveyingHelper
+
+  # Formats the question number the way we want, or not at all if number is nil
+  def question_number_helper(number)
+    if number
+      "#{number}<span style='padding-left:0.1em;'>)</span>" 
+    else
+      ""
+    end
+  end
+
+  # splits the question text using the delimiter
+  # parts before the delim. go before the input element, parts after the delim. go after the input element
+  def question_text_prefix_helper(question_text = "")
+    splits = question_text.split("|")
+    unless splits[0].empty?
+      splits[0] 
+    else
+      "&nbsp;"
+    end      
+  end
+  
+  # Parts of the question that go after the input element
+  def question_text_postfix_helper(question_text = "")
+    splits = question_text.split("|")
+    if splits.size > 1
+      splits[1] 
+    else
+      "&nbsp;"
+    end
+  end
+
+  alias_method :answer_text_prefix_helper, :question_text_prefix_helper
+  alias_method :answer_text_postfix_helper, :question_text_postfix_helper
+  
+  def section_id_helper(section)
+    "section_#{section.id}"
+  end
+
+  def question_id_helper(question)
+    "question_#{question.id}"
+  end
+
+  def answer_id_helper(answer)
+    "answer_id_#{answer.id}"
+  end
+
+  def question_help_helper(question)
+    question.help_text.blank? ? "" : %Q(<span class="question-help">#{question.help_text}</span>)
+  end
+
+  def fields_for_response(response, &block)
+    fields_for("responses[#{response.question_id}][#{response.answer_id}]", response, :builder => SurveyFormBuilder, &block)
+  end
+  
+  # Changes the response hash to accept response groups for repeater elements
+  def fields_for_repeater_response(response, response_group, &block)
+    fields_for("response_groups[#{response.question_id}][#{response_group}][#{response.answer_id}]", response, :builder => SurveyFormBuilder, &block)
+  end
+  
+  def fields_for_radio(response, &block)
+    fields_for("responses[#{response.question_id}]", response, :builder => SurveyFormBuilder, &block)
+  end
+
+  def section_submit_helper(section)
+    submit_tag(section.title, :name => section_submit_name_helper(section))
+  end
+
+  def section_next_helper(section)
+    submit_tag("Next section &gt;&gt;", :name => section_submit_name_helper(section))
+  end
+
+  def section_previous_helper(section)
+    submit_tag("&lt;&lt; Previous section", :name => section_submit_name_helper(section))
+  end
+
+  def section_submit_name_helper(section, anchor_id = nil)
+    "section[#{section.id}#{(anchor_id)? "_#{anchor_id}" : ""}]"
+  end
+  
+  # Attempts to explain why this dependent question needs to be answered by referenced the dependent question and users response
+  def dependency_explanation_helper(question,response_set)
+    trigger_responses = []
+    dependent_questions = Question.find_all_by_id(question.dependency.dependency_conditions.map(&:question_id)).uniq
+    response_set.responses.find_all_by_question_id(dependent_questions.map(&:id)).uniq.each do |resp|
+      trigger_responses << resp.to_s
+    end
+    "&nbsp;&nbsp;You answered &quot;#{trigger_responses.join("&quot; and &quot;")}&quot; to the question &quot;#{dependent_questions.map(&:text).join("&quot;,&quot;")}&quot;"
+  end
+  
+end