surveyor 0.6.10 → 0.7.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.6.10'
+    script/plugin install git://github.com/breakpointer/surveyor.git -r 'tag v0.7.0'
 
 Or as a gem plugin:
   
   # in environment.rb
-  config.gem "surveyor", :version => '>=0.6.10', :source => 'http://gemcutter.org'
+  config.gem "surveyor", :version => '>=0.7.0', :source => 'http://gemcutter.org'
   
     sudo gem install gemcutter
     gem tumble
@@ -103,4 +103,15 @@ The <code>surveyor\_includes</code> helper just calls <code>surveyor\_stylsheets
 
 Surveyor depends on Rails 2.3 and the SASS style sheet language, part of HAML (http://haml.hamptoncatlin.com/download)
 
+# Changes
+
+0.7.0
+
+* new kitchen sink survey with better documentation of DSL
+* migration misspelling
+* fixing ordering, dependency conditions evaluation, and changing named scopes for now
+* DRYing up surveyor DSL models
+* working on adding dependencies for question groups
+
+
 Copyright (c) 2008-2009 Brian Chamberlain and Mark Yoon, released under the MIT license

data/VERSION

@@ -1 +1 @@
-0.6.10
+0.7.0

data/app/controllers/surveyor_controller.rb

@@ -40,7 +40,7 @@ class SurveyorController < ApplicationController
       @survey = Survey.with_sections.find_by_id(@response_set.survey_id)
       @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.in_order
+      @questions = @section.questions
     else
       flash[:notice] = "Unable to find your responses to the survey"
       redirect_to(available_surveys_path)

data/app/models/dependency.rb

@@ -1,19 +1,30 @@
 class Dependency < ActiveRecord::Base
   # Associations
   belongs_to :question
+  belongs_to :question_group
   has_many :dependency_conditions
   
   # Scopes
-  named_scope :depending_on_questions, lambda {|question_ids| {:include => :dependency_conditions, :conditions => {:dependency_conditions => {:question_id => question_ids}} }}
+  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|\)|\(|\d|\s)+$/ #TODO properly formed parenthesis etc.
-  validates_numericality_of :question_id
+  validates_format_of :rule, :with => /^(?:and|or|\)|\(|[A-Z]|\s)+$/ #TODO properly formed parenthesis etc.
+  # validates_numericality_of :question_id
 
   # Attribute aliases
   alias_attribute :dependent_question_id, :question_id
-
+  
+  def question_group_id=(i)
+    write_attribute(:question_id, nil)
+    write_attribute(:question_group_id, i)
+  end
+  
+  def question_id=(i)
+    write_attribute(:question_group_id, nil)
+    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)
@@ -29,6 +40,7 @@ class Dependency < ActiveRecord::Base
   # 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_evaluation_hash(response_set))
     end
@@ -38,8 +50,11 @@ class Dependency < ActiveRecord::Base
   # 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| dc.rule_key}.join("|")) # Making a regexp to only look for the keys used in the child conditions
-    #logger.debug("rexp: #{rgx.inspect} FOO: #{keyed_pairs.inspect} --- subbed rules: #{rule.gsub(rgx){|m| keyed_pairs[m.to_sym]}} --> #{eval(self.rule.gsub(rgx){|m| keyed_pairs[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("|")) # Making a regexp to only look for the keys used in the child conditions
+    # 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
   end
   

data/app/models/question.rb

@@ -3,12 +3,11 @@ class Question < ActiveRecord::Base
   # Associations
   belongs_to :survey_section
   belongs_to :question_group
-  has_many :answers # it might not always have answers
+  has_many :answers, :order => "display_order ASC" # it might not always have answers
   has_one :dependency
 
   # Scopes
   default_scope :order => "display_order ASC"
-  named_scope :in_order, {:order => "display_order ASC"}
   
   # Validations
   validates_presence_of :text, :survey_section_id, :display_order
@@ -22,8 +21,8 @@ class Question < ActiveRecord::Base
   
   def default_args
     self.is_mandatory ||= true
-    self.display_type = "default"
-    self.pick = "none"
+    self.display_type ||= "default"
+    self.pick ||= "none"
   end
   
   def mandatory?
