scorm2004-manifest 0.1.0

data/lib/scorm2004/manifest/hide_lmsui.rb

@@ -0,0 +1,21 @@
+module Scorm2004
+  module Manifest
+    class HideLmsui
+      include VisitorPattern
+      include CustomError
+      include TextNode
+      
+      def self.vocabulary
+        %w( previous continue exit exitAll abandon abandonAll suspendAll )
+      end
+
+      private
+      
+      def do_visit
+        unless self.class.vocabulary.include?(content)
+          error("Invalid <adlnav:hideLMSUI> token: #{content}")
+        end
+      end
+    end
+  end
+end

data/lib/scorm2004/manifest/href.rb

@@ -0,0 +1,24 @@
+module Scorm2004
+  module Manifest
+    module Href
+      def href
+        (base ? resolve_href : relative_href).try(:to_s)
+      end
+
+      private
+
+      def relative_href
+        value = el.at('./@href', NS)
+        return unless value
+        uri = URI(value)
+        uri.absolute? ? uri : Pathname(uri.path)
+      end
+
+      def resolve_href
+        return nil unless relative_href
+        return relative_href if relative_href.is_a?(URI)
+        base + relative_href.to_s
+      end
+    end
+  end
+end

data/lib/scorm2004/manifest/item.rb

@@ -0,0 +1,36 @@
+module Scorm2004
+  module Manifest
+    class Item
+      include VisitorPattern
+      include CustomError
+      include Children
+      include Attributes
+      
+      attribute :id,      'identifier'
+      attribute :string,  'identifierref', allow_nil: true
+      attribute :boolean, 'isvisible',     default: true
+      attribute :string,  'parameters',    allow_nil: true
+
+      has_one_and_only_one 'imscp:title'
+      has_zero_or_more     'imscp:item'
+      has_zero_or_one      'adlcp:timeLimitAction'
+      has_zero_or_one      'adlcp:dataFromLMS'
+      has_zero_or_one      'adlcp:completionThreshold'
+      has_zero_or_one      'imsss:sequencing'
+      has_zero_or_one      'adlnav:presentation'
+      has_zero_or_one      'adlcp:data'
+
+      private
+      
+      def do_visit
+        if identifierref && resource.nil?
+          error("A <resource> element whose identifier is #{identifierref} not found:")
+        end
+      end
+
+      def resource
+        el.at("/imscp:manifest/imscp:resources/imscp:resource[@identifier='#{identifierref}']", NS)
+      end
+    end
+  end
+end

data/lib/scorm2004/manifest/limit_conditions.rb

@@ -0,0 +1,12 @@
+module Scorm2004
+  module Manifest
+    class LimitConditions
+      include VisitorPattern
+      include CustomError
+      include Attributes
+      
+      attribute :non_negative_integer, 'attemptLimit',                 allow_nil: true
+      attribute :duration,             'attemptAbsoluteDurationLimit', allow_nil: true
+    end
+  end
+end

data/lib/scorm2004/manifest/manifest.rb

@@ -0,0 +1,26 @@
+module Scorm2004
+  module Manifest
+    class Manifest
+      include VisitorPattern
+      include CustomError
+      include Children
+      include Attributes
+      include XmlBase
+      
+      has_one_and_only_one './imscp:metadata/imscp:schema'
+      has_one_and_only_one './imscp:metadata/imscp:schemaversion'
+      has_one_and_only_one 'imscp:resources'
+      has_one_and_only_one 'imscp:organizations'
+      has_zero_or_one      'imsss:sequencingCollection'
+
+      attribute :id,     'identifier'
+      attribute :string, 'version', spm: 20
+
+      private
+      
+      def do_visit
+        
+      end
+    end
+  end
+end

data/lib/scorm2004/manifest/map.rb

@@ -0,0 +1,13 @@
+module Scorm2004
+  module Manifest
+    class Map
+      include VisitorPattern
+      include CustomError
+      include Attributes
+      
+      attribute :any_uri, 'targetID'
+      attribute :boolean, 'readSharedData',  default: true
+      attribute :boolean, 'writeSharedData', default: true
+    end
+  end
+end

