surveyor 0.9.5 → 0.9.6

data/VERSION

@@ -1 +1 @@
-0.9.5
+0.9.6

data/app/models/response.rb

@@ -21,7 +21,11 @@ class Response < ActiveRecord::Base
     true
   end
   
-  def to_s
+  def correct?
+    question.correct_answer_id.nil? or self.answer.response_class != "answer" or (question.correct_answer_id.to_i == answer_id.to_i)
+  end
+  
+  def to_s # used in dependency_explanation_helper
     if self.answer.response_class == "answer" and self.answer_id
       return self.answer.text
     else

data/app/models/response_set.rb

@@ -89,8 +89,33 @@ class ResponseSet < ActiveRecord::Base
     self.completed_at = Time.now
   end
   
-  def has_not_answered_question?(question)
-    self.responses.find_all_by_question_id(question.id).empty?
+  def correct?
+    responses.all?(&:correct?)
+  end
+  def correctness_hash
+    { :questions => @survey.sections_with_questions.map(&:questions).flatten.compact.size,
+      :responses => responses.compact.size,
+      :correct => responses.find_all(&:correct?).compact.size
+    }
+  end
+  def mandatory_questions_complete?
+    progress_hash[:triggered_mandatory] == progress_hash[:triggered_mandatory_completed]
+  end
+  def progress_hash
+    qs = @survey.sections_with_questions.map(&:questions).flatten
+    ds = dependencies(qs.map(&:id))
+    triggered = qs - ds.select{|d| !d.is_met?(self)}.map(&:question)
+    { :questions => qs.compact.size,
+      :triggered => triggered.compact.size,
+      :triggered_mandatory => triggered.select{|q| q.mandatory?}.compact.size,
+      :triggered_mandatory_completed => triggered.select{|q| q.mandatory? and is_answered?(q)}.compact.size
+    }
+  end
+  def is_answered?(question)
+    !is_unanswered?(question)
+  end
+  def is_unanswered?(question)
+    self.responses.detect{|r| r.question_id == question.id}.nil?
   end
     
   # Returns the number of response groups (count of group responses enterted) for this question group
@@ -99,7 +124,7 @@ class ResponseSet < ActiveRecord::Base
   end
   
   def unanswered_dependencies
-    dependencies.select{|d| d.is_met?(self) and self.has_not_answered_question?(d.question)}.map(&:question)
+    dependencies.select{|d| d.is_met?(self) and self.is_unanswered?(d.question)}.map(&:question)
   end
   
   def all_dependencies
@@ -109,11 +134,12 @@ class ResponseSet < ActiveRecord::Base
   
   protected
   
-  def dependencies
-    question_ids = Question.find_all_by_survey_section_id(current_section_id).map(&:id)
+  def dependencies(question_ids = nil)
+    question_ids ||= Question.find_all_by_survey_section_id(current_section_id).map(&:id)
     depdendecy_ids = DependencyCondition.all(:conditions => {:question_id => question_ids}).map(&:dependency_id)
     Dependency.find(depdendecy_ids, :include => :dependency_conditions)
   end
+  
 end
 
 # responses

data/generators/surveyor/surveyor_generator.rb

@@ -29,7 +29,7 @@ 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"].each_with_index do |model, i|
+        "add_display_order_to_surveys", "add_correct_answer_id_to_questions"].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_correct_answer_id_to_questions.rb

@@ -0,0 +1,9 @@
+class AddCorrectAnswerIdToQuestions < ActiveRecord::Migration
+  def self.up
+    add_column :questions, :correct_answer_id, :integer
+  end
+
+  def self.down
+    remove_column :questions, :correct_answer_id
+  end
+end

data/spec/factories.rb

@@ -1,42 +1,43 @@
 # http://github.com/thoughtbot/factory_girl/tree/master
 
 Factory.define :survey do |s|
-  s.title	      	{"Simple survey"}
-  s.description		{"A simple survey for testing"}
-  s.access_code		{"simple_survey"}
-  s.active_at	  	{Time.now}
-  s.inactive_at		{}
-  s.css_url		    {}
+  s.title         {"Simple survey"}
+  s.description   {"A simple survey for testing"}
+  s.access_code   {"simple_survey"}
+  s.active_at     {Time.now}
+  s.inactive_at   {}
+  s.css_url       {}
 end
 
 Factory.sequence(:survey_section_display_order){|n| n }
 
 Factory.define :survey_section do |s|
   s.association               :survey # s.survey_id                 {}
-  s.title		                  {"Demographics"}
-  s.description	              {"Asking you about your personal data"}
-  s.display_order	            {Factory.next :survey_section_display_order}
-  s.reference_identifier		  {"demographics"}
-  s.data_export_identifier		{"demographics"}
+  s.title                     {"Demographics"}
+  s.description               {"Asking you about your personal data"}
+  s.display_order             {Factory.next :survey_section_display_order}
+  s.reference_identifier      {"demographics"}
+  s.data_export_identifier    {"demographics"}
 end
 
 Factory.sequence(:question_display_order){|n| n }
 
 Factory.define :question do |q|
   q.association             :survey_section  # s.survey_section_id       {}
-  q.question_group_id		    {}
-  q.text		                {"What is your favorite color?"}
-  q.short_text		          {"favorite_color"}
-  q.help_text	        	    {"just write it in the box"}
-  q.pick	            	    {:none}
+  q.question_group_id       {}
+  q.text                    {"What is your favorite color?"}
+  q.short_text              {"favorite_color"}
+  q.help_text               {"just write it in the box"}
+  q.pick                    {:none}
   q.reference_identifier    {|me| "q_#{me.object_id}"}
   q.data_export_identifier  {}
   q.common_namespace        {}
   q.common_identifier       {}
-  q.display_order	    	    {Factory.next :question_display_order}
-  q.display_type	    	    {} # nil is default
-  q.is_mandatory	    	    {false}
-  q.display_width       		{}
+  q.display_order           {Factory.next :question_display_order}
+  q.display_type            {} # nil is default
+  q.is_mandatory            {false}
+  q.display_width           {}
+  q.correct_answer_id       {nil}
 end
 
 Factory.define :question_group do |g|
@@ -55,19 +56,19 @@ Factory.sequence(:answer_display_order){|n| n }
 
 Factory.define :answer do |a|
   a.association               :question  # a.question_id               {}
-  a.text	                  	{"My favorite color is clear"}
-  a.short_text            		{"clear"}
-  a.help_text	              	{"Clear is the absense of color"}
-  a.weight		                {}
-  a.response_class        		{"String"}
-  a.reference_identifier		  {}
-  a.data_export_identifier		{}
+  a.text                      {"My favorite color is clear"}
+  a.short_text                {"clear"}
+  a.help_text                 {"Clear is the absense of color"}
+  a.weight                    {}
+  a.response_class            {"String"}
+  a.reference_identifier      {}
+  a.data_export_identifier    {}
   a.common_namespace          {}
-  a.common_identifier     		{}
-  a.display_order	        	  {Factory.next :answer_display_order}
-  a.is_exclusive	        	  {}
-  a.hide_label    		        {}
-  a.display_length		        {}
+  a.common_identifier         {}
+  a.display_order             {Factory.next :answer_display_order}
+  a.is_exclusive              {}
+  a.hide_label                {}
+  a.display_length            {}
   a.custom_class              {}
   a.custom_renderer           {}
 end
@@ -76,12 +77,12 @@ Factory.define :dependency do |d|
   # the dependent question
   d.association       :question # d.question_id       {}
   d.question_group_id {}
-  d.rule              {"A and B"}
+  d.rule              {"A"}
 end
 
 Factory.define :dependency_condition do |d|
   d.association       :dependency # d.dependency_id    {}
-  d.rule_key          {"1"}
+  d.rule_key          {"A"}
   # the conditional question
   d.question_id       {}
   d.operator          {"=="}
@@ -96,25 +97,25 @@ Factory.define :dependency_condition do |d|
 end
 
 Factory.define :response_set do |r|
-  r.user_id	        {}
+  r.user_id         {}
   r.association     :survey # r.survey_id       {}
-  r.access_code	    {Surveyor.make_tiny_code}
-  r.started_at	    {Time.now}
-  r.completed_at		{}
+  r.access_code     {Surveyor.make_tiny_code}
+  r.started_at      {Time.now}
+  r.completed_at    {}
 end
 
 Factory.define :response do |r|
   r.association       :response_set # r.response_set_id   {}
-  r.question_id	    	{}
-  r.answer_id	      	{}
-  r.datetime_value		{}
-  r.integer_value	  	{}
-  r.float_value	      {}
-  r.unit      	      {}
-  r.text_value	      {}
-  r.string_value	  	{}
-  r.response_other		{}
-  r.response_group		{}
+  r.question_id       {}
+  r.answer_id         {}
+  r.datetime_value    {}
+  r.integer_value     {}
+  r.float_value       {}
+  r.unit              {}
+  r.text_value        {}
+  r.string_value      {}
+  r.response_other    {}
+  r.response_group    {}
 end
 
 Factory.define :validation do |v|

data/spec/models/response_set_spec.rb

@@ -1,46 +1,24 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
-describe ResponseSet, "class methods" do
-  before(:each) do
-    @response_set = Factory(:response_set, :access_code => "PDQ")
-  end
-  it "should find a response set by response_set.access_code or return false" do
-    ResponseSet.find_by_access_code("PDQ").should == @response_set
-    ResponseSet.find_by_access_code("Different").should be_nil
-  end
-end
-describe ResponseSet, "with responses" do
+describe ResponseSet do
   before(:each) do
     @response_set = Factory(:response_set)
   end
-
-  it "can tell you its responses" do
-    3.times{ |x| @response_set.responses.build }  
-    @response_set.responses.should have(3).items
+  it "should have a unique code with length 10 that identifies the survey" do
+    @response_set.access_code.should_not be_nil
+    @response_set.access_code.length.should == 10
   end
-
   it "is completable" do
     @response_set.completed_at.should be_nil
     @response_set.complete!
     @response_set.completed_at.should_not be_nil
     @response_set.completed_at.is_a?(Time).should be_true
   end
-
   it "does not allow completion through mass assignment" do
     @response_set.completed_at.should be_nil
     @response_set.update_attributes(:completed_at => Time.now)
     @response_set.completed_at.should be_nil
   end
-
-end
-describe ResponseSet, "Creating new set for user" do
-  before(:each) do
-    @response_set = Factory(:response_set)
-  end
-  it "should have a unique code with length 10 that identifies the survey" do
-    @response_set.access_code.should_not be_nil
-    @response_set.access_code.length.should == 10
-  end
 end
 describe ResponseSet, "Updating the response set" do
   before(:each) do
@@ -135,4 +113,99 @@ describe ResponseSet, "with dependencies" do
     @response_set.all_dependencies[:show].should == ["question_#{@what_flavor.id}", "question_#{@what_bakery.id}"]
   end
   
+end
+describe ResponseSet, "as a quiz" do
+  before(:each) do
+    @survey = Factory(:survey)
+    @section = Factory(:survey_section, :survey => @survey)
+    @response_set = Factory(:response_set, :survey => @survey)
+  end
+  def generate_responses(count, quiz = nil, correct = nil)
+    count.times do |i|
+      q = Factory(:question, :survey_section => @section)
+      a = Factory(:answer, :question => q, :response_class => "answer")
+      x = Factory(:answer, :question => q, :response_class => "answer")
+      q.correct_answer_id = (quiz == "quiz" ? a.id : nil)
+      @response_set.responses << Factory(:response, :question => q, :answer => (correct == "correct" ? a : x))
+    end
+  end
+  
+  it "should report correctness if it is a quiz" do
+    generate_responses(3, "quiz", "correct")
+    @response_set.correct?.should be_true
+    @response_set.correctness_hash.should == {:questions => 3, :responses => 3, :correct => 3}
+  end
+  it "should report incorrectness if it is a quiz" do
+    generate_responses(3, "quiz", "incorrect")
+    @response_set.correct?.should be_false
+    @response_set.correctness_hash.should == {:questions => 3, :responses => 3, :correct => 0}
+  end
+  it "should report correct if it isn't a quiz" do
+    generate_responses(3, "non-quiz")
+    @response_set.correct?.should be_true
+    @response_set.correctness_hash.should == {:questions => 3, :responses => 3, :correct => 3}
+  end
+end
+describe ResponseSet, "with mandatory questions" do
+  before(:each) do
+    @survey = Factory(:survey)
+    @section = Factory(:survey_section, :survey => @survey)
+    @response_set = Factory(:response_set, :survey => @survey)
+  end
+  def generate_responses(count, mandatory = nil, responded = nil)
+    count.times do |i|
+      q = Factory(:question, :survey_section => @section, :is_mandatory => (mandatory == "mandatory"))
+      a = Factory(:answer, :question => q, :response_class => "answer")
+      if responded == "responded"
+        @response_set.responses << Factory(:response, :question => q, :answer => a)
+      end
+    end
+  end
+  it "should report progress without mandatory questions" do
+    generate_responses(3)
+    @response_set.mandatory_questions_complete?.should be_true
+    @response_set.progress_hash.should == {:questions => 3, :triggered => 3, :triggered_mandatory => 0, :triggered_mandatory_completed => 0}
+  end
+  it "should report progress with mandatory questions" do
+    generate_responses(3, "mandatory", "responded")
+    @response_set.mandatory_questions_complete?.should be_true
+    @response_set.progress_hash.should == {:questions => 3, :triggered => 3, :triggered_mandatory => 3, :triggered_mandatory_completed => 3}
+  end
+  it "should report progress with mandatory questions" do
+    generate_responses(3, "mandatory", "not-responded")
+    @response_set.mandatory_questions_complete?.should be_false
+    @response_set.progress_hash.should == {:questions => 3, :triggered => 3, :triggered_mandatory => 3, :triggered_mandatory_completed => 0}
+  end
+end
+describe ResponseSet, "with mandatory, dependent questions" do
+  before(:each) do
+    @survey = Factory(:survey)
+    @section = Factory(:survey_section, :survey => @survey)
+    @response_set = Factory(:response_set, :survey => @survey)
+  end
+  def generate_responses(count, mandatory = nil, dependent = nil, triggered = nil)
+    dq = Factory(:question, :survey_section => @section, :is_mandatory => (mandatory == "mandatory"))
+    da = Factory(:answer, :question => dq, :response_class => "answer")
+    dx = Factory(:answer, :question => dq, :response_class => "answer")
+    count.times do |i|
+      q = Factory(:question, :survey_section => @section, :is_mandatory => (mandatory == "mandatory"))
+      a = Factory(:answer, :question => q, :response_class => "answer")
+      if dependent = "dependent"
+        d = Factory(:dependency, :question => q)
+        dc = Factory(:dependency_condition, :dependency => d, :question_id => dq.id, :answer_id => da.id)
+      end
+      @response_set.responses << Factory(:response, :question => dq, :answer => (triggered == "triggered" ? da : dx))
+      @response_set.responses << Factory(:response, :question => q, :answer => a)
+    end
+  end
+  it "should report progress without mandatory questions" do
+    generate_responses(3, "mandatory", "dependent")
+    @response_set.mandatory_questions_complete?.should be_true
+    @response_set.progress_hash.should == {:questions => 4, :triggered => 1, :triggered_mandatory => 1, :triggered_mandatory_completed => 1}
+  end
+  it "should report progress with mandatory questions" do
+    generate_responses(3, "mandatory", "dependent", "triggered")
+    @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

data/spec/models/response_spec.rb

@@ -2,7 +2,8 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe Response, "when saving a response" do
   before(:each) do
-    @response = Response.new(:question_id => 314, :response_set_id => 159, :answer_id => 1)
+    # @response = Response.new(:question_id => 314, :response_set_id => 159, :answer_id => 1)
+    @response = Factory(:response, :question => Factory(:question), :answer => Factory(:answer))
   end
 
   it "should be valid" do
@@ -17,6 +18,22 @@ describe Response, "when saving a response" do
     @response.should have(1).error_on(:question_id)
   end
 
+  it "should be correct if the question has no correct_answer_id" do
+    @response.question.correct_answer_id.should be_nil
+    @response.correct?.should be_true
+  end
+  it "should be correct if the answer's response class != answer" do
+    @response.answer.response_class.should_not == "answer"
+    @response.correct?.should be_true
+  end  
+  it "should be (in)correct if answer_id is (not) equal to question's correct_answer_id" do
+    @answer = Factory(:answer, :response_class => "answer")
+    @question = Factory(:question, :correct_answer_id => @answer.id)
+    @response = Factory(:response, :question => @question, :answer => @answer)
+    @response.correct?.should be_true
+    @response.answer_id = 143
+    @response.correct?.should be_false
+  end
   describe "returns the response as the type requested" do
 
     it "returns 'string'" do

data/surveyor.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{surveyor}
-  s.version = "0.9.5"
+  s.version = "0.9.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Chamberlain", "Mark Yoon"]
-  s.date = %q{2009-11-12}
+  s.date = %q{2009-11-13}
   s.email = %q{yoon@northwestern.edu}
   s.extra_rdoc_files = [
     "README.md"
@@ -109,6 +109,7 @@ Gem::Specification.new do |s|
      "generators/surveyor/templates/assets/stylesheets/ui.theme.css",
      "generators/surveyor/templates/initializers/haml.rb",
      "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/create_answers.rb",
      "generators/surveyor/templates/migrate/create_dependencies.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: surveyor
 version: !ruby/object:Gem::Version 
-  version: 0.9.5
+  version: 0.9.6
 platform: ruby
 authors: 
 - Brian Chamberlain
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-12 00:00:00 -06:00
+date: 2009-11-13 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -126,6 +126,7 @@ files:
 - generators/surveyor/templates/assets/stylesheets/ui.theme.css
 - generators/surveyor/templates/initializers/haml.rb
 - 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/create_answers.rb
 - generators/surveyor/templates/migrate/create_dependencies.rb