surveyor 0.21.0 → 0.22.0

data/.gitignore

@@ -24,3 +24,4 @@ reports
 testbed
 surveys/fixtures/*.yml
 .rvmrc
+.sass-cache/**/*.sassc

data/Gemfile

@@ -3,9 +3,3 @@ source :rubygems
 gemspec
 
 eval(File.read File.expand_path('../Gemfile.rails_version', __FILE__))
-
-group :development do
-  # use git version for the ci:setup:rspecbase task; not there in
-  # 1.6.5, but might be in a later version.
-  gem 'ci_reporter', :git => 'git://github.com/nicksieger/ci_reporter.git'
-end

data/README.md

@@ -55,34 +55,32 @@ The first question is "pick one" (radio buttons) with "other". The second questi
 
 # Installation
 
-1. Add surveyor to your Gemfile (add add haml too if you haven't already):
+1. Add surveyor to your Gemfile:
 
-gem "surveyor"
-gem "haml"
+    gem "surveyor"
 
 Then run:
 
-`bundle install`
+    bundle install
 
 2. Generate assets, run migrations:
 
-`script/rails generate surveyor:install`
-`rake db:migrate`
+    script/rails generate surveyor:install
+    rake db:migrate
 
 3. Try out the "kitchen sink" survey. The rake task above generates surveys from our custom survey DSL (a good format for end users and stakeholders).
 
-`rake surveyor FILE=surveys/kitchen_sink_survey.rb`
+    rake surveyor FILE=surveys/kitchen_sink_survey.rb
 
-4. Start up your app and visit:
-
-http://localhost:3000/surveys
+4. Start up your app and visit http://localhost:3000/surveys
 
 Try taking the survey and compare it to the contents of the DSL file kitchen\_sink\_survey.rb. See how the DSL maps to what you see.
 
-There are two other useful rake tasks for removing (only surveys without responses) and un-parsing (from db to DSL file) surveys:
+There are two other useful rake tasks:
 
-`rake surveyor:remove`
-`rake surveyor:unparse`
+* `surveyor:remove` removes all unused surveys.
+* `rake surveyor:unparse` exports a survey from the application into a
+  file in the surveyor DSL.
 
 # Customizing surveyor
 
@@ -92,12 +90,40 @@ Surveyor's controller, models, and views may be customized via classes in your a
 
 and read surveys/EXTENDING\_SURVEYOR
 
+# PDF support
+
+* Add the following lines to your Gemfile:
+
+<pre>
+	gem 'pdfkit'
+	gem 'wkhtmltopdf'
+</pre>
+
+or on OSX:
+
+<pre>
+	gem 'pdfkit'
+	gem 'wkhtmltopdf-binary'
+</pre>
+
+* Add the following to your application.rb:
+
+<pre>
+	config.middleware.use PDFKit::Middleware
+</pre>
+
+* Create links with :format => 'pdf' in them, for example:
+
+<pre>
+	%li= link_to "PDF", view_my_survey_path(:survey_code => response_set.survey.access_code, :response_set_code => response_set.access_code, :format => 'pdf')
+</pre>
+
 # Requirements
 
 Surveyor depends on:
 
 * Ruby (1.8.7 - 1.9.2)
-* Rails 3.x
+* Rails 3.0-3.1
 * HAML
 * SASS
 * fastercsv (or CSV for ruby 1.9) for csv exports

data/app/helpers/surveyor_helper.rb

@@ -1,87 +1,3 @@
 module SurveyorHelper
-  # Layout: stylsheets and javascripts
-  def surveyor_includes
-    surveyor_stylsheets + surveyor_javascripts
-  end
-  def surveyor_stylsheets
-    stylesheet_link_tag 'surveyor/reset', 'surveyor/dateinput', 'surveyor', 'custom'
-  end
-  def surveyor_javascripts
-    javascript_include_tag 'surveyor/jquery.tools.min', 'surveyor/jquery.surveyor', 'surveyor/jquery.blockUI'
-  end
-  # Helper for displaying warning/notice/error flash messages
-  def flash_messages(types)
-    types.map{|type| content_tag(:div, "#{flash[type]}".html_safe, :class => type.to_s)}.join.html_safe
-  end
-  # Section: dependencies, menu, previous and next
-  def dependency_explanation_helper(question,response_set)
-    # Attempts to explain why this dependent question needs to be answered by referenced the dependent question and users response
-    trigger_responses = []
-    dependent_questions = Question.find_all_by_id(question.dependency.dependency_conditions.map(&:question_id)).uniq
-    response_set.responses.find_all_by_question_id(dependent_questions.map(&:id)).uniq.each do |resp|
-      trigger_responses << resp.to_s
-    end
-    "&nbsp;&nbsp;You answered &quot;#{trigger_responses.join("&quot; and &quot;")}&quot; to the question &quot;#{dependent_questions.map(&:text).join("&quot;,&quot;")}&quot;"
-  end
-  def menu_button_for(section)
-    submit_tag(section.title, :name => "section[#{section.id}]")
-  end
-  def previous_section
-    # use copy in memory instead of making extra db calls
-    submit_tag(t('surveyor.previous_section').html_safe, :name => "section[#{@sections[@sections.index(@section)-1].id}]") unless @sections.first == @section
-  end
-  def next_section
-    # use copy in memory instead of making extra db calls
-    @sections.last == @section ? submit_tag(t('surveyor.click_here_to_finish').html_safe, :name => "finish") : submit_tag(t('surveyor.next_section').html_safe, :name => "section[#{@sections[@sections.index(@section)+1].id}]")
-  end
-
-  # Questions
-  def q_text(obj)
-    @n ||= 0
-    return image_tag(obj.text) if obj.is_a?(Question) and obj.display_type == "image"
-    return obj.text if obj.is_a?(Question) and (obj.dependent? or obj.display_type == "label" or obj.part_of_group?)
-    "#{@n += 1}) #{obj.text}"
-  end
-  # def split_text(text = "") # Split text into with "|" delimiter - parts to go before/after input element
-  #   {:prefix => text.split("|")[0].blank? ? "&nbsp;" : text.split("|")[0], :postfix => text.split("|")[1] || "&nbsp;"}
-  # end
-  # def question_help_helper(question)
-  #   question.help_text.blank? ? "" : %Q(<span class="question-help">#{question.help_text}</span>)
-  # end
-
-  # Answers
-  def a_text(obj, pos=nil)
-    return image_tag(obj.text) if obj.is_a?(Answer) and obj.display_type == "image"
-    obj.split_or_hidden_text(pos)
-  end
-  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
-  def rc_to_as(type_sym)
-    case type_sym.to_s
-    when /(integer|float)/ then :string
-    else type_sym
-    end
-  end
-  def generate_pick_none_input_html(response_class, default_value, css_class)
-    html = {}
-    html[:class] = css_class unless css_class.blank?
-    html[:value] = default_value if response_class.blank?
-    html
-  end
-
-  # Responses
-  def response_for(response_set, question, answer = nil, response_group = nil)
-    return nil unless response_set && question && question.id
-    result = response_set.responses.detect{|r| (r.question_id == question.id) && (answer.blank? ? true : r.answer_id == answer.id) && (r.response_group.blank? ? true : r.response_group.to_i == response_group.to_i)}
-    result.blank? ? response_set.responses.build(:question_id => question.id, :response_group => response_group) : result
-  end
-  def response_idx(increment = true)
-    @rc ||= 0
-    (increment ? @rc += 1 : @rc).to_s
-  end
+  include Surveyor::Helpers::SurveyorHelperMethods
 end

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

@@ -2,18 +2,19 @@
 - rg ||= nil
 - r = response_for(@response_set, q, a, rg)
 - i = response_idx(q.pick != "one") # argument will be false (don't increment i) if we're on radio buttons
+- disabled = defined?(disableFlag) ? disableFlag : false
 = f.semantic_fields_for i, r do |ff|
   = ff.quiet_input :question_id unless q.pick == "one" # don't repeat question_id if we're on radio buttons
   = ff.quiet_input :id unless q.pick == "one" or r.new_record?
   = ff.quiet_input :response_group, :value => rg if q.pick != "one" && g && g.display_type == "repeater"
   - case q.pick
   - when "one"
-    = ff.input :answer_id, :as => :surveyor_radio, :collection => [[a_text(a), a.id]], :label => false, :input_html => {:class => a.css_class}, :response_class => a.response_class
+    = ff.input :answer_id, :as => :surveyor_radio, :collection => [[a_text(a, nil, @render_context), a.id]], :label => false, :input_html => {:class => a.css_class, :disabled => disabled}, :response_class => a.response_class
   - when "any"
-    = ff.input :answer_id, :as => :surveyor_check_boxes, :collection => [[a_text(a), a.id]], :label => false, :input_html => {:class => a.css_class}, :response_class => a.response_class
+    = ff.input :answer_id, :as => :surveyor_check_boxes, :collection => [[a_text(a, nil, @render_context), a.id]], :label => false, :input_html => {:class => a.css_class, :disabled => disabled}, :response_class => a.response_class
   - when "none"
     - if %w(date datetime time float integer string text).include? a.response_class
       = ff.quiet_input :answer_id, :input_html => {:class => a.css_class, :value => a.id}
-      = ff.input rc_to_attr(a.response_class), :as => rc_to_as(a.response_class), :label => a_text(a, :pre).blank? ? false : a_text(a, :pre), :hint => a_text(a, :post), :input_html => generate_pick_none_input_html(r.as(a.response_class), a.default_value, a.css_class)
+      = ff.input rc_to_attr(a.response_class), :as => rc_to_as(a.response_class), :label => a_text(a, :pre, @render_context).blank? ? false : a_text(a, :pre, @render_context), :hint => a_text(a, :post, @render_context), :input_html => generate_pick_none_input_html(r.as(a.response_class), a.default_value, a.css_class, a.response_class, disabled)
     - else
-      = a_text(a)
+      = a_text(a, nil, @render_context)

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

@@ -1,18 +1,19 @@
 -# TODO: js for slider
 - rg ||= nil
 - renderer = q.renderer(g ||= nil)
-= f.inputs q_text(q), :id => rg ? "q_#{q.id}_#{rg}" : "q_#{q.id}", :class => "q_#{renderer} #{q.css_class(@response_set)}" do
-  %span.help= q.help_text
+- disabled = defined?(disableFlag) ? disableFlag : false
+= f.inputs q_text(q, @render_context), :id => rg ? "q_#{q.id}_#{rg}" : "q_#{q.id}", :class => "q_#{renderer} #{q.css_class(@response_set)}" do
+  %span.help= render_help_text(q, @render_context)
   - case renderer
   - when :image, :label
-  - when :dropdown, :inline_dropdown, :slider, :repeater_dropdown
+  - when :dropdown, :inline_dropdown, :default_dropdown, :slider, :repeater_dropdown
     - r = response_for(@response_set, q, nil, rg)
     - i = response_idx
     = f.semantic_fields_for i, r do |ff|
       = ff.quiet_input :question_id
       = ff.quiet_input :response_group, :value => rg if g && g.display_type == "repeater"
       = ff.quiet_input :id unless r.new_record?
-      = ff.input :answer_id, :as => :select, :collection => q.answers.map{|a| [a.text, a.id]}, :label => q.text
+      = ff.input :answer_id, :as => :select, :collection => q.answers.map{|a| [a.text, a.id]}, :label => q.text, :input_html => { :disabled => disabled }
   - else # :default, :inline, :inline_default
     - if q.pick == "one"
       - r = response_for(@response_set, q, nil, rg)
@@ -22,4 +23,5 @@
         = ff.quiet_input :response_group, :value => rg if g && g.display_type == "repeater"
         = ff.quiet_input :id unless r.new_record?
     - q.answers.each do |a|
-      = render a.custom_renderer || '/partials/answer', :q => q, :a => a, :f => f, :rg => rg, :g => g
+      - next if (q.pick == "one" or q.pick == "any") and disabled and @response_set.responses.where( :question_id => q.id, :answer_id => a.id).empty? 
+      = render a.custom_renderer || '/partials/answer', :q => q, :a => a, :f => f, :rg => rg, :g => g, :disableFlag => disabled

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

@@ -1,6 +1,6 @@
 - renderer = g.renderer
-= f.inputs q_text(g), :id => "g_#{g.id}", :class => "g_#{renderer} #{g.css_class(@response_set)}" do
-  %li.help= g.help_text
+= f.inputs q_text(g, @render_context), :id => "g_#{g.id}", :class => "g_#{renderer} #{g.css_class(@response_set)}" do
+  %li.help= render_help_text(g, @render_context)
   - case renderer
     - when :grid
       %li

data/app/views/surveyor/export.json.rabl

@@ -0,0 +1,75 @@
+object @survey
+attribute :title
+attribute :api_id => :uuid
+node(:description,            :if => lambda {|s| !s.description.blank? }){|s| s.description }
+node(:reference_identifier,   :if => lambda {|s| !s.reference_identifier.blank? }){|s| s.reference_identifier }
+
+child :sections => :sections do
+  attributes :title, :display_order
+  node(:description,            :if => lambda {|s| !s.description.blank? }){|s| s.description }
+  node(:reference_identifier,   :if => lambda {|s| !s.reference_identifier.blank? }){|s| s.reference_identifier }
+  
+  child :questions_and_groups => :questions_and_groups do
+    # both questions and question_groups have uuid, text, help_text, reference_identifier, and type
+    attribute :api_id => :uuid
+    node(:text,                 :if => lambda { |q| q.is_a?(Question)}){ |q| q.split_text(:pre) }
+    node(:text,                 :if => lambda { |q| q.is_a?(QuestionGroup)}){ |q| q.text }
+    node(:help_text,            :if => lambda { |q| !q.help_text.blank? }){ |q| q.help_text }
+    node(:reference_identifier, :if => lambda { |q| !q.reference_identifier.blank? }){ |q| q.reference_identifier }
+    node(:type,                 :if => lambda { |q| q.display_type != "default" }){ |q| q.display_type }
+    
+    # only questions
+    node(:pick,                 :if => lambda { |q| q.is_a?(Question) && q.pick != "none" }){ |q| q.pick }
+    node(:post_text,            :if => lambda { |q| q.is_a?(Question) && !q.split_text(:post).blank? }){ |q| q.split_text(:post) }
+  
+    child :answers, :if => lambda { |q| q.is_a?(Question) && !q.answers.blank? } do
+      attribute :api_id => :uuid
+      node(:help_text, :if => lambda { |a| !a.help_text.blank? }){ |a| a.help_text }
+      node(:exclusive, :if => lambda { |a| a.is_exclusive }){ |a| a.is_exclusive }
+      node(:text){ |a| a.split_or_hidden_text(:pre) }
+      node(:post_text, :if => lambda { |a| !a.split_or_hidden_text(:post).blank? }){ |a| a.split_or_hidden_text(:post) }
+      node(:type, :if => lambda { |a| a.response_class != "answer" }){ |a| a.response_class }
+    end
+    
+    # both questions and question_groups have dependencies
+    child :dependency, :if => lambda { |q| q.dependency } do
+      attributes :rule
+      child :dependency_conditions => :conditions do
+        attributes :rule_key, :operator
+        node(:question){ |d| d.question.api_id }
+        node(:answer, :if => lambda { |d| d.answer }){ |d| d.answer.api_id }
+        node(:value, :if => lambda { |d| d.answer && d.answer.response_class != "answer" && d.as(d.answer.response_class) }){ |d| d.as(d.answer.response_class)}
+      end
+    end
+    
+    child(:questions, :if => lambda{|x| x.is_a?(QuestionGroup)}) do
+      attributes :api_id => :uuid
+      node(:text){ |q| q.split_text(:pre) }
+      node(:post_text, :if => lambda { |q| !q.split_text(:post).blank? }){ |q| q.split_text(:post) }
+      node(:help_text, :if => lambda { |q| !q.help_text.blank? }){ |q| q.help_text }
+      node(:reference_identifier, :if => lambda { |q| !q.reference_identifier.blank? }){ |q| q.reference_identifier }
+      node(:type, :if => lambda { |q| q.display_type != "default" }){ |q| q.display_type }
+      node(:pick, :if => lambda { |q| q.pick != "none" }){ |q| q.pick }
+  
+      child :answers, :if => lambda { |q| !q.answers.blank? } do
+        attributes :api_id => :uuid
+        node(:help_text, :if => lambda { |a| !a.help_text.blank? }){ |a| a.help_text }
+        node(:is_exclusive, :if => lambda { |a| a.is_exclusive }){ |a| a.is_exclusive }
+        node(:text){ |a| a.split_or_hidden_text(:pre) }
+        node(:post_text, :if => lambda { |a| !a.split_or_hidden_text(:post).blank? }){ |a| a.split_or_hidden_text(:post) }
+        node(:type, :if => lambda { |a| a.response_class != "answer" }){ |a| a.response_class }
+      end
+  
+      child :dependency, :if => lambda { |q| q.dependency } do
+        attributes :rule
+        child :dependency_conditions => :conditions do
+          attributes :rule_key, :operator
+          node(:question){ |d| d.question.api_id }
+          node(:answer, :if => lambda { |d| d.answer }){ |d| d.answer.api_id }
+          node(:value, :if => lambda { |d| d.answer && d.answer.response_class != "answer" && d.as(d.answer.response_class) }){ |d| d.as(d.answer.response_class)}
+        end
+      end
+    end
+  end
+
+end

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

@@ -1,15 +1,77 @@
 #surveyor
-  - @survey.sections.each do |section|
-    - div_for section do
-      .title= section.title
-      .questions
-        - group_questions ||= []
-        - section.questions.each_with_index do |question, index|
-          - if question.part_of_group?
-            - group_questions << question
-            - 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, :group_questions => group_questions})
+  - unless (types = flash.keys.select{|k| [:notice, :error, :warning].include?(k)}).blank?
+    .surveyor_flash
+      = flash_messages(types)
+      .close
+  = semantic_form_for(@response_set, :as => :r, :url => update_my_survey_path, :html => {:id => "survey_form", :class => @survey.custom_class}) do |f|
+    .survey_title= @survey.title
+    - @survey.sections.each do |section|
+      = div_for section do
+        %span.title= strip_tags(section.title)
+        - group_questions = []
+        - answered_questions = []
+        - label = nil
+        - answered_count = 0
+        - (questions = section.questions).each_with_index do |q, i|
+          - if q.part_of_group?
+            - group_questions << q # gather up the group questions
+            - unless @response_set.responses.where( :question_id => q.id).empty?
+              - answered_questions << q
+              - answered_count = answered_count + 1
+            - if (i+1 >= questions.size) or (q.question_group_id != questions[i+1].question_group_id) # this is the last question of the section, or the group
+              - if answered_questions.length > 0 # there are answered questions in this section or group
+                - g = q.question_group
+                - renderer = g.renderer
+                
+                - unless label.blank?
+                  = render q.custom_renderer || "/partials/question", :q => label, :f => f, :disableFlag => true
+                  - label = nil
+                = f.inputs q_text(g), :id => "g_#{g.id}", :class => "g_#{renderer} #{g.css_class(@response_set)}" do
+                  %li.help= g.help_text
+                  - case renderer
+                    - when :grid
+                      %li
+                        %table
+                          %col.pre
+                          - group_questions.first.answers.each do |a| 
+                            %col{:class => cycle("odd", "even")}
+                          %col.post
+                          %tbody
+                            - group_questions.each_slice(10) do |ten_questions| # header row every 10
+                              %tr
+                                %th &nbsp;
+                                - ten_questions.first.answers.each do |a|
+                                  %th= a_text(a)
+                                %th &nbsp;
+                              - ten_questions.each_with_index do |q, j|
+                                %tr{:id => "q_#{q.id}", :class => "q_#{renderer} #{q.css_class(@response_set)}"}
+                                  - if q.pick == "one"
+                                    - r = response_for(@response_set, q, nil, g)
+                                    - j = response_idx  # increment the response index since the answer partial skips for q.pick == one
+                                  %th= q.split_text(:pre)
+                                  - q.answers.each do |a|
+                                    %td= render a.custom_renderer || '/partials/answer', :g => g, :q => q, :a => a, :f => f, :disableFlag => true
+                                  %th= q.split_text(:post)
+                    - when :repeater
+                      - (@response_set.count_group_responses(group_questions) + 1).times do |rg|
+                        %li
+                          - group_questions.each do |q|
+                            = render q.custom_renderer || "/partials/question", :g => g, :rg => rg, :q => q, :f => f, :disableFlag => true
+                    - else # :inline
+                      - answered_questions.each do |q|
+                        = render q.custom_renderer || "/partials/question", :g => g, :q => q, :f => f, :disableFlag => true         
+              
               - group_questions = []
