surveyor 1.3.0 → 1.4.0

data/features/z_redcap_parser.feature

@@ -14,7 +14,10 @@ Feature: Survey import from REDCap
     And there should be 233 answers with:
       ||
     And there should be 3 resolved dependency_conditions with:
-      ||
+      | rule_key	| operator	| question_reference | answer_reference |
+      | A	 		| ==		| sex				 | 0	  			|
+      | A	 		| ==		| sex				 | 0	  			|
+      | B	 		| ==		| given_birth		 | 1	  			|	
     And there should be 2 dependencies with:
       | rule    |
       | A       |

data/lib/assets/javascripts/surveyor/jquery.surveyor.js

@@ -35,7 +35,7 @@ jQuery(document).ready(function(){
   jQuery("input[type='text'].datetime").datetimepicker({
     showSecond: true,
     showMillisec: false,
-    timeFormat: 'hh:mm:ss',
+    timeFormat: 'HH:mm:ss',
     dateFormat: 'yy-mm-dd',
     changeMonth: true,
     changeYear: true
@@ -147,4 +147,8 @@ jQuery(document).ready(function(){
     $(e).mask(inputMask, options);
   });
 
+  // translations selection
+  $(".surveyor_language_selection").show();
+  $(".surveyor_language_selection select#locale").change(function(){ this.form.submit(); });
+
 });

data/lib/assets/stylesheets/surveyor.sass

@@ -47,6 +47,8 @@ body
         :border-bottom-width 1px
       li.active, li.active input[type="submit"]
         :background-color $surveyor_menus_active_color
+  .surveyor_language_selection
+    :display none
   //.previous_section
   .next_section
     :float right

data/lib/generators/surveyor/install_generator.rb

@@ -69,6 +69,10 @@ module Surveyor
       end
     end
 
+    def routes
+      route('mount Surveyor::Engine => "/surveys", :as => "surveyor"')
+    end
+
     def assets
       if asset_pipeline_enabled?
         directory "app/assets"

data/lib/generators/surveyor/templates/app/controllers/surveyor_controller.rb

@@ -27,11 +27,11 @@ module SurveyorControllerCustomMethods
   # Paths
   def surveyor_index
     # most of the above actions redirect to this method
-    super # available_surveys_path
+    super # surveyor.available_surveys_path
   end
   def surveyor_finish
     # the update action redirects to this method if given params[:finish]
-    super # available_surveys_path
+    super # surveyor.available_surveys_path
   end
 end
 class SurveyorController < ApplicationController

data/lib/generators/surveyor/templates/config/locales/surveyor_en.yml

@@ -16,3 +16,4 @@ en:
     next_section: "Next section »"
     select_one: "Select one ..."
     sections: "Sections"
+    language: "Language"

data/lib/generators/surveyor/templates/config/locales/surveyor_es.yml

@@ -16,3 +16,4 @@ es:
     next_section: "Sección siguiente »"
     select_one: "Seleccione una ..."
     sections: "Secciones"
+    language: "Idioma"

data/lib/generators/surveyor/templates/config/locales/surveyor_he.yml

@@ -16,3 +16,4 @@ he:
     next_section: "« המשך"
     select_one: "בחר/י"
     sections: "סעיפים"
+    language: "שפה"

data/lib/generators/surveyor/templates/config/locales/surveyor_ko.yml

@@ -15,4 +15,5 @@ ko:
     previous_section: "« 이전 항목으로"
     next_section: "다음 항목으로 »"
     select_one: "하나를 선택하십시요"
-    sections: "항목"
+    sections: "항목"
+    language: "언어"

data/lib/generators/surveyor/templates/surveys/languages.rb

@@ -1,10 +1,14 @@
 # encoding: UTF-8
 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, :es => "translations/languages.es.yml", :he => "translations/languages.he.yml", :ko => "translations/languages.ko.yml"
   section_one "One" do
     g_hello "Hello" do
-	    q_name "What is your name?"
-	    a_name :string, :help_text => "My name is..."
-	  end
+      q_name "What is your name?"
+      a_name :string, :help_text => "My name is..."
+    end
   end
-end
+  section_two "Two" do
+    q_color "What is your favorite color?"
+    a_name :string
+  end
+end

data/lib/generators/surveyor/templates/surveys/translations/languages.es.yml

@@ -3,6 +3,8 @@ title: "Un idioma nunca es suficiente"
 survey_sections:
   one:
     title: "Uno"
+  two:
+    title: "Dos"
 question_groups:
   hello:
     text: "¡Hola!"
@@ -12,3 +14,5 @@ questions:
     answers:
       name:
         help_text: "Mi nombre es..."
+  color:
+    text: "¿Cuál es tu color favorito?"

data/lib/generators/surveyor/templates/surveys/translations/languages.he.yml

@@ -3,6 +3,8 @@ title: "ידיעת שפה אחת אינה מספיקה"
 survey_sections:
   one:
     title: "אחת"
+  two:
+    title: "שנים"
 question_groups:
   hello:
     text: "שלום"
@@ -12,3 +14,5 @@ questions:
     answers:
       name:
         help_text: "שמי..."
+  color:
+    text: "מהו הצבע האהוב עליך?"

data/lib/generators/surveyor/templates/surveys/translations/languages.ko.yml

@@ -3,6 +3,8 @@ title: "한가지 언어로는 충분치 않습니다."
 survey_sections:
   one:
     title: "하나"
+  two:
+    title: "두"
 question_groups:
   hello:
     text: "안녕하십니까"
@@ -12,3 +14,5 @@ questions:
     answers:
       name:
         help_text: "제 이름은 ... 입니다"
+  color:
+    text: "좋아하는 색은 무엇입니까?"

data/lib/surveyor/helpers/surveyor_helper_methods.rb

@@ -79,7 +79,7 @@ module Surveyor
       def generate_pick_none_input_html(value, default_value, css_class, response_class, disabled, input_mask, input_mask_placeholder)
         html = {}
         html[:class] = [response_class,css_class].reject{ |c| c.blank? }
-        html[:value] = default_value if value.blank?
+        html[:value] = value.blank? ? default_value : value
         html[:disabled] = disabled unless disabled.blank?
         if input_mask
           html[:'data-input-mask'] = input_mask

data/lib/surveyor/models/answer_methods.rb

@@ -10,7 +10,7 @@ module Surveyor
         base.send :has_many, :validations, :dependent => :destroy
 
         # Scopes
-        base.send :default_scope, :order => "display_order ASC"
+        base.send :default_scope, :order => "#{base.quoted_table_name}.display_order ASC"
 
         # Mustache
         base.send :include, MustacheContext
@@ -83,4 +83,4 @@ module Surveyor
       end
     end
   end
-end
+end

data/lib/surveyor/models/question_methods.rb

@@ -7,12 +7,12 @@ module Surveyor
         # Associations
         base.send :belongs_to, :survey_section
         base.send :belongs_to, :question_group, :dependent => :destroy
-        base.send :has_many, :answers, :order => "display_order ASC", :dependent => :destroy # it might not always have answers
+        base.send :has_many, :answers, :dependent => :destroy # it might not always have answers
         base.send :has_one, :dependency, :dependent => :destroy
         base.send :belongs_to, :correct_answer, :class_name => "Answer", :dependent => :destroy
 
         # Scopes
-        base.send :default_scope, :order => "display_order ASC"
+        base.send :default_scope, :order => "#{base.quoted_table_name}.display_order ASC"
 
         # Mustache
         base.send :include, MustacheContext
@@ -112,4 +112,4 @@ module Surveyor
 
     end
   end
-end
+end

data/lib/surveyor/models/response_methods.rb

@@ -7,9 +7,6 @@ module Surveyor
         base.send :belongs_to, :question
         base.send :belongs_to, :answer
 
-        # Scopes
-        base.send :default_scope, :order => "created_at ASC"
-
         @@validations_already_included ||= nil
         unless @@validations_already_included
           # Validations
@@ -78,7 +75,23 @@ module Surveyor
       end
 
       def datetime_format
-        '%Y-%m-%d %H:%M'
+        '%Y-%m-%d %H:%M:%S'
+      end
+
+      def to_formatted_s
+        return "" if answer.nil? || answer.response_class.nil?
+        return case t = answer.response_class.to_sym
+               when :string, :text, :integer, :float
+                 send("#{t}_value".to_sym).to_s
+               when :date
+                 date_value
+               when :time
+                 time_value
+               when :datetime
+                 read_attribute(:datetime_value).strftime(datetime_format)
+               else
+                 to_s
+               end
       end
 
       def to_s # used in dependency_explanation_helper
@@ -99,7 +112,7 @@ module Surveyor
         }
 
         found = formats[answer.response_class]
-        found ?  datetime_value.try(:strftime, found) : as(answer.response_class)
+        found ? datetime_value.try{|d| d.utc.strftime(found)} : as(answer.response_class)
       end
     end
   end

data/lib/surveyor/models/response_set_methods.rb

@@ -7,7 +7,7 @@ module Surveyor
         # Associations
         base.send :belongs_to, :survey
         base.send :belongs_to, :user
-        base.send :has_many, :responses, :dependent => :destroy
+        base.send :has_many, :responses, :order => "#{Response.quoted_table_name}.created_at ASC", :dependent => :destroy
         base.send :accepts_nested_attributes_for, :responses, :allow_destroy => true
 
         @@validations_already_included ||= nil

data/lib/surveyor/models/survey_methods.rb

@@ -6,8 +6,8 @@ module Surveyor
     module SurveyMethods
       def self.included(base)
         # Associations
-        base.send :has_many, :sections, :class_name => "SurveySection", :order => 'display_order', :dependent => :destroy
-        base.send :has_many, :sections_with_questions, :include => :questions, :class_name => "SurveySection", :order => 'display_order'
+        base.send :has_many, :sections, :class_name => "SurveySection", :order => "#{SurveySection.quoted_table_name}.display_order", :dependent => :destroy
+        base.send :has_many, :sections_with_questions, :include => :questions, :class_name => "SurveySection", :order => "#{SurveySection.quoted_table_name}.display_order"
         base.send :has_many, :response_sets
         base.send :has_many, :translations, :class_name => "SurveyTranslation"
 

data/lib/surveyor/models/survey_section_methods.rb

@@ -3,7 +3,7 @@ module Surveyor
     module SurveySectionMethods
       def self.included(base)
         # Associations
-        base.send :has_many, :questions, :order => "display_order ASC", :dependent => :destroy
+        base.send :has_many, :questions, :dependent => :destroy
         base.send :belongs_to, :survey
 
         # Scopes
@@ -53,4 +53,4 @@ module Surveyor
       end
     end
   end
-end
+end

data/lib/surveyor/parser.rb

@@ -1,4 +1,7 @@
 %w(survey survey_translation survey_section question_group question dependency dependency_condition answer validation validation_condition).each {|model| require model }
+
+require 'yaml'
+
 module Surveyor
   class ParserError < StandardError; end
   class Parser
@@ -8,6 +11,9 @@ module Surveyor
     attr_accessor :context
 
     # Class methods
+    def self.parse_file(filename, options={})
+      self.parse(File.read(filename),{:filename => filename}.merge(options))
+    end
     def self.parse(str, options={})
       self.ensure_attrs
       self.options = options
@@ -82,6 +88,7 @@ module Surveyor
           resolve_dependency_condition_references
           resolve_question_correct_answers
           report_lost_and_duplicate_references
+          report_missing_default_locale
           Surveyor::Parser.rake_trace("", -2)
           if context[:survey].save
             Surveyor::Parser.rake_trace "Survey saved."
@@ -116,6 +123,11 @@ module Surveyor
     def block_models
       %w(survey survey_section question_group)
     end
+    def report_missing_default_locale
+      if !self.context[:survey].translations.empty? && self.context[:survey].translations.select{|t|YAML::load(t.translation)=={}}.empty?
+        Surveyor::Parser.raise_error("No default locale specified for translations.",true)
+      end
+    end
     def report_lost_and_duplicate_references
       Surveyor::Parser.raise_error("Bad references: #{self.context[:bad_references].join("; ")}", true) unless self.context[:bad_references].empty?
       Surveyor::Parser.raise_error("Duplicate references: #{self.context[:duplicate_references].join("; ")}", true) unless self.context[:duplicate_references].empty?
@@ -177,9 +189,18 @@ end
 # SurveySection model
 module SurveyorParserSurveyTranslationMethods
   def parse_and_build(context, args, original_method, reference_identifier)
+    dir = Surveyor::Parser.options[:filename].nil? ? Dir.pwd : File.dirname(Surveyor::Parser.options[:filename])
     # build, no change in context
     args[0].each do |k,v|
-      context[:survey].translations << self.class.new(:locale => k.to_s, :translation => File.read(Rails.root.join("surveys", v)))
+      case v
+      when Hash
+        trans = YAML::dump(v)
+      when String
+        trans = File.read(File.join(dir,v))
+      when :default
+        trans = YAML::dump({})
+      end
+      context[:survey].translations << self.class.new(:locale => k.to_s, :translation => trans)
     end
   end
 end
@@ -337,10 +358,10 @@ module SurveyorParserAnswerMethods
       self.attributes = ({:display_order => context[:question].answers.size}.merge(attrs))
       context[:question].answers << context[:answer] = self
       # keep reference for dependencies
-      unless context[:question].reference_identifier.blank? or reference_identifier.blank?
+      unless context[:question].reference_identifier.blank? or self.reference_identifier.blank?
         context[:answer_references][context[:question].reference_identifier] ||= {}
-        context[:duplicate_references].push "q_#{context[:question].reference_identifier}, a_#{reference_identifier}" if context[:answer_references][context[:question].reference_identifier].has_key?(reference_identifier)
-        context[:answer_references][context[:question].reference_identifier][reference_identifier] = context[:answer]
+        context[:duplicate_references].push "q_#{context[:question].reference_identifier}, a_#{self.reference_identifier}" if context[:answer_references][context[:question].reference_identifier].has_key?(self.reference_identifier)
+        context[:answer_references][context[:question].reference_identifier][self.reference_identifier] = context[:answer]
       end
     end
   end

data/lib/surveyor/redcap_parser.rb

@@ -62,16 +62,15 @@ module Surveyor
     end
     def resolve_references
       context[:dependency_conditions].each do |dc|
-        return unless dc.lookup_reference
         Surveyor::RedcapParser.rake_trace "resolve(#{dc.question_reference},#{dc.answer_reference})"
-        if dc.answer_reference.blank? and (row = dc.lookup_reference.find{|r| r[0] == dc.question_reference and r[1] == nil}) and row[2].answers.size == 1
+        if dc.answer_reference.blank? and (context[:question_references][dc.question_reference].answers.size == 1)
           Surveyor::RedcapParser.rake_trace "...found "
-          dc.question = row[2]
+          dc.question = context[:question_references][dc.question_reference]
           dc.answer = dc.question.answers.first
-        elsif row = dc.lookup_reference.find{|r| r[0] == dc.question_reference and r[1] == dc.answer_reference}
+        elsif answer = context[:answer_references][dc.question_reference][dc.answer_reference]
           Surveyor::RedcapParser.rake_trace "...found "
-          dc.answer = row[2]
-          dc.question = dc.answer.question
+          dc.answer = answer
+          dc.question = context[:question_references][dc.question_reference]
         else
           Surveyor::RedcapParser.rake_trace "\n!!! failed lookup for dependency_condition q: #{question_reference} a: #{question_reference}"
         end
@@ -118,8 +117,8 @@ module SurveyorRedcapParserQuestionMethods
     })
     context[:survey_section].questions << context[:question] = self
     unless context[:question].reference_identifier.blank?
