gipper 0.0.1

data/features/steps/parse_matching_steps.rb

@@ -0,0 +1,30 @@
+
+Given /^a GIFT file of matching questions$/ do
+  file = File.open(File.join(File.dirname(__FILE__), *%w[.. fixtures matching.gift]))
+  @data = file.read
+  assert @data.length > 0
+end
+
+Then /^contains the correct matching questions$/ do
+  #//My file of matching questions about emoticons
+  #::Intro to matching questions
+  #::Match the emoticon to the correct emotion:{
+  #=:) -> smiling
+  #=:D -> crazy happy
+  #=\(^_^)/ -> yay!
+  #=:( -> sad
+  #}
+  assert_equal 1, @questions.length
+  
+  question = @questions[0]
+  assert_equal 4, question.answer.length
+  assert_question question, :style => :matching,
+                            :text => "Match the emoticon to the correct emotion:",
+                            :title => "Intro to matching questions"
+
+  assert_answer question.answer[0], :correct => "smiling", :text => ":)"
+  assert_answer question.answer[1], :correct => "crazy happy", :text => ":D"
+  assert_answer question.answer[2], :correct => "yay!", :text => '\\(^_^)/'
+  assert_answer question.answer[3], :correct => "sad", :text => ":("
+end
+

data/features/steps/parse_missing_word_steps.rb

@@ -0,0 +1,58 @@
+Given /^a GIFT file of missing word questions$/ do
+  file = File.open(File.join(File.dirname(__FILE__), *%w[.. fixtures missing_word.gift]))
+  @data = file.read
+  @data.length.should be > 0
+end
+
+Then /^contains the correct missing word questions$/ do
+  @questions.length.should be(4)
+ 
+  #Sally sells {  =seashells  ~snails} by the seashore.
+  question = @questions[0]
+  assert_equal 2, question.answer.length
+  assert_question question, :style => :missing_word,
+                            :text => "Sally sells",
+                            :title => nil,
+                            :text_post => "by the seashore."
+
+  assert_answer question.answer[0], :correct => true, :text => "seashells"
+  assert_answer question.answer[1], :correct => false, :text => "snails"
+
+  
+  #::Hamster Tree::
+  #Oh woe is me, {~oh =doh!} woe is me!
+  question = @questions[1]
+  assert_equal 2, question.answer.length
+  assert_question question, :style => :missing_word,
+                            :text => "Oh woe is me,",
+                            :title => "Hamster Tree",
+                            :text_post => "woe is me!"
+
+  assert_answer question.answer[0], :correct => false, :text => "oh"
+  assert_answer question.answer[1], :correct => true, :text => "doh!"
+  
+  #You say that, "money is the root of all evil", I ask you "what is the root of all {~honey ~bunnies =money}?"
+  question = @questions[2]
+  assert_equal 3, question.answer.length
+  assert_question question, :style => :missing_word,
+                            :text => 'You say that, "money is the root of all evil", I ask you "what is the root of all',
+                            :title => nil,
+                            :text_post => '?"'
+
+  assert_answer question.answer[0], :correct => false, :text => "honey"
+  assert_answer question.answer[1], :correct => false, :text => "bunnies"
+  assert_answer question.answer[2], :correct => true, :text => "money"
+  
+  #Ooh Eee \{Uh\} Ooh Ah Ah {=Ting Tang ~Tung Ting ~Wing Wang} Walla Walla Bing Bang!
+  question = @questions[3]
+  assert_equal 3, question.answer.length
+  assert_question question, :style => :missing_word,
+                            :text => 'Ooh Eee {Uh} Ooh Ah Ah',
+                            :title => nil,
+                            :text_post => "Walla Walla Bing Bang!"
+
+  assert_answer question.answer[0], :correct => true, :text => "Ting Tang"
+  assert_answer question.answer[1], :correct => false, :text => "Tung Ting"
+  assert_answer question.answer[2], :correct => false, :text => "Wing Wang"
+end
+

data/features/steps/parse_multiple_choice_steps.rb

