jakewendt-surveyor 0.11.3

data/app/models/survey.rb

@@ -0,0 +1,172 @@
+class Survey < ActiveRecord::Base
+
+  # Extending surveyor
+  include "#{self.name}Extensions".constantize if Surveyor::Config['extend'].include?(self.name.underscore)
+
+  # Associations
+  has_many :sections, :class_name => "SurveySection", :order => 'display_order'
+  has_many :sections_with_questions, :include => :questions, :class_name => "SurveySection", :order => 'display_order'
+  has_many :response_sets
+  has_many :questions, :through => :sections
+  
+  # Scopes
+  named_scope :with_sections, {:include => :sections}
+  
+  # Validations
+  validates_presence_of :title
+  validates_uniqueness_of :access_code
+  
+  # Class methods
+  def self.to_normalized_string(value)
+    # replace non-alphanumeric with "-". remove repeat "-"s. don't start or end with "-"
+    value.to_s.downcase.gsub(/[^a-z0-9]/,"-").gsub(/-+/,"-").gsub(/-$|^-/,"")
+  end
+  
+  # Instance methods
+  def initialize(*args)
+    super(*args)
+    default_args
+  end
+  
+  def default_args
+    self.inactive_at ||= DateTime.now
+  end
+  
+  def title=(value)
+    self.access_code = Survey.to_normalized_string(value)
+    super
+  end
+  
+  def active?
+    self.active_as_of?(DateTime.now)
+  end
+  def active_as_of?(datetime)
+    (self.active_at.nil? or self.active_at < datetime) and (self.inactive_at.nil? or self.inactive_at > datetime)
+  end  
+  def activate!
+    self.active_at = DateTime.now
+  end
+  def deactivate!
+    self.inactive_at = DateTime.now
+  end
+  def active_at=(datetime)
+    self.inactive_at = nil if !datetime.nil? and !self.inactive_at.nil? and self.inactive_at < datetime
+    super(datetime)
+  end
+  def inactive_at=(datetime)
+    self.active_at = nil if !datetime.nil? and !self.active_at.nil? and self.active_at > datetime
+    super(datetime)
+  end
+
+
+
+		#	Survey access_code not guaranteed to be unique
+		#
+		#	As there is no model validation or unique index in the 
+		#	database, there is no guarantee that your survey access_code 
+		#	will be unique.  It is just a normalized version of your 
+		#	survey title.  
+		#
+		#	Running ...
+		#
+		#		rake surveyor FILE=surveys/kitchen_sink_survey.rb APPEND=true
+		#		rake surveyor FILE=surveys/kitchen_sink_survey.rb APPEND=true
+		#		script/console
+		#		Survey.all.collect(&:access_code)
+		#
+		#	should show this to be true.
+		#
+		#	This will show both surveys as able to be taken, but will 
+		#	only allow the first one when the attempt is made as the 
+		#	survey is found by
+		#
+		#
+		#		@survey = Survey.find_by_access_code(params[:survey_code])
+		#
+		#
+		#	In addition, adding a unique index to the db and model will 
+		#	make a mess when running 
+		#
+		#		rake surveyor FILE=surveys/kitchen_sink_survey.rb APPEND=true
+		#		rake surveyor FILE=surveys/kitchen_sink_survey.rb APPEND=true
+		#
+		#	as the access_code is not unique and the survey fixtures are 
+		#	loaded last, leaving the associations with an invalid survey_id.  
+		#	To avoid this, the survey fixture should probably be attempted first.
+		#
+		#
+		#	Update...
+		#
+		#	Adding something like ...
+		#
+		#		def access_code=(value)
+		#			counter = 2
+		#			original_value = value
+		#			while( ( survey = Survey.find_by_access_code(value) ) && 
+		#				( self.id != survey.id ) )
+		#				value = [original_value,"_",counter].join
+		#				counter += 1
+		#			end
+		#			super
+		#		end
+		#
+		#	... to Survey seems to provide a "fix" for this "problem", 
+		#	although I don't know how kosher it is.
+		#
+		#	It works in my test environment, but does not actually work 
+		#	in the "rake surveyor" task as the survey is built from a 
+		#	different Survey model completely and then loaded into the 
+		#	database and not created though the application.
+		#
+		#	My final "fix" was to add 
+		#
+		#		require 'lib/surveyor/survey_extensions'
+		#
+		#	to my Rakefile and create the file
+		#
+		#	> cat lib/surveyor/survey_extensions.rb
+		#		if surveyor_gem = Gem.searcher.find('surveyor')
+		#			require surveyor_gem.full_gem_path + '/script/surveyor/parser'
+		#			require surveyor_gem.full_gem_path + '/script/surveyor/survey'
+		#		end
+		#
+		#		module SurveyParser
+		#		module SurveyExtensions
+		#		  def self.included(base)
+		#		    base.class_eval do
+		#		      def initialize_with_unique_access_code(obj, args, opts)
+		#		        initialize_without_unique_access_code(obj, args, opts)
+		#		        counter = 2
+		#		        ac = self.access_code
+		#		        original_ac = self.access_code
+		#		        while( survey = ::Survey.find_by_access_code(ac) ) 
+		#		          ac = [original_ac,"_",counter].join
+		#		          counter += 1
+		#		        end
+		#		        self.access_code = ac
+		#		      end
+		#		      alias_method_chain :initialize, :unique_access_code
+		#		    end
+		#		  end
+		#		end
+		#		end
+		#		SurveyParser::Survey.send(:include, SurveyParser::SurveyExtensions)
+		#
+		#	It is not as clean as I would've liked, but works.
+		#	Override the setting of the access_code to ensure its uniqueness
+		#
+		#	While uniqueness was added after 0.10.0, this method
+		#	was not deemed important or likely to be needed enough.
+		#	It is true that this really isn't NEEDed.
+		def access_code=(value)
+			counter = 2
+			original_value = value
+			while( ( survey = Survey.find_by_access_code(value) ) && 
+				( self.id != survey.id ) )
+				value = [original_value,"_",counter].join
+				counter += 1
+			end
+			super		#(value)
+		end
+  
+end

