scorm2004-manifest 0.2.0 → 1.0.0

data/VERSION

@@ -1 +1 @@
-0.2.0
+1.0.0

data/lib/scorm2004/manifest.rb

@@ -54,6 +54,18 @@ require 'scorm2004/manifest/adlseq_objective'
 require 'scorm2004/manifest/adlseq_map_info'
 
 module Scorm2004
+  # @overload Manifest(manifest_file)
+  #   Parse and validate a manifest file.
+  #   Convenience method for Scorm2004::Manifest.parse
+  #   @param [String, IO] manifest_file manifest_file may be a String,
+  #     or any object that responds to read and close such as an IO,
+  #     or StringIO.
+  #   @return [Scorm2004::Manifest::Manifest]
+  #   @example Parse and validate a manifest file
+  #     manifest = Scorm2004::Manifest(open('imsmanifest.xml'))
+  #   @raise This method raises an instance of Scorm2004::Manifest::Error's
+  #     subclass if validation fails.
+  #   @see Scorm2004::Manifest.parse
   def self.Manifest(*args)
     Scorm2004::Manifest.parse(*args)
   end
@@ -67,6 +79,15 @@ module Scorm2004
       'imsss'  => "http://www.imsglobal.org/xsd/imsss"
     }
 
+    # @overload parse(manifest_file)
+    #   Parse and validate a manifest file
+    #   @param [String, IO] manifest_file manifest_file may be a String,
+    #     or any object that responds to read and close such as an IO,
+    #     or StringIO.
+    #   @raise This method raises an instance of Scorm2004::Manifest::Error's
+    #     subclass if validation fails.
+    #   @return [Scorm2004::Manifest::Manifest]
+    #   @see Scorm2004.Manifest
     def self.parse(*args)
       manifest_visitor = Scorm2004::Manifest::Manifest.new
       Nokogiri::XML(*args) { |config| config.strict.noent }.root.accept manifest_visitor

data/lib/scorm2004/manifest/adlseq_map_info.rb

@@ -4,10 +4,12 @@ module Scorm2004
       include VisitorPattern
       include Attributes
 
+      # @attribute [r] target_objective_id
+      # @return [String] The +targetObjectiveID+ attribute of <adlseq:mapInfo>
       attribute :any_uri, 'targetObjectiveID'
 
-      SLOTS = %w( RawScore MinScore MaxScore CompletionStatus ProgressMeasure )
-      %w( read write ).product(SLOTS).map(&:join).each do |attr|
+      elements = %w( RawScore MinScore MaxScore CompletionStatus ProgressMeasure )
+      %w( read write ).product(elements).map(&:join).each do |attr|
         default_value = /^read/ =~ attr ? true : false
         attribute :boolean, attr, default: default_value
       end

data/lib/scorm2004/manifest/adlseq_objective.rb

@@ -5,8 +5,12 @@ module Scorm2004
       include Children
       include Attributes
 
+      # @attribute [r] objective_id
+      # @return [String] The +objectiveID+ attribute of <adlseq:Objective>
       attribute :any_uri, 'objectiveID'
 
+      # @attribute [r] adlseq_map_infos
+      # @return [Array<AdlseqMapInfo>] <adlseq:mapInfo>
       has_one_or_more 'adlseq:mapInfo', visitor: :adlseq_map_info
     end
   end

data/lib/scorm2004/manifest/adlseq_objectives.rb

@@ -4,6 +4,8 @@ module Scorm2004
       include VisitorPattern
       include Children
 
+      # @attribute [r] adlseq_objectives
+      # @return [Array<AdlseqObjective>] <adlseq:objective>
       has_one_or_more 'adlseq:objective', visitor: :adlseq_objective
     end
   end

data/lib/scorm2004/manifest/completion_threshold.rb

@@ -4,8 +4,16 @@ module Scorm2004
       include VisitorPattern
       include Attributes
       
+      # @attribute [r] completed_by_measure
+      # @return [Boolean] The +completedByMeasure+ attribute of <completionThreshold>
       attribute :boolean, 'completedByMeasure', default: false
+
+      # @attribute [r] min_progress_measure
+      # @return [Float] The +minProgressMeasure+ attribute of <completionThreshold>
       attribute :decimal, 'minProgressMeasure', default: 1.0, range: 0.0..1.0
+
+      # @attribute [r] progress_weight
+      # @return [Float] The +progressWeight+ attribute of <completionThreshold>
       attribute :decimal, 'progressWeight',     default: 1.0, range: 0.0..1.0
     end
   end

