gift-parser 0.1.0

data/test/GIFT-examples.txt

@@ -0,0 +1,27 @@
+// true/false
+::Q1:: 1+1=2 {T}
+
+// multiple choice with specified feedback for right and wrong answers
+::Q2:: What's between orange and green in the spectrum? 
+{ =yellow # right; good! ~red # wrong, it's yellow ~blue # wrong, it's yellow }
+
+// fill-in-the-blank
+::Q3:: Two plus {=two =2} equals four.
+
+// matching
+::Q4:: Which animal eats which food? { =cat -> cat food =dog -> dog food }
+
+// math range question
+::Q5:: What is a number from 1 to 5? {#3:2}
+
+// math range specified with interval end points
+::Q6:: What is a number from 1 to 5? {#1..5}
+
+// multiple numeric answers with partial credit and feedback
+::Q7:: When was Ulysses S. Grant born? {#
+         =1822:0      # Correct! Full credit.
+         =%50%1822:2  # He was born in 1822. Half credit for being close.
+}
+
+// essay
+::Q8:: How are you? {}

data/test/gift_semantic_test.rb

@@ -0,0 +1,179 @@
+#!/usr/bin/env ruby
+# Tests for GIFT parser
+
+# This only tests that the input is parsed.
+# so far does not test output.
+
+require 'pp'
+require 'test/unit'
+require 'test/unit/ui/console/testrunner'
+
+require File.expand_path('../../lib/gift',  __FILE__)
+
+class GiftSemanticTest < Test::Unit::TestCase
+  
+  attr_accessor :parser
+
+  def setup
+    @parser = GiftParser.new
+  end
+
+  def assert_can_parse(string)
+    string << "\n\n" # Insert a blank line at end of string
+    assert !@parser.parse(string).nil?, "Failed on:\n#{string}\n Reason:\n#{@parser.failure_reason.inspect}\n"
+  end
+  
+  def assert_cannot_parse(string)
+    string << "\n\n" # Insert a blank line at end of string
+    p = @parser.parse(string)
+    assert p.nil?, "Failed on:\n#{string}\n Reason:\nThis should not be correctly parsed, but was.\nParser Output:\n#{p.inspect}"
+  end
+  
+  def test_description_question
+    q = @parser.parse("This is a description.\n\n").questions[0]
+    assert q.class == Gift::DescriptionQuestion
+    assert q.text == "This is a description."
+  end
+
+  def test_essay_question
+    q = @parser.parse("Write an essay on the toic of your choice{ }\n\n").questions[0]
+    assert q.class == Gift::EssayQuestion
+    assert q.text == "Write an essay on the toic of your choice"
+  end
+  
+  def test_true_false_question_true
+    q = @parser.parse("Is the sky blue?{T}\n\n").questions[0]
+    assert q.class == Gift::TrueFalseQuestion
+    assert q.text == "Is the sky blue?"
+    assert q.answers == [{:value => true, :correct => true, :feedback => nil}]
+  end
+  
+  def test_true_false_question_false
+    q = @parser.parse("Is the sky green?{F}\n\n").questions[0]
+    assert q.text == "Is the sky green?"
+    assert q.answers == [{:value => false, :correct => true, :feedback => nil}]
+  end
+  
+  def test_tf_with_feedback
+    q = @parser.parse("Is the sky green?{F#No It's blue.}\n\n").questions[0]
+    assert q.text == "Is the sky green?"
+    assert q.answers == [{:value => false, :correct => true, :feedback => "No It's blue."}]
+  end
+  
+  def test_multiple_choice_question
+    q = @parser.parse("What color is the sky?{=blue ~green ~red}\n\n").questions[0]
+    assert q.class == Gift::MultipleChoiceQuestion
+    assert q.text == "What color is the sky?"
+    assert q.answers ==  [{:value => "blue", :correct => true, :feedback => nil}, 
+                         {:value => "green", :correct => false, :feedback => nil},
+                         {:value => "red", :correct => false, :feedback => nil}]
+    
+  end
+  
+  def test_multiple_choice_question_with_feedback
+    q = @parser.parse("What color is the sky?{=blue#Correct ~green#Wrong! ~red}\n\n").questions[0]
+    assert q.answers ==  [{:value => "blue", :correct => true, :feedback => "Correct"}, 
+                         {:value => "green", :correct => false, :feedback => "Wrong!"},
+                         {:value => "red", :correct => false, :feedback => nil}]
+    
+  end
+  
+  def test_multiple_choice_question_with_weights
+    q = @parser.parse("What color is the sky?{=blue#Correct ~%50%green#Wrong! ~red}\n\n").questions[0]
+    assert q.answers ==  [{:value => "blue", :correct => true, :feedback => "Correct"}, 
+                         {:value => "green", :correct => false, :feedback => "Wrong!", :weight => 50.0},
+                         {:value => "red", :correct => false, :feedback => nil}]
+  end
+  
+  def test_short_answer_question
+    q = @parser.parse("Who's buried in Grant's tomb?{=Grant =Ulysses S. Grant =Ulysses Grant}\n\n").questions[0]
+    assert q.class == Gift::ShortAnswerQuestion
+    assert q.text == "Who's buried in Grant's tomb?"
+    assert q.answers == [{:feedback => nil, :value => "Grant", :correct => true}, 
+                         {:feedback => nil, :value => "Ulysses S. Grant", :correct => true}, 
+                         {:feedback => nil, :value => "Ulysses Grant" , :correct => true}]
+  end
+  
+  def test_short_answer_question_with_weights
+    q = @parser.parse("Name three colors of the rainbow?{=%33.3%red =%33.3%orange =%33.3%yellow =%33.3%green =%33.3%blue =%33.3%indigo =%33.3%violet }\n\n").questions[0]
+    q.answers.each do |a|
+      assert a[:weight] == 33.3
+    end
+  end
+  
+  def test_numeric_question
+    q = @parser.parse("What is 3 + 4?{#7}\n\n").questions[0]
+    assert q.class == Gift::NumericQuestion
+    assert q.answers == [{:maximum => 7.0, :minimum => 7.0}]
+  end
+  
+  def test_numeric_with_tolerance
+    q = @parser.parse("What is the value of PI?{#3.1:0.5}\n\n").questions[0]
+    assert q.answers == [{:maximum => 3.6, :minimum => 2.6}]
+  end
+  
+  def test_numeric_range
+    q = @parser.parse("What is a number from 1 to 5? {#1..5}\n\n").questions[0]
+    assert q.answers == [{:maximum => 1.0, :minimum => 5.0}]
+  end
+  
+  def test_numeric_multiple_answers
+    q = @parser.parse("What is the value of PI?{#3.1415 =%50%3.1 =%25%3 }\n\n").questions[0]
+    assert q.answers == [{:maximum => 3.1415, :minimum => 3.1415}, 
+                         {:maximum => 3.1, :minimum => 3.1},
+                         {:maximum => 3.0, :minimum => 3.0}]
+  end
+  
+  def test_numeric_neagitve_numbers
+    q = @parser.parse("Calculate 2 - 6.{#-4.0}\n\n").questions[0]
+    assert q.answers == [{:maximum => -4.0, :minimum => -4.0}]
+  end
+  
+  def test_matching_question
+    q = @parser.parse("Match the names. { =Charlie -> Chaplin =Groucho -> Marx =Buster -> Keaton  =Stan -> Laurel }\n\n").questions[0]
+    assert q.class == Gift::MatchQuestion 
+    assert q.text == "Match the names."
+    assert q.answers == {'Charlie' => 'Chaplin', 'Groucho' => 'Marx', 'Buster' => 'Keaton', 'Stan' => 'Laurel'}
+  end
+  
+  def test_fill_in_question
+    q = @parser.parse("There were {=three} little pigs.\n\n").questions[0]
+    assert q.class == Gift::FillInQuestion
+    assert q.text == "There were %% little pigs."
+    assert q.answers == [{:value => 'three', :correct => true, :feedback => nil}]
+  end
+  
+  def test_title
+    q = @parser.parse("::Essay One:: Write an essay on the toic of your choice{ }\n\n").questions[0]
+    assert q.title == "Essay One"
+  end 
+  
+  def test_title_from_question
+    q = @parser.parse("Write an essay on the toic of your choice{ }\n\n").questions[0]
+    assert q.title == q.text
+  end
+  
+  def test_comment
+    q = @parser.parse("//Here's an easy one\nWrite an essay on the toic of your choice{ }\n\n").questions[0]
+    assert q.comment == "Here's an easy one"
+  end
+  
+  def test_command
+    q = @parser.parse("$COMMAND=1\n\nQuestion{}\n\n")
+    assert q.commands == ["COMMAND=1"]
+  end
+ 
+  def test_category_setting
+    q = @parser.parse("$CATEGORY: food \n\nIs apple a food?{T}\n\n$CATEGORY: drink \n\nIs water drinkable?{T}\n\n" )
+    assert q.questions[0].category == "food"
+    assert q.questions[1].category == "drink"
+  end
+  
+  def test_markup_type
+    q = @parser.parse("[textile] This *essay* is marked up in textile.{}\n\n").questions[0]
+    assert q.markup == "textile"
+  end
+  
+end
+
+Test::Unit::UI::Console::TestRunner.run(GiftSemanticTest)

data/test/gift_syntax_test.rb

@@ -0,0 +1,243 @@
+#!/usr/bin/env ruby
+# Tests for GIFT parser
+
+# This only tests that the input is parsed.
+# so far does not test output.
+
+require 'pp'
+require 'test/unit'
+require 'test/unit/ui/console/testrunner'
+
+require File.expand_path('../../lib/gift',  __FILE__)
+require File.expand_path('../GIFT-examples.rb', __FILE__)
+
+
+class GiftSyntaxTest < Test::Unit::TestCase
+  
+  attr_accessor :parser
+  
+  def setup
+    @parser = GiftParser.new
+  end
+
+  def assert_can_parse(string)
+    string << "\n\n" # Insert a blank line at end of string
+    assert !@parser.parse(string).nil?, "Failed on:\n#{string}\n Reason:\n#{@parser.failure_reason.inspect}\n"
+  end
+  
+  def assert_cannot_parse(string)
+    string << "\n\n"
+    p = @parser.parse(string)
+    assert p.nil?, "Failed on:\n#{string}\n Reason:\nThis should not be correctly parsed, but was.\nParser Output:\n#{p.inspect}"
+  end
+  
+  def test_essay_question
+    assert_can_parse("Write an essay about something.{}")
+  end
+
+  def test_description_question
+   assert_can_parse("This is simply a description")
+  end 
+
+  def test_true_false_questions
+    assert_can_parse("The sky is blue.{T}")
+    assert_can_parse("The sky is blue.{TRUE}")
+    assert_can_parse("The sky is green.{F}")
+    assert_can_parse("The sky is blue.{FALSE}")
+  end 
+  
+  def test_feedback
+    assert_can_parse("Grant is buried in Grant's tomb.{FALSE#No one is buried in Grant's tomb.}")       
+  end
+  
+  def test_multiple_choice_question
+    assert_can_parse("What color is the sky?{ = Blue ~Green ~Red }")
+  end
+  
+  def test_multiple_choice_question_with_feedback
+    assert_can_parse('What color is the sky?{ = Blue#Right ~Green ~Red#Very wrong}')
+  end                                                    
+  
+  def test_multiple_choice_on_multiple_lines
+    test_text= <<EOS
+    What color is the sky?{ 
+    = Blue#Right 
+    ~Green 
+    ~Red
+    #Very wrong
+    }
+EOS
+    assert_can_parse(test_text)
+  end
+  
+  def test_multiple_choice_with_weights
+    assert_can_parse('Which of these are primary colors?{ ~%33%Blue ~%33%Yellow ~Beige ~%33%Red}')
+  end
+    
+  def test_numeric_question
+    assert_can_parse("How many pounds in a kilogram?{#2.2:0.1}")
+  end
+  
+  def test_numeric_question_with_multiple_answer
+    assert_can_parse("How many pounds in a kilogram?{# =2.2:0.1 =%50%2 }")
+  end
+  
+  def test_numeric_range_question
+    assert_can_parse("::Q5:: What is a number from 1 to 5? {#1..5}")
+  end 
+  
+  def test_numeric_negative_number
+    assert_can_parse("What is 6 - 10?{#-4}")
+  end
+   
+  def test_short_answer
+    assert_can_parse("Who's buried in Grant's tomb?{=Grant =Ulysses S. Grant =Ulysses Grant}")
+  end
+  
+  def test_matching_question
+    test_text= <<EOS
+    Match the following countries with their corresponding capitals. {
+       =Canada -> Ottawa
+       =Italy  -> Rome
+       =Japan  -> Tokyo
+       =India  -> New Delhi
+       }
+EOS
+     assert_can_parse(test_text) 
+  end
+  
+  def test_fill_in_question
+    assert_can_parse("Little {~blue =red ~green } riding hood.\n") 
+    assert_can_parse("Two plus two equals {=four =4}.\n")
+  end
+  
+  def test_question_with_title
+    assert_can_parse('::Colors 1:: Which of these are primary colors?{ ~%33%Blue ~%33%Yellow ~Beige ~%33%Red}')
+  end
+  
+  def test_question_with_comment
+    assert_can_parse("//This is an easy one\n Which of these are primary colors?{ ~%33%Blue ~%33%Yellow ~Beige ~%33%Red}")
+  end
+  
+  def test_multiline_comments
+     assert_can_parse("//This is an easy one\n//With more than one line of comment\nWhich of these are primary colors?{ ~%33%Blue ~%33%Yellow ~Beige ~%33%Red}")
+  end
+  
+  def test_that_questions_must_be_separated 
+    test_text = <<EOS
+    Who's buried in Grant's tomb?{=Grant =Ulysses S. Grant =Ulysses Grant}
+    Which of these are primary colors?{ ~%33%Blue ~%33%Yellow ~Beige ~%33%Red}
+EOS
+    assert_cannot_parse(test_text)
+    
+    test_text = <<EOS
+        Who's buried in Grant's tomb?{=Grant =Ulysses S. Grant =Ulysses Grant}
+        
+        Which of these are primary colors?{ ~%33%Blue ~%33%Yellow ~Beige ~%33%Red}
+EOS
+     assert_can_parse(test_text)
+  end
+  
+  def test_escape_left_bracket
+    assert_can_parse('Can a \{ be escaped?{=Yes ~No}')
+    assert_can_parse('Can a \{ be escaped?{=Yes ~No\{ }')
+    
+  end
+  
+  def test_escape_right_bracket
+    assert_can_parse('Can a \} be escaped?{=Yes \} can be escaped. ~No}') 
+    
+  end
+  
+  def test_escape_tilde
+    assert_can_parse('Can a \~ be escaped?{=Yes ~No \~ can\'t}')
+  end
+  
+  def test_escape_hash
+    assert_can_parse('Can a \# be escaped?{=Yes \# can ~No}')
+  end 
+  
+  def test_escape_equals
+    assert_can_parse('Can a \= be escaped?{=Yes ~No}')
+  end
+  
+  def test_escape_colon
+    assert_can_parse('Can a \: be escaped?{=Yes \: can be escaped. ~No}')
+  end
+  
+  def test_escapes_in_title
+    assert_can_parse('::\{This is in\: Brackets\}::Who\'s buried in Grant\'s tomb?{=Grant =Ulysses S. Grant =Ulysses Grant}')
+  end
+  
+  def test_escapes_in_comment
+    assert_can_parse("//Escapes in comments are redundant \\: since they end in a \n Question?{}")
+  end
+  
+  def test_crlf_support
+    assert_can_parse("Can we have DOS style line breaks?{\r\n=yes \r\n~no}\r\n \r\n And is it seen as a line_break?{TRUE}")
+  end
+  
+  def test_comment_line_break
+     assert_can_parse("//Comment\nWho's buried in Grant's tomb?{=Grant =Ulysses S. Grant =Ulysses Grant}")
+     assert_can_parse("//Comment\r\nWho's buried in Grant's tomb?{=Grant =Ulysses S. Grant =Ulysses Grant}")
+  end
+  
+  def test_dealing_with_blank_lines_at_top_of_file
+    assert_can_parse("\n    \n//Comment\nWho's buried in Grant's tomb?{=Grant =Ulysses S. Grant =Ulysses Grant}")
+  end
+  
+  def test_dealing_with_blank_lines_at_end_of_file
+    assert_can_parse("//Comment\nWho's buried in Grant's tomb?{=Grant =Ulysses S. Grant =Ulysses Grant}\n \n    \n ")
+  end
+  
+  def test_title_line_breaks
+   test_text= <<EOS
+     ::Title::
+     Match the following countries with their corresponding capitals. {
+     =Canada -> Ottawa
+     =Italy  -> Rome
+     =Japan  -> Tokyo
+     =India  -> New Delhi
+     }
+     
+EOS
+     assert_can_parse(test_text) 
+  end
+  
+  
+  def test_single_short_answer
+   test_text = <<EOS
+   // ===Short Answer===
+   What is your favorite color?{=blue}
+EOS
+  assert_can_parse(test_text)
+  end
+  
+  def test_multiple_short_answer
+  test_text = <<EOS
+       ::Multiple Short Answer::
+       What are your four favorite colors?{
+         =%25%Blue
+         =%25% Red
+         =%25% Green
+         =%25% pink
+         =%25% azure
+         =%25% gold
+         }
+EOS
+  assert_can_parse(test_text)
+  end
+  
+  def test_moodle_examples
+     GiftExamples.examples.each do |key, value|
+       assert_can_parse value
+     end                                                
+  end
+
+  def test_can_have_commands
+    assert_can_parse("$COMMAND=1\n\nQuestion text{}")
+  end
+end
+
+Test::Unit::UI::Console::TestRunner.run(GiftSyntaxTest)
+