affectiva-surveyor 1.5.0.pre.disco.2

data/spec/factories.rb

@@ -0,0 +1,166 @@
+# encoding: utf-8
+# http://github.com/thoughtbot/factory_girl/tree/master
+require 'rubygems'
+require 'factory_girl'
+
+FactoryGirl.define do
+  
+  sequence(:unique_survey_access_code){|n| "simple survey #{UUIDTools::UUID.random_create.to_s}" }
+  
+  factory :survey do |s|
+    s.title           "Simple survey"
+    s.description     "A simple survey for testing"
+    s.access_code     { FactoryGirl.generate :unique_survey_access_code }
+    s.survey_version  0
+  end
+
+
+  factory :survey_translation do |t|
+    t.locale "es"
+    t.translation %(title: "Un idioma nunca es suficiente"
+  survey_sections:
+    one:
+      title: "Uno"
+  questions:
+    hello:
+      text: "¡Hola!"
+    name:
+      text: "¿Cómo se llama Usted?"
+      answers:
+        name:
+          help_text: "Mi nombre es...")
+  end
+
+  sequence(:survey_section_display_order){|n| n }
+
+  factory :survey_section do |s|
+    s.association               :survey # s.survey_id                 {}
+    s.title                     {"Demographics"}
+    s.description               {"Asking you about your personal data"}
+    s.display_order             {FactoryGirl.generate :survey_section_display_order}
+    s.reference_identifier      {"demographics"}
+    s.data_export_identifier    {"demographics"}
+  end
+
+  sequence(:question_display_order){|n| n }
+
+  factory :question do |q|
+    q.association             :survey_section  # s.survey_section_id       {}
+    # q.question_group_id       {}
+    q.text                    "What is your favorite color?"
+    q.short_text              "favorite_color"
+    q.help_text               "just write it in the box"
+    q.pick                    :none
+    q.reference_identifier    {|me| "q_#{me.object_id}"}
+    # q.data_export_identifier  {}
+    # q.common_namespace        {}
+    # q.common_identifier       {}
+    q.display_order           FactoryGirl.generate(:question_display_order)
+    # q.display_type            {} # nil is default
+    q.is_mandatory            false
+    # q.display_width           {}
+    q.correct_answer_id       nil
+  end
+
+  factory :question_group do |g|
+    g.text                    {"Describe your family"}
+    g.help_text               {}
+    g.reference_identifier    {|me| "g_#{me.object_id}"}
+    g.data_export_identifier  {}
+    g.common_namespace        {}
+    g.common_identifier       {}
+    g.display_type            {}
+    g.custom_class            {}
+    g.custom_renderer         {}
+  end
+
+  sequence(:answer_display_order){|n| n }
+
+  factory :answer do |a|
+    a.association               :question  # a.question_id               {}
+    a.text                      "My favorite color is clear"
+    a.short_text                "clear"
+    a.help_text                 "Clear is the absense of color"
+    # a.weight
+    a.response_class            "string"
+    # a.reference_identifier      {}
+    # a.data_export_identifier    {}
+    # a.common_namespace          {}
+    # a.common_identifier         {}
+    a.display_order             {FactoryGirl.generate :answer_display_order}
+    # a.is_exclusive              {}
+    a.display_type              "default"
+    # a.display_length            {}
+    # a.custom_class              {}
+    # a.custom_renderer           {}
+  end
+
+  factory :dependency do |d|
+    # the dependent question
+    d.association       :question # d.question_id       {}
+    d.question_group_id {}
+    d.rule              {"A"}
+  end
+
+  factory :dependency_condition do |d|
+    d.association       :dependency # d.dependency_id    {}
+    d.rule_key          {"A"}
+    # the conditional question
+    d.question_id       {}
+    d.operator          {"=="}
+    d.answer_id         {}
+    d.datetime_value    {}
+    d.integer_value     {}
+    d.float_value       {}
+    d.unit              {}
+    d.text_value        {}
+    d.string_value      {}
+    d.response_other    {}
+  end
+
+  factory :response_set do |r|
+    r.user_id         {}
+    r.association     :survey # r.survey_id       {}
+    r.access_code     {Surveyor::Common.make_tiny_code}
+    r.started_at      {Time.now}
+    r.completed_at    {}
+  end
+
+  factory :response do |r|
+    r.association       :response_set # r.response_set_id   {}
+    r.survey_section_id {}
+    r.question_id       {}
+    r.answer_id         {}
+    r.datetime_value    {}
+    r.integer_value     {}
+    r.float_value       {}
+    r.unit              {}
+    r.text_value        {}
+    r.string_value      {}
+    r.response_other    {}
+    r.response_group    {}
+  end
+
+  factory :validation do |v|
+    v.association       :answer # v.answer_id         {}
+    v.rule              {"A"}
+    v.message           {}
+  end
+
+  factory :validation_condition do |v|
+    v.association       :validation # v.validation_id     {}
+    v.rule_key          {"A"}
+    v.question_id       {}
+    v.operator          {"=="}
+    v.answer_id         {}
+    v.datetime_value    {}
+    v.integer_value     {}
+    v.float_value       {}
+    v.unit              {}
+    v.text_value        {}
+    v.string_value      {}
+    v.response_other    {}
+    v.regexp            {}
+  end
+
+end

