scorm2004-manifest 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem "nokogiri"
+gem "activesupport"
+
+group :development do
+  gem "shoulda-context", "~> 1.0"
+  gem "mocha", "~> 0.10.4"
+  gem "yard", "~> 0.7"
+  gem "bundler", '~> 1.1.0'
+  gem "jeweler", "~> 1.8.3"
+end

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.2)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    git (1.2.5)
+    i18n (0.6.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.5)
+    metaclass (0.0.1)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
+    multi_json (1.1.0)
+    nokogiri (1.5.2)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    shoulda-context (1.0.0)
+    yard (0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bundler (~> 1.1.0)
+  jeweler (~> 1.8.3)
+  mocha (~> 0.10.4)
+  nokogiri
+  shoulda-context (~> 1.0)
+  yard (~> 0.7)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Takahiro Noda
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,94 @@
+= scorm2004-manifest
+
+* https://github.com/tnoda/scorm2004-manifest
+
+== 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.
+
+== Installation
+
+To install scorm2004-manifest, use the following command:
+
+   $ gem install scorm2004-manifest
+
+== Requirements
+
+* ruby 1.9.3
+* nokogiri
+* activesupport
+
+
+== Synopsis
+
+  require 'scorm2004-manifest'
+
+  # Parse a manifest file
+  manifest = Scorm2004::Manifest(open('imsmanifest.xml'))
+
+  # Traverse an object tree
+  manifest.identifier        # => "LMSTestPackage_CM-01"
+  manifest.version           # => "1.1.1"
+  organizations = manifest.organizations
+  organization = organizations.organizations[0]
+  organization.identifier    # => "CM-01"
+  organization.title.content # => "LMS Test Content Package CM-01 "
+  item_0 = organization.items[0]
+  item_0.title.content       # => "Activity 1"
+  item_0.identifier          # => "activity_1"
+  item_0.identifierref       # => "SEQ01"
+  item_0.parameters          # => "?tc=CM-01&act=1"
+  item_0.sequencing.limit_conditions.attempt_absolute_duration_limit
+  # => "P5Y6M4DT12H30M58S"
+  item_0.presentation.navigation_interface.hide_lmsuis.map(&:content)
+  # => ["continue", "previous", "suspendAll"]
+  # ...
+
+For every XML element in a manifest file, XML attributes and
+child elements defined in Content Aggregation Model can be
+accessed using accessor methods whose names are underscored.
+Namespace prefixes are omitted from the accessor methods,
+except for either +adlseq_objectives+, +adlseq_objective+,
+or +adlseq_map_info+.
+If an element may have multiple child elements,
+the accessor method for the child elements will be pluralized.
+For example, <organizations> element has one or more
+<organization> elements.
+
+  # <organizations> can be accessed using the organizations
+  # method of the manifest object.
+  organizations = manifest.organizations
+
+  # The <organization> collection of the <organizations>
+  # element can be accessed using the organizations method
+  # of the organizations object. To get the first
+  # <organization> of the <organizations>, use the
+  # following expression.
+  organization_0 = organizations.organizations[0]
+
+
+== Documentation
+
+To generate scorm2004-manifest's document set, use the following command:
+
+    $ git clone git://github.com/tnoda/scorm2004-manifest.git
+    $ cd scorm2004-manifest
+    $ rake yard
+
+The document set will be generated under the +doc+ directory.
+
+
+== Contributing to scorm2004-manifest
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+
+== Copyright
+
+Copyright (c) 2012 Takahiro Noda. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "scorm2004-manifest"
+  gem.homepage = "https://github.com/tnoda/scorm2004-manifest"
+  gem.license = "MIT"
+  gem.summary = %Q{A manifest file parser/validator for SCORM 2004 4th Edition}
+  gem.description = <<EOS
+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.
+EOS
+  gem.email = "takahiro.noda+rubygems@gmail.com"
+  gem.authors = ["Takahiro Noda"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/scorm2004/manifest/adlseq_map_info.rb

@@ -0,0 +1,17 @@
+module Scorm2004
+  module Manifest
+    class AdlseqMapInfo
+      include VisitorPattern
+      include CustomError
+      include Attributes
+
+      attribute :any_uri, 'targetObjectiveID'
+
+      SLOTS = %w( RawScore MinScore MaxScore CompletionStatus ProgressMeasure )
+      %w( read write ).product(SLOTS).map(&:join).each do |attr|
+        default_value = /^read/ =~ attr ? true : false
+        attribute :boolean, attr, default: default_value
+      end
+    end
+  end
+end

data/lib/scorm2004/manifest/adlseq_objective.rb

@@ -0,0 +1,14 @@
+module Scorm2004
+  module Manifest
+    class AdlseqObjective
+      include VisitorPattern
+      include CustomError
+      include Children
+      include Attributes
+
+      attribute :any_uri, 'objectiveID'
+
+      has_one_or_more 'adlseq:mapInfo', visitor: :adlseq_map_info
+    end
+  end
+end

data/lib/scorm2004/manifest/adlseq_objectives.rb

@@ -0,0 +1,11 @@
+module Scorm2004
+  module Manifest
+    class AdlseqObjectives
+      include VisitorPattern
+      include CustomError
+      include Children
+
+      has_one_or_more 'adlseq:objective', visitor: :adlseq_objective
+    end
+  end
+end

data/lib/scorm2004/manifest/attributes.rb

@@ -0,0 +1,147 @@
+module Scorm2004
+  module Manifest
+    module Attributes
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      private
+      
+      def replace_and_collapse_whitespaces(string)
+        string.gsub(/\s+/, ' ').gsub(/^ | $/, '')
+      end
+
+      def xs_id?(str)
+        (/\s|^\d+$/ =~ str).nil?
+      end
+
+      def xs_non_negative_integer?(string)
+        /^\+?\d+$/ =~ string
+      end
+
+      def xs_duration?(string)
+        /^(\+|-)?P(((\d+Y)?(\d+M)?(\d+D)?(T(\d+H)?(\d+M)?(\d+(\.\d+)?S)?)?)|(\d+W))$/ =~ string
+      end
+      
+      module ClassMethods
+        def attributes
+          @attributes ||= []
+        end
+
+        def attribute(type, name, options = {})
+          base = basename(name)
+          attributes << base
+          define_method("raw_#{base}") do
+            el.at("./@#{name}").try(:content) || options[:default].try(:to_s)
+          end
+          send("#{type}_attribute", name, options)
+          attr_reader base
+        end
+
+        def boolean_attribute(name, options)
+          base = basename(name)
+          define_method("check_#{base}".intern) do
+            raw = send("raw_#{base}")
+            error("No #{name} attribute.") if raw.nil?
+            unless %( true false 1 0 ).include?(raw)
+              error("Non xs:boolean value for the #{name}: #{raw}")
+            end
+            instance_variable_set("@#{base}".intern, %( true 1 ).include?(raw))
+          end
+        end
+
+        def string_attribute(name, options)
+          base = basename(name)
+          define_method("check_#{base}".intern) do
+            raw = send("raw_#{base}")
+            error("No #{name} attribute.") unless options[:allow_nil] || raw
+            if options[:spm] && raw.length > options[:spm]
+              error("The length of #{name} exceeds the SPM of #{options[:spm]} characters.")
+            end
+            instance_variable_set("@#{base}".intern, raw)
+          end
+        end
+
+        def id_attribute(name, options)
+          base = basename(name)
+          define_method("check_#{base}".intern) do
+            raw = send("raw_#{base}")
+            error("No #{name} attribute.") unless options[:allow_nil] || raw
+            error("Non xs:ID value for the #{name} attribute: #{raw}") unless xs_id?(raw)
+            instance_variable_set("@#{base}".intern, raw)
+          end
+        end
+        alias :idref_attribute :id_attribute
+
+        def decimal_attribute(name, options)
+          base = basename(name)
+          define_method("check_#{base}".intern) do
+            raw = send("raw_#{base}".intern)
+            return if options[:allow_nil] && raw.nil?
+            error("No #{name} attribute.") if raw.nil?
+            if options[:range] && !options[:range].include?(Float(raw))
+              error("The decimal attribute, #{name}, out of range (#{options[:range]}): #{raw}")
+            end
+            instance_variable_set("@#{base}".intern, Float(raw))
+          end
+        end
+
+        def non_negative_integer_attribute(name, options)
+          base = basename(name)
+          define_method("check_#{base}".intern) do
+            raw = send("raw_#{base}".intern)
+            return if options[:allow_nil] && raw.nil?
+            error("No #{name} attribute.") if raw.nil?
+            unless xs_non_negative_integer?(raw)
+              error("Non xs:nonNegativeInteger value for #{name}: #{raw}")
+            end
+            instance_variable_set("@#{base}".intern, Integer(raw, 10))
+          end
+        end
+
+        def duration_attribute(name, options)
+          base = basename(name)
+          define_method("check_#{base}".intern) do
+            raw = send("raw_#{base}".intern)
+            return if options[:allow_nil] && raw.nil?
+            error("No #{name} attribute.") if raw.nil?
+            error("Non xs:duration value for #{name}: #{raw}") unless xs_duration?(raw)
+            instance_variable_set("@#{base}".intern, raw)
+          end
+        end
+
+        def token_attribute(name, options)
+          base = basename(name)
+          define_method("check_#{base}".intern) do
+            raw = send("raw_#{base}".intern)
+            error("No #{name} attribute.") if raw.nil?
+            raw = replace_and_collapse_whitespaces(raw)
+            error("Invalid #{name}: #{raw}") unless options[:vocabulary].include?(raw)
+            instance_variable_set("@#{base}".intern, raw)
+          end
+        end
+
+        def any_uri_attribute(name, options)
+          base = basename(name)
+          define_method("check_#{base}".intern) do
+            raw = send("raw_#{base}".intern)
+            return if options[:allow_nil] && raw.nil?
+            error("No #{name} attribute.") if raw.nil?
+            begin
+              uri = URI(raw)
+            rescue URI::InvalidURIError => e
+              error(e)
+            end
+            instance_variable_set("@#{base}".intern, uri.to_s)
+          end
+        end
+
+        private
+
+        def basename(name)
+          name.split(':').last.underscore.intern
+        end
+      end
+    end
+  end
+end

data/lib/scorm2004/manifest/children.rb

@@ -0,0 +1,83 @@
+module Scorm2004
+  module Manifest
+    module Children
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+      
+      private
+
+      def at(xpath)
+        xpath = './' + xpath unless /^\.\// =~ xpath
+        el.at(xpath, NS)
+      end
+
+      def search(xpath)
+        xpath = './' + xpath unless /^\.\// =~ xpath
+        el.search(xpath, NS)
+      end
+
+      def create_visitor(name)
+        send("#{name}_visitor".intern)
+      end
+
+      module ClassMethods
+        def children
+          @children ||= []
+        end
+
+        def has_one(xpath, options = {})
+          name = options[:name].try(:to_s) || guess_child_name(xpath, options)
+          children << name.intern
+          attr_reader name.intern
+          visitor_name = options[:visitor].try(:to_s) || name
+          define_method("visit_#{name}".intern) do
+            error("Two <#{xpath}> elements found.") if search(xpath).size > 1
+            error("<#{xpath}> not found.") unless options[:allow_nil] || at(xpath)
+            if at(xpath)
+              instance_variable_set("@#{name}".intern, at(xpath).accept(create_visitor(visitor_name)))
+            end
+          end
+          define_visitor(visitor_name)
+        end
+        alias :has_one_and_only_one :has_one
+
+        def has_zero_or_one(xpath, options = {})
+          has_one(xpath, options.merge( { :allow_nil => true } ))
+        end
+
+        def has_many(xpath, options = {})
+          name = options[:name].try(:to_s) || guess_child_name(xpath, options)
+          children << name.pluralize.intern
+          attr_reader name.pluralize.intern
+          visitor_name = options[:visitor].try(:to_s) || name
+          define_method("visit_#{name.pluralize}".intern) do
+            unless options[:allow_nil] || search(xpath).size > 0
+              error("<#{xpath}> not found.")
+            end
+            instance_variable_set("@#{name.pluralize}".intern, search(xpath).map { |child|
+                child.accept(create_visitor(visitor_name))
+              } )
+          end
+          define_visitor(visitor_name)
+        end
+        alias :has_one_or_more :has_many
+
+        def has_zero_or_more(xpath, options = {})
+          has_many(xpath, options.merge( { :allow_nil => true} ))
+        end
+
+        def guess_child_name(xpath, options)
+          xpath.split(%r{[/:]}).last.underscore
+        end
+
+        def define_visitor(name)
+          define_method("#{name}_visitor".intern) do
+            options = respond_to?(:base) ? { :base => base } : {}
+            "Scorm2004::Manifest::#{name.camelize}".constantize.new(options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/scorm2004/manifest/completion_threshold.rb

@@ -0,0 +1,13 @@
+module Scorm2004
+  module Manifest
+    class CompletionThreshold
+      include VisitorPattern
+      include CustomError
+      include Attributes
+      
+      attribute :boolean, 'completedByMeasure', default: false
+      attribute :decimal, 'minProgressMeasure', default: 1.0, range: 0.0..1.0
+      attribute :decimal, 'progressWeight',     default: 1.0, range: 0.0..1.0
+    end
+  end
+end

data/lib/scorm2004/manifest/condition_rule.rb

@@ -0,0 +1,12 @@
+module Scorm2004
+  module Manifest
+    class ConditionRule
+      include VisitorPattern
+      include CustomError
+      include Children
+
+      has_one_and_only_one 'imsss:ruleConditions'
+      has_one_and_only_one 'imsss:ruleAction'
+    end
+  end
+end

data/lib/scorm2004/manifest/constrained_choice_considerations.rb

@@ -0,0 +1,12 @@
+module Scorm2004
+  module Manifest
+    class ConstrainedChoiceConsiderations
+      include VisitorPattern
+      include CustomError
+      include Attributes
+
+      attribute :boolean, 'preventActivation', default: false
+      attribute :boolean, 'constrainChoice',   default: false
+    end
+  end
+end

data/lib/scorm2004/manifest/control_mode.rb

@@ -0,0 +1,16 @@
+module Scorm2004
+  module Manifest
+    class ControlMode
+      include VisitorPattern
+      include CustomError
+      include Attributes
+
+      attribute :boolean, 'choice',                         default: true
+      attribute :boolean, 'choiceExit',                     default: true
+      attribute :boolean, 'flow',                           default: false
+      attribute :boolean, 'forwardOnly',                    default: false
+      attribute :boolean, 'useCurrentAttemptObjectiveInfo', default: true
+      attribute :boolean, 'useCurrentAttemptProgressInfo',  default: true
+    end
+  end
+end

data/lib/scorm2004/manifest/custom_error.rb

@@ -0,0 +1,15 @@
+module Scorm2004
+  module Manifest
+    module CustomError
+      def self.included(base)
+        base.class_eval do
+          const_set('Error', Class.new(Scorm2004::Manifest::Error))
+        end
+      end
+      
+      def error(message)
+        raise("#{self.class}::Error".constantize, [message, el.try(:to_s)].compact.join("\n"))
+      end
+    end
+  end
+end

data/lib/scorm2004/manifest/data.rb

@@ -0,0 +1,11 @@
+module Scorm2004
+  module Manifest
+    class Data
+      include VisitorPattern
+      include CustomError
+      include Children
+
+      has_one_or_more 'adlcp:map'
+    end
+  end
+end

data/lib/scorm2004/manifest/data_from_lms.rb

@@ -0,0 +1,21 @@
+module Scorm2004
+  module Manifest
+    class DataFromLms
+      include VisitorPattern
+      include CustomError
+      include TextNode
+
+      def self.spm
+        4000
+      end
+
+      private
+      
+      def do_visit
+        if content.length > self.class.spm
+          error("<adlcp:dataFromLMS> exceeds the SPM of #{self.class.spm}: #{content}")
+        end
+      end
+    end
+  end
+end

data/lib/scorm2004/manifest/delivery_controls.rb

@@ -0,0 +1,13 @@
+module Scorm2004
+  module Manifest
+    class DeliveryControls
+      include VisitorPattern
+      include CustomError
+      include Attributes
+      
+      attribute :boolean, 'tracked',                default: true
+      attribute :boolean, 'completionSetByContent', default: false
+      attribute :boolean, 'objectiveSetByContent',  default: false
+    end
+  end
+end

data/lib/scorm2004/manifest/dependency.rb

@@ -0,0 +1,21 @@
+module Scorm2004
+  module Manifest
+    class Dependency
+      include VisitorPattern
+      include CustomError
+      include Attributes
+      
+      attribute :string, 'identifierref'
+
+      private
+      
+      def do_visit
+        error('Referenced <resource> not found:') unless referenced_resource
+      end
+
+      def referenced_resource
+        el.at("/imscp:manifest/imscp:resources/imscp:resource[@identifier='#{identifierref}']", NS)
+      end
+    end
+  end
+end

data/lib/scorm2004/manifest/error.rb

@@ -0,0 +1,5 @@
+module Scorm2004
+  module Manifest
+    class Error < StandardError; end
+  end
+end

data/lib/scorm2004/manifest/file.rb

@@ -0,0 +1,16 @@
+module Scorm2004
+  module Manifest
+    class File
+      include VisitorPattern
+      include CustomError
+      include XmlBase
+      include Href
+      
+      private
+      
+      def do_visit
+        error('href attribute not found:') unless href
+      end
+    end
+  end
+end