Fixing and adding writer. Integration tests for parser.

Author: olivervbk-studiare

lib/moodle_gift_parser.rb

@@ -1,14 +1,15 @@
 module MoodleGiftParser
   require 'logger'
 
-  require 'moodle_gift_parser/parser'
+  require 'moodle_gift_parser/gift_error'
+  require 'moodle_gift_parser/invalid_gift_format_error'
+
 
   require 'moodle_gift_parser/question'
   require 'moodle_gift_parser/essay_question'
   require 'moodle_gift_parser/multiple_choice_question'
 
-  require 'moodle_gift_parser/gift_error'
-  require 'moodle_gift_parser/invalid_gift_format_error'
+  require 'moodle_gift_parser/parser'
 
   class << self
     #http://stackoverflow.com/questions/11729456/how-do-i-log-correctly-inside-my-ruby-gem
@@ -18,7 +19,7 @@ class << self
     def logger
       @logger ||= Logger.new($stdout).tap do |log|
         log.progname = self.name
-        log.level = Logger::INFO
+        log.level = Logger::DEBUG #INFO
       end
       return @logger
     end

lib/moodle_gift_parser/multiple_choice_question.rb

@@ -36,7 +36,7 @@ def self.build_alternative(is_correct)
         current_alt.credit  = 0
       end
       current_alt.content = ''
-      current_alt.comment = ''
+      current_alt.comment = nil
       return current_alt
     end
   end
@@ -109,7 +109,7 @@ def self.parse_options(options)
         if state == State::COMMENT
           raise MoodleGiftParser::InvalidGiftFormatError, "Two following comment sequences with '#' found."
         end
-
+        current_alt.comment = ''
         state  = State::COMMENT
         hashes = 0
       end

lib/moodle_gift_parser/parser.rb

@@ -14,14 +14,11 @@ def parse(content)
       question    = ''
       empty_lines = 0
       content.each_line do |line|
-        if line.length == 0
+        if line.strip.empty?
           empty_lines+=1
           if empty_lines >= 2 && !question.empty?
-            begin
-              questions << build_question(question, category, comment)
-            rescue => e
-              raise MoodleGiftParser::InvalidGiftFormatError, "Error parsing question:#{e.message}\nQuestion: '#{question}'", e.backtrace
-            end
+            MoodleGiftParser.logger.debug {"Question finished: '#{question}'"}
+            questions << build_question_wrapped(question, category, comment)
 
             question = ''
             comment  = ''
@@ -30,22 +27,38 @@ def parse(content)
         end
 
         if line.start_with?(CATEGORY_PREFIX)
-          category = line[CATEGORY_PREFIX.length..-1]
+          category = line[CATEGORY_PREFIX.length..-1].strip
+          MoodleGiftParser.logger.debug {"Found category: '#{category}'"}
           next
         end
 
         if line.start_with?(COMMENT_PREFIX)
           #concat if multiline comment
           comment = comment + line[COMMENT_PREFIX.length..-1]
+          MoodleGiftParser.logger.debug {"Found comment: '#{comment.strip}'"}
           next
         end
 
         question = question + line
       end
 
+      if !question.empty?
+        MoodleGiftParser.logger.debug {"Last question finished: '#{question}'"}
+        questions << build_question_wrapped(question, category, comment)
+      end
+
       return questions
     end
 
+    private
+    def build_question_wrapped(question, category, comment)
+      begin
+        return build_question(question, category, comment)
+      rescue => e
+        raise MoodleGiftParser::InvalidGiftFormatError, "Error parsing question:#{e.message}\nQuestion: '#{question}'", e.backtrace
+      end
+    end
+
     private
     def build_question(question_str, category, comment)
       question_text     = question_str.dup

lib/moodle_gift_parser/writer.rb

@@ -0,0 +1,14 @@
+class MoodleGiftParser::Writer
+  @output = nil
+
+  def initialize(output)
+    self.output = output
+  end
+
+  def write(questions)
+    questions.each do |q|
+      q_gift = q.to_gift
+      @output << q_gift + "\n\n"
+    end
+  end
+end

spec/example/example-gift-multiple-choice.gift

@@ -0,0 +1,36 @@
+// question: 0  name: Switch category to $system$/Default/Example Category/Sub Category
+$CATEGORY: $system$/Default/Example Category/Sub Category
+
+
+// question: 81658  name: 2017.1-U4S1-Q01
+::2017.1-U4S1-Q01::[html]<p><span>Example 1</span></p>\n<p><span>Therefore\: </span></p>\n<p><span>Question\:</span></p>{
+	~<p><span>First</span></p>
+	~<p><span>Second.</span></p>
+	=<p><span>Correct.</span></p>#<p><span>Reason.</span></p>
+	~<p><span>Fourth.</span></p>
+	~<p><span>Fifth.</span></p>
+}
+
+
+// question: 81659  name: 2017.1-U4S1-Q02
+::2017.1-U4S1-Q02::[html]<p><span>Example1 (2015)\: </span></p>\n<p><span>( )\:</span></p>{
+	~<p><span>V,V,F,V,V,V,F.</span></p>
+	~<p><span>V,F,V,V,V,F,V.</span></p>
+	=<p><span>V,V,V,V,V,V,V.</span></p>#<p><span>Reason</span></p>
+	~<p><span>V,F,F,V,V,V,V.</span></p>
+	~<p><span>F,V,V,V,V,V,V.</span></p>
+}
+
+
+$CATEGORY: $system$/Default/Example Category 2/Sub Category 2
+
+
+// question: 87569  name: 2017.1-Q03
+::2017.1-Q03::[html]<p>Image\:</p>\n<p><img src\="http\://missing.png" alt\="" width\="474" height\="282" /></p>\n<p>Figure\:</p>{
+	~<p>First.</p>
+	=<p>Second.</p>
+	~<p>Third “o”.</p>
+	~<p>Fourth.</p>
+	~<p>Fifth.</p>
+	####<p>Generic comment!.</p>
+}

spec/parser_integration_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe 'Parse file' do
+  before(:context) do
+    @parser = MoodleGiftParser::Parser.new
+  end
+
+  after(:example) do
+    expect(@questions).to have(3).items
+
+    q1 = @questions[0]
+    expect(q1).to be_a(MoodleGiftParser::MultipleChoiceQuestion)
+    expect(q1.category).to eq('$system$/Default/Example Category/Sub Category')
+    expect(q1.title).to eq('2017.1-U4S1-Q01')
+    expect(q1.markup).to eq('html')
+    expect(q1.content).to eq('<p><span>Example 1</span></p>\n<p><span>Therefore\: </span></p>\n<p><span>Question\:</span></p>')
+    expect(q1.alternatives).to have(5).items
+    alt1 = q1.alternatives[0]
+    expect(alt1.content).to eq('<p><span>First</span></p>')
+    expect(alt1.correct).to eq(false)
+    expect(alt1.comment).to eq(nil)
+    alt3 = q1.alternatives[2]
+    expect(alt3.content).to eq('<p><span>Correct.</span></p>')
+    expect(alt3.correct).to eq(true)
+    expect(alt3.comment).to eq('<p><span>Reason.</span></p>')
+
+    q2 = @questions[1]
+    expect(q2).to be_a(MoodleGiftParser::MultipleChoiceQuestion)
+    expect(q2.category).to eq('$system$/Default/Example Category/Sub Category')
+
+    q3 = @questions[2]
+    expect(q3).to be_a(MoodleGiftParser::MultipleChoiceQuestion)
+    expect(q3.category).to eq('$system$/Default/Example Category 2/Sub Category 2')
+    expect(q3.generic_comment).to eq('<p>Generic comment!.</p>')
+  end
+
+  it 'should should parse file correctly' do
+    path = File.expand_path '../example/example-gift-multiple-choice.gift', __FILE__
+    File.open(path, 'r') do |file|
+      @questions = @parser.parse(file)
+    end
+  end
+end

spec/spec_helper.rb

@@ -9,4 +9,5 @@
 RSpec.configure do |config|
 #  config.color_enabled = true
   config.formatter     = 'documentation'
+  #RAILS 5:config.file_fixture_path = "spec/example"
 end

spec/writer_single_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe 'Write MultipleChoiceQuestion' do
+  before(:example) do
+    @question = MoodleGiftParser::MultipleChoiceQuestion.new
+    @question.category = 'category'
+    @question.content = 'Content'
+    @question.markup = 'html'
+    @question.alternatives
+  end
+
+  it 'should write without comment' do
+
+  end
+
+  it 'should write with comment' do
+
+  end
+
+  it 'should write with category' do
+
+  end
+
+  it 'should write without title and markup' do
+
+  end
+end