surveyor 0.9.1 → 0.9.2

data/VERSION

@@ -1 +1 @@
-0.9.1
+0.9.2

data/lib/tasks/surveyor_tasks.rake

@@ -11,7 +11,7 @@ namespace :surveyor do
     raise "USAGE: file name required e.g. 'FILE=surveys/kitchen_sink_survey.rb'" if ENV["FILE"].blank?
     fixture_dir = File.join(RAILS_ROOT, "surveys", "fixtures")
     mkdir fixture_dir unless File.exists?(fixture_dir)
-    SurveyParser.parse(File.join(RAILS_ROOT, ENV["FILE"]))
+    SurveyParser::Parser.parse(File.join(RAILS_ROOT, ENV["FILE"]))
   end
 
   desc "load survey fixtures"

data/script/surveyor/answer.rb

@@ -1,52 +1,54 @@
-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
-  attr_accessor :validation
+module SurveyParser
+  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
+    attr_accessor :validation
 
-  def default_options
-    { :is_exclusive => false,
-      :hide_label => false,
-      :response_class => "answer"
-    }
-  end
+    def default_options
+      { :is_exclusive => false,
+        :hide_label => false,
+        :response_class => "answer"
+      }
+    end
   
-  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_args(nil)
+    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_args(nil)
+      end
     end
-  end
   
-  def text_args(text = "Answer")
-    {:text => text.to_s, :short_text => text, :data_export_identifier => Surveyor.to_normalized_string(text)}
-  end
-  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})
+    def text_args(text = "Answer")
+      {:text => text.to_s, :short_text => text, :data_export_identifier => Surveyor.to_normalized_string(text)}
+    end
+    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
+      super
+      if self.validation then self.validation.to_file end
     end
-  end
-  def to_file
-    super
-    if self.validation then self.validation.to_file end
-  end
   
+  end
 end

data/script/surveyor/base.rb

@@ -1,4 +1,4 @@
-class SurveyParser
+module SurveyParser
   class Base
     
     # Class level instance variable, because class variable are shared with subclasses
@@ -22,17 +22,17 @@ class SurveyParser
     # Instance methods
     def initialize(obj, args, opts)
       # inherit the parser from parent (obj)
-      self.parser = (obj.nil? ? nil : obj.class == SurveyParser ? obj : obj.parser)
+      self.parser = (obj.nil? ? nil : obj.class == SurveyParser::Parser ? obj : obj.parser)
       # get a new id from the parser
-      self.id = parser.nil? ? nil : parser.send("new_#{self.class.name.underscore}_id")
+      self.id = parser.nil? ? nil : parser.send("new_#{self.class.name.demodulize.underscore}_id")
       # set [parent]_id to obj.id, if we have that attribute
-      self.send("#{obj.class.name.underscore}_id=", obj.nil? ? nil : obj.id) if self.respond_to?("#{obj.class.name.underscore}_id=") 
+      self.send("#{obj.class.name.demodulize.underscore}_id=", obj.nil? ? nil : obj.id) if self.respond_to?("#{obj.class.name.demodulize.underscore}_id=") 
       # initialize descendant models
       self.class.children.each{|model| self.send("#{model}=", [])}
       # combine default options, parsed opts, parsed args, and initialize instance variables
       self.default_options.merge(parse_opts(opts)).merge(parse_args(args)).each{|k,v| self.send("#{k.to_s}=", v)}
       # print to the log
-      print "#{self.class.name.gsub(/[a-z]/, "")[-1,1]}#{self.id} "
+      print "#{self.class.name.demodulize.gsub(/[a-z]/, "")[-1,1]}#{self.id} "
     end
     def default_options
       {}
@@ -54,7 +54,7 @@ class SurveyParser
       (out << nil ).join("\r\n")
     end
     def to_file
-      File.open(self.parser.send("#{self.class.name.underscore.pluralize}_yml"), File::CREAT|File::APPEND|File::WRONLY) {|f| f << to_yml}
+      File.open(self.parser.send("#{self.class.name.demodulize.underscore.pluralize}_yml"), File::CREAT|File::APPEND|File::WRONLY) {|f| f << to_yml}
       self.class.children.each{|model| self.send(model).compact.map(&:to_file)}
     end
   end

data/script/surveyor/dependency.rb

@@ -1,11 +1,13 @@
-class Dependency < SurveyParser::Base
-  # Context, Conditional, Children
-  attr_accessor :id, :question_id, :question_group_id, :parser
-  attr_accessor :rule
-  has_children :dependency_conditions
+module SurveyParser
+  class Dependency < SurveyParser::Base
+    # Context, Conditional, Children
+    attr_accessor :id, :question_id, :question_group_id, :parser
+    attr_accessor :rule
+    has_children :dependency_conditions
 
-  def parse_opts(opts)
-    {} # toss the method name and reference identifier by default
-  end
+    def parse_opts(opts)
+      {} # toss the method name and reference identifier by default
+    end
 
+  end
 end

data/script/surveyor/dependency_condition.rb