data/spec/helpers/formtastic_custom_input_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../../lib/surveyor/helpers/formtastic_custom_input')
+
+describe Surveyor::Helpers::FormtasticCustomInput do
+  context "input helpers" do
+    it "should translate response class into attribute" do
+      helper.response_class_to_method(:string).should == :string_value
+      helper.response_class_to_method(:integer).should == :integer_value
+      helper.response_class_to_method(:float).should == :float_value
+      helper.response_class_to_method(:datetime).should == :datetime_value
+      helper.response_class_to_method(:date).should == :date_value
+      helper.response_class_to_method(:time).should == :time_value
+    end
+  end
+end

data/spec/helpers/surveyor_helper_spec.rb

@@ -0,0 +1,117 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SurveyorHelper do
+  context "numbering" do
+    before do
+      ActionController::Base.helpers.config.assets_dir = "public" unless asset_pipeline_enabled?
+    end
+    it "should return the question text with number, except for labels, dependencies, images, and grouped questions" do
+      q1 = FactoryGirl.create(:question)
+      q2 = FactoryGirl.create(:question, :display_type => "label")
+      q3 = FactoryGirl.create(:question, :dependency => FactoryGirl.create(:dependency))
+      q4 = FactoryGirl.create(:question, :display_type => "image", :text => "something.jpg")
+      q5 = FactoryGirl.create(:question, :question_group => FactoryGirl.create(:question_group))
+      helper.q_text(q1).should == "<span class='qnum'>1) </span>#{q1.text}"
+      helper.q_text(q2).should == q2.text
+      helper.q_text(q3).should == q3.text
+      helper.q_text(q4).should == %Q(<img alt="Something" src="/images/something.jpg" />)
+      helper.q_text(q5).should == q5.text
+    end
+  end
+
+  context "with mustache text substitution" do
+    require 'mustache'
+    let(:mustache_context){ Class.new(::Mustache){ def site; "Northwestern"; end; def somethingElse; "something new"; end; def group; "NUBIC"; end } }
+    it "substitues values into Question#text" do
+      q1 = FactoryGirl.create(:question, :text => "You are in {{site}}")
+      label = FactoryGirl.create(:question, :display_type => "label", :text => "Testing {{somethingElse}}")
+      helper.q_text(q1, mustache_context).should == "<span class='qnum'>1) </span>You are in Northwestern"
+      helper.q_text(label, mustache_context).should == "Testing something new"
+    end
+  end
+
+  context "response methods" do
+    it "should find or create responses, with index" do
+      q1 = FactoryGirl.create(:question, :answers => [a = FactoryGirl.create(:answer, :text => "different")])
+      q2 = FactoryGirl.create(:question, :answers => [b = FactoryGirl.create(:answer, :text => "strokes")])
+      q3 = FactoryGirl.create(:question, :answers => [c = FactoryGirl.create(:answer, :text => "folks")])
+      rs = FactoryGirl.create(:response_set, :responses => [r1 = FactoryGirl.create(:response, :question => q1, :answer => a), r3 = FactoryGirl.create(:response, :question => q3, :answer => c, :response_group => 1)])
+
+      helper.response_for(rs, nil).should == nil
+      helper.response_for(nil, q1).should == nil
+      helper.response_for(rs, q1).should == r1
+      helper.response_for(rs, q1, a).should == r1
+      helper.response_for(rs, q2).attributes.reject{|k,v| k == "api_id"}.should == Response.new(:question => q2, :response_set => rs).attributes.reject{|k,v| k == "api_id"}
+      helper.response_for(rs, q2, b).attributes.reject{|k,v| k == "api_id"}.should == Response.new(:question => q2, :response_set => rs).attributes.reject{|k,v| k == "api_id"}
+      helper.response_for(rs, q3, c, "1").should == r3
+
+    end
+    it "should keep an index of responses" do
+      helper.response_idx.should == "1"
+      helper.response_idx.should == "2"
+      helper.response_idx(false).should == "2"
+      helper.response_idx.should == "3"
+    end
+    it "should translate response class into attribute" do
+      helper.rc_to_attr(:string).should == :string_value
+      helper.rc_to_attr(:text).should == :text_value
+      helper.rc_to_attr(:integer).should == :integer_value
+      helper.rc_to_attr(:float).should == :float_value
+      helper.rc_to_attr(:datetime).should == :datetime_value
+      helper.rc_to_attr(:date).should == :date_value
+      helper.rc_to_attr(:time).should == :time_value
+    end
+
+    it "should translate response class into as" do
+      helper.rc_to_as(:string).should == :string
+      helper.rc_to_as(:text).should == :text
+      helper.rc_to_as(:integer).should == :string
+      helper.rc_to_as(:float).should == :string
+      helper.rc_to_as(:datetime).should == :string
+      helper.rc_to_as(:date).should == :string
+      helper.rc_to_as(:time).should == :string
+    end
+  end
+
+  context "overriding methods" do
+    before do
+      module SurveyorHelper
+        include Surveyor::Helpers::SurveyorHelperMethods
+        alias :old_rc_to_as :rc_to_as
+        def rc_to_as(type_sym)
+          case type_sym.to_s
+          when /(integer|float)/ then :string
+          when /(datetime)/ then :datetime
+          else type_sym
+          end
+        end
+      end
+    end
+    it "should translate response class into as" do
+      helper.rc_to_as(:string).should == :string
+      helper.rc_to_as(:text).should == :text
+      helper.rc_to_as(:integer).should == :string
+      helper.rc_to_as(:float).should == :string
+      helper.rc_to_as(:datetime).should == :datetime  # not string
+      helper.rc_to_as(:date).should == :date          # not string
+      helper.rc_to_as(:time).should == :time
+    end
+    after do
+      module SurveyorHelper
+        include Surveyor::Helpers::SurveyorHelperMethods
+        def rc_to_as(type_sym)
+          old_rc_to_as(type_sym)
+        end
+      end
+    end
+  end
+
+  # run this context after 'overriding methods'
+  context "post override test" do
+    # Sanity check
+    it "should translate response class into as after override" do
+      helper.rc_to_as(:datetime).should == :string  # back to string
+      helper.rc_to_as(:date).should == :string      # back to string
+    end
+  end
+end