data/lib/scorm2004/manifest/map_info.rb

@@ -0,0 +1,15 @@
+module Scorm2004
+  module Manifest
+    class MapInfo
+      include VisitorPattern
+      include CustomError
+      include Attributes
+      
+      attribute :any_uri, 'targetObjectiveID'
+      attribute :boolean, 'readSatisfiedStatus', default: true
+      attribute :boolean, 'readNormalizedMeasure', default: true
+      attribute :boolean, 'writeSatisfiedStatus', default: false
+      attribute :boolean, 'writeNormalizedMeasure', default: false
+    end
+  end
+end

data/lib/scorm2004/manifest/min_normalized_measure.rb

@@ -0,0 +1,18 @@
+module Scorm2004
+  module Manifest
+    class MinNormalizedMeasure
+      include VisitorPattern
+      include CustomError
+      
+      def to_f
+        Float(el.content)
+      end
+
+      private
+      
+      def do_visit
+        error("#{el} should be between -1 and 1.") unless (-1.0..1.0).include?(to_f)
+      end
+    end
+  end
+end

data/lib/scorm2004/manifest/navigation_interface.rb

@@ -0,0 +1,10 @@
+module Scorm2004
+  module Manifest
+    class NavigationInterface
+      include VisitorPattern
+      include Children
+
+      has_zero_or_more 'adlnav:hideLMSUI'
+    end
+  end
+end

data/lib/scorm2004/manifest/objective.rb

@@ -0,0 +1,16 @@
+module Scorm2004
+  module Manifest
+    class Objective
+      include VisitorPattern
+      include CustomError
+      include Children
+      include Attributes
+
+      attribute :boolean, 'satisfiedByMeasure', default: false
+      attribute :any_uri, 'objectiveID'
+
+      has_zero_or_one 'imsss:minNormalizedMeasure'
+      has_zero_or_more 'imsss:mapInfo'
+    end
+  end
+end

data/lib/scorm2004/manifest/objectives.rb

@@ -0,0 +1,12 @@
+module Scorm2004
+  module Manifest
+    class Objectives
+      include VisitorPattern
+      include CustomError
+      include Children
+
+      has_one_and_only_one 'imsss:primaryObjective'
+      has_zero_or_more 'imsss:objective'
+    end
+  end
+end

data/lib/scorm2004/manifest/organization.rb

@@ -0,0 +1,20 @@
+module Scorm2004
+  module Manifest
+    class Organization
+      include VisitorPattern
+      include CustomError
+      include Children
+      include Attributes
+      include XmlBase
+
+      has_one_or_more      'imscp:item'
+      has_one_and_only_one 'imscp:title'
+      has_zero_or_one      'adlcp:completionThreshold'
+      has_zero_or_one      'imsss:sequencing'
+
+      attribute :id,      'identifier'
+      attribute :boolean, 'adlseq:objectivesGlobalToSystem', default: false
+      attribute :boolean, 'adlcp:sharedDataGlobalToSystem',  default: false
+    end
+  end
+end

data/lib/scorm2004/manifest/organizations.rb

@@ -0,0 +1,24 @@
+module Scorm2004
+  module Manifest
+    class Organizations
+      include VisitorPattern
+      include CustomError
+      include Children
+      include Attributes
+      include XmlBase
+      
+      attribute :idref, 'default'
+      has_one_or_more 'imscp:organization'
+
+      private
+      
+      def do_visit
+        error('Default <resource> not foulnd: ' + default) unless default_resource
+      end
+
+      def default_resource
+        el.at("/imscp:manifest/imscp:organizations/imscp:organization[@identifier='#{default}']", NS)
+      end
+    end
+  end
+end

data/lib/scorm2004/manifest/presentation.rb

@@ -0,0 +1,10 @@
+module Scorm2004
+  module Manifest
+    class Presentation
+      include VisitorPattern
+      include Children
+      
+      has_zero_or_one 'adlnav:navigationInterface'
+    end
+  end
+end

