surveyor 0.20.0 → 0.21.0

data/{generators/surveyor/templates/assets/javascripts → lib/generators/surveyor/templates/public/javascripts/surveyor}/jquery.surveyor.js

@@ -24,23 +24,66 @@ jQuery(document).ready(function(){
   });
 
   jQuery("form#survey_form input, form#survey_form select, form#survey_form textarea").change(function(){
+    var elements = [$('[type="submit"]').parent(), $('[name="' + this.name +'"]').closest('li')];
+    blockElements(elements);
+    
     question_data = $(this).parents('fieldset[id^="q_"],tr[id^="q_"]').find("input, select, textarea").add($("form#survey_form input[name='authenticity_token']")).serialize();
     // console.log(unescape(question_data));
-    $.ajax({ type: "PUT", url: $(this).parents('form#survey_form').attr("action"), data: question_data, dataType: 'json', success: successfulSave })
+    $.ajax({ 
+      type: "PUT", 
+      url: $(this).parents('form#survey_form').attr("action"), 
+      data: question_data, dataType: 'json', 
+      success: function(response) {
+        unblockElements(elements);
+        successfulSave(response);
+      }, 
+      error: function(xhr, ajaxOptions, thrownError) {
+        unblockElements(elements);
+      }
+    });
   });
-  // }
 
   // If javascript works, we don't need to show dependents from previous sections at the top of the page.
   jQuery("#dependents").remove();
 
   function successfulSave(responseText){ // for(key in responseText) { console.log("key is "+[key]+", value is "+responseText[key]); }
     // surveyor_controller returns a json object to show/hide elements and insert/remove ids e.g. {"ids": {"2" => 234}, "remove": {"4" => 21}, "hide":["question_12","question_13"],"show":["question_14"]}
-    jQuery.each(responseText.show, function(){ jQuery('#' + this).show("fast"); });
-    jQuery.each(responseText.hide, function(){ jQuery('#' + this).hide("fast"); });
+    jQuery.each(responseText.show, function(){ showElement(this) });
+    jQuery.each(responseText.hide, function(){ hideElement(this) });
     jQuery.each(responseText.ids, function(k,v){ jQuery('#r_'+k+'_question_id').after('<input id="r_'+k+'_id" type="hidden" value="'+v+'" name="r['+k+'][id]"/>'); });
     jQuery.each(responseText.remove, function(k,v){ jQuery('#r_'+k+'_id[value="'+v+'"]').remove(); });
     return false;
   }
+  
+  function showElement(id){
+    group = id.match('^g_') ? true : false;
+    if (group) {
+      jQuery('#' + id).removeClass("g_hidden");
+    } else {
+      jQuery('#' + id).removeClass("q_hidden");
+    }
+  }
+  
+  function hideElement(id){
+    group = id.match('^g_') ? true : false;
+    if (group) {
+      jQuery('#' + id).addClass("g_hidden");
+    } else {
+      jQuery('#' + id).addClass("q_hidden");
+    }
+  }
+  
+  function blockElements(elements) {
+    $.blockUI.defaults.overlayCSS.opacity = 0;
+    $.blockUI.defaults.message = null;
+    $.blockUI.defaults.fadeIn = 0;
+    $.blockUI.defaults.fadeOut = 0;
+    $.each(elements, function(){ $(this).block()});
+  }
+  
+  function unblockElements(elements) {
+    $.each(elements, function(){ $(this).unblock()});
+  }
 
   // is_exclusive checkboxes should disble sibling checkboxes
   $('input.exclusive:checked').parents('fieldset[id^="q_"]').find(':checkbox').not(".exclusive").attr('checked', false).attr('disabled', true);

data/{generators/surveyor/templates/assets → lib/generators/surveyor/templates/public}/stylesheets/sass/surveyor.sass

@@ -95,7 +95,7 @@ body
       li.datetime, li.time
         input, fieldset, fieldset ol li
           :display inline
-    &.q_inline ol li
+    &.q_inline ol li, &.q_inline_inline ol li
       :display inline
     input, textarea, select
       :margin 0 3px
@@ -103,7 +103,7 @@ body
       :font-size 0.8em
 
   fieldset.q_hidden, fieldset.g_hidden
-    :display none
+    :display none !important
   fieldset.q_dependent, fieldset.g_dependent
     :background-color $surveyor_dependent_color
     legend

data/lib/surveyor.rb