data/spec/lib/benchmark_spec.rb

@@ -0,0 +1,22 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Surveyor do
+  it "should write thousands of response sets" do
+    Surveyor::Parser.parse(File.read(File.join(Rails.root, 'surveys', 'kitchen_sink_survey.rb')))
+    survey = Survey.last
+    rs = ResponseSet.create(:survey => survey)
+    survey.sections.each{|s| s.questions.each{|q| rs.responses.create(:question => q, :answer => q.answers.first)}}
+    Benchmark.bm 20 do |x|
+      x.report "a test" do
+        full_path = File.join(Rails.root,"#{survey.access_code}_#{Time.now.to_i}.csv")
+        File.open(full_path, 'w') do |f|
+          100.times do # adjust this to test
+            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
+    end
+  end
+end
+
+

data/spec/lib/chinese_survey.rb

@@ -0,0 +1,14 @@
+survey "青少年人际关系问卷", :access_code => "青少年人际关系问卷" do
+  section "Basic questions" do
+    grid "第二部分：以下列出了一些描述。请您根据自己的实际情况作答。如果“非常不像我”，请选“1”，如果“非常像我”，请选“5”，以此类推。" do
+      a "1"
+      a "2"
+      a "3"
+      a "4"
+      a "5"
+      q "我常常想出新的有趣的点子", :pick => :one
+      q "我比同龄的其他孩子更有想象力", :pick => :one
+      q "即使一个人独处，我也不会觉得无聊", :pick => :one
+    end
+  end
+end

data/spec/lib/common_spec.rb