data/lib/scorm2004/manifest/condition_rule.rb

@@ -4,7 +4,12 @@ module Scorm2004
       include VisitorPattern
       include Children
 
+      # @attribute [r] rule_conditions
+      # @return [RuleConditions] <imsss:ruleConditions>
       has_one_and_only_one 'imsss:ruleConditions'
+
+      # @attribute [r] rule_action
+      # @return [RuleAction] <imsss:ruleAction>
       has_one_and_only_one 'imsss:ruleAction'
     end
   end

data/lib/scorm2004/manifest/constrained_choice_considerations.rb

@@ -4,7 +4,12 @@ module Scorm2004
       include VisitorPattern
       include Attributes
 
+      # @attribute [r] prevent_activation
+      # @return [Boolean] The +preventActivation+ attribute of <constrainedChoiceConsideration>
       attribute :boolean, 'preventActivation', default: false
+
+      # @attribute [r] constrain_choice
+      # @return [Boolean] The +constrainChoice+ attribute of <constrainedChoiceConsideration>
       attribute :boolean, 'constrainChoice',   default: false
     end
   end

data/lib/scorm2004/manifest/control_mode.rb

@@ -4,11 +4,28 @@ module Scorm2004
       include VisitorPattern
       include Attributes
 
+      # @attribute [r] choice
+      # @return [Boolean] The +choice+ attribute of <controlMode>
       attribute :boolean, 'choice',                         default: true
+
+      # @attribute [r] choice_exit
+      # @return [Boolean] The +choiceExit+ attribute of <controlMode>
       attribute :boolean, 'choiceExit',                     default: true
+
+      # @attribute [r] flow
+      # @return [Boolean] The +flow+ attribute of <controlMode>
       attribute :boolean, 'flow',                           default: false
+
+      # @attribute [r] forward_only
+      # @return [Boolean] The +forwardOnly+ attribute of <controlMode>
       attribute :boolean, 'forwardOnly',                    default: false
+
+      # @attribute [r] use_current_attempt_objective_info
+      # @return [Boolean] The +useCurrentAttemptObjectiveInfo+ attribute of <controlMode>
       attribute :boolean, 'useCurrentAttemptObjectiveInfo', default: true
+
+      # @attribute [r] use_current_attempt_progress_info
+      # @return [Boolean] The +useCurrentAttemptProgressInfo+ attribute of <controlMode>
       attribute :boolean, 'useCurrentAttemptProgressInfo',  default: true
     end
   end

data/lib/scorm2004/manifest/data.rb

@@ -4,6 +4,8 @@ module Scorm2004
       include VisitorPattern
       include Children
 
+      # @attribute [r] maps
+      # @return [Array<Map>] <adlcp:map>
       has_one_or_more 'adlcp:map'
     end
   end

data/lib/scorm2004/manifest/data_from_lms.rb

@@ -4,15 +4,13 @@ module Scorm2004
       include VisitorPattern
       include TextNode
 
-      def self.spm
-        4000
-      end
+      SPM = 4000
 
       private
       
       def do_visit
-        if content.length > self.class.spm
-          error("<adlcp:dataFromLMS> exceeds the SPM of #{self.class.spm}: #{content}")
+        if content.length > SPM
+          error("<adlcp:dataFromLMS> exceeds the SPM of #{SPM}: #{content}")
         end
       end
     end

data/lib/scorm2004/manifest/delivery_controls.rb

@@ -4,8 +4,16 @@ module Scorm2004
       include VisitorPattern
       include Attributes
       
+      # @attribute [r] tracked
+      # @return [Boolean] The +tracked+ attribute of <deliveryControls>
       attribute :boolean, 'tracked',                default: true
+
+      # @attribute [r] completion_set_by_content
+      # @return [Boolean] The +completion_set_by_content+ attribute of <deliveryControls>
       attribute :boolean, 'completionSetByContent', default: false
+
+      # @attribute [r] objective_set_by_content
+      # @return [Boolean] The +objective_set_by_content+ attribute of <deliveryControls>
       attribute :boolean, 'objectiveSetByContent',  default: false
     end
   end

data/lib/scorm2004/manifest/dependency.rb

@@ -4,6 +4,8 @@ module Scorm2004
       include VisitorPattern
       include Attributes
       
