scorm2004-manifest 0.1.0

data/test/scorm2004/manifest/visitor_pattern_test.rb

@@ -0,0 +1,85 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class VisitorPatternTest < ActiveSupport::TestCase
+      class DumbVisitor
+        include VisitorPattern
+      end
+
+      include PartialManifest
+      
+      context 'Visitor visiting a element' do
+        setup do
+          @v = DumbVisitor.new
+          el('<dummy />').accept(@v)
+        end
+
+        should 'set a Nokogiri node as an attribute named el' do
+          assert_kind_of Nokogiri::XML::Node, @v.el
+        end
+
+        should 'return self when visiting a element' do
+          assert_equal @v, el('<dummy />').accept(@v)
+        end
+      end
+
+      context 'Visitor with do_visit method' do
+        class PrivateDoVisit
+          include VisitorPattern
+
+          private
+
+          def do_visit
+            do_visit_probe
+          end
+        end
+
+        setup do
+          @v = PrivateDoVisit.new
+          @v.expects(:do_visit_probe)
+        end
+
+        should 'call do_visit method' do
+          el('<dummy />').accept(@v)
+        end
+      end
+
+      context 'Visitor with the attributes class method' do
+        setup do
+          @v = DumbVisitor.new
+          @v.class.stubs(:attributes)
+        end
+
+        should 'call the check_attributes method when visiting an element' do
+          @v.expects(:check_attributes)
+          el('<dummy />').accept(@v)
+        end
+
+        should 'call check_foo if attributes include foo when visiting an element' do
+          @v.class.stubs(:attributes).returns([:foo])
+          @v.expects(:check_foo)
+          el('<dummy />').accept(@v)
+        end
+      end
+
+      context 'Visitor with the children class method' do
+        setup do
+          @v = DumbVisitor.new
+          @v.class.stubs(:children)
+        end
+
+        should 'call the visit_children method when visiting an element' do
+          @v.expects(:visit_children)
+          el('<dummy />').accept(@v)
+        end
+
+        should 'call visit_foo if children include foo when visiting an element' do
+          @v.class.stubs(:children).returns([:foo])
+          @v.expects(:visit_foo)
+          el('<dummy />').accept(@v)
+        end
+      end
+    end
+  end
+end

data/test/scorm2004/manifest/xml_base_test.rb

@@ -0,0 +1,125 @@
+require_relative '../../helper'
+
+module Scorm2004
+  module Manifest
+    class XmlBaseTest < ActiveSupport::TestCase
+      include PartialManifest
+      
+      class Visitor
+        include VisitorPattern
+        include CustomError
+        include XmlBase
+      end
+
+      context 'visitor with its parent base nil' do
+        setup do
+          @v = Visitor.new(base: nil)
+        end
+
+        context 'visiting a node with xml:base beginning leading a slash' do
+          should 'raise exception' do
+            el('<dummy xml:base="/path/to/dir/" />').accept(@v)
+            assert_raise Visitor::Error do
+              @v.base
+            end
+          end
+        end
+
+        context 'visiting a node without xml:base trailing a slash' do
+          should 'raise exception' do
+            el('<dummy xml:base="http://exampe.com/a" />').accept(@v)
+            assert_raise Visitor::Error do
+              @v.base
+            end
+          end
+        end
+
+        context 'visiting a node without xml:base' do
+          should 'set nil as its base' do
+            el('<dummy />').accept(@v)
+            assert_nil @v.base
+          end
+        end
+
+        context 'visiting a node with a URI xml:base' do
+          should 'set the uri as its base' do
+            el('<dummy xml:base="http://example.com/path/to/file/" />').accept(@v)
+            assert_equal URI('http://example.com/path/to/file/'), @v.base
+          end
+        end
+
+        context 'visiting a node with a pathname xml:base' do
+          should 'set the pathname as its base' do
+            el('<dummy xml:base="path/to/dir/" />').accept(@v)
+            assert_equal Pathname('path/to/dir'), @v.base
+          end
+        end
+
+        context 'visiting a node with a relative-path xml:base' do
+          should 'set normalized pathname as its base' do
+            el('<dummy xml:base="../../path/to/dir/" />').accept(@v)
+            assert_equal Pathname('path/to/dir'), @v.base
+          end
+        end
+      end
+
+      context 'visitor with its parent base an absolute URL' do
+        setup do
+          @parent_base = URI('http://example.com/a/')
+          @v = Visitor.new(base: @parent_base)
+        end
+
+        context 'visiting a node without xml:base' do
+          should 'set the parent base as its base' do
+            el('<dummy />').accept(@v)
+            assert_equal @parent_base, @v.base
+          end
+        end
+        
+        context 'visiting a node with a relateve URL' do
+          should 'set a resolved URI as its base' do
+            el('<dummy xml:base="../../x/" />').accept(@v)
+            assert_equal URI('http://example.com/x/'), @v.base
+          end
+        end
+        
+        context 'visiting a node with a absolute URL' do
+          should 'set its XML Base value as its base' do
+            absolute_url = 'http://example.net/b/'
+            el("<dummy xml:base='#{absolute_url}' />").accept(@v)
+            assert_equal URI(absolute_url), @v.base
+          end
+        end
+      end
+
+      context 'visitor with its parent base a relative URL' do
+        setup do
+          @parent_path = Pathname('a/b/c')
+          @v = Visitor.new(base: Pathname(@parent_path))
+        end
+        
+        context 'visiting a node without xml:base' do
+          should 'set the parent base as its base' do
+            el('<dummy />').accept(@v)
+            assert_equal @parent_path, @v.base
+          end
+        end
+
+        context 'visiting a node with an absolute URL' do
+          should 'set its XML Base value as its base' do
+            absolute_url = URI('http://example.org/x/y/z/')
+            el("<dummy xml:base='#{absolute_url}' />").accept(@v)
+            assert_equal absolute_url, @v.base
+          end
+        end
+
+        context 'visiting a node with a relative URL' do
+          should 'set a resolved URL as its base' do
+            el('<dummy xml:base="x/y/z/" />').accept(@v)
+            assert_equal Pathname('a/b/c/x/y/z'), @v.base
+          end
+        end
+      end
+    end
+  end
+end

