qti 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 393747e20e5dfd4ea82c84d94a453ff255dca004
+  data.tar.gz: 4895db6433e8b5b37775888cffc6b884103637b2
+SHA512:
+  metadata.gz: 025acd7b5b163a07ff92daf38373037fe62ae82a6a46aa0101f95d0d924186dcecd467d5a4c585cb4e35b20d94e7e716b00c1070719b60871f3847a23f017506
+  data.tar.gz: 5bc328455e6b63cb3e543d0199e135aee3696b2d66be5994732ba7ae36dccc6211602870887c6c1d7b0f633caa2275238b718d88e56f82a7e8bf2b880faa325a

data/README.md

@@ -0,0 +1,28 @@
+# Qti Gem
+
+The Qti gem supports QTI 1.2 and 2.1. It currently supports the following interaction types:
+
+  - True/False
+  - Multiple Choice
+  - Multiple Answer
+
+### Installation
+
+```sh
+$ cd your_project
+$ bundle install qti
+```
+
+### Usage
+
+`require 'qti'`
+`@gem = Qti::Importer.new(path_of_quiz)`
+
+Now you can use the gem to access the manifest, the assessments, and the assessment items and use it in your own code!
+
+### Development
+
+Want to contribute? Submit a pull request!
+
+### To Do
+  - More interaction models!

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/qti.rb

@@ -0,0 +1,62 @@
+require 'find'
+
+module Qti
+  class Importer
+    def initialize(path)
+      Find.find(path) do |subdir|
+        @path = subdir if subdir =~ /imsmanifest.xml/
+      end
+    end
+
+    def import_manifest
+      @manifest = Qti::Models::Manifest.from_path!(@path)
+      raise 'Unsupported QTI version' if @manifest.assessment_test_href.nil?
+      @manifest.assessment_test_href
+    end
+
+    def test_object
+      version_agnostic_test_object(import_manifest)
+    end
+
+    def version_agnostic_test_object(assessment_test_file)
+      if @manifest.qti_1_href
+        Qti::V1::Models::Assessment.from_path!(assessment_test_file)
+      else
+        Qti::V2::Models::AssessmentTest.from_path!(assessment_test_file)
+      end
+    end
+
+    def assessment_item_refs
+      @assessment_item_refs ||= begin
+        if @manifest.qti_1_href
+          test_object.assessment_items
+        else
+          test_object.assessment_item_reference_hrefs
+        end
+      end
+    end
+
+    def create_assessment_item(assessment_item_ref)
+      if @manifest.qti_1_href
+        Qti::V1::Models::AssessmentItem.new(assessment_item_ref)
+      else
+        Qti::V2::Models::AssessmentItem.from_path!(assessment_item_ref)
+      end
+    end
+  end
+end
+
+require 'qti/models/manifest'
+require 'qti/models/base'
+
+require 'qti/v1/models/base'
+require 'qti/v1/models/assessment'
+require 'qti/v1/models/assessment_item'
+require 'qti/v1/models/choices/logical_identifier_choice'
+require 'qti/v1/models/interactions/logical_identifier_interaction'
+
+require 'qti/v2/models/base'
+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'

data/lib/qti/models/base.rb