+      # @attribute [r] identifierref
+      # @return [String] The identifierref attribute of <dependency>
       attribute :string, 'identifierref'
 
       private

data/lib/scorm2004/manifest/hide_lmsui.rb

@@ -4,14 +4,12 @@ module Scorm2004
       include VisitorPattern
       include TextNode
       
-      def self.vocabulary
-        %w( previous continue exit exitAll abandon abandonAll suspendAll )
-      end
+      VOCABULARY = %w( previous continue exit exitAll abandon abandonAll suspendAll )
 
       private
       
       def do_visit
-        unless self.class.vocabulary.include?(content)
+        unless VOCABULARY.include?(content)
           error("Invalid <adlnav:hideLMSUI> token: #{content}")
         end
       end

data/lib/scorm2004/manifest/href.rb

@@ -1,6 +1,7 @@
 module Scorm2004
   module Manifest
     module Href
+      # @return [String] The +href+ to which all +xml:base+ attributes have been applied
       def href
         (base ? resolve_href : relative_href).try(:to_s)
       end

data/lib/scorm2004/manifest/item.rb

@@ -5,18 +5,52 @@ module Scorm2004
       include Children
       include Attributes
       
+      # @attribute [r] identifier
+      # @return [String] The +identifier+ attribute of <item>
       attribute :id,      'identifier'
+
+      # @attribute [r] identifierref
+      # @return [String] The +identifierref+ attribute of <item>
       attribute :string,  'identifierref', allow_nil: true
+
+      # @attribute [r] isvisible
+      # @return [Boolean] The +isvisible+ attribute of <item>
       attribute :boolean, 'isvisible',     default: true
+
+      # @attribute [r] parameters
+      # @return [String] The +parameters+ attribute of <item>
       attribute :string,  'parameters',    allow_nil: true
 
+      # @attribute [r] title
+      # @return [Title] <title>
       has_one_and_only_one 'imscp:title'
+
+      # @attribute [r] item
+      # @return [Array<Item>] <item>
       has_zero_or_more     'imscp:item'
+
+      # @attribute [r] time_limit_action
+      # @return [TimeLimitAction, nil] <adlcp:timeLimitAction>
       has_zero_or_one      'adlcp:timeLimitAction'
+
+      # @attribute [r] data_from_lms
+      # @return [DataFromLms, nil] <adlcp:dataFromLMS>
       has_zero_or_one      'adlcp:dataFromLMS'
+
+      # @attribute [r] completion_threshold
+      # @return [CompletionThreshold, nil] <adlcp:completionThreshold>
       has_zero_or_one      'adlcp:completionThreshold'
+
+      # @attribute [r] sequencing
+      # @return [Sequencing, nil] <imsss:sequencing>
       has_zero_or_one      'imsss:sequencing'
+
+      # @attribute [r] presentation
+      # @return [Presentation, nil] <adlnav:presentation>
       has_zero_or_one      'adlnav:presentation'
+
+      # @attribute [r] data
+      # @return [Data, nil] <adlcp:data>
       has_zero_or_one      'adlcp:data'
 
       private

data/lib/scorm2004/manifest/limit_conditions.rb

@@ -4,7 +4,12 @@ module Scorm2004
       include VisitorPattern
       include Attributes
       
+      # @attribute [r] attempt_limit
+      # @return [Fixnum] The +attemptLimit+ attribute of <limitConditions>
       attribute :non_negative_integer, 'attemptLimit',                 allow_nil: true
+
+      # @attribute [r] attempt_absolute_duration_limit
+      # @return [String] The +attemptAbsoluteDurationLimit+ attribute of <limitConditions>
       attribute :duration,             'attemptAbsoluteDurationLimit', allow_nil: true
     end
   end

data/lib/scorm2004/manifest/manifest.rb

@@ -10,11 +10,25 @@ module Scorm2004
 
       has_one_and_only_one './imscp:metadata/imscp:schema'
       has_one_and_only_one './imscp:metadata/imscp:schemaversion'
+
+      # @attribute [r] resources
+      # @return [Resources] <resources>
       has_one_and_only_one 'imscp:resources'
+
+      # @attribute [r] organizations
+      # @return [Organizations] <organizations>
       has_one_and_only_one 'imscp:organizations'
+
+      # @attribute [r] sequencing_collection
+      # @return [SequencingCollection, nil] <imsss:sequencingCollection>
       has_zero_or_one      'imsss:sequencingCollection'
 
