affectiva-surveyor 1.5.0.pre.disco.2

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

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+survey "One language is never enough" do
+  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
+  end
+  section_two "Two" do
+    q_color "What is your favorite color?"
+    a_name :string
+  end
+end

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

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+survey "Favorites" do
+  section "Foods" do
+    # In a quiz, both the questions and the answers need to have reference identifiers
+    # Here, the question has reference_identifier: "1", and the answers: "oint", "tweet", and "moo"
+    question_1 "What is the best meat?", :pick => :one, :correct => "oink"
+    a_oink "bacon"
+    a_tweet "chicken"
+    a_moo "beef"
+  end
+end

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

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+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?"

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

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+title: "ידיעת שפה אחת אינה מספיקה"
+survey_sections:
+  one:
+    title: "אחת"
+  two:
+    title: "שנים"
+question_groups:
+  hello:
+    text: "שלום"
+questions:
+  name:
+    text: "מה שמך?"
+    answers:
+      name:
+        help_text: "שמי..."
+  color:
+    text: "מהו הצבע האהוב עליך?"

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

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+title: "한가지 언어로는 충분치 않습니다."
+survey_sections:
+  one:
+    title: "하나"
+  two:
+    title: "두"
+question_groups:
+  hello:
+    text: "안녕하십니까"
+questions:
+  name:
+    text: "성함이 어떻게 되십니까?"
+    answers:
+      name:
+        help_text: "제 이름은 ... 입니다"
+  color:
+    text: "좋아하는 색은 무엇입니까?"

data/lib/generators/surveyor/templates/vendor/assets/stylesheets/custom.sass

@@ -0,0 +1,5 @@
+/* Add custom styles here. They will be
+ * loaded after the surveyor stylesheets */
+
+#surveyor
+ :font-family "Century Gothic"

data/lib/surveyor.rb

@@ -0,0 +1,13 @@
+module Surveyor
+  require 'surveyor/engine' if defined?(Rails) && Rails::VERSION::MAJOR >= 3
+  autoload :VERSION, 'surveyor/version'
+  autoload :ParserError, 'surveyor/parser'
+end
+require 'surveyor/common'
+require 'surveyor/acts_as_response'
+# require 'surveyor/surveyor_controller_methods'
+# require 'surveyor/models/survey_methods'
+require 'formtastic'
+Formtastic::FormBuilder.default_text_area_height = 5
+Formtastic::FormBuilder.default_text_area_width = 50
+Formtastic::FormBuilder.all_fields_required_by_default = false

data/lib/surveyor/acts_as_response.rb

@@ -0,0 +1,17 @@
+module Surveyor
+  module ActsAsResponse
+    # Returns the response as a particular response_class type
+    def as(type_symbol)
+      return case type_symbol.to_sym
+      when :string, :text, :integer, :float, :datetime
+        self.send("#{type_symbol}_value".to_sym)
+      when :date
+        self.datetime_value.nil? ? nil : self.datetime_value.to_date
+      when :time
+        self.datetime_value.nil? ? nil : self.datetime_value.to_time
+      else # :answer_id
+        self.answer_id
+      end
+    end
+  end
+end

data/lib/surveyor/common.rb

@@ -0,0 +1,59 @@
+require 'securerandom'
+require 'uuidtools'
+
+module Surveyor
+  class Common
+    OPERATORS = %w(== != < > <= >= =~)
+
+    class << self
+      if SecureRandom.respond_to?(:urlsafe_base64)
+        def make_tiny_code
+          # 7 random bytes is increased to ~10 characters (sans padding) by
+          # base64 encoding
+          SecureRandom.urlsafe_base64(7)
+        end
+      else
+        def make_tiny_code
+          s = [SecureRandom.random_bytes(7)].pack("m*")
+          s.delete!("\n")
+          s.tr!("+/", "-_")
+          s.delete!("=")
+        end
+      end
+
+      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/su, ' ') # Remove html tags
+        col_text.downcase!                            # Remove capitalization
+        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
+
+      alias :normalize :to_normalized_string
+
+      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/engine.rb

@@ -0,0 +1,10 @@
+require 'rails'
+require 'surveyor'
+require 'haml' # required for view resolution
+
+module Surveyor
+  class Engine < Rails::Engine
+    root = File.expand_path('../../', __FILE__)
+    config.autoload_paths << root
+  end
+end

data/lib/surveyor/helpers/asset_pipeline.rb