data/app/models/survey_section.rb

@@ -0,0 +1,18 @@
+class SurveySection < ActiveRecord::Base
+  
+  # Extending surveyor
+  include "#{self.name}Extensions".constantize if Surveyor::Config['extend'].include?(self.name.underscore)
+    
+  # Associations
+  has_many :questions, :order => "display_order ASC"
+  belongs_to :survey
+  
+  # Scopes
+  default_scope :order => "display_order ASC"
+  named_scope :with_includes, { :include => {:questions => [:answers, :question_group, {:dependency => :dependency_conditions}]}}
+  
+  # Validations
+  validates_presence_of :title, :survey, :display_order
+  
+end
+

data/app/models/validation.rb

@@ -0,0 +1,38 @@
+class Validation < ActiveRecord::Base
+
+  # Extending surveyor
+  include "#{self.name}Extensions".constantize if Surveyor::Config['extend'].include?(self.name.underscore)
+
+  
+  # Associations
+  belongs_to :answer
+  has_many :validation_conditions
+  
+  # Scopes
+  
+  # Validations
+  validates_presence_of :rule
+  validates_format_of :rule, :with => /^(?:and|or|\)|\(|[A-Z]|\s)+$/
+  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

@@ -0,0 +1,47 @@
+class ValidationCondition < ActiveRecord::Base
+
+  # Extending surveyor
+  include "#{self.name}Extensions".constantize if Surveyor::Config['extend'].include?(self.name.underscore)
+  
+  # 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
+  
+  acts_as_response # includes "as" instance method
+  
+  # Class methods
+  def self.operators
+    OPERATORS
+  end
+  
+  # Instance Methods
+  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
+    compare_to = Response.find_by_question_id_and_answer_id(self.question_id, self.answer_id) || self
+    case self.operator
+    when "==", "<", ">", "<=", ">="
+      response.as(klass).send(self.operator, compare_to.as(klass))
+    when "!="
+      !(response.as(klass) == compare_to.as(klass))
+    when "=~"
+      return false if compare_to != self
+      !(response.as(klass).to_s =~ Regexp.new(self.regexp || "")).nil?
+    else
+      false
+    end
+  end
+end

data/app/views/layouts/surveyor_default.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+  <title>Survey: <%= controller.action_name %></title>
+  <%= surveyor_includes %>
+</head>
+<body>
+  <div id="flash"><%= flash[:notice] %></div>
+  <%= yield %>
+</body>
+</html>

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

