RubyGems - surveyor - Versions diffs - 0.6.1 - Mend

surveyor 0.6.1

Files changed (137) hide show

data/app/views/layouts/surveyor_default.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 %>
+</head>
+<body>
+  <div id="flash"><%= flash[:notice] %></div>
+  <%= yield %>
+</body>
+</html>

data/app/views/partials/_answer.html.haml ADDED

@@ -0,0 +1,49 @@
+- renderer = answer.renderer(question)
+- hide_label ||= false
+- disabled ||= false
+- fields_for_response(response_obj) do |response_form|
+  - case renderer
+  - when :any_answer
+    = response_form.survey_check_box(:selected)
+    = response_form.label("selected", answer.text) unless hide_label # This is a temp fix til I figure out why the id of the checkbox is all jacked up
+  - when :any_other_and_string
+    = response_form.survey_check_box(:selected)
+    %label Other
+    = response_form.text_field(:other_value)
+    = response_form.text_field(:string_value)
+  - when :any_string
+    = response_form.survey_check_box(:selected)
+    = response_form.label(:answer_id, answer.text)
+    = response_form.text_field(:string_value, :size => 25, :maxlength => 250)
+  - when :one_answer, :one_string
+    - fields_for_radio(response_obj) do |radio_form|
+      = radio_form.radio_button(:answer_id, answer.id, :checked => response_obj.selected?)
+      = radio_form.label("answer_#{answer.id}", answer.text) unless hide_label
+    - if renderer == :one_string
+      = response_form.text_field(:string_value, :size => 25, :maxlength => 250, :autocomplete => "off")
+  - when :none_date
+    = response_form.text_field(:datetime_value, {:include_blank => true})
+  - when :none_datetime
+    = response_form.datetime_select(:datetime_value, {:include_blank => true})
+  - when :none_float
+    = response_form.label(:float_value, split_text(answer.text)[:prefix]) unless hide_label
+    = response_form.text_field(:float_value, :size => 5, :maxlength => 10, :autocomplete => "off")
+    = response_form.label(:float_value, split_text(answer.text)[:postfix]) unless hide_label
+  - when :none_integer
+    = response_form.label(:integer_value, split_text(answer.text)[:prefix], :class => "#{(disabled)? 'disabled' : 'enabled'}") unless hide_label
+    = response_form.text_field(:integer_value, :size => 5, :maxlength => 10, :autocomplete => "off", :disabled => disabled)
+    = response_form.label(:integer_value, split_text(answer.text)[:postfix], :class => "#{(disabled)? 'disabled' : 'enabled'}") unless hide_label
+  - when :none_string
+    = response_form.label(:string_value, split_text(answer.text)[:prefix], :class => "#{(disabled)? 'disabled' : 'enabled'}") unless hide_label
+    = response_form.text_field(:string_value, :size => 25, :maxlength => 250, :autocomplete => "off", :disabled => disabled)
+    = response_form.label(:string_value, split_text(answer.text)[:postfix], :class => "#{(disabled)? 'disabled' : 'enabled'}") unless hide_label
+  - when :none_text
+    = response_form.label(:text_value, split_text(answer.text)[:prefix]) unless hide_label
+    = response_form.text_area(:text_value, :cols => 80, :rows => 10)
+    = response_form.label(:text_value, split_text(answer.text)[:postfix]) unless hide_label
+  - when :none_time
+    = response_form.time_select(:datetime_value,{ :include_blank => true })
+  - else
+    = answer.text

data/app/views/partials/_question.html.haml ADDED