data/lib/scorm2004/manifest/primary_objective.rb

@@ -0,0 +1,24 @@
+module Scorm2004
+  module Manifest
+    class PrimaryObjective
+      include VisitorPattern
+      include CustomError
+      include Children
+      include Attributes
+      
+      attribute :boolean, 'satisfiedByMeasure', default: false
+      attribute :any_uri, 'objectiveID', allow_nil: true
+
+      has_zero_or_one 'imsss:minNormalizedMeasure'
+      has_zero_or_more 'imsss:mapInfo'
+
+      private
+      
+      def do_visit
+        error(<<EOS) if el.at('./imsss:mapInfo', NS) && objective_id.nil?
+If a <primaryObjective> contains an objective map (<mapInfo>), then the objectiveID attribute is required.
+EOS
+      end
+    end
+  end
+end

data/lib/scorm2004/manifest/randomization_controls.rb

@@ -0,0 +1,16 @@
+module Scorm2004
+  module Manifest
+    class RandomizationControls
+      include VisitorPattern
+      include CustomError
+      include Attributes
+
+      TIMINGS = %w( never once onEachNewAttempt )
+
+      attribute :token, 'randomizationTiming', vocabulary: TIMINGS, default: 'never'
+      attribute :non_negative_integer, 'selectCount', allow_nil: true
+      attribute :boolean, 'reorderChildren', default: false
+      attribute :token, 'selectionTiming', vocabulary: TIMINGS, default: 'never'
+    end
+  end
+end

data/lib/scorm2004/manifest/resource.rb

@@ -0,0 +1,18 @@
+module Scorm2004
+  module Manifest
+    class Resource
+      include VisitorPattern
+      include CustomError
+      include Children
+      include Attributes
+      include XmlBase
+      include Href
+      
+      attribute :id, 'identifier'
+      attribute :token, 'adlcp:scormType', vocabulary: %w( sco asset )
+
+      has_zero_or_more 'imscp:file'
+      has_zero_or_more 'imscp:dependency'
+    end
+  end
+end

data/lib/scorm2004/manifest/resources.rb

@@ -0,0 +1,12 @@
+module Scorm2004
+  module Manifest
+    class Resources
+      include VisitorPattern
+      include CustomError
+      include Children
+      include XmlBase
+      
+      has_zero_or_more 'imscp:resource'
+    end
+  end
+end

data/lib/scorm2004/manifest/rollup_action.rb

@@ -0,0 +1,13 @@
+module Scorm2004
+  module Manifest
+    class RollupAction
+      include VisitorPattern
+      include CustomError
+      include Attributes
+
+      ACTIONS = %w( satisfied notSatisfied completed incomplete )
+
+      attribute :token, 'action', vocabulary: ACTIONS
+    end
+  end
+end

data/lib/scorm2004/manifest/rollup_condition.rb

@@ -0,0 +1,24 @@
+module Scorm2004
+  module Manifest
+    class RollupCondition
+      include VisitorPattern
+      include CustomError
+      include Attributes
+
+      CONDITIONS = [
+        'satisfied',
+        'objectiveStatusKnown',
+        'objectiveMeasureKnown',
+        'completed',
+        'activityProgressKnown',
+        'attempted',
+        'attemptLimitExceeded',
+        'timeLimitExceeded',
+        'outsideAvailableTimeRange'
+      ]
+
+      attribute :token, 'operator', vocabulary: %w( not noOp ), default: 'noOp'
+      attribute :token, 'condition', vocabulary: CONDITIONS
+    end
+  end
+end

data/lib/scorm2004/manifest/rollup_conditions.rb

@@ -0,0 +1,14 @@
+module Scorm2004
+  module Manifest
+    class RollupConditions
+      include VisitorPattern
+      include CustomError
+      include Children
+      include Attributes
+
+      attribute :token, 'conditionCombination', vocabulary: %w( any all ), default: 'any'
+
+      has_one_or_more 'imsss:rollupCondition'
+    end
+  end
+end