@@ -39,9 +38,6 @@ class Question < ActiveRecord::Base
   def dep_class(response_set)
     dependent? ? triggered?(response_set) ? "dependent" : "hidden dependent" : nil
   end
-  def dependency_satisfied?(response_set)
-    self.has_dependency? and self.dependency.met?(response_set)
-  end
   
   def part_of_group?
     !self.question_group.nil?

data/app/models/question_group.rb

@@ -1,6 +1,7 @@
 class QuestionGroup < ActiveRecord::Base
   
   has_many :questions
+  has_one :dependency
   
   # Instance Methods
   def initialize(*args)
@@ -9,10 +10,21 @@ class QuestionGroup < ActiveRecord::Base
   end
   
   def default_args
-    self.display_type = "inline"
+    self.display_type ||= "inline"
   end
 
   def renderer
     display_type.blank? ? :default : display_type.to_sym
   end
+  
+  def dependent?
+    self.dependency != nil
+  end
+  def triggered?(response_set)
+    dependent? ? self.dependency.met?(response_set) : true
+  end
+  def dep_class(response_set)
+    dependent? ? triggered?(response_set) ? "dependent" : "hidden dependent" : nil
+  end
+  
 end

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| "question_#{d.question_id}"}, :hide => arr[1].map{|d| "question_#{d.question_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/survey_section.rb

@@ -1,7 +1,7 @@
 class SurveySection < ActiveRecord::Base
   
   # Associations
-  has_many :questions
+  has_many :questions, :order => "display_order ASC"
   belongs_to :survey
   
   # Scopes

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

@@ -1,7 +1,8 @@
 - renderer = question_group.renderer
+- dep_class = question_group.dep_class(response_set)
 - locals = {:question_group => question_group, :response_set => response_set, :hide_label => true}
 
-- div_for question_group do
+- div_for question_group, :class => dep_class do
   .head
     .number= next_number
     %span.text= question_group.text

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

@@ -15,7 +15,7 @@ class CreateAnswers < ActiveRecord::Migration
       t.string :reference_identifier # from paper
       t.string :data_export_identifier # data export
       t.string :common_namespace # maping to a common vocab
-      t.string :common_identitier # maping to a common vocab
+      t.string :common_identifier # maping to a common vocab
     
       # Display
       t.integer :display_order

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

@@ -3,6 +3,7 @@ class CreateDependencies < ActiveRecord::Migration
     create_table :dependencies do |t|
       # Context
       t.integer :question_id # the dependent question
+      t.integer :question_group_id
       
       # Conditional
       t.string :rule

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

@@ -9,7 +9,7 @@ class CreateQuestionGroups < ActiveRecord::Migration
       t.string :reference_identifier # from paper
       t.string :data_export_identifier # data export
       t.string :common_namespace # maping to a common vocab
-      t.string :common_identitier # maping to a common vocab
+      t.string :common_identifier # maping to a common vocab
             
       # Display
       t.string :display_type

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

@@ -15,7 +15,7 @@ class CreateQuestions < ActiveRecord::Migration
       t.string :reference_identifier # from paper
       t.string :data_export_identifier # data export
       t.string :common_namespace # maping to a common vocab
-      t.string :common_identitier # maping to a common vocab
+      t.string :common_identifier # maping to a common vocab
       
       # Display
       t.integer :display_order

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

@@ -12,7 +12,7 @@ class CreateSurveySections < ActiveRecord::Migration
       t.string :reference_identifier # from paper
       t.string :data_export_identifier # data export
       t.string :common_namespace # maping to a common vocab
-      t.string :common_identitier # maping to a common vocab
+      t.string :common_identifier # maping to a common vocab
       
       # Display
       t.integer :display_order

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

@@ -10,7 +10,7 @@ class CreateSurveys < ActiveRecord::Migration
       t.string :reference_identifier # from paper
       t.string :data_export_identifier # data export
       t.string :common_namespace # maping to a common vocab
-      t.string :common_identitier # maping to a common vocab
+      t.string :common_identifier # maping to a common vocab
 
       # Expiry
       t.datetime :active_at

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

@@ -1,34 +1,29 @@
 survey "“Kitchen Sink” survey" do
 
   section "Basic questions" do
-
-    # exclusive
-    # name people you live with (choose all that apply)
-    # husband, friend, partner, siblings, other, alone, choose not to answer
-    # alone unchecks/erases, and disables all the others
-    # omit (choose not to answer) is exclusive as well
-
-    # a label is a question that accepts no answers
-    # reference_identifier => label
+    # A label is a question that accepts no answers
     label "These questions are examples of the basic supported input types"
 
-
-    # a basic question,
-    # reference_identifier => 1
+    # A basic question with radio buttons
     question_1 "What is your favorite color?", :pick => :one
     answer "red"
     answer "blue"
     answer "green"
     answer "yellow"
-    answer :other # :other is a custom answer symbol type, it has associated pre-sets with it
-
-    question_2 "Choose the colors you don't like", :pick => :any
-    answer_1 "red"
-    answer_2 "blue"
-    answer_3 "green"
-    answer_4 "yellow"
-    answer :omit
-    
+    answer :other
+
+    # A basic question with checkboxes
+    # "question" and "answer" may be abbreviated as "q" and "a"
+    q_2 "Choose the colors you don't like", :pick => :any
+    a_1 "red"
+    a_2 "blue"
+    a_3 "green"
+    a_4 "yellow"
+    a :omit
+
+    # 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
     q_2a "Please explain why you don't like this color?"
     a_1 "explanation", :text
     dependency :rule => "A or B or C or D"
@@ -37,67 +32,54 @@ survey "“Kitchen Sink” survey" do
     condition_C :q_2, "==", :a_3
     condition_D :q_2, "==", :a_4
 
-    # question definitions can be abreviated as shown below
-    # questions and answers don't need to have numbers. Only if they are referenced in a dependency condition
+    # When :pick isn't specified, the default is :none (no checkbox or radio button)
     q "What is your name?"
     a :string
 
-    q "Give your response"
+    # Surveys, sections, questions, groups, and answers all take the following reference arguments
+    # :reference_identifier   # usually from paper
+    # :data_export_identifier # data export
+    # :common_namespace       # maping to a common vocab
+    # :common_identitier      # maping to a common vocab
+    q "Get me started on an improv sketch", :reference_identifier => "improv_start", :data_export_identifier => "i_s", :common_namespace => "sketch comedy questions", :common_identifer => "get me started"
     a "who", :string
     a "what", :string
     a "where", :string
-
-    q "How many pets do you own?" 
+    
+    # Various types of respones can be accepted
+    q "How many pets do you own?"
     a :integer
 
-    q "What is your address?" 
+    q "What is your address?"
     a :text
-    # 
-    # q "Pick your favorite date"
-    # a :date
-    # 
-    # q "Pick your favorite time"
-    # a :time
 
     q "Pick your favorite date AND time"
     a :datetime
     
-    q "What time would you like to meet?"
+    q "What time do you usually take a lunch break?"
     a :time
     
-    q "What date would you like to meet?"
+    q "When would you like to meet for dinner?"
     a :date
-
+    
+    # Sliders deprecate to select boxes when javascript is off
+    # Valid Ruby code may be used to shorted repetitive tasks
     q "Adjust the slider to reflect your level of awesomeness", :pick => :one, :display_type => :slider
-    (1..10).to_a.each{ |num| a num.to_s}
+    (1..10).to_a.each{|num| a num.to_s}
 
     q "How much do you like Ruby?", :pick => :one, :display_type => :slider
     ["not at all", "a little", "some", "a lot", "a ton"].each{|level| a level}
-
-    # range "When did you start working at NUBIC?", :range_type => :date do
-    #      q "From"
-    #      a :date
-    #      
-    #      q "To"
-    #      a :date
-    #    end
-    #    
-    #    range "What times are you awake?", :range_type => :integer do
-    #      q "From"
-    #      a :integer
-    #      
-    #      q "To"
-    #      a :integer
-    #    end
     
+    # The "|" pipe is used to place labels before or after the input elements
     q "How much money do you want?"
-    a "$|USD", :float, :unit => "F"  
+    a "$|USD", :float
 
+    # Questions may be grouped
     group "How much oil do you use per day?", :display_type => :inline do
       q "Quantity"
       a "Quantity", :float
 
-      q "Unit", :pick => :one, :display_type => :dropdown, :hide_label => true
+      q "Unit", :pick => :one, :display_type => :dropdown
       a "Barrels"
       a "Gallons"
       a "Quarts"
@@ -124,7 +106,8 @@ survey "“Kitchen Sink” survey" do
         "St. Clair","Stark", "Stephenson","Tazewell","Union",
         "Vermilion","Wabash","Warren","Washington","Wayne",
         "White","Whiteside","Will","Williamson","Winnebago","Woodford"].each{ |county| a county}
-
+    
+    # When an is_exclusive answer is checked, it unchecks all other options and disables them (using Javascript)
     q "Choose your favorite meats", :display_type => :inline, :pick => :any
     a "Chicken"
     a "Pork"
@@ -141,7 +124,8 @@ survey "“Kitchen Sink” survey" do
   end
 
   section "Complicated questions" do
-
+    
+    # Grids are useful for repeated questions with the same set of answers, which are specified before the questions
     grid "Tell us how often do you cover these each day" do
       a "1"
       a "2"
@@ -150,33 +134,35 @@ survey "“Kitchen Sink” survey" do
       q "Knees", :pick => :one
       q "Toes", :pick => :one
     end
-
+    
+    # "grid" is a shortcut for group with :display_type => :grid
+    # The answers will be repeated every 10 rows, but long grids aren't recommended as they are generally tedious
     grid "Tell us how you feel today day" do
       a "-2"
       a "-1"
       a "0"
       a "1"
       a "2"
-      a :omit
       q "down|up" , :pick => :one
       q "sad|happy", :pick => :one
       q "limp|perky", :pick => :one
     end
     
     q "Please rank the following foods based on how much you like them"
-      a "|pizza", :integer
-      a "|salad", :integer
-      a "|sushi", :integer
-      a "|ice cream", :integer
-      a "|breakfast ceral", :integer
+    a "|pizza", :integer
+    a "|salad", :integer
+    a "|sushi", :integer
+    a "|ice cream", :integer
+    a "|breakfast ceral", :integer
     
