jakewendt-surveyor 0.11.3

data/generators/surveyor/templates/initializers/haml.rb

@@ -0,0 +1,8 @@
+begin
+  require File.join(File.dirname(__FILE__), 'lib', 'haml') # From here
+rescue LoadError
+  require 'haml' # From gem
+end
+
+# Load Haml and Sass
+Haml.init_rails(binding)

data/generators/surveyor/templates/initializers/surveyor.rb

@@ -0,0 +1,10 @@
+# Loaded once. Restart your app (even in development) to apply changes made here
+Surveyor::Config.run do |config|
+  config['default.relative_url_root'] = nil # "surveys"
+  config['default.title'] = nil # "You can take these surveys:"
+  config['default.layout'] = nil # "surveyor_default"
+  config['default.index'] =  nil # "/surveys" # or :index_path_method
+  config['default.finish'] =  nil # "/surveys" # or :finish_path_method
+  config['use_restful_authentication'] = false # set to true to use restful authentication
+  config['extend'] = %w() # %w(survey surveyor_helper surveyor_controller)
+end

data/generators/surveyor/templates/migrate/add_correct_answer_id_to_questions.rb

@@ -0,0 +1,9 @@
+class AddCorrectAnswerIdToQuestions < ActiveRecord::Migration
+  def self.up
+    add_column :questions, :correct_answer_id, :integer
+  end
+
+  def self.down
+    remove_column :questions, :correct_answer_id
+  end
+end

data/generators/surveyor/templates/migrate/add_display_order_to_surveys.rb

@@ -0,0 +1,9 @@
+class AddDisplayOrderToSurveys < ActiveRecord::Migration
+  def self.up
+    add_column :surveys, :display_order, :integer
+  end
+
+  def self.down
+    remove_column :surveys, :display_order
+  end
+end

data/generators/surveyor/templates/migrate/add_index_to_response_sets.rb

@@ -0,0 +1,9 @@
+class AddIndexToResponseSets < ActiveRecord::Migration
+  def self.up
+    add_index(:response_sets, :access_code, :name => 'response_sets_ac_idx')
+  end
+
+  def self.down
+    remove_index(:response_sets, :name => 'response_sets_ac_idx')
+  end
+end

data/generators/surveyor/templates/migrate/add_index_to_surveys.rb

@@ -0,0 +1,9 @@
+class AddIndexToSurveys < ActiveRecord::Migration
+  def self.up
+    add_index(:surveys, :access_code, :name => 'surveys_ac_idx')
+  end
+
+  def self.down
+    remove_index(:surveys, :name => 'surveys_ac_idx')
+  end
+end

data/generators/surveyor/templates/migrate/add_manual_numbering.rb

@@ -0,0 +1,11 @@
+class AddManualNumbering < ActiveRecord::Migration
+  def self.up
+    add_column :surveys, :manual_numbering, :boolean
+    add_column :questions, :number, :string
+  end
+
+  def self.down
+    remove_column :surveys, :manual_numbering
+    remove_column :questions, :number
+  end
+end

data/generators/surveyor/templates/migrate/add_unique_indicies.rb

@@ -0,0 +1,17 @@
+class AddUniqueIndicies < ActiveRecord::Migration
+  def self.up
+    remove_index(:response_sets, :name => 'response_sets_ac_idx')
+    add_index(:response_sets, :access_code, :name => 'response_sets_ac_idx', :unique => true)
+    
+    remove_index(:surveys, :name => 'surveys_ac_idx')
+    add_index(:surveys, :access_code, :name => 'surveys_ac_idx', :unique => true)
+  end
+
+  def self.down
+    remove_index(:response_sets, :name => 'response_sets_ac_idx')
+    add_index(:response_sets, :access_code, :name => 'response_sets_ac_idx')
+    
+    remove_index(:surveys, :name => 'surveys_ac_idx')
+    add_index(:surveys, :access_code, :name => 'surveys_ac_idx')
+  end
+end

data/generators/surveyor/templates/migrate/create_answers.rb

