strongmind_multi_version_common_cartridge 1.0.4

data/lib/multi_version_common_cartridge/writers/cartridge_writer.rb

@@ -0,0 +1,85 @@
+# multi_version_common_cartridge
+# Copyright © 2019 Vista Higher Learning, Inc.
+#
+# multi_version_common_cartridge is free software: you can redistribute it
+# and/or modify it under the terms of the GNU General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# multi_version_common_cartridge is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with multi_version_common_cartridge.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'common_cartridge'
+
+module MultiVersionCommonCartridge
+  module Writers
+    class CartridgeWriter
+      include SupportedVersions
+
+      attr_reader :cartridge
+
+      def initialize(cartridge, version)
+        @cartridge = cartridge
+        @finalized = false
+        @version = validate_version(version)
+      end
+
+      def finalize
+        manifest_writer.finalize
+        cartridge.all_items.each { |item| item_writer(item).finalize }
+        cartridge.all_resources.each { |resource| resource_writer(resource).finalize }
+        @finalized = true
+      end
+
+      def write_in_dir(dir)
+        # Should we raise, or should we call finalize from here?
+        raise StandardError, 'the cartridge has not been finalized' unless @finalized
+        FileUtils.mkdir_p(dir)
+        manifest_writer.write(dir)
+        cartridge.all_resources.each do |resource|
+          resource_writer(resource).create_files(dir)
+        end
+      end
+
+      def write_to_zip(filename)
+        Dir.mktmpdir do |dir|
+          write_in_dir(dir)
+          zip_dir(filename, dir)
+        end
+      end
+
+      private def zip_dir(filename, dir)
+        Zip::OutputStream.open(filename) { |zos| } # make sure it's a zip
+
+        Zip::File.open(filename, Zip::File::CREATE) do |zipfile|
+          base_path = Pathname.new(dir)
+          Dir["#{dir}/**/*"].each do |file|
+            entry = Pathname.new(file).relative_path_from(base_path)
+            zipfile.add(entry, file)
+          end
+        end
+      end
+
+      private def writers_factory
+        @writers_factory ||= Factory.new(cartridge, @version)
+      end
+
+      private def manifest_writer
+        writers_factory.manifest_writer
+      end
+
+      private def item_writer(item)
+        writers_factory.item_writer(item)
+      end
+
+      private def resource_writer(resource)
+        writers_factory.resource_writer(resource)
+      end
+    end
+  end
+end

data/lib/multi_version_common_cartridge/writers/factory.rb

@@ -0,0 +1,61 @@
+# multi_version_common_cartridge
+# Copyright © 2019 Vista Higher Learning, Inc.
+#
+# multi_version_common_cartridge is free software: you can redistribute it
+# and/or modify it under the terms of the GNU General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# multi_version_common_cartridge is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with multi_version_common_cartridge.  If not, see <http://www.gnu.org/licenses/>.
+
+module MultiVersionCommonCartridge
+  module Writers
+    class Factory
+      RESOURCE_WRITERS = {
+        ::MultiVersionCommonCartridge::Resources::BasicLtiLink::BasicLtiLink => BasicLtiLinkWriter,
+        ::MultiVersionCommonCartridge::Resources::CanvasAssignment::CanvasAssignment => CanvasAssignmentWriter,
+        ::MultiVersionCommonCartridge::Resources::CanvasCourseSettings::CanvasCourseSettings => CanvasCourseSettingsWriter,
+      }.freeze
+
+      def initialize(cartridge, version)
+        @cartridge = cartridge
+        @version = version
+        @item_writers = {}
+        @resource_writers = {}
+      end
+
+      def manifest_writer
+        @manifest_writer ||= ManifestWriter.new(@cartridge.manifest, self, @version)
+      end
+
+      def manifest_metadata_writer
+        @manifest_metadata_writer ||= ManifestMetadataWriter.new(@cartridge.manifest, @version)
+      end
+
+      def manifest_organization_writer
+        @manifest_organization_writer ||= ManifestOrganizationWriter.new(@cartridge, self, @version)
+      end
+
+      def manifest_resources_writer
+        @manifest_resources_writer ||= ManifestResourcesWriter.new(@cartridge, self, @version)
+      end
+
+      def item_writer(item)
+        @item_writers[item] ||= ItemWriter.new(item, self, @version)
+      end
+
+      def resource_writer(resource)
+        return @resource_writers[resource] if @resource_writers.key?(resource)
+        writer_class = RESOURCE_WRITERS[resource.class]
+        raise "Unknown resource '#{resource.class.name}'" unless writer_class
+        @resource_writers[resource] = writer_class.new(resource, @version)
+      end
+    end
+  end
+end

