qti 2.7.1 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01dd841b1a9215aeaddf4e9211f7e2327544067afa5fb2e24a58186f7c035115
-  data.tar.gz: b4d688f36fb284da0ba8168463b667eb59bf612b2750ef50650230dcc129e2bb
+  metadata.gz: 795e15592723e240bf42bb23030ae237606cdb9c4191ce010bf241ae1d23d6f7
+  data.tar.gz: ce7a0e634699b57c08ce425d247b928405b36de2dc98f34435dbf6e84e7e4551
 SHA512:
-  metadata.gz: 301bfa283539d68e2feca734a9aa97046c2604c5eedc8f656e217cdbd90949d3ddf88dcdda39ecbb1c19dde68d0b51c5f582aa9b33c3f79995109e921126dbe2
-  data.tar.gz: 880e9ce56fe47276d833ab1b19d1f6b30646cf5a641ddce0f7e6468bb9922b05ccfd5ff140b413f7e8698c532798ade8fa50262a37e93231cfef5af5b3417ae8
+  metadata.gz: 2699fb585fa48d0ee298426ae9ecca58724f5298cc3422e0d5363acbffae04bc3e58502bd72e7cc7433571975cb0152c81887d743412678c4a79bc691dfde2e0
+  data.tar.gz: 8b6bd0ac53d3c5783c7ebdea6d2cabe238b37ccb0365ae8ef045207a1d9d1493ebc48f4ae13371a4ecb872ca67fdbc8d9232e45c156e6c83e70b10fa311161db

data/lib/qti/sanitizer.rb

@@ -37,6 +37,18 @@ module Qti
 
     private
 
+    def convert_canvas_math_images(env)
+      node = env[:node]
+      node_name = env[:node_name]
+      latex = node['data-equation-content']
+
+      return if env[:is_whitelisted] || !env[:node].element?
+      return unless node_name == 'img'
+      return unless latex
+
+      node.replace("\\(#{latex}\\)")
+    end
+
     def object_tag_transformer
       lambda do |env|
         return unless env[:node_name] == 'object'
@@ -73,6 +85,7 @@ module Qti
       transformers << src_transformers
       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
     end
 

data/lib/qti/v1/models/interactions/base_fill_blank_interaction.rb

@@ -9,7 +9,7 @@ module Qti
             item_prompt.split(CANVAS_REGEX).map.with_index do |stem_item, index|
               if canvas_fib_response_ids.include?(stem_item)
                 # Strip the brackets before searching
-                stem_blank(index, canvas_blank_id(stem_item[1..-2]))
+                stem_blank(index, stem_item[1..-2])
               else
                 stem_text(index, stem_item)
               end
@@ -21,7 +21,8 @@ module Qti
               id: "stem_#{index}",
               position: index + 1,
               type: 'blank',
-              blank_id: value
+              blank_id: blank_id(value),
+              blank_name: value
             }
           end
 
@@ -34,6 +35,15 @@ module Qti
             }
           end
 
+          def blank_id(stem_item)
+            return stem_item unless canvas_custom_fitb?
+            canvas_blank_id(stem_item)
+          end
+
+          def canvas_custom_fitb?
+            @canvas_custom_fitb ||= BaseInteraction.canvas_custom_fitb?(@node)
+          end
+
           def canvas_blank_id(stem_item)
             blank_id = nil
             node.xpath('.//xmlns:response_lid/xmlns:material').children.map do |response_lid_node|

data/lib/qti/v1/models/interactions/base_interaction.rb

@@ -9,6 +9,11 @@ module Qti
             false
           end
 
+          def self.canvas_custom_fitb?(node)
+            qtype = question_type(node)
+            %w[fill_in_multiple_blanks_question multiple_dropdowns_question].include? qtype
+          end
+
           def self.canvas_multiple_fib?(node)
             matches = node.xpath('.//xmlns:response_lid')
             return false if matches.count < 1

data/lib/qti/v1/models/object_bank.rb

@@ -19,6 +19,12 @@ module Qti
             './/xmlns:qtimetadatafield/xmlns:fieldlabel[text()="bank_type"]/../xmlns:fieldentry'
           )&.content
         end
+
+        def bank_context_uuid
+          @bank_context_uuid ||= xpath_with_single_check(
+            './/xmlns:qtimetadatafield/xmlns:fieldlabel[text()="bank_context_uuid"]/../xmlns:fieldentry'
+          )&.content
+        end
       end
     end
   end

data/lib/qti/version.rb

@@ -1,3 +1,3 @@
 module Qti
-  VERSION = '2.7.1'.freeze
+  VERSION = '2.9.0'.freeze
 end

data/lib/qti.rb

@@ -4,6 +4,7 @@ require 'active_support/core_ext/string'
 require 'active_support/core_ext/hash/except'
 require 'active_support/core_ext/module/delegation'
 require 'dry-struct'
