surveyor 0.7.1 → 0.8.0

data/VERSION

@@ -1 +1 @@
-0.7.1
+0.8.0

data/app/controllers/surveyor_controller.rb

@@ -42,19 +42,18 @@ class SurveyorController < ApplicationController
       @sections = @survey.sections
       @section = params[:section] ? @sections.with_includes.find(section_id_from(params[:section])) || @sections.with_includes.first : @sections.with_includes.first
       @questions = @section.questions
+      @dependents = (@response_set.unanswered_dependencies - @section.questions) || []
     else
       flash[:notice] = "Unable to find your responses to the survey"
       redirect_to(available_surveys_path)
     end
-    
-    @dependents = (@response_set.unanswered_dependencies - @section.questions) || []
   end
   def update
     if @response_set = ResponseSet.find_by_access_code(params[:response_set_code], :include => {:responses => :answer})
       @response_set.current_section_id = params[:current_section_id]
     else
       flash[:notice] = "Unable to find your responses to the survey"
-      redirect_to(available_surveys_path)
+      redirect_to(available_surveys_path) and return
     end
     
     if params[:responses] or params[:response_groups]
@@ -71,7 +70,7 @@ class SurveyorController < ApplicationController
           flash[:notice] = "Completed survey"
           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)
+          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])}
         end
       end

data/app/models/answer.rb

@@ -10,11 +10,10 @@ class Answer < ActiveRecord::Base
   # Validations
   validates_presence_of :text
   validates_numericality_of :question_id, :allow_nil => false, :only_integer => true
-  #validates_uniqueness_of :reference_identifier
   
   # Methods
   def renderer(q = question)  
-    r = [q.pick.to_s, self.response_class].compact.join("_")
+    r = [q.pick.to_s, self.response_class].compact.map(&:downcase).join("_")
     r.blank? ? :default : r.to_sym
   end
   

data/app/models/dependency.rb

@@ -10,19 +10,20 @@ class Dependency < ActiveRecord::Base
   # Validations
   validates_presence_of :rule
   validates_format_of :rule, :with => /^(?:and|or|\)|\(|[A-Z]|\s)+$/ #TODO properly formed parenthesis etc.
-  # validates_numericality_of :question_id
-
+  validates_numericality_of :question_id, :if => Proc.new { |d| d.question_group_id.nil? }
+  validates_numericality_of :question_group_id, :if => Proc.new { |d| d.question_id.nil? }
+  
   # Attribute aliases
   alias_attribute :dependent_question_id, :question_id
   
   def question_group_id=(i)
-    write_attribute(:question_id, nil)
+    write_attribute(:question_id, nil) unless i.nil?
     write_attribute(:question_group_id, i)
   end
   
   def question_id=(i)
-    write_attribute(:question_group_id, nil)
-    write_attribute(:question_id, i)
+    write_attribute(:question_group_id, nil) unless i.nil?
+    write_attribute(:question_id, i) 
   end
   
   # Is the method that determines if this dependency has been met within
@@ -42,7 +43,7 @@ class Dependency < ActiveRecord::Base
     keyed_pairs = {}
     # logger.debug dependency_conditions.inspect
     self.dependency_conditions.each do |dc|
-      keyed_pairs.merge!(dc.to_evaluation_hash(response_set))
+      keyed_pairs.merge!(dc.to_hash(response_set))
     end
     return(keyed_pairs)
   end

data/app/models/dependency_condition.rb

@@ -13,67 +13,30 @@ class DependencyCondition < ActiveRecord::Base
   validates_inclusion_of :operator, :in => OPERATORS
   validates_uniqueness_of :rule_key, :scope => :dependency_id
 
+  acts_as_response # includes "as" instance method
+  
   # Class methods
   def self.operators
     OPERATORS
   end
 
   # Instance methods
-  
-  # The hash used in the dependency parent object to evaluate its rule string
-  def to_evaluation_hash(response_set)
-    x = {rule_key.to_sym => self.evaluation_of(response_set)}
-    # logger.warn "to_evaluation_hash #{x.inspect}"
-    return x
-  end
-
-  # # Evaluates the condition on the response_set
-  # def evaluation_of(response_set)
-  #   response = response_set.responses.detect{|r| r.answer_id == answer_id} || false # turns out eval("nil and false") => nil so we need to return false if no response is found
-  #   return(response and self.is_satisfied_by?(response))
-  # end
-  # Evaluates the condition on the response_set
-  def evaluation_of(response_set)
-    # response = response_set.find_response(self.answer_id) || false # turns out eval("nil and false") => nil so we need to return false if no response is found
-    response = response_set.responses.detect{|r| r.answer_id.to_i == self.answer_id.to_i} || false # turns out eval("nil and false") => nil so we need to return false if no response is found
-    # logger.warn "evaluation_of_response #{response.inspect}"
-    return(response and self.is_satisfied_by?(response))
+  def to_hash(response_set)
+    response = response_set.responses.detect{|r| r.answer_id.to_i == self.answer_id.to_i} || false # eval("nil and false") => nil so return false if no response is found
+    {rule_key.to_sym => (response and self.is_met?(response))}
   end
 