@@ -0,0 +1,58 @@
+- renderer = answer.renderer(question)
+- response_group ||= nil
+- hide_label ||= false
+- disabled ||= false
+- fields_for_response(response_obj, response_group) do |response_form|
+  - case renderer
+  - when :any_answer
+    = response_form.survey_check_box(:selected, :class => (answer.is_exclusive? ? "exclusive" : ""))
+    = response_form.label("selected", answer.text) unless hide_label # This is a temp fix til I figure out why the id of the checkbox is all jacked up
+  - when :any_other_and_string
+    = response_form.survey_check_box(:selected, :class => (answer.is_exclusive? ? "exclusive" : ""))
+    %label Other
+    = response_form.text_field(:other_value)
+    = response_form.text_field(:string_value)
+  - when :any_string
+    = 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, :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}", 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(:datetime_value, split_text(answer.text)[:prefix], :class => "#{(disabled)? 'disabled' : 'enabled'}") unless hide_label
+    = response_form.text_field(:datetime_value)
+    = response_form.label(:datetime_value, split_text(answer.text)[:postfix], :class => "#{(disabled)? 'disabled' : 'enabled'}") unless hide_label
+  - when :none_datetime
+    = 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(: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")
+    = response_form.label(:float_value, split_text(answer.text)[:postfix]) unless hide_label
+  - when :none_integer
+    = response_form.label(:integer_value, split_text(answer.text)[:prefix], :class => "#{(disabled)? 'disabled' : 'enabled'}") unless hide_label
+    = response_form.text_field(:integer_value, :size => 5, :maxlength => 10, :autocomplete => "off", :disabled => disabled)
+    = response_form.label(:integer_value, split_text(answer.text)[:postfix], :class => "#{(disabled)? 'disabled' : 'enabled'}") unless hide_label
+  - when :none_string
+    = response_form.label(:string_value, split_text(answer.text)[:prefix], :class => "#{(disabled)? 'disabled' : 'enabled'}") unless hide_label
+    = response_form.text_field(:string_value, :size => 25, :maxlength => 250, :autocomplete => "off", :disabled => disabled)
+    = response_form.label(:string_value, split_text(answer.text)[:postfix], :class => "#{(disabled)? 'disabled' : 'enabled'}") unless hide_label
+  - when :none_text
+    = response_form.label(:text_value, split_text(answer.text)[:prefix]) unless hide_label
+    = 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(: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(:datetime_value, split_text(answer.text)[:postfix], :class => "#{(disabled)? 'disabled' : 'enabled'}") unless hide_label
+  - else
+    = answer.text
+  

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

@@ -0,0 +1,80 @@
+- renderer = question.renderer(question_group ||= nil)
+- case renderer
+- when :label
+  - div_for question, :class => "label #{question.css_class(response_set)}" do
+    - if question.survey_section.survey.manual_numbering && question.number
+      .number= question.number	#||' '
+    %span.text= question.text
+    %span.help= question.help_text
+- when :image
+  .image= image_tag(question.text)
+- when :dropdown, :slider
+  - if renderer == :slider
+    %script{:type => "text/javascript"}= "$(function(){$('#slider_#{question.id}').accessibleUISlider({width: 400, labels:#{question.answers.size} }).hide();});"
+  - div_for question, :class => question.css_class(response_set) do
+    - if question.survey_section.survey.manual_numbering
+      .number= question.number||' '
+    - else
+      .number= next_number unless question.dependent?
+    %fieldset
+      %legend{:style => "display:inline;"}
+        %span.text= question.text
+        %span.help= question.help_text
+        = hidden_field_tag("responses[#{question.id}][question_id]", question.id)
+      %ol.answers
+        %li.answer
+          - options = question.answers.collect{|a| "<option #{ (response_set.response_for(question.id, a.id).selected?)? "selected='selected'" : nil } value ='#{a.id}'>#{a.text}</option>" }
+          = renderer == :slider ? select_tag("responses[#{question.id}][answer_id]", options, {:id => "slider_#{question.id}"}) : select_tag("responses[#{question.id}][answer_id]", ["<option value=''>Select one...</option>"].concat(options))
+- when :grid_default
+  - reset_cycle("col")
+  - content_tag_for :tr, question, :class => question.css_class(response_set) do
+    %th.question_prefix
+      %span.text= split_text(question.text)[:prefix]
+      %span.help= question.help_text
+      = hidden_field_tag("responses[#{question.id}][question_id]", question.id)
+    - question.answers.each do |answer|
+      %td{:class => "#{cycle("column_highlight", "", :name => "col")}"}
+        .answer{:class => answer.custom_class}= render(:partial => answer.custom_renderer || "/partials/answer", :locals => {:answer => answer, :question => question, :response_obj => @response_set.response_for(question.id, answer.id), :hide_label => true})
+    %th.question_postfix
+      %span.text= split_text(question.text)[:postfix]
+- when :repeater_default, :repeater_dropdown
+  - disabled ||= false
+  - div_for question, :class => "#{disabled ? 'dis' : 'en'}abled #{question.css_class(response_set)}" do
+    %span.text= question.text
+    %span.help= question.help_text
+    = hidden_field_tag("response_groups[#{question.id}][#{response_group}][response_group]", response_group)
+    = hidden_field_tag("response_groups[#{question.id}][#{response_group}][question_id]", question.id)
+    %br
+    %ol.answers
+      - if renderer == :repeater_default  
+        - question.answers.each do |answer|
+          - content_tag_for :li, answer, :class => answer.custom_class do
+            = render(:partial => answer.custom_renderer || "/partials/answer", :locals => {:answer => answer, :question => question, :response_obj => @response_set.response_for(question.id, answer.id, response_group), :response_group => response_group, :hide_label => true, :disabled => disabled})
+      - else
+        %li.answer
+          - options = question.answers.collect{|a| "<option #{ (response_set.response_for(question.id, a.id, response_group).selected?)? "selected='selected'" : nil } value ='#{a.id}'>#{a.text}</option>" }
+          = select_tag("response_groups[#{question.id}][#{response_group}][answer_id]", ["<option value=''>Select one...</option>"].concat(options), :disabled => disabled)
+- when :inline_default, :inline_dropdown
+  - div_for question, :class => "inline #{question.css_class(response_set)}" do
+    = hidden_field_tag("responses[#{question.id}][question_id]", question.id)
+    - if renderer == :inline_default
+      - question.answers.each do |answer|
+        .answer{:class => answer.custom_class}= render(:partial => answer.custom_renderer || "/partials/answer", :locals => {:answer => answer, :question => question, :response_obj => @response_set.response_for(question.id, answer.id), :hide_label => answer.hide_label})
+    - else
+      - options = question.answers.collect{|a| "<option #{ (response_set.response_for(question.id, a.id).selected?)? "selected='selected'" : nil } value ='#{a.id}'>#{a.text}</option>" }
+      = select_tag("responses[#{question.id}][answer_id]", ["<option value=''>Select one...</option>"].concat(options))
+- else # :default, :inline
+  - div_for question, :class => question.css_class(response_set) do
+    - if question.survey_section.survey.manual_numbering
+      .number= question.number||'&nbsp;'
+    - else
+      .number= next_number unless question.dependent?
+    %fieldset
+      %legend
+        %span.text= question.text
+        %span.help= question.help_text
+        = hidden_field_tag("responses[#{question.id}][question_id]", question.id)
+      %ol.answers{:class => renderer == :inline ? "inline" : nil}
+        - question.answers.each do |answer|
+          - content_tag_for :li, answer, :class => answer.custom_class do
+            = render(:partial => answer.custom_renderer || "/partials/answer", :locals => {:answer => answer, :question => question, :response_obj => @response_set.response_for(question.id, answer.id), :hide_label => answer.hide_label})

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

@@ -0,0 +1,39 @@
+- renderer = question_group.renderer
+- locals = {:question_group => question_group, :response_set => response_set, :hide_label => true}
+- div_for question_group, :class => question_group.css_class(response_set) do
+  .head
+    .number= next_number
+    %span.text= question_group.text
+    %span.help= question_group.help_text
+
+  - case question_group.renderer
+  - when :grid
+    %table.grid
+      %thead
+        %tr
+          %th= " "
+          - reset_cycle("column_highlight")
+          - group_questions.first.answers.each do |answer|
+            %th{:class => "#{cycle("column_highlight", "", :name => "column_highlight")}"}= answer.text
+      %tbody
+        - group_questions.each_with_index do |question, i|
+          = render(:partial => question.custom_renderer || "/partials/question", :locals => locals.merge({:question => question}))
+          - if i%10 == 9
+            %th= " "
+            - reset_cycle("column_highlight")
+            - group_questions.first.answers.each do |answer|
+              %th{:class => "#{cycle("column_highlight", "", :name => "column_highlight")}"}= answer.text
+  - when :repeater
+    %ul.repeater
+      - (response_set.count_group_responses(group_questions) + 1).times do |group_number|
+        %li.repeater
+          - group_questions.each do |question|
+            = render(:partial => question.custom_renderer || "/partials/question", :locals => locals.merge({:question => question, :response_group => group_number, :disabled => false}))
+      %li.repeater
+        - group_questions.each do |question|
+          = render(:partial => question.custom_renderer || "/partials/question", :locals => locals.merge({:question => question, :response_group => 9999, :disabled => true}))
+        = submit_tag("<= add row", :name => "section[#{group_questions.first.survey_section_id}]question_group_#{question_group.id}", :class => "add_row")
+  - else # :inline
+    %ul
+      - group_questions.each do |question|
+        %li{:class => question_group.renderer == :inline ? "inline" : nil}= render(:partial => question.custom_renderer || "/partials/question", :locals => locals.merge({:question => question}))