@@ -0,0 +1,107 @@
+
+Given /^a GIFT file of multiple choice questions$/ do
+  file = File.open(File.join(File.dirname(__FILE__), *%w[.. fixtures multiple_choice.gift]))
+  @data = file.read
+  @data.length.should be > 0
+end
+
+Then /^contains the correct multiple choice questions$/ do
+  @questions.length.should be(6)
+
+
+  #::Ninjas and the future::In the future, ninjas will be able to{= Travel to the moon ~play tennis ~eat apples ~play fable 2 ~code in Assembly }
+  question = @questions[0]
+  assert_equal 5, question.answer.length
+  assert_question question, :style => :multiple_choice,
+                            :text => "In the future, ninjas will be able to",
+                            :title => "Ninjas and the future"
+
+  assert_answer question.answer[0], :correct => true, :text => "Travel to the moon"
+  assert_answer question.answer[1], :correct => false, :text => "play tennis"
+  assert_answer question.answer[2], :correct => false, :text => "eat apples"
+  assert_answer question.answer[3], :correct => false, :text => "play fable 2"
+  assert_answer question.answer[4], :correct => false, :text => "code in Assembly"
+  
+  #// question: 2 name: Ninjas and you
+  #::Ninjas and you::
+  # If you see a ninja you should: {~offer them a crunchy frog =run ~attack them }
+  question = @questions[1]
+  assert_equal 3, question.answer.length
+  assert_question question, :style => :multiple_choice,
+                            :text => "If you see a ninja you should:",
+                            :title => "Ninjas and you"
+
+  assert_answer question.answer[0], :correct => false, :text => "offer them a crunchy frog"
+  assert_answer question.answer[1], :correct => true, :text => "run"
+  assert_answer question.answer[2], :correct => false, :text => "attack them"
+  
+  #Ninjas will only attack when {~provoked ~ upset ~off duty =none of the above}
+  question = @questions[2]
+  assert_equal 4, question.answer.length
+  assert_question question, :style => :multiple_choice,
+                            :text => "Ninjas will only attack when",
+                            :title => nil
+
+  assert_answer question.answer[0], :correct => false, :text => "provoked"
+  assert_answer question.answer[1], :correct => false, :text => "upset"
+  assert_answer question.answer[2], :correct => false, :text => "off duty"
+  assert_answer question.answer[3], :correct => true, :text => "none of the above"
+  
+  #One way ninjas are like a snake is: {~Ninjas have scales ~Ninjas eat rodents =Ninjas can spit venom}
+  question = @questions[3]
+  assert_equal 3, question.answer.length
+  assert_question question, :style => :multiple_choice,
+                            :text => "One way ninjas are like a snake is:",
+                            :title => nil
+
+  assert_answer question.answer[0], :correct => false, :text => "Ninjas have scales"
+  assert_answer question.answer[1], :correct => false, :text => "Ninjas eat rodents"
+  assert_answer question.answer[2], :correct => true, :text => "Ninjas can spit venom"
+  
+  #::Supercomputing Ninjas
+  #::Ninjas can recite the value of pi to how many digits?{
+  #~10 
+  ## do you even know what a ninja is?
+  #~100 
+  ## are you crazy?
+  #~100,000 
+  ## that is pitiful
+  #=twice the US national debt
+  ## if not more!
+  #}
+  question = @questions[4]
+  assert_equal 4, question.answer.length
+  assert_question question, :style => :multiple_choice,
+                            :text => "Ninjas can recite the value of pi to how many digits?",
+                            :title => "Supercomputing Ninjas"
+
+  assert_answer question.answer[0], :correct => false, :text => "10", :comment => "do you even know what a ninja is?"
+  assert_answer question.answer[1], :correct => false, :text => "100", :comment => "are you crazy?"
+  assert_answer question.answer[2], :correct => false, :text => "100,000", :comment => "that is pitiful"
+  assert_answer question.answer[3], :correct => true, :text => "twice the US national debt", :comment => "if not more!"
+    
+  #// Ninjas can be commented on
+  #::Are you a Ninja?:: 
+  #When confronted by a zombie army of terracotta kung-fu masters, you would: {
+  #~ cry
+  ## not even baby ninjas would do that
+  #~ try to fight
+  ## fight or fight not, there is no try.
+  #= slay them all with a single strike before they even saw you.
+  ## You are Ninja!
+  #~ run away
+  ## You would make a poor ninja.
+  #}
+  question = @questions[5]
+  assert_equal 4, question.answer.length
+  assert_question question, :style => :multiple_choice,
+                            :text => "When confronted by a zombie army of terracotta kung-fu masters, you would:",
+                            :title => "Are you a Ninja?"
+
+  assert_answer question.answer[0], :correct => false, :text => "cry", :comment => "not even baby ninjas would do that"
+  assert_answer question.answer[1], :correct => false, :text => "try to fight", :comment => "fight or fight not, there is no try."
+  assert_answer question.answer[2], :correct => true, :text => "slay them all with a single strike before they even saw you.", :comment => "You are Ninja!"
+  assert_answer question.answer[3], :correct => false, :text => "run away", :comment => "You would make a poor ninja."
+
+end
+