data/test/scorm2004/manifest_test.rb

@@ -0,0 +1,33 @@
+require_relative '../helper'
+
+module Scorm2004
+  class ManifestTest < ActiveSupport::TestCase
+    context 'Manifest' do
+      should 'be a module' do
+        assert_kind_of Module, Manifest
+      end
+
+      should 'have its own exception class' do
+        assert_kind_of StandardError, Manifest::Error.new
+      end
+
+      should 'have its own namespace as a Hash' do
+        assert_kind_of Hash, Manifest::NS
+      end
+    end
+
+    context 'Manifest()' do
+      should 'call Manifest.parse' do
+        Scorm2004::Manifest.expects(:parse)
+        Scorm2004::Manifest :dummy
+      end
+    end
+
+    context 'Manifest.parse()' do
+      should 'let a manifest visitor visit a root element' do
+        Scorm2004::Manifest::Manifest.expects(:new).returns(mock(:visit))
+        Scorm2004::Manifest.parse('<dummy />')
+      end
+    end
+  end
+end

data/test/scorm2004_test.rb

@@ -0,0 +1,9 @@
+require_relative 'helper'
+
+class Scorm2004Test < ActiveSupport::TestCase
+  context 'Scorm2004' do
+    should 'be a module' do
+      assert_kind_of Module, Scorm2004
+    end
+  end
+end

data/test/sece_test.rb

@@ -0,0 +1,53 @@
+require_relative 'helper'
+require_relative 'functional_test'
+
+class SeceTest < ActiveSupport::TestCase
+  include FunctionalTest
+
+  gist 2020335, 'sece'
+
+  test 'parsing imsmanifest.xml of ADL SCORM 2004 4th Edition SECE' do
+    manifest = Scorm2004::Manifest(xml)
+
+    # <manifest>
+    assert_equal 'LMSTestPackage_T-01b', manifest.identifier
+    assert_equal '1.0', manifest.version
+
+    # <organizations>
+    organizations = manifest.organizations
+    assert_equal 'ORG-AAE040C6-5D31-FF80-7A74-C93346D3DE42', organizations.default
+
+    # <organization>
+    organization = organizations.organizations.first
+    assert_equal 'ORG-AAE040C6-5D31-FF80-7A74-C93346D3DE42', organization.identifier
+    assert_equal 'SCORM 2004 4th Edition Sequencing Essentials Content Example 1.0', organization.title.to_s
+
+    # <controlMode>
+    Scorm2004::Manifest::ControlMode.attributes.each do |attr|
+      assert_equal (attr != :forward_only), organization.sequencing.control_mode.send(attr), attr.to_s
+    end
+    
+    item_0 = organization.items[0]
+    Scorm2004::Manifest::ControlMode.attributes.each do |attr|
+      assert_equal (attr != :forward_only), item_0.sequencing.control_mode.send(attr), attr.to_s
+    end
+
+    last = organization.items.last
+    Scorm2004::Manifest::ControlMode.attributes.each do |attr|
+      assert_equal ![:flow, :forward_only].include?(attr), last.sequencing.control_mode.send(attr), attr.to_s
+    end
+
+    # <postConditionRule>
+    rule = last.sequencing.sequencing_rules.post_condition_rules.first
+    rule_conditions = rule.rule_conditions
+    assert_equal 'all', rule_conditions.condition_combination
+    rule_condition = rule_conditions.rule_conditions.first
+    assert_equal 'noOp', rule_condition.operator
+    assert_equal 'attempted', rule_condition.condition
+    rule_action = rule.rule_action
+    assert_equal 'exitAll', rule_action.action
+
+    # <rollupRules>
+    assert_equal 1.0, last.sequencing.rollup_rules.objective_measure_weight
+  end
+end