-      context[:lookup] ||= []
-      context[:lookup] << [context[:question].reference_identifier, nil, context[:question]]
+      context[:question_references] ||= {}
+      context[:question_references][context[:question].reference_identifier] = context[:question]
     end
     Surveyor::RedcapParser.rake_trace "question_#{context[:question].reference_identifier} "
   end
@@ -141,7 +140,7 @@ module SurveyorRedcapParserDependencyMethods
       self.attributes = {:rule => hash[:rule]}
       context[:question].dependency = context[:dependency] = self
       hash[:components].each do |component|
-        dc = context[:dependency].dependency_conditions.build(decompose_component(component).merge(:lookup_reference => context[:lookup], :rule_key => letters.shift))
+        dc = context[:dependency].dependency_conditions.build(decompose_component(component).merge({ :rule_key => letters.shift } ))
         context[:dependency_conditions] << dc
       end
       Surveyor::RedcapParser.rake_trace "dependency(#{hash[:rule]}) "
@@ -193,8 +192,8 @@ end
 # DependencyCondition model
 module SurveyorRedcapParserDependencyConditionMethods
   DependencyCondition.instance_eval do
-    attr_accessor :question_reference, :answer_reference, :lookup_reference
-    attr_accessible :question_reference, :answer_reference, :lookup_reference
+    attr_accessor :question_reference, :answer_reference
+    attr_accessible :question_reference, :answer_reference
   end
 end
 
@@ -228,8 +227,9 @@ module SurveyorRedcapParserAnswerMethods
           :display_order => context[:question].answers.size })
         context[:question].answers << context[:answer] = a
         unless context[:question].reference_identifier.blank? or aref.blank? or !context[:answer].valid?
-          context[:lookup] ||= []
-          context[:lookup] << [context[:question].reference_identifier, aref, context[:answer]]
+          context[:answer_references] ||= {}
+          context[:answer_references][context[:question].reference_identifier] ||= {}
+          context[:answer_references][context[:question].reference_identifier][aref] = context[:answer]
         end
         Surveyor::RedcapParser.rake_trace "#{context[:answer].errors.full_messages}, #{context[:answer].inspect}" unless context[:answer].valid?
         Surveyor::RedcapParser.rake_trace "answer_#{context[:answer].reference_identifier} "

data/lib/surveyor/surveyor_controller_methods.rb

@@ -15,7 +15,7 @@ module Surveyor
     # Actions
     def new
       @surveys_by_access_code = Survey.order("created_at DESC, survey_version DESC").all.group_by(&:access_code)
-      redirect_to surveyor_index unless surveyor_index == available_surveys_path
+      redirect_to surveyor_index unless surveyor_index == surveyor.available_surveys_path
     end
 
     def create
@@ -29,7 +29,7 @@ module Surveyor
         create(:survey => @survey, :user_id => (@current_user.nil? ? @current_user : @current_user.id))
       if (@survey && @response_set)
         flash[:notice] = t('surveyor.survey_started_success')
-        redirect_to(edit_my_survey_path(
+        redirect_to(surveyor.edit_my_survey_path(
           :survey_code => @survey.access_code, :response_set_code  => @response_set.access_code))
       else
         flash[:notice] = t('surveyor.Unable_to_find_that_survey')
@@ -60,11 +60,7 @@ module Surveyor
       if @response_set
         @survey = Survey.with_sections.find_by_id(@response_set.survey_id)
         @sections = @survey.sections
-        if params[:section]
-          @section = @sections.with_includes.find(section_id_from(params[:section])) || @sections.with_includes.first
-        else
-          @section = @sections.with_includes.first
-        end
+        @section = @sections.with_includes.find(section_id_from(params) || :first) || @sections.with_includes.first
         set_dependents
       else
         flash[:notice] = t('surveyor.unable_to_find_your_responses')
@@ -81,11 +77,10 @@ module Surveyor
       respond_to do |format|
         format.html do
           if @response_set.nil?
-            return redirect_with_message(available_surveys_path, :notice, t('surveyor.unable_to_find_your_responses'))
+            return redirect_with_message(surveyor.available_surveys_path, :notice, t('surveyor.unable_to_find_your_responses'))
           else
             flash[:notice] = t('surveyor.unable_to_update_survey') unless saved
-            redirect_to edit_my_survey_path(
-              :anchor => anchor_from(params[:section]), :section => section_id_from(params[:section]))
+            redirect_to surveyor.edit_my_survey_path(:anchor => anchor_from(params[:section]), :section => section_id_from(params))
           end
         end
         format.js do
@@ -167,18 +162,26 @@ module Surveyor
     end
 
      def set_locale
-       if params[:locale]
-         I18n.locale = params[:locale]
-       else
-         I18n.locale = I18n.default_locale
-       end
+      if params[:new_locale]
+        I18n.locale = params[:new_locale]
+      elsif params[:locale]
+        I18n.locale = params[:locale]
+      else
+        I18n.locale = I18n.default_locale
+      end
     end
 
     # Params: the name of some submit buttons store the section we'd like to go
     # to. for repeater questions, an anchor to the repeater group is also stored
     # e.g. params[:section] = {"1"=>{"question_group_1"=>"<= add row"}}
-    def section_id_from(p)
-      p.respond_to?(:keys) ? p.keys.first : p
+    def section_id_from(p = {})
+      if p[:section] && p[:section].respond_to?(:keys)
+        p[:section].keys.first
+      elsif p[:section]
+        p[:section]
+      elsif p[:current_section]
+        p[:current_section]
+      end
     end
 
     def anchor_from(p)
@@ -186,10 +189,10 @@ module Surveyor
     end
 
     def surveyor_index
-      available_surveys_path
+      surveyor.available_surveys_path
     end
     def surveyor_finish
-      available_surveys_path
+      surveyor.available_surveys_path
     end
 
     def redirect_with_message(path, message_type, message)