surveyor 1.3.0 → 1.4.0

data/CHANGELOG.md

@@ -1,6 +1,28 @@
 History for Surveyor
 ====================
 
+1.4.0
+-----
+### Features
+
+- Routes are namespaced (e.g. `surveyor.available_surveys_path`) and may be mounted at a different root (e.g. `mount Surveyor::Engine, :at => '/instruments'`) (#398, #421)
+- Surveyor::Parser.parse_file takes an options[:filename] parameter, used to locate translations (#429)
+- Surveyor::Parser allows translations to be specified inline using a hash (#429)
+- require locale of survey when translations are present (#426)
+- locale selection in survey UI (#427)
+
+### Fixes
+
+- Remove default order on Response. (#423)
+- Bug fix for RedCap Parser for DependencyConditions. thanks @ariel-perez-birchbox
+- Make Surveyor::Parser accept Answer#reference_identifier via underscore or hash syntax (#439)
+- Fix show action and have it use new translation view methods (#438, #442) thanks @alanjcfs
+- Fix times showing in UTC when time zone is specified in Rails (#435)
+
+### Dependencies
+
+- Removing support for Rails 3.0. Applications requiring Rails 3.0 should use Surveyor v1.3.0
+
 1.3.0
 -----
 

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://www.rubygems.org'
 
 gemspec
 

data/README.md

@@ -20,7 +20,7 @@ without maintaining a fork.
 Surveyor works with:
 
 * Ruby 1.8.7, 1.9.2, and 1.9.3
-* Rails 3.0-3.2
+* Rails 3.1-3.2
 
 Some key dependencies are:
 

data/Rakefile

@@ -40,7 +40,10 @@ task :testbed => 'testbed:rebuild'
 namespace :testbed do
   desc 'Generate a minimal surveyor-using rails app'
   task :generate do
-    sh 'bundle exec rails new testbed --skip-bundle' # don't run bundle install until the Gemfile modifications
+    Tempfile.open('surveyor_Rakefile') do |f|
+      f.write("application \"config.time_zone='Rome'\"");f.flush
+      sh "bundle exec rails new testbed --skip-bundle -m #{f.path}" # don't run bundle install until the Gemfile modifications
+    end
     chdir('testbed') do
       gem_file_contents = File.read('Gemfile')
       gem_file_contents.sub!(/^(gem 'rails'.*)$/, %Q{# \\1\nplugin_root = File.expand_path('../..', __FILE__)\neval(File.read File.join(plugin_root, 'Gemfile.rails_version'))\ngem 'surveyor', :path => plugin_root})

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

@@ -19,7 +19,7 @@
                   :as         => rc_to_as(a.response_class),
                   :label      => a.text_for(:pre, @render_context, I18n.locale).blank? ? false : a.text_for(:pre, @render_context, I18n.locale),
                   :hint       => a.text_for(:post, @render_context, I18n.locale),
-                  :input_html => generate_pick_none_input_html(r.as(a.response_class), a.default_value_for(@render_context, I18n.locale), a.css_class, a.response_class, disabled, a.input_mask, a.input_mask_placeholder)
+                  :input_html => generate_pick_none_input_html(r.to_formatted_s, a.default_value_for(@render_context, I18n.locale), a.css_class, a.response_class, disabled, a.input_mask, a.input_mask_placeholder)
     - else
       = a.text_for(nil, @render_context, I18n.locale)
   %span.help= a.help_text_for(@render_context, I18n.locale) unless g && g.display_type == "grid"

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

@@ -1,5 +1,12 @@
 .surveyor_menu
+  - if !@survey.translations.empty?
+    = hidden_field_tag "current_section", @section.id
+    .surveyor_language_selection
+      = label_tag "locale", t('surveyor.language')
+      %select{:id=>"locale", :name=>"new_locale"}
+        = options_for_select(@survey.translations.map(&:locale),I18n.locale)
+
   = t('surveyor.sections')
   %ul
     - @sections.each do |s|
-      %li{:class => ("active" if s == @section)}= menu_button_for(s)
+      %li{:class => ("active" if s == @section)}= menu_button_for(s)

data/app/views/surveyor/edit.html.haml

@@ -3,7 +3,7 @@
     .surveyor_flash
       = flash_messages(types)
       .close
-  = semantic_form_for(@response_set, :as => :r, :url => update_my_survey_path, :html => {:method => :put, :id => "survey_form", :class => @survey.custom_class}) do |f|
+  = semantic_form_for(@response_set, :as => :r, :url => surveyor.update_my_survey_path, :html => {:method => :put, :id => "survey_form", :class => @survey.custom_class}) do |f|
 
     = hidden_field_tag :surveyor_javascript_enabled, false
 

data/app/views/surveyor/new.html.haml

@@ -9,7 +9,7 @@
     %ul
       - @surveys_by_access_code.each do |access_code, surveys|
         %li
-          = form_tag take_survey_path(:survey_code => access_code) do
+          = form_tag surveyor.take_survey_path(:survey_code => access_code) do
             = hidden_field_tag :surveyor_javascript_enabled, false
             = surveys.first.translation(I18n.locale)[:title]
              

data/app/views/surveyor/show.html.haml

@@ -3,7 +3,7 @@
     .surveyor_flash
       = flash_messages(types)
       .close
-  = semantic_form_for(@response_set, :as => :r, :url => update_my_survey_path, :html => {:id => "survey_form", :class => @survey.custom_class}) do |f|
+  = semantic_form_for(@response_set, :as => :r, :url => surveyor.update_my_survey_path, :html => {:id => "survey_form", :class => @survey.custom_class}) do |f|
     .survey_title= @survey.title
     - @survey.sections.each do |section|
       = div_for section do
@@ -22,18 +22,18 @@
               - if answered_questions.length > 0 # there are answered questions in this section or group
                 - g = q.question_group
                 - renderer = g.renderer
-                
+
                 - unless label.blank?
                   = render q.custom_renderer || "/partials/question", :q => label, :f => f, :disableFlag => true
                   - label = nil
-                = f.inputs q_text(g), :id => "g_#{g.id}", :class => "g_#{renderer} #{g.css_class(@response_set)}" do
+                = f.inputs g.text_for(@render_context, I18n.locale), :id => "g_#{g.id}", :class => "g_#{renderer} #{g.css_class(@response_set)}" do
                   %li.help= g.help_text
                   - case renderer
                     - when :grid
                       %li
                         %table
                           %col.pre
-                          - group_questions.first.answers.each do |a| 
+                          - group_questions.first.answers.each do |a|
                             %col{:class => cycle("odd", "even")}
                           %col.post
                           %tbody
@@ -41,17 +41,18 @@
                               %tr
                                 %th  
                                 - ten_questions.first.answers.each do |a|
-                                  %th= a_text(a)
+                                  %th
+                                    = a.text_for(nil, @render_context, I18n.locale)
+                                    %span.help= a.help_text_for(@render_context, I18n.locale)
                                 %th  
                               - ten_questions.each_with_index do |q, j|
                                 %tr{:id => "q_#{q.id}", :class => "q_#{renderer} #{q.css_class(@response_set)}"}
-                                  - if q.pick == "one"
-                                    - r = response_for(@response_set, q, nil, g)
-                                    - j = response_idx  # increment the response index since the answer partial skips for q.pick == one
-                                  %th= q.split(q.text, :pre)
+                                  %th
+                                    = q.text_for(:pre, @render_context, I18n.locale)
+                                    = q.help_text_for(@render_context, I18n.locale)
                                   - q.answers.each do |a|
-                                    %td= render a.custom_renderer || '/partials/answer', :g => g, :q => q, :a => a, :f => f, :disableFlag => true
-                                  %th= q.split(q.text, :post)
+                                    %td= render(a.custom_renderer || '/partials/answer', :g => g, :q => q, :a => a, :f => f, :disableFlag => true) unless q.display_type == "label"
+                                  %th= q.text_for(:post, @render_context, I18n.locale)
                     - when :repeater
                       - (@response_set.count_group_responses(group_questions) + 1).times do |rg|
                         %li
@@ -59,19 +60,15 @@
                             = render q.custom_renderer || "/partials/question", :g => g, :rg => rg, :q => q, :f => f, :disableFlag => true
                     - else # :inline
                       - answered_questions.each do |q|
-                        = render q.custom_renderer || "/partials/question", :g => g, :q => q, :f => f, :disableFlag => true         
-              
+                        = render q.custom_renderer || "/partials/question", :g => g, :q => q, :f => f, :disableFlag => true
               - group_questions = []
               - answered_questions = []
-          - else 
+          - else
             - if q.display_type == 'label'
-              - label = q
-            - unless @response_set.responses.where( :question_id => q.id).empty?
-              - unless label.blank?
-                = render q.custom_renderer || "/partials/question", :q => label, :f => f, :disableFlag => true
-                - label = nil
+              = render q.custom_renderer || "/partials/question", :q => q, :f => f, :disableFlag => true
+            - elsif !(@response_set.responses.where(:question_id => q.id).empty?)
               = render q.custom_renderer || "/partials/question", :q => q, :f => f, :disableFlag => true
               - answered_count = answered_count + 1
           - if (i+1 >= questions.size) and (answered_count == 0)
             #{"--- No data ---"}
-          
+

data/ci-exec.sh

@@ -1,6 +1,6 @@
 #!/bin/bash -xe
 
-BUNDLER_VERSION=1.1.5
+BUNDLER_VERSION=1.3.1
 GEMSET=surveyor
 
 if [ -z $CI_RUBY ]; then

data/config/routes.rb

@@ -1,8 +1,8 @@
-Rails.application.routes.draw do
-  match 'surveys', :to                                      => 'surveyor#new', :as    => 'available_surveys', :via => :get
-  match 'surveys/:survey_code', :to                         => 'surveyor#create', :as => 'take_survey', :via       => :post
-  match 'surveys/:survey_code', :to                    => 'surveyor#export', :as => 'export_survey', :via     => :get
-  match 'surveys/:survey_code/:response_set_code', :to      => 'surveyor#show', :as   => 'view_my_survey', :via    => :get
-  match 'surveys/:survey_code/:response_set_code/take', :to => 'surveyor#edit', :as   => 'edit_my_survey', :via    => :get
-  match 'surveys/:survey_code/:response_set_code', :to      => 'surveyor#update', :as => 'update_my_survey', :via  => :put
+Surveyor::Engine.routes.draw do
+  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
 end

data/features/internationalization.feature

@@ -8,7 +8,10 @@ Feature: Internationalization
   Given I parse
     """
     survey "One language is never enough" do
-      translations :es => "translations/languages.es.yml", :he => "translations/languages.he.yml", :ko => "translations/languages.ko.yml"
+      translations :en => :default
+      translations :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..."}}}}}
+      translations :he => {"title"=>"ידיעת שפה אחת אינה מספיקה", "survey_sections"=>{"one"=>{"title"=>"אחת"}}, "question_groups"=>{"hello"=>{"text"=>"שלום"}}, "questions"=>{"name"=>{"text"=>"מה שמך?", "answers"=>{"name"=>{"help_text"=>"שמי..."}}}}}
+      translations :ko => {"title"=>"한가지 언어로는 충분치 않습니다.", "survey_sections"=>{"one"=>{"title"=>"하나"}}, "question_groups"=>{"hello"=>{"text"=>"안녕하십니까"}}, "questions"=>{"name"=>{"text"=>"성함이 어떻게 되십니까?", "answers"=>{"name"=>{"help_text"=>"제 이름은 ... 입니다"}}}}}
       section_one "One" do
         g_hello "Hello" do
           q_name "What is your name?"
@@ -17,39 +20,102 @@ Feature: Internationalization
       end
     end
     """
-  Then there should be 3 translations with
+  Then there should be 4 translations with
     | locale |
+    | en     |
     | es     |
     | he     |
     | ko     |
   When I start the survey
   Then I should see "One language is never enough"
+    And a dropdown should exist with the options "en, es, he, ko"
+    And I should see "One"
+    And I should see "Hello"
+    And I should see "What is your name?"
+    And I should see "My name is..."
+  When I start the survey in "en"
+  Then I should see "One language is never enough"
+    And a dropdown should exist with the options "en, es, he, ko"
     And I should see "One"
     And I should see "Hello"
     And I should see "What is your name?"
     And I should see "My name is..."
   When I start the survey in "es"
   Then I should see "Un idioma nunca es suficiente"
+    And a dropdown should exist with the options "en, es, he, ko"
     And I should see "Uno"
     And I should see "¡Hola!"
     And I should see "¿Cómo se llama Usted?"
     And I should see "Mi nombre es..."
   When I start the survey in "he"
   Then I should see "ידיעת שפה אחת אינה מספיקה"
+    And a dropdown should exist with the options "en, es, he, ko"
     And I should see "אחת"
     And I should see "שלום"
     And I should see "מה שמך?"
     And I should see "שמי..."
   When I start the survey in "ko"
   Then I should see "한가지 언어로는 충분치 않습니다."
+    And a dropdown should exist with the options "en, es, he, ko"
     And I should see "하나"
     And I should see "안녕하십니까"
     And I should see "성함이 어떻게 되십니까?"
     And I should see "제 이름은 ... 입니다"
   When I start the survey
   Then I should see "One language is never enough"
+    And a dropdown should exist with the options "en, es, he, ko"
     And I should see "One"
     And I should see "Hello"
     And I should see "What is your name?"
     And I should see "My name is..."
 
+
+  Scenario:
+  Given I parse
+    """
+    survey "Favorites" do
+      section "Foods" do
+        question_1 "What is the best meat?", :pick => :one, :correct => "oink"
+        a_oink "bacon"
+        a_tweet "chicken"
+        a_moo "beef"
+      end
+    end
+    """
+   When I start the survey
+   Then I should not see "Language"
+
+  @javascript
+  Scenario:
+  Given I parse
+    """
+    survey "One language is never enough" do
+      translations :en => :default
+      translations :es => {"title"=>"Un idioma nunca es suficiente", "survey_sections"=>{"one"=>{"title"=>"Uno"}, "two"=>{"title"=>"Dos"}}, "question_groups"=>{"hello"=>{"text"=>"¡Hola!"}}, "questions"=>{"name"=>{"text"=>"¿Cómo se llama Usted?", "answers"=>{"name"=>{"help_text"=>"Mi nombre es..."}}}, "color"=>{"text"=>"¿Cuál es tu color favorito?"}}}
+      translations :he => {"title"=>"ידיעת שפה אחת אינה מספיקה", "survey_sections"=>{"one"=>{"title"=>"אחת"}, "two"=>{"title"=>"שנים"}}, "question_groups"=>{"hello"=>{"text"=>"שלום"}}, "questions"=>{"name"=>{"text"=>"מה שמך?", "answers"=>{"name"=>{"help_text"=>"שמי..."}}}, "color"=>{"text"=>"מהו הצבע האהוב עליך?"}}}
+
+      section_one "One" do
+        g_hello "Hello" do
+          q_name "What is your name?"
+          a_name :string, :help_text => "My name is..."
+        end
+      end
+
+      section_two "Two" do
+        q_color "What is your favorite color?"
+        a_name :string
+      end
+    end
+    """
+  When I start the survey in "en"
+  Then I should see "One language is never enough"
+    And I should see "What is your name?"
+    And I should see "Language"
+    And a dropdown should exist with the options "en, es, he"
+  When I change the locale to "es"
+  Then I should see "Un idioma nunca es suficiente"
+    And I should see "¿Cómo se llama Usted?"
+  When I press "Dos"
+  Then I should see "¿Cuál es tu color favorito?"
+  When I change the locale to "he"
+  Then I should see "מהו הצבע האהוב עליך?"

data/features/show_survey.feature

@@ -37,6 +37,35 @@ Feature: showing a survey
       | orange |
       | brown  |
     When I go to the last response set show page
+    Then I should see "You with the sad eyes don't be discouraged"
     Then the "blue" radiobutton should be checked
     And the "orange" checkbox should be checked
     And the "brown" checkbox should be checked
+
+  Scenario: Take a survey with group questions, then look at it
+    Given I parse
+    """
+      survey "Grid question test", :default_mandatory => false do
+        section 'Communication Skills' do
+          grid 'Identify communication and interviewing skills' do
+            a 'Yes'
+            a 'No'
+
+            q 'Able to articulate job duties and skills', :pick => :one
+          end
+
+          q 'Communication Skills Comments'
+          a :text
+        end
+      end
+    """
+    When I start the "Grid question test" survey
+    Then I should see "Identify communication and interviewing skills"
+    And I choose "Yes"
+    And I press "Click here to finish"
+    Then there should be 1 response set with 1 responses with:
+      | answer |
+      | Yes    |
+    When I go to the last response set show page
+    Then I should see "Identify communication and interviewing skills"
+    Then the "Yes" radiobutton should be checked

data/features/step_definitions/parser_steps.rb

@@ -88,7 +88,22 @@ end
 
 Then /^there should be (\d+) resolved dependency_condition(?:s?) with:$/ do |x, table|
   DependencyCondition.count.should == x.to_i
+  
   table.hashes.each do |hash|
+    if hash.has_key?("question_reference")
+      question = Question.find_by_reference_identifier(hash.delete("question_reference"))
+      question.should_not be_nil
+      
+      hash.merge!({ :question_id => question.id })
+      
+      if hash.has_key?("answer_reference")
+        answer = Answer.find(:first, :conditions => { :question_id => question.id, :reference_identifier => hash.delete("answer_reference") })
+        answer.should_not be_nil
+        
+        hash.merge!({ :answer_id => answer.id })
+      end
+    end
+   
     d = DependencyCondition.find(:first, :conditions => hash)
     d.should_not be_nil
     d.question.should_not be_nil

data/features/step_definitions/surveyor_steps.rb

@@ -18,10 +18,9 @@ When /^I start the survey$/ do
 end
 
 When /^I start the survey in "(.*?)"$/ do |locale|
-    visit(available_surveys_path(:locale => locale))
-    steps %Q{
-      And I press "#{I18n.t 'surveyor.take_it'}"
-    }
+    step %Q{I go to the surveys page in "#{locale}"}
+    # these steps need to be separated so the url param has a chance to set I18n.locale
+    step %Q{I press "#{I18n.t 'surveyor.take_it'}"}
 end
 
 
@@ -120,6 +119,7 @@ end
 Then /^there should (not )?be a (\w+ )?response(?: for answer "([^"]+)")?(?: with value "([^"]+)")?(?: on question "([^"]+)")?$/ do |neg, type, answer_reference_id, value, question_reference_id|
   conditions = []
   values = []
+  where = {}
   expected_count = neg.blank? ? 1 : 0
   if type
     attribute = case type.strip
@@ -132,10 +132,8 @@ Then /^there should (not )?be a (\w+ )?response(?: for answer "([^"]+)")?(?: wit
                 end
     if value
       case type.strip
-      when 'date'
-        # Work around deficient SQLite date handling
-        conditions << "date(#{attribute}) = date(?)"
-        values << value
+      when 'date' || 'datetime' || 'time'
+        where[:datetime_value] = Time.zone.parse(value).utc
       else
         conditions << "#{attribute} = ?"
         values << value
@@ -163,7 +161,7 @@ Then /^there should (not )?be a (\w+ )?response(?: for answer "([^"]+)")?(?: wit
     values << answer
   end
 
-  Response.where(conditions.join(' AND '), *values).count.should == expected_count
+  Response.where(conditions.join(' AND '), *values).where(where).count.should == expected_count
 end
 
 Then /^I should see the image "([^"]*)"$/ do |src|
@@ -321,3 +319,7 @@ end
 Then /^I set the asset directory$/ do
   ActionController::Base.helpers.config.assets_dir = "public" unless asset_pipeline_enabled?
 end
+
+When(/^I change the locale to "(.*?)"$/) do |locale|
+  steps %Q{When I select "#{locale}" from "new_locale"}
+end

data/features/support/paths.rb

@@ -10,10 +10,13 @@ module NavigationHelpers
 
     when /^the home\s?page$/
       '/'
-    when /the surveys page/
+    when /^the surveys page$/
       '/surveys'
+    when /the surveys page in "(.*)"$/
+      "/surveys?locale=#{$1}"
     when /the last response set show page/
-      view_my_survey_path(:survey_code => ResponseSet.last.survey.access_code, :response_set_code => ResponseSet.last.access_code)
+      "/surveys/#{ResponseSet.last.survey.access_code}/#{ResponseSet.last.access_code}"
+
     # Add more mappings here.
     # Here is an example that pulls values out of the Regexp:
     #