hssc_surveyor 1.4.1.pre

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

@@ -0,0 +1,52 @@
+== SurveyorController
+
+The SurveyorController class just includes actions from Surveyor::SurveyorControllerMethods module. You may include your own module, and overwrite the methods or add to them using "super". A template for this customization is in your app/controllers/surveyor\_controller.rb. SurveyorController is "unloadable", so changes in development (and any environment that does not cache classes) will be reflected immediately without restarting the app.
+
+== Models
+
+Surveyor's models can all be customized:
+
+- answer
+- dependency_condition
+- dependency
+- question_group
+- question
+- response_set
+- response
+- survey_section
+- survey
+- validation_condition
+- validation
+
+For example, create app/models/survey.rb with the following contents:
+
+    class Survey < ActiveRecord::Base
+      include Surveyor::Models::SurveyMethods
+      def title
+        "Custom #{super}"
+      end
+    end
+
+== 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
+
+== Layout
+
+Create a custom SurveyorController as above, and specify your custom layout in it.

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,16 @@
+# encoding: UTF-8
+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

@@ -0,0 +1,284 @@
+# encoding: UTF-8
+# Question#is_mandatory is now false by default. The default_mandatory option allows you to set
+#   is_mandatory for all questions in a survey.
+survey "Kitchen Sink survey", :default_mandatory => false do
+
+  section "Basic questions" do
+    # A label is a question that accepts no answers
+    label "These questions are examples of the basic supported input types"
+
+    # A basic question with radio buttons
+    question "What is your favorite color?", :pick => :one
+    answer "red"
+    answer "blue"
+    answer "green"
+    answer "yellow"
+    answer :other
+
+    # A basic question with checkboxes
+    # The "question" and "answer" methods may be abbreviated as "q" and "a".
+    # Append a reference identifier (a short string used for dependencies and validations) using the "_" underscore.
+    # Question reference identifiers must be unique within a survey.
+    # Answer reference identifiers must be unique within a question
+    q_2 "Choose the colors you don't like", :pick => :any
+    a_1 "red"
+    a_2 "blue"
+    a_3 "green"
+    a_4 "yellow"
+    a :omit
+
+    # A dependent question, with conditions and rule to logically join them
+    # If the conditions, logically joined into the rule, are met, then the question will be shown.
+    q_2a "Please explain why you don't like this color?"
+    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
+    condition_C :q_2, "==", :a_3
+    condition_D :q_2, "==", :a_4
+
+    # The count operator checks how many responses exist for the referenced question.
+    # It understands conditions of the form: count== count!= count> count< count>= count<=
+    q_2b "Please explain why you dislike so many colors?"
+    a_1 "explanation", :text
+    dependency :rule => "Z"
+    condition_Z :q_2, "count>2"
+
+    # When :pick isn't specified, the default is :none (no checkbox or radio button)
+    q_montypython3 "What... is your name? (e.g. It is 'Arthur', King of the Britons)"
+    a_1 :string
+
+    # Dependency conditions can refer to any value, not just answer_id. An answer_reference still needs to be specified, to know which answer you would like to check
+    q_montypython4 "What... is your quest? (e.g. To seek the Holy Grail)"
+    a_1 :string
+    dependency :rule => "A"
+    condition_A :q_montypython3, "==", {:string_value => "It is 'Arthur', King of the Britons", :answer_reference => "1"}
+
+    # http://www.imdb.com/title/tt0071853/quotes
+    q_montypython5 "What... is the air-speed velocity of an unladen swallow? (e.g. What do you mean? An African or European swallow?)"
+    a_1 :string
+    dependency :rule => "A"
+    condition_A :q_montypython4, "==", {:string_value => "To seek the Holy Grail", :answer_reference => "1"}
+
+    label "Huh? I-- I don't know that! Auuuuuuuugh!"
+    dependency :rule => "A"
+    condition_A :q_montypython5, "==", {:string_value => "What do you mean? An African or European swallow?", :answer_reference => "1"}
+
+    q_cooling_1 "How do you cool your home?", :pick => :one
+    a_1 "Fans"
+    a_2 "Window AC"
+    a_3 "Central AC"
+    a_4 "Passive"
+
+    # When using !=, also use count>0 if you want to make sure the user responds
+    q_cooling_2 "How much does it cost to run your non-passive cooling solutions? (This question hidden until you respond 'How do you cool your home?')"
+    dependency :rule => "A and B"
+    condition_A :q_cooling_1, "!=", :a_4
+    condition_B :q_cooling_1, "count>0"
+    a_1 "$", :float
+
+    # Using != alone means the dependent question is shown by default
+    label "Please consider passive cooling solutions (This question always shown, unless you respond 'Passive')"
+    dependency :rule => "A"
+    condition_A :q_cooling_1, "!=", :a_4
+
+    # Surveys, sections, questions, groups, and answers all take the following reference arguments
+    # :reference_identifier   # used for parsing references, usually derived from the paper version
+    # :data_export_identifier # used for data export
+    # :common_namespace       # maping to a common vocabulary - the namespace
+    # :common_identifier      # maping to a common vocabulary - the identifier within the namespace
+    q "Get me started on an improv sketch", :reference_identifier => "improv_start", :data_export_identifier => "i_s", :common_namespace => "sketch comedy questions", :common_identifier => "get me started"
+    a "who", :string
+    a "what", :string
+    a "where", :string
+
+    # Various types of responses can be accepted, and validated
+    q "How many pets do you own?"
+    a :integer
+    validation :rule => "A"
+    condition_A ">=", :integer_value => 0
+
+    # Surveys, sections, questions, groups, and answers also take a custom css class for covenience in custom styling
+    q "What is your address?", :custom_class => 'address'
+    a :text, :custom_class => 'mapper'
+    # validations can use regexp values
+    validation :rule => "A"
+    condition_A "=~", :regexp => "[0-9a-zA-z\. #]"
+
+    # Questions, groups, and answers take a custom renderer (a partial in the application's views dir)
+    # defaults are "/partials/question_group", "/partials/question", "/partials/answer", so the custom renderers should have a different name
+    q "Pick your favorite date AND time" #, :custom_renderer => "/partials/custom_question"
+    a :datetime
+
+    q_time_lunch "What time do you usually take a lunch break?"
+    a_1 :time
+
+    q "When would you like to meet for dinner?"
+    a :date
+
+    # Sliders deprecate to select boxes when javascript is off
+    # Valid Ruby code may be used to shorten repetitive tasks
+    q "Adjust the slider to reflect your level of awesomeness", :pick => :one, :display_type => :slider
+    (1..10).to_a.each{|num| a num.to_s}
+
+    q "How much do you like Ruby?", :pick => :one, :display_type => :slider
+    ["not at all", "a little", "some", "a lot", "a ton"].each{|level| a level}
+
+    # The "|" pipe is used to place labels before or after the input elements
+    q "How much money do you want?"
+    a "$|USD", :float
+
+    # Questions may be grouped
+    group "How much oil do you use per day?", :display_type => :inline do
+      q "Quantity"
+      a :float
+
+      q "Unit", :pick => :one, :display_type => :dropdown
+      a "Barrels"
+      a "Gallons"
+      a "Quarts"
+    end
+
+    q "Choose your Illinois county", :pick => :one, :display_type => :dropdown
+    ["Adams","Alexander","Bond", "Boone",
+        "Brown","Bureau","Calhoun","Carroll","Cass",
+        "Champaign", "Christian", "Clark","Clay",
+        "Clinton", "Coles", "Cook", "Crawford","Cumberland","DeKalb",
+        "De Witt","Douglas","DuPage","Edgar", "Edwards",
+        "Effingham","Fayette", "Ford","Franklin","Fulton",
+        "Gallatin","Greene", "Grundy", "Hamilton","Hancock",
+        "Hardin","Henderson","Henry","Iroquois","Jackson",
+        "Jasper", "Jefferson","Jersey","Jo Daviess","Johnson",
+        "Kane","Kankakee","Kendall","Knox", "La Salle",
+        "Lake", "Lawrence", "Lee","Livingston","Logan",
+        "Macon","Macoupin","Madison","Marion","Marshall", "Mason",
+        "Massac","McDonough","McHenry","McLean","Menard",
+        "Mercer","Monroe", "Montgomery","Morgan","Moultrie",
+        "Ogle","Peoria","Perry","Piatt","Pike","Pope",
+        "Pulaski","Putnam","Randolph","Richland","Rock Island",
+        "Saline","Sangamon","Schuyler","Scott","Shelby",
+        "St. Clair","Stark", "Stephenson","Tazewell","Union",
+        "Vermilion","Wabash","Warren","Washington","Wayne",
+        "White","Whiteside","Will","Williamson","Winnebago","Woodford"].each{ |county| a county}
+
+    # When an is_exclusive answer is checked, it unchecks all other options and disables them (using Javascript)
+    q "Choose your favorite meats", :display_type => :inline, :pick => :any
+    a "Chicken"
+    a "Pork"
+    a "Beef"
+    a "Shellfish"
+    a "Fish"
+    a "I don't eat meats!!!", :is_exclusive => true
+
+    q "All out of ideas for questions?", :pick => :one, :display_type => :inline
+    a "yes"
+    a "maybe"
+    a "no"
+    a "I don't know"
+
+    # Questions may also have input masks with fancy placeholders
+    q "What is your phone number?"
+    a :string, :input_mask => '(999)999-9999', :input_mask_placeholder => '#'
+    
+  end
+
+  section "Complicated questions" do
+
+    # Grids are useful for repeated questions with the same set of answers, which are specified before the questions
+    grid "Tell us how often do you cover these each day" do
+      a "1"
+      a "2"
+      a "3"
+      q "Head", :pick => :one
+      q "Knees", :pick => :one
+      q "Toes", :pick => :one
+    end
+
+    # "grid" is a shortcut for group with :display_type => :grid
+    # The answers will be repeated every 10 rows, but long grids aren't recommended as they are generally tedious
+    grid "Tell us how you feel today day" do
+      a "-2"
+      a "-1"
+      a "0"
+      a "1"
+      a "2"
+      q "down|up" , :pick => :one
+      q "sad|happy", :pick => :one
+      q "limp|perky", :pick => :one
+    end
+
+    grid "For each of the car types checked, what type of options would you prefer?" do
+      a "Leather seats"
+      a "Shiny rims"
+      a "Subwoofer"
+      a "Sunroof"
+      a "Turbocharger"
+      q "SUV", :pick => :any
+      q "Sedan", :pick => :any
+      q "Coupe", :pick => :any
+      q "Convertible", :pick => :any
+      q "Minivan", :pick => :any
+      q "Crossover", :pick => :any
+      q "Wagon", :pick => :any
+      q "Other", :pick => :any
+    end
+
+    q "Please rank the following foods based on how much you like them"
+    a "|pizza", :integer
+    a "|salad", :integer
+    a "|sushi", :integer
+    a "|ice cream", :integer
+    a "|breakfast ceral", :integer
+
+    # :other, :string allows someone to specify both the "other" and some other information
+    q "Choose your favorite utensils and enter frequency of use (daily, weekly, monthly, etc...)", :pick => :any
+    a "spoon", :string
+    a "fork", :string
+    a "knife", :string
+    a :other, :string
+
+    q "What is your birth date?", :pick => :one
+    a "I was born on", :date
+    a "Refused"
+
+    q "At what time were you born?", :pick => :any
+    a "I was born at", :time
+    a "This time is approximate"
+
+    q "When would you like to schedule your next appointment?"
+    a :datetime
+
+    q_car "Do you own a car?", :pick => :one
+    a_y "Yes"
+    a_n "No"
+
+    # Repeaters allow multiple responses to a question or set of questions
+    repeater "Tell us about the cars you own" do
+      dependency :rule => "A"
+      condition_A :q_car, "==", :a_y
+      q "Make", :pick => :one, :display_type => :dropdown
+      a "Toyota"
+      a "Ford"
+      a "GMChevy"
+      a "Ferrari"
+      a "Tesla"
+      a "Honda"
+      a "Other weak brand"
+      q "Model"
+      a :string
+      q "Year"
+      a :string
+    end
+
+    repeater "Tell us the name and age of your siblings" do
+      q "Sibling"
+      a "Name", :string
+      a "Age|years", :integer
+    end
+
+    # File responses (uses paperclip), display_type must equal :file and answer must be :file
+    question "File Upload", :display_type => :file
+    answer :file
+
+  end
+end

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/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,13 @@
+module Surveyor
+  module Helpers
+    module AssetPipeline
+      ##
+      # Returns whether or not the asset pipeline is present and enabled.
+      #
+      # The detection scheme used here was ripped from jquery-rails.
+      def asset_pipeline_enabled?
+        ::Rails.version >= "3.1" && ::Rails.application.config.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