+      # @attribute [r] identifier
+      # @return [String] The identifier attribute of <manifest>
       attribute :id,     'identifier'
+
+      # @attribute [r] version
+      # @return [String] The version attribute of <manifest>
       attribute :string, 'version', spm: VERSION_SPM
     end
   end

data/lib/scorm2004/manifest/map.rb

@@ -4,8 +4,16 @@ module Scorm2004
       include VisitorPattern
       include Attributes
       
+      # @attribute [r] target_id
+      # @return [String] The +targetID+ attribute of <map>
       attribute :any_uri, 'targetID'
+
+      # @attribute [r] read_shared_data
+      # @return [Boolean] The +readSharedData+ attribute of <map>
       attribute :boolean, 'readSharedData',  default: true
+
+      # @attribute [r] write_shared_data
+      # @return [Boolean] The +writeSharedData+ attribute of <map>
       attribute :boolean, 'writeSharedData', default: true
     end
   end

data/lib/scorm2004/manifest/map_info.rb

@@ -4,10 +4,24 @@ module Scorm2004
       include VisitorPattern
       include Attributes
       
+      # @attribute [r] target_objective_id
+      # @return [String] The +targetObjectiveID+ attribute of <mapinfo>
       attribute :any_uri, 'targetObjectiveID'
+
+      # @attribute [r] read_satisfied_status
+      # @return [Boolean] The +readSatisfiedStatus+ attribute of <mapInfo>
       attribute :boolean, 'readSatisfiedStatus', default: true
+
+      # @attribute [r] read_normalized_measure
+      # @return [Boolean] The +readNormalizedMeasure+ attribute of <mapInfo>
       attribute :boolean, 'readNormalizedMeasure', default: true
+
+      # @attribute [r] write_satisfied_status
+      # @return [Boolean] The +writeSatisfiedStatus+ attribute of <mapInfo>
       attribute :boolean, 'writeSatisfiedStatus', default: false
+
+      # @attribute [r] write_normalized_measure
+      # @return [Boolean] The +writeNormalizedMeasure+ attribute of <mapInfo>
       attribute :boolean, 'writeNormalizedMeasure', default: false
     end
   end

data/lib/scorm2004/manifest/min_normalized_measure.rb

@@ -3,6 +3,7 @@ module Scorm2004
     class MinNormalizedMeasure
       include VisitorPattern
       
+      # @return [Float] The value of <minNormalizedMeasure>
       def to_f
         Float(@el.content)
       end

data/lib/scorm2004/manifest/navigation_interface.rb

@@ -4,6 +4,8 @@ module Scorm2004
       include VisitorPattern
       include Children
 
+      # @attribute [r] hide_lmsuis
+      # @return [Array<HideLmsui>] <adlnav:hideLMSUI>
       has_zero_or_more 'adlnav:hideLMSUI'
     end
   end

data/lib/scorm2004/manifest/objective.rb

@@ -5,10 +5,20 @@ module Scorm2004
       include Children
       include Attributes
 
+      # @attribute [r] satisfied_by_measure
+      # @return [Boolean] The +satisfiedByMeasure+ attribute of <objective>
       attribute :boolean, 'satisfiedByMeasure', default: false
+
+      # @attribute [r] objective_id
+      # @return [String] The +objectiveID+ attribute of <objective>
       attribute :any_uri, 'objectiveID'
 
+      # @attribute [r] min_normalized_measure
+      # @return [MinNormalizedMeasure, nil] <imsss:minNormalizedMeasure>
       has_zero_or_one 'imsss:minNormalizedMeasure'
+
+      # @attribute [r] map_infos
+      # @return [Array<MapInfo>] <imsss:mapInfo>
       has_zero_or_more 'imsss:mapInfo'
     end
   end

data/lib/scorm2004/manifest/objectives.rb

@@ -4,7 +4,12 @@ module Scorm2004
       include VisitorPattern
       include Children
 
+      # @attribute [r] primary_objective
+      # @return [PrimaryObjective] <imsss:primaryObjective>
       has_one_and_only_one 'imsss:primaryObjective'
+
+      # @attribute [r] objectives
+      # @return [Array<Objective>] <imsss:objective>
       has_zero_or_more 'imsss:objective'
     end
   end

data/lib/scorm2004/manifest/organization.rb

@@ -6,13 +6,32 @@ module Scorm2004
       include Attributes
       include XmlBase
 
