surveyor 0.22.0 → 1.0.0

data/doc/REPRESENTATIONS.md

@@ -0,0 +1,34 @@
+# JSON Representations
+
+This document describes the JSON representations for the ResponseSet and Survey models.  The models can be serialized
+by calling the `to_json` method.
+
+## ResponseSet
+
+An example of the serialized ResponseSet JSON can be found below. The schema will be coming soon.
+ 
+    /* ResponseSet JSON */
+    {
+      "uuid"        : "9af6d142-7fac-4ccb-9bca-58a05308a5a7",
+      "survey_id"   : "94b3d750-fb63-4540-a1e2-dd7f88be9b4f",
+      "created_at"  : "1970-02-04T05:15:30Z",
+      "completed_at": "1990-03-06T07:21:42Z"
+      "responses": [{
+        "uuid"        : "07d72796-ebb2-4be2-91b9-68f5a30a0054",
+        "answer_id"   : "9c788711-8373-44d7-b44b-754c31e596a9",
+        "question_id" : "376a501b-c32f-49de-b4d7-e28030a2ea94",
+        "value"       : "Chimpanzee",
+        "created_at"  : "1970-02-04T05:15:30Z",
+        "modified_at" : "1990-03-06T07:21:42Z"
+      },{
+        "uuid"        : "d0467180-e126-44c0-b112-63bb87f0d869",
+        "answer_id"   : "86a85d44-9f39-4df9-ae90-da7ff5dbaaf5",
+        "question_id" : "6146c103-4a8b-4869-836b-415b8666babe",
+        "created_at"  : "1970-02-04T05:16:30Z",
+        "modified_at" : "1990-03-06T07:22:42Z"
+      }]
+    }
+
+## Survey
+
+Example representation and schema coming soon.

data/doc/api_id_schema.json

@@ -0,0 +1,7 @@
+{
+    "$schema": "http://json-schema.org/draft-03/schema#",
+    "description": "Public UUID of a Surveyor entity",
+    "maxLength": 36,
+    "required": true,
+    "type": "string"
+}

data/doc/response_set_schema.json

@@ -0,0 +1,54 @@
+{
+    "$schema": "http://json-schema.org/draft-03/schema#",
+    "description": "Response set",
+    "properties": {
+        "completed_at": {
+            "$ref": "http://download.nubic.northwestern.edu/surveyor/surveyor_timestamp_schema.json#"
+        },
+        "created_at": {
+            "$ref": "http://download.nubic.northwestern.edu/surveyor/surveyor_timestamp_schema.json#"
+        },
+        "responses": {
+            "description": "Responses in the response set",
+            "items": {
+                "properties": {
+                    "answer_id": {
+                        "$ref": "http://download.nubic.northwestern.edu/surveyor/api_id_schema.json#"
+                    },
+                    "created_at": {
+                        "$ref": "http://download.nubic.northwestern.edu/surveyor/surveyor_timestamp_schema.json#"
+                    },
+                    "question_id": {
+                        "$ref": "http://download.nubic.northwestern.edu/surveyor/api_id_schema.json#"
+                    },
+                    "response_group": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "updated_at": {
+                        "$ref": "http://download.nubic.northwestern.edu/surveyor/surveyor_timestamp_schema.json#"
+                    },
+                    "uuid": {
+                        "$ref": "http://download.nubic.northwestern.edu/surveyor/api_id_schema.json#"
+                    },
+                    "value": {
+                        "type": [
+                            "string",
+                            "number",
+                            "null"
+                        ]
+                    }
+                }
+            },
+            "type": "array"
+        },
+        "survey_id": {
+            "$ref": "http://download.nubic.northwestern.edu/surveyor/api_id_schema.json#"
+        },
+        "uuid": {
+            "$ref": "http://download.nubic.northwestern.edu/surveyor/api_id_schema.json#"
+        }
+    }
+}

data/doc/surveyor_timestamp_schema.json

@@ -0,0 +1,9 @@
+{
+    "$schema": "http://json-schema.org/draft-03/schema#",
+    "description": "Timestamp on a Surveyor entity",
+    "format": "\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:Z|[+-]\\d{2}:\\d{2})",
+    "type": [
+        "string",
+        "null"
+    ]
+}

data/features/ajax_submissions.feature

