surveyor 0.6.1

data/script/surveyor/question_group.rb

@@ -0,0 +1,33 @@
+class QuestionGroup
+  
+  # Context, Content, Display
+  attr_accessor :id, :section_id, :section, :parser
+  attr_accessor :text, :help_text
+  attr_accessor :display_type
+
+  # id, section and text required
+  def initialize(section, args, options)
+    self.parser = section.parser
+    self.id = parser.new_question_group_id
+    self.text = args[0]
+    self.default_options().merge(options).merge(args[1] || {}).each{|key,value| self.instance_variable_set("@#{key}", value)}
+  end
+  
+  def default_options()
+    {:display_type => "default"}
+  end
+  
+  def to_yml
+    out =[ %(#{@id}:) ]
+    out << %(  id: #{@id})
+    out << %(  text: "#{@text}")
+    out << %(  help_text: "#{@help_text}")
+    out << %(  display_type: "#{@display_type}")
+    (out << nil ).join("\r\n")
+  end
+
+  def to_file
+    File.open(self.parser.question_groups_yml, File::CREAT|File::APPEND|File::WRONLY){ |f| f << to_yml }
+  end
+
+end

data/script/surveyor/specs/answer_spec.rb

@@ -0,0 +1,66 @@
+require File.dirname(__FILE__) + '/../answer'
+
+describe Answer, " when first created" do
+
+  TEST_ID = 1
+  TEST_CONTEXT_ID = "b3a_1"
+  TEST_QUESTION_ID = "2"
+  TEST_TEXT = "No / Rarely"
+  TEST_OPTIONS = {:help_text => "Never or rarely ever"}
+
+  before do    
+    @ans = Answer.new(TEST_ID, TEST_QUESTION_ID, TEST_CONTEXT_ID, TEST_TEXT, TEST_OPTIONS)
+  end
+  
+  it "should set inititalized variables to those passed in" do
+    @ans.id.should == TEST_ID
+    @ans.question_id.should == TEST_QUESTION_ID
+    @ans.context_id.should == TEST_CONTEXT_ID
+    @ans.text.should == TEST_TEXT
+    @ans.help_text.should == TEST_OPTIONS[:help_text]
+    end
+  
+  it "should output current state to yml" do
+     @ans.should.respond_to?(:to_yml)
+  end
+  
+  it "should create a normalized code from the answer text" do
+    # The answer object should take the title of the text and convert
+    # it to a code that is more appropirate for a database entry
+    
+    # Taking a few answers from the survey for testing
+    str = []
+    str[0] = "This? is a in - t3rrible-@nswer of! (question) on"
+    str[1] = "Private insurance/ HMO/ PPO"
+    str[2] = "VA"
+    str[3] = "PMS (Premenstrual syndrome)/ PMDD (Premenstrual Dysphoric Disorder)"
+    str[4] = "Have never been employed outside the home"
+    str[5] = "Professional"
+    str[6] = "Not working because of temporary disability, but expect to return to a job"
+    
+    # What the results should look like
+    r_str = []
+    r_str[0] = "this_t3rrible_nswer"
+    r_str[1] = "private_insurance_hmo_ppo"
+    r_str[2] = "va"
+    r_str[3] = "pms_pmdd"
+    r_str[4] = "never_been_employed_outside_home"
+    r_str[5] = "professional"
+    r_str[6] = "temporary_disability_expect_return_job"
+    
+    count = 0 
+    str.each do |s|
+       
+       code = Answer.to_normalized_code(s)  
+       code.should eql(r_str[count])
+       count += 1
+      
+    end
+    
+  end
+  
+  it "should create a normalized code automatically when initalized" do
+    @ans.code.should eql("no_rarely")
+  end
+  
+end

data/script/surveyor/specs/question_dependency_spec.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/../question_dependency'
+
+describe QuestionDependency, " when first created" do
+
+  ID = 1
+  QUESTION_ID = 2
+  DEPENDENT_QUESTION_ID = 3
+  DEPENDENT_GROUP_ID = nil
+  DEPENDENCY_TYPE_1 = {:dependency_type => :response_count, :conditional => :one_or_more }
+  DEPENDENCY_TYPE_2 = {:dependency_type => :response_answer, :conditional => :selected, :answer_id => 1}
+  DEPENDENCY_TYPE_3 = {:dependency_type => :response_value, :condition => :not_zero}
+
+  before do    
+    @dependent_1 = QuestionDependency.new(ID, QUESTION_ID, DEPENDENT_QUESTION_ID, DEPENDENT_GROUP_ID, DEPENDENCY_TYPE_1)
+    @dependent_2 = QuestionDependency.new(ID, QUESTION_ID, DEPENDENT_QUESTION_ID, DEPENDENT_GROUP_ID, DEPENDENCY_TYPE_2)
+    @dependent_3 = QuestionDependency.new(ID, QUESTION_ID, DEPENDENT_QUESTION_ID, DEPENDENT_GROUP_ID, DEPENDENCY_TYPE_3)
+    
+  end
+  
+  it "should set initialization paramerters properly" do
+    # Checking both type1 and type2 dependencies
+    @dependent_1.id.should == ID
+    @dependent_1.question_id.should == QUESTION_ID
+    @dependent_1.dependent_question_id.should == DEPENDENT_QUESTION_ID
+    @dependent_1.dependency_type.should == DEPENDENCY_TYPE_1[:dependency_type]
+    @dependent_1.conditional.should == DEPENDENCY_TYPE_1[:conditional]
+    
+    @dependent_2.id.should == ID
+    @dependent_2.question_id.should == QUESTION_ID
+    @dependent_2.dependent_question_id.should == DEPENDENT_QUESTION_ID
+    @dependent_2.dependency_type.should == DEPENDENCY_TYPE_2[:dependency_type]
+    @dependent_2.conditional.should == DEPENDENCY_TYPE_2[:conditional]
+    @dependent_2.answer_id.should == DEPENDENCY_TYPE_2[:answer_id]
+    
+    @dependent_3.id.should == ID
+    @dependent_3.question_id.should == QUESTION_ID
+    @dependent_3.dependent_question_id.should == DEPENDENT_QUESTION_ID
+    @dependent_3.dependency_type.should == DEPENDENCY_TYPE_3[:dependency_type]
+    @dependent_3.conditional.should == DEPENDENCY_TYPE_3[:conditional]
+  end
+  
+  it "should output current state to yml" do
+     @ans.should.respond_to?(:to_yml)
+  end
+
+end

data/script/surveyor/specs/question_group_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__) + '/../question_group'
+
+describe QuestionGroup, " when first created" do
+  
+  it "should do stuff" do
+    pending
+  end
+  
+end

data/script/surveyor/specs/question_spec.rb

@@ -0,0 +1,111 @@
+require File.dirname(__FILE__) + '/../question'
+
+describe Question, " when first created" do
+  TEST_ID = 1
+  TEST_CONTEXT_ID = "B3"
+  TEST_SECTION_ID = 2
+  TEST_TEXT = "In the past 12 months how many times have you been to a doctor?"
+  TEST_HELP_TEXT = "Please give a rough estimate"
+  TEST_OPTIONS = {:help_text => TEST_HELP_TEXT }
+  TEST_CODE = "many_times_you_been_doctor"
+
+  before do    
+    @ques = Question.new(TEST_ID, TEST_SECTION_ID, TEST_CONTEXT_ID, TEST_TEXT, TEST_OPTIONS)
+  end
+  
+  it "should set initialization parameters properly" do
+    @ques.id.should == TEST_ID
+    @ques.context_id.should == TEST_CONTEXT_ID
+    @ques.section_id.should == TEST_SECTION_ID
+    @ques.code.should == TEST_CODE
+    @ques.options[:help_text].should == TEST_HELP_TEXT
+    
+    #Checking the defaults
+    @ques.options[:has_omit?].should == true
+    @ques.options[:has_other?].should == false
+    @ques.options[:answer_format].should == :medium_text
+  end
+
+  it "should output current state to yml" do
+     @ques.should.respond_to?(:to_yml)
+  end
+  
+  it "should create a normalized code from the answer text" do
+    # The question object should take the title of the text and convert
+    # it to a code that is more appropirate for a database entry
+    
+    # Taking a few questions from the survey for testing
+    str = []
+    str[0] = "How long has it been since you last visited a doctor for a routine checkup (routine being not for a particular reason)?"
+    str[1] = "Do you take medications as directed?"
+    str[2] = "Do you every leak urine (or) water when you didn't want to?" #checking for () and ' removal
+    str[3] = "Do your biological family members (not adopted) have a \"history\" of any of the following?"
+    str[4] = "Your health:"
+    str[5] = "In general, you would say your health is:"
+    
+    # What the results should look like
+    r_str = []
+    r_str[0] = "visited_doctor_for_routine_checkup"
+    r_str[1] = "you_take_medications_as_directed"
+    r_str[2] = "urine_water_you_didnt_want"
+    r_str[3] = "family_members_history_any_following"
+    r_str[4] = "your_health"
+    r_str[5] = "you_would_say_your_health"
+    
+    count = 0 
+    str.each do |s|
+       
+       code = Question.to_normalized_code(s)  
+       code.should eql(r_str[count])
+       count += 1
+      
+    end
+    
+  end
+  
+  it "should create a normalized code automatically when initalized" do
+    @ques.code.should eql(TEST_CODE)
+  end
+  
+  it "should update the normalized code if the title is changed" do
+    @ques.code.should eql(TEST_CODE)
+    @ques.text = "Sometimes or All the time?"
+    @ques.code.should eql("sometimes_all_time")
+  end
+
+end
+
+describe Question, " when it contains data" do
+  
+  before do # Mocking up some answers
+    @question = Question.new(1,TEST_SECTION_ID,TEST_CONTEXT_ID,TEST_TEXT,TEST_OPTIONS)
+    ma1 = mock("answer")
+    ma1.stub!(:context_id).and_return("1")
+    @question.add_answer(ma1)
+    
+    ma2 = mock("answer")
+    ma2.stub!(:context_id).and_return("2")
+    @question.add_answer(ma2)
+    
+    ma3 = mock("answer")
+    ma3.stub!(:context_id).and_return("3")
+    @question.add_answer(ma3)
+    
+  end
+  
+  it "should have added the test answers correctly" do
+    @question.answers.length.should eql(3)
+  end
+  
+  it "should have a question text" do
+    @question.text.should eql(TEST_TEXT)
+  end
+  
+  it "should find an answer by context_id" do
+    pending # yoon: commented out during dsl refactoring
+    a_to_find = @question.find_answer_by_context_id("2")
+    a_to_find.should_not eql(nil)
+    a_to_find.context_id.should eql("2")
+  end
+  
+end

data/script/surveyor/specs/section_spec.rb

@@ -0,0 +1,58 @@
+require File.dirname(__FILE__) + '/../section'
+
+describe Section, " when first created" do
+
+  TEST_TITLE = "Demographics"
+  TEST_SECTION = :B
+
+  before do    
+    @section = Section.new(1,TEST_SECTION,TEST_TITLE)
+  end
+  
+  it "should accept questions" do
+    mock_question = mock("question")
+    @section.questions.size.should eql(0)
+    @section.add_question(mock_question)
+    @section.questions.size.should eql(1)
+  end  
+  
+  it "should output current state to code" do
+    @section.should.respond_to?(:to_code)
+  end
+
+end
+
+describe Section, " when it contains data" do
+  
+  before do # Mocking up some questions
+    @section = Section.new(1,TEST_SECTION,TEST_TITLE)
+    mq1 = mock("question")
+    mq1.stub!(:context_id).and_return("B1")
+    @section.add_question(mq1)
+    
+    mq2 = mock("question")
+    mq2.stub!(:context_id).and_return("B2")
+    @section.add_question(mq2)
+    
+    mq3 = mock("question")
+    mq3.stub!(:context_id).and_return("B3")
+    @section.add_question(mq3)
+    
+  end
+  
+  it "should have added the test questions correctly" do
+    @section.questions.length.should eql(3)
+  end
+  
+  it "should have a title" do
+    @section.title.should eql(TEST_TITLE)
+  end
+  
+  it "should find a question by context_id" do
+    pending # yoon: commented out during dsl refactoring
+    q_to_find = @section.find_question_by_context_id("B2")
+    q_to_find.should_not eql(nil)
+    q_to_find.context_id.should eql("B2")
+  end
+  
+end

data/script/surveyor/survey.rb

@@ -0,0 +1,108 @@
+require File.dirname(__FILE__) + '/survey_section'
+
+class Survey
+    include Columnizer
+  # Content, Reference, Expiry, Children
+  attr_accessor :id, :parser
+  attr_accessor :title, :description
+  attr_accessor :access_code
+  attr_accessor :active_at, :inactive_at
+  attr_accessor :survey_sections
+  
+  @@current_survey = nil
+  
+  def self.current_survey
+    @@current_survey
+  end
+  
+  def self.current_survey=(value)
+    @@current_survey = value
+    puts "Assigning current survey #{@@current_survey.title}"
+  end
+  
+  # id, parser, and title required
+  def initialize(id, parser, title, options = {})
+    self.id = id
+    self.parser = parser
+    self.title = title
+    self.survey_sections = []
+    self.access_code = Columnizer.to_normalized_column(title)
+    # self.default_options(title).merge(options).each{|key,value| self.instance_variable_set("@#{key}", value)}
+    Survey.current_survey = self
+  end
+  
+  # def default_options(title)
+  #   {}
+  # end
+
+  # This method_missing magic does all the heavy lifting for the DSL
+  def method_missing(missing_method, *args, &block)
+    m_name = missing_method.to_s
+    if (section_match = m_name.match(/(\Asection)_?(.*)/))
+      build_survey_section(section_match[3].to_s, *args, &block) # Parse "section" method, create new section in this survey
+    else
+      puts "  ERROR: '#{m_name}' not valid method_missing name"
+    end
+  end
+  
+  def build_survey_section(reference_identifier, title, &block)
+    puts "  Section: #{title}"
+    if block_given?
+      new_survey_section = SurveySection.new(new_survey_section_id, self, title, {:display_order => self.survey_sections.size + 1, :reference_identifier => reference_identifier})
+      new_survey_section.instance_eval(&block)
+      add_survey_section(new_survey_section)
+      puts "  Section added"
+    else
+      puts "  ERROR: A section cannot be empty!"
+    end
+  end
+  
+  def new_survey_section_id
+    self.parser.new_survey_section_id
+  end
+  
+  def add_survey_section(survey_section)
+    self.survey_sections << survey_section
+  end
+ 
+  # Used to find questions for dependency linking
+  def find_question_by_reference(ref_id)
+    question = nil
+    count = 0
+    while question.nil? and count < self.survey_sections.size
+      question = self.survey_sections[count].find_question_by_reference(ref_id)
+      count += 1
+    end
+    question
+  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
+    end
+    
+  end
+  
+  def to_yml
+    out =[ %(survey_#{@id}:) ]
+    out << %(  id: #{@id})
+    out << %(  title: "#{@title}")
+    out << %(  description: "#{@description}")
+    out << %(  access_code: #{@access_code})
+    out << %(  active_at: #{@active_at})
+    out << %(  inactive_at: #{@inactive_at})
+    (out << nil ).join("\r\n")
+  end
+
+  def to_file
+    "survey -#{self.title}- written to file..."
+    File.open(self.parser.surveys_yml, File::CREAT|File::APPEND|File::WRONLY) {|f| f << to_yml}
+    self.survey_sections.compact.map(&:to_file)
+  end
+ 
+end

data/script/surveyor/survey_parser.rb

@@ -0,0 +1,64 @@
+require File.dirname(__FILE__) + '/survey'
+
+class SurveyParser
+  # Children, Counters, Files
+  attr_accessor :surveys
+  attr_accessor :last_survey_id, :last_survey_section_id, :last_question_id, :last_answer_id
+  attr_accessor :surveys_yml, :survey_sections_yml, :question_groups_yml, :questions_yml, :answers_yml, :dependencies_yml, :dependency_conditions_yml
+
+  # no more "ARRRGH, EVIL GLOBALS!!!"
+  def initialize
+    self.surveys = []
+    self.define_counter_methods(%w(survey survey_section question_group question answer dependency dependency_condition))
+    self.initialize_fixtures(%w(surveys survey_sections question_groups questions answers dependencies dependency_conditions), File.join(RAILS_ROOT, "surveys", "fixtures"))
+  end
+
+  # new_survey_id, new_survey_section_id, etc.
+  def define_counter_methods(names)
+    names.each do |name|
+      self.instance_variable_set("@last_#{name}_id", 0)
+      # self.class.send is a hack - define_method is private
+      self.class.send(:define_method, "new_#{name}_id") do
+        self.instance_variable_set("@last_#{name}_id", self.instance_variable_get("@last_#{name}_id") + 1)
+      end
+    end
+  end
+
+  # surveys_yml, survey_sections_yml, etc.
+  def initialize_fixtures(names, path)
+    names.each do |name|
+      file = self.instance_variable_set("@#{name}_yml", "#{path}/#{name}.yml")
+      File.truncate(file, 0) if File.exist?(file)
+    end
+  end
+
+  def self.parse(file_name)
+    puts "--- Parsing '#{file_name}' ---"
+    parser = SurveyParser.new
+    parser.instance_eval(File.read(file_name), file_name)
+    parser.to_files
+    puts "--- End of parsing ---"
+  end
+
+  def survey(title, &block)
+    puts "Survey: #{title}"
+    if block_given?
+      new_survey = Survey.new(self.new_survey_id, self, title)
+      new_survey.instance_eval(&block)    
+      new_survey.reconcile_dependencies
+      add_survey(new_survey)
+      puts "Survey added"
+    else
+      puts "ERROR: A survey cannot be empty!"
+    end
+  end
+
+  def add_survey(survey)
+    self.surveys << survey
+  end
+
+  def to_files
+    self.surveys.compact.map(&:to_file)
+  end
+
+end