qti 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bca00e3ced1649d9c45a507e11f8834b989f1792
-  data.tar.gz: 25f6fc89f8e60cae72d06f8e68ef548adae14f62
+  metadata.gz: 852302a8eb0d02d23199e435c997d027f720c476
+  data.tar.gz: c52b00f23b75fc6b0c0d14ccf1bf3e1309b7016b
 SHA512:
-  metadata.gz: 8755835f90b0cad59633b9911c20e9f0c206860c7e439fadd2c745ae62f63b54224138844c8a8c0ae2469bd9e076b5a10af031dcf6484276913e560e80bd3599
-  data.tar.gz: ecd4c1d067f58aba092288032ea306d87a9afe800919d26fdd0ee1f0ecf78a7f2358b25360b0aa8612bdce666ba9decfc1071a74344b93b74cd0f616dc47213e
+  metadata.gz: 0cb5f6a63677f60d18ed90dd6729c061f2a64189168f8ffb7bc8ee93693c938ec9fbfa102c0f1ccda4996c2db97b066d38d01c9aa1c40e4a8001f1f63d6ea114
+  data.tar.gz: 436eeb7b20019d9f95b61df809993f4b2293fbd06598dd8e2f70d2bb29177093080a2da5633dc4f395e92b968ead921abb0c7a9cf969de8b924146811e138b2a

data/lib/qti.rb

@@ -27,7 +27,7 @@ module Qti
     def self.manifest(path)
       mpath = manifest_path(path)
       package_root = File.dirname(mpath)
-      manifest = Qti::Models::Manifest.from_path!(mpath, package_root)
+      manifest = Qti::Models::Manifest.from_path!(mpath, package_root = package_root)
       [mpath, package_root, manifest]
     end
 

data/lib/qti/models/base.rb

@@ -10,19 +10,21 @@ module Qti
 
   module Models
     class Base
-      attr_reader :doc, :path, :package_root
+      attr_reader :doc, :path, :package_root, :resource
       attr_accessor :manifest
+      delegate :metadata, to: :@resource, allow_nil: true
 
       def sanitize_content!(html)
         sanitizer.clean(html)
       end
 
-      def self.from_path!(path, package_root = nil)
-        new(path: path, package_root: package_root)
+      def self.from_path!(path, package_root = nil, resource = nil)
+        new(path: path, package_root: package_root, resource: resource)
       end
 
-      def initialize(path:, package_root: nil, html: false)
+      def initialize(path:, package_root: nil, html: false, resource: nil)
         @path = path
+        @resource = resource
         self.package_root = package_root || File.dirname(path)
         @doc = html ? parse_html(File.read(path)) : parse_xml(File.read(path))
         raise ArgumentError unless @doc
@@ -76,6 +78,10 @@ module Qti
         path
       end
 
+      def raise_unsupported(message = 'Unsupported QTI version')
+        raise Qti::UnsupportedSchema, message
+      end
+
       protected
 
       def package_root=(package_root)

data/lib/qti/models/manifest.rb

@@ -3,22 +3,13 @@ require 'qti/models/assessment_meta'
 require 'qti/v1/models/assessment'
 require 'qti/v2/models/assessment_test'
 require 'qti/v2/models/non_assessment_test'
+require 'qti/models/resource'
 
 module Qti
   module Models
     class Manifest < Qti::Models::Base
-      RESOURCE_QTI_TYPES = %w[imsqti_test_xmlv2p1
-                              imsqti_test_xmlv2p2
-                              imsqti_xmlv1p2].freeze
-      ASSESSMENT_CLASSES = {
-        'imsqti_xmlv1p2' => Qti::V1::Models::Assessment,
-        'imsqti_test_xmlv2p1' => Qti::V2::Models::AssessmentTest,
-        'imsqti_test_xmlv2p2' => Qti::V2::Models::AssessmentTest
-      }.freeze
-      EMBEDDED_QTI_TYPES = %w[imsqti_item_xmlv2p1
-                              imsqti_item_xmlv2p2].freeze
-      EMBEDDED_NON_ASSESSMENT_ID = '@embedded_non_assessment'.freeze
-
+      include Qti::Models::ResourceGroup
+      include Qti::XPathHelpers
       def assessment_test(resource_id = nil)
         resource_id ||= assessment_identifiers.first
         test = assessment_from_identifier(resource_id)
@@ -26,31 +17,11 @@ module Qti
         test
       end
 
