surveyor 0.7.0 → 0.7.1

data/README.md

@@ -105,6 +105,12 @@ Surveyor depends on Rails 2.3 and the SASS style sheet language, part of HAML (h
 
 # Changes
 
+0.7.1
+
+custom index page
+custom classes and renderers
+fixing typo in kitchen sink survey
+
 0.7.0
 
 * new kitchen sink survey with better documentation of DSL

data/VERSION

@@ -1 +1 @@
-0.7.0
+0.7.1

data/app/controllers/surveyor_controller.rb

@@ -23,6 +23,7 @@ class SurveyorController < ApplicationController
   # Actions
   def new
     @surveys = Survey.find(:all)
+    redirect_to surveyor_default(:index) unless available_surveys_path == surveyor_default(:index)
   end
   def create
     if (@survey = Survey.find_by_access_code(params[:survey_code])) && (@response_set = ResponseSet.create(:survey => @survey, :user_id => @current_user))
@@ -68,7 +69,7 @@ class SurveyorController < ApplicationController
       format.html do
         if saved && params[:finish]
           flash[:notice] = "Completed survey"
-          redirect_to surveyor_default_finish
+          redirect_to surveyor_default(:finish)
         else
           flash[:notice] = "Unable to update survey" if !saved and !saved.nil? # saved.nil? is true if there are no questions on the page (i.e. if it only contains a label)
           redirect_to :action => "edit", :anchor => anchor_from(params[:section]), :params => {:section => section_id_from(params[:section])}
@@ -98,18 +99,19 @@ class SurveyorController < ApplicationController
   end
   
   # Extending surveyor
-  def surveyor_default_finish
+  def surveyor_default(type = :finish)
     # http://www.postal-code.com/mrhappy/blog/2007/02/01/ruby-comparing-an-objects-class-in-a-case-statement/
     # http://www.skorks.com/2009/08/how-a-ruby-case-statement-works-and-what-you-can-do-with-it/
-    case finish = Surveyor::Config['default.finish']
+    case arg = Surveyor::Config["default.#{type.to_s}"]
     when String
-      return finish
+      return arg
     when Symbol
-      return self.send(finish)
+      return self.send(arg)
     else
-      return '/surveys'
+      return available_surveys_path
     end
   end
+  
   def extend_actions
     # http://blog.mattwynne.net/2009/07/11/rails-tip-use-polymorphism-to-extend-your-controllers-at-runtime/
     self.extend SurveyorControllerExtensions::Actions if Surveyor::Config['extend_controller'] && defined? SurveyorControllerExtensions::Actions

data/app/models/question.rb

@@ -35,8 +35,8 @@ class Question < ActiveRecord::Base
   def triggered?(response_set)
     dependent? ? self.dependency.met?(response_set) : true
   end
-  def dep_class(response_set)
-    dependent? ? triggered?(response_set) ? "dependent" : "hidden dependent" : nil
+  def css_class(response_set)
+    [(dependent? ? "dependent" : nil), (triggered?(response_set) ? nil : "hidden"), custom_class].compact.join(" ")
   end
   
   def part_of_group?

data/app/models/question_group.rb

@@ -23,8 +23,8 @@ class QuestionGroup < ActiveRecord::Base
   def triggered?(response_set)
     dependent? ? self.dependency.met?(response_set) : true
   end
-  def dep_class(response_set)
-    dependent? ? triggered?(response_set) ? "dependent" : "hidden dependent" : nil
+  def css_class(response_set)
+    [(dependent? ? "dependent" : nil), (triggered?(response_set) ? nil : "hidden"), custom_class].compact.join(" ")
   end
   
 end

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

@@ -1,8 +1,7 @@
 - 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
+  - div_for question, :class => "label #{question.css_class(response_set)}" do
     %span.text= question.text
     %span.help= question.help_text
 - when :image
@@ -10,7 +9,7 @@
 - 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
+  - div_for question, :class => question.css_class(response_set) do
     .number= next_number unless question.dependent?
     %fieldset
       %legend{:style => "display:inline;"}
@@ -23,19 +22,19 @@
           = 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
+  - content_tag_for :tr, question, :class => question.css_class(response_set) do
     %th.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})
+        .answer{:class => answer.custom_class}= render(:partial => answer.custom_renderer || "/partials/answer", :locals => {:answer => answer, :question => question, :response_obj => @response_set.response_for(question.id, answer.id), :hide_label => true})
     %th.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
+  - div_for question, :class => "#{disabled ? 'dis' : 'en'}abled #{question.css_class(response_set)}" do
     %span.text= question.text
     %span.help= question.help_text
     = hidden_field_tag("response_groups[#{question.id}][#{response_group}][response_group]", response_group)
@@ -43,23 +42,23 @@
     %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 => response_group, :hide_label => true, :disabled => disabled})
+          - content_tag_for :li, answer, :class => answer.custom_class do
+            = render(:partial => answer.custom_renderer || "/partials/answer", :locals => {:answer => answer, :question => question, :response_obj => @response_set.response_for(question.id, answer.id, response_group), :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, response_group).selected?)? "selected='selected'" : nil } value ='#{a.id}'>#{a.text}</option>" }
           = select_tag("response_groups[#{question.id}][#{response_group}][answer_id]", ["<option value=''>Select one...</option>"].concat(options), :disabled => disabled)
 - when :inline_default, :inline_dropdown
-  - div_for question, :class => "inline #{dep_class}" do
+  - div_for question, :class => "inline #{question.css_class(response_set)}" 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})
+        .answer{:class => answer.custom_class}= render(:partial => answer.custom_renderer || "/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
+  - div_for question, :class => question.css_class(response_set) do
     .number= next_number unless question.dependent?
     %fieldset
       %legend
@@ -68,5 +67,5 @@
         = 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})
+          - content_tag_for :li, answer, :class => answer.custom_class do
+            = render(:partial => answer.custom_renderer || "/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

@@ -1,8 +1,6 @@
 - renderer = question_group.renderer
-- dep_class = question_group.dep_class(response_set)
 - locals = {:question_group => question_group, :response_set => response_set, :hide_label => true}
-
-- div_for question_group, :class => dep_class do
+- div_for question_group, :class => question_group.css_class(response_set) do
   .head
     .number= next_number
     %span.text= question_group.text
@@ -19,7 +17,7 @@
             %th{:class => "#{cycle("column_highlight", "", :name => "column_highlight")}"}= answer.text
       %tbody
         - group_questions.each_with_index do |question, i|
-          = render(:partial => "/partials/question", :locals => locals.merge({:question => question}))
+          = render(:partial => question.custom_renderer || "/partials/question", :locals => locals.merge({:question => question}))
           - if i%10 == 9
             %th= " "
             - reset_cycle("column_highlight")
@@ -30,12 +28,12 @@
       - (response_set.count_group_responses(group_questions) + 3).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}))
+            = render(:partial => question.custom_renderer || "/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}))
+          = render(:partial => question.custom_renderer || "/partials/question", :locals => locals.merge({:question => question, :response_group => 9999, :disabled => true}))
         = submit_tag("<= 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}))
+        %li{:class => question_group.renderer == :inline ? "inline" : nil}= render(:partial => question.custom_renderer || "/partials/question", :locals => locals.merge({:question => question}))

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

@@ -1,5 +1,5 @@
 #surveyor
-  - form_tag(update_my_survey_path, :method => :put, :id => "survey_form") do
+  - form_tag(update_my_survey_path, :method => :put, :id => "survey_form", :class => @survey.custom_class) do
     = hidden_field_tag :current_section_id, @section.id
     - unless @sections.size < 3
       #menu
@@ -15,19 +15,19 @@
         .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
+          = render(:partial => question.custom_renderer || "/partials/question", :locals => {:question => question, :response_set => @response_set, :number => "D#{index+1}"})
+    - div_for @section, :class => @section.custom_class do
       %span.title= @section.title
       .questions
         - group_questions ||= []
         - @questions.each_with_index do |question, index|
           - unless question.part_of_group?
-            = render(:partial => "/partials/question", :locals => {:question => question, :response_set => @response_set})
+            = render(:partial => question.custom_renderer || "/partials/question", :locals => {:question => question, :response_set => @response_set})
           - else # gather up the group questions
             - group_questions << question
             - if (index + 1 >= @questions.size) or (question.question_group_id != @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})
+              = render(:partial => question.question_group.custom_renderer || "/partials/question_group", :locals => {:question_group => question.question_group, :response_set => @response_set, :group_questions => group_questions})
               - group_questions = []
     .next_section= next_section
       

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

@@ -2,6 +2,7 @@ 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.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_controller'] = false # set to true to extend SurveyorController

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

@@ -40,8 +40,8 @@ survey "“Kitchen Sink” survey" do
     # :reference_identifier   # usually from paper
     # :data_export_identifier # data export
     # :common_namespace       # maping to a common vocab
-    # :common_identitier      # 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_identifer => "get me started"
+    # :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
@@ -49,11 +49,14 @@ survey "“Kitchen Sink” survey" do
     # Various types of respones can be accepted
     q "How many pets do you own?"
     a :integer
-
-    q "What is your address?"
-    a :text
-
-    q "Pick your favorite date AND time"
+    
+    # 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'
+    
+    # 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 "What time do you usually take a lunch break?"

data/surveyor.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{surveyor}
-  s.version = "0.7.0"
+  s.version = "0.7.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Chamberlain", "Mark Yoon"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: surveyor
 version: !ruby/object:Gem::Version 
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors: 
 - Brian Chamberlain