data/features/steps/parse_numerical_steps.rb

@@ -0,0 +1,35 @@
+Given /^a GIFT file of numerical questions$/ do
+  file = File.open(File.join(File.dirname(__FILE__), *%w[.. fixtures numerical.gift]))
+  @data = file.read
+  @data.length.should be > 0
+end
+
+Then /^contains the correct numerical questions$/ do
+  @questions.length.should be(2)
+  
+  #When was Harvey D. Smith born?{#1945:5}
+  question = @questions[0]
+  assert_equal 1, question.answer.length
+  assert_question question, :style => :numerical,
+                            :text => "When was Harvey D. Smith born?",
+                            :title => nil
+
+  assert_answer question.answer[0], :correct => 1945, :range => 5, :weight => nil
+  
+  #//this comment will be ignored in the import process 
+  #::Numerical example::
+  #When was Elizabeth M. Danson born? {#
+  #    =1993:0      #Correct!  you will get full credit for this answer
+  #    =%50%1993:2  #She was born in 1993.
+  #                 You get 50% credit for being close.
+  #}
+  question = @questions[1]
+  assert_equal 2, question.answer.length
+  assert_question question, :style => :numerical,
+                            :text => "When was Elizabeth M. Danson born?",
+                            :title => "Numerical example"
+
+  assert_answer question.answer[0], :correct => 1993, :range => 0, :weight => nil, :comment => "Correct!  you will get full credit for this answer"
+  assert_answer question.answer[1], :correct => 1993, :range => 2, :weight => 50, :comment => "She was born in 1993.\n                 You get 50% credit for being close."
+end
+

data/features/steps/parse_short_answer_steps.rb

@@ -0,0 +1,42 @@
+
+Given(/^a GIFT file of short answer questions$/) do
+  file = File.open(File.join(File.dirname(__FILE__), *%w[.. fixtures short_answer.gift]))
+  @data = file.read
+  @data.length.should be > 0
+end
+
+Then(/^contains the correct short answer questions$/) do
+  @questions.length.should be(3)
+  
+  #//File of short answer questions
+  #::Intro question about coffee::
+  #Coffee is made from {=ground coffee beans and water =burnt beans = the nectar of the gods}
+  question = @questions[0]
+  assert_equal 3, question.answer.length
+  assert_question question, :style => :short_answer,
+                            :text => "Coffee is made from",
+                            :title => "Intro question about coffee"
+
+  assert_answer question.answer[0], :correct => true, :text => "ground coffee beans and water"
+  assert_answer question.answer[1], :correct => true, :text => "burnt beans"
+  assert_answer question.answer[2], :correct => true, :text => "the nectar of the gods"
+  
+  #Coffee is best when{ = hot = cold}
+  question = @questions[1]
+  assert_equal 2,  question.answer.length
+  assert_question question, :style => :short_answer,
+                            :text => "Coffee is best when",
+                            :title => nil
+
+  assert_answer question.answer[0], :correct => true, :text => "hot"
+  assert_answer question.answer[1], :correct => true, :text => "cold"
+  
+  #The only way to spell coffee is:{=coffee}
+  question = @questions[2]
+  assert_equal 1,  question.answer.length
+  assert_question question, :style => :short_answer,
+                            :text => "The only way to spell coffee is:",
+                            :title => nil
+
+  assert_answer question.answer[0], :correct => true, :text => "coffee"
+end

data/features/steps/parse_steps.rb

@@ -0,0 +1,7 @@
+When(/^I tell gipper to parse the file$/)do
+  @questions = Gipper::Quiz.parse @data
+end
+
+Then(/^I will get an array of questions and answers$/)do
+  @questions.class.should eql(Array)
+end

data/features/steps/parse_true_or_false_steps.rb

@@ -0,0 +1,61 @@
+Given(/^a GIFT file of true or false questions$/) do
+  file = File.open(File.join(File.dirname(__FILE__), *%w[.. fixtures true_or_false.gift]))
+  @data = file.read
+  @data.length.should be > 0
+end
+
+Then(/^contains the correct true or false questions$/)do  
+  @questions.length.should be(6)
+  
+  #:trueStatement about monkeys::Monkeys like to fly like ninjas.{T}
+  question = @questions[0]
+  assert_question question, :style => :true_false,
+                            :text => "Monkeys like to fly like ninjas.",
+                            :title => "TrueStatement about monkeys"
+
+  assert_answer question.answer[0], :correct => true
+  
+  #// question: 0 name: TrueStatement
+  #::A Second TrueStatement about monkeys::
+  #Monkeys roam in packs with swords.{True}
+  question = @questions[1]
+  assert_question question, :style => :true_false,
+                            :text => "Monkeys roam in packs with swords.",
+                            :title => "A Second TrueStatement about monkeys"
+
+  assert_answer question.answer[0], :correct => true
+  
+  #Monkeys will jump from buildings without fear. {T}
+  question = @questions[2]
+  assert_question question, :style => :true_false,
+                            :text => "Monkeys will jump from buildings without fear.",
+                            :title => nil
+
+  assert_answer question.answer[0], :correct => true
+  
+  #Monkeys have a formal system of government{False}
+  question = @questions[3]
+  assert_question question, :style => :true_false,
+                            :text => "Monkeys have a formal system of government",
+                            :title => nil
+
+  assert_answer question.answer[0], :correct => false
+
+  #::A Second FalseStatement about monkeys
+  #::Monkeys wear suits and sit around in corporate offices.{False}
+  question = @questions[4]
+  assert_question question, :style => :true_false,
+                            :text => "Monkeys wear suits and sit around in corporate offices.",
+                            :title => "A Second FalseStatement about monkeys"
+
+  assert_answer question.answer[0], :correct => false
+  
+  #// question: 6 name: FalseStatement
+  #::A Third FalseStatement about monkeys:: Monkeys can operate heavy machinery.{F}
+  question = @questions[5]
+  assert_question question, :style => :true_false,
+                            :text => "Monkeys can operate heavy machinery.",
+                            :title => "A Third FalseStatement about monkeys"
+
+  assert_answer question.answer[0], :correct => false
+end

data/features/support/env.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.join [File.dirname(__FILE__), "..", "..", "lib"])
+require 'gipper'
+
+$LOAD_PATH.unshift(File.join [File.dirname(__FILE__), "..", "..", "test"])
+require 'custom_assertions'
+include CustomAssertions
+
+require 'test/unit/assertions'
+
+World(Test::Unit::Assertions)

data/lib/answer.rb

