surveyor 0.8.0 → 0.9.0

data/README.md

@@ -7,12 +7,12 @@ Surveyor is a rails (gem) plugin, that brings surveys to your rails app. Before
 As a plugin:
 
     sudo gem install haml
-    script/plugin install git://github.com/breakpointer/surveyor.git -r 'tag v0.7.0'
+    script/plugin install git://github.com/breakpointer/surveyor.git -r 'tag v0.9.0'
 
 Or as a gem plugin:
   
   # in environment.rb
-  config.gem "surveyor", :version => '>=0.7.0', :source => 'http://gemcutter.org'
+  config.gem "surveyor", :version => '>=0.9.0', :source => 'http://gemcutter.org'
   
     sudo gem install gemcutter
     gem tumble
@@ -105,11 +105,28 @@ Surveyor depends on Rails 2.3 and the SASS style sheet language, part of HAML (h
 
 # Changes
 
+0.9.0
+
+* validations in dsl and surveyor models
+* preserve underscores in reference identifiers
+* dsl specs, refactoring into base class
+* adding display order to surveys
+* moving columnizer and tiny column functionality to surveyor module
+* columnizer (and tiny code) refactoring, columnizer spec extracted from answer spec
+* cleanup of scopes with joins
+* refactoring dependency
+
+0.8.0
+
+* question group dependencies
+* expanded examples in kitchen sink survey
+* specs
+
 0.7.1
 
-custom index page
-custom classes and renderers
-fixing typo in kitchen sink survey
+* custom index page
+* custom classes and renderers
+* fixing typo in kitchen sink survey
 
 0.7.0
 

data/VERSION

@@ -1 +1 @@
-0.8.0
+0.9.0

data/app/models/dependency.rb

@@ -4,9 +4,6 @@ class Dependency < ActiveRecord::Base
   belongs_to :question_group
   has_many :dependency_conditions
   
-  # Scopes
-  named_scope :depending_on_questions, lambda {|question_ids| {:joins => :dependency_conditions, :conditions => {:dependency_conditions => {:question_id => question_ids}} }}
-  
   # Validations
   validates_presence_of :rule
   validates_format_of :rule, :with => /^(?:and|or|\)|\(|[A-Z]|\s)+$/ #TODO properly formed parenthesis etc.
@@ -26,37 +23,24 @@ class Dependency < ActiveRecord::Base
     write_attribute(:question_id, i) 
   end
   
-  # Is the method that determines if this dependency has been met within
-  # the provided response set
-  def met?(response_set)
-    if keyed_pairs = keyed_conditions(response_set)
-      return(rule_evaluation(keyed_pairs))
-    else
-      return(false)
-    end
-  end
-
-  # Pairs up the substitution key with the evaluated condition result for substitution into the rule
-  # Example: If you have two dependency conditions with rule keys "A" and "B" in the rule "A or B"
-  # calling keyed_condition_pairs will return {:A => true, :B => false}
-  def keyed_conditions(response_set)
-    keyed_pairs = {}
-    # logger.debug dependency_conditions.inspect
-    self.dependency_conditions.each do |dc|
-      keyed_pairs.merge!(dc.to_hash(response_set))
-    end
-    return(keyed_pairs)
-  end
-
-  # Does the substiution and evaluation of the dependency rule with the keyed pairs
-  def rule_evaluation(keyed_pairs)
-    # subtitute into rule for evaluation
-    rgx = Regexp.new(self.dependency_conditions.map{|dc| ["a","o"].include?(dc.rule_key) ? "#{dc.rule_key}(?!nd|r)" : dc.rule_key}.join("|")) # Making a regexp to only look for the keys used in the child conditions
+  # Has this dependency has been met in the context of response_set?
+  # Substitutes the conditions hash into the rule and evaluates it
+  def is_met?(response_set)
+    ch = conditions_hash(response_set)
+    return false if ch.blank?
     # logger.debug "rule: #{self.rule.inspect}"
     # logger.debug "rexp: #{rgx.inspect}"
-    # logger.debug "keyp: #{keyed_pairs.inspect}"
-    # logger.debug "subd: #{self.rule.gsub(rgx){|m| keyed_pairs[m.to_sym]}}"
-    eval(self.rule.gsub(rgx){|m| keyed_pairs[m.to_sym]}) # returns the evaluation of the rule and the conditions
+    # logger.debug "keyp: #{ch.inspect}"
+    # logger.debug "subd: #{self.rule.gsub(rgx){|m| ch[m.to_sym]}}"
+    rgx = Regexp.new(self.dependency_conditions.map{|dc| ["a","o"].include?(dc.rule_key) ? "#{dc.rule_key}(?!nd|r)" : dc.rule_key}.join("|")) # exclude and, or
+    eval(self.rule.gsub(rgx){|m| ch[m.to_sym]})
+  end
+  
+  # A hash of the conditions (keyed by rule_key) and their evaluation (boolean) in the context of response_set
+  def conditions_hash(response_set)
+    hash = {}
+    self.dependency_conditions.each{|dc| hash.merge!(dc.to_hash(response_set))}
+    return hash
   end
   
 end

data/app/models/question.rb

@@ -33,7 +33,7 @@ class Question < ActiveRecord::Base
     self.dependency != nil
   end
   def triggered?(response_set)
-    dependent? ? self.dependency.met?(response_set) : true
+    dependent? ? self.dependency.is_met?(response_set) : true
   end
   def css_class(response_set)
     [(dependent? ? "dependent" : nil), (triggered?(response_set) ? nil : "hidden"), custom_class].compact.join(" ")

data/app/models/question_group.rb

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

data/app/models/response.rb

@@ -8,10 +8,7 @@ class Response < ActiveRecord::Base
   
   # Validations
   validates_presence_of :response_set_id, :question_id, :answer_id
-  
-  # 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

data/app/models/response_set.rb

@@ -100,11 +100,11 @@ class ResponseSet < ActiveRecord::Base
   end
   
   def unanswered_dependencies
-    dependencies.select{|d| d.met?(self) and self.has_not_answered_question?(d.question)}.map(&:question)
+    dependencies.select{|d| d.is_met?(self) and self.has_not_answered_question?(d.question)}.map(&:question)
   end
   
   def all_dependencies
-    arr = dependencies.partition{|d| d.met?(self) }
+    arr = dependencies.partition{|d| d.is_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}"}}
   end
   
@@ -112,7 +112,8 @@ class ResponseSet < ActiveRecord::Base
   
   def dependencies
     question_ids = Question.find_all_by_survey_section_id(current_section_id).map(&:id)
-    Dependency.depending_on_questions(question_ids)
+    depdendecy_ids = DependencyCondition.all(:conditions => {:question_id => question_ids}).map(&:dependency_id)
+    Dependency.find(depdendecy_ids, :include => :dependency_conditions)
   end
 end
 

data/app/models/survey.rb

@@ -1,5 +1,4 @@
 class Survey < ActiveRecord::Base
-  include TinyCode
   
   # Associations
   has_many :sections, :class_name => "SurveySection", :order => 'display_order'

data/app/models/validation.rb

@@ -1,6 +1,7 @@
 class Validation < ActiveRecord::Base
   # Associations
   belongs_to :answer
+  has_many :validation_conditions
   
   # Scopes
   
@@ -10,4 +11,23 @@ class Validation < ActiveRecord::Base
   validates_numericality_of :answer_id
   
   # Instance Methods
+  def is_valid?(response_set)
+    ch = conditions_hash(response_set)
+    rgx = Regexp.new(self.validation_conditions.map{|vc| ["a","o"].include?(vc.rule_key) ? "#{vc.rule_key}(?!nd|r)" : vc.rule_key}.join("|")) # exclude and, or
+    # logger.debug "v: #{self.inspect}"
+    # logger.debug "rule: #{self.rule.inspect}"
+    # logger.debug "rexp: #{rgx.inspect}"
+    # logger.debug "keyp: #{ch.inspect}"
+    # logger.debug "subd: #{self.rule.gsub(rgx){|m| ch[m.to_sym]}}"
+    eval(self.rule.gsub(rgx){|m| ch[m.to_sym]})
+  end
+  
+  # A hash of the conditions (keyed by rule_key) and their evaluation (boolean) in the context of response_set
+  def conditions_hash(response_set)
+    hash = {}
+    response = response_set.responses.detect{|r| r.answer_id.to_i == self.answer_id.to_i}
+    # logger.debug "r: #{response.inspect}"
+    self.validation_conditions.each{|vc| hash.merge!(vc.to_hash(response))}
+    return hash
+  end
 end

data/app/models/validation_condition.rb

@@ -13,27 +13,29 @@ class ValidationCondition < ActiveRecord::Base
   validates_inclusion_of :operator, :in => OPERATORS
   validates_uniqueness_of :rule_key, :scope => :validation_id
   
+  acts_as_response # includes "as" instance method
+  
   # 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
+  def to_hash(response)
+    {rule_key.to_sym => (response.nil? ? false : 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 =~ Regexp.new(self.regexp || "")).nil?
+    else
+      false
+    end
+  end
 end

data/generators/surveyor/surveyor_generator.rb

@@ -25,12 +25,16 @@ 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", "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]
+      [ "create_surveys", "create_survey_sections", "create_questions", "create_question_groups", "create_answers", 
+        "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|
+        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
-        # raise "Another migration is already named create_#{model}" if not Dir.glob("db/migrate/[0-9]*_*.rb").grep(/[0-9]+_create_#{model}.rb$/).empty?
-        m.template("migrate/create_#{model}.rb", "db/migrate/#{(prev_migration_timestamp || Time.now.utc.strftime("%Y%m%d%H%M%S").to_i + i).to_s}_create_#{model}.rb")
+        # raise "Another migration is already named #{model}" if not Dir.glob("db/migrate/[0-9]*_*.rb").grep(/[0-9]+_#{model}.rb$/).empty?
+        m.template("migrate/#{model}.rb", "db/migrate/#{(prev_migration_timestamp || Time.now.utc.strftime("%Y%m%d%H%M%S").to_i + i).to_s}_#{model}.rb")
       end
       
       # Generate CSS

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

@@ -0,0 +1,9 @@
+class AddDisplayOrderToSurveys < ActiveRecord::Migration
+  def self.up
+    add_column :surveys, :display_order, :integer
+  end
+
+  def self.down
+    remove_column :surveys, :display_order
+  end
+end

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

@@ -23,7 +23,7 @@ survey "“Kitchen Sink” survey" do
 
     # A dependent question, with conditions and rule to logically join them  
     # the question's reference identifier is "2a", and the answer's reference_identifier is "1"
-    # question reference identifiers used in conditions need to be unique for the lookups to work
+    # question reference identifiers used in conditions need to be unique on a survey for the lookups to work
     q_2a "Please explain why you don't like this color?"
     a_1 "explanation", :text
     dependency :rule => "A or B or C or D"
@@ -62,22 +62,33 @@ survey "“Kitchen Sink” survey" do
     a "what", :string
     a "where", :string
     
-    # Various types of respones can be accepted
+    # Various types of responses can be accepted, and validated
     q "How many pets do you own?"
     a :integer
+    validation :rule => "A"
+    condition_A ">=", :integer_value => 0
     
     # 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'
+    # validations can use regexp values
+    validation :rule => "A"
+    condition_A "=~", :regexp => /[0-9a-zA-z\. #]/
     
     # 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?"
-    a :time
+    q_time_lunch "What time do you usually take a lunch break?"
+    a_1 :time
     
+    # # validation conditions can look up the response to another question/answer pair
+    # q_time_dinner "What time do you usually take a dinner break?"
+    # a :time
+    # validation :rule => "A"
+    # condition_A ">=", :question_reference => "time_lunch", :answer_reference => "1"
+        
     q "When would you like to meet for dinner?"
     a :date
     

data/lib/surveyor.rb

@@ -5,4 +5,20 @@ require 'surveyor/config'
 require 'surveyor/acts_as_response'
 
 module Surveyor
+  RAND_CHARS = [('a'..'z'), ('A'..'Z'), (0..9)].map(&:to_a).flatten.to_s
+
+  def self.make_tiny_code(len = 10)
+    len.times.map{|i| RAND_CHARS[rand(RAND_CHARS.size), 1] }.to_s
+  end
+
+  def self.to_normalized_string(text)
+    words_to_omit = %w(a be but has have in is it of on or the to when)
+    col_text = text.gsub(/(<[^>]*>)|\n|\t/s, ' ') # Remove html tags
+    col_text.downcase!                            # Remove capitalization
+    col_text.gsub!(/\"|\'/, '')                   # Remove potential problem characters
+    col_text.gsub!(/\(.*?\)/,'')                  # Remove text inside parens
+    col_text.gsub!(/\W/, ' ')                     # Remove all other non-word characters      
+    cols = (col_text.split(' ') - words_to_omit)
+    (cols.size > 5 ? cols[-5..-1] : cols).join("_")
+  end
 end

data/script/surveyor/answer.rb

@@ -1,75 +1,52 @@
-require File.dirname(__FILE__) + '/columnizer'
-
-class Answer  
-  include Columnizer
-
+class Answer < SurveyParser::Base
   # Context, Content, Reference, Display
   attr_accessor :id, :parser, :question_id
   attr_accessor :text, :short_text, :help_text, :weight, :response_class
   attr_accessor :reference_identifier, :data_export_identifier, :common_namespace, :common_identitier
   attr_accessor :display_order, :is_exclusive, :hide_label, :display_length, :custom_class, :custom_renderer
-  
-  def initialize(question, args, options)
-    self.parser = question ? question.parser : nil
-    self.id = parser ? parser.new_answer_id : nil
-    self.question_id = question ? question.id : nil
+  attr_accessor :validation
 
-    #self.text is set in args
-    args_options = parse_args_options(args)
-    self.default_options(args_options[:text]).merge(options).merge(args_options).each{|key,value| self.instance_variable_set("@#{key}", value)}
-  end
-  
-  def default_options(text)
-    { :short_text => text,
-      :data_export_identifier => Columnizer.to_normalized_column(text),
-      :is_exclusive => false,
+  def default_options
+    { :is_exclusive => false,
       :hide_label => false,
       :response_class => "answer"
     }
   end
   
-  def parse_args_options(args)
-    a0, a1, a2 = args
-    
-    # Hash
-    if a0.is_a?(Hash)
-      {:text => "Answer"}.merge(a0)
-      
-    # (String, Hash) or (String, Symbol, Hash)
-    elsif a0.is_a?(String)
-      a1.is_a?(Symbol) ? {:text => a0, :response_class => a1.to_s}.merge(a2 || {}) : {:text => a0}.merge(a1 || {})
-      
-    # (Symbol, Hash) or (Symbol, Symbol, Hash)
-    elsif a0.is_a?(Symbol)
-      shortcuts = case a0
-      when :other
-        {:text => "Other"}
-      when :other_and_string
-        {:text => "Other", :response_class => "string"}
-      when :none, :omit #a disabler erases and disables all other answer options (text, checkbox, dropdowns, etc). Unchecking the omit box is the only way to enable other options (except in the case limit => :one)
-        {:text => a0.to_s.humanize, :is_exclusive => true} # "omit" is no longer a response class... it's treated as any other answer type 
-      when :integer, :date, :time, :datetime, :text, :datetime, :string
-        {:text => a0.to_s.humanize, :response_class => a0.to_s, :hide_label => true}
-      else
-        {:text => a0.to_s.humanize}
-      end
-      a1.is_a?(Symbol) ? shortcuts.merge({:response_class => a1.to_s}).merge(a2 || {}) : shortcuts.merge(a1 || {})
+  def parse_args(args)
+    case args[0]
+    when Hash # Hash
+      text_args(args[0][:text]).merge(args[0])
+    when String # (String, Hash) or (String, Symbol, Hash)
+      text_args(args[0]).merge(hash_from args[1]).merge(args[2] || {})
+    when Symbol # (Symbol, Hash) or (Symbol, Symbol, Hash)
+      symbol_args(args[0]).merge(hash_from args[1]).merge(args[2] || {})
     else
-      {:text => "Answer"}
+      text_args(nil)
     end
   end
-
-  def yml_attrs
-    instance_variables.sort - ["@parser"]
+  
+  def text_args(text = "Answer")
+    {:text => text.to_s, :short_text => text, :data_export_identifier => Surveyor.to_normalized_string(text)}
   end
-  def to_yml
-    out = [ %(#{@data_export_identifier}_#{@id}:) ]
-    yml_attrs.each{|a| out << "  #{a[1..-1]}: #{instance_variable_get(a).is_a?(String) ? "\"#{instance_variable_get(a)}\"" : instance_variable_get(a) }"}
-    (out << nil ).join("\r\n")
+  def hash_from(arg)
+    arg.is_a?(Symbol) ? {:response_class => arg.to_s} : arg.is_a?(Hash) ? arg : {}
+  end
+  def symbol_args(arg)
+    case arg
+    when :other
+      text_args("Other")
+    when :other_and_string
+      text_args("Other").merge({:response_class => "string"})
+    when :none, :omit # is_exclusive erases and disables other checkboxes and input elements
+      text_args(arg.to_s.humanize).merge({:is_exclusive => true})
+    when :integer, :date, :time, :datetime, :text, :datetime, :string
+      text_args(arg.to_s.humanize).merge({:response_class => arg.to_s, :hide_label => true})
+    end
   end
-
   def to_file
-     File.open(self.parser.answers_yml, File::CREAT|File::APPEND|File::WRONLY){ |f| f << to_yml }
+    super
+    if self.validation then self.validation.to_file end
   end
   
 end