scorm2004-manifest 0.1.0

data/test/scorm2004/manifest/attributes_test.rb

@@ -0,0 +1,224 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class AttributesTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      class Visitor
+        include VisitorPattern
+        include Attributes
+      end
+
+      context 'visitor having binary attributes with default values' do
+        class VisitorHavingBinaryAttributesWithDefaultValues < Visitor
+          attribute(:boolean, 'defaultsTrue', default: true)
+          attribute(:boolean, 'defaultsFalse', default: false)
+        end
+
+        setup do
+          @v = VisitorHavingBinaryAttributesWithDefaultValues.new
+        end
+
+        should 'set default values' do
+          el('<dummy />').accept(@v)
+          assert_equal true, @v.defaults_true
+          assert_equal false, @v.defaults_false
+        end
+
+        should 'set boolean values' do
+          el('<dummy defaultsTrue="false" defaultsFalse="true" />').accept(@v)
+          assert_equal false, @v.defaults_true
+          assert_equal true, @v.defaults_false
+        end
+      end
+
+      context 'visitor having binary attributes without default values' do
+        class VisitorHavingBinaryAttributesWithoutDefaultValues < Visitor
+          include CustomError
+
+          attribute(:boolean, 'foo')
+          attribute(:boolean, 'bar')
+        end
+
+        setup do
+          @v = VisitorHavingBinaryAttributesWithoutDefaultValues.new
+        end
+
+        should 'raise exception if the attribute not found' do
+          assert_raise VisitorHavingBinaryAttributesWithoutDefaultValues::Error do
+            el('<dummy foo="true" />').accept(@v)
+          end
+        end
+      end
+
+      context 'visitor having a attribute with namespace prefix' do
+        class VisitorHavingNamespacedAttribute < Visitor
+          attribute(:boolean, 'adlcp:foo')
+        end
+
+        setup do
+          @v = VisitorHavingNamespacedAttribute.new
+        end
+
+        should 'create an unnamespaced attribute' do
+          el('<dummy adlcp:foo="false" />').accept(@v)
+          assert_equal false, @v.foo
+        end
+      end
+
+      context 'visitor with an id attribute' do
+        class VisitorWithIdAttribute < Visitor
+          include CustomError
+
+          attribute(:id, 'foo')
+        end
+
+        setup do
+          @v = VisitorWithIdAttribute.new
+        end
+
+        should 'set a string value as the attribute' do
+          el('<dummy foo="bar" />').accept(@v)
+          assert_equal 'bar', @v.foo
+        end
+
+        should 'raise exception unless the attribute exists' do
+          assert_raise VisitorWithIdAttribute::Error do
+            el('<dummy />').accept(@v)
+          end
+        end
+
+        whitespaces = {
+          'space'   => ' ',
+          'tab'     => "\t",
+          'newline' => "\n",
+          'return'  => "\r"
+        }
+        whitespaces.each do |k, v|
+          should "raise exception if the attribute value contains a #{k}" do
+            assert_raise VisitorWithIdAttribute::Error do
+              el("<dummy foo='bar#{v}baz' />").accept(@v)
+            end
+          end
+        end
+
+        should 'raise exception if the attribute value consists of digits' do
+          assert_nothing_raised do
+            el('<dummy foo="4bar2baz6" />').accept(@v)
+          end
+
+          assert_raise VisitorWithIdAttribute::Error do
+            el('<dummy foo="123456789" />').accept(@v)
+          end
+        end
+      end
+
+      context 'visitor having a decimal attribute without a default value' do
+        class VisitorHavingDecimalAttributeWithoutDefaultValue < Visitor
+          include CustomError
+
+          attribute(:decimal, 'foo')
+        end
+
+        setup do
+          @v = VisitorHavingDecimalAttributeWithoutDefaultValue.new
+        end
+
+        should 'raise exception unless the attribute exists' do
+          assert_raise VisitorHavingDecimalAttributeWithoutDefaultValue::Error do
+            el('<dummy />').accept(@v)
+          end
+        end
+
+        should 'set a float value' do
+          el('<dummy foo="6.789" />').accept(@v)
+          assert_equal 6.789, @v.foo
+        end
+      end
+
+      context 'visitor having a decimal attribute with a default value' do
+        class VisitorHavingDecimalAttributeWithDefaultValue < Visitor
+          attribute(:decimal, 'foo', default: -1.234)
+        end
+
+        setup do
+          @v = VisitorHavingDecimalAttributeWithDefaultValue.new
+        end
+
+        should 'set a default value' do
+          el('<dummy />').accept(@v)
+          assert_equal -1.234, @v.foo
+        end
+
+        should 'set a float value' do
+          el('<dummy foo="45.67" />').accept(@v)
+          assert_equal 45.67, @v.foo
+        end
+      end
+
+      context 'visitor having a decimal attribute with a range' do
+        class VisitorHavingDecimalAttributeWithRange < Visitor
+          include CustomError
+
+          attribute(:decimal, 'foo', range: -1.0..1.0)
+        end
+
+        setup do
+          @v = VisitorHavingDecimalAttributeWithRange.new
+        end
+
+        should 'set a float value if the value is within the range' do
+          [-1.0, 0.0, 1.0].each do |v|
+            el("<dummy foo='#{v}' />").accept(@v)
+            assert_equal v, @v.foo, v
+          end
+        end
+
+        should 'raise exception if the value is out of the range' do
+          [-1.0001, 1.0001].each do |v|
+            assert_raise VisitorHavingDecimalAttributeWithRange::Error do
+              el("<dummy foo='#{v}' />").accept(@v)
+            end
+          end
+        end
+      end
+
+      context 'visitor having an idref attribute' do
+        class VisitorHavingIdrefAttribute < Visitor
+          include CustomError
+
+          attribute :idref, 'foo'
+        end
+
+        setup do
+          @v = VisitorHavingIdrefAttribute.new
+        end
+
+        context 'visitng an element with an idref attribute' do
+          should 'set the idref value ast its attribute' do
+            el('<dummy foo="bar" />').accept(@v)
+            assert_equal 'bar', @v.foo
+          end
+        end
+
+        context 'visiting an element without an idref attribute' do
+          should 'raise exception' do
+            assert_raise VisitorHavingIdrefAttribute::Error do
+              el('<dummy />').accept(@v)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+#  LocalWords:  AttributesTest PartialManifest VisitorPattern defaultsTrue el
+#  LocalWords:  VisitorHavingBinaryAttributesWithDefaultValues defaultsFalse
+#  LocalWords:  VisitorHavingBinaryAttributesWithoutDefaultValues CustomError
+#  LocalWords:  VisitorHavingNamespacedAttribute adlcp unnamespaced spm baz
+#  LocalWords:  VisitorWithStringAttribute VisitorWithIdAttribute whitespaces
+#  LocalWords:  VisitorHavingDecimalAttributeWithDefaultValue
+#  LocalWords:  VisitorHavingDecimalAttributeWithoutDefaultValue
+#  LocalWords:  VisitorHavingDecimalAttributeWithRange