data/lib/multi_version_common_cartridge/writers/item_writer.rb

@@ -0,0 +1,60 @@
+# multi_version_common_cartridge
+# Copyright © 2019 Vista Higher Learning, Inc.
+#
+# multi_version_common_cartridge is free software: you can redistribute it
+# and/or modify it under the terms of the GNU General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# multi_version_common_cartridge is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with multi_version_common_cartridge.  If not, see <http://www.gnu.org/licenses/>.
+
+module MultiVersionCommonCartridge
+  module Writers
+    class ItemWriter
+      include SupportedVersions
+
+      MESSAGES = {
+        no_title: 'A title is required',
+        no_identifier: 'An identifier is required'
+      }.freeze
+
+      attr_reader :item
+
+      def initialize(item, factory, version)
+        @item = item
+        @factory = factory
+        @version = validate_version(version)
+      end
+
+      def finalize
+        validate_title
+        validate_identifier
+      end
+
+      def organization_item_element
+        CommonCartridge::Elements::Organizations::Item.new.tap do |item_element|
+          item_element.identifier = item.identifier
+          item_element.identifierref = item.resource.identifier if item.resource
+          item_element.title = item.title
+          item_element.items = item.children.map do |child|
+            @factory.item_writer(child).organization_item_element
+          end
+        end
+      end
+
+      private def validate_title
+        raise StandardError, MESSAGES[:no_title] unless item.title
+      end
+
+      private def validate_identifier
+        raise StandardError, MESSAGES[:no_identifier] unless item.identifier
+      end
+    end
+  end
+end

data/lib/multi_version_common_cartridge/writers/manifest_metadata_writer.rb