+      # @attribute [r] items
+      # @return [Array<Item>] <item>
       has_one_or_more      'imscp:item'
+
+      # @attribute [r] title
+      # @return [Title] <title>
       has_one_and_only_one 'imscp:title'
+
+      # @attribute [r] completion_threshold
+      # @return [CompletionThreshold, nil] <adlcp:completionThrehsold>
       has_zero_or_one      'adlcp:completionThreshold'
+
+      # @attribute [r] sequencing
+      # @return [Sequencing, nil] <imsss:sequencing>
       has_zero_or_one      'imsss:sequencing'
 
+      # @attribute [r] identifier
+      # @return [String] The identifier attribute of <organization>
       attribute :id,      'identifier'
+
+      # @attribute [r] objectives_global_to_system
+      # @return [Boolean] The adlseq:objectivesGlobalToSystem attribute of <organization>
       attribute :boolean, 'adlseq:objectivesGlobalToSystem', default: false
+
+      # @attribute [r] shared_data_global_to_system
+      # @return [Boolean] The adlcp:sharedDataGlobalToSystem attribute of <organization>
       attribute :boolean, 'adlcp:sharedDataGlobalToSystem',  default: false
     end
   end

data/lib/scorm2004/manifest/organizations.rb

@@ -6,13 +6,18 @@ module Scorm2004
       include Attributes
       include XmlBase
       
+      # @attribute [r] default
+      # @return [String] The default attribute of <organizations>
       attribute :idref, 'default'
+
+      # @attribute [r] organizations
+      # @return [Array<Organization>] <organization>
       has_one_or_more 'imscp:organization'
 
       private
       
       def do_visit
-        error('Default <resource> not foulnd: ' + default) unless default_resource
+        error('Default <resource> not found: ' + default) unless default_resource
       end
 
       def default_resource

data/lib/scorm2004/manifest/presentation.rb

@@ -4,6 +4,8 @@ module Scorm2004
       include VisitorPattern
       include Children
       
+      # @attribute [r] navigation_interface
+      # @return [NavigationInterface, nil] <adlnav:navigationInterface>
       has_zero_or_one 'adlnav:navigationInterface'
     end
   end

data/lib/scorm2004/manifest/primary_objective.rb

@@ -8,7 +8,12 @@ module Scorm2004
       attribute :boolean, 'satisfiedByMeasure', default: false
       attribute :any_uri, 'objectiveID', allow_nil: true
 
+      # @attribute [r] min_normalized_measure
+      # @return [MinNormalizedMeasure, nil] <imsss:minNormalizedMeasure>
       has_zero_or_one 'imsss:minNormalizedMeasure'
+
+      # @attribute [r] map_infos
+      # @return [Array<MapInfo>] <imsss:mapInfo>
       has_zero_or_more 'imsss:mapInfo'
 
       private

data/lib/scorm2004/manifest/randomization_controls.rb

@@ -6,9 +6,20 @@ module Scorm2004
 
       TIMINGS = %w( never once onEachNewAttempt )
 
+      # @attribute [r] randomization_timing
+      # @return [String] The +randomizationTiming+ attribute of <randomizationControls>
       attribute :token, 'randomizationTiming', vocabulary: TIMINGS, default: 'never'
+
+      # @attribute [r] select_count
+      # @return [Fixnum] The +selectCount+ attribute of <randomizationControls>
       attribute :non_negative_integer, 'selectCount', allow_nil: true
+
+      # @attribute [r] reorder_children
+      # @return [Boolean] The +reorderChildren+ attribute of <randomizationControls>
       attribute :boolean, 'reorderChildren', default: false
+
+      # @attribute [r] selection_timing
+      # @return [String] The +selectionTiming+ attribute of <randomizationControls>
       attribute :token, 'selectionTiming', vocabulary: TIMINGS, default: 'never'
     end
   end

data/lib/scorm2004/manifest/resource.rb

@@ -7,10 +7,20 @@ module Scorm2004
       include XmlBase
       include Href
       
+      # @attribute [r] identifier
+      # @return [String] The identifier attribute of <resource>
       attribute :id, 'identifier'
+
+      # @attribute [r] scorm_type
+      # @return [String] The adlcp:scormType attribute of <resource>, +sco+ or +asset+
       attribute :token, 'adlcp:scormType', vocabulary: %w( sco asset )
 
+      # @attribute [r] files
+      # @return [Array<File>] <file>
       has_zero_or_more 'imscp:file'
