qti 2.9.4 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e648510b781222e5d0e43ac7ba30ab1d252cf14360b38d28f03ec5231f053b6e
-  data.tar.gz: fb44120abe93da6c1237a188641d743724ce5db9c0c5a7bffe9853236d423f06
+  metadata.gz: 783579cd76121396d891a45730e833ebed9967a7366f75b61c8dca97dd429091
+  data.tar.gz: 15193545fbe7b76ae5e66906a1794f19d3b5d175c7719adb8b01b48223ffe1d2
 SHA512:
-  metadata.gz: 5d86e4792c5d904a667299bbc6f005105a064a8cf61bff5d5ca87e3d716fc08274a36804dbb1404c2a82bdd6264c039146614595edfad65f151606cb0f527588
-  data.tar.gz: 3ced8059b3d3fd86ce0604076e2f8b37a2b6820342ac102ef64b47abca8ac048675fec879ee5a60f113c104d4a9538d5150b43a55eedf90c1bf33aa31f807df7
+  metadata.gz: e2a783e103895c2f88d98e7e79c8a8024b1ef8726b7d54a03021213ac5745d6c85f0d5cb822e2034e64812e63ac2b8501067ef584a1167521be89401d08bc4b6
+  data.tar.gz: 82a518e1b780ebc9ca5177212bde1108e7980efe4f4bee9473bc753a238268b1f9bfd1ba57bf8341d668faa8ed02166e5566dcfdb61215ddd817c6b8e6d34e05

data/lib/qti/content_packaging/assessment_item.rb

@@ -1,7 +1,17 @@
 module Qti
   module ContentPackaging
     class AssessmentItem < Dry::Struct
-      constructor_type :schema
+      transform_keys(&:to_sym)
+
+      transform_types do |type|
+        if type.default?
+          type.constructor do |value|
+            value.nil? ? Dry::Types::Undefined : value
+          end
+        else
+          type
+        end
+      end
 
       attribute :identifier, Types::Strict::String
       attribute :title, Types::Strict::String

data/lib/qti/content_packaging/assessment_test.rb

@@ -1,8 +1,17 @@
 module Qti
   module ContentPackaging
     class AssessmentTest < Dry::Struct
-      constructor_type :schema
+      transform_keys(&:to_sym)
 
+      transform_types do |type|
+        if type.default?
+          type.constructor do |value|
+            value.nil? ? Dry::Types::Undefined : value
+          end
+        else
+          type
+        end
+      end
       attribute :identifier, Types::Strict::String
       attribute :title, Types::Strict::String
       attribute :items, Types::Strict::Array.of(ContentPackaging::AssessmentItem)

data/lib/qti/content_packaging/choice_interaction.rb

@@ -1,8 +1,17 @@
 module Qti
   module ContentPackaging
     class ChoiceInteraction < Dry::Struct
-      constructor_type :schema
+      transform_keys(&:to_sym)
 
+      transform_types do |type|
+        if type.default?
+          type.constructor do |value|
+            value.nil? ? Dry::Types::Undefined : value
+          end
+        else
+          type
+        end
+      end
       attribute :prompt, Types::Strict::String
       attribute :shuffle, Types::Strict::Bool.default(false)
       attribute :maxChoices, Types::Coercible::Integer

data/lib/qti/content_packaging/outcome_declaration.rb

@@ -1,8 +1,17 @@
 module Qti
   module ContentPackaging
     class OutcomeDeclaration < Dry::Struct
-      constructor_type :schema
+      transform_keys(&:to_sym)
 
+      transform_types do |type|
+        if type.default?
+          type.constructor do |value|
+            value.nil? ? Dry::Types::Undefined : value
+          end
+        else
+          type
+        end
+      end
       attribute :identifier, Types::Strict::String
       attribute :baseType, Types::Strict::String
       attribute :cardinality, Types::Strict::String

data/lib/qti/content_packaging/simple_choice.rb