-      def raise_unsupported
-        raise Qti::UnsupportedSchema, 'Unsupported QTI version'
-      end
-
-      def assessment_identifiers(embedded_as_assessment = true)
-        id_list = identifier_list('/assessment')
-        return id_list + [EMBEDDED_NON_ASSESSMENT_ID] if embedded_as_assessment && embedded_non_assessment?
-        id_list
-      end
-
-      def question_bank_identifiers
-        identifier_list('/question-bank')
-      end
-
-      def identifier_list(rsc_type)
-        RESOURCE_QTI_TYPES.map do |v|
-          xmlns_resource_list("[#{rtype_predicate(v, rsc_type)}]").map { |r| r[:identifier] }
-        end.flatten
-      end
-
       private
 
       def assessment_from_identifier(identifier)
         return embedded_non_assessment if identifier == EMBEDDED_NON_ASSESSMENT_ID
-        rsc_ver = xpath_with_single_check(xpath_xmlns_resource("[@identifier='#{identifier}']"))&.[](:type)
+        rsc_ver = xpath_with_single_check(xpath_resource("[@identifier='#{identifier}']"))&.[](:type)
         raise_unsupported unless rsc_ver
         assessment_from(rsc_ver, identifier)
       end
@@ -58,73 +29,24 @@ module Qti
       def assessment_from(version, identifier)
         builder = ASSESSMENT_CLASSES[version.split('/').first]
         raise_unsupported unless builder
-        canvas_meta = canvas_meta_data_for(identifier)
-        assessment = builder.from_path!(
-          remap_href_path(asset_resource_for(identifier, version, canvas_meta&.quiz_identifier)),
-          @package_root
-        )
-        assessment.canvas_meta_data(canvas_meta_data_for(identifier))
+        rsc = resource_for(identifier, version)
+        assessment = builder.from_path!(remap_href_path(asset_resource_for(rsc)), @package_root, rsc)
+        assessment.canvas_meta_data(rsc.canvas_metadata)
         assessment
       end
 
-      def asset_resource_for(identifier, qti_type, canvas_ident)
-        asset_resource_for_canvas(canvas_ident) || asset_resource_for_ims(identifier, qti_type)
-      end
-
-      def asset_resource_for_canvas(identifier)
-        canvas_extra_file(identifier, '.xml.qti')
-      end
-
-      def asset_resource_for_ims(identifier, qti_type)
-        base_xpath = "[@identifier='#{identifier}' and starts-with(@type, '#{qti_type}')]"
-        xmlns_resource(base_xpath + '/@href') || xmlns_resource(base_xpath + '/xmlns:file/@href')
-      end
-
-      def dependency_id(identifier)
-        xmlns_resource("[@identifier='#{identifier}']/xmlns:dependency/@identifierref")
-      end
-
-      def canvas_meta_data_for(identifier)
-        meta_file = canvas_extra_file(identifier, 'assessment_meta.xml')
-        return Qti::Models::AssessmentMeta.from_path!(File.join(@package_root, meta_file)) if meta_file
-      end
-
-      def canvas_extra_file(identifier, filename)
-        dep_id = dependency_id(identifier)
-        xmlns_resource(
-          "[@identifier='#{dep_id}']/xmlns:file[#{xpath_endswith('@href', filename)}]/@href"
-        )
-      end
-
       def xmlns_resource(type)
-        xpath_with_single_check(xpath_xmlns_resource(type))&.content
+        xpath_with_single_check(xpath_resource(type))
       end
 
       def xmlns_resource_list(type)
-        @doc.xpath(xpath_xmlns_resource(type))
+        @doc.xpath(xpath_resource(type))
       end
 
       def xmlns_resource_count(type)
         xmlns_resource_list(type).count
       end
 
-      def xpath_xmlns_resource(type = '')
-        "//xmlns:resources/xmlns:resource#{type}"
-      end
-
-      def xpath_endswith(tag, tail)
-        "substring(#{tag}, string-length(#{tag}) - string-length('#{tail}') + 1) = '#{tail}'"
-      end
-
-      def rtype_predicate(ver, rsc_type)
-        # XPath 2.0 supports ends-with, which is what substring is doing here.
-        # It also support regex matching with matches.
-        # We only have XPath 1.0 available.
-        cc_match = "starts-with(@type, '#{ver}') and " + xpath_endswith('@type', rsc_type)
-        qti_match = "@type='#{ver}'"
-        "#{qti_match} or (#{cc_match})"
-      end
-
       def embedded_non_assessment?
         EMBEDDED_QTI_TYPES.map { |typ| xmlns_resource_count("[@type='#{typ}']/@href") }.flatten.sum.positive?
       end

data/lib/qti/models/metadata.rb

