qti 0.1.2 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d28b9b4b803434ea56ecd453295db6a28b783b69
-  data.tar.gz: 6ba9bef6b2282a140bc6093d9cf2f3f6f3f78f35
+  metadata.gz: 3c740d1b3ac0a16f4661dd5ec3fe25691e3aacc4
+  data.tar.gz: d487bd97b470c0948c4512e52cab356777c28674
 SHA512:
-  metadata.gz: 7c4491ca81bc84b3e224b1965f5e5fd0e22e27335c85260ed1756a10fbedacf15db94c5a53af2bc35f5a75fee637a71485ff2460700357891d0324f9084c94fb
-  data.tar.gz: a5ee171c6fe09d519be06d6dfdf3136e5ff364705c489bded21ac64180598ce2d5f4f4cd91538a4098f78e92a50ea12119f095baec44bcafeda987efad252b57
+  metadata.gz: af2cbeb0a5efc6aefd940b238b57a6bc5c273b0601096323ea6beece7137b6c1fcacaa28c6a98840704d656d22bd3214d2661874bc6ad796a4b68b4813caeb2a
+  data.tar.gz: 4b3b108554561f85eda5915f773b301ea396f6ec7e39ea2c46963498ab479f717b5f9f4198682c0bf86c73730f7f665cf330950fca3a69277c776fafb0bf25bd

data/lib/null_logger.rb

@@ -0,0 +1,7 @@
+class NullLogger < Logger
+  def initialize(*args)
+  end
+
+  def add(*args, &block)
+  end
+end

data/lib/qti.rb

@@ -46,6 +46,8 @@ module Qti
   end
 end
 
+require 'active_support/core_ext/string'
+
 require 'qti/models/manifest'
 require 'qti/models/base'
 
@@ -59,3 +61,11 @@ require 'qti/v2/models/choices/simple_choice'
 require 'qti/v2/models/interactions/choice_interaction'
 require 'qti/v2/models/assessment_item'
 require 'qti/v2/models/assessment_test'
+
+require 'zip'
+require 'qti/exporter'
+
+require 'qti/content_packaging'
+require 'qti/assessment_item_exporter'
+
+require 'null_logger'

data/lib/qti/assessment_item_exporter.rb

@@ -0,0 +1,67 @@
+module Qti
+  class AssessmentItemExporter
+    attr_reader :index, :assessment_item, :package_root_path
+
+    def initialize(index, assessment_item, args = {})
+      @index = index
+      @assessment_item = assessment_item
+      @package_root_path = args[:package_root_path] || '.'
+    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)
+      end
+    end
+
+    private
+
+    def xml_string_for_assessment_item(assessment_item)
+      builder = 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),
+                                  'baseType' => 'identifier') do
+            xml.correctResponse do
+              xml.value assessment_item.response
+            end
+          end
+          xml_assessment_item_body(xml, assessment_item)
+        end
+      end
+      builder.to_xml
+    end
+
+    def cardinality_for_response(assessment_item)
+      if assessment_item.response.is_a? Array
+        'multiple'
+      else
+        'single'
+      end
+    end
+
+    def xml_assessment_item_body(xml, assessment_item)
+      xml.itemBody do
+        xml.choiceInteraction(interaction_params(assessment_item.interaction)) do
+          xml.prompt assessment_item.interaction.prompt
+          assessment_item.interaction.choices.each do |choice|
+            xml.simpleChoice(choice.body, 'identifier' => choice.identifier, 'fixed' => choice.fixed)
+          end
+        end
+      end
+    end
+
+    def interaction_params(interaction)
+      { 'responseIdentifier' => 'RESPONSE',
+        'shuffle' => interaction.shuffle,
+        'maxChoices' => interaction.maxChoices }
+    end
+
+    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' }
+    end
+  end
+end

data/lib/qti/content_packaging.rb

@@ -0,0 +1,15 @@
+require 'dry-struct'
+
+module Qti
+  module ContentPackaging
+    module Types
+      include Dry::Types.module
+    end
+  end
+end
+
+require 'qti/content_packaging/outcome_declaration'
+require 'qti/content_packaging/simple_choice'
+require 'qti/content_packaging/choice_interaction'
+require 'qti/content_packaging/assessment_item'
+require 'qti/content_packaging/assessment_test'

data/lib/qti/content_packaging/assessment_item.rb

