gipper 0.0.1

data/test/answers_test.rb

@@ -0,0 +1,126 @@
+require 'test_helper'
+
+class AnswersTest < Test::Unit::TestCase
+  def setup
+    @answers = Gipper::Answers.new
+  end
+
+
+  context "answer splitting" do
+    should "not split strings that do not contain answer delimiters" do
+      answers = @answers.send :split_apart, "this is a single answer"
+      assert_answers ["this is a single answer"], answers
+    end
+
+    should "split strings on twiddle" do
+      answers = @answers.send :split_apart, "~this ~answer has ~three parts"
+      assert_answers ["~this", "~answer has", "~three parts"], answers
+    end
+    
+    should "split strings on equals" do
+      answers = @answers.send :split_apart, "=this =answer has =three parts"
+      assert_answers ["=this", "=answer has", "=three parts"], answers
+    end
+    
+    should "split strings on equals and twiddles" do
+      answers = @answers.send :split_apart, "~this =answer has ~three parts"
+      assert_answers ["~this", "=answer has", "~three parts"], answers
+    end
+    
+    should "not split strings on escaped equals and twiddles" do
+      answers = @answers.send :split_apart, "~this \\=answer has ~two parts"
+      assert_answers ["~this \\=answer has", "~two parts"], answers
+    end
+
+    should "split matching correctly" do
+      answers = @answers.send :split_apart, "=waffle -> cone =cheese -> cheddar"
+      assert_answers ["=waffle -> cone", "=cheese -> cheddar"], answers
+    end
+
+    should "be tolerant of input variance" do
+      answers = @answers.send :split_apart, "  ~ %%%%%%% ~ UUUUUUUUU ~@@%^&* ~ 232323   = 2345       "
+      assert_answers ["~ %%%%%%%", "~ UUUUUUUUU", "~@@%^&*", "~ 232323", "= 2345"], answers
+    end
+
+    should "get answer conmments" do
+      answers = @answers.send :split_apart, "  ~ %%%%%%%#foo = UUUUUUUUU #bar"
+      assert_answers ["~ %%%%%%%#foo", "= UUUUUUUUU #bar"], answers
+    end
+
+    should "get answer conmments when preceeded by a new line" do
+      answers = @answers.send :split_apart, "~ Oompa\r\n#kun\r\n = Loompa\r\n #pyakun"
+      assert_answers ["~ Oompa\r\n#kun", "= Loompa\r\n #pyakun"], answers
+    end
+
+    # If you want to use curly braces, { or }, or equal sign, =,
+    # or # or ~ in a GIFT file (for example in a math question including
+    # TeX expressions) you must "escape" them by preceding them with a \
+    # directly in front of each { or } or =.
+    should "ignore all escaped characters" do
+      answers = @answers.send :split_apart, "~ \\{\\}\\~\\=\\#foo =\\{\\}\\~\\=\\#bar"
+      assert_answers ["~ \\{\\}\\~\\=\\#foo", "=\\{\\}\\~\\=\\#bar"], answers
+    end
+  end
+
+  context "splitting numerical answers" do
+    setup do
+      @answers = Gipper::Answers.new
+    end
+    
+    should "determine numerical by a leading pound" do
+      assert @answers.send :is_numerical?, "#333"
+    end
+
+    should "understand numerical answer format" do
+      result = @answers.send :split_apart, "2000:3"
+      assert_answers ["2000:3"], result
+    end
+
+    should "understand multiple numerical answer format" do
+      result = @answers.send :split_apart, "=2000:0 #Whoopdee do! =%50%2000:3 #Yippers"
+      assert_answers ["=2000:0 #Whoopdee do!", "=%50%2000:3 #Yippers"], result
+    end
+  end
+
+  context "when determining the answer style" do
+    should "return a style of true_false when it has one answer of true and no text" do
+      @answers.parse("T")
+      assert_equal :true_false, @answers.find_style
+    end
+
+    should "return a style of true_false when it has one answer of false and no text" do
+      @answers.parse("F")
+      assert_equal :true_false, @answers.find_style
+    end
+
+    should "return a style of multiple choice when it has more than one answer and text and only one answer is true" do
+      @answers.parse("~foo =bar")
+      assert_equal :multiple_choice, @answers.find_style
+    end
+
+    should "return a style of short answer when it has more than one answer and text and all answers are true" do
+      @answers.parse("=foo =bar")
+      assert_equal :short_answer, @answers.find_style
+    end
+
+    should "return a style of short answer when it has one true answer and text" do
+      @answers.parse("=foo")
+      assert_equal :short_answer, @answers.find_style
+    end
+
+    should "return a style of short answer when it has one true answer and text without equals" do
+      @answers.parse("5")
+      assert_equal :short_answer, @answers.find_style
+    end
+
+    should "return a style of matching when correct contains a string ->" do
+      @answers.parse("=foo -> bar")
+      assert_equal :matching, @answers.find_style
+    end
+
+    should "return a style of matching when correct contains a symbols ->" do
+      @answers.parse("=:) -> smiley")
+      assert_equal :matching, @answers.find_style
+    end
+  end
+end