data/test/scorm2004/manifest/children_test.rb

@@ -0,0 +1,330 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class Son
+      include VisitorPattern
+    end
+
+    class Grandson
+      include VisitorPattern
+    end
+
+    class ChildrenTest < ActiveSupport::TestCase
+      include PartialManifest
+
+      context 'visitor that has one and only one child' do
+        class VisitorHasOneAndOnlyOneChild
+          include VisitorPattern
+          include CustomError
+          include Children
+
+          has_one_and_only_one('imscp:son')
+        end
+
+        setup do
+          @v = VisitorHasOneAndOnlyOneChild.new
+        end
+
+        context 'visiting an element with one child' do
+          should 'visit the only one child' do
+            @v.expects(:visit_son).once
+            assert el('<dummy><son /></dummy>').accept(@v)
+          end
+
+          should 'provide an accessor method for the child' do
+            el('<dummy><son /></dummy>').accept(@v)
+            assert @v.respond_to?(:son)
+            assert_kind_of Son, @v.son
+          end
+
+          should 'call a visitor factory method during the visit' do
+            @v.expects(:son_visitor).once.returns(mock(:visit))
+            el('<dummy><son /></dummy>').accept(@v)
+          end
+        end
+
+        context 'visiting an element without the child' do
+          should 'raise exception' do
+            assert_raise VisitorHasOneAndOnlyOneChild::Error do
+              el('<dummy />').accept(@v)
+            end
+          end
+        end
+
+        context 'visiting an element with two children' do
+          should 'raise exception' do
+            assert_raise VisitorHasOneAndOnlyOneChild::Error do
+              el(<<XML).accept(@v)
+<dummy>
+  <son />
+  <son />
+</dummy>
+XML
+            end
+          end
+        end
+      end
+
+      context 'visitor that has zero or one child' do
+        class VisitorHasZeroOrOneChild
+          include VisitorPattern
+          include CustomError
+          include Children
+
+          has_zero_or_one('imscp:son')
+        end
+
+        setup do
+          @v = VisitorHasZeroOrOneChild.new
+        end
+
+        context 'visiting an element with one child' do
+          should 'visit the only one child' do
+            @v.expects(:visit_son).once
+            assert el('<dummy><son /></dummy>').accept(@v)
+          end
+
+          should 'provide an accessor method for the child' do
+            el('<dummy><son /></dummy>').accept(@v)
+            assert @v.respond_to?(:son)
+            assert_kind_of Son, @v.son
+          end
+
+          should 'call a visitor factory method during the visit' do
+            @v.expects(:son_visitor).once.returns(mock(:visit))
+            el('<dummy><son /></dummy>').accept(@v)
+          end
+        end
+
+        context 'visiting an element without the child' do
+          should 'raise nothing' do
+            assert_nothing_raised do
+              el('<dummy />').accept(@v)
+            end
+          end
+        end
+
+        context 'visiting an element with two children' do
+          should 'raise exception' do
+            assert_raise VisitorHasZeroOrOneChild::Error do
+              el(<<XML).accept(@v)
+<dummy>
+  <son />
+  <son />
+</dummy>
+XML
+            end
+          end
+        end
+      end
+
+      context 'visitor that has one or more children' do
+        class VisitorHasOneOrMoreChildren
+          include VisitorPattern
+          include CustomError
+          include Children
+
+          has_one_or_more('imscp:son')
+        end
+
+        setup do
+          @v = VisitorHasOneOrMoreChildren.new
+        end
+
+        context 'visiting an element without a child' do
+          should 'raise exception' do
+            assert_raise VisitorHasOneOrMoreChildren::Error do
+              el('<dummy />').accept(@v)
+            end
+          end
+        end
+
+        context 'visiting an element with a child' do
+          should 'visit the child' do
+            @v.expects(:visit_sons)
+            assert el('<dummy><son /></dummy>').accept(@v)
+          end
+
+          should 'provide an accessor method for children' do
+            el('<dummy><son /></dummy>').accept(@v)
+            assert_kind_of Array, @v.sons
+            assert_equal 1, @v.sons.size
+          end
+
+          should 'call a visitor factory method during the visit' do
+            @v.expects(:son_visitor).once.returns(mock(:visit))
+            el('<dummy><son /></dummy>').accept(@v)
+          end
+        end
+        
+        context 'visiting an element with two children' do
+          should 'visit the children' do
+            @v.expects(:visit_sons)
+            assert el(<<XML).accept(@v)
+<dummy>
+  <son />
+  <son />
+</dummy>
+XML
+          end
+
+          should 'provide an accessor method for children' do
+            assert el(<<XML).accept(@v)
+<dummy>
+  <son />
+  <son />
+</dummy>
+XML
+            assert_kind_of Array, @v.sons
+            assert_equal 2, @v.sons.size
+          end
+
+          should 'call a visitor factory method during the visit' do
+            @v.expects(:son_visitor).twice.returns(stub(:visit))
+            assert el(<<XML).accept(@v)
+<dummy>
+  <son />
+  <son />
+</dummy>
+XML
+          end
+        end
+      end
+
+      context 'visitor that has zero or more children' do
+        class VisitorHasZeroOrMoreChildren
+          include VisitorPattern
+          include CustomError
+          include Children
+
+          has_zero_or_more('imscp:son')
+        end
+
+        setup do
+          @v = VisitorHasZeroOrMoreChildren.new
+        end
+
+        context 'visiting an element without a child' do
+          should 'not raise exception' do
+            assert_nothing_raised do
+              el('<dummy />').accept(@v)
+            end
+          end
+        end
+
+        context 'visiting an element with a child' do
+          should 'visit the child' do
+            @v.expects(:visit_sons)
+            assert el('<dummy><son /></dummy>').accept(@v)
+          end
+
+          should 'provide an accessor method for children' do
+            el('<dummy><son /></dummy>').accept(@v)
+            assert_kind_of Array, @v.sons
+            assert_equal 1, @v.sons.size
+          end
+
+          should 'call a visitor factory method during the visit' do
+            @v.expects(:son_visitor).once.returns(mock(:visit))
+            el('<dummy><son /></dummy>').accept(@v)
+          end
+        end
+        
+        context 'visiting an element with two children' do
+          should 'visit the children' do
+            @v.expects(:visit_sons)
+            assert el(<<XML).accept(@v)
+<dummy>
+  <son />
+  <son />
+</dummy>
+XML
+          end
+
+          should 'provide an accessor method for children' do
+            assert el(<<XML).accept(@v)
+<dummy>
+  <son />
+  <son />
+</dummy>
+XML
+            assert_kind_of Array, @v.sons
+            assert_equal 2, @v.sons.size
+          end
+
+          should 'call a visitor factory method during the visit' do
+            @v.expects(:son_visitor).twice.returns(stub(:visit))
+            assert el(<<XML).accept(@v)
+<dummy>
+  <son />
+  <son />
+</dummy>
+XML
+          end
+        end
+      end
+
+      context 'visitor has one grandson' do
+        class VisitorHasOneGrandson
+          include VisitorPattern
+          include CustomError
+          include Children
+
+          has_one_and_only_one './imscp:son/imscp:grandson'
+        end
+
+        setup do
+          @v = VisitorHasOneGrandson.new
+        end
+
+        should 'raise exception if the grandson does not exist' do
+          assert_raise VisitorHasOneGrandson::Error do
+            el('<dummy><grandson /></dummy>').accept(@v)
+          end
+        end
+
+        should 'visit the grandson' do
+          el(<<-XML).accept(@v)
+            <dummy>
+              <son>
+                <grandson />
+              </son>
+            </dummy>
+          XML
+          assert_kind_of Grandson, @v.grandson
+        end
+
+        should 'call the grandson_visitor method during the visit' do
+          @v.expects(:grandson_visitor).once.returns(mock(:visit))
+          el(<<-XML).accept(@v)
+            <dummy>
+              <son>
+                <grandson />
+              </son>
+            </dummy>
+          XML
+        end
+      end
+
+      context 'a visitor with the visitor option' do
+        class NamespacedVisitor
+          include VisitorPattern
+          include CustomError
+          include Children
+
+          has_one_and_only_one 'imscp:foo', visitor: :foo_bar
+        end
+        
+        setup do
+          @v = NamespacedVisitor.new
+          @v.expects(:foo_bar_visitor).once.returns(mock(:visit))
+        end
+
+        should 'visits a child element using the visitor' do
+          el('<dummy><foo /></dummy>').accept(@v)
+        end
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/completion_threshold_test.rb