data/lib/scorm2004/manifest/rollup_considerations.rb

@@ -0,0 +1,17 @@
+module Scorm2004
+  module Manifest
+    class RollupConsiderations
+      include VisitorPattern
+      include CustomError
+      include Attributes
+      
+      CONDITIONS = %w( always ifAttempted ifNotSkipped ifNotSuspended )
+
+      %w( requiredForSatisfied requireForNotSatisfied requiredForCompleted requireForIncomplete ).each do |attr|
+        attribute :token, attr, vocabulary: CONDITIONS, default: CONDITIONS.first
+      end
+      
+      attribute :boolean, 'measureSatisfactionIfActive', default: true
+    end
+  end
+end

data/lib/scorm2004/manifest/rollup_rule.rb

@@ -0,0 +1,19 @@
+module Scorm2004
+  module Manifest
+    class RollupRule
+      include VisitorPattern
+      include CustomError
+      include Children
+      include Attributes
+
+      CONDITIONS = %w( all any none atLeastCount atLeastPercent )
+
+      attribute :token, 'childActivitySet', vocabulary: CONDITIONS, default: CONDITIONS.first
+      attribute :non_negative_integer, 'minimumCount', default: 0
+      attribute :decimal, 'minimumPercent', range: 0.0..1.0, default: 0.0
+
+      has_one_and_only_one 'imsss:rollupConditions'
+      has_one_and_only_one 'imsss:rollupAction'
+    end
+  end
+end

data/lib/scorm2004/manifest/rollup_rules.rb

@@ -0,0 +1,16 @@
+module Scorm2004
+  module Manifest
+    class RollupRules
+      include VisitorPattern
+      include CustomError
+      include Children
+      include Attributes
+
+      attribute :boolean, 'rollupObjectiveSatisfied', default: true
+      attribute :boolean, 'rollupProgressCompletion', default: true
+      attribute :decimal, 'objectiveMeasureWeight', range: 0.0..1.0, default: 1.0
+
+      has_zero_or_more 'imsss:rollupRule'
+    end
+  end
+end

data/lib/scorm2004/manifest/rule_action.rb

@@ -0,0 +1,31 @@
+module Scorm2004
+  module Manifest
+    class RuleAction
+      include VisitorPattern
+      include CustomError
+      include Attributes
+      
+      PRE  = %w( skip disabled hiddenFromChoice stopForwardTraversal )
+      POST = %w( exitParent exitAll retry retryAll continue previous )
+      EXIT = %w( exit )
+
+      attribute :token, 'action', vocabulary: PRE + POST + EXIT
+
+      private
+      
+      def do_visit
+        parent_name = el.at('..').name
+        case parent_name
+        when 'preConditionRule'
+          error("Invalid rule action in <preConditionRule>: #{action}") unless PRE.include?(action)
+        when 'postConditionRule'
+          error("Invalid rule action in <postConditionRule>: #{action}") unless POST.include?(action)
+        when 'exitConditionRule'
+          error("Invalid rule action in <exitConditionRuel>: #{action}") unless EXIT.include?(action)
+        else
+          error("Invalid parent element for <ruleAction>: <#{parent_name}>")
+        end
+      end
+    end
+  end
+end

data/lib/scorm2004/manifest/rule_condition.rb

@@ -0,0 +1,41 @@
+module Scorm2004
+  module Manifest
+    class RuleCondition
+      include VisitorPattern
+      include CustomError
+      include Attributes
+      
+      CONDITIONS = [
+        'satisfied',
+        'objectiveStatusKnown',
+        'objectiveMeasureKnown',
+        'objectiveMeasureGreaterThan',
+        'objectiveMeasureLessThan',
+        'completed',
+        'activityProgressKnown',
+        'attempted',
+        'attemptLimitExceeded',
+        'timeLimitExceeded',
+        'outsideAvailableTimeRange',
+        'always'
+      ]
+
+      attribute :token,   'operator',            vocabulary: %w( not noOp ), default: 'noOp'
+      attribute :string,  'referencedObjective', allow_nil: true
+      attribute :decimal, 'measureThreshold',    range: -1.0..1.0, allow_nil: true
+      attribute :token,   'condition',           vocabulary: CONDITIONS
+
+      private
+
+      def do_visit
+        return unless referenced_objective
+        if '' == referenced_objective
+          error('The referencedObjective attribute cannot be an empty string.')
+        end
+        if /\s/ =~ referenced_objective
+          error('The referencedObjective attribute cannot contain any whitespace characters.')
+        end
+      end
+    end
+  end
+end

