scorm2004-manifest 0.1.0

data/test/scorm2004/manifest/manifest_test.rb

@@ -0,0 +1,152 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class ManifestTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      setup do
+        @v = Manifest.new
+        @v.stubs(:schema_visitor).returns(stub(:visit))
+        @v.stubs(:schemaversion_visitor).returns(stub(:visit))
+        @v.stubs(:resources_visitor).returns(stub(:visit))
+        @v.stubs(:organizations_visitor).returns(stub(:visit))
+        @v.stubs(:sequencing_collection_visitor).returns(stub(:visit))
+      end
+
+      context 'a manifest visitor' do
+        should 'be able to handle xml:base' do
+          assert @v.respond_to? :base
+        end
+      end
+
+      context 'a manifest visitor visiting a valid manifest element' do
+        should 'visit its offsprings and set attributes' do
+          @v.expects(:schema_visitor).once.returns(mock(:visit))
+          @v.expects(:schemaversion_visitor).once.returns(mock(:visit))
+          @v.expects(:resources_visitor).once.returns(mock(:visit))
+          @v.expects(:organizations_visitor).once.returns(mock(:visit))
+          @v.expects(:sequencing_collection_visitor).once.returns(mock(:visit))
+          el(<<-XML).accept(@v)
+            <dummy identifier="sample" version="1.0" xml:base="path/to/root/">
+              <metadata>
+                <schema />
+                <schemaversion />
+              </metadata>
+              <resources />
+              <organizations />
+              <imsss:sequencingCollection />
+            </dummy>
+          XML
+          assert_equal "sample", @v.identifier
+          assert_equal "1.0",    @v.version
+          assert_equal Pathname('path/to/root'), @v.base
+        end
+      end
+
+      context 'a manifest visitor visiting a manifest element without <schema>' do
+        should 'raise exceptoin' do
+          assert_error do
+            el(<<-XML).accept @v
+              <dummy identifier="sample" version="1.0">
+                <metadata>
+                  <schemaversion />
+                </metadata>
+                <resources />
+                <organizations />
+              </dummy>
+            XML
+          end
+        end
+      end
+    
+      context 'a manifest visitor visiting a manifest element without <schemaversion>' do
+        should 'raise exceptoin' do
+          assert_error do
+            el(<<-XML).accept @v
+              <dummy identifier="sample" version="1.0">
+                <metadata>
+                  <schema />
+                </metadata>
+                <resources />
+                <organizations />
+              </dummy>
+            XML
+          end
+        end
+      end
+
+      context 'a manifest visitor visiting a manifest element without <resources>' do
+        should 'raise exceptoin' do
+          assert_error do
+            el(<<-XML).accept @v
+              <dummy identifier="sample" version="1.0">
+                <metadata>
+                  <schema />
+                  <schemaversion />
+                </metadata>
+                <organizations />
+              </dummy>
+            XML
+          end
+        end
+      end
+
+      context 'a manifest visitor visiting a manifest element without <organizations>' do
+        should 'raise exceptoin' do
+          assert_error do
+            el(<<-XML).accept @v
+              <dummy identifier="sample" version="1.0">
+                <metadata>
+                  <schema />
+                  <schemaversion />
+                </metadata>
+                <resources />
+              </dummy>
+            XML
+          end
+        end
+      end
+
+      context 'a manifest visitor visiting a manifest element without identifier' do
+        should 'raise exeption' do
+          assert_error do
+            el(<<-XML).accept(@v)
+              <dummy version="1.0">
+                <metadata>
+                  <schema />
+                  <schemaversion />
+                </metadata>
+                <resources />
+                <organizations />
+              </dummy>
+              XML
+          end
+        end
+      end
+
+      context 'a manifest visitor visiting a manifest element with version too long' do
+        should 'raise exeption' do
+          assert_error do
+            el(<<-XML).accept(@v)
+              <dummy identifier="dummy" version="01234567890123456789x">
+                <metadata>
+                  <schema />
+                  <schemaversion />
+                </metadata>
+                <resources />
+                <organizations />
+              </dummy>
+              XML
+          end
+        end
+      end
+
+      private
+
+      def assert_error(&block)
+        assert_raise Manifest::Error, &block
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/map_info_test.rb

@@ -0,0 +1,41 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class MapInfoTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      setup do
+        @v = MapInfo.new
+      end
+      
+      test 'an empty element causes error' do
+        assert_raise(MapInfo::Error) { el.accept(@v) }
+      end
+
+      test 'default value' do
+        el('<dummy targetObjectiveID="dummy" />').accept(@v)
+        assert_equal true, @v.read_satisfied_status
+        assert_equal true, @v.read_normalized_measure
+        assert_equal false, @v.write_satisfied_status
+        assert_equal false, @v.write_normalized_measure
+      end
+
+      test 'a visitor set attribute values as its attributes' do
+        el(<<-XML).accept(@v)
+          <dummy
+            targetObjectiveID="bar"
+            readSatisfiedStatus="0"
+            readNormalizedMeasure="0"
+            writeSatisfiedStatus="1"
+            writeNormalizedMeasure="1" />
+        XML
+        assert_equal 'bar', @v.target_objective_id
+        assert_equal false, @v.read_satisfied_status
+        assert_equal false, @v.read_normalized_measure
+        assert_equal true, @v.write_satisfied_status
+        assert_equal true, @v.write_normalized_measure
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/map_test.rb