@@ -0,0 +1,80 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class CompletionThresholdTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      
+      context 'an <adlcp:completionThreshold> visitor' do
+        setup do
+          @v = CompletionThreshold.new
+        end
+
+        context 'visiting an <adlcp:completionThreshold> element' do
+          setup do
+            el(<<-XML).accept(@v)
+              <adlcp:completionThreshold
+               completedByMeasure = "true"
+               minProgressMeasure = "0.75"
+               progressWeight = "0.3" />
+            XML
+          end
+
+          should 'set completedByMeasure value as its attribute' do
+            assert_equal true, @v.completed_by_measure
+          end
+
+          should 'set minProgressMeasure value as its attribute' do
+            assert_equal 0.75, @v.min_progress_measure
+          end
+
+          should 'set progressWeight value as its attribute' do
+            assert_equal 0.3, @v.progress_weight
+          end
+        end
+
+        context 'visiting an empty <adlcp:completionThreshold> element' do
+          should 'set default values' do
+            el('<adlcp:completionThreshold />').accept(@v)
+            assert_equal false, @v.completed_by_measure
+            assert_equal 1.0,  @v.min_progress_measure
+            assert_equal 1.0,  @v.progress_weight
+          end
+        end
+
+        context 'visiting an <adlcp:completionThreshold> element with its attribute value out of range' do
+          should 'raise exception for too small minProgressMeasure' do
+            assert_error do
+              el('<adlcp:completionThreshold minProgressMeasure="-0.0001" />').accept(@v)
+            end
+          end
+
+          should 'raise exception for too large minProgressMeasure' do
+            assert_error do
+              el('<adlcp:completionThreshold minProgressMeasure="1.0001" />').accept(@v)
+            end
+          end
+
+          should 'raise exception for too small progressWeight' do
+            assert_error do
+              el('<adlcp:completionThreshold progressWeight="-0.0001" />').accept(@v)
+            end
+          end
+
+          should 'raise exception for too large progressWeight' do
+            assert_error do
+              el('<adlcp:completionThreshold progressWeight="1.0001" />').accept(@v)
+            end
+          end
+        end
+      end
+
+      private
+
+      def assert_error(&block)
+        assert_raise CompletionThreshold::Error, &block
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/condition_rule_test.rb

