surveyor 1.1.0 → 1.2.0

data/CHANGELOG.md

@@ -1,12 +1,30 @@
 History for Surveyor
 ====================
 
+1.2.0
+-----
+
+### Features
+
+- Allow rendering of simple hash contexts with Mustache (#296)
+- Allow configuration of question numbering (#136)
+- Allow references to question_ and answer_ in dependency conditions (#345)
+
+### Fixes
+
+- Surveyor will never require 'fastercsv' on Ruby 1.9. (#381)
+- Add question_groups/question/answer/reference_identifier to JSON
+  serialization for Survey. (#390)
+- Evaluate dependencies even when the last response is removed (#362, #215)
+- Add answer help text (#373)
+- SurveyorController#export now renders 404 when surveys are not found (#391)
+
 1.1.0
 -----
 
 ### Features
 
-- Breaking change: Question#is_mandatory => false by default. For those who found it useful to have 
+- Breaking change: Question#is_mandatory => false by default. For those who found it useful to have
   all questions mandatory, the parser accepts `:default_mandatory => true` as an argument to the survey.
 
 ### Fixes

data/Gemfile.rails_version

@@ -8,11 +8,11 @@ if ENV['RAILS_VERSION']
   when /3.1$/
     gem 'rails', '~> 3.1.0'
     # A JS runtime is required for Rails 3.1+
-    gem 'therubyracer'
+    gem 'therubyracer', '~> 0.10.2'
   when /3.2$/
     gem 'rails', '~> 3.2.0'
     # A JS runtime is required for Rails 3.1+
-    gem 'therubyracer'
+    gem 'therubyracer', '~> 0.10.2'
   else
     fail "Unknown Rails version #{ENV['RAILS_VERSION']}"
   end

data/app/views/partials/_answer.html.haml

@@ -4,6 +4,7 @@
 - i = response_idx(q.pick != "one") # argument will be false (don't increment i) if we're on radio buttons
 - disabled = defined?(disableFlag) ? disableFlag : false
 = f.semantic_fields_for i, r do |ff|
+  %span.help= render_help_text(a, @render_context) unless g && g.display_type == "grid"
   = ff.input :question_id, :as => :quiet unless q.pick == "one" # don't repeat question_id if we're on radio buttons
   = ff.input :api_id, :as => :quiet unless q.pick == "one"
   = ff.input :response_group, :value => rg, :as => :quiet if q.pick != "one" && g && g.display_type == "repeater"

data/app/views/partials/_question_group.html.haml

@@ -15,7 +15,9 @@
                 %tr
                   %th  
                   - ten_questions.first.answers.each do |a|
-                    %th= a_text(a)
+                    %th
+                      =a_text(a)
+                      %span.help= render_help_text(a, @render_context)
                   %th  
                 - ten_questions.each_with_index do |q, i|
                   %tr{:id => "q_#{q.id}", :class => "q_#{renderer} #{q.css_class(@response_set)}"}

data/app/views/surveyor/export.json.rabl

@@ -51,6 +51,7 @@ child :sections => :sections do
       node(:post_text, :if => lambda { |q| !q.split_text(:post).blank? }){ |q| q.split_text(:post) }
       node(:help_text, :if => lambda { |q| !q.help_text.blank? }){ |q| q.help_text }
       node(:reference_identifier, :if => lambda { |q| !q.reference_identifier.blank? }){ |q| q.reference_identifier }
+      node(:data_export_identifier,   :if => lambda { |q| !q.data_export_identifier.blank? }){ |q| q.data_export_identifier }
       node(:type, :if => lambda { |q| q.display_type != "default" }){ |q| q.display_type }
       node(:pick, :if => lambda { |q| q.pick != "none" }){ |q| q.pick }
 
@@ -61,6 +62,8 @@ child :sections => :sections do
         node(:text){ |a| a.split_or_hidden_text(:pre) }
         node(:post_text, :if => lambda { |a| !a.split_or_hidden_text(:post).blank? }){ |a| a.split_or_hidden_text(:post) }
         node(:type, :if => lambda { |a| a.response_class != "answer" }){ |a| a.response_class }
+        node(:reference_identifier,   :if => lambda { |a| !a.reference_identifier.blank? }){ |a| a.reference_identifier }
+        node(:data_export_identifier, :if => lambda { |a| !a.data_export_identifier.blank? }){ |a| a.data_export_identifier }
       end
 
       child :dependency, :if => lambda { |q| q.dependency } do
@@ -75,4 +78,4 @@ child :sections => :sections do
     end
   end
 
-end
+end

data/features/export_to_json.feature

@@ -241,4 +241,8 @@ Feature: Survey export
   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"
+  And the JSON response at "responses/0/answer_id" should correspond to an answer with text "most favorite color"
+
+  Scenario: Exporting non-existent surveys
+    When I visit "/surveys/simple-json.json"
+    Then I should get a "404" response

data/features/step_definitions/parser_steps.rb

@@ -50,8 +50,11 @@ Then /^there should be (\d+) question(?:s?) with:$/ do |x, table|
   table.hashes.each do |hash|
     hash["reference_identifier"] = nil if hash["reference_identifier"] == "nil"
     hash["custom_class"] = nil if hash["custom_class"] == "nil"
-    hash["is_mandatory"] = (hash["is_mandatory"] == "true" ? true : (hash["is_mandatory"] == "false" ? false : hash["is_mandatory"]))
+    if hash.has_key?("is_mandatory")
+      hash["is_mandatory"] = (hash["is_mandatory"] == "true" ? true : (hash["is_mandatory"] == "false" ? false : hash["is_mandatory"]))
+    end
     result = Question.find(:first, :conditions => hash)
+    puts hash if result.nil?
     result.should_not be_nil
   end
 end

data/features/step_definitions/surveyor_steps.rb

@@ -225,6 +225,26 @@ Given /^I have survey context of "(.*)"$/ do |context|
   end
 end
 
+Given /^I have a simple hash context$/ do
+  class SurveyorController < ApplicationController
+    def render_context
+      {:name => "Moses", :site => "Northwestern"}
+    end
+  end
+end
+
+Given /^I replace question numbers with letters$/ do
+  module SurveyorHelper
+    include Surveyor::Helpers::SurveyorHelperMethods
+    def next_question_number(question)
+      @letters ||= ("A".."Z").to_a
+      @n ||= 25
+      "<span class='qnum'>#{@letters[(@n += 1)%26]}. </span>"
+    end
+  end
+end
+
+
 ## Various input elements
 
 Then /^I should see (\d+) textareas on the page$/ do |i|

data/features/step_definitions/web_steps.rb

@@ -219,3 +219,7 @@ end
 Then /^show me the page$/ do
   save_and_open_page
 end
+
+Then /^I should get a "(\d+)" response$/ do |http_status|
+  page.status_code.should == http_status.to_i
+end

data/features/surveyor.feature

@@ -334,7 +334,7 @@ Feature: Survey creation
 
 
   # Issue 259 - substitution of the text with Mustache
-  @javascript
+  @javascript @mustache
   Scenario: Creating a question with an mustache syntax
     Given I have survey context of "FakeMustacheContext"
     Given I parse
@@ -364,6 +364,36 @@ Feature: Survey creation
     And I should see "Santa Claus lives on South Pole"
     And I should see "Santa Claus doesn't exist"
 
+  # Issue 296 - Mustache rendering doesn't work with simple hash contexts
+  @javascript @mustache
+  Scenario: Creating a question with an mustache syntax
+    Given I have a simple hash context
+    Given I parse
+    """
+      survey "Overall info" do
+        section "Group of questions" do
+          group "Information on {{name}}?", :help_text => "Answer all you know on {{name}}" do
+            label "{{name}} does not work for {{site}}!", :help_text => "Make sure you sure {{name}} doesn't work for {{site}}"
+
+            q "Where does {{name}} live?", :pick => :one,
+            :help_text => "If you don't know where {{name}} lives, skip the question"
+            a "{{name}} lives on North Pole"
+            a "{{name}} lives on South Pole"
+            a "{{name}} doesn't exist"
+          end
+        end
+      end
+    """
+    When I start the "Overall info" survey
+    Then I should see "Information on Moses"
+    And I should see "Answer all you know on Moses"
+    And I should see "Moses does not work for Northwestern!"
+    And I should see "Make sure you sure Moses doesn't work for Northwestern"
+    And I should see "Where does Moses live?"
+    And I should see "If you don't know where Moses lives, skip the question"
+    And I should see "Moses lives on North Pole"
+    And I should see "Moses lives on South Pole"
+    And I should see "Moses doesn't exist"
 
   Scenario: Creating and saving grids
     Given I parse
@@ -691,3 +721,59 @@ Feature: Survey creation
       And I should see "1) What is your favorite number?"
       And I should not see "What is your name?"
 
+  @numbers
+  Scenario: hidden numbers
+    Given I parse
+    """
+      survey "Alpha" do
+        section "A-C" do
+          q "Aligator"
+          q "Barber"
+          q "Camel"
+        end
+      end
+    """
+      And I replace question numbers with letters
+    When I start the "Alpha" survey
+    Then I should see "A. Aligator"
+      And I should see "B. Barber"
+      And I should see "C. Camel"
+
+  Scenario: help text
+    Given I parse
+    """
+      survey "Help!" do
+        section "Songs" do
+          q "Do you need anybody?", :pick => :one, :help_text => "select one of the following"
+          a "I need somebody to love", :help_text => "like The Beatles"
+          a "I am a rock, I am an island", :help_text => "like Simon and Garfunkel"
+
+          grid "How would these artists respond to 'Do you need anybody?'", :help_text => "in your opinion" do
+            a "Yes", :help_text => "would say yes"
+            a "No", :help_text => "would say no"
+            q "Bobby Darrin", :pick => :one
+            q "Kurt Cobain", :pick => :one
+            q "Ella Fitzgerald", :pick => :one
+            q "Kanye West", :pick => :one
+          end
+
+          repeater "Over and over" do
+            q "Row row row your boat", :pick => :any, :help_text => "the 1st part of a round"
+            a "gently down the stream", :help_text => "the 2nd part of a round"
+            a "merrily merrily merrily merrily", :help_text => "the 3rd part of a round"
+            a "life is but a dream", :help_text => "the 4th part of a round"
+          end
+        end
+      end
+    """
+    When I start the "Help!" survey
+    Then I should see "select one of the following"
+      And I should see "like The Beatles"
+      And I should see "like Simon and Garfunkel"
+      And I should see "in your opinion"
+      And I should see "would say yes"
+      And I should see "would say no"
+      And I should see "the 1st part of a round"
+      And I should see "the 2nd part of a round"
+      And I should see "the 3rd part of a round"
+      And I should see "the 4th part of a round"

data/features/surveyor_dependencies.feature

@@ -361,3 +361,62 @@ Feature: Survey dependencies
     When I check "Once for you"
     Then the element "#q_3" should not be hidden
       And the element "#q_2" should be hidden
+
+  @javascript
+  Scenario: Dependency evaluation when the last response is removed
+    Given I parse
+      """
+      survey "Heating" do
+        section "Basics" do
+          q_heating_1 "How do you heat your home?", :pick => :any
+          a_1 "Forced air"
+          a_2 "Radiators"
+          a_3 "Oven"
+          a_4 "Passive"
+
+          q_heating_2 "How much does it cost to run your non-passive heating solutions?"
+          dependency :rule => "A"
+          condition_A :q_heating_1, "==", :a_1
+          a_1 "$", :float
+        end
+      end
+      """
+    When I go to the surveys page
+      And I start the "Heating" survey
+    Then the question "How much does it cost to run your non-passive heating solutions?" should be hidden
+      And I check "Forced air"
+    Then the question "How much does it cost to run your non-passive heating solutions?" should be triggered
+      And I uncheck "Forced air"
+    Then the question "How much does it cost to run your non-passive heating solutions?" should be hidden
+
+  @javascript @focus
+  Scenario: Dependency evaluation within groups
+    Given I parse
+      """
+      survey "Body" do
+        section "Joints" do
+          group "Muscle" do
+            q_muscles_joints_bones "Muscles, Joints, Bones", :pick => :any, :data_export_identifier => "muscles_joints_bones"
+            a_1 "Weakness"
+            a_2 "Arthritis"
+            a_3 "Cane/Walker"
+            a_4 "Morning stiffness"
+            a_5 "Joint pain"
+            a_6 "Muscle tenderness"
+            a_7 :other
+
+            q_muscles_joints_bones_other "Explain", :data_export_identifier => "muscles_joints_bones_other"
+            dependency :rule => "A"
+            condition_A :q_muscles_joints_bones, "==", :a_7
+            a "Explain", :string
+          end
+        end
+      end
+      """
+    When I go to the surveys page
+      And I start the "Body" survey
+    Then the question "Explain" should be hidden
+    When I check "Other"
+    Then the question "Explain" should be triggered
+    When I uncheck "Other"
+    Then the question "Explain" should be hidden

data/features/surveyor_parser.feature

@@ -473,3 +473,32 @@ Feature: Survey parser
       | Did you take out the trash | true         |
       | Did you do the laundry     | true         |
       | Optional comments          | false        |
+
+  @javascript
+  Scenario: Parsing dependencies with "question_" and "answer_" syntax
+    Given I parse
+    """
+      survey "Days" do
+        section "Fridays" do
+          q_is_it_friday "Is it Friday?", :pick => :one
+          a_yes "Yes"
+          a_no  "No"
+
+          label "woot!"
+          dependency :rule => "A"
+          condition_A :question_is_it_friday, "==", :answer_yes
+        end
+      end
+    """
+    Then there should be 1 dependency with:
+      | rule |
+      | A    |
+    And there should be 1 resolved dependency_condition with:
+      | rule_key |
+      | A        |
+    When I go to the surveys page
+    And I start the "Days" survey
+    Then the question "woot!" should be hidden
+    And I choose "Yes"
+    Then the question "woot!" should be triggered
+

data/lib/surveyor/common.rb

@@ -37,6 +37,23 @@ module Surveyor
       def generate_api_id
         UUIDTools::UUID.random_create.to_s
       end
+
+      ##
+      # @private Intended for internal use only.
+      #
+      # Loads and uses either `FasterCSV` (for Ruby 1.8) or the stdlib `CSV`
+      # (for Ruby 1.9+).
+      #
+      # @return [Class] either `CSV` for `FasterCSV`.
+      def csv_impl
+        @csv_impl ||= if RUBY_VERSION < '1.9'
+                         require 'fastercsv'
+                         FasterCSV
+                       else
+                         require 'csv'
+                         CSV
+                       end
+      end
     end
   end
 end

data/lib/surveyor/helpers/surveyor_helper_methods.rb

@@ -41,11 +41,17 @@ module Surveyor
 
       # Questions
       def q_text(obj, context=nil)
-        @n ||= 0
+
         return image_tag(obj.text) if obj.is_a?(Question) and obj.display_type == "image"
         return obj.render_question_text(context) if obj.is_a?(Question) and (obj.dependent? or obj.display_type == "label" or obj.part_of_group?)
-        "#{@n += 1}) #{obj.render_question_text(context)}"
+        "#{next_question_number(obj)}#{obj.render_question_text(context)}"
+      end
+
+      def next_question_number(question)
+        @n ||= 0
+        "<span class='qnum'>#{@n += 1}) </span>"
       end
+
       # def split_text(text = "") # Split text into with "|" delimiter - parts to go before/after input element
       #   {:prefix => text.split("|")[0].blank? ? "&nbsp;" : text.split("|")[0], :postfix => text.split("|")[1] || "&nbsp;"}
       # end

data/lib/surveyor/models/response_set_methods.rb

@@ -1,5 +1,3 @@
-require 'fastercsv'
-require 'csv'
 require 'rabl'
 
 module Surveyor
@@ -54,8 +52,7 @@ module Surveyor
         qcols = Question.content_columns.map(&:name) - %w(created_at updated_at)
         acols = Answer.content_columns.map(&:name) - %w(created_at updated_at)
         rcols = Response.content_columns.map(&:name)
-        csvlib = CSV.const_defined?(:Reader) ? FasterCSV : CSV
-        result = csvlib.generate do |csv|
+        result = Surveyor::Common.csv_impl.generate do |csv|
           if print_header
             csv << (access_code ? ["response set access code"] : []) +
               qcols.map{|qcol| "question.#{qcol}"} +
@@ -184,6 +181,7 @@ module Surveyor
       protected
 
       def dependencies(question_ids = nil)
+        question_ids = survey.sections.map(&:questions).flatten.map(&:id) if responses.blank? and question_ids.blank?
         deps = Dependency.all(:include => :dependency_conditions,
           :conditions => {:dependency_conditions => {:question_id => question_ids || responses.map(&:question_id)}})
         # this is a work around for a bug in active_record in rails 2.3 which incorrectly eager-loads associatins when a

data/lib/surveyor/models/survey_methods.rb

@@ -25,6 +25,10 @@ module Surveyor
         # Whitelisting attributes
         base.send :attr_accessible, :title, :description, :reference_identifier, :data_export_identifier, :common_namespace, :common_identifier, :css_url, :custom_class, :display_order
 
+        # Derived attributes
+        base.send :before_save, :generate_access_code
+        base.send :before_save, :increment_version
+
         # Class methods
         base.instance_eval do
           def to_normalized_string(value)
@@ -45,16 +49,6 @@ module Surveyor
         self.display_order ||= Survey.count
       end
 
-      def title=(value)
-        return if value == self.title
-        surveys = Survey.where(:access_code => Survey.to_normalized_string(value)).order("survey_version DESC")
-        self.survey_version     = surveys.first.survey_version.to_i + 1 if surveys.any?
-        self.access_code = Survey.to_normalized_string(value)
-        super(value)
-        # self.access_code = Survey.to_normalized_string(value)
-        # super
-      end
-
       def active?
         self.active_as_of?(DateTime.now)
       end
@@ -72,7 +66,22 @@ module Surveyor
       def as_json(options = nil)
         template_paths = ActionController::Base.view_paths.collect(&:to_path)
         Rabl.render(self, 'surveyor/export.json', :view_path => template_paths, :format => "hash")
-      end      
+      end
+
+      def default_access_code
+        self.class.to_normalized_string(title)
+      end
+
+      def generate_access_code
+        self.access_code ||= default_access_code
+      end
+
+      def increment_version
+        surveys = self.class.select(:survey_version).where(:access_code => access_code).order("survey_version DESC")
+        next_version = surveys.any? ? surveys.first.survey_version.to_i + 1 : 0
+
+        self.survey_version = next_version
+      end
     end
   end
 end