-
+    # :other, :string allows someone to specify both the "other" and some other information
     q "Choose your favorite utensils and enter frequency of use (daily, weekly, monthly, etc...)", :pick => :any
     a "spoon", :string
     a "fork", :string
     a "knife", :string
     a :other, :string
-
+    
+    # Repeaters allow multiple responses to a question or set of questions
     repeater "Tell us about the cars you own" do
       q "Make", :pick => :one, :display_type => :dropdown
       a "Toyota"
@@ -191,10 +177,11 @@ survey "“Kitchen Sink” survey" do
       q "Year"
       a :string
     end
+    
     repeater "Tell us the name and age of your siblings" do
       q "Sibling"
       a "Name", :string
-      a "Age", :integer, :unit => "years"
+      a "Age|years", :integer
     end
 
   end

data/script/surveyor/answer.rb

@@ -23,7 +23,6 @@ class Answer
     { :short_text => text,
       :data_export_identifier => Columnizer.to_normalized_column(text),
       :is_exclusive => false,
-      :is_a_disabler => false,
       :hide_label => false,
       :response_class => "answer"
     }
@@ -36,11 +35,11 @@ class Answer
     if a0.is_a?(Hash)
       {:text => "Answer"}.merge(a0)
       
-    # String, Hash || String, Symbol, Hash
+    # (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 || Symbol, Symbol, Hash
+    # (Symbol, Hash) or (Symbol, Symbol, Hash)
     elsif a0.is_a?(Symbol)
       shortcuts = case a0
       when :other
@@ -60,25 +59,12 @@ class Answer
     end
   end
 
+  def yml_attrs
+    instance_variables.sort - ["@parser"]
+  end
   def to_yml
-    out =[ %(#{@data_export_identifier}_#{@id}:) ]
-    out << %(  id: #{@id})
-    out << %(  question_id: #{@question_id})
-    out << %(  text: "#{@text}")
-    out << %(  short_text: "#{@short_text}")
-    out << %(  help_text: "#{@help_text}")
-    out << %(  weight: #{@weight})
-    out << %(  response_class: "#{@response_class}")
-    out << %(  reference_identifier: "#{@reference_identifier}")
-    out << %(  data_export_identifier: "#{@data_export_identifier}")
-    out << %(  common_namespace: "#{@common_namespace}")
-    out << %(  common_identitier: "#{@common_identitier}")
-    out << %(  display_order: #{@display_order} )
-    out << %(  is_exclusive: #{@is_exclusive})
-    out << %(  hide_label: #{@hide_label})
-    out << %(  display_length: #{@display_length} )
-    out << %(  custom_class: "#{@custom_class}")
-    out << %(  custom_renderer: "#{@custom_renderer}")
+    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")
   end
 

data/script/surveyor/dependency.rb

@@ -1,7 +1,7 @@
 class Dependency
   
   # Context, Conditional, Children
-  attr_accessor :id, :question_id, :parser
+  attr_accessor :id, :question_id, :question_group_id, :parser
   attr_accessor :rule
   attr_accessor :dependency_conditions
 
@@ -9,7 +9,11 @@ class Dependency
   def initialize(question, args, options)
     self.parser = question.parser
     self.id = parser.new_dependency_id
-    self.question_id = question.id
+    if question.class == QuestionGroup
+      self.question_group_id = question.id
+    else
+      self.question_id = question.id
+    end
     self.rule = (args[0] || {})[:rule]
     self.dependency_conditions = []
     self.default_options().merge(options).merge(args[1] || {}).each{|key,value| self.instance_variable_set("@#{key}", value)}
@@ -25,11 +29,12 @@ class Dependency
     self.dependency_conditions << dc_obj
   end
   
+  def yml_attrs
+    instance_variables.sort - ["@parser", "@dependency_conditions", "@reference_identifier"]
+  end
   def to_yml
-    out =[ %(#{question_id}_#{@id}:) ]
-    out << %(  id: #{@id})
-    out << %(  question_id: #{@question_id})
-    out << %(  rule: "#{@rule}")
+    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")
   end
 

data/script/surveyor/dependency_condition.rb

@@ -11,11 +11,8 @@ class DependencyCondition
     self.parser = dependency.parser
     self.id = parser.new_dependency_condition_id
     self.dependency_id = dependency.id
-    self.rule_key = options[:reference_identifier]
-    
     args_options = parse_args_options(args)
     self.default_options().merge(options).merge(args_options).each{|key,value| self.instance_variable_set("@#{key}", value)}
-    
   end
   
   def default_options()
@@ -28,29 +25,21 @@ class DependencyCondition
     a2.is_a?(Hash) ? options.merge(a2) : options.merge({:answer_reference => a2.to_s.gsub("a_", "")})
   end
   
+  def yml_attrs
+    instance_variables.sort - ["@parser", "@question_reference", "@answer_reference", "@reference_identifier"]
+  end
   def to_yml
-    out =[ %(#{@question_id}_#{@dependency_id}_#{id}:) ]
-    out << %(  id: #{@id})
-    out << %(  dependency_id: #{@dependency_id})
-    out << %(  rule_key: "#{@rule_key}")
-    out << %(  question_id: #{@question_id})
-    out << %(  operator: "#{@operator}")
-    out << %(  answer_id: #{@answer_id})
-    out << %(  datetime_value: #{@date_value})
-    out << %(  integer_value: #{@integer_value})
-    out << %(  float_value: #{@float_value})
-    out << %(  unit: "#{@unit}")
-    out << %(  text_value: "#{@text_value}")
-    out << %(  string_value: "#{@string_value}")
-    out << %(  response_other: "#{@response_other}")
+    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")
   end
 
   def reconcile_dependencies
     # Looking up references to questions and answers for linking the dependency objects
-    puts "Looking up references for question: #{@question_reference} in Survey: #{Survey.current_survey.title}"
-    ref_question = Survey.current_survey.find_question_by_reference(@question_reference) # Argh. I can't think of a better way to get a hold of this reference here...
+    puts "Looking up references for question: #{@question_reference}"
+    ref_question = Survey.current_survey.find_question_by_reference(@question_reference) # TODO change this. Argh. I can't think of a better way to get a hold of this reference here...
     if ref_question
+      puts "  found question: #{ref_question.data_export_identifier} (id:#{ref_question.id})"
       @question_id = ref_question.id
       ref_answer = ref_question.find_answer_by_reference(@answer_reference)
       if ref_answer 

data/script/surveyor/question.rb

@@ -49,26 +49,13 @@ class Question
     puts "  found answer: '#{answer.text}' (id:#{answer.id})"  unless answer.nil?
     answer
   end
-
+  
+  def yml_attrs
+    instance_variables.sort - ["@parser", "@answers", "@dependency"]
+  end
   def to_yml
-    out =[ %(#{@data_export_identifier}_#{@id}:) ]
-    out << %(  id: #{@id})
-    out << %(  survey_section_id: #{@survey_section_id})
-    out << %(  question_group_id: #{@question_group_id})
-    out << %(  text: "#{@text}")
-    out << %(  short_text: "#{@short_text}")
-    out << %(  help_text: "#{@help_text}")
-    out << %(  pick: "#{pick}")
-    out << %(  reference_identifier: "#{@reference_identifier}")
-    out << %(  data_export_identifier: "#{@data_export_identifier}")
-    out << %(  common_namespace: "#{@common_namespace}")
-    out << %(  common_identitier: "#{@common_identitier}")
-    out << %(  display_order: #{@display_order})
-    out << %(  display_type: "#{@display_type}")
-    out << %(  is_mandatory: #{@is_mandatory})
-    out << %(  display_width: #{@display_width})
-    out << %(  custom_class: "#{@custom_class}")
-    out << %(  custom_renderer: "#{@custom_renderer}")
+    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")
   end
   

data/script/surveyor/question_group.rb

@@ -1,10 +1,11 @@
 class QuestionGroup
 
-  # Context, Content, Display
-  attr_accessor :id, :section_id, :section, :parser
+  # Context, Content, Display, Children
+  attr_accessor :id, :parser
   attr_accessor :text, :help_text
   attr_accessor :reference_identifier, :data_export_identifier, :common_namespace, :common_identitier
   attr_accessor :display_type, :custom_class, :custom_renderer
+  attr_accessor :dependency
 
   # id, section and text required
   def initialize(section, args, options)
@@ -18,18 +19,12 @@ class QuestionGroup
     {:display_type => "default"}
   end
 
+  def yml_attrs
+    instance_variables.sort - ["@parser", "@dependency"]
+  end
   def to_yml
-    out =[ %(#{@id}:) ]
-    out << %(  id: #{@id})
-    out << %(  text: "#{@text}")
-    out << %(  help_text: "#{@help_text}")
-    out << %(  reference_identifier: "#{@reference_identifier}")
-    out << %(  data_export_identifier: "#{@data_export_identifier}")
-    out << %(  common_namespace: "#{@common_namespace}")
-    out << %(  common_identitier: "#{@common_identitier}")
-    out << %(  display_type: "#{@display_type}")
-    out << %(  custom_class: "#{@custom_class}")
-    out << %(  custom_renderer: "#{@custom_renderer}")    
+    out = [ %(#{@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")
   end
 

data/script/surveyor/survey.rb

@@ -86,20 +86,12 @@ class Survey
     end  
   end
 
+  def yml_attrs
+    instance_variables.sort - ["@parser", "@survey_sections"]
+  end
   def to_yml
-    out =[ %(survey_#{@id}:) ]
-    out << %(  id: #{@id})
-    out << %(  title: "#{@title}")
-    out << %(  description: "#{@description}")
-    out << %(  access_code: "#{@access_code}")
-    out << %(  reference_identifier: "#{@reference_identifier}")
-    out << %(  data_export_identifier: "#{@data_export_identifier}")
-    out << %(  common_namespace: "#{@common_namespace}")
-    out << %(  common_identitier: "#{@common_identitier}")
-    out << %(  active_at: #{@active_at})
-    out << %(  inactive_at: #{@inactive_at})
-    out << %(  css_url: "#{@css_url}")
-    out << %(  custom_class: "#{@custom_class}")
+    out = [ %(survey_#{@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")
   end
 

data/script/surveyor/survey_section.rb

@@ -41,13 +41,14 @@ class SurveySection
   # This method_missing magic does all the heavy lifting for the DSL
   def method_missing(missing_method, *args, &block)    
     method_name, reference_identifier = missing_method.to_s.split("_")
-
+    
     case method_name
       
     when "group", "g", "grid", "repeater"
       puts "    Group: #{reference_identifier}"
       raise "Error: A question group cannot be empty" unless block_given?
       
+      clear_current_question
       options = {:reference_identifier => reference_identifier, :display_type => (method_name =~ /grid|repeater/)? method_name : nil }
       self.question_groups << (self.current_question_group = QuestionGroup.new(self, args, options))
       self.instance_eval(&block)
@@ -67,17 +68,17 @@ class SurveySection
     when "dependency", "d"
       puts "        Dependency: #{reference_identifier}"
       raise "Error: I'm dropping the block like it's hot" if block_given?
-      raise "Error: " unless self.current_question
+      raise "Error: No question or question group" unless (d = self.current_question_group || self.current_question)
       
-      options = {:reference_identifier => reference_identifier}
-      self.current_question.dependency = (self.current_dependency = Dependency.new(current_question, args, options))
+      options = {}# {:reference_identifier => reference_identifier}
+      d.dependency = (self.current_dependency = Dependency.new(d, args, options))
       
     when "condition", "c"
       puts "          Condition: #{reference_identifier}"
       raise "Error, I'm dropping the block like it's hot" if block_given?
       raise "Error: No current dependency" unless self.current_dependency
       
-      options = {:reference_identifier => reference_identifier}
+      options = {:rule_key => reference_identifier}
       self.current_dependency.add_dependency_condition DependencyCondition.new(self, args, options)
       
     when "answer", "a"
@@ -121,28 +122,15 @@ class SurveySection
   
   # Used to find questions for dependency linking 
   def find_question_by_reference(ref_id)
-    question = nil
-    count = 0
-    while question.nil? and count < questions.size
-      question = self.questions[count] if self.questions[count].reference_identifier == ref_id
-      count +=1
-    end
-    question
+    self.questions.detect{|q| q.reference_identifier == ref_id}
   end
   
+  def yml_attrs
+    instance_variables.sort - ["@parser", "@question_groups", "@questions", "@grid_answers", "@current_question_group", "@current_question", "@current_dependency"]
+  end
   def to_yml
-    out =[ %(#{@data_export_identifier}_#{@id}:) ]
-    out << %(  id: #{@id})
-    out << %(  survey_id: #{@survey_id})
-    out << %(  title: "#{@title}")
-    out << %(  description: "#{@description}")
-    out << %(  reference_identifier: "#{@reference_identifier}")
-    out << %(  data_export_identifier: "#{@data_export_identifier}")
-    out << %(  common_namespace: "#{@common_namespace}")
-    out << %(  common_identitier: "#{@common_identitier}")
-    out << %(  display_order: #{@display_order})
-    out << %(  custom_class: "#{@custom_class}")
-    
+    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")
   end
 

data/surveyor.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{surveyor}
-  s.version = "0.6.10"
+  s.version = "0.7.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{2009-10-16}
+  s.date = %q{2009-10-20}
   s.email = %q{yoon@northwestern.edu}
   s.extra_rdoc_files = [
     "README.md"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: surveyor
 version: !ruby/object:Gem::Version 
-  version: 0.6.10
+  version: 0.7.0
 platform: ruby
 authors: 
 - Brian Chamberlain
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-16 00:00:00 -05:00
+date: 2009-10-20 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency