RubyGems - surveyor - Versions diffs - 0.10.0 → 0.11.0 - Mend

surveyor 0.10.0 → 0.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (16) hide show

data/README.md +30 -11
data/VERSION +1 -1
data/app/controllers/surveyor_controller.rb +7 -0
data/app/models/response_set.rb +22 -0
data/app/models/survey.rb +1 -0
data/app/views/partials/_answer.html.haml +13 -10
data/app/views/surveyor/new.html.haml +0 -1
data/config/routes.rb +5 -5
data/generators/surveyor/surveyor_generator.rb +2 -1
data/generators/surveyor/templates/migrate/add_index_to_response_sets.rb +9 -0
data/generators/surveyor/templates/migrate/add_index_to_surveys.rb +9 -0
data/generators/surveyor/templates/migrate/add_unique_indicies.rb +17 -0
data/spec/factories.rb +3 -1
data/spec/models/response_set_spec.rb +27 -0
data/surveyor.gemspec +5 -2
metadata +6 -3

data/README.md CHANGED Viewed

@@ -106,15 +106,16 @@ The surveyor generator creates config/initializers/surveyor.rb. There, you can s
 The initializer runs once, when the app starts. The block style is used to keep multiple options DRY (defaults below):
     Surveyor::Config.run do |config|
-      config['default.relative_url_root'] = "surveys/" # should end with '/'
-      config['default.title'] = "You can take these surveys:"
-      config['default.layout'] = "surveyor_default"
-      config['default.finish'] =  "/surveys"
-      config['use_restful_authentication'] = false
-      config['extend_controller'] = false
+      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
-You can update surveyor's at any time. Use the block style (above), or the individual style:
+You can update surveyor's configuration at any time. Use the block style (above), or the individual style:
     Surveyor::Config['default.title'] = "Cheese is great!"
@@ -152,9 +153,7 @@ SurveyorController class_eval, class methods, instance methods, and actions can
     </head>
     <body>
       <div id="flash"><%= flash[:notice] %></div>
-      <div id="survey_with_menu">
-        <%= yield %>
-      </div>
+      <%= yield %>
     </body>
     </html>
@@ -175,6 +174,26 @@ To work on the plugin code (for enhancements, and bug fixes, etc...) fork this g
 # Changes