+require 'ostruct'
 require 'find'
 require 'forwardable'
 require 'mathml2latex'
@@ -68,6 +69,14 @@ module Qti
       @import.create_question_group(question_group_ref)
     end
   end
+
+  def self.configuration
+    @configuration ||= OpenStruct.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
 end
 
 # The load order of all of these is important.

data/spec/fixtures/items_1.2/true_false.xml

@@ -5,7 +5,7 @@
       <item title="Grading - specific - 3 pt score" ident="QUE_1003">
         <presentation>
           <material>
-            <mattext texttype="text/html"><![CDATA[If I get a 3, I must have done something wrong. <img align="bottom" alt="image.png" src="org0/images/image.png" border="0"/>]]></mattext>
+            <mattext texttype="text/html"><![CDATA[If I get a 3, I must have done something wrong. <img data-equation-content="sample equation" script="alert('bad')" align="bottom" alt="image.png" src="org0/images/image.png" border="0"/> <img script="alert('bad')" align="bottom" alt="image.png" src="org0/images/image.png" border="0"/>]]></mattext>
           </material>
           <response_lid ident="QUE_1004_RL" rcardinality="Single" rtiming="No">
             <render_choice shuffle="Yes">

data/spec/lib/qti/v1/models/assessment_item_spec.rb

@@ -29,6 +29,18 @@ describe Qti::V1::Models::AssessmentItem do
     it 'has sanitized item_body' do
       expect(loaded_class.item_body).to include '<img'
       expect(loaded_class.item_body).to include 'If I get a 3, I must have done something wrong.'
+      expect(loaded_class.item_body).not_to include 'script="alert(\'bad\')"'
+    end
+
+    it 'transforms canvas math content when conversion is enabled' do
+      expect(loaded_class.item_body).to include '\(sample equation\)'
+    end
+
+    it 'does not transform math content when conversion is Disabled' do
+      Qti.configure do |config|
+        config.extract_latex_from_image_tags = false
+      end
+      expect(loaded_class.item_body).not_to include '"sample equation"'
     end
 
     describe '#points_possible' do

data/spec/lib/qti/v1/models/interactions/canvas_multiple_dropdown_spec.rb

@@ -44,9 +44,9 @@ describe Qti::V1::Models::Interactions::CanvasMultipleDropdownInteraction do
     let(:expected_stem_items) do
       [
         { id: 'stem_0', position: 1, type: 'text', value: '<div><p>Roses are ' },
-        { id: 'stem_1', position: 2, type: 'blank', blank_id: 'response_color1' },
+        { id: 'stem_1', position: 2, type: 'blank', blank_id: 'response_color1', blank_name: 'color1' },
         { id: 'stem_2', position: 3, type: 'text', value: ', violets are ' },
-        { id: 'stem_3', position: 4, type: 'blank', blank_id: 'response_color2' },
+        { id: 'stem_3', position: 4, type: 'blank', blank_id: 'response_color2', blank_name: 'color2' },
         { id: 'stem_4', position: 5, type: 'text', value: '.</p></div>' }
       ]
     end

data/spec/lib/qti/v1/models/interactions/fill_blank_interaction_spec.rb

@@ -47,7 +47,7 @@ describe Qti::V1::Models::Interactions::FillBlankInteraction do
     let(:expected_stem_items) do
       [
         { id: 'stem_0', position: 1, type: 'text', value: '<div><p>Chicago is in what state?</p></div>' },
-        { id: 'stem_1', position: 2, type: 'blank', blank_id: 'response1' }
+        { id: 'stem_1', position: 2, type: 'blank', blank_id: 'response1', blank_name: 'response1' }
       ]
     end
 
@@ -72,9 +72,9 @@ describe Qti::V1::Models::Interactions::FillBlankInteraction do
     let(:expected_stem_items) do
       [
         { id: 'stem_0', position: 1, type: 'text', value: '<div><p><span>Roses are ' },
-        { id: 'stem_1', position: 2, type: 'blank', blank_id: 'response_color1' },
+        { id: 'stem_1', position: 2, type: 'blank', blank_id: 'response_color1', blank_name: 'color1' },
         { id: 'stem_2', position: 3, type: 'text', value: ', violets are ' },
-        { id: 'stem_3', position: 4, type: 'blank', blank_id: 'response_color2' },
+        { id: 'stem_3', position: 4, type: 'blank', blank_id: 'response_color2', blank_name: 'color2' },
         { id: 'stem_4', position: 5, type: 'text', value: '</span></p></div>' }
       ]
     end
@@ -102,11 +102,11 @@ describe Qti::V1::Models::Interactions::FillBlankInteraction do
       [
         { id: 'stem_0', position: 1, type: 'text', value: 'Fill-in-the blanks in this text from Richard III: ' },
         { id: 'stem_1', position: 2, type: 'text', value: 'Now is the ' },
-        { id: 'stem_2', position: 3, type: 'blank', blank_id: 'FIB01' },
+        { id: 'stem_2', position: 3, type: 'blank', blank_id: 'FIB01', blank_name: 'FIB01' },
         { id: 'stem_3', position: 4, type: 'text', value: ' of our discontent made glorious ' },
-        { id: 'stem_4', position: 5, type: 'blank', blank_id: 'FIB02' },
+        { id: 'stem_4', position: 5, type: 'blank', blank_id: 'FIB02', blank_name: 'FIB02' },
         { id: 'stem_5', position: 6, type: 'text', value: ' by these sons of ' },
-        { id: 'stem_6', position: 7, type: 'blank', blank_id: 'FIB03' }
+        { id: 'stem_6', position: 7, type: 'blank', blank_id: 'FIB03', blank_name: 'FIB03' }
       ]
     end
 
@@ -165,11 +165,11 @@ describe Qti::V1::Models::Interactions::FillBlankInteraction do
       [
         { id: 'stem_0', position: 1, type: 'text', value: 'Fill-in-the blanks in this text from Richard III: ' },
         { id: 'stem_1', position: 2, type: 'text', value: 'Now is the ' },
-        { id: 'stem_2', position: 3, type: 'blank', blank_id: 'FIB01' },
+        { id: 'stem_2', position: 3, type: 'blank', blank_id: 'FIB01', blank_name: 'FIB01' },
         { id: 'stem_3', position: 4, type: 'text', value: ' of our discontent made glorious ' },
-        { id: 'stem_4', position: 5, type: 'blank', blank_id: 'FIB02' },
+        { id: 'stem_4', position: 5, type: 'blank', blank_id: 'FIB02', blank_name: 'FIB02' },
         { id: 'stem_5', position: 6, type: 'text', value: ' by these sons of ' },
-        { id: 'stem_6', position: 7, type: 'blank', blank_id: 'FIB03' }
+        { id: 'stem_6', position: 7, type: 'blank', blank_id: 'FIB03', blank_name: 'FIB03' }
       ]
     end
 
@@ -195,7 +195,7 @@ describe Qti::V1::Models::Interactions::FillBlankInteraction do
     let(:expected_stem_items) do
       [
         { id: 'stem_0', position: 1, type: 'text', value: '<div><p>Bird, bird, bird, bird is the ' },
-        { id: 'stem_1', position: 2, type: 'blank', blank_id: 'response_word' },
+        { id: 'stem_1', position: 2, type: 'blank', blank_id: 'response_word', blank_name: 'word' },
         { id: 'stem_2', position: 3, type: 'text', value: '</p></div>' }
       ]
     end

data/spec/lib/qti/v1/models/object_bank_spec.rb

@@ -13,6 +13,10 @@ describe Qti::V1::Models::ObjectBank do
               <fieldlabel>bank_type</fieldlabel>
               <fieldentry>account</fieldentry>
             </qtimetadatafield>
+            <qtimetadatafield>
+              <fieldlabel>bank_context_uuid</fieldlabel>
+              <fieldentry>oAORQgMEvQquzZyKIW6Usg6CFveihQH5pOqHadsb</fieldentry>
+            </qtimetadatafield>
           </qtimetadata>
         </objectbank>
       </questestinterop>
@@ -60,4 +64,12 @@ describe Qti::V1::Models::ObjectBank do
       expect(objectbank.bank_type).to eq 'account'
     end
   end
+
+  describe '#bank_context_uuid' do
+    it 'has the bank_context_uuid attribute' do
+      allow(File).to receive(:read).and_return(doc)
+      objectbank = described_class.new path: '/etc/FakeBank008.xml'
+      expect(objectbank.bank_context_uuid).to eq 'oAORQgMEvQquzZyKIW6Usg6CFveihQH5pOqHadsb'
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -16,6 +16,10 @@ end
 $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 require 'qti'
 
+Qti.configure do |config|
+  config.extract_latex_from_image_tags = true
+end
+
 Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
 
 RSpec.configure do |config|

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: qti
 version: !ruby/object:Gem::Version
-  version: 2.7.1
+  version: 2.9.0
 platform: ruby
 authors:
 - Hannah Bottalla
 - Robinson Rodríguez
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-01 00:00:00.000000000 Z
+date: 2022-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -275,7 +275,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
-description:
+description: 
 email:
 - hannah@instructure.com
 - rrodriguez-bd@instructure.com
@@ -684,7 +684,7 @@ homepage: https://github.com/instructure/qti
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -699,8 +699,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: QTI 1.2 and 2.1 import and export models
 test_files: