gipper 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+*[~#]
+pkg*
+*.gemspec
+nbproject*
+spec.opts.netbeans
+coverage*
+rdoc*

data/PostInstall.txt

@@ -0,0 +1,5 @@
+------------------------------------------
+Thank you for using Gipper
+
+For more information on gipper, see http://gipper.rubyforge.org
+------------------------------------------

data/README.rdoc

@@ -0,0 +1,49 @@
+= gipper
+
+* http://gipper.rubyforge.org
+
+== DESCRIPTION:
+
+A ruby parser for the GIFT quiz file format
+
+== FEATURES/PROBLEMS:
+
+* Parses GIFT files into a usable format. 
+* Missing features - Categories, Description type questions, setting case sensitivity on short answer questions.
+
+== SYNOPSIS:
+
+  
+
+== REQUIREMENTS:
+
+* Oniguruma
+
+== INSTALL:
+
+* sudo gem install gipper
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Jamal Hansen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,69 @@
+require 'rubygems'
+require 'rake'
+require 'yaml'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "gipper"
+    gem.summary = %Q{A gem for parsing the GIFT quiz file format}
+    gem.email = "jamal.hansen@gmail.com"
+    gem.homepage = "http://github.com/rubyyot/gipper"
+    gem.authors = ["Jamal Hansen"]
+    gem.rubyforge_project = "gipper"
+    gem.add_dependency 'oniguruma'
+    gem.add_development_dependency 'technicalpickles-shoulda'
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "gipper #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Dir['tasks/**/*.rake'].each { |t| load t }

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 0
+:patch: 1

data/features/fixtures/matching.gift

@@ -0,0 +1,9 @@
+
+//My file of matching questions about emoticons
+::Intro to matching questions::
+Match the emoticon to the correct emotion:{
+=:) -> smiling
+=:D -> crazy happy
+=\(^_^)/ -> yay!
+=:( -> sad
+}

data/features/fixtures/missing_word.gift

@@ -0,0 +1,8 @@
+Sally sells {  =seashells  ~snails} by the seashore.
+
+::Hamster Tree::
+Oh woe is me, {~oh =doh!} woe is me!
+
+You say that, "money is the root of all evil", I ask you "what is the root of all {~honey ~bunnies =money}?"
+
+Ooh Eee \{Uh\} Ooh Ah Ah {=Ting Tang ~Tung Ting ~Wing Wang} Walla Walla Bing Bang!

data/features/fixtures/multiple_choice.gift

@@ -0,0 +1,41 @@
+
+
+::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: 2 name: Ninjas and you
+::Ninjas and you::
+ If you see a ninja you should: {~offer them a crunchy frog =run ~attack them}
+
+Ninjas will only attack when {~provoked ~ upset ~off duty =none of the above}
+
+One way ninjas are like a snake is: {~Ninjas have scales ~Ninjas eat rodents =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!
+}
+
+// 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.
+}
+
+
+
+

data/features/fixtures/numerical.gift

@@ -0,0 +1,10 @@
+When was Harvey D. Smith born?{#1945:5}
+
+//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.
+}
+

data/features/fixtures/short_answer.gift

@@ -0,0 +1,10 @@
+
+
+//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}
+
+Coffee is best when{ = hot = cold}
+
+The only way to spell coffee is:{=coffee}
+

data/features/fixtures/super_gift.txt

@@ -0,0 +1,169 @@
+// Basic GIFT questions
+// GIFT filter and documentation by Paul Tsuchido Shew http://ac.shew.jp.
+//---------------------------
+
+Who's buried in Grant's tomb?{~Grant ~Jefferson =no one}
+
+Grant is {~buried =entombed ~living} in Grant's tomb.
+
+//----------------------------------
+// Formatting
+//----------------------------------
+The American holiday of Thanksgiving is celebrated on the {
+   ~second
+   ~third
+   =fourth
+} Thursday of November.
+
+Japanese characters originally came from what country? {
+   ~India
+   =China
+   ~Korea
+   ~Egypt}
+         
+
+Who's buried in Grant's tomb?{=no one =nobody}
+
+Two plus two equals {=four =4}
+
+Four plus one equals {5}
+
+Three plus {2} equals five.
+
+Grant is buried in Grant's tomb.{F}
+
+    The sun rises in the east.{T}
+   
+// ------------------------------------------
+// Matching
+// There must be at least three matching pairs.
+// Matching questions do not support feedback or percentage answer weights.
+// ------------------------------------------
+
+     Matching Question. {
+         =subquestion1 -> subanswer1
+         =subquestion2 -> subanswer2
+         =subquestion3 -> subanswer3
+         }
+     
+     Match the following countries with their corresponding capitals. {
+         =Canada -> Ottawa
+         =Italy  -> Rome
+         =Japan  -> Tokyo
+         =India  -> New Delhi
+         }
+
+// ------------------------------------------
+// Numerical
+// ------------------------------------------
+
+     When was Ulysses S. Grant born? {#1822}
+
+     What is the value of pi (to 3 decimal places)? {#3.1415:0.0005}
+
+     What is the value of pi (to 3 decimal places)? {#3.141..3.142}
+
+     When was Ulysses S. Grant born? {#
+         =1822:0
+         =%50%1822:2}
+
+
+//Line Comments:
+
+// Subheading: Numerical questions below
+What's 2 plus 2? {#4}
+     
+//Question Name:
+::Kanji Origins::Japanese characters originally
+came from what country? {=China}
+
+ ::Thanksgiving Date::The American holiday of Thanksgiving is 
+ celebrated on the {~second ~third =fourth} Thursday of November.
+
+//Feedback:
+
+     What's the answer to this multiple-choice question?{
+     ~wrong answer#feedback comment on the wrong answer
+     ~another wrong answer#feedback comment on this wrong answer
+     =right answer#Very good!}
+     
+     Who's buried in Grant's tomb?{
+     =no one#excellent answer!
+     =nobody#excellent answer!}
+     
+     Grant is buried in Grant's tomb.{FALSE#No one is buried in Grant's tomb.}
+
+//Percentage Answer Weights:
+//Percentage answer weights are available for both Multiple Choice and Short Answer questions. Percentage answer weights can be included by following the tilde (for Multiple Choice) or equal sign (for Short Answer) with the desired percent enclosed within percent signs (e.g., %50%). 
+//This option can be combined with feedback comments.
+
+     Difficult question.{~wrong answer ~%50%half credit answer =full credit answer}
+          
+     ::Jesus' hometown::Jesus Christ was from {
+     ~Jerusalem#This was an important city, but the wrong answer.
+     ~%25%Bethlehem#He was born here, but not raised here.
+     ~%50%Galilee#You need to be more specific.
+     =Nazareth#Yes! That's right!}.
+     
+     ::Jesus' hometown:: Jesus Christ was from {
+     =Nazareth#Yes! That's right!
+     =%75%Nazereth#Right, but misspelled.
+     =%25%Bethlehem#He was born here, but not raised here.}
+
+//Specify text-formatting for the question
+//The question text (only) may have an optional text format specified. 
+//Currently the available formats are moodle (Moodle Auto-Format), html (HTML format), plain (Plain text format) and markdown (Markdown format). 
+//The format is specified in square brackets immediately before the question text. More information on text formats in Moodle.
+
+[markdown]The *American holiday of Thanksgiving* is celebrated on the {
+         ~second
+         ~third
+         =fourth
+     } Thursday of November.    
+     
+//Multiple Answers:
+//The Multiple Answers option is used for multiple choice questions when 
+//two or more answers must be selected in order to obtain full credit. 
+//The multiple answers option is enabled by assigning partial answer weight to
+//multiple answers, while allowing no single answer to receive full credit.
+
+     What two people are entombed in Grant's tomb? {
+          ~No one
+          ~%50%Grant
+          ~%50%Grant's wife
+          ~Grant's father }
+//Note that there is no equal sign (=) in any answer and the answers should total no more than 100%, otherwise Moodle will return an error. To avoid the problem of students automatically getting 100% by simply checking all of the answers, it is best to include negative answer weights for wrong answers.
+
+     What two people are entombed in Grant's tomb? {
+          ~%-50%No one
+          ~%50%Grant
+          ~%50%Grant's wife
+          ~%-50%Grant's father }
+          
+//Special Characters ~ = # { } :
+//These symbols ~ = # { } control the operation of this filter 
+//and cannot be used as normal text within questions. 
+//Since these symbols have a special role in determining the 
+//operation of this filter, they are called "control characters." 
+//But sometimes you may want to use one of these characters, 
+//for example to show a mathematical formula in a question. 
+//The way to get around this problem is "escaping" the control characters.
+//This means simply putting a backslash (\) before a control character 
+//so the filter will know that you want to use it as a literal character 
+//instead of as a control character. For example:
+
+     Which answer equals 5? {
+          ~ \= 2 + 2
+          = \= 2 + 3
+          ~ \= 2 + 4  }
+
+     ::GIFT Control Characters::
+     Which of the following is NOT a control character for the GIFT import format? {
+        ~ \~     # \~ is a control character.
+        ~ \=     # \= is a control character.
+        ~ \#     # \# is a control character.
+        ~ \{     # \{ is a control character.
+        ~ \}     # \} is a control character.
+        = \     # Correct! \ (backslash) is not a control character. BUT,
+                   it is used to escape the control characters.
+     }

data/features/fixtures/true_or_false.gift

@@ -0,0 +1,19 @@
+::TrueStatement about monkeys::Monkeys like to fly like ninjas.{T}
+
+// question: 0 name: TrueStatement
+::A Second TrueStatement about monkeys::
+ Monkeys roam in packs with swords.{True}
+
+Monkeys will jump from buildings without fear. {T}
+
+Monkeys have a formal system of government{False}
+
+::A Second FalseStatement about monkeys
+::Monkeys wear suits and sit around in corporate offices.{False}
+
+// question: 6 name: FalseStatement
+::A Third FalseStatement about monkeys:: Monkeys can operate heavy machinery.{F}
+
+
+
+

data/features/gift_parsing.feature

@@ -0,0 +1,10 @@
+Story: Parsing a GIFT File with multiple formats
+  As a developer
+  I want to parse a GIFT file
+  So that I can use the data in my application
+
+Scenario: read a file and return an array of questions and answers
+  Given a GIFT file
+  When I tell gipper to parse the file
+  Then I will get an array of questions and answers
+  And contains the correct questions

data/features/parse_matching_questions.feature

@@ -0,0 +1,10 @@
+Story: Parsing matching questions
+  As a developer
+  I want to parse a GIFT file containing matching questions
+  So that I can use the data in my application
+
+Scenario: read a file and return an array of questions and answers
+  Given a GIFT file of matching questions 
+  When I tell gipper to parse the file
+  Then I will get an array of questions and answers
+  And contains the correct matching questions

data/features/parse_missing_word.feature

@@ -0,0 +1,10 @@
+Story: Parsing missing word questions
+  As a developer
+  I want to parse a GIFT file containing missing word questions
+  So that I can use the data in my application
+
+Scenario: read a file and return an array of questions and answers
+  Given a GIFT file of missing word questions 
+  When I tell gipper to parse the file
+  Then I will get an array of questions and answers
+  And contains the correct missing word questions