surveyor 0.21.0 → 0.22.0

data/lib/generators/surveyor/templates/surveys/EXTENDING_SURVEYOR.md

@@ -29,6 +29,20 @@ For example, create app/models/survey.rb with the following contents:
 
 == SurveyorHelper
 
+The SurveyorHelper module can be customized just like the models:
+
+    module SurveyorHelper
+      include Surveyor::Helpers::SurveyorHelperMethods
+      def rc_to_as(type_sym)
+        case type_sym.to_s
+        when /(integer|float)/ then :string
+        when /(datetime)/ then :string
+        when /^date$/ then :string
+        else type_sym
+        end
+      end
+    end
+
 == Views
 
 Surveyor's views can be overwritten by simply creating views in app/views/surveyor

data/lib/generators/surveyor/templates/surveys/MODIFYING_SURVEYOR.md

@@ -0,0 +1,91 @@
+== Dates, Times, and Javascript Date Picker
+
+== Default JQuery Date Picker
+
+By default Surveyor uses the JQuery-UI date picker (http://jqueryui.com/demos/datepicker/)
+for all date and time fields (denoted by :date, :time, or :datetime for the answer in the survey).
+
+== Using Rails Date Helpers
+
+It is possible (and relatively easy) to use the default Rails
+date helpers (http://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html)
+instead of the javascript date picker.
+
+To do so you would need to override two methods in the SurveyorHelperMethods. Currently the
+rc_to_attr and rc_to_as handle how the form fields are displayed. The formtastic input method
+(https://github.com/justinfrench/formtastic) used in the _answer.html.haml partial
+calls the rc_to_attr method to get the attribute for the answer object
+and then calls the rc_to_as method to get the value to set the :as parameter.
+
+    ff.input rc_to_attr(a.response_class), :as => rc_to_as(a.response_class)
+
+    def rc_to_attr(type_sym)
+      case type_sym.to_s
+      when /^answer$/ then :answer_id
+      else "#{type_sym.to_s}_value".to_sym
+      end
+    end
+
+    def rc_to_as(type_sym)
+      case type_sym.to_s
+      when /(integer|float|date|time|datetime)/ then :string
+      else type_sym
+      end
+    end
+
+First, we would need to set that the attribute to be used is the :datetime_value attribute on the
+answer. (By default we use the custom date_value and time_value methods which wrap the :datetime_value
+on the answer to work with the string representation of those values). To do this we would need to
+change the rc_to_attr method so that either the date or time types return the :datetime_value attribute
+
+    def rc_to_attr(type_sym)
+      case type_sym.to_s
+      when /^date|time$/ then :datetime_value
+      when /^(string|text|integer|float|datetime)$/ then "#{type_sym.to_s}_value".to_sym
+      else :answer_id
+      end
+    end
+
+
+Second, we would need to update the rc_to_as method so that the date, time, and/or datetime
+answer types would return those values rather than string as they do by default
+
+    def rc_to_as(type_sym)
+      case type_sym.to_s
+      when /(integer|float)/ then :string
+      else type_sym
+      end
+    end
+
+Of course, you could mix and match which attribute types could be show with the Rails Date Helper
+methods and which ones could use the javascript date picker.
+
+== JQuery Tools Date Input
+
+If you would like to use JQuery Tools dateinput instead (http://jquerytools.org/demos/dateinput/index.html)
+you would need to edit the
+vendor/assets/javascripts/surveyor/jquery.surveyor.js file.
+
+Replace the jquery-ui datepicker lines:
+
+    jQuery("input[type='text'].date").datepicker({
+    	dateFormat: 'yy-mm-dd',
+    	changeMonth: true,
+    	changeYear: true
+    });
+
+with those for the jquery tools dateinput
+
+    jQuery('li input.date').dateinput({
+        format: 'dd mmm yyyy'
+    });
+
+(note that you may need to add the following to make the jquery tools dateinput widget to work properly)
+
+    jQuery('li.date input').change(function(){
+        if ( $(this).data('dateinput') ) {
+            var date_obj = $(this).data('dateinput').getValue();
+            this.value = date_obj.getFullYear() + "-" + (date_obj.getMonth()+1) + "-" +
+                date_obj.getDate() + " 00:00:00 UTC";
+        }
+    });

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

@@ -0,0 +1,15 @@
+survey "Date Survey" do
+
+  section "Simple date questions" do
+
+    q "What is your birth date?"
+    a :date
+
+    q "At what time were you born?"
+    a :time
+
+    q "When would you like to schedule your next appointment?"
+    a :datetime
+
+  end
+end

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

@@ -25,7 +25,7 @@ survey "Kitchen Sink survey" do
     # the question's reference identifier is "2a", and the answer's reference_identifier is "1"
     # question reference identifiers used in conditions need to be unique on a survey for the lookups to work
     q_2a "Please explain why you don't like this color?"
-    a_1 "explanation", :text
+    a_1 "explanation", :text, :help_text => "Please give an explanation for each color you don't like"
     dependency :rule => "A or B or C or D"
     condition_A :q_2, "==", :a_1
     condition_B :q_2, "==", :a_2
@@ -110,7 +110,7 @@ survey "Kitchen Sink survey" do
     # Questions may be grouped
     group "How much oil do you use per day?", :display_type => :inline do
       q "Quantity"
-      a "Quantity", :float
+      a :float
 
       q "Unit", :pick => :one, :display_type => :dropdown
       a "Barrels"

data/lib/surveyor/common.rb

@@ -1,3 +1,5 @@
+require 'uuidtools'
+
 module Surveyor
   class Common
     RAND_CHARS = [('a'..'z'), ('A'..'Z'), (0..9)].map{|r| r.to_a}.flatten.join
@@ -14,17 +16,42 @@ module Surveyor
 
       def to_normalized_string(text)
         words_to_omit = %w(a be but has have in is it of on or the to when)
-        col_text = text.to_s.gsub(/(<[^>]*>)|\n|\t/s, ' ') # Remove html tags
+        col_text = text.to_s.gsub(/(<[^>]*>)|\n|\t/su, ' ') # Remove html tags
         col_text.downcase!                            # Remove capitalization
-        col_text.gsub!(/\"|\'/, '')                   # Remove potential problem characters
-        col_text.gsub!(/\(.*?\)/,'')                  # Remove text inside parens
-        col_text.gsub!(/\W/, ' ')                     # Remove all other non-word characters      
+        col_text.gsub!(/\"|\'/u, '')                   # Remove potential problem characters
+        col_text.gsub!(/\(.*?\)/u,'')                  # Remove text inside parens
+        col_text.gsub!(/\W/u, ' ')                     # Remove all other non-word characters      
         cols = (col_text.split(' ') - words_to_omit)
         (cols.size > 5 ? cols[-5..-1] : cols).join("_")
       end
       
+      def equal_json_excluding_wildcards(a,b)
+        return false if a.nil? or b.nil?
+        a = a.is_a?(String) ? JSON.load(a) : JSON.load(a.to_json)
+        b = b.is_a?(String) ? JSON.load(b) : JSON.load(b.to_json)
+        deep_compare_excluding_wildcards(a,b)
+      end
+      def deep_compare_excluding_wildcards(a,b)
+        return false if a.class != b.class
+        if a.is_a?(Hash)
+          return false if a.size != b.size
+          a.each do |k,v|
+            return false if deep_compare_excluding_wildcards(v,b[k]) == false
+          end
+        elsif a.is_a?(Array)
+          return false if a.size != b.size
+          a.each_with_index{|e,i| return false if deep_compare_excluding_wildcards(e,b[i]) == false }
+        else
+          return (a == "*") || (b == "*") || (a == b)
+        end
+        true
+      end
+
       alias :normalize :to_normalized_string
       
+      def generate_api_id
+        UUIDTools::UUID.random_create.to_s
+      end
     end
   end
 end

data/lib/surveyor/helpers/surveyor_helper_methods.rb

@@ -0,0 +1,99 @@
+module Surveyor
+  module Helpers
+    module SurveyorHelperMethods
+      # Layout: stylsheets and javascripts
+      def surveyor_includes
+        surveyor_stylsheets + surveyor_javascripts
+      end
+      def surveyor_stylsheets
+        stylesheet_link_tag 'surveyor/reset', 'surveyor/dateinput', 'surveyor/jquery-ui.custom', 'surveyor/jquery-ui-timepicker-addon', 'surveyor', 'custom'
+      end
+      def surveyor_javascripts
+        javascript_include_tag 'surveyor/jquery.tools.min', 'surveyor/jquery-ui', 'surveyor/jquery-ui-timepicker-addon', 'surveyor/jquery.surveyor', 'surveyor/jquery.blockUI'
+      end
+      # Helper for displaying warning/notice/error flash messages
+      def flash_messages(types)
+        types.map{|type| content_tag(:div, "#{flash[type]}".html_safe, :class => type.to_s)}.join.html_safe
+      end
+      # Section: dependencies, menu, previous and next
+      def dependency_explanation_helper(question,response_set)
+        # Attempts to explain why this dependent question needs to be answered by referenced the dependent question and users response
+        trigger_responses = []
+        dependent_questions = Question.find_all_by_id(question.dependency.dependency_conditions.map(&:question_id)).uniq
+        response_set.responses.find_all_by_question_id(dependent_questions.map(&:id)).uniq.each do |resp|
+          trigger_responses << resp.to_s
+        end
+        "&nbsp;&nbsp;You answered &quot;#{trigger_responses.join("&quot; and &quot;")}&quot; to the question &quot;#{dependent_questions.map(&:text).join("&quot;,&quot;")}&quot;"
+      end
+      def menu_button_for(section)
+        submit_tag(section.title, :name => "section[#{section.id}]")
+      end
+      def previous_section
+        # use copy in memory instead of making extra db calls
+        submit_tag(t('surveyor.previous_section').html_safe, :name => "section[#{@sections[@sections.index(@section)-1].id}]") unless @sections.first == @section
+      end
+      def next_section
+        # use copy in memory instead of making extra db calls
+        @sections.last == @section ? submit_tag(t('surveyor.click_here_to_finish').html_safe, :name => "finish") : submit_tag(t('surveyor.next_section').html_safe, :name => "section[#{@sections[@sections.index(@section)+1].id}]")
+      end
+
+      # 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)}"
+      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
+      # def question_help_helper(question)
+      #   question.help_text.blank? ? "" : %Q(<span class="question-help">#{question.help_text}</span>)
+      # end
+
+      # Help_text
+      def render_help_text(obj, context=nil)
+        obj.render_help_text(context)
+      end
+
+      # Answers
+      def a_text(obj, pos=nil, context = nil)
+        return image_tag(obj.text) if obj.is_a?(Answer) and obj.display_type == "image"
+        obj.split_or_hidden_text(pos, context)
+      end
+
+      def rc_to_attr(type_sym)
+        case type_sym.to_s
+        when /^answer$/ then :answer_id
+        else "#{type_sym.to_s}_value".to_sym
+        end
+      end
+
+      def rc_to_as(type_sym)
+        case type_sym.to_s
+        when /(integer|float|date|time|datetime)/ then :string
+        else type_sym
+        end
+      end
+
+      def generate_pick_none_input_html(value, default_value, css_class, response_class, disabled)
+        html = {}
+        html[:class] = [response_class,css_class].reject{ |c| c.blank? }
+        html[:value] = default_value if value.blank?
+        html[:disabled] = disabled unless disabled.blank?
+        html
+      end
+
+      # Responses
+      def response_for(response_set, question, answer = nil, response_group = nil)
+        return nil unless response_set && question && question.id
+        result = response_set.responses.detect{|r| (r.question_id == question.id) && (answer.blank? ? true : r.answer_id == answer.id) && (r.response_group.blank? ? true : r.response_group.to_i == response_group.to_i)}
+        result.blank? ? response_set.responses.build(:question_id => question.id, :response_group => response_group) : result
+      end
+      def response_idx(increment = true)
+        @rc ||= 0
+        (increment ? @rc += 1 : @rc).to_s
+      end
+    end
+  end
+end

data/lib/surveyor/models/answer_methods.rb

@@ -1,4 +1,4 @@
-require 'uuid'
+require 'surveyor/common'
 
 module Surveyor
   module Models
@@ -21,6 +21,8 @@ module Surveyor
           @@validations_already_included = true
         end
       end
+      
+      include RenderText      
 
       # Instance Methods
       def initialize(*args)
@@ -34,18 +36,17 @@ module Surveyor
         self.response_class ||= "answer"
         self.short_text ||= text
         self.data_export_identifier ||= Surveyor::Common.normalize(text)
-        self.api_id ||= UUID.generate
+        self.api_id ||= Surveyor::Common.generate_api_id
       end
       
       def css_class
         [(is_exclusive ? "exclusive" : nil), custom_class].compact.join(" ")
       end
       
-      def split_or_hidden_text(part = nil)
+      def split_or_hidden_text(part = nil, context = nil)
         return "" if display_type == "hidden_label"
-        part == :pre ? text.split("|",2)[0] : (part == :post ? text.split("|",2)[1] : text)
+        part == :pre ? self.render_answer_text(text.split("|",2)[0], context) : (part == :post ? self.render_answer_text(text.split("|",2)[1], context) : self.render_answer_text(text, context))
       end
-      
     end
   end
 end

data/lib/surveyor/models/dependency_condition_methods.rb

@@ -61,7 +61,6 @@ module Surveyor
           false
         end
       end
-
     protected
 
       def validates_operator

data/lib/surveyor/models/dependency_methods.rb

@@ -51,7 +51,7 @@ module Surveyor
         hash = {}
         self.dependency_conditions.each{|dc| hash.merge!(dc.to_hash(response_set))}
         return hash
-      end    
+      end
     end
   end
 end

data/lib/surveyor/models/question_group_methods.rb

@@ -1,3 +1,5 @@
+require 'surveyor/common'
+
 module Surveyor
   module Models
     module QuestionGroupMethods
@@ -6,6 +8,8 @@ module Surveyor
         base.send :has_many, :questions
         base.send :has_one, :dependency
       end
+
+      include RenderText
       
       # Instance Methods
       def initialize(*args)
@@ -15,6 +19,7 @@ module Surveyor
 
       def default_args
         self.display_type ||= "inline"
+        self.api_id ||= Surveyor::Common.generate_api_id
       end
 
       def renderer

data/lib/surveyor/models/question_methods.rb

@@ -1,4 +1,4 @@
-require 'uuid'
+require 'surveyor/common'
 
 module Surveyor
   module Models
@@ -23,9 +23,12 @@ module Surveyor
           base.send :validates_inclusion_of, :is_mandatory, :in => [true, false]
           
           @@validations_already_included = true
+          
         end
       end
 
+      include RenderText
+
       # Instance Methods
       def initialize(*args)
         super(*args)
@@ -38,7 +41,7 @@ module Surveyor
         self.pick ||= "none"
         self.data_export_identifier ||= Surveyor::Common.normalize(text)
         self.short_text ||= text
-        self.api_id ||= UUID.generate
+        self.api_id ||= Surveyor::Common.generate_api_id
       end
       
       def pick=(val)

data/lib/surveyor/models/response_methods.rb

@@ -6,15 +6,19 @@ module Surveyor
         base.send :belongs_to, :response_set
         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
-          base.send :validates_presence_of, :response_set_id, :question_id, :answer_id
-          
+          base.send :validates_presence_of, :question_id, :answer_id
+
           @@validations_already_included = true
         end
         base.send :include, Surveyor::ActsAsResponse # includes "as" instance method
-        
+
         # Class methods
         base.instance_eval do
           def applicable_attributes(attrs)
@@ -30,6 +34,15 @@ module Surveyor
       end
 
       # Instance Methods
+      def initialize(*args)
+        super(*args)
+        default_args
+      end
+
+      def default_args
+        self.api_id ||= Surveyor::Common.generate_api_id
+      end
+      
       def answer_id=(val)
         write_attribute :answer_id, (val.is_a?(Array) ? val.detect{|x| !x.to_s.blank?} : val)
       end
@@ -37,6 +50,34 @@ module Surveyor
         question.correct_answer.nil? or self.answer.response_class != "answer" or (question.correct_answer.id.to_i == answer.id.to_i)
       end
 
+      def time_value
+        read_attribute(:datetime_value).strftime( time_format ) unless read_attribute(:datetime_value).blank?
+      end
+
+      def time_value=(val)
+        self.datetime_value = Time.zone.parse("#{Date.today.to_s} #{val}").to_datetime
+      end
+
+      def date_value
+        read_attribute(:datetime_value).strftime( date_format ) unless read_attribute(:datetime_value).blank?
+      end
+
+      def date_value=(val)
+        self.datetime_value = Time.zone.parse(val).to_datetime
+      end
+
+      def time_format
+        '%H:%M'
+      end
+
+      def date_format
+        '%Y-%m-%d'
+      end
+
+      def datetime_format
+        '%Y-%m-%d %H:%M'
+      end
+
       def to_s # used in dependency_explanation_helper
         if self.answer.response_class == "answer" and self.answer_id
           return self.answer.text