data/lib/scorm2004/manifest/rule_conditions.rb

@@ -0,0 +1,14 @@
+module Scorm2004
+  module Manifest
+    class RuleConditions
+      include VisitorPattern
+      include CustomError
+      include Children
+      include Attributes
+
+      attribute :token, 'conditionCombination', vocabulary: %w( all any ), default: 'all'
+
+      has_one_or_more 'imsss:ruleCondition'
+    end
+  end
+end

data/lib/scorm2004/manifest/schema.rb

@@ -0,0 +1,18 @@
+module Scorm2004
+  module Manifest
+    class Schema
+      include VisitorPattern
+      include CustomError
+      
+      private
+      
+      def do_visit
+        error("Invalid schema: #{el.content}") unless valid?
+      end
+
+      def valid?
+        'ADL SCORM' == el.content
+      end
+    end
+  end
+end

data/lib/scorm2004/manifest/schemaversion.rb

@@ -0,0 +1,18 @@
+module Scorm2004
+  module Manifest
+    class Schemaversion
+      include VisitorPattern
+      include CustomError
+      
+      private
+      
+      def do_visit
+        error("Invalid schemaversion: #{el.content}") unless valid?
+      end
+
+      def valid?
+        '2004 4th Edition' == el.content
+      end
+    end
+  end
+end

data/lib/scorm2004/manifest/sequencing.rb

@@ -0,0 +1,24 @@
+module Scorm2004
+  module Manifest
+    class Sequencing
+      include VisitorPattern
+      include CustomError
+      include Children
+      include Attributes
+      
+      attribute :id,    'ID',    allow_nil: true
+      attribute :idref, 'IDRef', allow_nil: true
+
+      has_zero_or_one 'imsss:controlMode'
+      has_zero_or_one 'imsss:sequencingRules'
+      has_zero_or_one 'imsss:limitConditions'
+      has_zero_or_one 'imsss:rollupRules'
+      has_zero_or_one 'imsss:objectives'
+      has_zero_or_one 'imsss:randomizationControls'
+      has_zero_or_one 'imsss:deliveryControls'
+      has_zero_or_one 'adlseq:constrainedChoiceConsiderations'
+      has_zero_or_one 'adlseq:rollupConsiderations'
+      has_zero_or_one 'adlseq:objectives', name: 'adlseq_objectives', visitor: :adlseq_objectives
+    end
+  end
+end

data/lib/scorm2004/manifest/sequencing_collection.rb

@@ -0,0 +1,11 @@
+module Scorm2004
+  module Manifest
+    class SequencingCollection
+      include VisitorPattern
+      include CustomError
+      include Children
+
+      has_one_or_more 'imsss:sequencing'
+    end
+  end
+end

data/lib/scorm2004/manifest/sequencing_rules.rb

@@ -0,0 +1,13 @@
+module Scorm2004
+  module Manifest
+    class SequencingRules
+      include VisitorPattern
+      include CustomError
+      include Children
+
+      has_zero_or_more 'imsss:preConditionRule',  visitor: :condition_rule
+      has_zero_or_more 'imsss:postConditionRule', visitor: :condition_rule
+      has_zero_or_more 'imsss:exitConditionRule', visitor: :condition_rule
+    end
+  end
+end

data/lib/scorm2004/manifest/text_node.rb

@@ -0,0 +1,11 @@
+module Scorm2004
+  module Manifest
+    module TextNode
+      def content
+        el.content
+      end
+      alias :to_s :content
+      alias :to_str :content
+    end
+  end
+end