PerfectlyNormal/scorm

View on GitHub
lib/scorm/adlcp/data.rb

Summary

Maintainability
A
0 mins
Test Coverage
require 'virtus'
require 'scorm/errors'
require 'scorm/adlcp/map'

# 3.4.1.18. <data> Element
# The <data> element is the container used to define sets of data shared
# associated with an activity. This element is an ADL defined extension to
# the IMS Content Packaging Specification. The element shall only appear, if
# needed, as a child of a leaf <item> element that references a SCO resource.
#
# XML Namespace: http://www.adlnet.org/xsd/adlcp_v1p3
# XML Namespace Prefix: adlcp
# XML Binding Representation: <data>
# SCORM Requirements:
#   SCORM places a requirement that all manifests shall adhere to the
#   following multiplicity requirements for the <data> element:
#     Content Aggregation: 0 or 1
#     Resource:            0
# For Resource Content Packages, this element shall not appear.
# The <organizations> element is required to be empty.
#
# Data Type:
#   The <data> element is a parent element. Parent elements have no values
#   associated with them. Parent elements act as “containers” for other
#   elements/attributes. The <data> element contains the following
#   elements/attributes:
#
# Attributes:
#   * None
#
# Elements:
#   * <adlcp:map>
#
module Scorm::Adlcp
  class Data
    include Virtus.model

    def self.from_xml(data)
      return nil if data.nil? || data.length == 0
      raise Scorm::Errors::DuplicateItem.new(
        "Found #{data.length} instances of <adlcp:data>, but only 0 or 1 is allowed."
      ) if data.length > 1
      raise Scorm::Errors::RequiredItemMissing.new(
        "<adlcp:data> requires one or more <adlcp:map> elements, but found none"
      ) if data.xpath('adlcp:map').empty?

      instance = new
      data.xpath('adlcp:map').each do |map|
        instance.maps.push(Scorm::Adlcp::Map.from_xml(map))
      end

      instance
    end

    attribute :maps, Array[Scorm::Adlcp::Map]

    def valid?
      !maps.empty?
    end
  end
end