@@ -0,0 +1,37 @@
+class CreateAnswers < ActiveRecord::Migration
+  def self.up
+    create_table :answers do |t|
+      # Context
+      t.integer :question_id
+
+      # Content
+      t.text :text
+      t.text :short_text #Used for presenting responses to experts (ie non-survey takers). Just a shorted version of the string
+      t.text :help_text
+      t.integer :weight # Used to assign a weight to an answer object (used for computing surveys that have numerical results) (I added this to support the Urology questionnaire -BLC)
+      t.string :response_class # What kind of additional data does this answer accept?
+      
+      # Reference
+      t.string :reference_identifier # from paper
+      t.string :data_export_identifier # data export
+      t.string :common_namespace # maping to a common vocab
+      t.string :common_identifier # maping to a common vocab
+    
+      # Display
+      t.integer :display_order
+      t.boolean :is_exclusive # If set it causes some UI trigger to remove (and disable) all the other answer choices selected for a question (needed for the WHR)
+      t.boolean :hide_label
+      t.integer :display_length # if smaller than answer.length the html input length will be this value
+      
+      t.string :custom_class
+      t.string :custom_renderer
+      
+      t.timestamps
+      
+    end
+  end
+
+  def self.down
+    drop_table :answers
+  end
+end

data/generators/surveyor/templates/migrate/create_dependencies.rb

@@ -0,0 +1,22 @@
+class CreateDependencies < ActiveRecord::Migration
+  def self.up
+    create_table :dependencies do |t|
+      # Context
+      t.integer :question_id # the dependent question
+      t.integer :question_group_id
+      
+      # Conditional
+      t.string :rule
+
+      # Result - TODO: figure out the dependency hook presentation options
+      # t.string :property_to_toggle # visibility, class_name,
+      # t.string :effect #blind, opacity
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :dependencies
+  end
+end

data/generators/surveyor/templates/migrate/create_dependency_conditions.rb

@@ -0,0 +1,29 @@
+class CreateDependencyConditions < ActiveRecord::Migration
+  def self.up
+    create_table :dependency_conditions do |t|
+      # Context
+      t.integer :dependency_id
+      t.string :rule_key
+      
+      # Conditional
+      t.integer :question_id # the conditional question
+      t.string :operator
+
+      # Value
+      t.integer :answer_id
+      t.datetime :datetime_value
+      t.integer :integer_value
+      t.float :float_value
+      t.string :unit
+      t.text :text_value
+      t.string :string_value
+      t.string :response_other
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :dependency_conditions
+  end
+end

data/generators/surveyor/templates/migrate/create_question_groups.rb

@@ -0,0 +1,27 @@
+class CreateQuestionGroups < ActiveRecord::Migration
+  def self.up
+    create_table :question_groups do |t|
+      # Content
+      t.text :text
+      t.text :help_text
+      
+      # Reference
+      t.string :reference_identifier # from paper
+      t.string :data_export_identifier # data export
+      t.string :common_namespace # maping to a common vocab
+      t.string :common_identifier # maping to a common vocab
+            
+      # Display
+      t.string :display_type
+      
+      t.string :custom_class
+      t.string :custom_renderer
+      
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :question_groups
+  end
+end

data/generators/surveyor/templates/migrate/create_questions.rb

@@ -0,0 +1,36 @@
+class CreateQuestions < ActiveRecord::Migration
+  def self.up
+    create_table :questions do |t|
+      # Context
+      t.integer :survey_section_id
+      t.integer :question_group_id
+
+      # Content
+      t.text :text
+      t.text :short_text # For experts (ie non-survey takers). Short version of text
+      t.text :help_text
+      t.string :pick
+
+      # Reference
+      t.string :reference_identifier # from paper
+      t.string :data_export_identifier # data export
+      t.string :common_namespace # maping to a common vocab
+      t.string :common_identifier # maping to a common vocab
+      
+      # Display
+      t.integer :display_order
+      t.string :display_type
+      t.boolean :is_mandatory
+      t.integer :display_width # used only for slider component (if needed)
+      
+      t.string :custom_class
+      t.string :custom_renderer
+      
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :questions
+  end
+end

data/generators/surveyor/templates/migrate/create_response_sets.rb

@@ -0,0 +1,22 @@
+class CreateResponseSets < ActiveRecord::Migration
+  def self.up
+    create_table :response_sets do |t|
+      # Context
+      t.integer :user_id
+      t.integer :survey_id
+
+      # Content
+      t.string :access_code #unique id for the object used in urls
+
+      # Expiry
+      t.datetime :started_at
+      t.datetime :completed_at
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :response_sets
+  end
+end

data/generators/surveyor/templates/migrate/create_responses.rb

@@ -0,0 +1,33 @@
+class CreateResponses < ActiveRecord::Migration
+  def self.up
+    create_table :responses do |t|
+      # Context
+      t.integer :response_set_id
+      t.integer :question_id
+
+      # Content                    
+      t.integer :answer_id         
+      t.datetime :datetime_value # handles date, time, and datetime (segregate by answer.response_class)
+      
+      #t.datetime :time_value      
+      t.integer :integer_value  
+      t.float :float_value      
+      t.string :unit               
+      t.text :text_value           
+      t.string :string_value
+      t.string :response_other #used to hold the string entered with "Other" type answers in multiple choice questions
+
+      # arbitrary identifier used to group responses
+      # the pertinent example here is Q: What's your car's make/model/year
+      # group 1: Ford/Focus/2007
+      # group 2: Toyota/Prius/2006
+      t.string :response_group
+      
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :responses
+  end
+end

data/generators/surveyor/templates/migrate/create_survey_sections.rb

@@ -0,0 +1,29 @@
+class CreateSurveySections < ActiveRecord::Migration
+  def self.up
+    create_table :survey_sections do |t|
+      # Context
+      t.integer :survey_id
+      
+      # Content
+      t.string :title
+      t.text :description
+      
+      # Reference
+      t.string :reference_identifier # from paper
+      t.string :data_export_identifier # data export
+      t.string :common_namespace # maping to a common vocab
+      t.string :common_identifier # maping to a common vocab
+      
+      # Display
+      t.integer :display_order
+      
+      t.string :custom_class
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :survey_sections
+  end
+end

data/generators/surveyor/templates/migrate/create_surveys.rb

@@ -0,0 +1,31 @@
+class CreateSurveys < ActiveRecord::Migration
+  def self.up
+    create_table :surveys do |t|
+      # Content
+      t.string :title
+      t.text :description
+
+      # Reference
+      t.string :access_code
+      t.string :reference_identifier # from paper
+      t.string :data_export_identifier # data export
+      t.string :common_namespace # maping to a common vocab
+      t.string :common_identifier # maping to a common vocab
+
+      # Expiry
+      t.datetime :active_at
+      t.datetime :inactive_at
+      
+      # Display
+      t.string :css_url
+      
+      t.string :custom_class
+      
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :surveys
+  end
+end

data/generators/surveyor/templates/migrate/create_validation_conditions.rb

@@ -0,0 +1,32 @@
+class CreateValidationConditions < ActiveRecord::Migration
+  def self.up
+    create_table :validation_conditions do |t|
+      # Context
+      t.integer :validation_id
+      t.string :rule_key
+      
+      # Conditional    
+      t.string :operator
+      
+      # Optional external reference
+      t.integer :question_id
+      t.integer :answer_id
+
+      # Value
+      t.datetime :datetime_value
+      t.integer :integer_value
+      t.float :float_value
+      t.string :unit
+      t.text :text_value
+      t.string :string_value
+      t.string :response_other
+      t.string :regexp
+      
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :validation_conditions
+  end
+end

data/generators/surveyor/templates/migrate/create_validations.rb

@@ -0,0 +1,20 @@
+class CreateValidations < ActiveRecord::Migration
+  def self.up
+    create_table :validations do |t|
+      # Context
+      t.integer :answer_id # the answer to validate
+      
+      # Conditional
+      t.string :rule
+
+      # Message
+      t.string :message
+      
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :validations
+  end
+end

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

@@ -0,0 +1,218 @@
+survey "“Kitchen Sink” survey" 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_1 "What is your favorite color?", :pick => :one
+    answer "red"
+    answer "blue"
+    answer "green"
+    answer "yellow"
+    answer :other
+
+    # A basic question with checkboxes
+    # "question" and "answer" may be abbreviated as "q" and "a"
+    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  
+    # 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
+    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
+
+    # 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"}
+    
+    # Surveys, sections, questions, groups, and answers all take the following reference arguments
+    # :reference_identifier   # usually from paper
+    # :data_export_identifier # data export
+    # :common_namespace       # maping to a common vocab
+    # :common_identifier      # maping to a common vocab
+    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
+    
+    # # validation conditions can look up the response to another question/answer pair
+    # q_time_dinner "What time do you usually take a dinner break?"
+    # a :time
+    # validation :rule => "A"
+    # condition_A ">=", :question_reference => "time_lunch", :answer_reference => "1"
+        
+    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 shorted 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 "Quantity", :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"
+  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
+    
+    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
+    
+    # Repeaters allow multiple responses to a question or set of questions
+    repeater "Tell us about the cars you own" do
+      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
+
+  end
+end