strongmind_multi_version_common_cartridge 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7861854f0bf3a6b3e3f35954864edf86fa8b5c30bead75f87d057f5e47631a91
-  data.tar.gz: 853cc0d321b1e99f32d2fc43ea9cd927d69dd45cdc269f43b6c1f152518835ae
+  metadata.gz: fafc7a3fb601c861dbaa2cd0cdd0283fc99f9ab9063422c5bd35979a7c4736f8
+  data.tar.gz: 28d30a8390ce6ca47e9c45981c94657d1a6656a5bb635861f5b75408047e60e7
 SHA512:
-  metadata.gz: cf48d095be43393ac36dc58f94f7101a43285697801c64bc6181e9dd0b42978c51230a29efd5252d1cb449d91279dd033a23c4d350e5ff70485133f013857f4a
-  data.tar.gz: 31c861c0b9af7d61cc14dd4961a3bc802db51f7cd6334e8b0f19fb7b3641641f4e5ea9a81367e254b96c581a9395dfdc952198683e5836db4f81a457b22b8d64
+  metadata.gz: 71ffa47bd5eea926e2a92738a84680b81cc4a554bdc0b78e588f8ad8179004430bd0c51ea64bf190f4a2d09c31bc0480f3e429d8cca4365ad1b226776d99f900
+  data.tar.gz: c0fe805700fdf621beea2ffb6744a085fd95c2d21dc7a03c312fe35f5ef8b1849877f70164d113294795d9432d17f4c79b2f40ec85341c882d18afa719c52eb7

data/Gemfile

@@ -1,3 +1,6 @@
 source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gem 'common_cartridge_parser', github: 'vhl/common_cartridge_parser'
 gemspec
 ruby '>=3.2'

data/README.md

@@ -3,8 +3,23 @@ A gem for writing different versions of Common Cartridges.
 
 It supports Common Cartridge version 1.1, 1.2, 1.3 and Thin CC version 1.2 and 1.3.
 
+## Installation
+[Ruby Gems](https://rubygems.org/gems/strongmind_multi_version_common_cartridge)
+
+Gemfile:
+``` ruby
+gem 'strongmind_multi_version_common_cartridge', '~> 1.0', '>= 1.0.5'
+```
+
+Direct Install:
+``` ruby
+gem install strongmind_multi_version_common_cartridge
+```
+
 ## Usage
 ``` ruby
+require 'multi_version_common_cartridge'
+
 # Create a Common Cartridge
 cartridge = MultiVersionCommonCartridge::Cartridge.new
 cartridge.manifest.set_title('My cartridge')

data/lib/multi_version_common_cartridge/cartridge.rb

@@ -45,7 +45,7 @@ module MultiVersionCommonCartridge
     end
 
     def all_resources
-      @all_resources ||= all_items.map(&:resource).compact + @resources
+      @all_resources ||= get_resources
     end
 
     private def child_items(item, memo)
@@ -54,5 +54,17 @@ module MultiVersionCommonCartridge
         child_items(child, memo)
       end
     end
+
+    private
+
+    def get_resources
+      all_resources = all_items.flat_map do |item|
+        next if item.resource.nil?
+
+        item.resource.dependencies.insert(0, item.resource)
+      end
+
+      all_resources.compact + @resources
+    end
   end
 end

data/lib/multi_version_common_cartridge/elements/canvas/assignment.rb

@@ -0,0 +1,31 @@
+module MultiVersionCommonCartridge
+  module Elements
+    module Canvas
+
+      class Assignment
+        include SAXMachine
+
+        attribute :xmlns
+        attribute 'xmlns:xsi', as: :xmlns_xsi
+        attribute :identifier, as: :identifier
+
+        element 'title', as: :title
+        element 'assignment_group_identifierref', as: :assignment_group_identifierref
+        element 'points_possible', as: :points_possible
+        element 'max_attempts', as: :max_attempts
+        element 'allowed_attempts', as: :allowed_attempts
+        element 'is_end_of_module_exam', as: :is_end_of_module_exam
+        element 'grading_type', as: :grading_type
+        element 'submission_types', as: :submission_types
+        element 'peer_review_count', as: :peer_review_count
+        element 'external_tool_url', as: :external_tool_url
+
+        def self.type
+          :canvas_assignment
+        end
+
+        def self.pattern; end
+      end
+    end
+  end
+end

data/lib/multi_version_common_cartridge/elements/canvas/course_settings.rb

@@ -0,0 +1,109 @@
+module MultiVersionCommonCartridge
+  module Elements
+    module Canvas
+
+      class CourseSettings
+        include SAXMachine
+
+        attribute :identifier
+
+        attribute :xmlns
+        attribute 'xmlns:xsi', as: :xmlns_xsi
+
+        element 'image_url', as: :image_url
+        element 'group_weighting_scheme', as: :group_weighting_scheme
+
+        def self.type
+          :course_settings
+        end
+
+        def self.pattern; end
+      end
+
+      class AssignmentGroup
+        include SAXMachine
+
+        attribute :identifier
+
+        element 'title', as: :title
+        element 'position', as: :position
+        element 'group_weight', as: :group_weight
+
+      end
+
+      class AssignmentGroups
+        include SAXMachine
+
+        attribute :xmlns
+        attribute 'xmlns:xsi', as: :xmlns_xsi
+
+        elements 'assignmentGroup', class: AssignmentGroup, as: :groups
+      end
+
+      class Prerequisite
+        include SAXMachine
+        attribute :type
+        element :title
+        element :identifierref
+      end
+
+      class Prerequisites
+        include SAXMachine
+
+        elements :prerequisite, as: :prerequisites, class: Prerequisite
+      end
+
+      class Item
+        include SAXMachine
+        attribute :identifier, as: :identifier
+        element :title
+        element :workflow_state
+        element :content_type
+        element :identifierref
+        element :url
+        element :position
+        element :indent
+        element :global_identifierref
+      end
+
+      class Items
+        include SAXMachine
+
+        elements :item, as: :items, class: Item
+      end
+
+      class CompletionRequirement
+        include SAXMachine
+        attribute :type
+        element :identifierref
+      end
+
+      class CompletionRequirements
+        include SAXMachine
+
+        elements :completionRequirement, as: :completion_requirements, class: CompletionRequirement
+      end
+
+      class Module
+        include SAXMachine
+        attribute :identifier
+        element :title
+        element :workflow_state
+        element :position
+        element :require_sequential_progress
+        element :requirement_count
+        element :prerequisites, as: :root_prerequisites, class: Prerequisites
+        element :items, as: :root_items, class: Items
+        element :completionRequirements, as: :root_requirements, class: CompletionRequirements
+      end
+
+      class Modules
+        include SAXMachine
+
+        attribute :xmlns
+        attribute 'xmlns:xsi', as: :xmlns_xsi
+        elements :module, as: :modules, class: Module
+      end
+    end
+  end
+end

data/lib/multi_version_common_cartridge/elements/canvas/topic_meta.rb

@@ -0,0 +1,24 @@
+module MultiVersionCommonCartridge
+  module Elements
+    module Canvas
+      class TopicMeta
+        include SAXMachine
+
+        attribute :xmlns
+        attribute 'xmlns:xsi', as: :xmlns_xsi
+        attribute :identifier, as: :identifier
+
+        element :topic_id
+        element :title
+
+        element :assignment, class: Assignment
+
+        element :position
+        element :workflow_state
+        element :discussion_type
+        element :type
+      end
+
+    end
+  end
+end

data/lib/multi_version_common_cartridge/elements/topic.rb

@@ -0,0 +1,24 @@
+module MultiVersionCommonCartridge
+  module Elements
+    class TopicText
+      include SAXMachine
+
+      attribute :type
+
+      element :text
+    end
+
+    class Topic
+      include SAXMachine
+
+      attribute :xmlns
+      attribute 'xmlns:xsi', as: :xmlns_xsi
+
+      element 'title', as: :title
+      element 'text_', as: :text, class: TopicText
+
+      element 'attachments', class: ::CommonCartridge::Elements::Resources::Attachments::RootAttachment, as: :attachment_root
+    end
+
+  end
+end

data/lib/multi_version_common_cartridge/resources/canvas_topic.rb

@@ -0,0 +1,7 @@
+module MultiVersionCommonCartridge
+  module Resources
+    class CanvasTopic < MultiVersionCommonCartridge::Resources::Resource
+      attr_accessor :title, :position, :workflow_state, :discussion_type, :type, :assignment
+    end
+  end
+end

data/lib/multi_version_common_cartridge/resources/resource.rb

@@ -18,6 +18,10 @@ module MultiVersionCommonCartridge
   module Resources
     class Resource
       attr_accessor :identifier, :href
+
+      def dependencies
+        []
+      end
     end
   end
 end

data/lib/multi_version_common_cartridge/resources/topic.rb

@@ -0,0 +1,11 @@
+module MultiVersionCommonCartridge
+  module Resources
+    class Topic < MultiVersionCommonCartridge::Resources::Resource
+      attr_accessor :title, :text, :canvas_topic
+
+      def dependencies
+        [canvas_topic]
+      end
+    end
+  end
+end

data/lib/multi_version_common_cartridge/version.rb

@@ -15,5 +15,5 @@
 # along with multi_version_common_cartridge.  If not, see <http://www.gnu.org/licenses/>.
 
 module MultiVersionCommonCartridge
-  VERSION = '1.0.4'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/multi_version_common_cartridge/writers/canvas_assignment_writer.rb

@@ -67,7 +67,7 @@ module MultiVersionCommonCartridge
 
       def canvas_assignment_element
         @canvas_assignment_element ||=
-          CanvasCartridge::Elements::Resources::CanvasAssignment::Assignment.new.tap do |element|
+          MultiVersionCommonCartridge::Elements::Canvas::Assignment.new.tap do |element|
             element.xmlns = required_namespaces['xmlns']
             element.xmlns_xsi = required_namespaces['xmlns:xsi']
             element.identifier = resource.identifier

data/lib/multi_version_common_cartridge/writers/canvas_course_settings_writer.rb

@@ -81,7 +81,7 @@ module MultiVersionCommonCartridge
 
       def course_settings_element
         @course_settings_element ||=
-          CanvasCartridge::Elements::Resources::CourseSettings::CourseSettings.new.tap do |element|
+          MultiVersionCommonCartridge::Elements::Canvas::CourseSettings.new.tap do |element|
             element.identifier = resource.identifier
             element.xmlns = required_namespaces['xmlns']
             element.xmlns_xsi = required_namespaces['xmlns:xsi']
@@ -92,7 +92,7 @@ module MultiVersionCommonCartridge
 
       def assignment_groups_element
         @assignment_groups_element ||=
-          CanvasCartridge::Elements::Resources::CourseSettings::AssignmentGroups.new.tap do |element|
+          MultiVersionCommonCartridge::Elements::Canvas::AssignmentGroups.new.tap do |element|
             element.xmlns = required_namespaces['xmlns']
             element.xmlns_xsi = required_namespaces['xmlns:xsi']
             element.groups = groups_child_elements
@@ -103,7 +103,7 @@ module MultiVersionCommonCartridge
         return if resource.assignment_groups.nil?
 
         resource.assignment_groups.map do |key, value|
-          CanvasCartridge::Elements::Resources::CourseSettings::AssignmentGroup.new.tap do |element|
+          MultiVersionCommonCartridge::Elements::Canvas::AssignmentGroup.new.tap do |element|
             element.identifier = key
             element.title = value[:title]
             element.position = value[:position]
@@ -114,7 +114,7 @@ module MultiVersionCommonCartridge
 
       def module_meta_element
         @module_meta_element ||=
-          CanvasCartridge::Elements::Resources::CourseSettings::Modules.new.tap do |element|
+          MultiVersionCommonCartridge::Elements::Canvas::Modules.new.tap do |element|
             element.xmlns = required_namespaces['xmlns']
             element.xmlns_xsi = required_namespaces['xmlns:xsi']
             element.modules = modules_child_elements
@@ -125,7 +125,7 @@ module MultiVersionCommonCartridge
         return if resource.modules.nil?
 
         resource.modules.map do |key, value|
-          CanvasCartridge::Elements::Resources::CourseSettings::Module.new.tap do |element|
+          MultiVersionCommonCartridge::Elements::Canvas::Module.new.tap do |element|
             element.identifier = key
             element.title = value[:title]
             element.workflow_state = value[:workflow_state]
@@ -142,14 +142,14 @@ module MultiVersionCommonCartridge
       def prerequisites_root_element(prerequisites)
         return if prerequisites.nil?
 
-        CanvasCartridge::Elements::Resources::CourseSettings::Prerequisites.new.tap do |element|
+        MultiVersionCommonCartridge::Elements::Canvas::Prerequisites.new.tap do |element|
           element.prerequisites = prerequisites_child_elements(prerequisites)
         end
       end
 
       def prerequisites_child_elements(prerequisites)
         prerequisites.map do |prerequisite|
-          CanvasCartridge::Elements::Resources::CourseSettings::Prerequisite.new.tap do |element|
+          MultiVersionCommonCartridge::Elements::Canvas::Prerequisite.new.tap do |element|
             element.type = prerequisite[:type]
             element.title = prerequisite[:title]
             element.identifierref = prerequisite[:identifierref]
@@ -160,14 +160,14 @@ module MultiVersionCommonCartridge
       def items_root_element(items)
         return if items.nil?
 
-        CanvasCartridge::Elements::Resources::CourseSettings::Items.new.tap do |element|
+        MultiVersionCommonCartridge::Elements::Canvas::Items.new.tap do |element|
           element.items = items_child_elements(items)
         end
       end
 
       def items_child_elements(items)
         items.map do |item|
-          CanvasCartridge::Elements::Resources::CourseSettings::Item.new.tap do |element|
+          MultiVersionCommonCartridge::Elements::Canvas::Item.new.tap do |element|
             element.identifier = item[:identifier]
             element.title = item[:title]
             element.workflow_state = item[:workflow_state]
@@ -184,14 +184,14 @@ module MultiVersionCommonCartridge
       def completion_requirements_root_element(completion_requirements)
         return if completion_requirements.nil?
 
-        CanvasCartridge::Elements::Resources::CourseSettings::CompletionRequirements.new.tap do |element|
+        MultiVersionCommonCartridge::Elements::Canvas::CompletionRequirements.new.tap do |element|
           element.completion_requirements = completion_requirements_child_elements(completion_requirements)
         end
       end
 
       def completion_requirements_child_elements(completion_requirements)
         completion_requirements.map do |completion_requirement|
-          CanvasCartridge::Elements::Resources::CourseSettings::CompletionRequirement.new.tap do |element|
+          MultiVersionCommonCartridge::Elements::Canvas::CompletionRequirement.new.tap do |element|
             element.type = completion_requirement[:type]
             element.identifierref = completion_requirement[:identifierref]
           end

data/lib/multi_version_common_cartridge/writers/canvas_topic_writer.rb

@@ -0,0 +1,100 @@
+# multi_version_common_cartridge
+# Copyright © 2023 StrongMind
+#
+# 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 CanvasTopicWriter < ResourceWriter
+      REQUIRED_NAMESPACES = {
+        MultiVersionCommonCartridge::CartridgeVersions::CC_1_1_0 => {
+          'xmlns' => 'http://canvas.instructure.com/xsd/cccv1p0',
+          'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance'
+        }
+      }.freeze
+
+      MESSAGES = {
+        no_title: 'A title is required.',
+        no_external_tool_url: 'An external tool url is required.'
+      }.freeze
+
+      def finalize
+        super
+        validate_title
+      end
+
+      def type
+        'webcontent'
+      end
+
+      def create_files(out_dir)
+        FileUtils.mkdir_p(File.join(out_dir))
+        doc = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |builder|
+          SaxMachineNokogiriXmlSaver.new.save(
+            builder, canvas_topic_element, 'topicMeta'
+          )
+        end
+        File.open(File.join(out_dir, "#{resource.identifier}.xml"), 'w') do |file|
+          file.write(doc.to_xml)
+        end
+
+      end
+
+      def canvas_topic_element
+        @canvas_topic_element ||=
+          MultiVersionCommonCartridge::Elements::Canvas::TopicMeta.new.tap do |element|
+            element.xmlns = required_namespaces['xmlns']
+            element.xmlns_xsi = required_namespaces['xmlns:xsi']
+            element.identifier = resource.identifier
+            element.topic_id = resource.identifier.gsub(/_canvasTopic$/, '')
+            element.title = resource.title
+            assignment_resource = resource.assignment
+            element.assignment = MultiVersionCommonCartridge::Elements::Canvas::Assignment.new.tap do |assignment|
+              assignment.title = resource.title
+              assignment.identifier = resource.identifier
+              assignment.assignment_group_identifierref = assignment_resource.assignment_group_identifierref
+              assignment.points_possible = assignment_resource.points_possible
+              assignment.max_attempts = assignment_resource.max_attempts
+              assignment.allowed_attempts = assignment_resource.allowed_attempts
+              assignment.is_end_of_module_exam = assignment_resource.is_end_of_module_exam
+              assignment.grading_type = assignment_resource.grading_type
+              assignment.submission_types = assignment_resource.submission_types
+              assignment.peer_review_count = assignment_resource.peer_review_count
+            end
+
+            element.position = resource.position
+            element.workflow_state = resource.workflow_state
+            element.discussion_type = resource.discussion_type
+            element.type = resource.type
+
+          end
+      end
+
+      def files
+        [
+          "#{resource.identifier}.xml"
+        ]
+      end
+
+      private def validate_title
+        raise StandardError, MESSAGES[:no_title] unless resource.title
+      end
+
+      private def required_namespaces
+        REQUIRED_NAMESPACES[@version]
+      end
+
+    end
+  end
+end

data/lib/multi_version_common_cartridge/writers/factory.rb

@@ -21,6 +21,8 @@ module MultiVersionCommonCartridge
         ::MultiVersionCommonCartridge::Resources::BasicLtiLink::BasicLtiLink => BasicLtiLinkWriter,
         ::MultiVersionCommonCartridge::Resources::CanvasAssignment::CanvasAssignment => CanvasAssignmentWriter,
         ::MultiVersionCommonCartridge::Resources::CanvasCourseSettings::CanvasCourseSettings => CanvasCourseSettingsWriter,
+        ::MultiVersionCommonCartridge::Resources::Topic => Writers::TopicWriter,
+        ::MultiVersionCommonCartridge::Resources::CanvasTopic => Writers::CanvasTopicWriter
       }.freeze
 
       def initialize(cartridge, version)
@@ -52,8 +54,10 @@ module MultiVersionCommonCartridge
 
       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

data/lib/multi_version_common_cartridge/writers/resource_writer.rb

@@ -38,6 +38,9 @@ module MultiVersionCommonCartridge
           element.files = files.map do |file|
             CommonCartridge::Elements::Resources::File.new(href: file)
           end
+          element.dependencies = dependencies.map do |dependency|
+            CommonCartridge::Elements::Resources::Dependency.new(identifierref: dependency)
+          end
         end
       end
 
@@ -49,6 +52,10 @@ module MultiVersionCommonCartridge
       def files
         []
       end
+
+      def dependencies
+        []
+      end
     end
   end
 end

data/lib/multi_version_common_cartridge/writers/topic_writer.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module MultiVersionCommonCartridge
+  module Writers
+    class TopicWriter < ResourceWriter
+      include SupportedVersions
+
+      CANVAS_TOPIC_IDENTIFIER_SUFFIX = '_canvasTopic'.freeze
+
+      def type
+        'imsdt_xmlv1p1'
+      end
+
+      def create_files(dir)
+        doc = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |builder|
+          SaxMachineNokogiriXmlSaver.new.save(builder, topic_element, 'topic')
+        end
+        File.write(File.join(dir, "#{resource.identifier}.xml"), doc.to_xml)
+      end
+
+      def topic_element
+        @topic_element ||= MultiVersionCommonCartridge::Elements::Topic.new.tap do |element|
+          element.xmlns_xsi = required_namespaces['xmlns:xsi']
+          element.xmlns = required_namespaces['xmlns:imsdt']
+          element.title = resource.title
+          element.text = MultiVersionCommonCartridge::Elements::TopicText.new.tap do |text|
+            text.text = resource.text
+            text.type = 'text/html'
+          end
+        end
+      end
+
+      def files
+        [
+          "#{resource.identifier}.xml"
+        ]
+      end
+
+      def dependencies
+        return [] unless resource.canvas_topic
+
+        [
+          "#{resource.identifier}#{CANVAS_TOPIC_IDENTIFIER_SUFFIX}"
+        ]
+      end
+
+      private def required_namespaces
+        XmlDefinitions::REQUIRED_NAMESPACES[@version]
+      end
+
+    end
+  end
+end

data/lib/multi_version_common_cartridge/xml_definitions.rb

@@ -37,13 +37,15 @@ module MultiVersionCommonCartridge
         'xmlns' => 'http://www.imsglobal.org/xsd/imsccv1p1/imscp_v1p1',
         'xmlns:lom' => 'http://ltsc.ieee.org/xsd/imsccv1p1/LOM/resource',
         'xmlns:lomimscc' => 'http://ltsc.ieee.org/xsd/imsccv1p1/LOM/manifest',
-        'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance'
+        'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+        'xmlns:imsdt' => 'http://www.imsglobal.org/xsd/imsccv1p1/imsdt_v1p1'
       },
       MultiVersionCommonCartridge::CartridgeVersions::CC_1_2_0 => {
         'xmlns' => 'http://www.imsglobal.org/xsd/imsccv1p2/imscp_v1p1',
         'xmlns:lom' => 'http://ltsc.ieee.org/xsd/imsccv1p2/LOM/resource',
         'xmlns:lomimscc' => 'http://ltsc.ieee.org/xsd/imsccv1p2/LOM/manifest',
-        'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance'
+        'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+        'xmlns:imsdt' => 'http://www.imsglobal.org/xsd/imsccv1p1/imsdt_v1p1'
       },
       MultiVersionCommonCartridge::CartridgeVersions::CC_1_3_0 => {
         'xmlns' => 'http://www.imsglobal.org/xsd/imsccv1p3/imscp_v1p1',

data/lib/multi_version_common_cartridge.rb

@@ -15,6 +15,7 @@
 # along with multi_version_common_cartridge.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'sax-machine'
+require 'common_cartridge'
 require 'multi_version_common_cartridge/version'
 require 'multi_version_common_cartridge/sax_machine_nokogiri_xml_saver'
 
@@ -24,8 +25,12 @@ require 'multi_version_common_cartridge/resources/resource'
 require 'multi_version_common_cartridge/resources/basic_lti_link'
 require 'multi_version_common_cartridge/resources/canvas_assignment'
 require 'multi_version_common_cartridge/resources/canvas_course_settings'
-require 'multi_version_common_cartridge/resources/canvas_elements/assignment'
-require 'multi_version_common_cartridge/resources/canvas_elements/course_settings'
+require 'multi_version_common_cartridge/resources/topic'
+require 'multi_version_common_cartridge/resources/canvas_topic'
+require 'multi_version_common_cartridge/elements/canvas/assignment'
+require 'multi_version_common_cartridge/elements/canvas/course_settings'
+require 'multi_version_common_cartridge/elements/canvas/topic_meta'
+require 'multi_version_common_cartridge/elements/topic'
 require 'multi_version_common_cartridge/manifest'
 require 'multi_version_common_cartridge/cartridge'
 require 'multi_version_common_cartridge/xml_definitions'
@@ -37,9 +42,12 @@ require 'multi_version_common_cartridge/writers/basic_lti_extension_writer'
 require 'multi_version_common_cartridge/writers/basic_lti_link_writer'
 require 'multi_version_common_cartridge/writers/canvas_course_settings_writer'
 require 'multi_version_common_cartridge/writers/canvas_assignment_writer'
+require 'multi_version_common_cartridge/writers/canvas_topic_writer'
 require 'multi_version_common_cartridge/writers/manifest_writer'
 require 'multi_version_common_cartridge/writers/manifest_metadata_writer'
 require 'multi_version_common_cartridge/writers/manifest_organization_writer'
 require 'multi_version_common_cartridge/writers/manifest_resources_writer'
 require 'multi_version_common_cartridge/writers/cartridge_writer'
+require 'multi_version_common_cartridge/writers/topic_writer'
 require 'multi_version_common_cartridge/writers/factory'
+

data/multi_version_common_cartridge.gemspec

@@ -13,15 +13,17 @@ Gem::Specification.new do |spec|
   spec.description = 'Target versions supported: 1.1, 1.2, 1.3; Thin 1.2, 1.3'
   spec.homepage = 'https://github.com/StrongMind/multi_version_common_cartridge'
 
+  spec.require_paths = ["lib"]
+
   spec.files = `git ls-files -z`.split("\x0").reject do |file|
     file.match(%r{^(test|spec|features)/})
   end
 
   spec.add_dependency 'activesupport', '> 2.0'
-  spec.add_dependency 'common_cartridge_parser', '~> 1.0'
+  spec.add_dependency 'common_cartridge_parser', '~> 1.0.9'
 
   spec.add_development_dependency 'rspec', '~> 3.8'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-rspec'
-  spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'simplecov', '~> 0.22'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strongmind_multi_version_common_cartridge
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - StrongMind
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-05 00:00:00.000000000 Z
+date: 2024-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.0.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.0.9
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.22'
 description: 'Target versions supported: 1.1, 1.2, 1.3; Thin 1.2, 1.3'
 email:
 - vendor@strongmind.com
@@ -112,14 +112,18 @@ files:
 - lib/multi_version_common_cartridge.rb
 - lib/multi_version_common_cartridge/cartridge.rb
 - lib/multi_version_common_cartridge/cartridge_versions.rb
+- lib/multi_version_common_cartridge/elements/canvas/assignment.rb
+- lib/multi_version_common_cartridge/elements/canvas/course_settings.rb
+- lib/multi_version_common_cartridge/elements/canvas/topic_meta.rb
+- lib/multi_version_common_cartridge/elements/topic.rb
 - lib/multi_version_common_cartridge/item.rb
 - lib/multi_version_common_cartridge/manifest.rb
 - lib/multi_version_common_cartridge/resources/basic_lti_link.rb
 - lib/multi_version_common_cartridge/resources/canvas_assignment.rb
 - lib/multi_version_common_cartridge/resources/canvas_course_settings.rb
-- lib/multi_version_common_cartridge/resources/canvas_elements/assignment.rb
-- lib/multi_version_common_cartridge/resources/canvas_elements/course_settings.rb
+- lib/multi_version_common_cartridge/resources/canvas_topic.rb
 - lib/multi_version_common_cartridge/resources/resource.rb
+- lib/multi_version_common_cartridge/resources/topic.rb
 - lib/multi_version_common_cartridge/sax_machine_nokogiri_xml_saver.rb
 - lib/multi_version_common_cartridge/version.rb
 - lib/multi_version_common_cartridge/writers/basic_lti_extension_writer.rb
@@ -127,6 +131,7 @@ files:
 - lib/multi_version_common_cartridge/writers/basic_lti_vendor_writer.rb
 - lib/multi_version_common_cartridge/writers/canvas_assignment_writer.rb
 - lib/multi_version_common_cartridge/writers/canvas_course_settings_writer.rb
+- lib/multi_version_common_cartridge/writers/canvas_topic_writer.rb
 - lib/multi_version_common_cartridge/writers/cartridge_writer.rb
 - lib/multi_version_common_cartridge/writers/factory.rb
 - lib/multi_version_common_cartridge/writers/item_writer.rb
@@ -136,12 +141,13 @@ files:
 - lib/multi_version_common_cartridge/writers/manifest_writer.rb
 - lib/multi_version_common_cartridge/writers/resource_writer.rb
 - lib/multi_version_common_cartridge/writers/supported_versions.rb
+- lib/multi_version_common_cartridge/writers/topic_writer.rb
 - lib/multi_version_common_cartridge/xml_definitions.rb
 - multi_version_common_cartridge.gemspec
 homepage: https://github.com/StrongMind/multi_version_common_cartridge
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -157,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.10
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Creates IMS Common Cartridge files, supporting several versions of the CC
   standard.

data/lib/multi_version_common_cartridge/resources/canvas_elements/assignment.rb

@@ -1,33 +0,0 @@
-module CanvasCartridge
-  module Elements
-    module Resources
-      module CanvasAssignment
-
-        class Assignment
-          include SAXMachine
-
-          attribute :xmlns
-          attribute 'xmlns:xsi', as: :xmlns_xsi
-          attribute :identifier, as: :identifier
-
-          element 'title', as: :title
-          element 'assignment_group_identifierref', as: :assignment_group_identifierref
-          element 'points_possible', as: :points_possible
-          element 'max_attempts', as: :max_attempts
-          element 'allowed_attempts', as: :allowed_attempts
-          element 'is_end_of_module_exam', as: :is_end_of_module_exam
-          element 'grading_type', as: :grading_type
-          element 'submission_types', as: :submission_types
-          element 'peer_review_count', as: :peer_review_count
-          element 'external_tool_url', as: :external_tool_url
-
-          def self.type
-            :canvas_assignment
-          end
-
-          def self.pattern; end
-        end
-      end
-    end
-  end
-end

data/lib/multi_version_common_cartridge/resources/canvas_elements/course_settings.rb

@@ -1,111 +0,0 @@
-module CanvasCartridge
-  module Elements
-    module Resources
-      module CourseSettings
-
-        class CourseSettings
-          include SAXMachine
-
-          attribute :identifier
-
-          attribute :xmlns
-          attribute 'xmlns:xsi', as: :xmlns_xsi
-
-          element 'image_url', as: :image_url
-          element 'group_weighting_scheme', as: :group_weighting_scheme
-
-          def self.type
-            :course_settings
-          end
-
-          def self.pattern; end
-        end
-
-        class AssignmentGroup
-          include SAXMachine
-
-          attribute :identifier
-
-          element 'title', as: :title
-          element 'position', as: :position
-          element 'group_weight', as: :group_weight
-
-        end
-
-        class AssignmentGroups
-          include SAXMachine
-
-          attribute :xmlns
-          attribute 'xmlns:xsi', as: :xmlns_xsi
-
-          elements 'assignmentGroup', class: AssignmentGroup, as: :groups
-        end
-
-        class Prerequisite
-          include SAXMachine
-          attribute :type
-          element :title
-          element :identifierref
-        end
-
-        class Prerequisites
-          include SAXMachine
-
-          elements :prerequisite, as: :prerequisites, class: Prerequisite
-        end
-
-        class Item
-          include SAXMachine
-          attribute :identifier, as: :identifier
-          element :title
-          element :workflow_state
-          element :content_type
-          element :identifierref
-          element :url
-          element :position
-          element :indent
-          element :global_identifierref
-        end
-
-        class Items
-          include SAXMachine
-
-          elements :item, as: :items, class: Item
-        end
-
-        class CompletionRequirement
-          include SAXMachine
-          attribute :type
-          element :identifierref
-        end
-
-        class CompletionRequirements
-          include SAXMachine
-
-          elements :completionRequirement, as: :completion_requirements, class: CompletionRequirement
-        end
-
-        class Module
-          include SAXMachine
-          attribute :identifier
-          element :title
-          element :workflow_state
-          element :position
-          element :require_sequential_progress
-          element :requirement_count
-          element :prerequisites, as: :root_prerequisites, class: Prerequisites
-          element :items, as: :root_items, class: Items
-          element :completionRequirements, as: :root_requirements, class: CompletionRequirements
-        end
-
-        class Modules
-          include SAXMachine
-
-          attribute :xmlns
-          attribute 'xmlns:xsi', as: :xmlns_xsi
-          elements :module, as: :modules, class: Module
-        end
-      end
-    end
-  end
-end