+
+      # @attribute [r] dependencies
+      # @return [Array<Dependency>] <dependency>
       has_zero_or_more 'imscp:dependency'
     end
   end

data/lib/scorm2004/manifest/resources.rb

@@ -5,6 +5,8 @@ module Scorm2004
       include Children
       include XmlBase
       
+      # @attribute [r] resources
+      # @return [Array<Resource>] <resource>
       has_zero_or_more 'imscp:resource'
     end
   end

data/lib/scorm2004/manifest/rollup_action.rb

@@ -6,6 +6,8 @@ module Scorm2004
 
       ACTIONS = %w( satisfied notSatisfied completed incomplete )
 
+      # @attribute [r] action
+      # @return [String] The +action+ attribute of <rollupAction>
       attribute :token, 'action', vocabulary: ACTIONS
     end
   end

data/lib/scorm2004/manifest/rollup_condition.rb

@@ -16,7 +16,12 @@ module Scorm2004
         'outsideAvailableTimeRange'
       ]
 
+      # @attribute [r] operator
+      # @return [String] The +operator+ attribute of <rollupCondition>
       attribute :token, 'operator', vocabulary: %w( not noOp ), default: 'noOp'
+
+      # @attribute [r] condition
+      # @return [String] The +condition+ attribute of <rollupCondition>
       attribute :token, 'condition', vocabulary: CONDITIONS
     end
   end

data/lib/scorm2004/manifest/rollup_conditions.rb

@@ -5,8 +5,12 @@ module Scorm2004
       include Children
       include Attributes
 
+      # @attribute [r] condition_combination
+      # @return [String] The +conditionCombination+ attribute of <rollupConditions>
       attribute :token, 'conditionCombination', vocabulary: %w( any all ), default: 'any'
 
+      # @attribute [r] rollup_conditions
+      # @return [Array<RollupCondition>] <imsss:rollupCondition>
       has_one_or_more 'imsss:rollupCondition'
     end
   end

data/lib/scorm2004/manifest/rollup_considerations.rb

@@ -5,11 +5,19 @@ module Scorm2004
       include Attributes
       
       CONDITIONS = %w( always ifAttempted ifNotSkipped ifNotSuspended )
+      ATTRIBUTES = [
+        'requiredForSatisfied',
+        'requireForNotSatisfied',
+        'requiredForCompleted',
+        'requireForIncomplete'
+      ]
 
-      %w( requiredForSatisfied requireForNotSatisfied requiredForCompleted requireForIncomplete ).each do |attr|
+      ATTRIBUTES.each do |attr|
         attribute :token, attr, vocabulary: CONDITIONS, default: CONDITIONS.first
       end
       
+      # @attribute [r] measure_satisfaction_if_active
+      # @return [Boolean] The +measureSatisfactionIfActive+ attribute of <rollupConsideration>
       attribute :boolean, 'measureSatisfactionIfActive', default: true
     end
   end

data/lib/scorm2004/manifest/rollup_rule.rb

@@ -7,11 +7,24 @@ module Scorm2004
 
       CONDITIONS = %w( all any none atLeastCount atLeastPercent )
 
+      # @attribute [r] child_activity_set
+      # @return [String] The +childActivitySet+ of <rollupRule>
       attribute :token, 'childActivitySet', vocabulary: CONDITIONS, default: CONDITIONS.first
+
+      # @attribute [r] minimum_count
+      # @return [Fixnum] The +minimumCount+ attribute of <rollupRule>
       attribute :non_negative_integer, 'minimumCount', default: 0
+
+      # @attribute [r] minimum_percent
+      # @return [Float] The +minimumPercent+ attribute  of <rollupRule>
       attribute :decimal, 'minimumPercent', range: 0.0..1.0, default: 0.0
 
+      # @attribute [r] rollup_conditions
+      # @return [RollupConditions] <imsss:rollupConditions>
       has_one_and_only_one 'imsss:rollupConditions'
+
+      # @attribute [r] rollup_action
+      # @return [RollupAction] <imsss:rollupAction>
       has_one_and_only_one 'imsss:rollupAction'
     end
   end

data/lib/scorm2004/manifest/rollup_rules.rb

@@ -5,10 +5,20 @@ module Scorm2004
       include Children
       include Attributes
 
+      # @attribute [r] rollup_objective_satisfied
+      # @return [Boolean] The +rollupObjectiveSatisfied+ attribute of <rollupRules>
       attribute :boolean, 'rollupObjectiveSatisfied', default: true