@@ -0,0 +1,140 @@
+@javascript
+Feature: AJAX submissions
+  As a survey administrator
+  I want participants' responses to be saved as soon as possible
+
+Scenario: With a simple pick-one question
+  Given the question
+    """
+    q_1 "Was this saved?", :pick => :one
+    a_y "Yes"
+    a_n "No"
+    """
+  When I start the survey
+   And I choose "Yes"
+  Then there should be a response for answer "y"
+
+Scenario: With a simple pick-any question
+  Given the question
+    """
+    q_1 "What is the state of the cat?", :pick => :any
+    a_d "Dead"
+    a_a "Alive"
+    a_s "Sleeping"
+    """
+  When I start the survey
+   And I check "Alive"
+   And I check "Sleeping"
+  Then there should be a response for answer "a"
+   And there should be a response for answer "s"
+   And there should not be a response for answer "d"
+
+Scenario: With a free text question
+  Given the question
+    """
+    q_1 "What is your favorite movie?"
+    answer "Title", :string
+    """
+  When I start the survey
+   And I fill in "Title" with "The Shawshank Redemption"
+   And I click elsewhere
+  Then there should be a string response with value "The Shawshank Redemption"
+
+Scenario: With a date question
+  Given the question
+    """
+    q_1 "When do you want to depart?"
+    answer "Departure date", :date
+    """
+    When I start the survey
+     And I click "Departure date"
+     And I select "Mar" as the datepicker's month
+     And I select "2013" as the datepicker's year
+     And I follow "9"
+    Then there should be a date response with value "2013-03-09"
+
+Scenario: With a datetime question
+  Given the question
+    """
+    q_1 "When do you want to depart?"
+    answer "Departure date and time", :datetime
+    """
+    When I start the survey
+     And I click "Departure date and time"
+     And I select "Apr" as the datepicker's month
+     And I select "2013" as the datepicker's year
+     And I follow "8"
+    Then there should be a date response with value "2013-04-08 00:00:00"
+
+# How to move the sliders progammatically?
+@wip
+Scenario: With a time question
+  Given the question
+    """
+    q_1 "When do you want lunch?"
+    answer "Meal time", :time
+    """
+    When I start the survey
+     And I click "Meal time"
+     And ?
+    Then there should be a time response with value "11:45:00"
+
+Scenario: With a pick-one plus free text question
+  Given the question
+    """
+    q_1 "Where is Panama City?", :pick => :one
+    a_florida "Florida"
+    a_panama "Panama"
+    a_other :other, :string
+    """
+  When I start the survey
+   And I fill in the string for "other" with "Chicago"
+  Then I click elsewhere
+   And there should be a string response for answer "other" with value "Chicago"
+
+# How to move the slider programmatically?
+@wip
+Scenario: With a slider
+  Given the question
+    """
+    q_1 "How many?", :pick => :one, :display_type => :slider
+    a_0   "None"
+    a_10  "Some"
+    a_100 "Lots"
+    """
+  When I start the survey
+   And ?
+  Then there should be a response for answer "100"
+
+# Issue #339
+Scenario: With a grid question
+  Given the question
+    """
+    grid "Tell us how often do you cover these each day" do
+      a_1 "1"
+      a_2 "2"
+      a_3 "3"
+      q_h "Head", :pick => :one
+      q_k "Knees", :pick => :one
+      q_t "Toes", :pick => :one
+    end
+    """
+  When I start the survey
+   And I choose "3"
+  Then there should be a response for answer "3"
+
+Scenario: With a repeater
+  Given the question
+    """
+    repeater "List your former addresses" do
+      q "Address"
+      a_address_line "Line", :string
+    end
+    """
+  When I start the survey
+   And I fill in the 1st string for "address_line" with "10 Downing St."
+   And I press "+ add row"
+   And I fill in the 2nd string for "address_line" with "1600 Penn Ave."
+   And I click elsewhere
+  Then there should be a string response for answer "address_line" with value "10 Downing St."
+   And there should be a string response for answer "address_line" with value "1600 Penn Ave."

data/features/export_to_json.feature

@@ -17,14 +17,15 @@ Feature: Survey export
           answer :other
 
           q_2b "Choose the colors you don't like", :pick => :any
-          a_1 "orange"
-          a_2 "purple"
-          a_3 "brown"
+          a "orange"
+          a "purple"
+          a "brown"
           a :omit
         end
       end
     """
-    Then the json for "Simple json" should be
+    And I visit "/surveys/simple-json.json"
+    Then the JSON should be:
     """
     {
       "title": "Simple json",
@@ -39,12 +40,117 @@ Feature: Survey export
         }]
       }
     """
-  
+
+  Scenario: Exporting export and reference identifiers
+    Given I parse
+    """
+      survey "Exportable" do
+        section "First section" do
+          question_1 "What is your favorite color?", :pick => :one, :data_export_identifier => "favorite_color"
+          a_red "red"
+          a_blue "blue"
+
+          q_2b "Choose the colors you don't like", :pick => :any
+          a_1 "orange", :data_export_identifier => "dont_like_orange"
+          a_2 "purple"
+        end
+      end
+    """
+    And I visit "/surveys/exportable.json"
+    Then the JSON should be:
+    """
+    {
+      "title": "Exportable",
+      "uuid": "*",
+      "sections": [{
+        "title": "First section",
+        "display_order":0,
+        "questions_and_groups": [
+          { "uuid": "*", "reference_identifier": "1", "pick": "one", "text": "What is your favorite color?", "data_export_identifier": "favorite_color", "answers": [{"text": "red", "uuid": "*", "reference_identifier": "red"}, {"text": "blue", "uuid": "*", "reference_identifier": "blue"}]},
+          { "uuid": "*", "reference_identifier": "2b", "pick": "any", "text": "Choose the colors you don't like", "answers": [{"text": "orange", "uuid": "*", "reference_identifier": "1", "data_export_identifier": "dont_like_orange"},{"text": "purple", "uuid": "*", "reference_identifier": "2"}]}]
+        }]
+      }
+    """
+
+  Scenario: Exporting versioned survey questions
+  Given I parse
+  """
+    survey "Simple json" do
+      section "Basic questions" do
+        label "These questions are examples of the basic supported input types"
+
+        question_1 "What is your favorite color?", :pick => :one
+        answer "red"
+        answer "blue"
+        answer "green"
+        answer :other
+
+        q_2b "Choose the colors you don't like", :pick => :any
+        a "orange"
+        a "purple"
+        a "brown"
+        a :omit
+      end
+    end
+  """
+  And I parse
+  """
+    survey "Simple json" do
+      section "Not so basic questions" do
+        label "These questions are examples of the basic supported input types"
+
+        question_1 "What is your favorite color?", :pick => :one
+        answer "reddish"
+        answer "blueish"
+        answer "greenish"
+        answer :other
+
+        q_2b "Choose the colors you don't like", :pick => :any
+        a "orange"
+        a "purple"
+        a "brown"
+        a :omit
+      end
+    end
+  """
+  And I visit "/surveys/simple-json.json"
+  Then the JSON should be:
+  """
+  {
+    "title": "Simple json",
+    "uuid": "*",
+    "sections": [{
+      "title": "Not so basic questions",
+      "display_order":0,
+      "questions_and_groups": [
+        { "uuid": "*", "type": "label", "text": "These questions are examples of the basic supported input types" },
+        { "uuid": "*", "reference_identifier": "1", "pick": "one", "text": "What is your favorite color?", "answers": [{"text": "reddish", "uuid": "*"}, {"text": "blueish", "uuid": "*"}, {"text": "greenish", "uuid": "*"}, {"text": "Other", "uuid": "*"}]},
+        { "uuid": "*", "reference_identifier": "2b", "pick": "any", "text": "Choose the colors you don't like", "answers": [{"text": "orange", "uuid": "*"},{"text": "purple", "uuid": "*"},{"text": "brown", "uuid": "*"},{"text": "Omit", "exclusive":true, "uuid": "*"}]}]
+      }]
+    }
+  """
+  And I visit "/surveys/simple-json.json?survey_version=0"
+  Then the JSON should be:
+  """
+  {
+    "title": "Simple json",
+    "uuid": "*",
+    "sections": [{
+      "title": "Basic questions",
+      "display_order":0,
+      "questions_and_groups": [
+        { "uuid": "*", "type": "label", "text": "These questions are examples of the basic supported input types" },
+        { "uuid": "*", "reference_identifier": "1", "pick": "one", "text": "What is your favorite color?", "answers": [{"text": "red", "uuid": "*"}, {"text": "blue", "uuid": "*"}, {"text": "green", "uuid": "*"}, {"text": "Other", "uuid": "*"}]},
+        { "uuid": "*", "reference_identifier": "2b", "pick": "any", "text": "Choose the colors you don't like", "answers": [{"text": "orange", "uuid": "*"},{"text": "purple", "uuid": "*"},{"text": "brown", "uuid": "*"},{"text": "Omit", "exclusive":true, "uuid": "*"}]}]
+      }]
+    }
+  """
+
   Scenario: Exporting response sets
   Given I parse
   """
     survey "Simple json response sets" do
-      section "Colors" do
+      section "Section 1" do
 
         question_1 "What is your favorite color?", :pick => :one
         answer "red"
@@ -55,42 +161,84 @@ Feature: Survey export
         q_2b "What color don't you like?"
         a_1 "color", :string
       end