@@ -0,0 +1,73 @@
+- renderer = question.renderer(question_group ||= nil)
+- dep_class = question.dep_class(response_set)
+- case renderer
+- when :label
+  - div_for question, :class => "label #{dep_class}" do
+    %span.text= question.text
+    %span.help= question.help_text
+- when :image
+  .image= image_tag(question.text)
+- when :dropdown, :slider
+  - if renderer == :slider
+    %script{:type => "text/javascript"}= "$(function(){$('#slider_#{question.id}').accessibleUISlider({width: 400, labels:#{question.answers.size} }).hide();});"
+  - div_for question, :class => dep_class do
+    .number= next_number unless question.dependent?
+    %fieldset
+      %legend{:style => "display:inline;"}
+        %span.text= question.text
+        %span.help= question.help_text
+        = hidden_field_tag("responses[#{question.id}][question_id]", question.id)
+      %ol.answers
+        %li.answer
+          - options = question.answers.collect{|a| "<option #{ (response_set.response_for(question.id, a.id).selected?)? "selected='selected'" : nil } value ='#{a.id}'>#{a.text}</option>" }
+          = renderer == :slider ? select_tag("responses[#{question.id}][answer_id]", options, {:id => "slider_#{question.id}"}) : select_tag("responses[#{question.id}][answer_id]", ["<option value=''>Select one...</option>"].concat(options))
+- when :grid_default
+  - reset_cycle("col")
+  - content_tag_for :tr, question, :class => dep_class do
+    %td.question_prefix
+      %span.text= split_text(question.text)[:prefix]
+      %span.help= question.help_text
+      = hidden_field_tag("responses[#{question.id}][question_id]", question.id)
+    - question.answers.each do |answer|
+      %td{:class => "#{cycle("column_highlight", "", :name => "col")}"}
+        .answer= render(:partial => "/partials/answer", :locals => {:answer => answer, :question => question, :response_obj => @response_set.response_for(question.id, answer.id), :hide_label => true})
+    %td.question_postfix
+      %span.text= split_text(question.text)[:postfix]
+- when :repeater_default, :repeater_dropdown
+  - disabled ||= false
+  - div_for question, :class => "#{disabled ? 'dis' : 'en'}abled #{dep_class}" do
+    %span.text= question.text
+    %span.help= question.help_text
+    = hidden_field_tag("response_groups[#{question.id}][#{response_group}][response_group]", response_group)
+    = hidden_field_tag("response_groups[#{question.id}][#{response_group}][question_id]", question.id)
+    %ol.answers
+      - if renderer == :repeater_default
+        - question.answers.each do |answer|
+          - content_tag_for :li, answer do
+            = render(:partial => "/partials/answer", :locals => {:answer => answer, :question => question, :response_obj => @response_set.response_for(question.id, answer.id), :response_group => response_group, :hide_label => true, :disabled => disabled})
+      - else
+        %li.answer
+          - options = question.answers.collect{|a| "<option #{ (response_set.response_for(question.id, a.id).selected?)? "selected='selected'" : nil } value ='#{a.id}'>#{a.text}</option>" }
+          = select_tag("responses[#{question.id}][answer_id]", ["<option value=''>Select one...</option>"].concat(options))
+- when :inline_default, :inline_dropdown
+  - div_for question, :class => "inline #{dep_class}" do
+    = hidden_field_tag("responses[#{question.id}][question_id]", question.id)
+    - if renderer == :inline_default
+      - question.answers.each do |answer|
+        .answer= render(:partial => "/partials/answer", :locals => {:answer => answer, :question => question, :response_obj => @response_set.response_for(question.id, answer.id), :hide_label => answer.hide_label})
+    - else
+      - options = question.answers.collect{|a| "<option #{ (response_set.response_for(question.id, a.id).selected?)? "selected='selected'" : nil } value ='#{a.id}'>#{a.text}</option>" }
+      = select_tag("responses[#{question.id}][answer_id]", ["<option value=''>Select one...</option>"].concat(options))
+- else # :default, :inline
+  - div_for question, :class => dep_class do
+    .number= next_number unless question.dependent?
+    %fieldset
+      %legend
+        %span.text= question.text
+        %span.help= question.help_text
+        = hidden_field_tag("responses[#{question.id}][question_id]", question.id)
+      %ol.answers{:class => renderer == :inline ? "inline" : nil}
+        - question.answers.each do |answer|
+          - content_tag_for :li, answer do
+            = render(:partial => "/partials/answer", :locals => {:answer => answer, :question => question, :response_obj => @response_set.response_for(question.id, answer.id), :hide_label => answer.hide_label})

data/app/views/partials/_question_group.html.haml ADDED

@@ -0,0 +1,41 @@
+- renderer = question_group.renderer
+- locals = {:question_group => question_group, :response_set => response_set, :hide_label => true}
+- div_for question_group do
+  .head
+    .number= next_number
+    %span.text= question_group.text
+    %span.help= question_group.help_text
+  - case question_group.renderer
+  - when :grid
+    %table.grid
+      %thead
+        %tr
+          %th= "&nbsp;"
+          - reset_cycle("column_highlight")
+          - group_questions.first.answers.each do |answer|
+            %th{:class => "#{cycle("column_highlight", "", :name => "column_highlight")}"}= answer.text
+      %tfoot
+        %tr
+          %th= "&nbsp;"
+          - reset_cycle("column_highlight")
+          - group_questions.first.answers.each do |answer|
+            %th{:class => "#{cycle("column_highlight","", :name => "column_highlight")}"}= answer.text
+      %tbody
+        - group_questions.each do |question|
+          = render(:partial => "/partials/question", :locals => locals.merge({:question => question}))
+  - when :repeater
+    %ul.repeater
+      - (response_set.count_group_responses(group_questions) + 1).times do |group_number|
+        %li.repeater
+          - group_questions.each do |question|
+            = render(:partial => "/partials/question", :locals => locals.merge({:question => question, :response_group => group_number, :disabled => false}))
+      %li.repeater
+        - group_questions.each do |question|
+          = render(:partial => "/partials/question", :locals => locals.merge({:question => question, :response_group => 9999, :disabled => true}))
+        = submit_tag("&lt;= add row", :name => "section[#{group_questions.first.survey_section_id}]question_group_#{question_group.id}", :class => "add_row")
+  - else # :inline
+    %ul
+      - group_questions.each do |question|
+        %li{:class => question_group.renderer == :inline ? "inline" : nil}= render(:partial => "/partials/question", :locals => locals.merge({:question => question}))