@@ -0,0 +1,80 @@
+require 'nokogiri'
+require 'sanitize'
+
+module Qti
+  class ParseError < StandardError; end
+  class SpecificationViolation < StandardError; end
+  class UnsupportedSchema < StandardError; end
+
+  module Models
+    class Base
+      ELEMENTS_REMAP = {
+        'prompt' => 'div',
+        'simpleBlock' => 'div',
+        'simpleInline' => 'span',
+        'atomicBlock' => 'div',
+        'atomicInline' => 'span'
+      }.freeze
+
+      def sanitize_content!(html)
+        Sanitize.fragment(html, sanitize_config)
+      end
+
+      def remap_unknown_tags_transformer
+        lambda do |env|
+          node_name = env[:node_name]
+          node = env[:node]
+
+          return if env[:is_whitelisted] || !node.element?
+          return unless ELEMENTS_REMAP.keys.include? node_name
+
+          new_name = ELEMENTS_REMAP[node_name]
+          env[:node].name = new_name
+          env[:node_name] = new_name
+        end
+      end
+
+      def sanitize_config
+        Sanitize::Config::RELAXED.merge transformers: remap_unknown_tags_transformer
+      end
+
+      def self.from_path!(path)
+        new(path: path)
+      end
+
+      def initialize(path: nil)
+        @path = path
+        @doc = parse_xml(File.read(path))
+        raise ArgumentError unless @doc
+      end
+
+      def xpath_with_single_check(xpath)
+        node_list = @doc.xpath(xpath)
+        raise Qti::ParseError, 'Too many matches' if node_list.count > 1
+        node_list.first
+      end
+
+      def css_with_single_check(css)
+        node_list = @doc.css(css)
+        raise Qti::ParseError, 'Too many matches' if node_list.count > 1
+        node_list.first
+      end
+
+      def parse_xml(xml_string)
+        Nokogiri.XML(xml_string, &:noblanks)
+      end
+
+      def remap_href_path(href, source_path)
+        return href unless href
+        # Attempts to map to a file path relative href if href doesn't exist
+        # Returns original href if that file doesn't exist
+        if File.exist?(href)
+          href
+        else
+          new_path = File.join(File.dirname(source_path), href)
+          File.exist?(new_path) ? new_path : href
+        end
+      end
+    end
+  end
+end

data/lib/qti/models/manifest.rb

@@ -0,0 +1,20 @@
+require 'qti/v1/models/base'
+
+module Qti
+  module Models
+    class Manifest < Qti::Models::Base
+      def assessment_test_href
+        href = qti_1_href.nil? ? qti_2_href : qti_1_href
+        remap_href_path(href, @path)
+      end
+
+      def qti_1_href
+        xpath_with_single_check("//xmlns:resources/xmlns:resource[@type='imsqti_xmlv1p1']/@href")&.content
+      end
+
+      def qti_2_href
+        xpath_with_single_check("//xmlns:resources/xmlns:resource[@type='imsqti_test_xmlv2p2']/@href")&.content
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+require 'qti/v1/models/base'
+
+module Qti
+  module V1
+    module Models
+      class Assessment < Qti::V1::Models::Base
+        def title
+          @title ||= xpath_with_single_check('//assessment/@title').content
+        end
+
+        def assessment_items
+          @doc.xpath('//item')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+require 'qti/v1/models/interactions/logical_identifier_interaction'
+
+module Qti
+  module V1
+    module Models
+      class AssessmentItem < Qti::V1::Models::Base
+        ScoringData = Struct.new(:values, :rcardinality)
+
+        def initialize(item)
+          @doc = item
+        end
+
+        def item_body
+          @item_body ||= begin
+            node = @doc.dup
+            prompt = node.at_xpath('./presentation/material/mattext').content
+            sanitize_content!(prompt)
+          end
+        end
+
+        def identifier
+          @identifier ||= @doc.attribute('ident').value
+        end
+
+        def title
+          @title ||= @doc.attribute('title').value
+        end
+
+        def points_possible
+          @points_possible ||= begin
+            @doc.at_xpath('.//decvar/@maxvalue')&.value || @doc.at_xpath('.//decvar/@defaultval')&.value
+          end
+        end
+
+        def rcardinality
+          @rcardinality ||= @doc.at_xpath('.//response_lid/@rcardinality').value
+        end
+
+        def interaction_model
+          @interaction_model ||= V1::Models::Interactions::LogicalIdentifierInteraction.new(@doc)
+        end
+
+        def scoring_data_structs
+          @scoring_data_structs ||= begin
+            rcardinality = @doc.at_xpath('//response_lid/@rcardinality').value
+
+            choice_nodes = @doc.xpath('.//respcondition')
+            value_nodes = []
+            # We need to find an action of Set or Add greater than 0 bc there is no correct answer tag
+            choice_nodes.each do |choice_node|
+              value_nodes << choice_node if choice_node.at_xpath('.//setvar').content.to_f.positive?
+            end
+            value_nodes.map { |value_node| ScoringData.new(value_node.at_xpath('//varequal').content, rcardinality) }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+require 'qti/models/base'
+
+module Qti
+  module V1
+    module Models
+      class Base < Qti::Models::Base
+        def qti_version
+          1
+        end
+      end
+    end
+  end
+end

data/lib/qti/v1/models/choices/logical_identifier_choice.rb

@@ -0,0 +1,26 @@
+require 'qti/v1/models/base'
+
+module Qti
+  module V1
+    module Models
+      module Choices
+        class LogicalIdentifierChoice < Qti::V1::Models::Base
+          def initialize(node)
+            @node = node
+          end
+
+          def identifier
+            @identifier ||= @node.attributes['ident'].value
+          end
+
+          def item_body
+            @item_body ||= begin
+              node = @node.dup
+              node.content.strip.gsub(/\s+/, ' ')
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+require 'qti/v1/models/base'
+require 'qti/v1/models/choices/logical_identifier_choice'
+
+module Qti
+  module V1
+    module Models
+      module Interactions
+        class LogicalIdentifierInteraction < Qti::V1::Models::Base
+          def initialize(node)
+            @node = node
+          end
+
+          def shuffled?
+            @node.at_xpath('.//render_choice/@shuffle')&.value == 'Yes'
+          end
+
+          def answers
+            @answers ||= answer_nodes.map do |node|
+              V1::Models::Choices::LogicalIdentifierChoice.new(node)
+            end
+          end
+
+          private
+
+          def answer_nodes
+            @node.xpath('.//response_label')
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+require 'qti/v2/models/base'
+require 'qti/v2/models/interactions'
+
+module Qti
+  module V2
+    module Models
+      class AssessmentItem < Qti::V2::Models::Base
+        ScoringData = Struct.new(:values, :type)
+
+        def item_body
+          @item_body ||= begin
+            node = item_body_node.dup
+            # ensure a prompt is carried into the html
+            prompt = node.at_xpath('//xmlns:prompt')
+
+            # Filter undesired interaction nodes out of the list (need to make this a deep traversal)
+            node.children.filter(INTERACTION_ELEMENTS_CSS).map(&:unlink)
+
+            node.add_child(prompt) if prompt&.parent && prompt.parent != node
+            sanitize_content!(node.to_html)
+          end
+        end
+
+        # Not used yet
+        def identifier
+          @identifier ||= xpath_with_single_check('//xmlns:assessmentItem/@identifier').content
+        end
+
+        def title
+          @title ||= xpath_with_single_check('//xmlns:assessmentItem/@title').content
+        end
+
+        def points_possible
+          @points_possible ||= begin
+            xpath_with_single_check("//xmlns:outcomeDeclaration[@identifier='SCORE']/@normalMaximum")&.content ||
+            xpath_with_single_check("//xmlns:outcomeDeclaration[@identifier='MAXSCORE']//xmlns:value")&.content
+          end
+        end
+
+        def interaction_model
+          @interaction_model ||= begin
+            V2::Models::Interactions.interaction_model(item_body_node)
+          end
+        end
+
+        def scoring_data_structs
+          @scoring_data_structs ||= begin
+            type = xpath_with_single_check('//xmlns:responseDeclaration/@baseType').content
+            value_nodes = @doc.xpath('//xmlns:responseDeclaration/xmlns:correctResponse/xmlns:value')
+            value_nodes.map { |value_node| ScoringData.new(value_node.content, type) }
+          end
+        end
+
+        private
+
+        def item_body_node
+          @item_body_node ||= xpath_with_single_check('//xmlns:itemBody')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+require 'qti/v2/models/base'
+
+module Qti
+  module V2
+    module Models
+      class AssessmentTest < Qti::V2::Models::Base
+        def title
+          @title ||= xpath_with_single_check('//xmlns:assessmentTest/@title').content
+        end
+
+        def assessment_item_reference_hrefs
+          # 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)
+            end
+          end
+        end
+
+        # Not used yet
+        def test_parts
+          @test_parts ||= @doc.xpath('//xmlns:testPart')
+        end
+
+        # Not used yet
+        def assessment_sections
+          @assessment_sections ||= test_parts.first.xpath('//xmlns:assessmentSection')
+        end
+      end
+    end
+  end
+end