-      section "Other" do
+      section "Section 2" do
         label "no"
       end
     end
   """
   When I start the "Simple json response sets" survey
   And I choose "red"
-  And I press "Other"
-  And I wait 1 seconds
-  And I press "Colors"
+  And I press "Section 2"
+  And I press "Section 1"
   And I fill in "color" with "orange"
-  And I press "Other"
+  And I press "Section 2"
   And I press "Click here to finish"
   Then there should be 1 response set with 2 responses with:
     | answer |
     | red    |
-  And the json for the last response set for "Simple json response sets" should be
-  """
-  { 
-    "uuid":"*",
-    "survey_id":"*",
-    "created_at":"*",
-    "completed_at":"*",
-    "responses":[{
-      "uuid":"*",
-      "answer_id":"*",
-      "question_id":"*",
-      "created_at":"*",
-      "modified_at":"*"
-    },{
-      "uuid":"*",
-      "answer_id":"*",
-      "question_id":"*",
-      "created_at":"*",
-      "modified_at":"*",
-      "value":"orange"
-    }]
-  }
-  """
+  And I export the response set
+  Then the JSON at "responses" should have 2 entries
+  Then the JSON should not have "responses/0/value"
+  And the JSON response at "responses/0/answer_id" should correspond to an answer with text "red"
+  And the JSON response at "responses/1/value" should be "orange"
+  And the JSON response at "responses/1/answer_id" should correspond to an answer with text "color"
+
+  # Issue #294 - ResponseSet#to_json generates unexpected results with zero Responses
+  Scenario: Exporting response sets without responses
+  Given I parse
+  """
+    survey "Simple json response sets" do
+      section "Colors" do
+
+        question_1 "What is your favorite color?", :pick => :one
+        answer "red"
+        answer "blue"
+        answer "green"
+        answer :other
+
+        q_2b "What color don't you like?"
+        a_1 "color", :string
+      end
+      section "Other" do
+        label "no"
+      end
+    end
+  """
+  When I start the "Simple json response sets" survey
+  And I export the response set
+  Then the JSON at "responses" should be an array
+  Then the JSON at "responses" should have 0 entries
+
+  Scenario: Exporting response sets for versioned surveys
+  Given I parse
+  """
+    survey "Simple json response sets" do
+      section "Colors" do
+        question "What is your least favorite color?"
+        a "least favorite color", :string
+      end
+    end
+  """
+  And I start the "Simple json response sets" survey
+  And I fill in "color" with "orange"
+  And I press "Click here to finish"
+  And I export the response set
+  Then the JSON at "responses" should have 1 entry
+  And the JSON response at "responses/0/value" should be "orange"
+  And the JSON response at "responses/0/answer_id" should correspond to an answer with text "least favorite color"
+  And I parse
+  """
+    survey "Simple json response sets" do
+      section "Colors" do
+        question_1 "What is your most favorite color?"
+        a "most favorite color", :string
+      end
+    end
+  """
+  And I start the "Simple json response sets" survey
+  And I fill in "color" with "blueish"
+  And I press "Click here to finish"
+  And I export the response set
+  Then the JSON at "responses" should have 1 entry
+  And the JSON response at "responses/0/value" should be "blueish"
+  And the JSON response at "responses/0/answer_id" should correspond to an answer with text "most favorite color"

data/features/no_duplicates.feature

@@ -0,0 +1,110 @@
+@javascript @slow_updates @simultaneous_ajax
+Feature: Duplicate response prevention
+  As a survey administrator
+  I want to get exactly the number of responses entered
+  So that my results are analytically valid
+
+Scenario: With a simple pick-one question
+  Given the question
+    """
+    q_1 "Was this saved?", :pick => :one
+    a_y "Yes"
+    a_n "No"
+    """
+  When I start the survey
+   And I choose "Yes"
+   And I choose "No"
+   And I wait for things to settle out
+  Then there should be a response for answer "n"
+   And there should not be a response for answer "y"
+
+Scenario: With a simple pick-any question
+  Given the question
+    """
+    q_1 "What is the state of the cat?", :pick => :any
+    a_d "Dead"
+    a_a "Alive"
+    a_s "Sleeping"
+    """
+  When I start the survey
+   And I check "Alive"
+   And I check "Dead"
+   And I uncheck "Dead"
+   And I check "Sleeping"
+   And I wait for things to settle out
+  Then there should be a response for answer "a"
+   And there should be a response for answer "s"
+   And there should not be a response for answer "d"
+
+Scenario: With a free text question
+  Given the question
+    """
+    q_1 "What is your favorite movie?"
+    answer "Title", :string
+    """
+  When I start the survey
+   And I fill in "Title" with "The Shawshank Redemption"
+   And I click elsewhere
+   And I fill in "Title" with "Rear Window"
+   And I click elsewhere
+   And I wait for things to settle out
+   And there should be a string response with value "Rear Window"
+  Then there should not be a string response with value "The Shawshank Redemption"
+
+Scenario: With a pick-one plus free text question
+  Given the question
+    """
+    q_1 "Where is Panama City?", :pick => :one
+    a_florida "Florida"
+    a_panama "Panama"
+    a_other :other, :string
+    """
+  When I start the survey
+   And I choose "Florida"
+   And I choose "Other"
+   And I fill in the string for "other" with "Chicago"
+   And I click elsewhere
+   And I wait for things to settle out
+  Then there should be a string response for answer "other" with value "Chicago"
+   And there should not be a response for answer "florida"
+
+Scenario: With a grid question
+  Given the question
+    """
+    grid "Tell us how often do you cover these each day" do
+      a_1 "1"
+      a_2 "2"
+      a_3 "3"
+      q_h "Head", :pick => :one
+      q_k "Knees", :pick => :one
+      q_t "Toes", :pick => :one
+    end
+    """
+  When I start the survey
+   And I choose row 1, column 3 of the grid
+   And I choose row 1, column 2 of the grid
+   And I choose row 2, column 1 of the grid
+   And I wait for things to settle out
+  Then there should be a response for answer "2" on question "h"
+   And there should not be a response for answer "3" on question "h"
+   And there should be a response for answer "1" on question "k"
+
+Scenario: With a repeater
+  Given the question
+    """
+    repeater "List your former addresses" do
+      q "Address"
+      a_address_line "Line", :string
+    end
+    """
+  When I start the survey
+   And I fill in the 1st string for "address_line" with "10 Downing St."
+   And I press "+ add row"
+   And I fill in the 2nd string for "address_line" with "1600 Penn Ave."
+   And I click elsewhere
+   And I fill in the 2nd string for "address_line" with "1600 Pennsylvania Ave."
+   And I click elsewhere
+   And I wait for things to settle out longer
+  Then there should be a string response for answer "address_line" with value "10 Downing St."
+   And there should not be a string response for answer "address_line" with value "1600 Penn Ave."
+   And there should be a string response for answer "address_line" with value "1600 Pennsylvania Ave."

data/features/show_survey.feature

@@ -4,7 +4,7 @@ Feature: showing a survey
   So that I can understand the data
 
   Scenario: Take a survey, then look at it
-    Given the survey
+    Given I parse
     """
       survey "Favorites" do
         section "Colors" do