@@ -0,0 +1,165 @@
+require 'special_charater_handler'
+
+module Gipper
+  # == Gipper::Answer
+  # 
+  # Represents the single correct answer if there is only one answer,
+  # or one of the answer choices if multiple are provided for a question.
+  #
+  # To populate the answer from a string use the parse method
+  #
+  #   answer = Gipper::Answer.new
+  #   answer.parse "= foo #bar"
+  #
+  #   answer.correct
+  #   >> true
+  #
+  #   answer.text
+  #   >> foo
+  #
+  #   answer.comment
+  #   >> bar
+  #
+  # or 
+  #
+  #   answer.parse "F"
+  #
+  #   answer.correct
+  #   >> false
+  #
+  class Answer
+    include Oniguruma
+    include Gipper::SpecialCharacterHandler
+    attr_reader :weight, :correct, :comment, :range, :text
+
+    # Will parse a single answer into it's parts.
+    # If the answer type is numerical, pass :numerical as the optional second parameter.
+    def parse answer, style_hint = nil
+      if style_hint == :numerical
+        parse_as_numerical answer
+      else
+        parse_standard answer
+      end
+    end
+
+    private
+      def can_parse_as_true_false? answer
+        return false if answer.nil?
+        answer.downcase.strip =~ /^(t|f|true|false)$/
+      end
+
+      def parse_standard answer
+        correct, text = split_correct answer
+
+        split_matching(text) do |t, c|
+          text, correct = t, c
+        end
+
+        text, weight = split_weight(text)
+        @weight = weight.to_i if weight
+        @text, @comment = split_comment(text).map { |item| unescape item }
+
+        @correct = correct
+
+        # handle true false
+        if can_parse_as_true_false?(@text)
+          convert_to_true_false!
+        end
+      end
+
+      def parse_as_numerical answer
+        correct, range = answer.split(":", 2)
+        range, comment = split_comment range
+        correct.gsub!("=", "")
+        weight = 100
+
+        correct, weight = split_weight(correct)
+        @weight = weight.to_i if weight
+
+        @comment = comment
+        parts = correct.split(/\.\./)
+        if parts.length == 2
+          parts.map! { |s| to_num(s) }
+          @correct = ((parts[0] + parts[1]) /2)
+          @range = ((parts[1] - parts[0]) /2)
+        else
+          @correct = to_num(correct)
+          @range = to_num(range)
+        end
+      end
+
+      def convert_to_true_false!
+        @correct = is_true(@text)
+        @text = nil
+      end
+
+      def to_num(val)
+        if val && val.include?(".")
+          val.to_f
+        else
+          val.to_i
+        end
+      end
+
+      def is_true answer
+        !(answer.downcase.strip =~ /^(t|true)$/).nil?
+      end
+
+      def split_correct clause
+        correct = []
+
+        if clause =~ /^[~=]/
+          correct[0] = eval_correctness(clause[0])
+          correct[1] = clause[1..clause.length].strip
+        else
+          correct[0] = true
+          correct[1] = clause
+        end
+
+        return correct
+      end
+
+      def split_matching answers
+        reg = Regexp.new('(.*)\-\>(.*)', Regexp::MULTILINE)
+        matches = reg.match answers
+
+        if matches
+          yield matches.captures.map {|s| s.strip}
+        end
+      end
+
+      def split_weight answer
+        return [answer, nil] unless answer.class == String
+        matches = answer.match(/%(-?\d+)%(.+)/)
+        if matches
+          weight = matches.captures[0]
+          correct = matches.captures[1]
+          return [correct, weight]
+        end
+
+        return [answer, nil]
+      end
+
+      def eval_correctness indicator
+        { 61 => true, 126 => false}[indicator]
+      end
+
+      def split_comment answer_text
+        return [nil, nil] if blank?(answer_text)
+
+        answer_text.strip!
+        reg = ORegexp.new('(?<before>.*)(?<!\\\\)#(?<after>.*)', :options => OPTION_MULTILINE)
+        match = reg.match(answer_text)
+        return [answer_text, nil] unless match
+
+        text = match[:before].strip
+        feedback_comment = match[:after].strip
+        [text, feedback_comment]
+      end
+
+      def blank? text
+        text.nil? || text == ""
+      end
+  end
+end
+