qti 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c740d1b3ac0a16f4661dd5ec3fe25691e3aacc4
-  data.tar.gz: d487bd97b470c0948c4512e52cab356777c28674
+  metadata.gz: afd52bad22c9796edfbb8fd2fe412c955b0099a7
+  data.tar.gz: 73018306444c63ced0e4f45cc4b7d6a21a40ec99
 SHA512:
-  metadata.gz: af2cbeb0a5efc6aefd940b238b57a6bc5c273b0601096323ea6beece7137b6c1fcacaa28c6a98840704d656d22bd3214d2661874bc6ad796a4b68b4813caeb2a
-  data.tar.gz: 4b3b108554561f85eda5915f773b301ea396f6ec7e39ea2c46963498ab479f717b5f9f4198682c0bf86c73730f7f665cf330950fca3a69277c776fafb0bf25bd
+  metadata.gz: c96942dbe69be8e0bcedc61fd42d606d9d7d0cb14612d7d50e80dc17b52e1a363db023e0ba818e2c9bd533862cc25c9fa9ef68af5f5c1cd2c8e7af472fbd09c5
+  data.tar.gz: e6d932d96f046715d18fac372b095c01a416f300bb1383bef7b6f609ad51bb7bc52e86d9fda7d968b14ced89ccc7ab2631003dd8337c13f37597376b53417c86

data/lib/qti/assessment_item_exporter.rb

@@ -1,23 +1,26 @@
 module Qti
   class AssessmentItemExporter
-    attr_reader :index, :assessment_item, :package_root_path
+    attr_reader :assessment_item, :package_root_path, :exported_file_path
 
-    def initialize(index, assessment_item, args = {})
-      @index = index
+    def initialize(assessment_item, args = {})
       @assessment_item = assessment_item
       @package_root_path = args[:package_root_path] || '.'
     end
 
+    def exported_file_path
+      @exported_file_path ||= File.join(package_root_path, "#{assessment_item.identifier}.xml")
+    end
+
     def export
-      File.open(File.join(package_root_path, "item-#{index + 1}.xml"), 'wb') do |f|
-        f.write xml_string_for_assessment_item(assessment_item)
+      File.open(exported_file_path, 'wb') do |f|
+        f.write xml_string_for_assessment_item
       end
     end
 
     private
 
-    def xml_string_for_assessment_item(assessment_item)
-      builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+    def xml_string_for_assessment_item
+      Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
         xml.assessmentItem(assesment_item_attributes) do
           xml.responseDeclaration('identifier' => 'RESPONSE',
                                   'cardinality' => cardinality_for_response(assessment_item),
@@ -28,8 +31,7 @@ module Qti
           end
           xml_assessment_item_body(xml, assessment_item)
         end
-      end
-      builder.to_xml
+      end.to_xml
     end
 
     def cardinality_for_response(assessment_item)
@@ -60,8 +62,8 @@ module Qti
     def assesment_item_attributes
       { 'xmlns' => 'http://www.imsglobal.org/xsd/imsqti_v2p2', 'xmlns:xi' => 'http://www.w3.org/2001/XInclude',
         'xmlns:m' => 'http://www.w3.org/1998/Math/MathML', 'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
-        'xsi:schemaLocation' => 'http://www.imsglobal.org/xsd/imsqti_v2p2
-                                 http://www.imsglobal.org/xsd/qti/qtiv2p2/imsqti_v2p2.xsd' }
+        'xsi:schemaLocation' => 'http://www.imsglobal.org/xsd/imsqti_v2p2 ' \
+                                'http://www.imsglobal.org/xsd/qti/qtiv2p2/imsqti_v2p2.xsd' }
     end
   end
 end

data/lib/qti/exporter.rb

@@ -29,18 +29,20 @@ module Qti
     end
 
     def create_assessment_xml
-      builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+      File.open(File.join(package_root_path, 'assessment.xml'), 'wb') do |f|
+        f.write assessment_xml_string
+      end
+    end
+
+    def assessment_xml_string
+      Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
         xml.assessmentTest(assesment_test_attributes(title: assessment_test.title)) do
           outcome_declarations(xml, assessment_test)
           xml.testPart do
             xml_assessment_section(xml)
           end
         end
-      end
-
-      File.open(File.join(package_root_path, 'assessment.xml'), 'wb') do |f|
-        f.write builder.to_xml
-      end
+      end.to_xml
     end
 
     def outcome_declarations(xml, assessment_test)
@@ -56,9 +58,11 @@ module Qti
     end
 
     def xml_assessment_section(xml)
-      xml.assessmentSection('identifier' => 'S1', 'visible' => 'true', 'title' => 'Section 1') do
-        assessment_test.items.each_with_index do |item, index|
-          xml.assessmentItemRef('identifier' => item.identifier, 'href' => "item-#{index + 1}.xml")
+      unless assessment_test.items.empty?
+        xml.assessmentSection('identifier' => 'S1', 'visible' => 'true', 'title' => 'Section 1') do
+          assessment_test.items.each do |item|
+            xml.assessmentItemRef('identifier' => item.identifier, 'href' => "#{item.identifier}.xml")
+          end
         end
       end
     end
@@ -123,15 +127,15 @@ module Qti
     end
 
     def export_items
-      assessment_test.items.each_with_index do |assessment_item, index|
-        Qti::AssessmentItemExporter.new(index, assessment_item, package_root_path: package_root_path).export
+      assessment_test.items.each do |assessment_item|
+        Qti::AssessmentItemExporter.new(assessment_item, package_root_path: package_root_path).export
       end
     end
 
     def assesment_test_attributes(args = {})
       { 'xmlns' => 'http://www.imsglobal.org/xsd/imsqti_v2p2', 'xmlns:xi' => 'http://www.w3.org/2001/XInclude',
         'xmlns:m' => 'http://www.w3.org/1998/Math/MathML', 'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
-        'xsi:schemaLocation' => 'http://www.imsglobal.org/xsd/imsqti_v2p2' \
+        'xsi:schemaLocation' => 'http://www.imsglobal.org/xsd/imsqti_v2p2 ' \
         'http://www.imsglobal.org/xsd/qti/qtiv2p2/imsqti_v2p2.xsd' }.merge(args)
     end
 

data/spec/lib/qti/assessment_item_exporter_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Qti::AssessmentItemExporter do
+  let(:assessment_item) do
+    Qti::ContentPackaging::AssessmentItem.new(
+      identifier: '1', title: 'Question 1', response: 'true',
+      interaction: Qti::ContentPackaging::ChoiceInteraction.new(
+        prompt: 'Is 1+1 equals 2?', maxChoices: 1,
+        choices: [
+          Qti::ContentPackaging::SimpleChoice.new(
+            identifier: 'true', body: 'True'
+          ),
+          Qti::ContentPackaging::SimpleChoice.new(
+            identifier: 'false', body: 'False'
+          )
+        ]
+      )
+    )
+  end
+
+  describe '#export' do
+    it 'generates the xml for an item' do
+      dir = Dir.mktmpdir
+      exporter = Qti::AssessmentItemExporter.new(1, assessment_item, package_root_path: dir)
+      exporter.export
+
+      expect(exporter.exported_file_path).to have_file_content(
+        <<-XML.strip_heredoc
+          <?xml version="1.0" encoding="UTF-8"?>
+          <assessmentItem xmlns="http://www.imsglobal.org/xsd/imsqti_v2p2" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:m="http://www.w3.org/1998/Math/MathML" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.imsglobal.org/xsd/imsqti_v2p2 http://www.imsglobal.org/xsd/qti/qtiv2p2/imsqti_v2p2.xsd">
+            <responseDeclaration identifier="RESPONSE" cardinality="single" baseType="identifier">
+              <correctResponse>
+                <value>true</value>
+              </correctResponse>
+            </responseDeclaration>
+            <itemBody>
+              <choiceInteraction responseIdentifier="RESPONSE" shuffle="false" maxChoices="1">
+                <prompt>Is 1+1 equals 2?</prompt>
+                <simpleChoice identifier="true" fixed="true">True</simpleChoice>
+                <simpleChoice identifier="false" fixed="true">False</simpleChoice>
+              </choiceInteraction>
+            </itemBody>
+          </assessmentItem>
+        XML
+      )
+    end
+  end
+end

data/spec/lib/qti/exporter_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe Qti::Exporter do
+  let(:empty_assessment_test) do
+    Qti::ContentPackaging::AssessmentTest.new(
+      title: 'Empty test',
+      items: [],
+      outcome_declarations: []
+    )
+  end
+
+  let(:assessment_test) do
+    Qti::ContentPackaging::AssessmentTest.new(
+      title: 'Example test',
+      items: [
+        Qti::ContentPackaging::AssessmentItem.new(
+          identifier: '0b8664be39cf69ef76402f3e41eb05', title: 'Question 1', response: 'true',
+          interaction: Qti::ContentPackaging::ChoiceInteraction.new(
+            prompt: 'Is 1+1 equals 2?', maxChoices: 1,
+            choices: [
+              Qti::ContentPackaging::SimpleChoice.new(
+                identifier: 'true', body: 'True'
+              ),
+              Qti::ContentPackaging::SimpleChoice.new(
+                identifier: 'false', body: 'False'
+              )
+            ]
+          )
+        )
+      ],
+      outcome_declarations: [
+        Qti::ContentPackaging::OutcomeDeclaration.new(
+          identifier: 'TEST_total', baseType: 'float', cardinality: 'single', defaultValue: 0.0
+        ),
+        Qti::ContentPackaging::OutcomeDeclaration.new(
+          identifier: 'S1', baseType: 'float', cardinality: 'single', defaultValue: 0.0
+        )
+      ]
+    )
+  end
+
+  describe '#export' do
+    it 'generates the xml for the empty assessment' do
+      dir = Dir.mktmpdir
+
+      exporter = Qti::Exporter.new(empty_assessment_test, package_root_path: dir)
+      exporter.export
+
+      expect(exporter.exported_file_path).to have_zip_entry('assessment.xml').with_content(
+        <<-XML.strip_heredoc
+          <?xml version="1.0" encoding="UTF-8"?>
+          <assessmentTest xmlns="http://www.imsglobal.org/xsd/imsqti_v2p2" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:m="http://www.w3.org/1998/Math/MathML" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.imsglobal.org/xsd/imsqti_v2p2 http://www.imsglobal.org/xsd/qti/qtiv2p2/imsqti_v2p2.xsd" title="Empty test">
+            <testPart/>
+          </assessmentTest>
+        XML
+      )
+    end
+
+    it 'generates the xml for an assessment with an item' do
+      dir = Dir.mktmpdir
+
+      exporter = Qti::Exporter.new(assessment_test, package_root_path: dir)
+      exporter.export
+
+      expect(exporter.exported_file_path).to contain_zip_entry('imsmanifest.xml')
+      expect(exporter.exported_file_path).to contain_zip_entry('0b8664be39cf69ef76402f3e41eb05.xml')
+      expect(exporter.exported_file_path).to have_zip_entry('assessment.xml').with_content(
+        <<-XML.strip_heredoc
+          <?xml version="1.0" encoding="UTF-8"?>
+          <assessmentTest xmlns="http://www.imsglobal.org/xsd/imsqti_v2p2" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:m="http://www.w3.org/1998/Math/MathML" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.imsglobal.org/xsd/imsqti_v2p2 http://www.imsglobal.org/xsd/qti/qtiv2p2/imsqti_v2p2.xsd" title="Example test">
+            <outcomeDeclaration baseType="float" cardinality="single" identifier="TEST_total">
+              <defaultValue>
+                <value>0</value>
+              </defaultValue>
+            </outcomeDeclaration>
+            <outcomeDeclaration baseType="float" cardinality="single" identifier="S1">
+              <defaultValue>
+                <value>0</value>
+              </defaultValue>
+            </outcomeDeclaration>
+            <testPart>
+              <assessmentSection identifier="S1" visible="true" title="Section 1">
+                <assessmentItemRef identifier="0b8664be39cf69ef76402f3e41eb05" href="0b8664be39cf69ef76402f3e41eb05.xml"/>
+              </assessmentSection>
+            </testPart>
+          </assessmentTest>
+        XML
+      )
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,10 +1,11 @@
 require 'bundler/setup'
 require 'byebug'
-
 Bundler.setup
 
 require 'qti'
 
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
+
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
     expectations.syntax = :expect

data/spec/support/custom_matchers.rb

@@ -0,0 +1,42 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :have_file_content do |expected|
+  match do |actual|
+    File.read(actual) == expected
+  end
+end
+
+RSpec::Matchers.define :contain_zip_entry do |entry|
+  match do |file_path|
+    zip_entry = Zip::File.open(file_path) do |zip_file|
+      zip_file.glob(entry).first
+    end
+    expect(zip_entry).to be_present
+  end
+end
+
+RSpec::Matchers.define :have_zip_entry do |entry|
+  match do |file_path|
+    expect(file_content_in_zip_file(file_path, entry)).to eq(@expected_content)
+  end
+
+  failure_message do |file_path|
+    c = file_content_in_zip_file(file_path, entry)
+    if c.empty?
+      "expect #{file_path} to contain an entry #{entry}"
+    elsif c != @expected_content
+      RSpec::Support::Differ.new.diff(c, @expected_content)
+    end
+  end
+
+  def file_content_in_zip_file(file_path, entry)
+    Zip::File.open(file_path) do |zip_file|
+      e = zip_file.glob(entry).first
+      e.get_input_stream.read
+    end
+  end
+
+  chain :with_content do |expected_content|
+    @expected_content = expected_content
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qti
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Hannah Bottalla
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-06 00:00:00.000000000 Z
+date: 2017-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -186,10 +186,8 @@ files:
 - lib/qti/content_packaging/outcome_declaration.rb
 - lib/qti/content_packaging/simple_choice.rb
 - lib/qti/exporter.rb
-- lib/qti/item_exporter_factory.rb
 - lib/qti/models/base.rb
 - lib/qti/models/manifest.rb
-- lib/qti/true_false_item_exporter.rb
 - lib/qti/v1/models/assessment.rb
 - lib/qti/v1/models/assessment_item.rb
 - lib/qti/v1/models/base.rb
@@ -366,20 +364,22 @@ files:
 - spec/fixtures/tests/tests/rtest25.xml
 - spec/fixtures/tests/tests/rtest26.xml
 - spec/fixtures/tests/tests/rtest27.xml
-- spec/qti/exporter_spec.rb
-- spec/qti/models/base_spec.rb
-- spec/qti/models/manifest_spec.rb
-- spec/qti/v1/models/assessment_item_spec.rb
-- spec/qti/v1/models/assessment_spec.rb
-- spec/qti/v1/models/choices/logical_identifier_choice_spec.rb
-- spec/qti/v1/models/interactions/logical_identifier_interaction_spec.rb
-- spec/qti/v2/models/assessment_item_spec.rb
-- spec/qti/v2/models/assessment_test_spec.rb
-- spec/qti/v2/models/choices/simple_choice_spec.rb
-- spec/qti/v2/models/interactions/choice_interaction_spec.rb
-- spec/qti/v2/models/interactions/extended_text_interaction_spec.rb
-- spec/qti_spec.rb
+- spec/lib/qti/assessment_item_exporter_spec.rb
+- spec/lib/qti/exporter_spec.rb
+- spec/lib/qti/models/base_spec.rb
+- spec/lib/qti/models/manifest_spec.rb
+- spec/lib/qti/v1/models/assessment_item_spec.rb
+- spec/lib/qti/v1/models/assessment_spec.rb
+- spec/lib/qti/v1/models/choices/logical_identifier_choice_spec.rb
+- spec/lib/qti/v1/models/interactions/logical_identifier_interaction_spec.rb
+- spec/lib/qti/v2/models/assessment_item_spec.rb
+- spec/lib/qti/v2/models/assessment_test_spec.rb
+- spec/lib/qti/v2/models/choices/simple_choice_spec.rb
+- spec/lib/qti/v2/models/interactions/choice_interaction_spec.rb
+- spec/lib/qti/v2/models/interactions/extended_text_interaction_spec.rb
+- spec/lib/qti_spec.rb
 - spec/spec_helper.rb
+- spec/support/custom_matchers.rb
 homepage: 
 licenses: []
 metadata: {}
@@ -566,17 +566,19 @@ test_files:
 - spec/fixtures/tests/tests/rtest25.xml
 - spec/fixtures/tests/tests/rtest26.xml
 - spec/fixtures/tests/tests/rtest27.xml
-- spec/qti/exporter_spec.rb
-- spec/qti/models/base_spec.rb
-- spec/qti/models/manifest_spec.rb
-- spec/qti/v1/models/assessment_item_spec.rb
-- spec/qti/v1/models/assessment_spec.rb
-- spec/qti/v1/models/choices/logical_identifier_choice_spec.rb
-- spec/qti/v1/models/interactions/logical_identifier_interaction_spec.rb
-- spec/qti/v2/models/assessment_item_spec.rb
-- spec/qti/v2/models/assessment_test_spec.rb
-- spec/qti/v2/models/choices/simple_choice_spec.rb
-- spec/qti/v2/models/interactions/choice_interaction_spec.rb
-- spec/qti/v2/models/interactions/extended_text_interaction_spec.rb
-- spec/qti_spec.rb
+- spec/lib/qti/assessment_item_exporter_spec.rb
+- spec/lib/qti/exporter_spec.rb
+- spec/lib/qti/models/base_spec.rb
+- spec/lib/qti/models/manifest_spec.rb
+- spec/lib/qti/v1/models/assessment_item_spec.rb
+- spec/lib/qti/v1/models/assessment_spec.rb
+- spec/lib/qti/v1/models/choices/logical_identifier_choice_spec.rb
+- spec/lib/qti/v1/models/interactions/logical_identifier_interaction_spec.rb
+- spec/lib/qti/v2/models/assessment_item_spec.rb
+- spec/lib/qti/v2/models/assessment_test_spec.rb
+- spec/lib/qti/v2/models/choices/simple_choice_spec.rb
+- spec/lib/qti/v2/models/interactions/choice_interaction_spec.rb
+- spec/lib/qti/v2/models/interactions/extended_text_interaction_spec.rb
+- spec/lib/qti_spec.rb
 - spec/spec_helper.rb
+- spec/support/custom_matchers.rb

data/lib/qti/item_exporter_factory.rb

@@ -1,15 +0,0 @@
-module Qti
-  class ItemExporterFactory
-    EXPORTER_CLASS = { 'TrueFalse' => TrueFalseItemExporter }.freeze
-
-    def self.create(item, args = {})
-      exporter_class = EXPORTER_CLASS[item.interaction_type] || NullExporter
-      exporter_class.new(item, args)
-    end
-  end
-
-  class NullExporter < ItemExporter
-    def export
-    end
-  end
-end

data/lib/qti/true_false_item_exporter.rb

@@ -1,7 +0,0 @@
-module Qti
-  class TrueFalseItemExporter < ItemExporter
-    def export
-      xml_string_for_item(item)
-    end
-  end
-end

data/spec/qti/exporter_spec.rb

@@ -1,55 +0,0 @@
-require 'spec_helper'
-
-describe Qti::Exporter do
-  let(:assessment_test) do
-    Qti::ContentPackaging::AssessmentTest.new(
-      title: 'Example test',
-      items: [
-        Qti::ContentPackaging::AssessmentItem.new(
-          identifier: '1', title: 'Question 1', response: 'true',
-          interaction: Qti::ContentPackaging::ChoiceInteraction.new(
-            prompt: 'Is 1+1 equals 2?', maxChoices: 1,
-            choices: [
-              Qti::ContentPackaging::SimpleChoice.new(
-                identifier: 'true', body: 'True'
-              ),
-              Qti::ContentPackaging::SimpleChoice.new(
-                identifier: 'false', body: 'False'
-              )
-            ]
-          )
-        )
-      ],
-      outcome_declarations: [
-        Qti::ContentPackaging::OutcomeDeclaration.new(
-          identifier: 'TEST_total', baseType: 'float', cardinality: 'single', defaultValue: 0.0
-        ),
-        Qti::ContentPackaging::OutcomeDeclaration.new(
-          identifier: 'S1', baseType: 'float', cardinality: 'single', defaultValue: 0.0
-        )
-      ]
-    )
-  end
-
-  it 'creates the zip file' do
-    dir = Dir.mktmpdir
-
-    exporter = Qti::Exporter.new(assessment_test, package_root_path: dir)
-    exporter.export
-
-    expect(File.exist?(exporter.exported_file_path)).to be_truthy
-  end
-
-  it 'contains an imsnanifest.xml and an assessment.xml files' do
-    dir = Dir.mktmpdir
-
-    exporter = Qti::Exporter.new(assessment_test, package_root_path: dir)
-    exporter.export
-
-    Zip::File.open(exporter.exported_file_path, 'r') do |zip_file|
-      expect(zip_file.glob('imsmanifest.xml').first).to be_present
-      expect(zip_file.glob('assessment.xml').first).to be_present
-      expect(zip_file.glob('item-1.xml').first).to be_present
-    end
-  end
-end