metadata

@@ -0,0 +1,260 @@
+--- !ruby/object:Gem::Specification
+name: scorm2004-manifest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Takahiro Noda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &2153645740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153645740
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2153645260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153645260
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: &2153644780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: *2153644780
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &2153644300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: *2153644300
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2153643800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: *2153643800
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2153643260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *2153643260
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2153642640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *2153642640
+description: ! 'scorm2004-manifest is a Ruby gem that provides a manifest file parser
+  for SCORM 2004 4th edition. It parses and validates the manifest file according
+  to SCORM 2004 4th Edition Content Aggregation Model (CAM) Version 1.1. After parsing
+  and validating, it builds an object tree that captures XML''s hierarchical structure.
+
+'
+email: takahiro.noda+rubygems@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/scorm2004-manifest.rb
+- lib/scorm2004/manifest.rb
+- lib/scorm2004/manifest/adlseq_map_info.rb
+- lib/scorm2004/manifest/adlseq_objective.rb
+- lib/scorm2004/manifest/adlseq_objectives.rb
+- lib/scorm2004/manifest/attributes.rb
+- lib/scorm2004/manifest/children.rb
+- lib/scorm2004/manifest/completion_threshold.rb
+- lib/scorm2004/manifest/condition_rule.rb
+- lib/scorm2004/manifest/constrained_choice_considerations.rb
+- lib/scorm2004/manifest/control_mode.rb
+- lib/scorm2004/manifest/custom_error.rb
+- lib/scorm2004/manifest/data.rb
+- lib/scorm2004/manifest/data_from_lms.rb
+- lib/scorm2004/manifest/delivery_controls.rb
+- lib/scorm2004/manifest/dependency.rb
+- lib/scorm2004/manifest/error.rb
+- lib/scorm2004/manifest/file.rb
+- lib/scorm2004/manifest/hide_lmsui.rb
+- lib/scorm2004/manifest/href.rb
+- lib/scorm2004/manifest/item.rb
+- lib/scorm2004/manifest/limit_conditions.rb
+- lib/scorm2004/manifest/manifest.rb
+- lib/scorm2004/manifest/map.rb
+- lib/scorm2004/manifest/map_info.rb
+- lib/scorm2004/manifest/min_normalized_measure.rb
+- lib/scorm2004/manifest/navigation_interface.rb
+- lib/scorm2004/manifest/objective.rb
+- lib/scorm2004/manifest/objectives.rb
+- lib/scorm2004/manifest/organization.rb
+- lib/scorm2004/manifest/organizations.rb
+- lib/scorm2004/manifest/presentation.rb
+- lib/scorm2004/manifest/primary_objective.rb
+- lib/scorm2004/manifest/randomization_controls.rb
+- lib/scorm2004/manifest/resource.rb
+- lib/scorm2004/manifest/resources.rb
+- lib/scorm2004/manifest/rollup_action.rb
+- lib/scorm2004/manifest/rollup_condition.rb
+- lib/scorm2004/manifest/rollup_conditions.rb
+- lib/scorm2004/manifest/rollup_considerations.rb
+- lib/scorm2004/manifest/rollup_rule.rb
+- lib/scorm2004/manifest/rollup_rules.rb
+- lib/scorm2004/manifest/rule_action.rb
+- lib/scorm2004/manifest/rule_condition.rb
+- lib/scorm2004/manifest/rule_conditions.rb
+- lib/scorm2004/manifest/schema.rb
+- lib/scorm2004/manifest/schemaversion.rb
+- lib/scorm2004/manifest/sequencing.rb
+- lib/scorm2004/manifest/sequencing_collection.rb
+- lib/scorm2004/manifest/sequencing_rules.rb
+- lib/scorm2004/manifest/text_node.rb
+- lib/scorm2004/manifest/time_limit_action.rb
+- lib/scorm2004/manifest/title.rb
+- lib/scorm2004/manifest/visitor_pattern.rb
+- lib/scorm2004/manifest/xml_base.rb
+- test/functional_test.rb
+- test/helper.rb
+- test/mbce_test.rb
+- test/msce_test.rb
+- test/scorm2004/manifest/adlseq_map_info_test.rb
+- test/scorm2004/manifest/adlseq_objective_test.rb
+- test/scorm2004/manifest/adlseq_objectives_test.rb
+- test/scorm2004/manifest/any_uri_token_test.rb
+- test/scorm2004/manifest/attributes_test.rb
+- test/scorm2004/manifest/children_test.rb
+- test/scorm2004/manifest/completion_threshold_test.rb
+- test/scorm2004/manifest/condition_rule_test.rb
+- test/scorm2004/manifest/constrained_choice_considerations_test.rb
+- test/scorm2004/manifest/control_mode_test.rb
+- test/scorm2004/manifest/custom_error_test.rb
+- test/scorm2004/manifest/data_from_lms_test.rb
+- test/scorm2004/manifest/data_test.rb
+- test/scorm2004/manifest/delivery_controls_test.rb
+- test/scorm2004/manifest/dependency_test.rb
+- test/scorm2004/manifest/duration_attribute_test.rb
+- test/scorm2004/manifest/file_test.rb
+- test/scorm2004/manifest/hide_lmsui_test.rb
+- test/scorm2004/manifest/href_test.rb
+- test/scorm2004/manifest/item_test.rb
+- test/scorm2004/manifest/limit_conditions_test.rb
+- test/scorm2004/manifest/manifest_test.rb
+- test/scorm2004/manifest/map_info_test.rb
+- test/scorm2004/manifest/map_test.rb
+- test/scorm2004/manifest/min_normalized_measure_test.rb
+- test/scorm2004/manifest/navigation_interface_test.rb
+- test/scorm2004/manifest/non_negative_integer_attribute_test.rb
+- test/scorm2004/manifest/objective_test.rb
+- test/scorm2004/manifest/objectives_test.rb
+- test/scorm2004/manifest/organization_test.rb
+- test/scorm2004/manifest/organizations_test.rb
+- test/scorm2004/manifest/partial_manifest.rb
+- test/scorm2004/manifest/partial_manifest_test.rb
+- test/scorm2004/manifest/presentation_test.rb
+- test/scorm2004/manifest/primary_objective_test.rb
+- test/scorm2004/manifest/randomization_controls_test.rb
+- test/scorm2004/manifest/resource_test.rb
+- test/scorm2004/manifest/resources_test.rb
+- test/scorm2004/manifest/rollup_action_test.rb
+- test/scorm2004/manifest/rollup_condition_test.rb
+- test/scorm2004/manifest/rollup_conditions_test.rb
+- test/scorm2004/manifest/rollup_considerations_test.rb
+- test/scorm2004/manifest/rollup_rule_test.rb
+- test/scorm2004/manifest/rollup_rules_test.rb
+- test/scorm2004/manifest/rule_action_test.rb
+- test/scorm2004/manifest/rule_condition_test.rb
+- test/scorm2004/manifest/rule_conditions_test.rb
+- test/scorm2004/manifest/schema_test.rb
+- test/scorm2004/manifest/schemaversion_test.rb
+- test/scorm2004/manifest/sequencing_collection_test.rb
+- test/scorm2004/manifest/sequencing_rules_test.rb
+- test/scorm2004/manifest/sequencing_test.rb
+- test/scorm2004/manifest/string_attribute_test.rb
+- test/scorm2004/manifest/text_node_test.rb
+- test/scorm2004/manifest/time_limit_action_test.rb
+- test/scorm2004/manifest/title_test.rb
+- test/scorm2004/manifest/token_attribute_test.rb
+- test/scorm2004/manifest/visitor_pattern_test.rb
+- test/scorm2004/manifest/xml_base_test.rb
+- test/scorm2004/manifest_test.rb
+- test/scorm2004_test.rb
+- test/sece_test.rb
+homepage: https://github.com/tnoda/scorm2004-manifest
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 688621200751165052
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: A manifest file parser/validator for SCORM 2004 4th Edition
+test_files: []