data/test/custom_assertions.rb

@@ -0,0 +1,68 @@
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+
+module CustomAssertions
+  def assert_answers correct, results
+    assert_equal correct.length, results.length
+    correct.each_with_index do |s, i|
+      assert_equal s, results[i]
+    end
+  end
+
+  def assert_question question, expected={}
+    check_expected question, expected, :text_post
+    check_expected question, expected, :answer
+    check_expected question, expected, :title
+    check_expected question, expected, :text
+    check_expected question, expected, :style
+    check_expected question, expected, :format
+  end
+
+  def assert_answer answer, expected={}
+    check_expected answer, expected, :correct
+    check_expected answer, expected, :text
+    check_expected answer, expected, :comment
+    check_expected answer, expected, :range
+    check_expected answer, expected, :weight
+  end
+
+  def assert_false value
+    assert FalseClass, value.class
+  end
+
+  def assert_question_parsing text, expected={}
+    question = Gipper::Question.new
+
+    question.parse text
+
+    assert_question question, expected
+  end
+
+  def assert_answer_parsing text, expected={}
+    answer = Gipper::Answer.new
+
+    if expected[:numerical]
+      answer.parse text, :numerical
+    else
+      answer.parse text
+    end
+
+    assert_answer answer, expected
+  end
+
+  def check_expected obj, expected, key
+    if expected.has_key? key
+      actual = (obj.send key.to_s)
+      if expected[key].nil?
+        assert_nil actual, "key #{key.to_s} expected to be nil got #{actual}"
+      else
+        if actual.class == Float
+          assert_in_delta expected[key], actual, 0.00001, "key #{key.to_s} expected #{expected[key]} got #{actual} with tolerence of .00001"
+        else
+          assert_equal expected[key], actual, "key #{key.to_s} expected #{expected[key]} got #{actual}"
+        end
+
+      end
+    end
+  end
+end

data/test/fixtures/begins_with_comment.txt

@@ -0,0 +1,6 @@
+// Basic GIFT questions
+// GIFT filter and documentation by Paul Tsuchido Shew http://ac.shew.jp.
+//---------------------------
+
+1=1{T}
+

data/test/question_test.rb

@@ -0,0 +1,86 @@
+require 'test_helper'
+
+class QuestionTest < Test::Unit::TestCase
+  def setup
+    @q = Gipper::Question.new
+  end
+
+  context "(when passed a single question without comments or title)" do
+
+    setup do
+      @single_question = "wubble."
+      @single_answer = "{=:) -> smiley}"
+      single_input = @single_question + @single_answer
+
+      @q.parse(single_input)
+    end
+
+    should "return the question" do
+      assert_equal "wubble.", @q.text
+    end
+
+    should "return the answer" do
+      assert_equal "smiley", @q.answer[0].correct
+    end
+
+    should "return the answer match" do
+      assert_equal ":)", @q.answer[0].text
+    end
+
+    should "return the style" do
+      assert_equal :matching, @q.style
+    end
+  end
+
+  context "(when passed a single question with title but without comments)" do
+
+    setup do
+      @single_title = "SuperTitle"
+      @single_question = "Titles are bad."
+      @single_answer = "{F}"
+      single_input = "::#{@single_title}::#{@single_question}#{@single_answer}"
+
+      @q.parse(single_input)
+    end
+
+    should "return the question" do
+      assert_equal @single_question, @q.text
+    end
+
+    should "return the answer" do
+      assert_false @q.answer[0].correct
+    end
+
+    should "return the style" do
+      assert_equal :true_false, @q.style
+    end
+
+    should "return the title" do
+      assert_equal @single_title, @q.title
+    end
+  end
+
+  context "when passed a question with escaped brackets" do
+    should "ignore the brackets" do
+      assert_question_parsing ' foo \\{escaped bracketed text\\}{T}',
+        :text => "foo {escaped bracketed text}",
+        :style => :true_false
+    end
+
+
+    should "handle all kinds of escaped stuff" do
+      assert_question_parsing ' my crazy \\#\\~\\= question \\{escaped bracketed text\\}{=\\=\\#\\~foo#hi-yah}',
+        :text => "my crazy #~= question {escaped bracketed text}",
+        :style => :short_answer
+    end
+  end
+
+  context "when determining the answer style" do
+    should "return missing word when question_post is present" do
+      assert_question_parsing "foo {=bar ~baz} cheese.",
+        :text => "foo",
+        :text_post => "cheese.",
+        :style => :missing_word
+    end
+  end
+end

data/test/quiz_test.rb

@@ -0,0 +1,65 @@
+require 'test_helper'
+
+class QuizTest < Test::Unit::TestCase
+  context "simple question" do
+    setup do
+      @single_question = "This is a really lame question"
+      @single_answer = "{T}"
+    end
+
+    should "remove commented lines before parsing" do
+      file = File.open(File.join(File.dirname(__FILE__), *%w[fixtures begins_with_comment.txt]))
+      Gipper::Quiz.new.iterate_through file.read do |q|
+        assert_equal "1=1{T}", q
+      end
+    end
+  end
+
+  should "return just a question mark for question_post when question_post is just a question mark" do
+    quiz = Gipper::Quiz.parse 'You say that, "money is the root of all evil", I ask you "what is the root of all {~honey ~bunnies =money}?"'
+    assert_equal 'You say that, "money is the root of all evil", I ask you "what is the root of all', quiz[0].text
+    assert_equal '?"', quiz[0].text_post
+
+    answers = quiz[0].answer
+    assert_false answers[0].correct
+    assert_equal "honey", answers[0].text
+    assert_false answers[1].correct
+    assert_equal "bunnies", answers[1].text
+    assert answers[2].correct
+    assert_equal "money", answers[2].text
+  end
+
+  context "(when passed an empty string)" do
+    should "should return an empty array" do
+      quiz = Gipper::Quiz.parse("")
+      assert_equal [], quiz
+    end
+  end
+
+  context "(when passed more than one question)" do
+    should "should return an array with questions" do
+      q = []
+      q << true_false_question("Weather Patterns in the Pacific Northwest", "Seattle is rainy.", "{T}")
+      q << true_false_question("", "Seattle has lots of water.", "{T}")
+      q << true_false_question("Accessories in the Pacific Northwest", "People in Seattle use umbrellas:", "{T}")
+
+      multiple_input = "//opening comment\r\n//another comment\r\n\r\n\r\n#{q[0]}\r\n//this is a \r\n//couple rows of comments\r\n\r\n#{q[1]}\r\n\r\n#{q[2]}"
+
+      Gipper::Quiz.new.iterate_through(multiple_input) do |qu|
+        assert q.include?(qu)
+      end
+    end
+
+    should "ignore whitespace between questions" do
+      quiz = "a\r\n\t\r\nb\r\n      \r\nc\r\n\r\nd"
+      count = 0
+
+      Gipper::Quiz.new.iterate_through(quiz) do |qu|
+        expected = ['a', 'b', 'c', 'd']
+        assert_equal expected[count], qu
+        count = count + 1
+      end
+      assert_equal 4, count
+    end
+  end
+end