@@ -0,0 +1,32 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class MapTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      setup do
+        @v = Map.new
+      end
+      
+      test 'an empty element' do
+        assert_raise Map::Error do
+          el('<dummy />').accept(@v)
+        end
+      end
+
+      test 'default value' do
+        el('<dummy targetID="dummy" />').accept(@v)
+        assert_equal true, @v.read_shared_data
+        assert_equal true, @v.write_shared_data
+      end
+
+      test 'attributes' do
+        el('<dummy targetID="foo" readSharedData="0" writeSharedData="0" />').accept(@v)
+        assert_equal 'foo', @v.target_id
+        assert_equal false, @v.read_shared_data
+        assert_equal false, @v.write_shared_data
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/min_normalized_measure_test.rb

@@ -0,0 +1,28 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class MinNormalizedMeasureTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      setup do
+        @v = MinNormalizedMeasure.new
+      end
+      
+      [-1.0, 0, 1.0].each do |valid_value|
+        tag = "<dummy>#{valid_value}</dummy>"
+        test tag do
+          el(tag).accept(@v)
+          assert_equal valid_value, @v.to_f
+        end
+      end
+
+      [-1.0001, 1.0001].each do |invalid_value|
+        tag = "<dummy>#{invalid_value}</dummy>"
+        test tag do
+          assert_raise(MinNormalizedMeasure::Error) { el(tag).accept(@v) }
+        end
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/navigation_interface_test.rb

@@ -0,0 +1,29 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class NavigationInterfaceTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      setup do
+        @v = NavigationInterface.new
+      end
+      
+      test 'an empty element' do
+        assert el('<dummy />').accept(@v)
+      end
+
+      test 'an element with children' do
+        hide_lmsui_visitor = mock()
+        hide_lmsui_visitor.expects(:visit).twice
+        @v.expects(:hide_lmsui_visitor).twice.returns(hide_lmsui_visitor)
+        assert el(<<-XML).accept(@v)
+          <dummy>
+            <adlnav:hideLMSUI />
+            <adlnav:hideLMSUI />
+          </dummy>
+        XML
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/non_negative_integer_attribute_test.rb

@@ -0,0 +1,64 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class NonNegativeIntegerAttributeTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      context 'a visitor with xs:nonNegativeInteger attribute' do
+        class Visitor
+          include VisitorPattern
+          include CustomError
+          include Attributes
+
+          attribute :non_negative_integer, 'foo'
+        end
+
+        setup do
+          @v = Visitor.new
+        end
+
+        should 'raise exception when visiting an empty element' do
+          assert_error do
+            el('<dummy />').accept(@v)
+          end
+        end
+
+        %w( 0 +21 00009 411 ).each do |valid_number|
+          tag = "<dummy foo='#{valid_number}' />"
+          should "accept #{tag}" do
+            el(tag).accept(@v)
+            assert_equal Integer(valid_number, 10), @v.foo
+          end
+        end
+
+        %w( 1.000 -50 ).each do |invalid_number|
+          tag = "<dummy foo='#{invalid_number}' />"
+          should "raise exception when visiting #{tag}" do
+            assert_error { el(tag).accept(@v) }
+          end
+        end
+
+        def assert_error(&block)
+          assert_raise Visitor::Error, &block
+        end
+      end
+
+      context 'a visitor with xs:nonNegativeInteger attribute optional' do
+        class VisitorWithOptionalAttribute
+          include VisitorPattern
+          include CustomError
+          include Attributes
+
+          attribute :non_negative_integer, 'bar', allow_nil: true
+        end
+
+        should 'raise nothing' do
+          assert_nothing_raised do
+            el('<dummy />').accept(VisitorWithOptionalAttribute.new)
+          end
+        end
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/objective_test.rb

