affectiva-surveyor 1.5.0.pre.disco.2

data/lib/surveyor/unparser.rb

@@ -0,0 +1,147 @@
+%w(survey survey_section question_group question dependency dependency_condition answer validation validation_condition).each {|model| require model }
+module Surveyor
+  class Unparser
+    # Class methods
+    def self.unparse(survey)
+      survey.unparse(dsl = "")
+      dsl
+    end
+  end
+end
+
+# Surveyor models with extra parsing methods
+class Survey < ActiveRecord::Base
+  # block
+
+  def unparse(dsl)
+    attrs = (self.attributes.diff Survey.new(:title => title).attributes).delete_if{|k,v| %w(created_at updated_at inactive_at id title access_code api_id).include? k}.symbolize_keys!
+    dsl << "survey \"#{title}\""
+    dsl << (attrs.blank? ? " do\n" : ", #{attrs.inspect.gsub(/\{|\}/, "")} do\n")
+    sections.each{|section| section.unparse(dsl)}
+    dsl << "end\n"
+  end
+end
+class SurveySection < ActiveRecord::Base
+  # block
+
+  def unparse(dsl)
+    attrs = (self.attributes.diff SurveySection.new(:title => title).attributes).delete_if{|k,v| %w(created_at updated_at id survey_id).include? k}.symbolize_keys!
+    group_questions = []
+    dsl << "  section \"#{title}\""
+    dsl << (attrs.blank? ? " do\n" : ", #{attrs.inspect.gsub(/\{|\}/, "")} do\n")
+    questions.each_with_index do |question, index|
+      if question.solo?
+        question.unparse(dsl)
+      else # gather up the group questions
+        group_questions << question
+        if (index + 1 >= questions.size) or (question.question_group != questions[index + 1].question_group)
+          # this is the last question of the section, or the group
+          question.question_group.unparse(dsl)
+        end
+        group_questions = []
+      end
+    end
+    dsl << "  end\n"
+  end
+end
+class QuestionGroup < ActiveRecord::Base
+  # block
+
+  def unparse(dsl)
+    attrs = (self.attributes.diff QuestionGroup.new(:text => text).attributes).delete_if{|k,v| %w(created_at updated_at id api_id).include?(k) or (k == "display_type" && %w(grid repeater default).include?(v))}.symbolize_keys!
+    method = (%w(grid repeater).include?(display_type) ? display_type : "group")
+    dsl << "\n"
+    dsl << "    #{method} \"#{text}\""
+    dsl << (attrs.blank? ? " do\n" : ", #{attrs.inspect.gsub(/\{|\}/, "")} do\n")
+    questions.first.answers.each{|answer| answer.unparse(dsl)} if display_type == "grid"
+    questions.each{|question| question.unparse(dsl)}
+    dsl << "    end\n"
+  end
+end
+class Question < ActiveRecord::Base
+  # nonblock
+
+  def unparse(dsl)
+    attrs = (self.attributes.diff Question.new(:text => text).attributes).delete_if{|k,v| %w(created_at updated_at reference_identifier id survey_section_id question_group_id api_id).include?(k) or (k == "display_type" && v == "label")}.symbolize_keys!
+    dsl << (solo? ? "\n" : "  ")
+    if display_type == "label"
+      dsl << "    label"
+    else
+      dsl << "    q"
+    end
+    dsl << "_#{reference_identifier}" unless reference_identifier.blank?
+    dsl << " \"#{text}\""
+    dsl << (attrs.blank? ? "\n" : ", #{attrs.inspect.gsub(/\{|\}/, "")}\n")
+    if solo? or question_group.display_type != "grid"
+      answers.each{|answer| answer.unparse(dsl)}
+    end
+    dependency.unparse(dsl) if dependency
+  end
+end
+class Dependency < ActiveRecord::Base
+  # nonblock
+
+  def unparse(dsl)
+    attrs = (self.attributes.diff Dependency.new.attributes).delete_if{|k,v| %w(created_at updated_at id question_id).include?(k) }.symbolize_keys!
+    dsl << "  " if question.part_of_group?
+    dsl << "    dependency"
+    dsl << (attrs.blank? ? "\n" : " #{attrs.inspect.gsub(/\{|\}/, "")}\n")
+    dependency_conditions.each{|dependency_condition| dependency_condition.unparse(dsl)}
+  end
+end
+class DependencyCondition < ActiveRecord::Base
+  # nonblock
+
+  def unparse(dsl)
+    attrs = (self.attributes.diff Dependency.new.attributes).delete_if{|k,v| %w(created_at updated_at question_id question_group_id rule_key rule operator id dependency_id answer_id).include? k}.symbolize_keys!
+    dsl << "  " if dependency.question.part_of_group?
+    dsl << "    condition"
+    dsl << "_#{rule_key}" unless rule_key.blank?
+    dsl << " :q_#{question.reference_identifier}, \"#{operator}\""
+    dsl << (attrs.blank? ? ", {:answer_reference=>\"#{answer && answer.reference_identifier}\"}\n" : ", {#{attrs.inspect.gsub(/\{|\}/, "")}, :answer_reference=>\"#{answer && answer.reference_identifier}\"}\n")
+  end  
+end
+class Answer < ActiveRecord::Base
+  # nonblock
+
+  def unparse(dsl)
+    attrs = (self.attributes.diff Answer.new(:text => text).attributes).delete_if{|k,v| %w(created_at updated_at reference_identifier response_class id question_id api_id).include? k}.symbolize_keys!
+    attrs.delete(:is_exclusive) if text == "Omit" && is_exclusive == true
+    attrs.merge!({:is_exclusive => false}) if text == "Omit" && is_exclusive == false
+    dsl << "  " if question.part_of_group?
+    dsl << "    a"
+    dsl << "_#{reference_identifier}" unless reference_identifier.blank?
+    if response_class.to_s.titlecase == text && attrs == {:display_type => "hidden_label"}
+      dsl << " :#{response_class}"
+    else    
+      dsl << [ text.blank? ? nil : text == "Other" ? " :other" : text == "Omit" ? " :omit" : " \"#{text}\"",
+                (response_class.blank? or response_class == "answer") ? nil : " #{response_class.to_sym.inspect}",
+                attrs.blank? ? nil : " #{attrs.inspect.gsub(/\{|\}/, "")}\n"].compact.join(",")
+    end
+    dsl << "\n"
+    validations.each{|validation| validation.unparse(dsl)}
+  end
+end
+class Validation < ActiveRecord::Base
+  # nonblock
+
+  def unparse(dsl)
+    attrs = (self.attributes.diff Validation.new.attributes).delete_if{|k,v| %w(created_at updated_at id answer_id).include?(k) }.symbolize_keys!
+    dsl << "  " if answer.question.part_of_group?
+    dsl << "    validation"
+    dsl << (attrs.blank? ? "\n" : " #{attrs.inspect.gsub(/\{|\}/, "")}\n")
+    validation_conditions.each{|validation_condition| validation_condition.unparse(dsl)}
+  end
+end
+class ValidationCondition < ActiveRecord::Base
+  # nonblock
+
+  def unparse(dsl)
+    attrs = (self.attributes.diff ValidationCondition.new.attributes).delete_if{|k,v| %w(created_at updated_at operator rule_key id validation_id).include? k}.symbolize_keys!
+    dsl << "  " if validation.answer.question.part_of_group?
+    dsl << "    condition"
+    dsl << "_#{rule_key}" unless rule_key.blank?
+    dsl << " \"#{operator}\""
+    dsl << (attrs.blank? ? "\n" : ", #{attrs.inspect.gsub(/\{|\}/, "")}\n")
+  end
+end

data/lib/surveyor/version.rb

@@ -0,0 +1,3 @@
+module Surveyor
+  VERSION = '1.5.0-disco.2'
+end

data/lib/tasks/surveyor_tasks.rake

@@ -0,0 +1,88 @@
+desc "generate and load survey (specify FILE=surveys/your_survey.rb)"
+task :surveyor => :"surveyor:parse"
+
+namespace :surveyor do
+  task :parse => :environment do
+    raise "USAGE: file name required e.g. 'FILE=surveys/kitchen_sink_survey.rb'" if ENV["FILE"].blank?
+    file = File.join(Rails.root, ENV["FILE"])
+    raise "File does not exist: #{file}" unless FileTest.exists?(file)
+    puts "--- Parsing #{file} ---"
+    Surveyor::Parser.parse_file(file, {:trace => Rake.application.options.trace})
+    puts "--- Done #{file} ---"
+  end
+  desc "generate and load survey from REDCap Data Dictionary (specify FILE=surveys/redcap.csv)"
+  task :redcap => :environment do
+    raise "USAGE: file name required e.g. 'FILE=surveys/redcap_demo_survey.csv'" if ENV["FILE"].blank?
+    file = File.join(Rails.root, ENV["FILE"])
+    raise "File does not exist: #{file}" unless FileTest.exists?(file)
+    puts "--- Parsing #{file} ---"
+    Surveyor::RedcapParser.parse File.read(file), File.basename(file, ".csv"), {:trace => Rake.application.options.trace}
+    puts "--- Done #{file} ---"
+  end
+  desc "generate a surveyor DSL file from a survey"
+  task :unparse => :environment do
+    surveys = Survey.all
+    if surveys
+      puts "The following surveys are available"
+      surveys.each do |survey|
+        puts "#{survey.id} #{survey.title}"
+      end
+      print "Which survey would you like to unparse? "
+      id = $stdin.gets.to_i
+      if survey_to_unparse = surveys.detect{|s| s.id == id}
+        filename = "surveys/#{survey_to_unparse.access_code}_#{Date.today.to_s(:db)}.rb"
+        puts "unparsing #{survey_to_unparse.title} to #{filename}"
+        File.open(filename, 'w') {|f| f.write(Surveyor::Unparser.unparse(survey_to_unparse))}
+      else
+        puts "not found"
+      end
+    else
+      puts "There are no surveys available"
+    end
+  end
+  desc "remove surveys (that don't have response sets)"
+  task :remove => :environment do
+    surveys = Survey.all.delete_if{|s| !s.response_sets.blank?}
+    if surveys
+      puts "The following surveys do not have any response sets"
+      surveys.each do |survey|
+        puts "#{survey.id} #{survey.title}"
+      end
+      print "Which survey would you like to remove? "
+      id = $stdin.gets.to_i
+      if survey_to_delete = surveys.detect{|s| s.id == id}
+        puts "removing #{survey_to_delete.title}"
+        survey_to_delete.destroy
+      else
+        put "not found"
+      end
+    else
+      puts "There are no surveys without response sets"
+    end
+  end
+  desc "dump all responses to a given survey"
+  task :dump => :environment do
+    require 'fileutils.rb'
+    survey_version = ENV["SURVEY_VERSION"]
+    access_code = ENV["SURVEY_ACCESS_CODE"]
+
+    raise "USAGE: rake surveyor:dump SURVEY_ACCESS_CODE=<access_code> [OUTPUT_DIR=<dir>] [SURVEY_VERSION=<survey_version>]" unless access_code
+    params_string = "code #{access_code}"
+
+    surveys = Survey.where(:access_code => access_code).order("survey_version ASC")
+    if survey_version.blank?
+      survey = surveys.last
+    else
+      params_string += " and survey_version #{survey_version}"
+      survey = surveys.where(:survey_version => survey_version).first
+    end
+
+    raise "No Survey found with #{params_string}" unless survey
+    dir = ENV["OUTPUT_DIR"] || Rails.root
+    mkpath(dir) # Create all non-existent directories
+    full_path = File.join(dir,"#{survey.access_code}_v#{survey.survey_version}_#{Time.now.to_i}.csv")
+    File.open(full_path, 'w') do |f|
+      survey.response_sets.each_with_index{|r,i| f.write(r.to_csv(true, i == 0)) } # print access code every time, print_header first time
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'surveyor'

