scorm2004-manifest 0.1.0

data/test/scorm2004/manifest/control_mode_test.rb

@@ -0,0 +1,41 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class ControlModeTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      setup do
+        @v = ControlMode.new
+      end
+      
+      test 'default values' do
+        el('<dummy />').accept(@v)
+        assert_equal true,  @v.choice
+        assert_equal true,  @v.choice_exit
+        assert_equal false, @v.flow
+        assert_equal false, @v.forward_only
+        assert_equal true,  @v.use_current_attempt_objective_info
+        assert_equal true,  @v.use_current_attempt_progress_info
+      end
+
+      test 'attributes' do
+        el(<<-XML).accept(@v)
+          <dummy
+            choice="0"
+            choiceExit="0"
+            flow="1"
+            forwardOnly="1"
+            useCurrentAttemptProgressInfo="0"
+            useCurrentAttemptObjectiveInfo="0" />
+        XML
+        assert_equal false, @v.choice
+        assert_equal false, @v.choice_exit
+        assert_equal true,  @v.flow
+        assert_equal true,  @v.forward_only
+        assert_equal false, @v.use_current_attempt_objective_info
+        assert_equal false, @v.use_current_attempt_progress_info
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/custom_error_test.rb

@@ -0,0 +1,43 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class CustomErrorTest < ActiveSupport::TestCase
+      context 'Visitor including the CustomError module' do
+        class Visitor
+          include VisitorPattern
+          include CustomError
+        end
+
+        setup do
+          @v = Visitor.new
+        end
+
+        should 'have its own error class' do
+          assert_kind_of Scorm2004::Manifest::Error, "#{@v.class}::Error".constantize.new
+        end
+
+        should 'have its own error method' do
+          assert @v.respond_to? :error
+        end
+
+        context 'error method' do
+          should 'raise its own exceptoin' do
+            assert_raise "#{@v.class}::Error".constantize do
+              @v.error('dummy message')
+            end
+          end
+
+          should 'set message' do
+            begin
+              message = 'something wrong'
+              @v.error(message)
+            rescue "#{@v.class}::Error".constantize => e
+              assert_equal message, e.message
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/data_from_lms_test.rb

@@ -0,0 +1,47 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class DataFromLmsTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      setup do
+        @v = DataFromLms.new
+      end
+      
+      context 'an <adlcp:dataFromLMS> visitor' do
+        should 'respond to :content' do
+          assert @v.respond_to? :content
+        end
+
+        should 'respond to :to_s' do
+          assert @v.respond_to? :to_s
+        end
+
+        context 'visiting an empty element' do
+          should 'return a blank string as its content' do
+            el('<dummy />').accept(@v)
+            assert_equal '', @v.content
+            assert_equal @v.to_s, @v.content
+          end
+        end
+
+        context 'visiting an element' do
+          should 'return the content as its content' do
+            el('<dummy>a sample content</dummy>').accept(@v)
+            assert_equal 'a sample content', @v.content
+            assert_equal @v.to_s, @v.content
+          end
+        end
+
+        context 'visitng an element whose content is too large' do
+          should 'raise exception' do
+            assert_raise DataFromLms::Error do
+              el('<dummy>' + 'x' * (DataFromLms.spm + 1) + '</dummy>').accept(@v)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/data_test.rb

@@ -0,0 +1,31 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class DataTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      setup do
+        @v = Scorm2004::Manifest::Data.new
+      end
+      
+      test 'an empty element' do
+        assert_raise Data::Error do
+          el('<dummy />').accept(@v)
+        end
+      end
+
+      test 'an element with children' do
+        map_visitor = mock()
+        map_visitor.expects(:visit).twice
+        @v.expects(:map_visitor).twice.returns(map_visitor)
+        assert el(<<-XML).accept(@v)
+          <dummy>
+            <adlcp:map />
+            <adlcp:map />
+          </dummy>
+        XML
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/delivery_controls_test.rb

@@ -0,0 +1,27 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class DeliveryControlsTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      setup do
+        @v = DeliveryControls.new
+      end
+      
+      test 'default values' do
+        el.accept @v
+        assert_equal true, @v.tracked
+        assert_equal false, @v.completion_set_by_content
+        assert_equal false, @v.objective_set_by_content
+      end
+
+      test 'attributes' do
+        el('<dummy tracked="0" completionSetByContent="1" objectiveSetByContent="1" />').accept @v
+        assert_equal false, @v.tracked
+        assert_equal true, @v.completion_set_by_content
+        assert_equal true, @v.objective_set_by_content
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/dependency_test.rb

@@ -0,0 +1,53 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class DependencyTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      setup do
+        @v = Dependency.new
+      end
+      
+      context 'a dependency visitor' do
+        setup do
+          @v = Dependency.new
+        end
+
+        context 'visiting a dependency element' do
+          should 'set an identifierref value as its attribute' do
+            el(<<-XML).accept(@v)
+              <dependency identifierref="k22" />
+              <resources>
+                <resource identifier="k22" />
+              </resources>
+            XML
+            assert_equal 'k22', @v.identifierref
+          end
+        end
+
+        context 'visiting a dependency element without an identifierref attribute' do
+          should 'raise exception' do
+            assert_error do
+              el('<dependency />').accept(@v)
+            end
+          end
+        end
+
+        context 'visiting a dependency element with its referencing resource nonexistent' do
+          should 'raise exceptoin' do
+            assert_error do
+              el('<dependency identifierref="k22" />').accept(@v)
+            end
+          end
+        end
+      end
+
+      private
+
+      def assert_error(&block)
+        assert_raise(Dependency::Error, &block)
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/duration_attribute_test.rb

@@ -0,0 +1,59 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class DurationAttributeTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      context 'an visitor with a duration attribute' do
+        class Visitor
+          include VisitorPattern
+          include CustomError
+          include Attributes
+
+          attribute :duration, 'foo'
+        end
+
+        setup do
+          @v = Visitor.new
+        end
+
+        should 'raise exception when visiting an empty element' do
+          assert_error { el('<dummy />').accept(@v) }
+        end
+
+        %w( PT1004199059S PT130S PT2M10S P1DT2S -P1Y P1Y2M3DT5H20M30.123S ).each do |valid_duration|
+          tag = "<dummy foo='#{valid_duration}' />"
+          should "accept #{tag}" do
+            el(tag).accept(@v)
+            assert_equal valid_duration, @v.foo
+          end
+        end
+
+        %w( 1Y P1S P-1Y P1M2Y P1Y-1M ).each do |invalid_duration|
+          tag = "<dumm foo='#{invalid_duration}' />"
+          should "reject #{tag}" do
+            assert_error { el(tag).accept(@v )}
+          end
+        end
+
+        def assert_error(&block)
+          assert_raise Visitor::Error, &block
+        end
+      end
+
+      context 'an visitor with a duration attribute optional' do
+        class VisitorWithOptionalAttribute
+          include VisitorPattern
+          include Attributes
+
+          attribute :duration, 'bar', allow_nil: true
+        end
+
+        should 'raise nothing' do
+          assert_nothing_raised { el('<dummy />').accept(VisitorWithOptionalAttribute.new) }
+        end
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/file_test.rb

@@ -0,0 +1,40 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class FileTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      context 'a file visitor with its parent no XML Base' do
+        setup do
+          @v = Scorm2004::Manifest::File.new
+        end
+
+        context 'visiting a file element' do
+          should 'set an href value as its attribute' do
+            el('<file href="path/to/file" />').accept(@v)
+            assert_equal 'path/to/file', @v.href
+          end
+        end
+
+        context 'visiting a file element without an href attribute' do
+          should 'raise exception' do
+            assert_raise Scorm2004::Manifest::File::Error do
+              el('<file />').accept(@v)
+            end
+          end
+        end
+      end
+
+      context 'a file visitor with its parent a path base' do
+        context 'visiting a file element' do
+          should 'set a resolved href value as its attribute' do
+            @v = Scorm2004::Manifest::File.new(base: Pathname('path/to/base'))
+            el('<file href="path/to/file" />').accept(@v)
+            assert_equal 'path/to/base/path/to/file', @v.href
+          end
+        end
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/hide_lmsui_test.rb

@@ -0,0 +1,40 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class HideLmsuiTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      setup do
+        @v = HideLmsui.new
+      end
+      
+      HideLmsui.vocabulary.each do |token|
+        tag ="<adlnav:hideLMSUI>#{token}</adlnav:hideLMSUI>" 
+        test tag do
+          el(tag).accept(@v)
+          assert_equal token, @v.content
+          assert_equal @v.content, @v.to_s
+        end
+      end
+
+      test 'an empty element' do
+        assert_error do
+          el('<dummy />').accept(@v)
+        end
+      end
+
+      test 'an element with an invalid token' do
+        assert_error do
+          el('<dummy>invalidToken</dummy').accept(@v)
+        end
+      end
+
+      private
+
+      def assert_error(&block)
+        assert_raise HideLmsui::Error, &block
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/href_test.rb

@@ -0,0 +1,43 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class HrefTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      class Visitor
+        include VisitorPattern
+        include CustomError
+        include XmlBase
+        include Href
+      end
+
+      context 'a visitor with its own base value' do
+        setup do
+          @v = Visitor.new(base: Pathname('a/b/c'))
+        end
+
+        context 'visiting an element with xml:base and href' do
+          should 'calculate the resolved href properly' do
+            el('<dummy xml:base="../../d/e/f/" href="x/y/z.html').accept(@v)
+            assert_equal 'a/d/e/f/x/y/z.html', @v.href
+          end
+        end
+
+        context 'visiting an element without href' do
+          should 'return nil for href' do
+            el('<dummy xml:base="../../d/e/f/" />').accept(@v)
+            assert_nil @v.href
+          end
+        end
+
+        context 'visiting an element with href' do
+          should 'calculate the resolved href properly' do
+            el('<dummy href="../../x/y/z.html" />').accept(@v)
+            assert_equal 'a/x/y/z.html', @v.href
+          end
+        end
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/item_test.rb

@@ -0,0 +1,86 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class ItemTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      context 'an <item> visitor' do
+        setup do
+          @v = Item.new
+          stubify(@v)
+        end
+
+        context 'with expectations visiting a fully-equipped <item> element' do
+          setup do
+            %w( title time_limit_action data_from_lms completion_threshold
+                sequencing presentation data ).each do |singular|
+              @v.expects("#{singular}_visitor".intern).once.returns(mock(:visit))
+            end
+            item_visitor = mock()
+            item_visitor.expects(:visit).twice
+            @v.expects(:item_visitor).twice.returns(item_visitor)
+            el(<<-XML).accept(@v)
+              <item identifier="i92"
+                    identifierref="r25"
+                    isvisible="false"
+                    parameters="?foo=bar#baz">
+                <title />
+                <item />
+                <item />
+                <adlcp:timeLimitAction />
+                <adlcp:dataFromLMS />
+                <adlcp:completionThreshold />
+                <imsss:sequencing />
+                <adlnav:presentation />
+                <adlcp:data />
+              </item>
+              <resources>
+                <resource identifier="r25" />
+              </resources>    
+            XML
+          end
+
+          should 'satisfy expectations' do
+            assert @v
+          end
+
+          should 'set an identifier value as its attribute' do
+            assert_equal 'i92', @v.identifier
+          end
+
+          should 'set an identifierref value as its attribute' do
+            assert_equal 'r25', @v.identifierref
+          end
+
+          should 'set an isvisible value as its attribute' do
+            assert_equal false, @v.isvisible
+          end
+
+          should 'set a paramters value as its attribute' do
+            assert_equal '?foo=bar#baz', @v.parameters
+          end
+        end
+
+        context 'visiting a bare <item> element' do
+          should 'set default values as its attributes' do
+            el('<item identifier="r26"><title /><item /></item>').accept(@v)
+            assert_equal "r26", @v.identifier
+            assert_equal nil,   @v.identifierref
+            assert_equal true,  @v.isvisible
+            assert_equal nil,   @v.parameters
+          end
+        end
+      end
+
+      private
+
+      def stubify(visitor)
+        %w( title item time_limit_action data_from_lms completion_thoreshold
+            sequencing presentation data ).each do |child|
+          visitor.stubs("#{child}_visitor".intern).returns(stub(:visit))
+        end
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/limit_conditions_test.rb

@@ -0,0 +1,34 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class LimitConditionsTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      setup do
+        @v = LimitConditions.new
+      end
+      
+      test 'an empty element' do
+        assert el('<dummy />').accept(@v)
+      end
+
+      %w( 0 1 001 +41 001002 ).each do |valid_number|
+        tag = "<dummy attemptLimit='#{valid_number}' />"
+        test tag do
+          el(tag).accept(@v)
+          assert_equal Integer(valid_number, 10), @v.attempt_limit
+        end
+      end
+
+      %w( -1 +0.1 1.000 ).each do |invalid_number|
+        tag = "<dummy attemptLimit='#{invalid_number}' />"
+        test tag do
+          assert_raise LimitConditions::Error do
+            el(tag).accept(@v)
+          end
+        end
+      end
+    end
+  end
+end