@@ -1,6 +1,13 @@
+module Surveyor
+  require 'surveyor/engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+
+  autoload :VERSION, 'surveyor/version'
+end
 require 'surveyor/common'
 require 'surveyor/acts_as_response'
 require 'formtastic/surveyor_builder'
+# require 'surveyor/surveyor_controller_methods'
+# require 'surveyor/models/survey_methods'
 Formtastic::SemanticFormHelper.builder = Formtastic::SurveyorBuilder
 Formtastic::SemanticFormBuilder.default_text_area_height = 5
 Formtastic::SemanticFormBuilder.default_text_area_width = 50

data/lib/surveyor/engine.rb

@@ -0,0 +1,12 @@
+require 'rails'
+require 'surveyor'
+require 'haml' # required for view resolution
+
+module Surveyor
+  class Engine < Rails::Engine
+    config.autoload_paths << File.expand_path("../../", __FILE__)
+    # rake_tasks do
+    #   load "tasks/surveyor_tasks.rake"
+    # end
+  end
+end

data/lib/surveyor/models/answer_methods.rb

@@ -29,7 +29,6 @@ module Surveyor
       end
 
       def default_args
-        self.display_order ||= self.question ? self.question.answers.count : 0
         self.is_exclusive ||= false
         self.display_type ||= "default"
         self.response_class ||= "answer"

data/lib/surveyor/models/dependency_condition_methods.rb

@@ -33,9 +33,7 @@ module Surveyor
       # Instance methods
       def to_hash(response_set)
         # all responses to associated question
-        responses = response_set.responses.select do |r| 
-          question && question.answers.include?(r.answer)
-        end
+        responses = question.blank? ? [] : response_set.responses.where("responses.answer_id in (?)", question.answer_ids).all
         {rule_key.to_sym => (!responses.empty? and self.is_met?(responses))}
       end
 

data/lib/surveyor/models/question_methods.rb

@@ -36,7 +36,6 @@ module Surveyor
         self.is_mandatory ||= true
         self.display_type ||= "default"
         self.pick ||= "none"
-        self.display_order ||= self.survey_section ? self.survey_section.questions.count : 0
         self.data_export_identifier ||= Surveyor::Common.normalize(text)
         self.short_text ||= text
         self.api_id ||= UUID.generate

data/lib/surveyor/models/response_methods.rb

@@ -34,7 +34,7 @@ module Surveyor
         write_attribute :answer_id, (val.is_a?(Array) ? val.detect{|x| !x.to_s.blank?} : val)
       end
       def correct?
-        question.correct_answer_id.nil? or self.answer.response_class != "answer" or (question.correct_answer_id.to_i == answer_id.to_i)
+        question.correct_answer.nil? or self.answer.response_class != "answer" or (question.correct_answer.id.to_i == answer.id.to_i)
       end
 
       def to_s # used in dependency_explanation_helper
@@ -46,4 +46,4 @@ module Surveyor
       end
     end
   end
-end
+end

data/lib/surveyor/models/response_set_methods.rb

@@ -9,39 +9,41 @@ module Surveyor
         base.send :belongs_to, :user
         base.send :has_many, :responses, :dependent => :destroy
         base.send :accepts_nested_attributes_for, :responses, :allow_destroy => true
-        
+
         @@validations_already_included ||= nil
         unless @@validations_already_included
           # Validations
           base.send :validates_presence_of, :survey_id
           base.send :validates_associated, :responses
           base.send :validates_uniqueness_of, :access_code
-          
+
           @@validations_already_included = true
         end
 
         # Attributes
         base.send :attr_protected, :completed_at
-        
+
         # Class methods
         base.instance_eval do
-          def reject_or_destroy_blanks(hash_of_hashes)
-            result = {}
+          def to_savable(hash_of_hashes)
+            result = []
             (hash_of_hashes || {}).each_pair do |k, hash|
               hash = Response.applicable_attributes(hash)
               if has_blank_value?(hash)
-                result.merge!({k => hash.merge("_destroy" => "true")}) if hash.has_key?("id")
+                result << hash.merge!({:_destroy => '1'}).except('answer_id') if hash.has_key?('id')
               else
-                result.merge!({k => hash})
+                result << hash
               end
             end
             result
           end
+
           def has_blank_value?(hash)
             return true if hash["answer_id"].blank?
             return false if (q = Question.find_by_id(hash["question_id"])) and q.pick == "one"
             hash.any?{|k,v| v.is_a?(Array) ? v.all?{|x| x.to_s.blank?} : v.to_s.blank?}
           end
+
           def trim_for_lookups(hash_of_hashes)
             result = {}
             (reject_or_destroy_blanks(hash_of_hashes) || {}).each_pair do |k, hash|
@@ -49,6 +51,20 @@ module Surveyor
             end
             result
           end
+
+          private
+            def reject_or_destroy_blanks(hash_of_hashes)
+              result = {}
+              (hash_of_hashes || {}).each_pair do |k, hash|
+                hash = Response.applicable_attributes(hash)
+                if has_blank_value?(hash)
+                  result.merge!({k => hash.merge("_destroy" => "true")}) if hash.has_key?("id")
+                else
+                  result.merge!({k => hash})
+                end
+              end
+              result
+            end
         end
       end
 
@@ -86,7 +102,7 @@ module Surveyor
       def complete!
         self.completed_at = Time.now
       end
-      
+
       def complete?
         !completed_at.nil?
       end
@@ -131,13 +147,13 @@ module Surveyor
       def unanswered_dependencies
         unanswered_question_dependencies + unanswered_question_group_dependencies
       end
-      
+
       def unanswered_question_dependencies
-        dependencies.select{|d| d.is_met?(self) and d.question and self.is_unanswered?(d.question)}.map(&:question)
+        dependencies.select{ |d| d.question && self.is_unanswered?(d.question) && d.is_met?(self) }.map(&:question)
       end
-      
+
       def unanswered_question_group_dependencies
-        dependencies.select{|d| d.is_met?(self) and d.question_group and self.is_group_unanswered?(d.question_group)}.map(&:question_group)
+        dependencies.select{ |d| d.question_group && self.is_group_unanswered?(d.question_group) && d.is_met?(self) }.map(&:question_group)
       end
 
       def all_dependencies(question_ids = nil)
@@ -151,11 +167,11 @@ module Surveyor
       end
 
       protected
-      
+
       def dependencies(question_ids = nil)
         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 condition clause includes an association limiter
-        deps.each{|d| d.dependency_conditions.reload} 
+        deps.each{|d| d.dependency_conditions.reload}
         deps
       end
     end

data/lib/surveyor/models/survey_methods.rb

@@ -10,7 +10,7 @@ module Surveyor
         base.send :has_many, :response_sets
 
         # Scopes
-        base.send :named_scope, :with_sections, {:include => :sections}
+        base.send :scope, :with_sections, {:include => :sections}
         
         @@validations_already_included ||= nil
         unless @@validations_already_included
@@ -39,6 +39,7 @@ module Surveyor
       def default_args
         self.inactive_at ||= DateTime.now
         self.api_id ||= UUID.generate
+        self.display_order ||= Survey.count
       end
 
       def title=(value)

data/lib/surveyor/models/survey_section_methods.rb

@@ -8,7 +8,7 @@ module Surveyor
 
         # Scopes
         base.send :default_scope, :order => "display_order ASC"
-        base.send :named_scope, :with_includes, { :include => {:questions => [:answers, :question_group, {:dependency => :dependency_conditions}]}}
+        base.send :scope, :with_includes, { :include => {:questions => [:answers, :question_group, {:dependency => :dependency_conditions}]}}
         
         @@validations_already_included ||= nil
         unless @@validations_already_included
@@ -28,7 +28,6 @@ module Surveyor
       end
 
       def default_args
-        self.display_order ||= survey ? survey.sections.count : 0
         self.data_export_identifier ||= Surveyor::Common.normalize(title)
       end
 

data/lib/surveyor/parser.rb

@@ -80,7 +80,7 @@ class Survey < ActiveRecord::Base
     # build and set context
     title = args[0]
     context[:survey] = new({  :title => title, 
-                              :reference_identifier => reference_identifier}.merge(args[1] || {}))
+                              :reference_identifier => reference_identifier }.merge(args[1] || {}))
   end
   def clear(context)
     context.delete_if{|k,v| true }
@@ -97,7 +97,8 @@ class SurveySection < ActiveRecord::Base
     
     # build and set context
     title = args[0]
-    context[:survey_section] = context[:survey].sections.build({ :title => title }.merge(args[1] || {}))
+    context[:survey_section] = context[:survey].sections.build({ :title => title,
+                                                                 :display_order => context[:survey].sections.size }.merge(args[1] || {}))
   end
   def clear(context)
     context.delete_if{|k,v| !%w(survey question_references answer_references).map(&:to_sym).include?(k)}
@@ -137,7 +138,8 @@ class Question < ActiveRecord::Base
       :question_group => context[:question_group],
       :reference_identifier => reference_identifier,
       :text => text,
-      :display_type => (original_method =~ /label|image/ ? original_method : "default")}.merge(args[1] || {}))
+      :display_type => (original_method =~ /label|image/ ? original_method : "default"),
+      :display_order => context[:survey_section].questions.size }.merge(args[1] || {}))
     
     # keep reference for dependencies
     context[:question_references][reference_identifier] = context[:question] unless reference_identifier.blank?
@@ -218,15 +220,15 @@ class Answer < ActiveRecord::Base
     # clear context
     context.delete_if{|k,v| %w(answer validation validation_condition reference_identifier).map(&:to_sym).include? k}
 
-    attrs = { :reference_identifier => reference_identifier}.merge(self.parse_args(args))
+    attrs = { :reference_identifier => reference_identifier }.merge(self.parse_args(args))
                               
     # add answers to grid
     if context[:question_group] && context[:question_group].display_type == "grid"
-      context[:answer] = new(attrs)
-      context[:grid_answers] ||= []
+      context[:grid_answers] ||= []      
+      context[:answer] = new({:display_order => [:grid_answers].size}.merge(attrs))
       context[:grid_answers] << context[:answer]
     else
-      context[:answer] = context[:question].answers.build(attrs)
+      context[:answer] = context[:question].answers.build({:display_order => context[:question].answers.size}.merge(attrs))
       context[:answer_references][context[:question].reference_identifier] ||= {} unless context[:question].reference_identifier.blank?
       context[:answer_references][context[:question].reference_identifier][reference_identifier] = context[:answer] unless reference_identifier.blank? or context[:question].reference_identifier.blank?
     end

data/lib/surveyor/redcap_parser.rb

@@ -35,7 +35,7 @@ module Surveyor
             Dependency.build_and_set(context, r)
           end
         end
-        print context[:survey].save ? "saved. " : " not saved! #{context[:survey].errors.each_full{|x| x }.join(", ")} "
+        print context[:survey].save ? "saved. " : " not saved! #{context[:survey].errors.full_messages.join(", ")} "
         # print context[:survey].sections.map(&:questions).flatten.map(&:answers).flatten.map{|x| x.errors.each_full{|y| y}.join}.join
       rescue csvlib::MalformedCSVError
         puts = "Oops. Not a valid CSV file."
@@ -65,7 +65,9 @@ class SurveySection < ActiveRecord::Base
       if match = context[:survey].sections.detect{|ss| ss.reference_identifier == r[:form_name]}
         context[:current_survey_section] = match
       else
-        context[:survey_section] = context[:survey].sections.build({:title => r[:form_name].to_s.humanize, :reference_identifier => r[:form_name]})
+        context[:survey_section] = context[:survey].sections.build({:title => r[:form_name].to_s.humanize, 
+                                                                    :reference_identifier => r[:form_name],
+                                                                    :display_order => context[:survey].sections.size })
         print "survey_section_#{context[:survey_section].reference_identifier} "
       end
     end
@@ -76,7 +78,7 @@ end
 class Question < ActiveRecord::Base
   def self.build_and_set(context, r)
     if !r[:section_header].blank?
-      context[:survey_section].questions.build({:display_type => "label", :text => r[:section_header]})
+      context[:survey_section].questions.build({:display_type => "label", :text => r[:section_header], :display_order => context[:survey_section].questions.size})
       print "label_ "
     end
     context[:question] = context[:survey_section].questions.build({
@@ -85,7 +87,8 @@ class Question < ActiveRecord::Base
       :help_text => r[:field_note],
       :is_mandatory => (/^y/i.match r[:required_field]) ? true : false,
       :pick => pick_from_field_type(r[:field_type]),
-      :display_type => display_type_from_field_type(r[:field_type])
+      :display_type => display_type_from_field_type(r[:field_type]),
+      :display_order => context[:survey_section].questions.size
     })
     unless context[:question].reference_identifier.blank?
       context[:lookup] ||= []
@@ -178,9 +181,9 @@ class Answer < ActiveRecord::Base
   def self.build_and_set(context, r)
     case r[:field_type]
     when "text"
-      context[:answer] = context[:question].answers.build(:response_class => "string", :text => "Text")
+      context[:answer] = context[:question].answers.build(:response_class => "string", :text => "Text", :display_order => context[:question].answers.size)
     when "notes"
-      context[:answer] = context[:question].answers.build(:response_class => "text", :text => "Notes")
+      context[:answer] = context[:question].answers.build(:response_class => "text", :text => "Notes", :display_order => context[:question].answers.size)
     when "file"
       puts "\n!!! skipping answer: file"
     end
@@ -189,7 +192,7 @@ class Answer < ActiveRecord::Base
       if aref.blank? or atext.blank? or (aref.to_i.to_s != aref)
         puts "\n!!! skipping answer #{pair}"
       else
-        context[:answer] = context[:question].answers.build(:reference_identifier => aref, :text => atext)
+        context[:answer] = context[:question].answers.build(:reference_identifier => aref, :text => atext, :display_order => context[:question].answers.size)
         unless context[:question].reference_identifier.blank? or aref.blank? or !context[:answer].valid?
           context[:lookup] ||= []
           context[:lookup] << [context[:question].reference_identifier, aref, context[:answer]]

data/lib/surveyor/surveyor_controller_methods.rb

@@ -2,6 +2,7 @@ module Surveyor
   module SurveyorControllerMethods
     def self.included(base)
       base.send :before_filter, :get_current_user, :only => [:new, :create]
+      base.send :before_filter, :determine_if_javascript_is_enabled, :only => [:create, :update]
       base.send :layout, 'surveyor_default'
     end
 
@@ -45,12 +46,12 @@ 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 
+        if params[:section]
+          @section = @sections.with_includes.find(section_id_from(params[:section])) || @sections.with_includes.first
         else
           @section = @sections.with_includes.first
         end
-        @dependents = (@response_set.unanswered_dependencies - @section.questions) || []
+        set_dependents
       else
         flash[:notice] = t('surveyor.unable_to_find_your_responses')
         redirect_to surveyor_index
@@ -58,20 +59,25 @@ module Surveyor
     end
 
     def update
-      @response_set = ResponseSet.find_by_access_code(params[:response_set_code], :include => {:responses => :answer}, :lock => true)
-      return redirect_with_message(available_surveys_path, :notice, t('surveyor.unable_to_find_your_responses')) if @response_set.blank?
       saved = false
       ActiveRecord::Base.transaction do
-        saved = @response_set.update_attributes(:responses_attributes => ResponseSet.reject_or_destroy_blanks(params[:r]))
-        @response_set.complete! if saved && params[:finish]
-        saved &= @response_set.save
+        @response_set = ResponseSet.find_by_access_code(params[:response_set_code], :include => {:responses => :answer}, :lock => true)
+        unless @response_set.blank?
+          saved = @response_set.update_attributes(:responses_attributes => ResponseSet.to_savable(params[:r]))
+          @response_set.complete! if saved && params[:finish]
+          saved &= @response_set.save
+        end
       end
       return redirect_with_message(surveyor_finish, :notice, t('surveyor.completed_survey')) if saved && params[:finish]
 
       respond_to do |format|
         format.html do
-          flash[:notice] = t('surveyor.unable_to_update_survey') unless saved
-          redirect_to :action => "edit", :anchor => anchor_from(params[:section]), :params => {:section => section_id_from(params[:section])}
+          if @response_set.blank?
+            return redirect_with_message(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]))
+          end
         end
         format.js do
           ids, remove, question_ids = {}, {}, []
@@ -109,7 +115,7 @@ module Surveyor
     def surveyor_finish
       available_surveys_path
     end
-    
+
     def redirect_with_message(path, message_type, message)
       respond_to do |format|
         format.html do
@@ -121,5 +127,33 @@ module Surveyor
         end
       end
     end
+    
+    ##
+    # @dependents are necessary in case the client does not have javascript enabled
+    # Whether or not javascript is enabled is determined by a hidden field set in the surveyor/edit.html form 
+    def set_dependents
+      if session[:surveyor_javascript] && session[:surveyor_javascript] == "enabled"
+        @dependents = []
+      else
+        @dependents = get_unanswered_dependencies_minus_section_questions
+      end
+    end
+    
+    def get_unanswered_dependencies_minus_section_questions
+      @response_set.unanswered_dependencies - @section.questions || []
+    end
+    
+    ##
+    # If the hidden field surveyor_javascript_enabled is set to true
+    # cf. surveyor/edit.html.haml
+    # the set the session variable [:surveyor_javascript] to "enabled"
+    def determine_if_javascript_is_enabled
+      if params[:surveyor_javascript_enabled] && params[:surveyor_javascript_enabled].to_s == "true"
+        session[:surveyor_javascript] = "enabled"
+      else
+        session[:surveyor_javascript] = "not_enabled"
+      end
+    end
+    
   end
 end