scorm2004-manifest 0.1.0

data/lib/scorm2004/manifest/time_limit_action.rb

@@ -0,0 +1,24 @@
+module Scorm2004
+  module Manifest
+    class TimeLimitAction
+      include VisitorPattern
+      include CustomError
+      include TextNode
+      
+      def self.vocabulary
+        [ 'exit, message',
+          'exit,no message',
+          'continue, message',
+          'continue,no message' ]
+      end
+
+      private
+      
+      def do_visit
+        unless self.class.vocabulary.include?(content)
+          error("Invalid <adlcp:timeLimitAction> token: #{content}") 
+        end
+      end
+    end
+  end
+end

data/lib/scorm2004/manifest/title.rb

@@ -0,0 +1,16 @@
+module Scorm2004
+  module Manifest
+    class Title
+      include VisitorPattern
+      include CustomError
+      include TextNode
+
+      private
+      
+      def do_visit
+        error('Empty <title> element.') unless content.present?
+        error('The <title> element exceeds the SPM of 200 characters:') if content.length > 200
+      end
+    end
+  end
+end

data/lib/scorm2004/manifest/visitor_pattern.rb

@@ -0,0 +1,31 @@
+module Scorm2004
+  module Manifest
+    module VisitorPattern
+      attr_reader :el
+
+      def initialize(options = {})
+        @options = options
+      end
+
+      def visit(el)
+        @el = el
+        check_attributes if self.class.respond_to?(:attributes)
+        do_visit         if self.respond_to?(:do_visit, true)
+        visit_children   if self.class.respond_to?(:children)
+        self
+      end
+
+      def check_attributes
+        self.class.attributes.each do |attr|
+          send("check_#{attr}".intern)
+        end
+      end
+
+      def visit_children
+        self.class.children.each do |child|
+          send("visit_#{child}".intern)
+        end
+      end
+    end
+  end
+end

data/lib/scorm2004/manifest/xml_base.rb

@@ -0,0 +1,38 @@
+require 'uri'
+require 'pathname'
+
+module Scorm2004
+  module Manifest
+    module XmlBase
+      def base
+        normalize_path(parent_base ? resolve_base : relative_base)
+      end
+
+      private
+
+      def relative_base
+        value = el.at('./@xml:base', NS)
+        return unless value
+        error("Invalid XML Base value: #{value}") if %r!^/|[^/]$! =~ value
+        uri = URI(value)
+        uri.absolute? ? uri : Pathname(uri.path)
+      end
+      
+      def parent_base
+        @options[:base]
+      end
+
+      def resolve_base
+        if relative_base.is_a?(URI)
+          relative_base
+        else
+          parent_base + relative_base.to_s
+        end
+      end
+
+      def normalize_path(path)
+        path.is_a?(Pathname) ? (Pathname('/') + path).relative_path_from(Pathname('/')) : path
+      end
+    end
+  end
+end

data/lib/scorm2004/manifest.rb

