RubyGems - surveyor - Versions diffs - 0.6.1 - Mend

surveyor 0.6.1

Files changed (137) hide show

data/generators/surveyor/templates/extensions/survey_extensions.rb ADDED

@@ -0,0 +1,18 @@
+module SurveyExtensions
+  def self.included(base)
+    base.extend(ClassMethods)
+    base.send(:include, InstanceMethods)
+    base.class_eval do
+      # Same as typing in the class
+    end
+  end
+  module ClassMethods
+  end
+  module InstanceMethods
+  end
+end
+# Add module to Survey
+Survey.send(:include, SurveyExtensions)

data/generators/surveyor/templates/extensions/surveyor_controller_extensions.rb ADDED

@@ -0,0 +1,28 @@
+module SurveyorControllerExtensions
+  def self.included(base)
+    base.extend(ClassMethods)
+    base.send(:include, InstanceMethods)
+    base.class_eval do
+      # Same as typing in the class
+      # before_filter :pimp_my_ride
+    end
+  end
+  module ClassMethods
+  end
+  module InstanceMethods
+    # def pimp_my_ride
+    #   flash[:notice] = "pimped!"
+    # end
+  end
+  module Actions
+    # Redefine the controller actions [index, new, create, show, update] here
+    # def new
+    #   render :text =>"surveys are down"
+    # end
+  end
+end
+# Set config['extend_controller'] = true in config/initializers/surveyor.rb to activate these extensions

data/generators/surveyor/templates/extensions/surveyor_custom.html.erb ADDED

@@ -0,0 +1,13 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+  <title>Survey: <%= controller.action_name %></title>
+  <%= surveyor_includes # calls surveyor_javascripts + surveyor_stylesheets %>
+</head>
+<body>
+  <div id="flash"><%= flash[:notice] %></div>
+  <%= yield %>
+</body>
+</html>

data/generators/surveyor/templates/extensions/surveyor_helper_extensions.rb ADDED

@@ -0,0 +1,18 @@
+module SurveyorHelperExtensions
+  def self.included(base) # :nodoc:
+    base.send(:include, InstanceMethods)
+    base.class_eval do
+      # Same as typing in the module
+      # alias_method_chain :question_number_helper, :sauce
+    end
+  end
+  module InstanceMethods
+    # def question_number_helper_with_sauce(number)
+    #   question_number_helper_without_sauce(number) + "Extra sauce"
+    # end
+  end
+end
+# Add module to SurveyorHelper
+SurveyorHelper.send(:include, SurveyorHelperExtensions)

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

@@ -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 ADDED

@@ -0,0 +1,11 @@
+Surveyor::Config.run do |config|
+  config['default.relative_url_root'] = nil # "surveys/" # should end with '/'
+  config['default.title'] = nil # "You can take these surveys:"
+  config['default.layout'] = nil # "surveyor_default"
+  config['default.finish'] =  nil # "/surveys" # or :finish_path_method
+  config['use_restful_authentication'] = false # set to true to use restful authentication
+  config['extend_controller'] = false # set to true to extend SurveyorController
+end
+# require 'models/survey_extensions' # Extended the survey model
+# require 'helpers/surveyor_helper_extensions' # Extend the surveyor helper

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

@@ -0,0 +1,45 @@
+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)
+      # Display
+      t.string :response_class # What kind of additional data does this answer accept?
+      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
+      # Reference
+      t.string :reference_identifier # Used to relate this question object to questions imported from a paper questionnaire
+      t.string :data_export_identifier # Used when referencing this quesiton in data export. Usually a shortend/cryptic version of the question text
+      t.string :common_data_identitier # Used to share data across surveys (or perhaps map to a common vocab.)
+      # Validations
+      # the response_class attr also has validation implications (int, string, float,etc..) but these attrs below give fine grain control over responses
+      t.integer :max_value
+      t.integer :min_value
+      t.integer :length # number of chars/ints accepted
+      t.integer :decimal_precision # only for floats
+      t.boolean :allow_negative # only for numeric values
+      t.boolean :allow_blank
+      t.string :unit # a string representation of the unit (lbs. USD, oz.) - Context is from the survey domain and question
+      # Display property
+      t.integer :display_length # if smaller than answer.length the html input length will be this value
+      t.timestamps
+    end
+  end
+  def self.down
+    drop_table :answers
+  end
+end

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

@@ -0,0 +1,21 @@
+class CreateDependencies < ActiveRecord::Migration
+  def self.up
+    create_table :dependencies do |t|
+      # Context
+      t.integer :question_id # the dependent question
+      # 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 ADDED

@@ -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 ADDED

@@ -0,0 +1,18 @@
+class CreateQuestionGroups < ActiveRecord::Migration
+  def self.up
+    create_table :question_groups do |t|
+      # Content
+      t.string :text
+      t.string :help_text
+      # Display
+      t.string :display_type
+      t.timestamps
+    end
+  end
+  def self.down
+    drop_table :question_groups
+  end
+end

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

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

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

@@ -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 ADDED

@@ -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 ADDED

@@ -0,0 +1,25 @@
+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
+      # Display
+      t.integer :display_order
+      # Reference
+      t.string :reference_identifier # Used to relate this question object to questions imported from a paper questionnaire
+      t.string :data_export_identifier # Used when referencing this quesiton in data export. Usually a shortend/cryptic version of the question text
+      t.timestamps
+    end
+  end
+  def self.down
+    drop_table :survey_sections
+  end
+end

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

@@ -0,0 +1,25 @@
+class CreateSurveys < ActiveRecord::Migration
+  def self.up
+    create_table :surveys do |t|
+      # Content
+      t.string :title
+      t.text :description
+      # Reference
+      t.string :access_code
+      # Expiry
+      t.datetime :active_at
+      t.datetime :inactive_at
+      # Styling
+      t.string :css_url
+      t.timestamps
+    end
+  end
+  def self.down
+    drop_table :surveys
+  end
+end

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

@@ -0,0 +1,201 @@
+survey "&#8220;Kitchen Sink&#8221; survey" do
+  section "Basic questions" do
+    # exclusive
+    # name people you live with (choose all that apply)
+    # husband, friend, partner, siblings, other, alone, choose not to answer
+    # alone unchecks/erases, and disables all the others
+    # omit (choose not to answer) is exclusive as well
+    # a label is a question that accepts no answers
+    # reference_identifier => label
+    label "These questions are examples of the basic supported input types"
+    # a basic question,
+    # reference_identifier => 1
+    question_1 "What is your favorite color?", :pick => :one
+    answer "red"
+    answer "blue"
+    answer "green"
+    answer "yellow"
+    answer :other # :other is a custom answer symbol type, it has associated pre-sets with it
+    question_2 "Choose the colors you don't like", :pick => :any
+    answer_1 "red"
+    answer_2 "blue"
+    answer_3 "green"
+    answer_4 "yellow"
+    answer :omit
+    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
+    # question definitions can be abreviated as shown below
+    # questions and answers don't need to have numbers. Only if they are referenced in a dependency condition
+    q "What is your name?"
+    a :string
+    q "Give your response"
+    a "who", :string
+    a "what", :string
+    a "where", :string
+    q "How many pets do you own?"
+    a :integer
+    q "What is your address?"
+    a :text
+    #
+    # q "Pick your favorite date"
+    # a :date
+    #
+    # q "Pick your favorite time"
+    # a :time
+    q "Pick your favorite date AND time"
+    a :datetime
+    q "What time would you like to meet?"
+    a :time
+    q "What date would you like to meet?"
+    a :date
+    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}
+    # range "When did you start working at NUBIC?", :range_type => :date do
+    #      q "From"
+    #      a :date
+    #
+    #      q "To"
+    #      a :date
+    #    end
+    #
+    #    range "What times are you awake?", :range_type => :integer do
+    #      q "From"
+    #      a :integer
+    #
+    #      q "To"
+    #      a :integer
+    #    end
+    q "How much money do you want?"
+    a "$|USD", :float, :unit => "F"
+    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, :hide_label => true
+      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}
+    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
+    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 "Tell us how you feel today day" do
+      a "-2"
+      a "-1"
+      a "0"
+      a "1"
+      a "2"
+      a :omit
+      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
+    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
+    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", :integer, :unit => "years"
+    end
+  end
+end