@@ -0,0 +1,62 @@
+# multi_version_common_cartridge
+# Copyright © 2019 Vista Higher Learning, Inc.
+#
+# multi_version_common_cartridge is free software: you can redistribute it
+# and/or modify it under the terms of the GNU General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# multi_version_common_cartridge is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with multi_version_common_cartridge.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'common_cartridge'
+
+module MultiVersionCommonCartridge
+  module Writers
+    class ManifestMetadataWriter
+      # http://www.imsglobal.org/profile/cc/ccv1p3/ccv1p3_imscp_v1p2_v1p0.xsd
+      # ManifestMetadata.Type
+      include SupportedVersions
+
+      attr_reader :manifest
+
+      def initialize(manifest, version)
+        @manifest = manifest
+        @version = validate_version(version)
+      end
+
+      def finalize
+        # nothing to check
+      end
+
+      def metadata_element
+        CommonCartridge::Elements::Metadata.new.tap do |metadata|
+          metadata.schema = XmlDefinitions::SCHEMA[@version]
+          metadata.schemaversion = XmlDefinitions::SCHEMA_VERSION[@version]
+          metadata.lom = lom_element
+        end
+      end
+
+      private def lom_element
+        CommonCartridge::Elements::Lom::Lom.new.tap do |lom|
+          lom.general = CommonCartridge::Elements::Lom::General.new.tap do |general|
+            general.title = lom_general_title_element
+          end
+        end
+      end
+
+      private def lom_general_title_element
+        CommonCartridge::Elements::Lom::Title.new.tap do |title_element|
+          title_element.strings = manifest.titles.map do |language, value|
+            CommonCartridge::Elements::Lom::LanguageString.new(language: language, value: value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/multi_version_common_cartridge/writers/manifest_organization_writer.rb

@@ -0,0 +1,68 @@
+# multi_version_common_cartridge
+# Copyright © 2019 Vista Higher Learning, Inc.
+#
+# multi_version_common_cartridge is free software: you can redistribute it
+# and/or modify it under the terms of the GNU General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# multi_version_common_cartridge is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with multi_version_common_cartridge.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'common_cartridge'
+require 'securerandom'
+
+module MultiVersionCommonCartridge
+  module Writers
+    class ManifestOrganizationWriter
+      # http://www.imsglobal.org/profile/cc/ccv1p3/ccv1p3_imscp_v1p2_v1p0.xsd
+      # Organizations.Type, Organization.Type
+      include SupportedVersions
+
+      ORGANIZATION_STRUCTURE = 'rooted-hierarchy'.freeze
+      DEFAULT_ROOT_ITEM_IDENTIFIER = 'root'.freeze
+
+      MESSAGES = {
+        no_identifier: 'An identifier is required'
+      }.freeze
+
+      attr_reader :cartridge
+
+      def initialize(cartridge, factory, version)
+        @cartridge = cartridge
+        @factory = factory
+        @version = validate_version(version)
+      end
+
+      def finalize
+        validate_identifier
+      end
+
+      def organization_element
+        CommonCartridge::Elements::Organizations::Organization.new.tap do |element|
+          element.identifier = SecureRandom.uuid
+          element.structure = ORGANIZATION_STRUCTURE
+          element.root_item = root_item
+        end
+      end
+
+      private def root_item
+        CommonCartridge::Elements::Organizations::RootItem.new.tap do |root_item|
+          root_item.identifier = cartridge.manifest.organization_identifier || DEFAULT_ROOT_ITEM_IDENTIFIER
+          root_item.items = cartridge.items.map do |item|
+            @factory.item_writer(item).organization_item_element
+          end
+        end
+      end
+
+      private def validate_identifier
+        # raise StandardError, MESSAGES[:no_identifier] unless manifest..identifier
+      end
+    end
+  end
+end

data/lib/multi_version_common_cartridge/writers/manifest_resources_writer.rb

@@ -0,0 +1,48 @@
+# multi_version_common_cartridge
+# Copyright © 2019 Vista Higher Learning, Inc.
+#
+# multi_version_common_cartridge is free software: you can redistribute it
+# and/or modify it under the terms of the GNU General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# multi_version_common_cartridge is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with multi_version_common_cartridge.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'common_cartridge'
+
+module MultiVersionCommonCartridge
+  module Writers
+    class ManifestResourcesWriter
+      # http://www.imsglobal.org/profile/cc/ccv1p3/ccv1p3_imscp_v1p2_v1p0.xsd
+      # Resources.type
+      include SupportedVersions
+
+      attr_reader :cartridge
+
+      def initialize(cartridge, factory, version)
+        @cartridge = cartridge
+        @factory = factory
+        @resource_writers = {}
+        @version = validate_version(version)
+      end
+
+      def finalize
+        # nothing to check
+      end
+
+      def root_resource_element
+        @root_resource_element ||= CommonCartridge::Elements::Resources::RootResource.new(
+          resources: cartridge.all_resources.map do |resource|
+            @factory.resource_writer(resource).resource_element
+          end
+        )
+      end
+    end
+  end
+end

data/lib/multi_version_common_cartridge/writers/manifest_writer.rb

@@ -0,0 +1,88 @@
+# multi_version_common_cartridge
+# Copyright © 2019 Vista Higher Learning, Inc.
+#
+# multi_version_common_cartridge is free software: you can redistribute it
+# and/or modify it under the terms of the GNU General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# multi_version_common_cartridge is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with multi_version_common_cartridge.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'common_cartridge'
+
+module MultiVersionCommonCartridge
+  module Writers
+    class ManifestWriter
+      include SupportedVersions
+
+      MESSAGES = {
+        no_identifier: 'An identifier is required',
+      }.freeze
+
+      attr_reader :manifest
+
+      def initialize(manifest, factory, version)
+        @manifest = manifest
+        @factory = factory
+        @version = validate_version(version)
+      end
+
+      def finalize
+        raise StandardError, MESSAGES[:no_identifier] unless manifest.identifier
+        metadata_writer.finalize
+        organization_writer.finalize
+        resources_writer.finalize
+      end
+
+      def write(dir)
+        doc = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |builder|
+          SaxMachineNokogiriXmlSaver.new.save(builder, manifest_element, 'manifest')
+        end
+        File.open(File.join(dir, 'imsmanifest.xml'), 'w') { |file| file.write(doc.to_xml) }
+      end
+
+      def manifest_element
+        @manifest_element ||= CommonCartridge::Elements::Manifest.new.tap do |element|
+          element.identifier = manifest.identifier
+          element.xmlns = required_namespaces['xmlns']
+          element.xmlns_lomimscc = required_namespaces['xmlns:lomimscc']
+          element.xmlns_lom = required_namespaces['xmlns:lom']
+          element.xmlns_xsi = required_namespaces['xmlns:xsi']
+          element.xsi_schema_location = xsi_schema_location
+          element.metadata = metadata_writer.metadata_element
+          element.root_organization = CommonCartridge::Elements::Organizations::RootOrganization.new(
+            organizations: [organization_writer.organization_element]
+          )
+          element.root_resource = resources_writer.root_resource_element
+        end
+      end
+
+      private def metadata_writer
+        @factory.manifest_metadata_writer
+      end
+
+      private def organization_writer
+        @factory.manifest_organization_writer
+      end
+
+      private def resources_writer
+        @factory.manifest_resources_writer
+      end
+
+      private def required_namespaces
+        XmlDefinitions::REQUIRED_NAMESPACES[@version]
+      end
+
+      private def xsi_schema_location
+        locations = XmlDefinitions::REQUIRED_SCHEMA_LOCATIONS[@version]
+        locations.flatten.join(' ')
+      end
+    end
+  end
+end

data/lib/multi_version_common_cartridge/writers/resource_writer.rb

@@ -0,0 +1,54 @@
+# multi_version_common_cartridge
+# Copyright © 2019 Vista Higher Learning, Inc.
+#
+# multi_version_common_cartridge is free software: you can redistribute it
+# and/or modify it under the terms of the GNU General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# multi_version_common_cartridge is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with multi_version_common_cartridge.  If not, see <http://www.gnu.org/licenses/>.
+
+module MultiVersionCommonCartridge
+  module Writers
+    class ResourceWriter
+      include SupportedVersions
+
+      attr_reader :resource
+
+      def initialize(resource, version)
+        @resource = resource
+        @version = validate_version(version)
+      end
+
+      def finalize
+        resource.identifier ||= 'i_' + Digest::MD5.hexdigest("resource #{resource.object_id}")
+      end
+
+      def resource_element
+        CommonCartridge::Elements::Resources::Resource.new.tap do |element|
+          element.identifier = resource.identifier
+          element.type = type
+          element.href = resource.href
+          element.files = files.map do |file|
+            CommonCartridge::Elements::Resources::File.new(href: file)
+          end
+        end
+      end
+
+      def type
+        raise NotImplementedError, 'Subclasses must implement the type method ' \
+          'that returns the correct resource type.'
+      end
+
+      def files
+        []
+      end
+    end
+  end
+end

data/lib/multi_version_common_cartridge/writers/supported_versions.rb

@@ -0,0 +1,37 @@
+# multi_version_common_cartridge
+# Copyright © 2019 Vista Higher Learning, Inc.
+#
+# multi_version_common_cartridge is free software: you can redistribute it
+# and/or modify it under the terms of the GNU General Public
+# License as published by the Free Software Foundation, either
+# version 3 of the License, or (at your option) any later version.
+#
+# multi_version_common_cartridge is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with multi_version_common_cartridge.  If not, see <http://www.gnu.org/licenses/>.
+
+module MultiVersionCommonCartridge
+  module Writers
+    module SupportedVersions
+      SUPPORTED_VERSIONS = [
+        MultiVersionCommonCartridge::CartridgeVersions::CC_1_1_0,
+        MultiVersionCommonCartridge::CartridgeVersions::CC_1_2_0,
+        MultiVersionCommonCartridge::CartridgeVersions::CC_1_3_0,
+        MultiVersionCommonCartridge::CartridgeVersions::THIN_CC_1_2_0,
+        MultiVersionCommonCartridge::CartridgeVersions::THIN_CC_1_3_0
+      ].freeze
+      UNSUPPORTED_VERSION_MSG_TEMPLATE = "Unsupported common cartridge version '%<version>s'".freeze
+
+      def validate_version(version)
+        unless SUPPORTED_VERSIONS.include?(version)
+          raise ArgumentError, format(UNSUPPORTED_VERSION_MSG_TEMPLATE, version: version)
+        end
+        version
+      end
+    end
+  end
+end