data/spec/controllers/surveyor_controller_spec.rb

@@ -0,0 +1,311 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SurveyorController do
+  include Surveyor::Engine.routes.url_helpers
+  before do
+    @routes = Surveyor::Engine.routes
+  end
+
+  let!(:survey)           { FactoryGirl.create(:survey, :title => "Alphabet", :access_code => "alpha", :survey_version => 0)}
+  let!(:survey_beta)      { FactoryGirl.create(:survey, :title => "Alphabet", :access_code => "alpha", :survey_version => 1)}
+  let!(:response_set)      { FactoryGirl.create(:response_set, :survey => survey, :access_code => "pdq")}
+  let!(:response_set_beta) { FactoryGirl.create(:response_set, :survey => survey_beta, :access_code => "rst")}
+  before { ResponseSet.stub(:create).and_return(response_set) }
+
+  # match '/', :to                                     => 'surveyor#new', :as    => 'available_surveys', :via => :get
+  # match '/:survey_code', :to                         => 'surveyor#create', :as => 'take_survey', :via       => :post
+  # match '/:survey_code', :to                         => 'surveyor#export', :as => 'export_survey', :via     => :get
+  # match '/:survey_code/:response_set_code', :to      => 'surveyor#show', :as   => 'view_my_survey', :via    => :get
+  # match '/:survey_code/:response_set_code/take', :to => 'surveyor#edit', :as   => 'edit_my_survey', :via    => :get
+  # match '/:survey_code/:response_set_code', :to      => 'surveyor#update', :as => 'update_my_survey', :via  => :put
+
+  context "#new" do
+    def do_get
+      get :new
+    end
+    it "renders new" do
+      do_get
+      response.should be_success
+      response.should render_template('new')
+    end
+    it "assigns surveys_by_access_code" do
+      do_get
+      assigns(:surveys_by_access_code).should == {"alpha" => [survey_beta,survey]}
+    end
+  end
+
+  context "#create" do
+    def do_post(params = {})
+      post :create, {:survey_code => "alpha"}.merge(params)
+    end
+    it "finds latest version" do
+      do_post
+      assigns(:survey).should == survey_beta
+    end
+    it "finds specified survey_version" do
+      do_post :survey_version => 0
+      assigns(:survey).should == survey
+    end
+    it "creates a new response_set" do
+      ResponseSet.should_receive(:create)
+      do_post
+    end
+    it "should redirects to the new response_set" do
+      do_post
+      response.should redirect_to( edit_my_survey_path(:survey_code => "alpha", :response_set_code  => "pdq"))
+    end
+
+    context "with failures" do
+      it "redirect to #new on failed ResponseSet#create" do
+        ResponseSet.should_receive(:create).and_return(false)
+        do_post
+        response.should redirect_to(available_surveys_path)
+      end
+      it "redirect to #new on failed Survey#find" do
+        do_post :survey_code => "missing"
+        response.should redirect_to(available_surveys_path)
+      end
+    end
+
+    context "with javascript check, assigned in session" do
+      it "enabled" do
+        do_post :surveyor_javascript_enabled => "true"
+        session[:surveyor_javascript].should_not be_nil
+        session[:surveyor_javascript].should == "enabled"
+      end
+      it "disabled" do
+        post :create, :survey_code => "xyz", :surveyor_javascript_enabled => "not_true"
+        session[:surveyor_javascript].should_not be_nil
+        session[:surveyor_javascript].should == "not_enabled"
+      end
+    end
+  end
+
+  context "#show" do
+    def do_get(params = {})
+      get :show, {:survey_code => "alpha", :response_set_code => "pdq"}.merge(params)
+    end
+    it "renders show" do
+      do_get
+      response.should be_success
+      response.should render_template('show')
+    end
+    it "finds ResponseSet with includes" do
+      ResponseSet.should_receive(:includes).with(:responses => [:question, :answer]).and_return(response_set)
+      response_set.should_receive(:find_by).with(:access_code => "pdq").and_return(response_set)
+      do_get
+    end
+    it "redirects for missing response set" do
+      do_get :response_set_code => "DIFFERENT"
+      response.should redirect_to(available_surveys_path)
+    end
+    it "assigns earlier survey_version" do
+      response_set
+      do_get
+      assigns[:response_set].should == response_set
+      assigns[:survey].should == survey
+    end
+    it "assigns later survey_version" do
+      response_set_beta
+      do_get :response_set_code => "rst"
+      assigns[:response_set].should == response_set_beta
+      assigns[:survey].should == survey_beta
+    end
+  end
+
+  context "#edit" do
+    def do_get(params = {})
+      survey.sections = [FactoryGirl.create(:survey_section, :survey => survey)]
+      get :edit, {:survey_code => "alpha", :response_set_code => "pdq"}.merge(params)
+    end
+    it "renders edit" do
+      do_get
+      response.should be_success
+      response.should render_template('edit')
+    end
+    it "assigns survey and response set" do
+      do_get
+      assigns[:survey].should == survey
+      assigns[:response_set].should == response_set
+    end
+    it "redirects for missing response set" do
+      do_get :response_set_code => "DIFFERENT"
+      response.should redirect_to(available_surveys_path)
+    end
+    it "assigns dependents if javascript not enabled" do
+      controller.stub(:get_unanswered_dependencies_minus_section_questions).and_return([FactoryGirl.create(:question)])
+      session[:surveyor_javascript].should be_nil
+      do_get
+      assigns[:dependents].should_not be_empty
+    end
+    it "does not assign dependents if javascript is enabled" do
+      controller.stub(:get_unanswered_dependencies_minus_section_questions).and_return([FactoryGirl.create(:question)])
+      session[:surveyor_javascript] = "enabled"
+      do_get
+      assigns[:dependents].should be_empty
+    end
+    it "assigns earlier survey_version" do
+      do_get
+      assigns[:response_set].should == response_set
+      assigns[:survey].should == survey
+    end
+    it "assigns later survey_version" do
+      survey_beta.sections = [FactoryGirl.create(:survey_section, :survey => survey_beta)]
+      do_get :response_set_code => "rst"
+      assigns[:survey].should == survey_beta
+      assigns[:response_set].should == response_set_beta
+
+    end
+  end
+
+  context "#update" do
+    let(:responses_ui_hash) { {} }
+    let(:update_params) {
+      {
+        :survey_code => "alpha",
+        :response_set_code => "pdq"
+      }
+    }
+    shared_examples "#update action" do
+      before do
+        ResponseSet.stub(:includes).and_return(response_set)
+        response_set.stub(:find_by).and_return(response_set)
+        responses_ui_hash['11'] = {'api_id' => 'something', 'answer_id' => '56', 'question_id' => '9'}
+      end
+      it "finds a response set" do
+        ResponseSet.should_receive(:includes).and_return(response_set)
+        response_set.should_receive(:find_by).and_return(response_set)
+        do_put
+      end
+      it "saves responses" do
+        response_set.should_receive(:update_from_ui_hash).with(responses_ui_hash)
+
+        do_put(:r => responses_ui_hash)
+      end
+      it "does not fail when there are no responses" do
+        lambda { do_put }.should_not raise_error
+      end
+      context "with update exceptions" do
+        it 'retries the update on a constraint violation' do
+ response_set.should_receive(:update_from_ui_hash).ordered.with(responses_ui_hash).and_raise(ActiveRecord::StatementInvalid.new('statement invalid'))
+          response_set.should_receive(:update_from_ui_hash).ordered.with(responses_ui_hash)
+
+          expect { do_put(:r => responses_ui_hash) }.to_not raise_error
+        end
+
+        it 'only retries three times' do
+          response_set.should_receive(:update_from_ui_hash).exactly(3).times.with(responses_ui_hash).and_raise(ActiveRecord::StatementInvalid.new('statement invalid'))
+
+          expect { do_put(:r => responses_ui_hash) }.to raise_error(ActiveRecord::StatementInvalid)
+        end
+
+        it 'does not retry for other errors' do
+          response_set.should_receive(:update_from_ui_hash).once.with(responses_ui_hash).and_raise('Bad news')
+
+          expect { do_put(:r => responses_ui_hash) }.to raise_error('Bad news')
+        end
+      end
+    end
+
+    context "with form submission" do
+      def do_put(extra_params = {})
+        put :update, update_params.merge(extra_params)
+      end
+
+      it_behaves_like "#update action"
+      it "redirects to #edit without params" do
+        do_put
+        response.should redirect_to(edit_my_survey_path(:survey_code => "alpha", :response_set_code => "pdq"))
+      end
+      it "completes the found response set on finish" do
+        do_put :finish => 'finish'
+        response_set.reload.should be_complete
+      end
+      it 'flashes completion' do
+        do_put :finish => 'finish'
+        flash[:notice].should == "Completed survey"
+      end
+      it "redirects for missing response set" do
+        do_put :response_set_code => "DIFFERENT"
+        response.should redirect_to(available_surveys_path)
+        flash[:notice].should == "Unable to find your responses to the survey"
+      end
+    end
+
+    context 'with ajax' do
+      def do_put(extra_params = {})
+        xhr :put, :update, update_params.merge(extra_params)
+      end
+
+      it_behaves_like "#update action"
+      it "returns dependencies" do
+        ResponseSet.should_receive(:includes).and_return(response_set)
+        response_set.should_receive(:find_by).and_return(response_set)
+        response_set.should_receive(:all_dependencies).and_return({"show" => ['q_1'], "hide" => ['q_2']})
+
+        do_put
+        JSON.parse(response.body).should == {"show" => ['q_1'], "hide" => ["q_2"]}
+      end
+      it "returns 404 for missing response set" do
+        do_put :response_set_code => "DIFFERENT"
+        response.status.should == 404
+      end
+    end
+  end
+
+  context "#export" do
+    render_views
+
+    let(:json) {
+      get :export, :survey_code => survey.access_code, :format => 'json'
+      JSON.parse(response.body)
+    }
+
+    context "question inside and outside a question group" do
+      def question_text(refid)
+        <<-SURVEY
+          q "Where is a foo?", :pick => :one, :help_text => 'Look around.', :reference_identifier => #{refid.inspect},
+            :data_export_identifier => 'X.FOO', :common_namespace => 'F', :common_identifier => 'f'
+          a_L 'To the left', :data_export_identifier => 'X.L', :common_namespace => 'F', :common_identifier => 'l'
+          a_R 'To the right', :data_export_identifier => 'X.R', :common_namespace => 'F', :common_identifier => 'r'
+          a_O 'Elsewhere', :string
+
+          dependency :rule => 'R'
+          condition_R :q_bar, "==", :a_1
+        SURVEY
+      end
+      let(:survey_text) {
+        <<-SURVEY
+          survey 'xyz' do
+            section 'Sole' do
+              q_bar "Should that other question show up?", :pick => :one
+              a_1 'Yes'
+              a_2 'No'
+
+              #{question_text('foo_solo')}
+
+              group do
+                #{question_text('foo_grouped')}
+              end
+            end
+          end
+        SURVEY
+      }
+      let(:survey) { Surveyor::Parser.new.parse(survey_text) }
+      let(:solo_question_json)    { json['sections'][0]['questions_and_groups'][1] }
+      let(:grouped_question_json) { json['sections'][0]['questions_and_groups'][2]['questions'][0] }
+
+      it "produces identical JSON except for API IDs and question reference identifers" do
+        solo_question_json['answers'].to_json.should be_json_eql( grouped_question_json['answers'].to_json).excluding("uuid", "reference_identifier")
+        solo_question_json['dependency'].to_json.should be_json_eql( grouped_question_json['dependency'].to_json).excluding("uuid", "reference_identifier")
+        solo_question_json.to_json.should be_json_eql( grouped_question_json.to_json).excluding("uuid", "reference_identifier")
+      end
+      it "produces the expected reference identifier for the solo question" do
+        solo_question_json['reference_identifier'].should == 'foo_solo'
+      end
+      it "produces the expected reference identifer for the question in the group" do
+        grouped_question_json['reference_identifier'].should == 'foo_grouped'
+      end
+    end
+  end
+end