@@ -0,0 +1,76 @@
+require 'nokogiri'
+require 'active_support/core_ext'
+require 'scorm2004/manifest/visitor_pattern'
+require 'scorm2004/manifest/custom_error'
+require 'scorm2004/manifest/attributes'
+require 'scorm2004/manifest/children'
+require 'scorm2004/manifest/xml_base'
+require 'scorm2004/manifest/error'
+require 'scorm2004/manifest/text_node'
+require 'scorm2004/manifest/manifest'
+require 'scorm2004/manifest/schema'
+require 'scorm2004/manifest/schemaversion'
+require 'scorm2004/manifest/resources'
+require 'scorm2004/manifest/href'
+require 'scorm2004/manifest/resource'
+require 'scorm2004/manifest/file'
+require 'scorm2004/manifest/dependency'
+require 'scorm2004/manifest/organizations'
+require 'scorm2004/manifest/organization'
+require 'scorm2004/manifest/title'
+require 'scorm2004/manifest/completion_threshold'
+require 'scorm2004/manifest/item'
+require 'scorm2004/manifest/time_limit_action'
+require 'scorm2004/manifest/data_from_lms'
+require 'scorm2004/manifest/presentation'
+require 'scorm2004/manifest/navigation_interface'
+require 'scorm2004/manifest/hide_lmsui'
+require 'scorm2004/manifest/data.rb'
+require 'scorm2004/manifest/map.rb'
+require 'scorm2004/manifest/sequencing_collection'
+require 'scorm2004/manifest/sequencing'
+require 'scorm2004/manifest/control_mode'
+require 'scorm2004/manifest/sequencing_rules'
+require 'scorm2004/manifest/condition_rule'
+require 'scorm2004/manifest/rule_conditions'
+require 'scorm2004/manifest/rule_action'
+require 'scorm2004/manifest/rule_condition'
+require 'scorm2004/manifest/limit_conditions'
+require 'scorm2004/manifest/rollup_rules'
+require 'scorm2004/manifest/rollup_rule'
+require 'scorm2004/manifest/rollup_conditions'
+require 'scorm2004/manifest/rollup_condition'
+require 'scorm2004/manifest/rollup_action'
+require 'scorm2004/manifest/objectives'
+require 'scorm2004/manifest/primary_objective'
+require 'scorm2004/manifest/min_normalized_measure'
+require 'scorm2004/manifest/map_info'
+require 'scorm2004/manifest/objective'
+require 'scorm2004/manifest/randomization_controls'
+require 'scorm2004/manifest/delivery_controls'
+require 'scorm2004/manifest/constrained_choice_considerations'
+require 'scorm2004/manifest/rollup_considerations'
+require 'scorm2004/manifest/adlseq_objectives'
+require 'scorm2004/manifest/adlseq_objective'
+require 'scorm2004/manifest/adlseq_map_info'
+
+module Scorm2004
+  def self.Manifest(*args)
+    Scorm2004::Manifest.parse(*args)
+  end
+
+  module Manifest
+    NS = {
+      'imscp'  => "http://www.imsglobal.org/xsd/imscp_v1p1",
+      'adlcp'  => "http://www.adlnet.org/xsd/adlcp_v1p3",
+      'adlseq' => "http://www.adlnet.org/xsd/adlseq_v1p3",
+      'adlnav' => "http://www.adlnet.org/xsd/adlnav_v1p3",
+      'imsss'  => "http://www.imsglobal.org/xsd/imsss"
+    }
+
+    def self.parse(*args)
+      manifest_visitor = Scorm2004::Manifest::Manifest.new
+      Nokogiri::XML(*args) { |config| config.strict.noent }.root.accept manifest_visitor
+    end
+  end
+end

data/lib/scorm2004-manifest.rb

@@ -0,0 +1 @@
+require 'scorm2004/manifest'

data/test/functional_test.rb

@@ -0,0 +1,45 @@
+require 'pathname'
+require 'open-uri'
+
+module FunctionalTest
+  @@tmpdir = Pathname('../tmp')
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  def xml
+    File.exists?(cache_path) ? open(cache_path) : download
+  end
+
+  def gist_url
+    "https://raw.github.com/gist/#{gist_id}/imsmanifest.xml"
+  end
+
+  def download
+    File.open(cache_path, 'wb') do |f|
+      f.write open(gist_url, proxy: ENV['http_proxy']).read
+    end
+  end
+
+  def cache_path
+    create_tmpdir + "#{nickname}.xml"
+  end
+
+  def create_tmpdir
+    if File.exist?(@@tmpdir) && File.directory?(@@tmpdir)
+      @@tmpdir
+    else
+      Pathname(FileUtils.mkdir_p(tmpdir).first)
+    end
+  end
+
+  module ClassMethods
+    attr_reader :gist_id, :nickname
+
+    def gist(gist_id, nickname)
+      define_method(:gist_id) { gist_id }
+      define_method(:nickname) { nickname }
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'active_support/test_case'
+require 'shoulda-context'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'scorm2004-manifest'
+require 'scorm2004/manifest/partial_manifest'

data/test/mbce_test.rb