@@ -1,38 +1,40 @@
-class DependencyCondition < SurveyParser::Base
+module SurveyParser
+  class DependencyCondition < SurveyParser::Base
 
-  # Context, Conditional, Value
-  attr_accessor :id, :dependency_id, :rule_key, :parser
-  attr_accessor :question_id, :operator
-  attr_accessor :answer_id, :datetime_value, :integer_value, :float_value, :unit, :text_value, :string_value, :response_other
-  attr_accessor :question_reference, :answer_reference
+    # Context, Conditional, Value
+    attr_accessor :id, :dependency_id, :rule_key, :parser
+    attr_accessor :question_id, :operator
+    attr_accessor :answer_id, :datetime_value, :integer_value, :float_value, :unit, :text_value, :string_value, :response_other
+    attr_accessor :question_reference, :answer_reference
   
-  def default_options
-    { :operator => "==" }
-  end
-  def parse_args(args)
-    a0, a1, a2 = args
-    {:question_reference => a0.to_s.gsub("q_", ""), :operator => a1}.merge(a2.is_a?(Hash) ? a2 : {:answer_reference => a2.to_s.gsub("a_", "")})
-  end
-  def parse_opts(opts)
-    {:rule_key => opts[:reference_identifier]}
-  end
+    def default_options
+      { :operator => "==" }
+    end
+    def parse_args(args)
+      a0, a1, a2 = args
+      {:question_reference => a0.to_s.gsub("q_", ""), :operator => a1}.merge(a2.is_a?(Hash) ? a2 : {:answer_reference => a2.to_s.gsub("a_", "")})
+    end
+    def parse_opts(opts)
+      {:rule_key => opts[:reference_identifier]}
+    end
   
-  def reconcile_dependencies
-    # Looking up references to questions and answers for linking the dependency objects
-    print "Lookup Q ref #{@question_reference}:"
-    if (ref_question = parser.current_survey.find_question_by_reference(@question_reference))
-      print " found Q#{ref_question.id} "
-      @question_id = ref_question.id
-      print "Lookup A ref #{@answer_reference}"
-      if (ref_answer = ref_question.find_answer_by_reference(@answer_reference))
-        print " found A#{ref_answer.id} "
-        @answer_id = ref_answer.id
+    def reconcile_dependencies
+      # Looking up references to questions and answers for linking the dependency objects
+      print "Lookup Q ref #{@question_reference}:"
+      if (ref_question = parser.current_survey.find_question_by_reference(@question_reference))
+        print " found Q#{ref_question.id} "
+        @question_id = ref_question.id
+        print "Lookup A ref #{@answer_reference}"
+        if (ref_answer = ref_question.find_answer_by_reference(@answer_reference))
+          print " found A#{ref_answer.id} "
+          @answer_id = ref_answer.id
+        else
+          raise "Could not find referenced answer #{@answer_reference}"
+        end
       else
-        raise "Could not find referenced answer #{@answer_reference}"
+        raise "Could not find referenced question #{@question_reference}"
       end
-    else
-      raise "Could not find referenced question #{@question_reference}"
     end
-  end
 
+  end
 end

data/script/surveyor/parser.rb