@@ -0,0 +1,63 @@
+module Qti
+  module Models
+    class MetaData < Qti::Models::Base
+      def initialize(node)
+        @node = node
+      end
+
+      def taxonpaths
+        return unless lom
+        hier = Hash.new { |h, k| h[k] = [] }
+        lom.xpath('imsmd:classification/imsmd:taxonPath').each do |tp|
+          entry = taxonpath_entry(tp)
+          hier[entry[:source]] = entry[:taxonpath]
+        end
+        hier
+      end
+
+      private
+
+      def taxonpath_entry(node)
+        {
+          source: node.xpath('imsmd:source/imsmd:string').text,
+          taxonpath: taxons(node)
+        }
+      end
+
+      def metadata
+        @metadata ||= @node&.xpath('xmlns:metadata')&.first
+      end
+
+      def lom
+        return unless imsmd
+        @lom ||= metadata&.xpath('imsmd:lom')&.first
+      end
+
+      def imsmd
+        @node.namespaces&.keys&.include?('xmlns:imsmd')
+      end
+
+      def taxons(node)
+        hier = Hash.new { |h, k| h[k] = [] }
+        taxon(node, hier)
+      end
+
+      def taxon(node, path)
+        return path unless node
+        xpath = 'imsmd:taxon/imsmd:entry/*[self::imsmd:string or self::imsmd:langstring]'
+        node.xpath(xpath).each do |taxon|
+          lang = taxon.attr('language') || taxon.attr('lang') || taxon.attr('xml:lang') || 'default'
+          path[lang].push(taxon.text)
+        end
+        taxon(node.xpath('imsmd:taxon')&.first, path)
+      end
+    end
+
+    module MetaDataBase
+      delegate :taxonpath, to: :@meta_data, allow_nil: true
+      def metadata_from_node!(node)
+        @meta_data ||= MetaData.new(node)
+      end
+    end
+  end
+end

data/lib/qti/models/resource.rb

@@ -0,0 +1,115 @@
+require 'qti/v1/models/base'
+require 'qti/models/assessment_meta'
+require 'qti/v1/models/assessment'
+require 'qti/v2/models/assessment_test'
+require 'qti/v2/models/non_assessment_test'
+require 'qti/xpath_helpers'
+require 'qti/models/metadata'
+
+module Qti
+  module Models
+    class Resource < Qti::Models::Base
+      include Qti::Models::MetaDataBase
+      include Qti::XPathHelpers
+      def initialize(node, parent)
+        @node = node
+        @parent = parent
+        @resource_type = node.attr('type')
+        @identifier = node.attr('identifier')
+        copy_paths_from_item(parent)
+      end
+
+      def href
+        @href ||= @node.attr('href') || @node.xpath('xmlns:file/@href')&.first&.content
+      end
+
+      def metadata
+        @metadata = metadata_from_node!(@node)
+      end
+
+      def canvas_metadata
+        @canvas_meta_file ||= canvas_extra_file('assessment_meta.xml')
+        return unless @canvas_meta_file
+        meta_file = File.join(@package_root, @canvas_meta_file)
+        @canvas_metadata ||= Qti::Models::AssessmentMeta.from_path!(meta_file) if @canvas_meta_file
+      end
+
+      def canvas_extra_file(filename)
+        dep_id = dependency_id
+        rsc = @parent.resource_node(
+          "[@identifier='#{dep_id}']/xmlns:file[#{xpath_endswith('@href', filename)}]/@href"
+        )
+        rsc&.content
+      end
+
+      private
+
+      # Canvas Metadata Helpers
+      def dependency_id
+        @node.xpath('xmlns:dependency/@identifierref')&.first&.content
+      end
+    end
+
+    module ResourceGroup
+      RESOURCE_QTI_TYPES = %w[imsqti_test_xmlv2p1
+                              imsqti_test_xmlv2p2
+                              imsqti_xmlv1p2].freeze
+      ASSESSMENT_CLASSES = {
+        'imsqti_xmlv1p2' => Qti::V1::Models::Assessment,
+        'imsqti_test_xmlv2p1' => Qti::V2::Models::AssessmentTest,
+        'imsqti_test_xmlv2p2' => Qti::V2::Models::AssessmentTest
+      }.freeze
+      EMBEDDED_QTI_TYPES = %w[imsqti_item_xmlv2p1
+                              imsqti_item_xmlv2p2].freeze
+      EMBEDDED_NON_ASSESSMENT_ID = '@embedded_non_assessment'.freeze
+
+      def resources(type = '')
+        @doc.xpath(xpath_resource(type))
+      end
+
+      def asset_resource_for(rsc)
+        asset_resource_for_canvas(rsc) || asset_resource_for_ims(rsc)
+      end
+
+      def asset_resource_for_canvas(rsc)
+        rsc.canvas_extra_file('.xml.qti')
+      end
+
+      def asset_resource_for_ims(rsc)
+        rsc.href
+      end
+
+      def identifier_list(rsc_type)
+        RESOURCE_QTI_TYPES.map do |v|
+          xmlns_resource_list("[#{rtype_predicate(v, rsc_type)}]").map { |r| r[:identifier] }
+        end.flatten
+      end
+
+      def resource_for(identifier, qti_type = nil)
+        qti_type = " and starts-with(@type, '#{qti_type}')" if qti_type
+        base_xpath = "[@identifier='#{identifier}'#{qti_type}]"
+        Resource.new(resource_node(base_xpath), self)
+      end
+
+      def assessment_identifiers(embedded_as_assessment = true)
+        id_list = identifier_list('/assessment')
+        return id_list + [EMBEDDED_NON_ASSESSMENT_ID] if embedded_as_assessment && embedded_non_assessment?
+        id_list
+      end
+
+      def question_bank_identifiers
+        identifier_list('/question-bank')
+      end
+
+      def item_resources_v2
+        nodes = resources('[@type="imsqti_item_xmlv2p2"]')
+        return nodes if nodes.count >= 1
+        resources('[@type="imsqti_item_xmlv2p1"]')
+      end
+
+      def resource_node(type)
+        xpath_with_single_check(xpath_resource(type))
+      end
+    end
+  end
+end

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

@@ -18,7 +18,7 @@ module Qti
 
         def create_assessment_item(assessment_item)
           return nil if sub_section?(assessment_item)
-          item = Qti::V1::Models::AssessmentItem.new(assessment_item, @package_root)
+          item = Qti::V1::Models::AssessmentItem.new(assessment_item, @package_root, self)
           item.manifest = manifest
           item
         end

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

@@ -6,10 +6,13 @@ module Qti
     module Models
       class AssessmentItem < Qti::V1::Models::Base
         attr_reader :doc
+        attr_reader :resource
+        delegate :metadata, to: :@resource
 
-        def initialize(item, package_root = nil)
+        def initialize(item, package_root = nil, resource = nil)
           @doc = item
           @path = item.document.url
+          @resource = resource
           self.package_root = package_root
         end
 

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

@@ -1,11 +1,13 @@
 require 'qti/v2/models/base'
 require 'qti/models/assessment_meta'
+require 'qti/xpath_helpers'
 
 module Qti
   module V2
     module Models
       class AssessmentTest < Qti::V2::Models::Base
         include Qti::Models::AssessmentMetaBase
+        include Qti::XPathHelpers
         def title
           @title ||= xpath_with_single_check('//xmlns:assessmentTest/@title')&.content || File.basename(@path, '.xml')
         end
@@ -14,7 +16,7 @@ module Qti
           # Return the xml files we should be parsing
           @assessment_item_reference_hrefs ||= begin
             @doc.xpath('//xmlns:assessmentItemRef/@href').map(&:content).map do |href|
-              remap_href_path(href)
+              { path: remap_href_path(href), resource: self }
             end
           end
         end
@@ -27,8 +29,8 @@ module Qti
           @assessment_sections ||= test_parts.first.xpath('//xmlns:assessmentSection')
         end
 
-        def create_assessment_item(assessment_item_ref)
-          item = Qti::V2::Models::AssessmentItem.from_path!(assessment_item_ref, @package_root)
+        def create_assessment_item(ref)
+          item = Qti::V2::Models::AssessmentItem.from_path!(ref[:path], @package_root, ref[:resource])
           item.manifest = manifest
           item
         end

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

@@ -1,31 +1,28 @@
 require 'qti/v2/models/base'
+require 'qti/models/resource'
 
 module Qti
   module V2
     module Models
       class NonAssessmentTest < Qti::V2::Models::AssessmentTest
+        include Qti::Models::ResourceGroup
         def assessment_items
           # Return the xml files we should be parsing
-          @assessment_item_reference_hrefs ||= begin
-            hrefs.map do |href|
-              remap_href_path(href)
+          @assessment_item_resources ||= begin
+            item_resources_v2.map do |node|
+              rsc = Qti::Models::Resource.new(node, self)
+              { path: remap_href_path(rsc.href), resource: rsc }
             end
           end
         end
 
         def stimulus_ref(assessment_item_ref)
-          ref = assessment_item_ref.sub(@package_root, '')
+          ref = assessment_item_ref[:path].sub(@package_root, '')
           dependencies = @doc.xpath("//xmlns:resource[@href='#{ref}']/xmlns:dependency/@identifierref")
           return unless dependencies&.count == 1
           href = xpath_with_single_check("//xmlns:resource[@identifier='#{dependencies.first}']/@href")
           remap_href_path(href)
         end
-
-        def hrefs
-          nodes = @doc.xpath("//xmlns:resource[@type='imsqti_item_xmlv2p2']/@href")
-          return nodes if nodes.count >= 1
-          @doc.xpath("//xmlns:resource[@type='imsqti_item_xmlv2p1']/@href")
-        end
       end
     end
   end