@@ -0,0 +1,10 @@
+module Qti
+  module ContentPackaging
+    class AssessmentItem < Dry::Struct
+      attribute :identifier, Types::Strict::String
+      attribute :title, Types::Strict::String
+      attribute :interaction, ContentPackaging::ChoiceInteraction
+      attribute :response, Types::Strict::Array.member(String) | Types::Strict::String
+    end
+  end
+end

data/lib/qti/content_packaging/assessment_test.rb

@@ -0,0 +1,9 @@
+module Qti
+  module ContentPackaging
+    class AssessmentTest < Dry::Struct
+      attribute :title, Types::Strict::String
+      attribute :items, Types::Strict::Array.member(ContentPackaging::AssessmentItem)
+      attribute :outcome_declarations, Types::Strict::Array.member(ContentPackaging::OutcomeDeclaration)
+    end
+  end
+end

data/lib/qti/content_packaging/choice_interaction.rb

@@ -0,0 +1,12 @@
+module Qti
+  module ContentPackaging
+    class ChoiceInteraction < Dry::Struct
+      constructor_type :schema
+
+      attribute :prompt, Types::Strict::String
+      attribute :shuffle, Types::Strict::Bool.default(false)
+      attribute :maxChoices, Types::Coercible::Int
+      attribute :choices, Types::Strict::Array.member(ContentPackaging::SimpleChoice)
+    end
+  end
+end

data/lib/qti/content_packaging/outcome_declaration.rb

@@ -0,0 +1,10 @@
+module Qti
+  module ContentPackaging
+    class OutcomeDeclaration < Dry::Struct
+      attribute :identifier, Types::Strict::String
+      attribute :baseType, Types::Strict::String
+      attribute :cardinality, Types::Strict::String
+      attribute :defaultValue, Types::Strict::String | Types::Coercible::Int | Types::Coercible::Float
+    end
+  end
+end

data/lib/qti/content_packaging/simple_choice.rb

@@ -0,0 +1,11 @@
+module Qti
+  module ContentPackaging
+    class SimpleChoice < Dry::Struct
+      constructor_type :schema
+
+      attribute :body, Types::Strict::String
+      attribute :identifier, Types::Strict::String
+      attribute :fixed, Types::Strict::Bool.default(true)
+    end
+  end
+end

data/lib/qti/exporter.rb

@@ -0,0 +1,168 @@
+module Qti
+  class Exporter
+    attr_reader :assessment_test, :package_root_path, :exported_file_path, :logger
+
+    def initialize(assessment_test, args = {})
+      @logger = args[:logger] || NullLogger.new
+      @assessment_test = assessment_test
+      @package_root_path = args[:package_root_path] || '.'
+      @exported_file_path =
+        File.join(File.expand_path('..', package_root_path), File.basename(export_file_name)) + '.zip'
+    end
+
+    def export
+      Dir.mkdir(package_root_path) unless File.exist?(package_root_path)
+      create_assessment_xml
+      create_imsmanifest_xml
+      export_items
+      compress_package
+    end
+
+    private
+
+    def export_file_name
+      @export_file_name ||= "#{assessment_test.title.camelcase.gsub(/\s+/, '')}#{file_timestamp}"
+    end
+
+    def file_timestamp
+      Time.now.utc.strftime('%Y%m%d%H%M%S')
+    end
+
+    def create_assessment_xml
+      builder = 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
+
+    def outcome_declarations(xml, assessment_test)
+      assessment_test.outcome_declarations.each do |outcome_declaration|
+        xml.outcomeDeclaration('baseType' => outcome_declaration.baseType,
+                               'cardinality' => outcome_declaration.cardinality,
+                               'identifier' => outcome_declaration.identifier) do
+          xml.defaultValue do
+            xml.value outcome_declaration.defaultValue
+          end
+        end
+      end
+    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")
+        end
+      end
+    end
+
+    def create_imsmanifest_xml
+      builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+        xml.manifest(imsmanifest_attributes) do
+          manifest_metadata(xml)
+          manifest_resources(xml)
+        end
+      end
+
+      File.open(File.join(package_root_path, 'imsmanifest.xml'), 'wb') do |f|
+        f.write builder.to_xml
+      end
+    end
+
+    def manifest_metadata(xml)
+      xml.metadata do
+        xml.schema 'QTIv2.2 Package'
+        xml.schemaversion '1.0.0'
+        learning_object_metadata(xml)
+      end
+    end
+
+    def learning_object_metadata(xml)
+      imsmd_ns = xml['imsmd']
+
+      imsmd_ns.lom do
+        imsmd_ns.general do
+          imsmd_ns.identifier do
+            imsmd_ns.entry 'FB-02'
+          end
+          imsmd_ns.title do
+            imsmd_ns.string(assessment_test.title, 'language' => 'en')
+          end
+          imsmd_ns.language 'en'
+          imsmd_ns.description do
+            imsmd_ns.string('Instructure QTI package.' \
+            'Feedback XML used as an example of unprocessable entity', 'language' => 'en')
+          end
+        end
+        keywords(xml)
+      end
+    end
+
+    def keywords(xml)
+      keywords = %w(feedback modal test inline block)
+      keywords.each do |keyword|
+        xml['imsmd'].keyword do
+          xml['imsmd'].string(keyword, 'language' => 'en')
+        end
+      end
+    end
+
+    def manifest_resources(xml)
+      xml.resources do
+        xml.resource('href' => 'assessment.xml', 'type' => 'imsqti_test_xmlv2p2', 'identifier' => 'TEST') do
+          xml.file('href' => 'assessment.xml')
+        end
+      end
+    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
+      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' \
+        'http://www.imsglobal.org/xsd/qti/qtiv2p2/imsqti_v2p2.xsd' }.merge(args)
+    end
+
+    def imsmanifest_attributes
+      { 'xmlns' => 'http://www.imsglobal.org/xsd/imscp_v1p1', 'xmlns:imsmd' => 'http://ltsc.ieee.org/xsd/LOM',
+        'xmlns:imsqti' => 'http://www.imsglobal.org/xsd/imsqti_v2p2', 'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+        'xsi:schemaLocation' => 'http://www.imsglobal.org/xsd/imscp_v1p1 ' \
+                                'http://www.imsglobal.org/xsd/qti/qtiv2p2/qtiv2p2_imscpv1p2_v1p0.xsd' \
+                                'http://ltsc.ieee.org/xsd/LOM http://www.imsglobal.org/xsd/imsmd_loose_v1p3p2.xsd' \
+                                'http://www.imsglobal.org/xsd/imsqti_metadata_v2p2' \
+                                'http://www.imsglobal.org/xsd/qti/qtiv2p2/imsqti_metadata_v2p2.xsd' }
+    end
+
+    def compress_package
+      Zip::File.open(exported_file_path, 'w') do |zipfile|
+        add_all_files(zipfile, package_root_path)
+      end
+
+      FileUtils.rm_rf(package_root_path)
+      exported_file_path
+    end
+
+    def add_all_files(zipfile, package_root_path)
+      Dir["#{package_root_path}/**/**"].each do |file|
+        begin
+          entry = file.sub(package_root_path + '/', '')
+          zipfile.add(entry, file)
+        rescue Zip::EntryExistsError
+          logger.info("#{file} already exists")
+        end
+      end
+    end
+  end
+end

data/lib/qti/item_exporter_factory.rb

@@ -0,0 +1,15 @@
+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

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

data/spec/qti/exporter_spec.rb

@@ -0,0 +1,55 @@
+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

data/spec/spec_helper.rb

@@ -1,4 +1,6 @@
 require 'bundler/setup'
+require 'byebug'
+
 Bundler.setup
 
 require 'qti'

metadata

@@ -1,15 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: qti
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.2
 platform: ruby
 authors:
 - Hannah Bottalla
+- Robinson Rodríguez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-26 00:00:00.000000000 Z
+date: 2017-03-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +67,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.0.5
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -111,16 +168,28 @@ dependencies:
 description: 
 email:
 - hannah@instructure.com
-- eng@instructure.com
+- rrodriguez-bd@instructure.com
+- quizzes@instructure.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
 - Rakefile
+- lib/null_logger.rb
 - lib/qti.rb
+- lib/qti/assessment_item_exporter.rb
+- lib/qti/content_packaging.rb
+- lib/qti/content_packaging/assessment_item.rb
+- lib/qti/content_packaging/assessment_test.rb
+- lib/qti/content_packaging/choice_interaction.rb
+- 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
@@ -297,6 +366,7 @@ 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
@@ -496,6 +566,7 @@ 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