@@ -0,0 +1,187 @@
+require 'activesupport' # for pluralize, humanize in ActiveSupport::CoreExtensions::String::Inflections
+module SurveyParser
+  class Parser
+    @@models = %w(survey survey_section question_group question answer dependency dependency_condition validation validation_condition)
+  
+    # Require base and all models
+    (%w(base) + @@models).each{|m| require File.dirname(__FILE__) + "/#{m}"}
+
+    # Attributes
+    attr_accessor :surveys, :grid_answers
+    @@models.each{|m| attr_accessor "#{m.pluralize}_yml".to_sym } # for fixtures
+    (@@models - %w(dependency_condition validation_condition)).each {|m| attr_accessor "current_#{m}".to_sym} # for current_model caches
+  
+    # Class methods
+    def self.parse(file_name)
+      self.define_counter_methods(@@models)
+      puts "\n--- Parsing '#{file_name}' ---"
+      parser = SurveyParser::Parser.new
+      parser.instance_eval(File.read(file_name))
+      parser.to_files
+      puts "--- End of parsing ---\n\n"
+    end
+
+    # new_survey_id, new_survey_section_id, etc.
+    def self.define_counter_methods(names)
+      names.each do |name|
+        define_method("new_#{name}_id") do
+          instance_variable_set("@last_#{name}_id", instance_variable_get("@last_#{name}_id") + 1)
+        end
+      end
+    end
+  
+    # Instance methods
+    def initialize
+      self.surveys = []
+      self.grid_answers = []
+      initialize_counters(@@models)
+      initialize_fixtures(@@models.map(&:pluralize), File.join(RAILS_ROOT, "surveys", "fixtures"))
+    end
+  
+    # @last_survey_id, @last_survey_section_id, etc.
+    def initialize_counters(names)
+      names.each{|name| instance_variable_set("@last_#{name}_id", 0)}
+    end
+
+    # @surveys_yml, @survey_sections_yml, etc.
+    def initialize_fixtures(names, path)
+      names.each {|name| file = instance_variable_set("@#{name}_yml", "#{path}/#{name}.yml"); File.truncate(file, 0) if File.exist?(file) }
+    end
+
+    # This method_missing does all the heavy lifting for the DSL
+    def method_missing(missing_method, *args, &block)
+      method_name, reference_identifier = missing_method.to_s.split("_", 2)
+      opts = {:method_name => method_name, :reference_identifier => reference_identifier}
+      case method_name
+      when "survey"
+        self.current_survey = Survey.new(self, args, opts)
+        evaluate_the "survey", &block
+    
+      when "section"
+        self.current_survey_section = SurveySection.new(self.current_survey, args, opts.merge({:display_order => current_survey.survey_sections.size + 1}))
+        evaluate_the "survey_section", &block
+      
+      when "group", "g", "grid", "repeater"
+        self.current_question_group = QuestionGroup.new(self.current_survey_section, args, opts)
+        evaluate_the "question_group", &block
+      
+      when "question", "q", "label", "image"
+        drop_the &block
+        self.current_question = Question.new(self.current_survey_section, args, opts.merge(:question_group_id => current_question_group ? current_question_group.id : nil))
+        add_grid_answers if in_a_grid?
+      
+      when "dependency", "d"
+        drop_the &block
+        self.current_dependency = Dependency.new(self.current_question_group || current_question, args, opts)
+      
+      when "condition", "c"
+        drop_the &block
+        raise "Error: No current dependency or validation for this condition" if self.current_dependency.nil? && self.current_validation.nil?
+        if self.current_dependency.nil?
+          self.current_validation.validation_conditions << ValidationCondition.new(self.current_validation, args, opts)
+        else
+          self.current_dependency.dependency_conditions << DependencyCondition.new(self.current_dependency, args, opts)
+        end
+      
+      when "answer", "a"
+        drop_the &block
+        if in_a_grid?
+          self.grid_answers << Answer.new(nil, args, opts.merge(:display_order => grid_answers.size + 1))
+        else
+          raise "Error: No current question" if self.current_question.nil?
+          self.current_answer = Answer.new(self.current_question, args, opts.merge(:display_order => current_question.answers.size + 1))
+        end
+    
+      when "validation", "v"
+        drop_the &block
+        self.current_validation = Validation.new(self.current_answer, args, opts)
+
+      else
+        raise "  ERROR: '#{missing_method}' not valid method"
+    
+      end
+    end
+
+    def drop_the(&block)
+      raise "Error, I'm dropping the block like it's hot" if block_given?
+    end
+  
+    def evaluate_the(model, &block)
+      raise "Error: A #{model.humanize} cannot be empty" unless block_given?
+      self.instance_eval(&block)
+      self.send("clear_current", model)
+    end
+  
+    def clear_current(model)
+      # puts "clear_current #{model}"
+      case model
+      when "survey"
+        self.current_survey.reconcile_dependencies unless current_survey.nil?
+      when "question_group"
+        self.grid_answers = []
+        clear_current("question")
+      when "question"
+        @current_dependency = nil
+      when "answer"
+        @current_validation = nil
+      end
+      instance_variable_set("@current_#{model}", nil)
+      "SurveyParser::#{model.classify}".constantize.send(:children).each{|m| clear_current(m.to_s.singularize)}
+    end
+  
+    def current_survey=(s)
+      clear_current "survey"
+      self.surveys << s
+      @current_survey = s
+    end
+    def current_survey_section=(s)
+      clear_current "survey_section"
+      self.current_survey.survey_sections << s
+      @current_survey_section = s 
+    end
+    def current_question_group=(g)
+      clear_current "question_group"
+      self.current_survey_section.question_groups << g
+      @current_question_group = g
+    end  
+    def current_question=(q)
+      clear_current "question"
+      self.current_survey_section.questions << q
+      @current_question = q
+    end
+    def current_dependency=(d)
+      raise "Error: No question or question group" unless (dependent = self.current_question_group || self.current_question)
+      dependent.dependency = d
+      @current_dependency = d
+    end
+    def current_answer=(a)
+      raise "Error: No current question" if self.current_question.nil?
+      self.current_question.answers << a
+      @current_answer = a
+    end  
+    def current_validation=(v)
+      clear_current "validation"
+      self.current_answer.validation = v
+      @current_validation = v
+    end
+
+    def in_a_grid?
+      self.current_question_group and self.current_question_group.display_type == "grid"
+    end
+  
+    def add_grid_answers
+      self.grid_answers.each do |grid_answer|
+        my_answer = grid_answer.dup
+        my_answer.id = new_answer_id
+        my_answer.question_id = self.current_question.id
+        my_answer.parser = self
+        self.current_answer = my_answer
+      end
+    end
+
+    def to_files
+      self.surveys.compact.map(&:to_file)
+    end
+
+  end
+end

data/script/surveyor/question.rb

@@ -1,34 +1,36 @@
-class Question < SurveyParser::Base
-  # Context, Content, Reference, Display, Children
-  attr_accessor :id, :parser, :survey_section_id, :question_group_id
-  attr_accessor :text, :short_text, :help_text, :pick
-  attr_accessor :reference_identifier, :data_export_identifier, :common_namespace, :common_identifier
-  attr_accessor :display_order, :display_type, :is_mandatory, :display_width, :custom_class, :custom_renderer
-  attr_accessor :dependency
-  has_children :answers
+module SurveyParser
+  class Question < SurveyParser::Base
+    # Context, Content, Reference, Display, Children
+    attr_accessor :id, :parser, :survey_section_id, :question_group_id
+    attr_accessor :text, :short_text, :help_text, :pick
+    attr_accessor :reference_identifier, :data_export_identifier, :common_namespace, :common_identifier
+    attr_accessor :display_order, :display_type, :is_mandatory, :display_width, :custom_class, :custom_renderer
+    attr_accessor :dependency
+    has_children :answers
 
-  def default_options
-    { :pick => :none,
-      :display_type => :default,
-      :is_mandatory => true,
-      :display_order => self.id
-    }
-  end
-  def parse_opts(opts)
-    (name = opts.delete(:method_name)) =~ /label|image/ ? opts.merge(:display_type => name) : opts
-  end
-  def parse_args(args)
-    text = args[0] || "Question"
-    {:text => text, :short_text => text, :data_export_identifier => Surveyor.to_normalized_string(text)}.merge(args[1] || {})
-  end
+    def default_options
+      { :pick => :none,
+        :display_type => :default,
+        :is_mandatory => true,
+        :display_order => self.id
+      }
+    end
+    def parse_opts(opts)
+      (name = opts.delete(:method_name)) =~ /label|image/ ? opts.merge(:display_type => name) : opts
+    end
+    def parse_args(args)
+      text = args[0] || "Question"
+      {:text => text, :short_text => text, :data_export_identifier => Surveyor.to_normalized_string(text)}.merge(args[1] || {})
+    end
   
-  def find_answer_by_reference(ref_id)
-    self.answers.detect{|a| a.reference_identifier == ref_id}
-  end
+    def find_answer_by_reference(ref_id)
+      self.answers.detect{|a| a.reference_identifier == ref_id}
+    end
 
-  def to_file
-    super
-    if self.dependency then self.dependency.to_file end
-  end
+    def to_file
+      super
+      if self.dependency then self.dependency.to_file end
+    end
 
+  end
 end

data/script/surveyor/question_group.rb

@@ -1,24 +1,26 @@
-class QuestionGroup < SurveyParser::Base
-  # 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
+module SurveyParser
+  class QuestionGroup < SurveyParser::Base
+    # 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
 
-  def default_options
-    {:display_type => "default"}
-  end
-  def parse_args(args)
-    {:text => args[0] || "Question Group"}.merge(args[1] || {})
-  end
-  def parse_opts(opts)
-    (name = opts.delete(:method_name)) =~ /grid|repeater/ ? opts.merge(:display_type => name) : opts
-  end
+    def default_options
+      {:display_type => "default"}
+    end
+    def parse_args(args)
+      {:text => args[0] || "Question Group"}.merge(args[1] || {})
+    end
+    def parse_opts(opts)
+      (name = opts.delete(:method_name)) =~ /grid|repeater/ ? opts.merge(:display_type => name) : opts
+    end
 
-  def to_file
-    super
-    if self.dependency then self.dependency.to_file end
-  end
+    def to_file
+      super
+      if self.dependency then self.dependency.to_file end
+    end
 
+  end
 end

data/script/surveyor/specs/answer_spec.rb

@@ -1,13 +1,13 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require 'answer'
 
-describe Answer, " when first created" do
+describe SurveyParser::Answer, " when first created" do
 
   before(:each) do
-    question = mock("Question", :id => 2, :parser => mock("Parser", :new_answer_id => 1))
-    question.stub!(:class => Question)
+    question = mock("Question", :id => 2, :parser => mock("SurveyParser::Parser", :new_answer_id => 1))
+    question.stub!(:class => SurveyParser::Question)
     options = {:help_text => "Never or rarely ever", :reference_identifier => "b3a_1"}
-    @ans = Answer.new(question, ["No / Rarely"], options)
+    @ans = SurveyParser::Answer.new(question, ["No / Rarely"], options)
   end
   
   it "should set inititalized variables to those passed in" do

data/script/surveyor/specs/question_spec.rb

@@ -1,13 +1,13 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require 'question'
 
-describe Question, " when first created" do
+describe SurveyParser::Question, " when first created" do
   before do    
-    section = mock("SurveySection", :id => 2, :parser => mock("Parser", :new_question_id => 1))
-    section.stub!(:class => SurveySection)
+    section = mock("SurveyParser::SurveySection", :id => 2, :parser => mock("SurveyParser::Parser", :new_question_id => 1))
+    section.stub!(:class => SurveyParser::SurveySection)
     args = {:help_text => "Please give a rough estimate", :reference_identifier => "B3"}
     options = {}