+
+      # @attribute [r] rollup_progress_completion
+      # @return [Boolean] The +rollupProgressCompletion+ attribute of <rollupRules>
       attribute :boolean, 'rollupProgressCompletion', default: true
+
+      # @attribute [r] objective_measure_weight
+      # @return [Float] The +objectiveMeasureWeight+ attribute of <rollupRules>
       attribute :decimal, 'objectiveMeasureWeight', range: 0.0..1.0, default: 1.0
 
+      # @attribute [r] rollup_rules
+      # @return [Array<RollupRule>] <imsss:rollupRule>
       has_zero_or_more 'imsss:rollupRule'
     end
   end

data/lib/scorm2004/manifest/rule_action.rb

@@ -8,6 +8,8 @@ module Scorm2004
       POST = %w( exitParent exitAll retry retryAll continue previous )
       EXIT = %w( exit )
 
+      # @attribute [r] action
+      # @return [String] The +action+ attribute of <ruleAction>
       attribute :token, 'action', vocabulary: PRE + POST + EXIT
 
       private

data/lib/scorm2004/manifest/rule_condition.rb

@@ -19,9 +19,20 @@ module Scorm2004
         'always'
       ]
 
+      # @attribute [r] operator
+      # @return [String] The +operator+ attribute of <ruleCondition>
       attribute :token,   'operator',            vocabulary: %w( not noOp ), default: 'noOp'
+
+      # @attribute [r] referenced_objective
+      # @return [String] The +referencedObjective+ attribute of <ruleCondition>
       attribute :string,  'referencedObjective', allow_nil: true
+
+      # @attribute [r] measure_threshold
+      # @return [Float] The +measureThreshold+ attribute of <ruleCondition>
       attribute :decimal, 'measureThreshold',    range: -1.0..1.0, allow_nil: true
+
+      # @attribute [r] condition
+      # @return [String] The +condition+ attribute of <ruleCondition>
       attribute :token,   'condition',           vocabulary: CONDITIONS
 
       private

data/lib/scorm2004/manifest/rule_conditions.rb

@@ -5,8 +5,12 @@ module Scorm2004
       include Children
       include Attributes
 
+      # @attribute [r] condition_combination
+      # @return [String] The +conditionCombination+ attribute of <ruleConditions>
       attribute :token, 'conditionCombination', vocabulary: %w( all any ), default: 'all'
 
+      # @attribute [r] rule_conditions
+      # @return [Array<RuleCondition>] <imsss:ruleCondition>
       has_one_or_more 'imsss:ruleCondition'
     end
   end

data/lib/scorm2004/manifest/sequencing.rb

@@ -5,18 +5,52 @@ module Scorm2004
       include Children
       include Attributes
       
+      # @attribute [r] id
+      # @return [String] The +ID+ attribute of <sequencing>
       attribute :id,    'ID',    allow_nil: true
+
+      # @attribute [r] idref
+      # @return [String] The +IDRef+ attribute of <sequencing>
       attribute :idref, 'IDRef', allow_nil: true
 
+      # @attribute [r] control_mode
+      # @return [ControlMode, nil] <imsss:controlMode>
       has_zero_or_one 'imsss:controlMode'
+
+      # @attribute [r] sequencing_rules
+      # @return [SequencingRules, nil] <imsss:sequencingRules>
       has_zero_or_one 'imsss:sequencingRules'
+
+      # @attribute [r] limit_conditions
+      # @return [LimitConditions, nil] <imsss:limitConditions>
       has_zero_or_one 'imsss:limitConditions'
+
+      # @attribute [r] rollup_rules
+      # @return [RollupRules, nil] <imsss:rollupRules>
       has_zero_or_one 'imsss:rollupRules'
+
+      # @attribute [r] objectives
+      # @return [Objectives, nil] <imsss:objectives>
       has_zero_or_one 'imsss:objectives'
+
+      # @attribute [r] randomization_controls
+      # @return [RandomizationControls, nil] <imsss:randomizationControls>
       has_zero_or_one 'imsss:randomizationControls'
+
+      # @attribute [r] delivery_controls
+      # @return [DeliveryControls, nil] <imsss:deliveryControls>
       has_zero_or_one 'imsss:deliveryControls'