@@ -0,0 +1,66 @@
+require_relative 'helper'
+require_relative 'functional_test'
+
+class MbceTest < ActiveSupport::TestCase
+  include FunctionalTest
+
+  gist 201036, 'mbce'
+
+  test 'parsing imsmanifest.xml of ADL SCORM 2004 4th Edition MBCE' do
+    manifest = Scorm2004::Manifest(xml)
+
+    # <manifest>
+    assert_equal 'LMSTestPackage_T-01b', manifest.identifier
+    assert_equal '1.0', manifest.version
+    
+    # <resources>
+    resources = manifest.resources
+
+    # <resource>
+    resource_0 = resources.resources[0]
+    assert_equal 'RES-0E255857-7E71-D9B4-3AFB-3F743420BFC7', resource_0.identifier
+    assert_equal 'asset', resource_0.scorm_type
+
+    resource_1 = resources.resources[1]
+    assert_equal 'RES-A5C12CB1-389E-4B4D-2420-2F194C3E51C0', resource_1.identifier
+    assert_equal 'sco', resource_1.scorm_type
+    assert_equal 'MBCE/01_introduction_to_manifests.html', resource_1.href
+    assert_equal 1, resource_1.files.size
+    assert_equal 1, resource_1.dependencies.size
+
+    # <file>
+    assert_equal 11, resource_0.files.size
+    file_0 = resource_0.files[0]
+    assert_equal 'Shared%20Files/scripts/APIWrapper.js', file_0.href
+
+    # <dependency>
+    dependency_0 = resource_1.dependencies[0]
+    assert_equal 'RES-0E255857-7E71-D9B4-3AFB-3F743420BFC7', dependency_0.identifierref
+
+    # <organizations>
+    organizations = manifest.organizations
+    assert_equal 'ORG-AAE040C6-5D31-FF80-7A74-C93346D3DE42', organizations.default
+    assert_equal 1, organizations.organizations.size
+
+    # <organization>
+    organization = organizations.organizations.first
+    assert_equal 'ORG-AAE040C6-5D31-FF80-7A74-C93346D3DE42', organization.identifier
+    assert_equal 'SCORM 2004 4th Edition Manifest Basics Content Example 1.0', organization.title.to_s
+
+    # <sequencing>
+    sequencing = organization.sequencing
+    assert_equal true, sequencing.control_mode.flow
+
+    # <item>
+    item_0 = organization.items[0]
+    assert_equal 'ITEM-5C1908B3-BD20-5B1D-0586-F9B3EA30732D', item_0.identifier
+    assert_equal true, item_0.isvisible
+    assert_equal 'RES-A5C12CB1-389E-4B4D-2420-2F194C3E51C0', item_0.identifierref
+    assert_equal 'Introduction to Manifests', item_0.title.to_s
+
+    # <presentation>
+    assert_equal 'continue', item_0.presentation.navigation_interface.hide_lmsuis[0].to_s
+    assert_equal 'previous', item_0.presentation.navigation_interface.hide_lmsuis[1].to_s
+  end
+end
+

data/test/msce_test.rb

@@ -0,0 +1,55 @@
+require_relative 'helper'
+require_relative 'functional_test'
+
+class MsceTest < ActiveSupport::TestCase
+  include FunctionalTest
+
+  gist 2034296, 'msce'
+
+  test 'parsing imsmanifest.xml of ADL SCORM 2004 4th Edition MSCE' do
+    manifest = Scorm2004::Manifest(xml)
+
+    # <manifest>
+    assert_equal 'LMSTestPackage_RU-12b', manifest.identifier
+
+    # <organizations>
+    organizations = manifest.organizations
+    assert_equal 'org1', organizations.default
+
+    # <organization>
+    organization = organizations.organizations.first
+    assert_equal 'org1', organization.identifier
+
+    # <item>
+    pretest = organization.items.find { |item| item.identifier == 'pretest' }
+    assert_equal 'Pre-Assessment', pretest.title.to_s
+
+    # <sequencingRules>
+    rule = pretest.sequencing.sequencing_rules.pre_condition_rules.first
+    assert_equal 'attempted', rule.rule_conditions.rule_conditions.first.condition
+    assert_equal 'skip', rule.rule_action.action
+
+    # <objectives>
+    assert_equal false, pretest.sequencing.rollup_rules.rollup_objective_satisfied
+    assert_equal 'PRIMARYOBJ', pretest.sequencing.objectives.primary_objective.objective_id
+    objectives = pretest.sequencing.objectives.objectives
+    obj1 = objectives[0]
+    assert_equal 'obj_module_1', obj1.objective_id
+    map_info = obj1.map_infos[0]
+    assert_equal 'obj_module_1', map_info.target_objective_id
+    assert_equal false, map_info.read_satisfied_status
+    assert_equal false, map_info.read_normalized_measure
+    assert_equal true,  map_info.write_satisfied_status
+    assert_equal true,  map_info.write_normalized_measure
+
+    # assessment activity
+    assessment = organization.items.find { |item| item.identifier == 'assessment' }
+    module1 = assessment.items.find { |item| item.identifier == 'assess-module1' }
+    sequencing = module1.sequencing
+    rollup_rule = sequencing.rollup_rules.rollup_rules[0]
+    condition = rollup_rule.rollup_conditions.rollup_conditions[0]
+    assert_equal 'attempted', condition.condition
+    assert_equal 'completed', rollup_rule.rollup_action.action
+    assert_equal 'ifNotSkipped', sequencing.rollup_considerations.required_for_completed
+  end
+end