-    @ques = Question.new(section, ["In the past 12 months how many times have you been to a doctor?", args], options)
+    @ques = SurveyParser::Question.new(section, ["In the past 12 months how many times have you been to a doctor?", args], options)
   end
   
   it "should set initialization parameters properly" do
@@ -39,15 +39,15 @@ describe Question, " when first created" do
 
 end
 
-describe Question, "when it contains data" do
+describe SurveyParser::Question, "when it contains data" do
   before(:each) do
-    section = mock("SurveySection", :id => 2, :parser => mock("Parser", :new_question_id => 1))
+    section = mock("SurveyParser::SurveySection", :id => 2, :parser => mock("SurveyParser::Parser", :new_question_id => 1))
     args = {:help_text => "Please give a rough estimate", :reference_identifier => "B3"}
     options = {}
-    @ques = Question.new(section, ["In the past 12 months how many times have you been to a doctor?", args], options)
-    @ques.answers << mock("Answer", :reference_identifier => "1", :text => "foo")
-    @ques.answers << mock("Answer", :reference_identifier => "2", :text => "foo")
-    @ques.answers << mock("Answer", :reference_identifier => "3", :text => "foo")
+    @ques = SurveyParser::Question.new(section, ["In the past 12 months how many times have you been to a doctor?", args], options)
+    @ques.answers << mock("SurveyParser::Answer", :reference_identifier => "1", :text => "foo")
+    @ques.answers << mock("SurveyParser::Answer", :reference_identifier => "2", :text => "foo")
+    @ques.answers << mock("SurveyParser::Answer", :reference_identifier => "3", :text => "foo")
   end
 
   it "should have added the test answers correctly" do

data/script/surveyor/specs/spec_helper.rb

@@ -1,5 +1,6 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..'))
 require File.expand_path(File.dirname(__FILE__) + "/../../../lib/surveyor")
+require File.expand_path(File.dirname(__FILE__) + "/../parser")
 require File.expand_path(File.dirname(__FILE__) + "/../base")
 
 Spec::Runner.configure do |config|

data/script/surveyor/specs/survey_section_spec.rb

@@ -1,10 +1,10 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require 'survey_section'
 
-describe SurveySection, "when first created" do
+describe SurveyParser::SurveySection, "when first created" do
 
   before(:each) do
-    @section = SurveySection.new(mock("Survey", :id => 2, :parser => mock("Parser", :new_survey_section_id => 1)), ["Demographics"], {})
+    @section = SurveyParser::SurveySection.new(mock("SurveyParser::Survey", :id => 2, :parser => mock("SurveyParser::Parser", :new_survey_section_id => 1)), ["Demographics"], {})
   end
   
   it "should generate a data export identifier" do
@@ -12,9 +12,9 @@ describe SurveySection, "when first created" do
   end
   
   it "should find a question by reference" do
-    @section.questions << mock("Question", :reference_identifier => "1", :text => "foo")
-    @section.questions << mock("Question", :reference_identifier => "2", :text => "foo")
-    @section.questions << mock("Question", :reference_identifier => "3", :text => "foo")
+    @section.questions << mock("SurveyParser::Question", :reference_identifier => "1", :text => "foo")
+    @section.questions << mock("SurveyParser::Question", :reference_identifier => "2", :text => "foo")
+    @section.questions << mock("SurveyParser::Question", :reference_identifier => "3", :text => "foo")
     
     q = @section.find_question_by_reference("2")
     q.should_not be_nil

data/script/surveyor/specs/validation_condition_spec.rb

@@ -1,13 +1,13 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require 'validation_condition'
 
-describe ValidationCondition, " when first created" do
+describe SurveyParser::ValidationCondition, " when first created" do
   before do    
-    validation = mock("Validation", :id => 29, :parser => mock("Parser", :new_validation_condition_id => 21))
-    validation.stub!(:class => Validation)
+    validation = mock("SurveyParser::Validation", :id => 29, :parser => mock("SurveyParser::Parser", :new_validation_condition_id => 21))
+    validation.stub!(:class => SurveyParser::Validation)
     args = [">=", {:integer_value => 0}]
     options = {}
-    @validation_condition = ValidationCondition.new(validation, args, options)
+    @validation_condition = SurveyParser::ValidationCondition.new(validation, args, options)
   end
   
   it "should set initialization parameters properly" do

data/script/surveyor/specs/validation_spec.rb

@@ -1,13 +1,13 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 require 'validation'
 
-describe Validation, " when first created" do
+describe SurveyParser::Validation, " when first created" do
   before do    
-    answer = mock("Answer", :id => 2, :parser => mock("Parser", :new_validation_id => 1))
-    answer.stub!(:class => Answer)
+    answer = mock("SurveyParser::Answer", :id => 2, :parser => mock("SurveyParser::Parser", :new_validation_id => 1))
+    answer.stub!(:class => SurveyParser::Answer)
     args = [{:rule => "C", :message => "Please select a number between 0 and 120"}]
     options = {}
