surveyor 0.14.5 → 0.15.0

data/script/surveyor/parser.rb

@@ -1,223 +0,0 @@
-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 :salt, :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.salt = Time.now.strftime("%Y%m%d%H%M%S")
-      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 "correct"
-        drop_the &block
-        raise "Error: No current question" if self.current_question.nil?
-        self.current_correct_answer = self.current_question.find_current_answers(args)
-    
-      when "validation", "v"
-        drop_the &block
-        self.current_validation = Validation.new(self.current_answer, args, opts)
-
-
-      # explicitly define a dependency condition
-      # (not really necessary as is default)
-      when "dependencycondition", "dcondition", "dc"
-        drop_the &block
-        raise "Error: No current dependency for this condition" if self.current_dependency.nil?
-        self.current_dependency.dependency_conditions << DependencyCondition.new(self.current_dependency, args, opts)
-
-      # explicitly define a validation condition
-      # (is necessary if want dependency AND validation on
-      #  same question as dependency existance would try to
-      #  make the condition a dependency condition.)
-      when "validationcondition", "vcondition", "vc"
-        drop_the &block
-        raise "Error: No current validation for this condition" if self.current_validation.nil?
-        self.current_validation.validation_conditions << ValidationCondition.new(self.current_validation, 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_correct_answer=(a)
-      raise "Error: No current question" if self.current_question.nil?
-      self.current_question.correct_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,59 +0,0 @@
-module SurveyParser
-  class Question < SurveyParser::Base
-    ANSWER_ID = /\s*\w+_/ unless defined?(ANSWER_ID)
-    
-    # Context, Content, Reference, Display, Children
-    attr_accessor :id, :parser, :survey_section_id, :question_group_id, :correct_answer_id
-    attr_accessor :text, :short_text, :help_text, :pick, :answer_id
-    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::Common.to_normalized_string(text)}.merge(args[1] || {})
-    end
-    
-    def correct_answer=(a)
-      self.answer_id = a.id
-    end
-  
-    def find_answer_by_reference(ref_id)
-      self.answers.detect{|a| a.reference_identifier == ref_id}
-    end
-    
-    # currently, only one correct answer is allowed
-    def find_current_answers(args)
-      ref_ids = args[0][:answer]
-      ids = ref_ids.to_s.split(ANSWER_ID).compact
-      self.answers.select{|a| ids.include?(a.reference_identifier)}.first
-    end
-    
-    # so we can build the correct yaml structure
-    def property_name_map(property)
-      names = {
-        "answer" => "correct_answer"
-      }
-      return names.has_key?(property) ? names[property] : property
-    end
-
-    def to_file
-      super
-      if self.dependency then self.dependency.to_file end
-    end
-
-  end
-end

data/script/surveyor/question_group.rb

@@ -1,26 +0,0 @@
-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 to_file
-      super
-      if self.dependency then self.dependency.to_file end
-    end
-
-  end
-end

data/script/surveyor/specs/answer_spec.rb

@@ -1,29 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-require 'answer'
-
-describe SurveyParser::Answer, " when first created" do
-
-  before(:each) do
-    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 = SurveyParser::Answer.new(question, ["No / Rarely"], options)
-  end
-  
-  it "should set inititalized variables to those passed in" do
-    @ans.id.should == 1
-    @ans.question_id.should == 2
-    @ans.reference_identifier.should == "b3a_1"
-    @ans.text.should == "No / Rarely"
-    @ans.help_text.should == "Never or rarely ever"
-  end
-  
-  it "should output current state to yml" do
-     @ans.should.respond_to?(:to_yml)
-  end
-
-  it "should create a normalized code automatically when initalized" do
-    @ans.data_export_identifier.should eql("no_rarely")
-  end
-  
-end

data/script/surveyor/specs/question_spec.rb

@@ -1,63 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-require 'question'
-
-describe SurveyParser::Question, " when first created" do
-  before do    
-    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 = 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
-    @ques.id.should == 1
-    @ques.reference_identifier.should == "B3"
-    @ques.survey_section_id.should == 2
-    @ques.help_text.should == "Please give a rough estimate"
-    
-    #Checking the defaults
-    @ques.pick.should == :none
-    @ques.display_type.should == :default
-    @ques.is_mandatory.should == true
-  end
-
-  it "should output current state to yml" do
-     @ques.should.respond_to?(:to_yml)
-  end
-
-  it "should create a normalized code automatically when initalized" do
-    @ques.data_export_identifier.should eql("many_times_you_been_doctor")
-  end
-  
-  # We don't change titles via the DSL
-  # it "should update the normalized code if the title is changed" do
-  #   @ques.data_export_identifier.should == "many_times_you_been_doctor"
-  #   @ques.text = "Sometimes or All the time?"
-  #   @ques.data_export_identifier.should == "sometimes_all_time"
-  # end
-
-end
-
-describe SurveyParser::Question, "when it contains data" do
-  before(:each) do
-    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 = 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
-    @ques.answers.length.should eql(3)
-  end
-  
-  it "should find an answer by reference" do
-    a_to_find = @ques.find_answer_by_reference("2")
-    a_to_find.should_not be_nil
-    a_to_find.reference_identifier.should eql("2")
-  end
-  
-end

data/script/surveyor/specs/spec_helper.rb

@@ -1,7 +0,0 @@
-$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|
-end

data/script/surveyor/specs/survey_section_spec.rb

@@ -1,23 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-require 'survey_section'
-
-describe SurveyParser::SurveySection, "when first created" do
-
-  before(:each) do
-    @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
-    @section.data_export_identifier.should == "demographics"
-  end
-  
-  it "should find a question by reference" do
-    @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
-    q.reference_identifier.should == "2"
-  end
-end

data/script/surveyor/specs/validation_condition_spec.rb

@@ -1,20 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-require 'validation_condition'
-
-describe SurveyParser::ValidationCondition, " when first created" do
-  before do    
-    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 = SurveyParser::ValidationCondition.new(validation, args, options)
-  end
-  
-  it "should set initialization parameters properly" do
-    @validation_condition.id.should == 21
-    @validation_condition.validation_id.should == 29
-    @validation_condition.integer_value.should == 0
-    @validation_condition.operator.should == ">="
-  end
-
-end