+0.11.0
+* basic csv export. closes #21
+* add unique indicies. closes #45
+* add one_integer renderer. closes #51
+* constrain surveys to have unique access_codes. closes #45. closes #42
+* covering the extremely unlikely case that response_sets may have a non-unique access_code. closes #46. thanks jakewendt.
+* current user id not needed in the view, set in SurveyorController. closes #48. thanks jakewendt
+0.10.0
+* surveyor config['extend'] is now an array. custom modules (e.g. SurveyExtensions are now included from within surveyor models, allowing
+the customizations to work on every request in development. closes #39. thanks to mgurley and jakewendt for the suggestions.
+* remove comment from surveyor_includes
+* css tweak
+* automatically add backslashes and eliminate multiple backslashes in relative root for routes
+* readme spelling and line breaks
+* fixing a failing spec with factory instead of mock parent model
+* upgrading cucumber to 0.6
 0.9.11
 * adding rails init.rb to make gem loading work. thanks mike gurley. closes #52.

data/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 0.10.0
1	+ 0.11.0

data/app/controllers/surveyor_controller.rb CHANGED Viewed

@@ -39,6 +39,13 @@ class SurveyorController < ApplicationController
   end
   def show
+    @response_set = ResponseSet.find_by_access_code(params[:response_set_code], :include => {:responses => [:question, :answer]})
+    respond_to do |format|
+      format.html #{render :action => :show}
+      format.csv {
+        send_data(@response_set.to_csv, :type => 'text/csv; charset=utf-8; header=present',:filename => "#{@response_set.updated_at.strftime('%Y-%m-%d')}_#{@response_set.access_code}.csv")
+      }
+    end
   end
   def edit

data/app/models/response_set.rb CHANGED Viewed

@@ -11,6 +11,7 @@ class ResponseSet < ActiveRecord::Base
   # Validations
   validates_presence_of :survey_id
   validates_associated :responses
+  validates_uniqueness_of :access_code
   # Attributes
   attr_protected :completed_at
@@ -30,6 +31,27 @@ class ResponseSet < ActiveRecord::Base
     self.access_code = Surveyor.make_tiny_code
   end
+  def access_code=(val)
+    while ResponseSet.find_by_access_code(val)
+      val = Surveyor.make_tiny_code
+    end
+    super
+  end
+  def to_csv
+    qcols = Question.content_columns.map(&:name) - %w(created_at updated_at)
+    acols = Answer.content_columns.map(&:name) - %w(created_at updated_at)
+    rcols = Response.content_columns.map(&:name)
+    require 'fastercsv'
+    FCSV(result = "") do |csv|
+      csv << qcols.map{|qcol| "question.#{qcol}"} + acols.map{|acol| "answer.#{acol}"} + rcols.map{|rcol| "response.#{rcol}"}
+      responses.each do |response|
+        csv << qcols.map{|qcol| response.question.send(qcol)} + acols.map{|acol| response.answer.send(acol)} + rcols.map{|rcol| response.send(rcol)}
+      end
+    end
+    result
+  end
   def response_for(question_id, answer_id, group = nil)
     found = responses.detect{|r| r.question_id == question_id && r.answer_id == answer_id && r.response_group.to_s == group.to_s}
     found.blank? ? responses.new(:question_id => question_id, :answer_id => answer_id, :response_group => group) : found

data/app/models/survey.rb CHANGED Viewed

@@ -13,6 +13,7 @@ class Survey < ActiveRecord::Base
   # Validations
   validates_presence_of :title
+  validates_uniqueness_of :access_code
   # Class methods
   def self.to_normalized_string(value)

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

@@ -16,20 +16,23 @@
     = response_form.survey_check_box(:selected, :class => (answer.is_exclusive? ? "exclusive" : ""))
     = response_form.label(:answer_id, answer.text)
     = response_form.text_field(:string_value, :size => 25, :maxlength => 250)
-  - when :one_answer, :one_string
+  - when :one_answer, :one_string, :one_integer
     - fields_for_radio(response_obj) do |radio_form|
       = radio_form.radio_button(:answer_id, answer.id, :checked => response_obj.selected?, :title => answer.text)
-      = radio_form.label("answer_id_#{answer.id}", answer.text, :class => (hide_label ? "hidden" : ""))
-    - if renderer == :one_string
-      = response_form.text_field(:string_value, :size => 25, :maxlength => 250, :autocomplete => "off")
+      = radio_form.label("answer_id_#{answer.id}", split_text(answer.text)[:prefix]) unless hide_label
+      - if renderer == :one_string
+        = response_form.text_field(:string_value, :size => 25, :maxlength => 250, :autocomplete => "off")
+      - if renderer == :one_integer
+        = response_form.text_field(:integer_value, :size => 5, :maxlength => 10, :autocomplete => "off")
+      = radio_form.label("answer_id_#{answer.id}", split_text(answer.text)[:postfix]) unless hide_label
   - when :none_date
-    = response_form.label(:string_value, split_text(answer.text)[:prefix], :class => "#{(disabled)? 'disabled' : 'enabled'}") unless hide_label
+    = response_form.label(:datetime_value, split_text(answer.text)[:prefix], :class => "#{(disabled)? 'disabled' : 'enabled'}") unless hide_label
     = response_form.text_field(:datetime_value)
-    = response_form.label(:string_value, split_text(answer.text)[:postfix], :class => "#{(disabled)? 'disabled' : 'enabled'}") unless hide_label
+    = response_form.label(:datetime_value, split_text(answer.text)[:postfix], :class => "#{(disabled)? 'disabled' : 'enabled'}") unless hide_label
   - when :none_datetime
-    = response_form.label(:string_value, split_text(answer.text)[:prefix], :class => "#{(disabled)? 'disabled' : 'enabled'}") unless hide_label
+    = response_form.label(:datetime_value, split_text(answer.text)[:prefix], :class => "#{(disabled)? 'disabled' : 'enabled'}") unless hide_label
     = response_form.datetime_select(:datetime_value, {:include_blank => true})
-    = response_form.label(:string_value, split_text(answer.text)[:postfix], :class => "#{(disabled)? 'disabled' : 'enabled'}") unless hide_label
+    = response_form.label(:datetime_value, split_text(answer.text)[:postfix], :class => "#{(disabled)? 'disabled' : 'enabled'}") unless hide_label
   - 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")
@@ -47,9 +50,9 @@
     = 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.label(:string_value, split_text(answer.text)[:prefix], :class => "#{(disabled)? 'disabled' : 'enabled'}") unless hide_label
+    = response_form.label(:datetime_value, split_text(answer.text)[:prefix], :class => "#{(disabled)? 'disabled' : 'enabled'}") unless hide_label
     = response_form.time_select(:datetime_value,{ :include_blank => true })
-    = response_form.label(:string_value, split_text(answer.text)[:postfix], :class => "#{(disabled)? 'disabled' : 'enabled'}") unless hide_label
+    = response_form.label(:datetime_value, split_text(answer.text)[:postfix], :class => "#{(disabled)? 'disabled' : 'enabled'}") unless hide_label
   - else
     = answer.text

data/app/views/surveyor/new.html.haml CHANGED Viewed

@@ -8,7 +8,6 @@
         - @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" )

data/config/routes.rb CHANGED Viewed

@@ -2,10 +2,10 @@ ActionController::Routing::Routes.draw do |map|
   root = Surveyor::Config['default.relative_url_root'] || "surveys"
   root = (root << "/").gsub(/\/+/, "/")
   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 create
-    s.view_my_survey    "#{root}:survey_code/:response_set_code",        :conditions => {:method => :get}, :action => "show"     # GET viewable/printable? survey
-    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
+    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 create
+    s.view_my_survey    "#{root}:survey_code/:response_set_code.:format", :conditions => {:method => :get}, :action => "show", :format => "html"  # GET viewable/printable? survey
+    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/surveyor_generator.rb CHANGED Viewed

@@ -29,7 +29,8 @@ class SurveyorGenerator < Rails::Generator::Base
         "create_response_sets", "create_responses",
         "create_dependencies", "create_dependency_conditions",
         "create_validations", "create_validation_conditions",
-        "add_display_order_to_surveys", "add_correct_answer_id_to_questions"].each_with_index do |model, i|
+        "add_display_order_to_surveys", "add_correct_answer_id_to_questions",
+        "add_index_to_response_sets", "add_index_to_surveys", "add_unique_indicies"].each_with_index do |model, i|
         unless (prev_migrations = Dir.glob("db/migrate/[0-9]*_*.rb").grep(/[0-9]+_#{model}.rb$/)).empty?
           prev_migration_timestamp = prev_migrations[0].match(/([0-9]+)_#{model}.rb$/)[1]
         end

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

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

@@ -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_unique_indicies.rb ADDED Viewed

@@ -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/spec/factories.rb CHANGED Viewed

@@ -2,10 +2,12 @@
 require 'rubygems'
 require 'factory_girl'
+Factory.sequence(:unique_survey_access_code){|n| "simple_survey" << n.to_s }
 Factory.define :survey do |s|
   s.title         {"Simple survey"}
   s.description   {"A simple survey for testing"}
-  s.access_code   {"simple_survey"}
+  s.access_code   {Factory.next :unique_survey_access_code}
   s.active_at     {Time.now}
   s.inactive_at   {}
   s.css_url       {}

data/spec/models/response_set_spec.rb CHANGED Viewed

@@ -215,4 +215,31 @@ describe ResponseSet, "with mandatory, dependent questions" do
     @response_set.mandatory_questions_complete?.should be_true
     @response_set.progress_hash.should == {:questions => 4, :triggered => 4, :triggered_mandatory => 4, :triggered_mandatory_completed => 4}
   end
+end
+describe ResponseSet, "exporting csv" do
+  before(:each) do
+    @section = Factory(:survey_section)
+    # Questions
+    @do_you_like_pie = Factory(:question, :text => "Do you like pie?", :survey_section => @section)
+    @what_flavor = Factory(:question, :text => "What flavor?", :survey_section => @section)
+    @what_bakery = Factory(:question, :text => "What bakery?", :survey_section => @section)
+    # Answers
+    @do_you_like_pie.answers << Factory(:answer, :text => "yes", :question_id => @do_you_like_pie.id)
+    @do_you_like_pie.answers << Factory(:answer, :text => "no", :question_id => @do_you_like_pie.id)
+    @what_flavor.answers << Factory(:answer, :response_class => :string, :question_id => @what_flavor.id)
+    @what_bakery.answers << Factory(:answer, :response_class => :string, :question_id => @what_bakery.id)
+    # Responses
+    @response_set = Factory(:response_set)
+    @response_set.current_section_id = @section.id
+    @response_set.responses << Factory(:response, :question_id => @do_you_like_pie.id, :answer_id => @do_you_like_pie.answers.first.id, :response_set_id => @response_set.id)
+    @response_set.responses << Factory(:response, :string_value => "pecan pie", :question_id => @what_flavor.id, :answer_id => @what_flavor.answers.first.id, :response_set_id => @response_set.id)
+  end
+  it "should export a string with responses" do
+    @response_set.responses.size.should == 2
+    csv = @response_set.to_csv
+    csv.is_a?(String).should be_true
+    csv.should match "question.short_text"
+    csv.should match "What flavor?"
+    csv.should match /pecan pie/
+  end
 end

data/surveyor.gemspec CHANGED Viewed

@@ -5,11 +5,11 @@
 Gem::Specification.new do |s|
   s.name = %q{surveyor}
-  s.version = "0.10.0"
+  s.version = "0.11.0"
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Chamberlain", "Mark Yoon"]
-  s.date = %q{2010-04-05}
+  s.date = %q{2010-04-06}
   s.email = %q{yoon@northwestern.edu}
   s.extra_rdoc_files = [
     "README.md"
@@ -111,6 +111,9 @@ Gem::Specification.new do |s|
      "generators/surveyor/templates/initializers/surveyor.rb",
      "generators/surveyor/templates/migrate/add_correct_answer_id_to_questions.rb",
      "generators/surveyor/templates/migrate/add_display_order_to_surveys.rb",
+     "generators/surveyor/templates/migrate/add_index_to_response_sets.rb",
+     "generators/surveyor/templates/migrate/add_index_to_surveys.rb",
+     "generators/surveyor/templates/migrate/add_unique_indicies.rb",
      "generators/surveyor/templates/migrate/create_answers.rb",
      "generators/surveyor/templates/migrate/create_dependencies.rb",
      "generators/surveyor/templates/migrate/create_dependency_conditions.rb",

metadata CHANGED Viewed

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments:
   - 0
-  - 10
+  - 11
   - 0
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Brian Chamberlain
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2010-04-05 00:00:00 -05:00
+date: 2010-04-06 00:00:00 -05:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -135,6 +135,9 @@ files:
 - generators/surveyor/templates/initializers/surveyor.rb
 - generators/surveyor/templates/migrate/add_correct_answer_id_to_questions.rb
 - generators/surveyor/templates/migrate/add_display_order_to_surveys.rb
+- generators/surveyor/templates/migrate/add_index_to_response_sets.rb
+- generators/surveyor/templates/migrate/add_index_to_surveys.rb
+- generators/surveyor/templates/migrate/add_unique_indicies.rb
 - generators/surveyor/templates/migrate/create_answers.rb
 - generators/surveyor/templates/migrate/create_dependencies.rb
 - generators/surveyor/templates/migrate/create_dependency_conditions.rb