data/test/special_character_handler_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+
+class SpecialCharacterHandlerTest < Test::Unit::TestCase
+  include Gipper::SpecialCharacterHandler
+
+  context "striping escapes" do
+    should "leave normal text alone" do
+      result = unescape("This is some normal text.")
+      assert_equal "This is some normal text.", result
+    end
+
+    #(~|=|#|\{|\})
+    should "remove escape from escaped twiddles" do
+      result = unescape("This is some twiddled \\~ text.")
+      assert_equal "This is some twiddled ~ text.", result
+    end
+
+    should "remove escape from escaped equals" do
+      result = unescape("This is some equaled \\= text.")
+      assert_equal "This is some equaled = text.", result
+    end
+
+    should "remove escape from escaped pounded" do
+      result = unescape("This is some pounded \\# text.")
+      assert_equal "This is some pounded # text.", result
+    end
+
+    should "remove escape from escaped left brackets" do
+      result = unescape("This is some left bracketed \\{ text.")
+      assert_equal "This is some left bracketed { text.", result
+    end
+
+    should "remove escape from escaped right brackets" do
+      result = unescape("This is some right bracketed \\} text.")
+      assert_equal "This is some right bracketed } text.", result
+    end
+
+    should "not remove escapes from other characters" do
+      result = unescape("\\This \\is \\some \\normal \\text\\.")
+      assert_equal "\\This \\is \\some \\normal \\text\\.", result
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'custom_assertions'
+require 'gipper'
+
+class Test::Unit::TestCase
+  include CustomAssertions
+  def true_false_question title, question, answer
+    if title
+      "::#{title}::#{question}#{answer}"
+    else
+      "#{question}#{answer}"
+    end
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: gipper
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jamal Hansen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-22 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: oniguruma
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: technicalpickles-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: jamal.hansen@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- docs/gift_reference.pdf
+- features/fixtures/matching.gift
+- features/fixtures/missing_word.gift
+- features/fixtures/multiple_choice.gift
+- features/fixtures/numerical.gift
+- features/fixtures/short_answer.gift
+- features/fixtures/super_gift.txt
+- features/fixtures/true_or_false.gift
+- features/gift_parsing.feature
+- features/parse_matching_questions.feature
+- features/parse_missing_word.feature
+- features/parse_multiple_choice_questions.feature
+- features/parse_numerical_questions.feature
+- features/parse_short_answer_questions.feature
+- features/parse_true_or_false_questions.feature
+- features/steps/gift_parsing_steps.rb
+- features/steps/parse_matching_steps.rb
+- features/steps/parse_missing_word_steps.rb
+- features/steps/parse_multiple_choice_steps.rb
+- features/steps/parse_numerical_steps.rb
+- features/steps/parse_short_answer_steps.rb
+- features/steps/parse_steps.rb
+- features/steps/parse_true_or_false_steps.rb
+- features/support/env.rb
+- lib/answer.rb
+- lib/answers.rb
+- lib/gipper.rb
+- lib/question.rb
+- lib/quiz.rb
+- lib/special_charater_handler.rb
+- script/txt2html
+- script/txt2html.cmd
+- tasks/rspec.rake
+- test/answer_test.rb
+- test/answers_test.rb
+- test/custom_assertions.rb
+- test/fixtures/begins_with_comment.txt
+- test/question_test.rb
+- test/quiz_test.rb
+- test/special_character_handler_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/rubyyot/gipper
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: gipper
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A gem for parsing the GIFT quiz file format
+test_files: 
+- test/custom_assertions.rb
+- test/quiz_test.rb
+- test/question_test.rb
+- test/test_helper.rb
+- test/answer_test.rb
+- test/special_character_handler_test.rb
+- test/answers_test.rb