@@ -0,0 +1,18 @@
+module Surveyor
+  module Helpers
+    module AssetPipeline
+      ##
+      # Returns whether or not the asset pipeline is present and enabled.
+      #
+      # With Rails4 it appears that assets.enabled is false if
+      # --skip-sprockets is specified when creating the application,
+      # but the assets.enabled option is nil in the default case
+      # (i.e., pipeline enabled).
+      def asset_pipeline_enabled?
+        return false unless Rails.configuration.respond_to?('assets')
+        assets = Rails.configuration.assets
+        assets.enabled.nil? || assets.enabled
+      end
+    end
+  end
+end

data/lib/surveyor/helpers/formtastic_custom_input.rb

@@ -0,0 +1,13 @@
+module Surveyor
+  module Helpers
+    module FormtasticCustomInput
+      def input_html_options_with(choice, response_class)
+        input_html_options.merge(choice_html_options(choice)).merge({:id => (input_html_options[:id] || "answer_id").gsub("answer_id", response_class_to_method(response_class).to_s), :class => [input_html_options[:class], response_class].join(" ")})
+      end
+      def response_class_to_method(type_sym)
+        # doesn't handle response_class == answer, and doesn't have to
+        "#{type_sym.to_s}_value".to_sym
+      end
+    end
+  end
+end

data/lib/surveyor/helpers/surveyor_helper_methods.rb

@@ -0,0 +1,103 @@
+require 'surveyor/helpers/asset_pipeline'
+
+module Surveyor
+  module Helpers
+    module SurveyorHelperMethods
+      include AssetPipeline
+
+      # Layout: stylsheets and javascripts
+      def surveyor_includes
+        if asset_pipeline_enabled?
+          stylesheet_link_tag('surveyor_all') + javascript_include_tag('surveyor_all')
+        else
+          stylesheet_link_tag('surveyor/reset',
+                              'surveyor/jquery-ui-1.10.0.custom',
+                              'surveyor/jquery-ui-timepicker-addon',
+                              'surveyor/ui.slider.extras',
+                              'surveyor/results',
+                              'surveyor',
+                              'custom') +
+          javascript_include_tag('surveyor/jquery-1.9.0',
+                                  'surveyor/jquery-ui-1.10.0.custom',
+                                  'surveyor/jquery-ui-timepicker-addon',
+                                  'surveyor/jquery.selectToUISlider',
+                                  'surveyor/jquery.surveyor',
+                                  'surveyor/jquery.maskedinput')
+        end
+      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.translation(I18n.locale)[: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(q, context=nil, locale=nil)
+        "#{next_question_number(q) unless (q.dependent? or q.display_type == "label" or q.display_type == "image" or q.part_of_group?)}#{q.text_for(nil, context, locale)}"
+      end
+
+      def next_question_number(question)
+        @n ||= 0
+        "<span class='qnum'>#{@n += 1}) </span>"
+      end
+
+      # Responses
+      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, input_mask, input_mask_placeholder)
+        html = {}
+        html[:class] = [response_class,css_class].reject{ |c| c.blank? }
+        html[:value] = value.blank? ? default_value : value
+        html[:disabled] = disabled unless disabled.blank?
+        if input_mask
+          html[:'data-input-mask'] = input_mask
+          html[:'data-input-mask-placeholder'] = input_mask_placeholder unless input_mask_placeholder.blank?
+        end
+        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

@@ -0,0 +1,83 @@
+require 'surveyor/common'
+
+module Surveyor
+  module Models
+    module AnswerMethods
+      def self.included(base)
+        # Associations
+        base.send :belongs_to, :question
+        base.send :has_many, :responses
+        base.send :has_many, :validations, :dependent => :destroy
+
+        # Scopes
+        base.instance_eval {default_scope ->{order "#{base.quoted_table_name}.display_order ASC"}}
+
+        # Mustache
+        base.send :include, MustacheContext
+
+        @@validations_already_included ||= nil
+        unless @@validations_already_included
+          # Validations
+          base.send :validates_presence_of, :text
+          # this causes issues with building and saving
+          # base.send :validates_numericality_of, :question_id, :allow_nil => false, :only_integer => true
+          @@validations_already_included = true
+        end
+      end
+
+      # Instance Methods
+      def initialize(*args)
+        super(*args)
+        default_args
+      end
+
+      def default_args
+        self.is_exclusive ||= false
+        self.display_type ||= "default"
+        self.response_class ||= "answer"
+        self.short_text ||= text
+        self.data_export_identifier ||= Surveyor::Common.normalize(text)
+        self.api_id ||= Surveyor::Common.generate_api_id
+      end
+      def display_type=(val)
+        write_attribute(:display_type, val.nil? ? nil : val.to_s)
+      end
+
+      def css_class
+        [(is_exclusive ? "exclusive" : nil), custom_class].compact.join(" ")
+      end
+
+      def text_for(position = nil, context = nil, locale = nil)
+        return "" if display_type == "hidden_label"
+        imaged(split(in_context(translation(locale)[:text], context), position))
+      end
+      def help_text_for(context = nil, locale = nil)
+        in_context(translation(locale)[:help_text], context)
+      end
+      def default_value_for(context = nil, locale = nil)
+        in_context(translation(locale)[:default_value], context)
+      end
+      def split(text, position=nil)
+        case position
+        when :pre
+          text.split("|",2)[0]
+        when :post
+          text.split("|",2)[1]
+        else
+          text
+        end.to_s
+      end
+      def translation(locale)
+        {:text => self.text, :help_text => self.help_text, :default_value => self.default_value}.with_indifferent_access.merge(
+          (self.question.translation(locale)[:answers] || {})[self.reference_identifier] || {}
+        )
+      end
+
+      private
+
+      def imaged(text)
+        self.display_type == "image" && !text.blank? ? ActionController::Base.helpers.image_tag(text) : text
+      end
+    end
+  end
+end

data/lib/surveyor/models/dependency_condition_methods.rb

@@ -0,0 +1,69 @@
+module Surveyor
+  module Models
+    module DependencyConditionMethods
+      def self.included(base)
+        # Associations
+        base.send :belongs_to, :answer
+        base.send :belongs_to, :dependency
+        base.send :belongs_to, :dependent_question, :foreign_key => :question_id, :class_name => :question
+        base.send :belongs_to, :question
+
+        @@validations_already_included ||= nil
+        unless @@validations_already_included
+          # Validations
+          base.send :validates_presence_of, :operator, :rule_key
+          base.send :validate, :validates_operator
+          base.send :validates_uniqueness_of, :rule_key, :scope => :dependency_id
+          # this causes issues with building and saving
+          # base.send :validates_numericality_of, :question_id, :dependency_id
+
+          @@validations_already_included = true
+        end
+
+        base.send :include, Surveyor::ActsAsResponse # includes "as" instance method
+
+        # Class methods
+        base.instance_eval do
+          def operators
+            Surveyor::Common::OPERATORS
+          end
+        end
+      end
+
+      # Instance methods
+      def to_hash(response_set)
+        # all responses to associated question
+        responses = question.blank? ? [] : response_set.responses.where("responses.answer_id in (?)", question.answer_ids)
+        if self.operator.match /^count(>|>=|<|<=|==|!=)\d+$/
+          op, i = self.operator.scan(/^count(>|>=|<|<=|==|!=)(\d+)$/).flatten
+          # logger.warn({rule_key.to_sym => responses.count.send(op, i.to_i)})
+          return {rule_key.to_sym => (op == "!=" ? !responses.count.send("==", i.to_i) : responses.count.send(op, i.to_i))}
+        elsif operator == "!=" and (responses.blank? or responses.none?{|r| r.answer.id == self.answer.id})
+          # logger.warn( {rule_key.to_sym => true})
+          return {rule_key.to_sym => true}
+        elsif response = responses.detect{|r| r.answer.id == self.answer.id}
+          klass = response.answer.response_class
+          klass = "answer" if self.as(klass).nil? # it should compare answer ids when the dependency condition *_value is nil
+          case self.operator
+          when "==", "<", ">", "<=", ">="
+            # logger.warn( {rule_key.to_sym => response.as(klass).send(self.operator, self.as(klass))})
+            return {rule_key.to_sym => !response.as(klass).nil? && response.as(klass).send(self.operator, self.as(klass))}
+          when "!="
+            # logger.warn( {rule_key.to_sym => !response.as(klass).send("==", self.as(klass))})
+            return {rule_key.to_sym => !response.as(klass).send("==", self.as(klass))}
+          end
+        end
+        # logger.warn({rule_key.to_sym => false})
+        {rule_key.to_sym => false}
+      end
+
+    protected
+
+      def validates_operator
+        errors.add(:operator, "Invalid operator") unless
+          Surveyor::Common::OPERATORS.include?(self.operator) ||
+            self.operator && self.operator.match(/^count(<|>|==|>=|<=|!=)(\d+)/)
+      end
+    end
+  end
+end