@@ -1,8 +1,17 @@
 module Qti
   module ContentPackaging
     class SimpleChoice < Dry::Struct
-      constructor_type :schema
+      transform_keys(&:to_sym)
 
+      transform_types do |type|
+        if type.default?
+          type.constructor do |value|
+            value.nil? ? Dry::Types::Undefined : value
+          end
+        else
+          type
+        end
+      end
       attribute :body, Types::Strict::String
       attribute :identifier, Types::Strict::String
       attribute :fixed, Types::Strict::Bool.default(true)

data/lib/qti/content_packaging.rb

@@ -1,7 +1,7 @@
 module Qti
   module ContentPackaging
     module Types
-      include Dry::Types.module
+      include Dry.Types()
     end
   end
 end

data/lib/qti/sanitizer.rb

@@ -9,26 +9,37 @@ module Qti
     }.freeze
 
     PROTOCOLS = ['http', 'https', :relative].freeze
-    FILTER_TAGS = %w[iframe object embed].freeze
+    FILTER_TAGS = %w[iframe object embed video audio source].freeze
+    MEDIA_SRC_ATTR = %w[src data type codebase].freeze
+    MEDIA_FMT_ATTR = %w[width height classid].freeze
+    MEDIA_ALT_ATTR = %w[title alt allow allowfullscreen].freeze
+    MEDIA_EXT_ATTR = %w[data-media-type data-media-id].freeze
+    MEDIA_ATTR = [MEDIA_SRC_ATTR, MEDIA_FMT_ATTR, MEDIA_ALT_ATTR, MEDIA_EXT_ATTR].flatten.freeze
 
     CONFIG =
       {
-        elements: FILTER_TAGS,
+        elements: Sanitize::Config::RELAXED[:elements] + FILTER_TAGS,
         protocols:
           {
             'iframe' => { 'src' => PROTOCOLS },
             'object' => { 'src' => PROTOCOLS, 'data' => PROTOCOLS },
-            'embed' => { 'src' => PROTOCOLS }
-          }.freeze,
+            'embed' => { 'src' => PROTOCOLS },
+            'video' => { 'src' => PROTOCOLS },
+            'audio' => { 'src' => PROTOCOLS },
+            'source' => { 'src' => PROTOCOLS }
+          },
         attributes:
           {
-            'object' => %w[src width height style data type classid codebase],
+            'video' => MEDIA_ATTR,
+            'audio' => MEDIA_ATTR,
+            'source' => MEDIA_ATTR,
+            'object' => MEDIA_ATTR,
             'embed' => %w[name src type allowfullscreen pluginspage wmode
                           allowscriptaccess width height],
             'iframe' => %w[src width height name align frameborder scrolling sandbox
                            allowfullscreen webkitallowfullscreen mozallowfullscreen
                            allow] # TODO: remove explicit allow with domain whitelist account setting
-          }.freeze
+          }
       }.freeze
 
     def clean(html)
@@ -86,7 +97,10 @@ module Qti
       transformers << object_tag_transformer if import_objects
       transformers << remap_unknown_tags_transformer
       transformers << method(:convert_canvas_math_images) if Qti.configuration.extract_latex_from_image_tags
-      Sanitize::Config::RELAXED.merge transformers: transformers
+      Sanitize::Config.merge(
+        Sanitize::Config.merge(Sanitize::Config::RELAXED, CONFIG),
+        transformers: transformers
+      )
     end
 
     def remap_href_path(href)

data/lib/qti/v2/models/non_assessment_test.rb

@@ -29,7 +29,7 @@ module Qti
         def title
           @title ||= begin
             QTIV2_TITLE_PATHS.map do |path|
-              xpath_with_single_check(path)&.content
+              @doc.xpath(path).first&.content
             end.compact.first
           end || super
         end

data/lib/qti/version.rb

@@ -1,3 +1,3 @@
 module Qti
-  VERSION = '2.9.4'.freeze
+  VERSION = '2.11.0'.freeze
 end

data/spec/fixtures/imsqti_2.2_package/choice.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Thie example adapted from the PET Handbook, copyright University of Cambridge ESOL Examinations -->
+<assessmentItem xmlns="http://www.imsglobal.org/xsd/imsqti_v2p2"
+    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_v2p2p2.xsd"
+    identifier="choice" title="Unattended Luggage" adaptive="false" timeDependent="false">
+    <responseDeclaration identifier="RESPONSE" cardinality="single" baseType="identifier">
+        <correctResponse>
+            <value>ChoiceA</value>
+        </correctResponse>
+    </responseDeclaration>
+    <outcomeDeclaration identifier="SCORE" cardinality="single" baseType="float">
+        <defaultValue>
+            <value>0</value>
+        </defaultValue>
+    </outcomeDeclaration>
+    <itemBody>
+        <p>Look at the text in the picture.</p>
+        <p>
+            <img src="images/sign.png" alt="NEVER LEAVE LUGGAGE UNATTENDED"/>
+        </p>
+        <choiceInteraction responseIdentifier="RESPONSE" shuffle="false" maxChoices="1">
+            <prompt>What does it say?</prompt>
+            <simpleChoice identifier="ChoiceA">You must stay with your luggage at all times.</simpleChoice>
+            <simpleChoice identifier="ChoiceB">Do not let someone else look after your luggage.</simpleChoice>
+            <simpleChoice identifier="ChoiceC">Remember your luggage when you leave.</simpleChoice>
+        </choiceInteraction>
+    </itemBody>
+    <responseProcessing template="http://www.imsglobal.org/question/qti_v2p2/rptemplates/match_correct"/>
+</assessmentItem>

data/spec/fixtures/imsqti_2.2_package/imsmanifest.xml

@@ -0,0 +1,101 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--This is a Reload version 1.3 Content Package document-->
+<!--Spawned from the Reload Content Package Generator - http://www.reload.ac.uk-->
+<manifest xmlns="http://www.imsglobal.org/xsd/imscp_v1p1"
+	xmlns:imsmd="http://ltsc.ieee.org/xsd/LOM"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xmlns:imsqti="http://www.imsglobal.org/xsd/imsqti_metadata_v2p2"
+	identifier="MANIFEST-85D76736-6D19-9DC0-7C0B-57C31A9FD390"
+	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">
+	<metadata>
+		<schema>QTIv2.2 Package</schema>
+		<schemaversion>1.0.0</schemaversion>
+		<imsmd:lom>
+			<imsmd:general>
+				<imsmd:title>
+					<imsmd:string>Example Package</imsmd:string>
+				</imsmd:title>
+				<imsmd:language>en</imsmd:language>
+				<imsmd:description>
+					<imsmd:string>This is an example Contentpackage containing a
+                        single QTI v2.2 item</imsmd:string>
+				</imsmd:description>
+			</imsmd:general>
+			<imsmd:lifeCycle>
+				<imsmd:version>
+					<imsmd:string>2.1</imsmd:string>
+				</imsmd:version>
+				<imsmd:status>
+					<imsmd:source>LOMv1.0</imsmd:source>
+					<imsmd:value>Final</imsmd:value>
+				</imsmd:status>
+			</imsmd:lifeCycle>
+			<imsmd:metaMetadata>
+				<imsmd:metadataschema>LOMv1.0</imsmd:metadataschema>
+				<imsmd:metadataschema>QTIv2.1</imsmd:metadataschema>
+				<imsmd:language>en</imsmd:language>
+			</imsmd:metaMetadata>
+			<imsmd:technical>
+				<imsmd:format>text/x-imsqti-item-xml</imsmd:format>
+				<imsmd:format>image/png</imsmd:format>
+			</imsmd:technical>
+			<imsmd:rights>
+				<imsmd:description>
+					<imsmd:string>(c) 2005, IMS Global Learning Consortium;
+                        individual questions may have their own copyright statements.</imsmd:string>
+				</imsmd:description>
+			</imsmd:rights>
+		</imsmd:lom>
+	</metadata>
+	<organizations/>
+	<resources>
+		<resource identifier="RES-B38DF83F-A291-86DA-4EC3-B2CEBD1515A4" type="imsqti_item_xmlv2p2"
+			href="choice.xml">
+			<metadata>
+				<imsqti:qtiMetadata>
+					<imsqti:timeDependent>false</imsqti:timeDependent>
+					<imsqti:interactionType>choiceInteraction</imsqti:interactionType>
+					<imsqti:feedbackType>none</imsqti:feedbackType>
+					<imsqti:solutionAvailable>true</imsqti:solutionAvailable>
+				</imsqti:qtiMetadata>
+				<imsmd:lom>
+					<imsmd:general>
+						<imsmd:identifier>
+                            <imsmd:entry>choice</imsmd:entry>
+                        </imsmd:identifier>
+						<imsmd:title>
+							<imsmd:string>Unattended Luggage</imsmd:string>
+						</imsmd:title>
+						<imsmd:description>
+							<imsmd:string>This example illustrates the
+                                choiceInteraction being used to obtain a single response from the candidate.</imsmd:string>
+						</imsmd:description>
+					</imsmd:general>
+					<imsmd:lifeCycle>
+						<imsmd:version>
+							<imsmd:string>2.1</imsmd:string>
+						</imsmd:version>
+						<imsmd:status>
+							<imsmd:source>LOMv1.0</imsmd:source>
+							<imsmd:value>Final</imsmd:value>
+						</imsmd:status>
+					</imsmd:lifeCycle>
+					<imsmd:technical>
+						<imsmd:format>text/x-imsqti-item-xml</imsmd:format>
+						<imsmd:format>image/png</imsmd:format>
+					</imsmd:technical>
+					<imsmd:rights>
+						<imsmd:description>
+							<imsmd:string>This example has been adapted from the
+                                PET Handbook, copyright University of Cambridge ESOL Examinations .</imsmd:string>
+						</imsmd:description>
+					</imsmd:rights>
+				</imsmd:lom>
+			</metadata>
+			<file href="choice.xml"/>
+			<file href="images/sign.png"/>
+		</resource>
+	</resources>
+</manifest>

data/spec/lib/qti/sanitizer_spec.rb

@@ -0,0 +1,50 @@
+describe Qti::Sanitizer do
+  let(:sanitizer) { Qti::Sanitizer.new }
+
+  describe '#sanitize' do
+    it 'keeps media tags' do
+      expect(sanitizer.clean('<img>')).to eq('<img>')
+      expect(sanitizer.clean('<video>')).to eq('<video></video>')
+      expect(sanitizer.clean('<audio>')).to eq('<audio></audio>')
+      expect(sanitizer.clean('<object>')).to eq('<object></object>')
+      expect(sanitizer.clean('<embed>')).to eq('<embed>')
+    end
+
+    it 'blocks undesirable tags do' do
+      expect(sanitizer.clean('<danger>')).to eq('')
+    end
+
+    it 'allows needed media src attributes' do
+      html = '<audio src="http://a.url" data="B64" type="media" codebase="???">'
+
+      expect(sanitizer.clean(html)).to include 'src'
+      expect(sanitizer.clean(html)).to include 'data'
+      expect(sanitizer.clean(html)).to include 'type'
+      expect(sanitizer.clean(html)).to include 'codebase'
+    end
+
+    it 'allows needed media format attributes' do
+      html = '<video width="12" height=14 classid="yes">'
+
+      expect(sanitizer.clean(html)).to include 'width'
+      expect(sanitizer.clean(html)).to include 'height'
+      expect(sanitizer.clean(html)).to include 'classid'
+    end
+
+    it 'allows needed media extension attributes' do
+      html = '<object data-media-type="thing" data-media-id=123456789>'
+
+      expect(sanitizer.clean(html)).to include 'data-media-type'
+      expect(sanitizer.clean(html)).to include 'data-media-id'
+    end
+
+    it 'allows needed media alt attributes' do
+      html = '<source title="Title" alt="description" allow="fullscreen" allowfullscreen=1>'
+
+      expect(sanitizer.clean(html)).to include 'title'
+      expect(sanitizer.clean(html)).to include 'alt'
+      expect(sanitizer.clean(html)).to include 'allow'
+      expect(sanitizer.clean(html)).to include 'allowfullscreen'
+    end
+  end
+end

data/spec/lib/qti/v2/models/non_assessment_test_spec.rb

@@ -33,6 +33,14 @@ describe Qti::V2::Models::NonAssessmentTest do
     include_examples 'loading_a_non-assessment'
   end
 
+  describe 'imsqti_2.2_package' do
+    let(:path) { File.join(fixtures_path, 'imsqti_2.2_package', 'imsmanifest.xml') }
+    let(:loaded_class) { described_class.from_path!(path) }
+    let(:title) { 'Example Package' }
+
+    include_examples 'loading_a_non-assessment'
+  end
+
   # describe '#stimulus_ref' do
   #   it 'should return the stimulus ref if it exists' do
   #     item = loaded_class.assessment_items[1]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qti
 version: !ruby/object:Gem::Version
-  version: 2.9.4
+  version: 2.11.0
 platform: ruby
 authors:
 - Adrian Diaz
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-25 00:00:00.000000000 Z
+date: 2022-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -54,34 +54,54 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: dry-logic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: dry-struct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: dry-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 1.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: mathml2latex
   requirement: !ruby/object:Gem::Requirement
@@ -366,6 +386,9 @@ files:
 - spec/fixtures/canvas_cartridge/non_cc_assessments/ib5281f3537a06f58877107a2501a4e2d.xml.qti
 - spec/fixtures/edge_cases_1.2.xml
 - spec/fixtures/feedback_quiz_1.2.xml
+- spec/fixtures/imsqti_2.2_package/choice.xml
+- spec/fixtures/imsqti_2.2_package/images/sign.png
+- spec/fixtures/imsqti_2.2_package/imsmanifest.xml
 - spec/fixtures/interaction_checks_1.2.xml
 - spec/fixtures/items_1.2/canvas_multiple_dropdown.xml
 - spec/fixtures/items_1.2/canvas_multiple_dropdowns.xml
@@ -639,6 +662,7 @@ files:
 - spec/lib/qti/models/manifest_spec.rb
 - spec/lib/qti/models/metadata_spec.rb
 - spec/lib/qti/models/resource_spec.rb
+- spec/lib/qti/sanitizer_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/fill_blank_choice_spec.rb
@@ -719,6 +743,9 @@ test_files:
 - spec/fixtures/canvas_cartridge/non_cc_assessments/ib5281f3537a06f58877107a2501a4e2d.xml.qti
 - spec/fixtures/edge_cases_1.2.xml
 - spec/fixtures/feedback_quiz_1.2.xml
+- spec/fixtures/imsqti_2.2_package/choice.xml
+- spec/fixtures/imsqti_2.2_package/images/sign.png
+- spec/fixtures/imsqti_2.2_package/imsmanifest.xml
 - spec/fixtures/interaction_checks_1.2.xml
 - spec/fixtures/items_1.2/canvas_multiple_dropdown.xml
 - spec/fixtures/items_1.2/canvas_multiple_dropdowns.xml
@@ -992,6 +1019,7 @@ test_files:
 - spec/lib/qti/models/manifest_spec.rb
 - spec/lib/qti/models/metadata_spec.rb
 - spec/lib/qti/models/resource_spec.rb
+- spec/lib/qti/sanitizer_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/fill_blank_choice_spec.rb