+
+      # @attribute [r] constrained_choice_considerations
+      # @return [ConstrainedChoiceConsiderations, nil] <imsss:constrainedChoiceConsiderations>
       has_zero_or_one 'adlseq:constrainedChoiceConsiderations'
+
+      # @attribute [r] rollup_considerations
+      # @return [RollupConsiderations, nil] <adlseq:rollupConsiderations>
       has_zero_or_one 'adlseq:rollupConsiderations'
+
+      # @attribute [r] adlseq_objectives
+      # @return [AdlseqObjectives, nil] <adlseq:objectives>
       has_zero_or_one 'adlseq:objectives', name: 'adlseq_objectives', visitor: :adlseq_objectives
     end
   end

data/lib/scorm2004/manifest/sequencing_collection.rb

@@ -4,6 +4,8 @@ module Scorm2004
       include VisitorPattern
       include Children
 
+      # @attribute sequencings
+      # @return [Array<Sequencing>] <imsss:sequencing>
       has_one_or_more 'imsss:sequencing'
     end
   end

data/lib/scorm2004/manifest/sequencing_rules.rb

@@ -4,8 +4,16 @@ module Scorm2004
       include VisitorPattern
       include Children
 
+      # @attribute pre_condition_rules
+      # @return [Array<ConditionRule>] <imsss:preConditionRule>
       has_zero_or_more 'imsss:preConditionRule',  visitor: :condition_rule
+
+      # @attribute post_condition_rule
+      # @return [Array<ConditionRule>] <imsss:postConditionRule>
       has_zero_or_more 'imsss:postConditionRule', visitor: :condition_rule
+
+      # @attribute exit_condition_rule
+      # @return [Array<ConditionRule>] <imsss:exitConditionRule>
       has_zero_or_more 'imsss:exitConditionRule', visitor: :condition_rule
     end
   end

data/lib/scorm2004/manifest/time_limit_action.rb

@@ -4,17 +4,17 @@ module Scorm2004
       include VisitorPattern
       include TextNode
       
-      def self.vocabulary
-        [ 'exit, message',
-          'exit,no message',
-          'continue, message',
-          'continue,no message' ]
-      end
+      VOCABULARY = [
+        'exit, message',
+        'exit,no message',
+        'continue, message',
+        'continue,no message'
+      ]
 
       private
       
       def do_visit
-        unless self.class.vocabulary.include?(content)
+        unless VOCABULARY.include?(content)
           error("Invalid <adlcp:timeLimitAction> token: #{content}") 
         end
       end

data/test/scorm2004/manifest/data_from_lms_test.rb

@@ -37,7 +37,7 @@ module Scorm2004
         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)
+              el('<dummy>' + 'x' * (DataFromLms::SPM + 1) + '</dummy>').accept(@v)
             end
           end
         end

data/test/scorm2004/manifest/hide_lmsui_test.rb

@@ -9,7 +9,7 @@ module Scorm2004
         @v = HideLmsui.new
       end
       
-      HideLmsui.vocabulary.each do |token|
+      HideLmsui::VOCABULARY.each do |token|
         tag ="<adlnav:hideLMSUI>#{token}</adlnav:hideLMSUI>" 
         test tag do
           el(tag).accept(@v)

data/test/scorm2004/manifest/time_limit_action_test.rb

@@ -19,7 +19,7 @@ module Scorm2004
         end
       end
 
-      TimeLimitAction.vocabulary.each do |token|
+      TimeLimitAction::VOCABULARY.each do |token|
         test "<adlcp:timeLimitAction>#{token}</adlcp:timieLimitAction>" do
           assert_nothing_raised do
             el("<dummy>#{token}</dummy").accept(@v)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scorm2004-manifest
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-17 00:00:00.000000000 Z
+date: 2012-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2159964920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2159964920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2159963820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2159963820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda-context
-  requirement: &2159963000 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *2159963000
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2159985660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +69,15 @@ dependencies:
         version: 0.10.4
   type: :development
   prerelease: false
-  version_requirements: *2159985660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.4
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2159985180 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +85,15 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *2159985180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2159984700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +101,15 @@ dependencies:
         version: 1.1.0
   type: :development
   prerelease: false
-  version_requirements: *2159984700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2159984060 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,7 +117,12 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *2159984060
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
 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
@@ -242,7 +277,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3400129364290875966
+      hash: -157757132896305828
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -251,7 +286,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.20
 signing_key: 
 specification_version: 3
 summary: A manifest file parser/validator for SCORM 2004 4th Edition