data/features/step_definitions/parser_steps.rb

@@ -1,7 +1,25 @@
-Given /^I parse$|^the survey$/ do |string|
+Given /^I parse$/ do |string|
   Surveyor::Parser.parse(string)
 end
 
+Given /^the survey$/ do |string|
+  @survey_string = string
+end
+
+Then /^the parser should fail with "(.*)"$/ do |error_message|
+  lambda { Surveyor::Parser.parse(@survey_string) }.should raise_error(Surveyor::ParserError, /#{error_message}/)
+end
+
+Given /^the questions?$/ do |q_string|
+  Surveyor::Parser.parse(<<-SURVEY)
+    survey "Some questions for you" do
+      section "All the questions" do
+        #{q_string}
+      end
+    end
+  SURVEY
+end
+
 Given /^I parse redcap file "([^"]*)"$/ do |name|
   Surveyor::RedcapParser.parse File.read(File.join(Rails.root, '..', 'features', 'support', name)), name
 end
@@ -36,6 +54,11 @@ Then /^there should be (\d+) question(?:s?) with:$/ do |x, table|
   end
 end
 
+Then /^there should be (\d+) question(?:s?) with a correct answer$/ do |x|
+  Question.count(:conditions => "correct_answer_id NOT NULL").should == x.to_i
+  Question.all(:conditions => "correct_answer_id NOT NULL").compact.map(&:correct_answer).compact.size.should == x.to_i
+end
+
 Then /^there should be (\d+) answer(?:s?) with:$/ do |x, table|
   Answer.count.should == x.to_i
   table.hashes.each do |hash|
@@ -57,7 +80,7 @@ Then /^there should be (\d+) resolved dependency_condition(?:s?) with:$/ do |x,
     d = DependencyCondition.find(:first, :conditions => hash)
     d.should_not be_nil
     d.question.should_not be_nil
-    d.answer.should_not be_nil unless d.operator.match(/^count[<>=!]{1,2}\d+/) 
+    d.answer.should_not be_nil unless d.operator.match(/^count[<>=!]{1,2}\d+/)
   end
 end