-  # Checks to see if the response passed in satisfies the dependency condition
-  def is_satisfied_by?(response)
-    response_class = response.answer.response_class
-    # response.as(response_class).send(operator.to_sym, self.as(response_class))
+  # Checks to see if the response passed in meets the dependency condition
+  def is_met?(response)
+    klass = response.answer.response_class
     return case self.operator
-    when "=="
-      response.as(response_class) == self.as(response_class)
+    when "==", "<", ">", "<=", ">="
+      response.as(klass).send(self.operator, self.as(klass))
     when "!="
-      response.as(response_class) != self.as(response_class)
-    when "<"
-      response.as(response_class) < self.as(response_class)
-    when ">"
-      response.as(response_class) > self.as(response_class)
-    when "<="
-      response.as(response_class) <= self.as(response_class)
-    when ">="
-      response.as(response_class) >= self.as(response_class)
+      !(response.as(klass) == self.as(klass))
     else
       false
     end
   end
 
-  # Method that returns the dependency as a particular response_class type
-  def as(type_symbol)
-    return case type_symbol.to_sym
-    when :string, :text, :integer, :float, :datetime
-      self.send("#{type_symbol}_value".to_sym)
-    when :date
-      self.datetime_value.nil? ? nil : self.datetime_value.to_date
-    when :time
-      self.datetime_value.nil? ? nil : self.datetime_value.to_time
-    else # :answer_id
-      self.answer_id
-    end
-  end
-
 end

data/app/models/response.rb

@@ -12,6 +12,8 @@ class Response < ActiveRecord::Base
   # Named scopes
   named_scope :in_section, lambda {|section_id| {:include => :question, :conditions => ['questions.survey_section_id =?', section_id.to_i ]}}
 
+  acts_as_response # includes "as" instance method
+
   def selected
     !self.new_record?
   end
@@ -21,20 +23,6 @@ class Response < ActiveRecord::Base
   def selected=(value)
     true
   end
-
-  #Method that returns the response as a particular response_class type
-  def as(type_symbol)
-    return case type_symbol.to_sym
-    when :string, :text, :integer, :float, :datetime
-      self.send("#{type_symbol}_value".to_sym)
-    when :date
-      self.datetime_value.nil? ? nil : self.datetime_value.to_date
-    when :time
-      self.datetime_value.nil? ? nil : self.datetime_value.to_time
-    else # :answer_id
-      self.answer_id
-    end
-  end
   
   def to_s
     if self.answer.response_class == "answer" and self.answer_id

data/app/models/response_set.rb

@@ -105,7 +105,7 @@ class ResponseSet < ActiveRecord::Base
   
   def all_dependencies
     arr = dependencies.partition{|d| d.met?(self) }
-    {:show => arr[0].map{|d| d.question_group_id.nil? ? "question_#{d.question_id}" : "question_group#{d.question_group_id}"}, :hide => arr[1].map{|d| d.question_group_id.nil? ? "question_#{d.question_id}" : "question_group#{d.question_group_id}"}}
+    {:show => arr[0].map{|d| d.question_group_id.nil? ? "question_#{d.question_id}" : "question_group_#{d.question_group_id}"}, :hide => arr[1].map{|d| d.question_group_id.nil? ? "question_#{d.question_id}" : "question_group_#{d.question_group_id}"}}
   end
   
   protected

data/app/models/validation.rb

@@ -0,0 +1,13 @@
+class Validation < ActiveRecord::Base
+  # Associations
+  belongs_to :answer
+  
+  # Scopes
+  
+  # Validations
+  validates_presence_of :rule
+  validates_format_of :rule, :with => /^(?:and|or|\)|\(|[A-Z]|\s)+$/
+  validates_numericality_of :answer_id
+  
+  # Instance Methods
+end

data/app/models/validation_condition.rb

@@ -0,0 +1,39 @@
+class ValidationCondition < ActiveRecord::Base
+  # Constants
+  OPERATORS = %w(== != < > <= >= =~)
+
+  # Associations
+  belongs_to :validation
+  
+  # Scopes
+  
+  # Validations
+  validates_numericality_of :validation_id #, :question_id, :answer_id
+  validates_presence_of :operator, :rule_key
+  validates_inclusion_of :operator, :in => OPERATORS
+  validates_uniqueness_of :rule_key, :scope => :validation_id
+  
+  # Class methods
+  def self.operators
+    OPERATORS
+  end
+  
+  # Instance Methods
+  # def to_hash(answer, response)
+  #   {rule_key.to_sym => self.is_valid?(response)}
+  # end
+  # 
+  # def is_valid?(response)
+  #   klass = response.answer.response_class
+  #   case self.operator
+  #   when "==", "<", ">", "<=", ">="
+  #     response.as(klass).send(self.operator, self.as(klass))
+  #   when "!="
+  #     !(response.as(klass) == self.as(klass))
+  #   when "=~"
+  #     response.as(klass).to_s =~ self.regexp
+  #   else
+  #     false
+  #   end
+  # end
+end