@@ -0,0 +1,40 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class ConditionRuleTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      setup do
+        @v = ConditionRule.new
+      end
+      
+      test 'a visitor visits children' do
+        @v.expects(:rule_conditions_visitor).once.returns(mock(:visit))
+        @v.expects(:rule_action_visitor).once.returns(mock(:visit))
+        el(<<-XML).accept(@v)
+          <dummy>
+            <imsss:ruleConditions />
+            <imsss:ruleAction />
+          </dummy>
+        XML
+      end
+
+      test 'an element without <ruleConditions> causes error' do
+        assert_error do
+          el('<dummy><imsss:ruleAction /></dummy>').accept(@v)
+        end
+      end
+
+      test 'an element without <ruleAction> causes error' do
+        assert_error do
+          el('<dummy><imsss:ruleCondition></dummy>').accept(@v)
+        end
+      end
+
+      def assert_error(&block)
+        assert_raise ConditionRule::Error, &block
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/constrained_choice_considerations_test.rb

@@ -0,0 +1,25 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class ConstrainedChoiceConsiderationsTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      setup do
+        @v = ConstrainedChoiceConsiderations.new
+      end
+      
+      test 'default values' do
+        el.accept @v
+        assert_equal false, @v.prevent_activation
+        assert_equal false, @v.constrain_choice
+      end
+
+      test 'attributes' do
+        el('<dummy preventActivation="1" constrainChoice="1" />').accept @v
+        assert_equal true, @v.prevent_activation
+        assert_equal true, @v.constrain_choice
+      end
+    end
+  end
+end