-          - else
-            = render(:partial => "/partials/question", :locals => {:question => question, :response_set => @response_set})
+              - answered_questions = []
+          - else 
+            - if q.display_type == 'label'
+              - label = q
+            - unless @response_set.responses.where( :question_id => q.id).empty?
+              - unless label.blank?
+                = render q.custom_renderer || "/partials/question", :q => label, :f => f, :disableFlag => true
+                - label = nil
+              = render q.custom_renderer || "/partials/question", :q => q, :f => f, :disableFlag => true
+              - answered_count = answered_count + 1
+          - if (i+1 >= questions.size) and (answered_count == 0)
+            #{"--- No data ---"}
+          

data/app/views/surveyor/show.json.rabl

@@ -0,0 +1,14 @@
+object @response_set
+attribute :api_id => :uuid
+attribute :created_at
+attribute :completed_at
+node(:survey_id){|rs| rs.survey.api_id }
+
+child :responses do
+  attribute :api_id => :uuid
+  attribute :created_at
+  attribute :updated_at => :modified_at
+  node(:answer_id){|r| r.answer.api_id }
+  node(:question_id){|r| r.question.api_id }
+  node(:value, :if => lambda{|r| r.answer.response_class != "answer"}){|r| r.as(r.answer.response_class) }
+end

data/config/routes.rb

@@ -1,9 +1,8 @@
 Rails.application.routes.draw do
-  match 'results', :to                                      => 'results#index', :as   => 'results', :via           => :get
-  match 'results/:survey_code', :to                         => 'results#show', :as    => 'result', :via            => :get
   match 'surveys', :to                                      => 'surveyor#new', :as    => 'available_surveys', :via => :get
   match 'surveys/:survey_code', :to                         => 'surveyor#create', :as => 'take_survey', :via       => :post
+  match 'surveys/:survey_code', :to                    => 'surveyor#export', :as => 'export_survey', :via     => :get
   match 'surveys/:survey_code/:response_set_code', :to      => 'surveyor#show', :as   => 'view_my_survey', :via    => :get
   match 'surveys/:survey_code/:response_set_code/take', :to => 'surveyor#edit', :as   => 'edit_my_survey', :via    => :get
   match 'surveys/:survey_code/:response_set_code', :to      => 'surveyor#update', :as => 'update_my_survey', :via  => :put
-end                                                                                      
+end