data/test/scorm2004/manifest/adlseq_map_info_test.rb

@@ -0,0 +1,47 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class AdlseqMapInfoTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      class << self
+        def flags
+          AdlseqMapInfo.attributes - [:target_objective_id]
+        end
+
+        def default(attr)
+          /^read/ =~ attr ? true : false
+        end
+      end
+
+      setup do
+        @v = AdlseqMapInfo.new
+      end
+      
+      test 'an empty element causes error' do
+        assert_raise(AdlseqMapInfo::Error) { el.accept @v }
+      end
+
+      flags.each do |attr|
+        test "default value of #{attr.to_s.camelize :lower}" do
+          el('<dummy targetObjectiveID="foo" />').accept @v
+          assert_equal default(attr), @v.send(attr)
+        end
+      end
+
+      flags.each do |attr|
+        test "#{attr.to_s.camelize :lower} = #{!default(attr)}" do
+          el("<dummy targetObjectiveID='bar' #{attr.to_s.camelize :lower}='#{!default(attr)}' />")
+        end
+      end
+
+      private
+
+
+      def default(attr)
+        self.class.default attr
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/adlseq_objective_test.rb

@@ -0,0 +1,44 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class AdlseqObjectiveTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      setup do
+        @v = AdlseqObjective.new
+      end
+      
+      test 'an empty element causes error' do
+        assert_error { el.accept @v }
+      end
+
+      test 'an element must have the objectiveID attribute' do
+        assert_error { el('<dummy><adlseq:mapInfo /></dummy').accept @v }
+      end
+
+      test 'an element must have at least one <adlseq:mapInfo>' do
+        assert_error { el('<dummy objectiveID="foo" />').accept @v }
+      end
+
+      test 'a valid element' do
+        map_info_visitor = mock()
+        map_info_visitor.expects(:visit).twice
+        @v.expects(:adlseq_map_info_visitor).twice.returns(map_info_visitor)
+        el(<<-XML).accept @v
+          <dummy objectiveID="bar">
+            <adlseq:mapInfo />
+            <adlseq:mapInfo />
+          </dummy>
+        XML
+        assert_equal 'bar', @v.objective_id
+      end
+
+      private
+
+      def assert_error &block
+        assert_raise AdlseqObjective::Error, &block
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/adlseq_objectives_test.rb

@@ -0,0 +1,29 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class AdlseqObjectivesTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      setup do
+        @v = AdlseqObjectives.new
+      end
+      
+      test 'an empty element cause error' do
+        assert_raise(AdlseqObjectives::Error) { el.accept @v }
+      end
+
+      test 'visiting multiple <adlseq:objective>' do
+        objective_visitor = mock()
+        objective_visitor.expects(:visit).twice
+        @v.expects(:adlseq_objective_visitor).twice.returns(objective_visitor)
+        el(<<-XML).accept @v
+          <dummy>
+            <adlseq:objective />
+            <adlseq:objective />
+          </dummy>
+        XML
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/any_uri_token_test.rb

@@ -0,0 +1,40 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class AnyUriTokenTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      class Visitor
+        include VisitorPattern
+        include CustomError
+        include Attributes
+
+        attribute :any_uri, 'foo'
+      end
+
+      setup do
+        @v = Visitor.new
+      end
+
+      valid_uris = [
+        ' http://example.com/a ',
+        ' path/to/somewhere '
+      ]
+
+      valid_uris.each do |valid_uri|
+        tag = "<dummy foo='#{valid_uri}' />"
+        test tag do
+          el(tag).accept(@v)
+          assert_equal URI(valid_uri).to_s, @v.foo
+        end
+      end
+
+      test 'invalid uri causes error' do
+        assert_raise Visitor::Error do
+          el('<dummy foo=" a b c " />').accept(@v)
+        end
+      end
+    end
+  end
+end