-    @validation = Validation.new(answer, args, options)
+    @validation = SurveyParser::Validation.new(answer, args, options)
   end
   
   it "should set initialization parameters properly" do

data/script/surveyor/survey.rb

@@ -1,32 +1,34 @@
-class Survey < SurveyParser::Base
-  # Context, Content, Reference, Expiry, Display
-  attr_accessor :id, :parser
-  attr_accessor :title, :description
-  attr_accessor :access_code, :reference_identifier, :data_export_identifier, :common_namespace, :common_identitier
-  attr_accessor :active_at, :inactive_at
-  attr_accessor :css_url, :custom_class
-  has_children :survey_sections
+module SurveyParser
+  class Survey < SurveyParser::Base
+    # Context, Content, Reference, Expiry, Display
+    attr_accessor :id, :parser
+    attr_accessor :title, :description
+    attr_accessor :access_code, :reference_identifier, :data_export_identifier, :common_namespace, :common_identitier
+    attr_accessor :active_at, :inactive_at
+    attr_accessor :css_url, :custom_class
+    has_children :survey_sections
   
-  def parse_args(args)
-    title = args[0]
-    {:title => title, :access_code => Surveyor.to_normalized_string(title)}.merge(args[1] || {})
-  end
+    def parse_args(args)
+      title = args[0]
+      {:title => title, :access_code => Surveyor.to_normalized_string(title)}.merge(args[1] || {})
+    end
 
-  def find_question_by_reference(ref_id)
-    found = nil
-    survey_sections.detect{|s| found = s.find_question_by_reference(ref_id)}
-    return found
-  end
+    def find_question_by_reference(ref_id)
+      found = nil
+      survey_sections.detect{|s| found = s.find_question_by_reference(ref_id)}
+      return found
+    end
   
-  def reconcile_dependencies
-    survey_sections.each do |section|
-      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
+    def reconcile_dependencies
+      survey_sections.each do |section|
+        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
 
+  end
 end

data/script/surveyor/survey_section.rb

@@ -1,19 +1,21 @@
-class SurveySection < SurveyParser::Base
-  # Context, Content, Display, Reference, Children, Placeholders
-  attr_accessor :id, :parser, :survey_id
-  attr_accessor :title, :description
-  attr_accessor :reference_identifier, :data_export_identifier, :common_namespace, :common_identitier
-  attr_accessor :display_order, :custom_class
-  has_children :question_groups, :questions
+module SurveyParser
+  class SurveySection < SurveyParser::Base
+    # Context, Content, Display, Reference, Children, Placeholders
+    attr_accessor :id, :parser, :survey_id
+    attr_accessor :title, :description
+    attr_accessor :reference_identifier, :data_export_identifier, :common_namespace, :common_identitier
+    attr_accessor :display_order, :custom_class
+    has_children :question_groups, :questions
 
-  def parse_args(args)
-    title = args[0]
-    {:title => title, :data_export_identifier => Surveyor.to_normalized_string(title)}.merge(args[1] || {})
-  end
+    def parse_args(args)
+      title = args[0]
+      {:title => title, :data_export_identifier => Surveyor.to_normalized_string(title)}.merge(args[1] || {})
+    end
 
-  # Used to find questions for dependency linking
-  def find_question_by_reference(ref_id)
-    self.questions.detect{|q| q.reference_identifier == ref_id}
-  end
+    # Used to find questions for dependency linking
+    def find_question_by_reference(ref_id)
+      self.questions.detect{|q| q.reference_identifier == ref_id}
+    end
   
+  end
 end

data/script/surveyor/validation.rb

@@ -1,19 +1,21 @@
-class Validation < SurveyParser::Base
+module SurveyParser
+  class Validation < SurveyParser::Base
   
-  # Context, Conditional, Children
-  attr_accessor :id, :answer_id, :parser
-  attr_accessor :rule, :message
-  has_children :validation_conditions
+    # Context, Conditional, Children
+    attr_accessor :id, :answer_id, :parser
+    attr_accessor :rule, :message
+    has_children :validation_conditions
   
   
-  def default_options
-    {:rule => "A"}
-  end
-  def parse_args(args)
-    args[0] || {}
-  end
-  def parse_opts(opts)
-    {} # toss the method name and reference identifier by default
-  end
+    def default_options
+      {:rule => "A"}
+    end
+    def parse_args(args)
+      args[0] || {}
+    end
+    def parse_opts(opts)
+      {} # toss the method name and reference identifier by default
+    end
     
+  end
 end

data/script/surveyor/validation_condition.rb

@@ -1,19 +1,21 @@
-class ValidationCondition < SurveyParser::Base
-  # Context, Conditional, Value, Reference
-  attr_accessor :id, :validation_id, :rule_key, :parser
-  attr_accessor :operator
-  attr_accessor :question_id, :answer_id, :datetime_value, :integer_value, :float_value, :unit, :text_value, :string_value, :response_other, :regexp
-  attr_accessor :question_reference, :answer_reference
+module SurveyParser
+  class ValidationCondition < SurveyParser::Base
+    # Context, Conditional, Value, Reference
+    attr_accessor :id, :validation_id, :rule_key, :parser
+    attr_accessor :operator
+    attr_accessor :question_id, :answer_id, :datetime_value, :integer_value, :float_value, :unit, :text_value, :string_value, :response_other, :regexp
+    attr_accessor :question_reference, :answer_reference
   
-  def default_options
-    { :operator => "==" }
-  end
-  def parse_args(args)
-    a0, a1 = args
-    {:operator => a0}.merge(a1 || {})
-  end
-  def parse_opts(opts)
-    {:rule_key => opts[:reference_identifier]}
-  end
+    def default_options
+      { :operator => "==" }
+    end
+    def parse_args(args)
+      a0, a1 = args
+      {:operator => a0}.merge(a1 || {})
+    end
+    def parse_opts(opts)
+      {:rule_key => opts[:reference_identifier]}
+    end
     
+  end
 end

data/spec/factories.rb

@@ -98,7 +98,7 @@ end
 Factory.define :response_set do |r|
   r.user_id	        {}
   r.association     :survey # r.survey_id       {}
-  r.access_code	    {ResponseSet.make_tiny_code}
+  r.access_code	    {Surveyor.make_tiny_code}
   r.started_at	    {Time.now}
   r.completed_at		{}
 end

data/surveyor.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{surveyor}
-  s.version = "0.9.1"
+  s.version = "0.9.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Chamberlain", "Mark Yoon"]
@@ -137,6 +137,7 @@ Gem::Specification.new do |s|
      "script/surveyor/base.rb",
      "script/surveyor/dependency.rb",
      "script/surveyor/dependency_condition.rb",
+     "script/surveyor/parser.rb",
      "script/surveyor/question.rb",
      "script/surveyor/question_group.rb",
      "script/surveyor/specs/answer_spec.rb",
@@ -146,7 +147,6 @@ Gem::Specification.new do |s|
      "script/surveyor/specs/validation_condition_spec.rb",
      "script/surveyor/specs/validation_spec.rb",
      "script/surveyor/survey.rb",
-     "script/surveyor/survey_parser.rb",
      "script/surveyor/survey_section.rb",
      "script/surveyor/validation.rb",
      "script/surveyor/validation_condition.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: surveyor
 version: !ruby/object:Gem::Version 
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors: 
 - Brian Chamberlain
@@ -154,6 +154,7 @@ files:
 - script/surveyor/base.rb
 - script/surveyor/dependency.rb
 - script/surveyor/dependency_condition.rb
+- script/surveyor/parser.rb
 - script/surveyor/question.rb
 - script/surveyor/question_group.rb
 - script/surveyor/specs/answer_spec.rb
@@ -163,7 +164,6 @@ files:
 - script/surveyor/specs/validation_condition_spec.rb
 - script/surveyor/specs/validation_spec.rb
 - script/surveyor/survey.rb
-- script/surveyor/survey_parser.rb
 - script/surveyor/survey_section.rb
 - script/surveyor/validation.rb
 - script/surveyor/validation_condition.rb

data/script/surveyor/survey_parser.rb

@@ -1,186 +0,0 @@
-require 'activesupport' # for pluralize, humanize in ActiveSupport::CoreExtensions::String::Inflections
-
-class SurveyParser
-  @@models = %w(survey survey_section question_group question answer dependency dependency_condition validation validation_condition)
-  
-  # Require base and all models
-  (%w(base) + @@models).each{|m| require File.dirname(__FILE__) + "/#{m}"}
-
-  # Attributes
-  attr_accessor :surveys, :grid_answers
-  @@models.each{|m| attr_accessor "#{m.pluralize}_yml".to_sym } # for fixtures
-  (@@models - %w(dependency_condition validation_condition)).each {|m| attr_accessor "current_#{m}".to_sym} # for current_model caches
-  
-  # Class methods
-  def self.parse(file_name)
-    self.define_counter_methods(@@models)
-    puts "\n--- Parsing '#{file_name}' ---"
-    parser = SurveyParser.new
-    parser.instance_eval(File.read(file_name))
-    parser.to_files
-    puts "--- End of parsing ---\n\n"
-  end
-
-  # new_survey_id, new_survey_section_id, etc.
-  def self.define_counter_methods(names)
-    names.each do |name|
-      define_method("new_#{name}_id") do
-        instance_variable_set("@last_#{name}_id", instance_variable_get("@last_#{name}_id") + 1)
-      end
-    end
-  end
-  
-  # Instance methods
-  def initialize
-    self.surveys = []
-    self.grid_answers = []
-    initialize_counters(@@models)
-    initialize_fixtures(@@models.map(&:pluralize), File.join(RAILS_ROOT, "surveys", "fixtures"))
-  end
-  
-  # @last_survey_id, @last_survey_section_id, etc.
-  def initialize_counters(names)
-    names.each{|name| instance_variable_set("@last_#{name}_id", 0)}
-  end
-
-  # @surveys_yml, @survey_sections_yml, etc.
-  def initialize_fixtures(names, path)
-    names.each {|name| file = instance_variable_set("@#{name}_yml", "#{path}/#{name}.yml"); File.truncate(file, 0) if File.exist?(file) }
-  end
-
-  # This method_missing does all the heavy lifting for the DSL
-  def method_missing(missing_method, *args, &block)
-    method_name, reference_identifier = missing_method.to_s.split("_", 2)
-    opts = {:method_name => method_name, :reference_identifier => reference_identifier}
-    case method_name
-    when "survey"
-      self.current_survey = Survey.new(self, args, opts)
-      evaluate_the "survey", &block
-    
-    when "section"
-      self.current_survey_section = SurveySection.new(self.current_survey, args, opts.merge({:display_order => current_survey.survey_sections.size + 1}))
-      evaluate_the "survey_section", &block
-      
-    when "group", "g", "grid", "repeater"
-      self.current_question_group = QuestionGroup.new(self.current_survey_section, args, opts)
-      evaluate_the "question_group", &block
-      
-    when "question", "q", "label", "image"
-      drop_the &block
-      self.current_question = Question.new(self.current_survey_section, args, opts.merge(:question_group_id => current_question_group ? current_question_group.id : nil))
-      add_grid_answers if in_a_grid?
-      
-    when "dependency", "d"
-      drop_the &block
-      self.current_dependency = Dependency.new(self.current_question_group || current_question, args, opts)
-      
-    when "condition", "c"
-      drop_the &block
-      raise "Error: No current dependency or validation for this condition" if self.current_dependency.nil? && self.current_validation.nil?
-      if self.current_dependency.nil?
-        self.current_validation.validation_conditions << ValidationCondition.new(self.current_validation, args, opts)
-      else
-        self.current_dependency.dependency_conditions << DependencyCondition.new(self.current_dependency, args, opts)
-      end
-      
-    when "answer", "a"
-      drop_the &block
-      if in_a_grid?
-        self.grid_answers << Answer.new(nil, args, opts.merge(:display_order => grid_answers.size + 1))
-      else
-        raise "Error: No current question" if self.current_question.nil?
-        self.current_answer = Answer.new(self.current_question, args, opts.merge(:display_order => current_question.answers.size + 1))
-      end
-    
-    when "validation", "v"
-      drop_the &block
-      self.current_validation = Validation.new(self.current_answer, args, opts)
-
-    else
-      raise "  ERROR: '#{missing_method}' not valid method"
-    
-    end
-  end
-
-  def drop_the(&block)
-    raise "Error, I'm dropping the block like it's hot" if block_given?
-  end
-  
-  def evaluate_the(model, &block)
-    raise "Error: A #{model.humanize} cannot be empty" unless block_given?
-    self.instance_eval(&block)
-    self.send("clear_current", model)
-  end
-  
-  def clear_current(model)
-    # puts "clear_current #{model}"
-    case model
-    when "survey"
-      self.current_survey.reconcile_dependencies unless current_survey.nil?
-    when "question_group"
-      self.grid_answers = []
-      clear_current("question")
-    when "question"
-      @current_dependency = nil
-    when "answer"
-      @current_validation = nil
-    end
-    instance_variable_set("@current_#{model}", nil)
-    model.classify.constantize.send(:children).each{|m| clear_current(m.to_s.singularize)}
-  end
-  
-  def current_survey=(s)
-    clear_current "survey"
-    self.surveys << s
-    @current_survey = s
-  end
-  def current_survey_section=(s)
-    clear_current "survey_section"
-    self.current_survey.survey_sections << s
-    @current_survey_section = s 
-  end
-  def current_question_group=(g)
-    clear_current "question_group"
-    self.current_survey_section.question_groups << g
-    @current_question_group = g
-  end  
-  def current_question=(q)
-    clear_current "question"
-    self.current_survey_section.questions << q
-    @current_question = q
-  end
-  def current_dependency=(d)
-    raise "Error: No question or question group" unless (dependent = self.current_question_group || self.current_question)
-    dependent.dependency = d
-    @current_dependency = d
-  end
-  def current_answer=(a)
-    raise "Error: No current question" if self.current_question.nil?
-    self.current_question.answers << a
-    @current_answer = a
-  end  
-  def current_validation=(v)
-    clear_current "validation"
-    self.current_answer.validation = v
-    @current_validation = v
-  end
-
-  def in_a_grid?
-    self.current_question_group and self.current_question_group.display_type == "grid"
-  end
-  
-  def add_grid_answers
-    self.grid_answers.each do |grid_answer|
-      my_answer = grid_answer.dup
-      my_answer.id = new_answer_id
-      my_answer.question_id = self.current_question.id
-      my_answer.parser = self
-      self.current_answer = my_answer
-    end
-  end
-
-  def to_files
-    self.surveys.compact.map(&:to_file)
-  end
-
-end