data/config/routes.rb

@@ -2,9 +2,9 @@ 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.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 
-  end 
+  end   
 end

data/generators/surveyor/surveyor_generator.rb

@@ -25,7 +25,7 @@ class SurveyorGenerator < Rails::Generator::Base
       # 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|
+      ["surveys", "survey_sections", "questions", "question_groups", "answers", "response_sets", "responses", "dependencies", "dependency_conditions", "validations", "validation_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

data/generators/surveyor/templates/migrate/create_validation_conditions.rb

@@ -0,0 +1,32 @@
+class CreateValidationConditions < ActiveRecord::Migration
+  def self.up
+    create_table :validation_conditions do |t|
+      # Context
+      t.integer :validation_id
+      t.string :rule_key
+      
+      # Conditional    
+      t.string :operator
+      
+      # Optional external reference
+      t.integer :question_id
+      t.integer :answer_id
+
+      # Value
+      t.datetime :datetime_value
+      t.integer :integer_value
+      t.float :float_value
+      t.string :unit
+      t.text :text_value
+      t.string :string_value
+      t.string :response_other
+      t.string :regexp
+      
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :validation_conditions
+  end
+end

data/generators/surveyor/templates/migrate/create_validations.rb

@@ -0,0 +1,20 @@
+class CreateValidations < ActiveRecord::Migration
+  def self.up
+    create_table :validations do |t|
+      # Context
+      t.integer :answer_id # the answer to validate
+      
+      # Conditional
+      t.string :rule
+
+      # Message
+      t.string :message
+      
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :validations
+  end
+end

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

@@ -33,9 +33,25 @@ survey "“Kitchen Sink” survey" do
     condition_D :q_2, "==", :a_4
 
     # When :pick isn't specified, the default is :none (no checkbox or radio button)
-    q "What is your name?"
-    a :string
-
+    q_montypython3 "What... is your name? (e.g. It is 'Arthur', King of the Britons)"
+    a_1 :string
+    
+    # Dependency conditions can refer to any value, not just answer_id. An answer_reference still needs to be specified, to know which answer you would like to check
+    q_montypython4 "What... is your quest? (e.g. To seek the Holy Grail)"
+    a_1 :string
+    dependency :rule => "A"
+    condition_A :q_montypython3, "==", {:string_value => "It is 'Arthur', King of the Britons", :answer_reference => "1"}
+    
+    # http://www.imdb.com/title/tt0071853/quotes
+    q_montypython5 "What... is the air-speed velocity of an unladen swallow? (e.g. What do you mean? An African or European swallow?)"
+    a_1 :string
+    dependency :rule => "A"
+    condition_A :q_montypython4, "==", {:string_value => "To seek the Holy Grail", :answer_reference => "1"}
+    
+    label "Huh? I-- I don't know that! Auuuuuuuugh!"
+    dependency :rule => "A"
+    condition_A :q_montypython5, "==", {:string_value => "What do you mean? An African or European swallow?", :answer_reference => "1"}
+    
     # Surveys, sections, questions, groups, and answers all take the following reference arguments
     # :reference_identifier   # usually from paper
     # :data_export_identifier # data export

data/lib/surveyor/acts_as_response.rb

@@ -0,0 +1,33 @@
+require 'active_record'
+
+module Surveyor
+  module Response
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def acts_as_response
+        include Surveyor::Response::InstanceMethods
+      end    
+    end
+    
+    module InstanceMethods
+      # Returns the response as a particular response_class type
+      def as(type_symbol)
+        return case type_symbol.to_sym
+        when :string, :text, :integer, :float, :datetime
+          self.send("#{type_symbol}_value".to_sym)
+        when :date
+          self.datetime_value.nil? ? nil : self.datetime_value.to_date
+        when :time
+          self.datetime_value.nil? ? nil : self.datetime_value.to_time
+        else # :answer_id
+          self.answer_id
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, Surveyor::Response)

data/lib/surveyor.rb

@@ -2,6 +2,7 @@ dir = File.dirname(__FILE__)
 $LOAD_PATH.unshift dir unless $LOAD_PATH.include?(dir)
 
 require 'surveyor/config'
+require 'surveyor/acts_as_response'
 
 module Surveyor
 end

data/script/surveyor/question_group.rb

@@ -30,6 +30,7 @@ class QuestionGroup
 
   def to_file
     File.open(self.parser.question_groups_yml, File::CREAT|File::APPEND|File::WRONLY){ |f| f << to_yml }
+    if self.dependency then self.dependency.to_file end
   end
 
 end

data/script/surveyor/survey.rb

@@ -83,6 +83,9 @@ class Survey
       section.questions.each do |question| 
         question.dependency.dependency_conditions.each { |con| con.reconcile_dependencies} unless question.dependency.nil?
       end
+      section.question_groups.each do |group|
+        group.dependency.dependency_conditions.each { |con| con.reconcile_dependencies} unless group.dependency.nil?
+      end
     end  
   end