@@ -0,0 +1,45 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class ObjectiveTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      setup do
+        @v = Objective.new
+        @v.stubs(:min_normalized_measure_visitor).returns(stub(:visit))
+        @v.stubs(:map_info_visitor).returns(stub(:visit))
+      end
+      
+      test 'an empty element cause error' do
+        assert_raise(Objective::Error) { el.accept(@v) }
+      end
+
+      test 'default satisfiedByMeasure' do
+        el('<dummy objectiveID="dummy" />').accept(@v)
+        assert_equal false, @v.satisfied_by_measure
+      end
+
+      test 'a visitor visits <minNormalizedMeasure>' do
+        @v.expects(:min_normalized_measure_visitor).once.returns(mock(:visit))
+        el(<<-XML).accept(@v)
+          <dummy objectiveID="dummy">
+            <imsss:minNormalizedMeasure />
+          </dummy>
+        XML
+      end
+
+      test 'a visitor visits multiple <mapInfo>s' do
+        map_info_visitor = mock()
+        map_info_visitor.expects(:visit).twice
+        @v.expects(:map_info_visitor).twice.returns(map_info_visitor)
+        el(<<-XML).accept(@v)
+          <dummy objectiveID="dummy">
+            <imsss:mapInfo />
+            <imsss:mapInfo />
+          </dummy>
+        XML
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/objectives_test.rb

@@ -0,0 +1,37 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class ObjectivesTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      setup do
+        @v = Objectives.new
+        @v.stubs(:primary_objective_visitor).returns(stub(:visit))
+        @v.stubs(:objective_visitor).returns(stub(:visit))
+      end
+      
+      test 'an empty element causes error' do
+        assert_raise(Objectives::Error) { el.accept(@v) }
+      end
+
+      test 'a minimal element' do
+        assert_nothing_raised { el('<dummy><imsss:primaryObjective />').accept(@v) }
+      end
+
+      test 'a fat element' do
+        objective_visitor = mock()
+        objective_visitor.expects(:visit).twice
+        @v.expects(:objective_visitor).twice.returns(objective_visitor)
+        @v.expects(:primary_objective_visitor).once.returns(mock(:visit))
+        el(<<-XML).accept(@v)
+          <dummy>
+            <imsss:primaryObjective />
+            <imsss:objective />
+            <imsss:objective />
+          </dummy>
+        XML
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/organization_test.rb

@@ -0,0 +1,115 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class OrganizationTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      context 'an organization visitor with its parent no base' do
+        setup do
+          @v = Organization.new
+          @v.stubs(:item_visitor).returns(stub(:visit))
+          @v.stubs(:title_visitor).returns(stub(:visit))
+          @v.stubs(:completion_threshold_visitor).returns(stub(:visit))
+          @v.stubs(:sequencing_visitor).returns(stub(:visit))
+        end
+
+        context 'visiting a fully equipped element' do
+          setup do
+            item_visitor = mock()
+            item_visitor.expects(:visit).twice
+            @v.expects(:item_visitor).twice.returns(item_visitor)
+            @v.expects(:title_visitor).once.returns(mock(:visit))
+            @v.expects(:completion_threshold_visitor).once.returns(mock(:visit))
+            @v.expects(:sequencing_visitor).once.returns(mock(:visit))
+            el(<<-XML).accept(@v)
+              <organization identifier="toc1"
+                            adlseq:objectivesGlobalToSystem=" false "
+                            adlcp:sharedDataGlobalToSystem=" 0 ">
+                <item />
+                <item />
+                <title />
+                <adlcp:completionThreshold />
+                <imsss:sequencing />
+              </organization>
+            XML
+          end
+
+          should 'set an identifier value as its attribute' do
+            assert_equal 'toc1', @v.identifier
+          end
+
+          should 'set an objectivesGlobalToSystem value as its attribute' do
+            assert_equal false, @v.objectives_global_to_system
+          end
+
+          should 'set a sharedDataGlobalToSystem value as its attribute' do
+            assert_equal false, @v.shared_data_global_to_system
+          end
+        end
+
+        context 'visiting an element with optional attributes missing' do
+          setup do
+            el(<<-XML).accept(@v)  
+              <organization identifier="toc1">
+                <item />
+                <item />
+                <title />
+              </organization>
+            XML
+          end
+
+          should 'set default values as the optional attributes' do
+            assert_equal false, @v.objectives_global_to_system
+            assert_equal false, @v.shared_data_global_to_system
+          end
+        end
+
+        context 'visiting an element without an item element' do
+          should 'raise exception' do
+            assert_error do
+              el('<organization identifier="b00"><title /></organization>').accept(@v)
+            end
+          end
+        end
+
+        context 'visiting an element without a title element' do
+          should 'raise exception' do
+            assert_error do
+              el('<organization identifier="b11"><item /></organization').accept(@v)
+            end
+          end
+        end
+      end
+
+      context 'an organization visitor with its parent having XML Base' do
+        setup do
+          @v = Organization.new(base: Pathname('path/to/base'))
+          @v.stubs(:item_visitor).returns(stub(:visit))
+          @v.stubs(:title_visitor).returns(stub(:visit))
+        end
+
+        context 'visiting a minimal organization element with XML Base' do
+          should 'handle xml:base' do
+            el(<<-XML).accept(@v)
+              <organization identifier="toc2" xml:base="x/y/z/">
+                <item />
+                <title />
+              </organization>
+            XML
+            assert_equal Pathname('path/to/base/x/y/z'), @v.base
+          end
+        end
+      end
+
+      private
+
+      def assert_error(&block)
+        assert_raise(Organization::Error, &block)
+      end
+    end
+  end
+end
+
+#  LocalWords:  el toc adlseq objectivesGlobalToSystem adlcp imsss
+#  LocalWords:  sharedDataGlobalToSystem completionThreshold

data/test/scorm2004/manifest/organizations_test.rb

@@ -0,0 +1,68 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class OrganizationsTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      context 'an organizations visitor' do
+        setup do
+          @v = Organizations.new
+          @v.stubs(:organization_visitor).returns(stub(:visit))
+        end
+
+        context 'visiting an organizations element' do
+          should 'set the default value as its attribute' do
+            organization_visitor = mock()
+            organization_visitor.expects(:visit).twice
+            @v.expects(:organization_visitor).twice.returns(organization_visitor)
+            el(<<-XML).accept(@v)
+              <organizations default="t41">
+                <organization identifier="t41" />
+                <organization identifier="t42" />
+              </organizations>
+            XML
+            assert_equal 't41', @v.default
+          end
+        end
+
+        context 'visiting an organizations element without a default attribute' do
+          should 'raise exceptoin' do
+            assert_error do
+              el('<organizations />').accept(@v)
+            end
+          end
+        end
+
+        context 'visiting an organizations element with its default organization not found' do
+          should 'raise exception' do
+            assert_error do
+              el('<organization default="t41" />').accept(@v)
+            end
+          end
+        end
+      end
+
+      context 'an organization visitor with its parent having an XML Base value' do
+        context 'visiting an organizations element' do
+          should 'handle XML Base' do
+            @v = Organizations.new(base: Pathname('a/b/c'))
+            @v.stubs(:organization_visitor).returns(stub(:visit))
+            el(<<-XML).accept(@v)
+              <organizations default="t41" xml:base="x/y/z/">
+                <organization identifier="t41" />
+              </organizations>
+            XML
+            assert_equal Pathname('a/b/c/x/y/z'), @v.base
+          end
+        end
+      end
+
+      private
+
+      def assert_error(&block)
+        assert_raise Organizations::Error, &block
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/partial_manifest.rb

@@ -0,0 +1,23 @@
+require 'nokogiri'
+
+module PartialManifest
+  def el(fragment = '<dummy />')
+    Nokogiri::XML(<<XML).root.at('./*', Scorm2004::Manifest::NS)
+<?xml version = "1.0" standalone = "no"?>
+<manifest identifier = "minimal_manifest" version = "1.0"
+    xmlns = "http://www.imsglobal.org/xsd/imscp_v1p1"
+    xmlns:adlcp = "http://www.adlnet.org/xsd/adlcp_v1p3"
+    xmlns:adlseq = "http://www.adlnet.org/xsd/adlseq_v1p3"
+    xmlns:adlnav = "http://www.adlnet.org/xsd/adlnav_v1p3"
+    xmlns:imsss = "http://www.imsglobal.org/xsd/imsss"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation = "http://www.imsglobal.org/xsd/imscp_v1p1 imscp_v1p1.xsd
+        http://www.adlnet.org/xsd/adlcp_v1p3 adlcp_v1p3.xsd
+        http://www.adlnet.org/xsd/adlseq_v1p3 adlseq_v1p3.xsd
+        http://www.adlnet.org/xsd/adlnav_v1p3 adlnav_v1p3.xsd
+        http://www.imsglobal.org/xsd/imsss imsss_v1p0.xsd">
+#{fragment}
+</manifest>
+XML
+  end
+end

data/test/scorm2004/manifest/partial_manifest_test.rb

@@ -0,0 +1,44 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class PartialManifestTest < ActiveSupport::TestCase
+      class DummyVisitor
+        include PartialManifest
+      end
+
+      context 'Partial manifest of a dummy element' do
+        setup do
+          @el = DummyVisitor.new.el('<dummy />')
+        end
+
+        should 'be named dummy' do
+          assert_equal 'dummy', @el.name
+        end
+
+        should 'be a Nokogiri node' do
+          assert_kind_of Nokogiri::XML::Node, @el
+        end
+      end
+
+      context 'Partial manifest of nil' do
+        setup do
+          @el = DummyVisitor.new.el(nil)
+        end
+
+        should 'be nil' do
+          assert_nil @el
+        end
+      end
+
+      context 'default partial manifest' do
+        should 'return an empty element' do
+          el = DummyVisitor.new.el
+          assert_kind_of Nokogiri::XML::Node, el
+          assert_equal 'dummy', el.name
+        end
+      end
+    end
+  end
+end
+