@@ -0,0 +1,34 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Surveyor::Common, "" do
+  it "should convert text to a code that is more appropirate for a database entry" do
+    # A few answers from the survey
+    { "This? is a in - t3rrible-@nswer of! (question) on" => "this_t3rrible_nswer",
+      "Private insurance/ HMO/ PPO" => "private_insurance_hmo_ppo",
+      "<bold>VA</bold>" => "va",
+      "PMS (Premenstrual syndrome)/ PMDD (Premenstrual Dysphoric Disorder)" => "pms_pmdd",
+      "Have never been employed outside the home" => "never_been_employed_outside_home",
+      "Professional" => "professional",
+      "Not working because of temporary disability, but expect to return to a job" => "temporary_disability_expect_return_job",
+      "How long has it been since you last visited a doctor for a routine checkup (routine being not for a particular reason)?" => "visited_doctor_for_routine_checkup",
+      "Do you take medications as directed?" => "you_take_medications_as_directed",
+      "Do you every leak urine (or) water when you didn't want to?" => "urine_water_you_didnt_want", #checking for () and ' removal
+      "Do your biological family members (not adopted) have a \"history\" of any of the following?" => "family_members_history_any_following",
+      "Your health:" => "your_health",
+      "In general, you would say your health is:" => "you_would_say_your_health"
+    }.each{|k, v| Surveyor::Common.to_normalized_string(k).should == v}
+  end
+  describe '#generate_api_id' do
+    def generate
+      Surveyor::Common.generate_api_id
+    end
+
+    it 'generates a String' do
+      generate.should be_a String
+    end
+
+    it 'generates a new value every time' do
+      (1..100).collect { generate }.uniq.size.should == 100
+    end
+  end
+end

data/spec/lib/parser_spec.rb

@@ -0,0 +1,204 @@
+# -*- coding: utf-8 -*-
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Surveyor::Parser do
+  let(:parser){ Surveyor::Parser.new }
+  it "should translate shortcuts into full model names" do
+    parser.send(:full, "section").should == "survey_section"
+    parser.send(:full, "g").should == "question_group"
+    parser.send(:full, "repeater").should == "question_group"
+    parser.send(:full, "label").should == "question"
+    parser.send(:full, "vc").should == "validation_condition"
+    parser.send(:full, "vcondition").should == "validation_condition"
+  end
+  it "should translate 'condition' based on context" do
+    parser.send(:full, "condition").should == "dependency_condition"
+    parser.send(:full, "c").should == "dependency_condition"
+    parser.context[:validation] = Validation.new
+    parser.send(:full, "condition").should == "validation_condition"
+    parser.send(:full, "c").should == "validation_condition"
+    parser.context[:validation] = nil
+    parser.send(:full, "condition").should == "dependency_condition"
+    parser.send(:full, "c").should == "dependency_condition"
+  end
+  it "should not translate bad shortcuts" do
+    parser.send(:full, "quack").should == "quack"
+    parser.send(:full, "grizzly").should == "grizzly"
+  end
+  it "should identify models that take blocks" do
+    parser.send(:block_models).should == %w(survey survey_section question_group)
+  end
+  it "should return a survey object" do
+    Surveyor::Parser.new.parse("survey 'hi' do\n end").is_a?(Survey).should be_true
+  end
+  describe 'reference checking' do
+    it 'accepts Answer#reference_identifier via underscore or hash syntax' do
+      survey_text = <<END
+  survey "Numbers" do
+    section_one "One" do
+      q_1 "Select a number", :pick => :one
+      a "One", {:reference_identifier => "1"}
+      a_2 "Two"
+      a_3 "Three"
+
+      label_2 "One is the loneliest number..."
+      dependency :rule => "A"
+      condition_A :q_1, "==", {:answer_reference => "1"}
+
+      label_3 "Two can be as bad as one..."
+      dependency :rule => "A"
+      condition_A :q_1, "==", {:answer_reference => "2"}
+
+      label_4 "that you'll ever do"
+      dependency :rule => "A"
+      condition_A :q_1, "==", :a_1
+
+      label_5 "it's the loneliest number since the number one"
+      dependency :rule => "A"
+      condition_A :q_1, "==", :a_2
+    end
+  end
+END
+      survey = Surveyor::Parser.new.parse(survey_text)
+      survey.is_a?(Survey).should == true
+    end
+
+  end
+
+  describe 'translations' do
+
+    it 'should produce the survey text for :default locale' do
+      survey_text = <<END
+  survey "One language is never enough" do
+   translations :en => :default, :es =>{'questions' => {'name' =>{ 'text' => '¡Hola!'}}}
+    section_one "One" do
+      label_name "Hello!"
+    end
+  end
+END
+      survey = Surveyor::Parser.new.parse(survey_text)
+      survey.is_a?(Survey).should == true
+      survey.translations.size.should == 2
+      question = survey.sections.first.questions.first
+      question.translation(:en)[:text].should == "Hello!"
+      question.translation(:es)[:text].should == "¡Hola!"
+    end
+
+
+    it 'should raise an error w/o :default locale' do
+      survey_text = <<END
+  survey "One language is never enough" do
+   translations :es =>{'questions' => {'name' =>{ 'text' => '¡Hola!'}}}
+    section_one "One" do
+      label_name "Hello!"
+    end
+  end
+END
+      s = Survey.all.size
+      expect {survey = Surveyor::Parser.new.parse(survey_text)}.to raise_error
+      Survey.all.size.should == s
+    end
+
+
+    it 'should allow multiple default locales' do
+      survey_text = <<END
+  survey "Just don't talk about tyres" do
+   translations :'en-US' => :default, :'en-GB' => :default, :es =>{'questions' => {'name' =>{'text' => '¡Hola!'}}}
+   section_one "One" do
+     label_name "Hello!"
+   end
+  end
+END
+
+      survey = Surveyor::Parser.new.parse(survey_text)
+      survey.is_a?(Survey).should == true
+      survey.translations.size.should == 3
+      question = survey.sections.first.questions.first
+      question.translation(:'en-US')[:text].should == "Hello!"
+      question.translation(:'en-GB')[:text].should == "Hello!"
+      question.translation(:es)[:text].should == "¡Hola!"
+    end
+
+    context 'when a translation is specified as a Hash' do
+      it 'should should treat the hash as an inline translation' do
+        survey_text = <<END
+survey "One language is never enough" do
+      translations :en => :default, :es => {"title"=>"Un idioma nunca es suficiente", "survey_sections"=>{"one"=>{"title"=>"Uno"}}, "question_groups"=>{"hello"=>{"text"=>"¡Hola!"}}, "questions"=>{"name"=>{"text"=>"¿Cómo se llama Usted?", "answers"=>{"name"=>{"help_text"=>"Mi nombre es..."}}}}}
+      section_one "One" do
+        g_hello "Hello" do
+          q_name "What is your name?"
+          a_name :string, :help_text => "My name is..."
+        end
+      end
+    end
+END
+        survey = Surveyor::Parser.new.parse(survey_text)
+        survey.is_a?(Survey).should == true
+        survey.translations.size.should == 2
+        survey.translation(:es)['title'].should == "Un idioma nunca es suficiente"
+      end
+    end
+
+    context 'when a translation is specified as a String' do
+
+      context 'when the survey filename is not given' do
+        it 'should look for the translation file relative to pwd' do
+          Dir.mktmpdir do |dir|
+            FileUtils.cd(dir) do
+              translation_yaml = YAML::dump({'title' => 'Un idioma nunca es suficiente'})
+              translation_temp_file = Tempfile.new('parser_spec_translation.yml',dir)
+              translation_temp_file.write(translation_yaml)
+              translation_temp_file.flush
+              survey_text = <<END
+survey "One language is never enough" do
+      translations :es =>'#{File.basename(translation_temp_file.path)}', :en => :default
+      section_one "One" do
+        g_hello "Hello" do
+          q_name "What is your name?"
+          a_name :string, :help_text => "My name is..."
+        end
+      end
+    end
+END
+              survey_temp_file = Tempfile.new('parser_spec_survey.rb',dir)
+              survey_temp_file.write(survey_text)
+              survey_temp_file.flush
+              Surveyor::Parser.parse(File.read(survey_temp_file.path))
+              survey = Survey.where(:title=>'One language is never enough').first
+              survey.nil?.should == false
+              survey.translation(:es)['title'].should == "Un idioma nunca es suficiente"
+            end
+          end
+        end
+      end
+      context 'when the survey filename is given' do
+        it 'should look for the translation file relative to the survey directory' do
+          Dir.mktmpdir do |dir|
+            translation_yaml = YAML::dump({'title' => 'Un idioma nunca es suficiente'})
+            translation_temp_file = Tempfile.new('surveyor:parser_spec.rb',dir)
+            translation_temp_file.write(translation_yaml)
+            translation_temp_file.flush
+            survey_text = <<END
+survey "One language is never enough" do
+      translations :es =>'#{File.basename(translation_temp_file.path)}', :en => :default
+      section_one "One" do
+        g_hello "Hello" do
+          q_name "What is your name?"
+          a_name :string, :help_text => "My name is..."
+        end
+      end
+    end
+END
+            survey_temp_file = Tempfile.new('surveyor:parser_spec.rb',dir)
+            survey_temp_file.write(survey_text)
+            survey_temp_file.flush
+            Surveyor::Parser.parse_file(survey_temp_file.path)
+            survey = Survey.where(:title=>'One language is never enough').first
+            survey.nil?.should == false
+            survey.translation(:es)['title'].should == "Un idioma nunca es suficiente"
+          end
+        end
+      end
+    end
+  end
+end