data/app/views/surveyor/edit.html.haml ADDED

@@ -0,0 +1,32 @@
+#surveyor
+  - form_tag(update_my_survey_path, :method => :put, :id => "survey_form") do
+    = hidden_field_tag :current_section_id, @section.id
+    - unless @sections.size < 3
+      #menu
+        Sections:
+        %ul
+          - @sections.each do |s|
+            %li{:class => ("active" if s == @section)}= menu_button_for(s)
+    #header
+      .title= @survey.title
+    .previous_section= previous_section
+    - unless @dependents.empty?
+      #dependents
+        .title Follow-up questions from your answers on the previous page
+        -# @dependents.each_with_index do |question, index|
+          = dependency_explanation_helper(question, @response_set)
+          = render(:partial => "/partials/question", :locals => {:question => question, :response_set => @response_set, :number => "D#{index+1}"})
+    - div_for @section do
+      %span.title= @section.title
+      .questions
+        - @section.questions.each_with_index do |question, index|
+          - unless question.part_of_group?
+            = render(:partial => "/partials/question", :locals => {:question => question, :response_set => @response_set})
+          - else # gather up the group questions
+            - (group_questions ||= []) << question
+            - if (index + 1 >= @section.questions.size) or (question.question_group_id != @section.questions[index + 1].question_group_id)
+              - # this is the last question of the section, or the group
+              = render(:partial => "/partials/question_group", :locals => {:question_group => question.question_group, :response_set => @response_set, :group_questions => group_questions})
+              - group_questions = []
+    .next_section= next_section

data/app/views/surveyor/new.html.haml ADDED

@@ -0,0 +1,17 @@
+#surveyor
+  #header
+    .title= surveyor_config['default.title'] || "You can take these surveys:"
+  %br
+  #survey_list
+    %ul
+      - unless @surveys.empty?
+        - @surveys.each do |survey|
+          %li
+            - form_tag(take_survey_path(:survey_code => survey.access_code)) do
+              = hidden_field_tag("current_user_id", @current_user.nil? ? nil : @current_user.id)
+              = survey.title
+              &nbsp;
+              = submit_tag("Take it" )
+      - else
+        %li
+          No surveys

data/app/views/surveyor/show.html.haml ADDED

@@ -0,0 +1,12 @@
+#surveyor
+  - @survey.sections.each do |section|
+    - div_for section do
+      .title= section.title
+      .questions
+        - @section.questions.each_with_index do |question, index|
+          - if question.part_of_group?
+            - if (index + 1 >= @section.questions.size) or (question.question_group_id != @section.questions[index + 1].question_group_id)
+              - # skip to the last question of the section, or the last question of the group
+              = render(:partial => "/partials/question_group", :locals => {:question_group => question.question_group, :response_set => @response_set})
+          - else
+            = render(:partial => "/partials/question", :locals => {:question => question, :response_set => @response_set})

data/config/routes.rb ADDED

@@ -0,0 +1,10 @@
+ActionController::Routing::Routes.draw do |map|
+  root = Surveyor::Config['default.relative_url_root'] || "surveys/"
+  map.with_options :controller => 'surveyor' do |s|
+    s.available_surveys "#{root}",                                       :conditions => {:method => :get}, :action => "new"      # GET survey list
+    s.take_survey       "#{root}:survey_code",                           :conditions => {:method => :post}, :action => "create"  # Only POST of survey to cre
+    s.view_my_survey    "#{root}:survey_code/:response_set_code",        :conditions => {:method => :get}, :action => "show"     # GET viewable/printable? su
+    s.edit_my_survey    "#{root}:survey_code/:response_set_code/take",   :conditions => {:method => :get}, :action => "edit"     # GET editable survey
+    s.update_my_survey  "#{root}:survey_code/:response_set_code",        :conditions => {:method => :put}, :action => "update"   # PUT edited survey
+  end
+end

data/generators/surveyor/EXTENDING_SURVEYOR ADDED

@@ -0,0 +1,12 @@
+Any of surveyor's models class_eval, class methods, and instance methods can be modified. Include the following in config/initializers/surveyor.rb:
+    require 'models/survey_extensions' # Extended the survey model
+SurveyorHelper class_eval and instance methods can be modified. Include the following in config/initializers/surveyor.rb:
+    require 'helpers/surveyor_helper_extensions' # Extend the surveyor helper
+SurveyorController class_eval, class methods, instance methods, and actions can be modified. Action methods should be specified separately in the Actions submodule. Set the following option in config/initializers/surveyor.rb Surveyor::Config block:
+    config['extend_controller'] = true

data/generators/surveyor/extend_surveyor_generator.rb ADDED

@@ -0,0 +1,22 @@
+class SurveyorGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      # Copy README to your app
+      m.file "EXTENDING_SURVEYOR", "surveyor/EXTENDING_SURVEYOR"
+      # Custom layout
+      m.file "extensions/surveyor_custom.html.erb", "app/views/layouts/surveyor_custom.html.erb"
+      # Model, helper, and controller extensions
+      # http://www.redmine.org/boards/3/topics/4095#message-4136
+      # http://blog.mattwynne.net/2009/07/11/rails-tip-use-polymorphism-to-extend-your-controllers-at-runtime/
+      m.file "extensions/survey_extensions.rb", "app/models/survey_extensions.rb"
+      m.file "extensions/surveyor_helper_extensions.rb", "app/helper/surveyor_helper_extensions.rb"
+      m.file "extensions/surveyor_controller_extensions.rb", "app/controllers/surveyor_controller_extensions.rb"
+      m.readme "EXTENDING_SURVEYOR"
+    end
+  end
+end

data/generators/surveyor/surveyor_generator.rb ADDED

@@ -0,0 +1,60 @@
+class SurveyorGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.directory "surveys"
+      # Copy README to your app
+      m.file "../../../README.md", "surveys/README.md"
+      # Gem plugin rake tasks
+      m.file "tasks/surveyor.rb", "lib/tasks/surveyor.rb"
+      if file_has_line(destination_path('Rakefile'), /^require 'tasks\/surveyor'$/ )
+        logger.skipped 'Rakefile'
+      else
+        File.open(destination_path('Rakefile'), 'ab') {|file| file.write("\nrequire 'tasks/surveyor'\n") }
+        # http://ggr.com/how-to-include-a-gems-rake-tasks-in-your-rails-app.html
+        logger.appended 'Rakefile'
+      end
+      # HAML
+      m.file "initializers/surveyor.rb", "config/initializers/surveyor.rb"
+      m.file "initializers/haml.rb", "config/initializers/haml.rb"
+      # Migrate
+      # not using m.migration_template because all migration timestamps end up the same, causing a collision when running rake db:migrate
+      # coped functionality from RAILS_GEM_PATH/lib/rails_generator/commands.rb
+      m.directory "db/migrate"
+      ["surveys", "survey_sections", "questions", "answers", "response_sets", "responses", "dependencies", "question_groups", "dependency_conditions"].each_with_index do |model, i|
+        unless (prev_migrations = Dir.glob("db/migrate/[0-9]*_*.rb").grep(/[0-9]+_create_#{model}.rb$/)).empty?
+          prev_migration_timestamp = prev_migrations[0].match(/([0-9]+)_create_#{model}.rb$/)[1]
+        end
+        # raise "Another migration is already named create_#{model}" if not Dir.glob("db/migrate/[0-9]*_*.rb").grep(/[0-9]+_create_#{model}.rb$/).empty?
+        m.template("migrate/create_#{model}.rb", "db/migrate/#{(prev_migration_timestamp || Time.now.utc.strftime("%Y%m%d%H%M%S").to_i + i).to_s}_create_#{model}.rb")
+      end
+      # Generate CSS
+      css_root = File.join(File.dirname(__FILE__), "templates", "assets", "stylesheets")
+      `sass #{css_root}/sass/surveyor.sass #{css_root}/surveyor.css`
+      # Assets
+      ["images", "javascripts", "stylesheets"].each do |asset_type|
+        m.directory "public/#{asset_type}/surveyor"
+        Dir.glob(File.join(File.dirname(__FILE__), "templates", "assets", asset_type, "*.*")).map{|path| File.basename(path)}.each do |filename|
+          m.file "assets/#{asset_type}/#{filename}", "public/#{asset_type}/surveyor/#{filename}"
+        end
+      end
+      # Surveys
+      m.directory "surveys/fixtures"
+      m.file "surveys/kitchen_sink_survey.rb", "surveys/kitchen_sink_survey.rb"
+      m.readme "README"
+    end
+  end
+  def file_has_line(filename, rxp)
+    File.readlines(filename).each{ |line| return true if line =~ rxp }
+    false
+  end
+end

data/generators/surveyor/templates/README ADDED

@@ -0,0 +1,10 @@
+Surveyor installed. Next, run the migrations:
+    rake db:migrate
+Try out the "kitchen sink" survey:
+    rake surveyor FILE=surveys/kitchen_sink_survey.rb
+Or see README.md for configuration and customization details