common_cartridge 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5b2481f5a5f1ba164d5ca9a60fea3847c18035b
+  data.tar.gz: e8efc878e6554217fa1d79dbec768cdf6a0d07fd
+SHA512:
+  metadata.gz: d41a9f3fb2ad06e4c876c8798b650798efec9b3553a48d0e288b552a1692970ed674c3d330eb0b5837ddc6475902e86e62e5a0586eeeb9178fe4520c0395d2e3
+  data.tar.gz: 1877b1fbb6d429054fc8f86f4555d5dd7bcc81f6092c6253bf21d3ae00755b59c8bba9e23918118f03b12af1796c039e38c8a8163f5f20b0e3c2f74a35340003

data/lib/common_cartridge.rb

@@ -0,0 +1,40 @@
+require 'sax-machine'
+require 'sax_machine/sax_handler'
+
+module CommonCartridge
+  def self.parse_from_zip(zipfile)
+    parser = Parsers::Parser.new(zipfile)
+    package = parser.parse
+    package
+  end
+
+  # todo: methods to detect version and inject resultant namespace
+
+  # Configuration
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure
+    self.config ||= Config.new
+    yield(config)
+  end
+
+  class Config
+    attr_accessor :import_directory, :export_directory
+
+    def initialize
+      @import_directory = '.'
+      @export_directory = '/tmp'
+    end
+  end
+end
+
+require 'common_cartridge/elements/lom'
+require 'common_cartridge/elements/metadata'
+require 'common_cartridge/elements/organizations'
+require 'common_cartridge/elements/resources'
+require 'common_cartridge/elements/outcomes'
+require 'common_cartridge/elements/manifest'
+require 'common_cartridge/package'
+require 'common_cartridge/parsers/parser'

data/lib/common_cartridge/elements/lom.rb

@@ -0,0 +1,60 @@
+module CommonCartridge
+  module Elements
+    module Lom
+      class Title
+        include SAXMachine
+
+        element :string, as: :value
+        element :string, value: :language, as: :language
+
+        def to_s; string; end
+      end
+
+      class Description
+        include SAXMachine
+
+        element :string, as: :value
+        element :string, value: :language, as: :language
+
+        def to_s; string; end
+      end
+
+      class Keyword
+        include SAXMachine
+
+        element :string, as: :value
+        element :string, value: :language, as: :language
+
+        def to_s; string; end
+      end
+
+      class CopyrightAndOtherRestrictions
+        include SAXMachine
+
+        element :value
+      end
+
+      class Rights
+        include SAXMachine
+
+        element :description, class: CommonCartridge::Elements::Lom::Description
+        element :copyrightAndOtherRestrictions, class: CommonCartridge::Elements::Lom::CopyrightAndOtherRestrictions
+      end
+
+      class General
+        include SAXMachine
+
+        element :title, class: CommonCartridge::Elements::Lom::Title
+        element :description, class: CommonCartridge::Elements::Lom::Description
+        elements :keyword, as: :keywords, class: CommonCartridge::Elements::Lom::Keyword
+      end
+
+      class Lom
+        include SAXMachine
+
+        element :general, class: CommonCartridge::Elements::Lom::General
+        element :rights, class: CommonCartridge::Elements::Lom::Rights
+      end
+    end
+  end
+end

data/lib/common_cartridge/elements/manifest.rb

@@ -0,0 +1,24 @@
+module CommonCartridge
+  module Elements
+    class Manifest
+      include SAXMachine
+
+      element :metadata, class: CommonCartridge::Elements::Metadata
+      element :organizations, class: CommonCartridge::Elements::Organizations::RootOrganization, as: :root_organization
+      element :resources, class: CommonCartridge::Elements::Resources::RootResource, as: :root_resource
+
+      def organizations
+        root_organization.organizations
+      end
+
+      def resources
+        root_resource.resources
+      end
+
+      def organization
+        organizations.first
+      end
+
+    end
+  end
+end

data/lib/common_cartridge/elements/metadata.rb

@@ -0,0 +1,12 @@
+module CommonCartridge
+  module Elements
+    class Metadata
+      include SAXMachine
+
+      element :schema
+      element :schemaversion
+
+      element :lom, class: CommonCartridge::Elements::Lom::Lom
+    end
+  end
+end

data/lib/common_cartridge/elements/organizations.rb

@@ -0,0 +1,42 @@
+module CommonCartridge
+  module Elements
+    module Organizations
+      class Item
+        attr_accessor :type
+
+        include SAXMachine
+
+        attribute :identifier
+        attribute :identifierref
+        element :title
+
+        elements :item, class: self, as: :items
+      end
+
+      class RootItem
+        include SAXMachine
+
+        attribute :identifier
+        attribute :identifierref
+
+        elements :item, class: Item, as: :items
+
+        # todo: implement 'find_by' method here to quickly scan for particular items
+      end
+
+      class Organization
+        include SAXMachine
+
+        attribute :identifier
+        attribute :structure
+        element :item, class: RootItem, as: :root_item
+      end
+
+      class RootOrganization
+        include SAXMachine
+
+        elements :organization, class: Organization, as: :organizations
+      end
+    end
+  end
+end

data/lib/common_cartridge/elements/outcomes.rb

@@ -0,0 +1,10 @@
+require 'common_cartridge/elements/outcomes/outcome'
+require 'common_cartridge/elements/outcomes/outcome_group'
+require 'common_cartridge/elements/outcomes/outcome_root'
+module CommonCartridge
+  module Elements
+    module Outcomes
+    end
+  end
+end
+

data/lib/common_cartridge/elements/outcomes/outcome.rb

@@ -0,0 +1,15 @@
+module CommonCartridge
+  module Elements
+    module Outcomes
+      class Outcome
+        include SAXMachine
+
+        attribute :identifier
+
+        element :title
+        element :points_possible
+        element :mastery_points
+      end
+    end
+  end
+end

data/lib/common_cartridge/elements/outcomes/outcome_group.rb

@@ -0,0 +1,12 @@
+module CommonCartridge
+  module Elements
+    module Outcomes
+      class OutcomeGroup
+        include SAXMachine
+
+        attribute :identifier
+        elements 'learningOutcome', as: :outcomes, class: Outcome
+      end
+    end
+  end
+end

data/lib/common_cartridge/elements/outcomes/outcome_root.rb

@@ -0,0 +1,11 @@
+module CommonCartridge
+  module Elements
+    module Outcomes
+      class OutcomeRoot
+        include SAXMachine
+
+        elements 'learningOutcomeGroup', as: :outcome_groups, class: OutcomeGroup
+      end
+    end
+  end
+end

data/lib/common_cartridge/elements/resources.rb

@@ -0,0 +1,117 @@
+require 'common_cartridge/elements/resources/attachments'
+require 'common_cartridge/elements/resources/web_link'
+require 'common_cartridge/elements/resources/topic'
+require 'common_cartridge/elements/resources/assignment'
+require 'common_cartridge/elements/resources/assessment'
+require 'common_cartridge/elements/resources/page'
+
+module CommonCartridge
+  module Elements
+    module Resources
+
+    def self.type_mappings
+      {
+       Topic.pattern => Topic,
+       WebLink.pattern =>  WebLink,
+       Assignment.pattern => Assignment,
+       Assessment.pattern => Assessment,
+       Page.pattern => Page
+      }
+    end
+
+
+      class Content
+        include SAXMachine
+
+        element :title
+        element :points_possible
+        element :type
+      end
+
+      class Dependency
+        attr_writer :contents
+
+        include SAXMachine
+        attribute :identifierref
+
+        def contents
+          @contents ||= []
+        end
+
+        def title
+          if c = contents.detect { |content| !content.title.to_s.empty? }
+            return c.title
+          end
+        end
+
+        def points_possible
+          if c = contents.detect { |content| !content.points_possible.to_s.empty? }
+            return c.points_possible
+          end
+        end
+      end
+
+      class File
+        attr_accessor :content
+
+        include SAXMachine
+        attribute :href
+        element :attachments, class: Attachments::RootAttachment, as: :attachment_root
+        elements :dependency, class: Dependency, as: :dependencies
+
+        def attachments; attachment_root.attachments; end
+      end
+
+      class Resource
+        attr_accessor :question_count
+        attr_writer :title, :points_possible
+
+        include SAXMachine
+        attribute :identifier
+        attribute :type
+        attribute :href
+        attribute :intendeduse
+
+        elements :file, class: File, as: :files
+        elements :dependency, class: Dependency, as: :dependencies
+
+
+        # Switch statement based on 'type'
+        def points_possible
+          @points_possible ||= if dependency = dependencies.detect { |d| d.points_possible && !d.points_possible.empty? }
+            dependency.points_possible
+          end
+        end
+
+        def title
+          @title ||= if file = files.detect { |f| f.content && f.content.title && !f.content.title.empty? }
+                       file.content.title
+                     elsif dependency = dependencies.detect { |d| d.title && !d.title.empty? }
+                       dependency.title
+                     end
+        end
+
+        def file_locations
+          [
+            ::File.join(identifier, "assessment.xml"),
+            ::File.join(identifier, "assessment_qti.xml"),
+            ::File.join("non_cc_assessments", "#{identifier}.xml"),
+            ::File.join("non_cc_assessments", "#{identifier}.xml.qti")
+          ]
+        end
+
+        def is_announcement?
+          !!dependencies.collect(&:contents).flatten.detect { |c| c.type == 'announcement' }
+        end
+      end
+
+      class RootResource
+        include SAXMachine
+
+        elements :resource, class: Resource, as: :resources
+
+      end
+
+    end
+  end
+end

data/lib/common_cartridge/elements/resources/assessment.rb

@@ -0,0 +1,21 @@
+module CommonCartridge
+  module Elements
+    module Resources
+      class Assessment
+        attr_accessor :title, :identifier
+
+        include SAXMachine
+
+        element :points_possible
+
+        def self.type
+          :quiz
+        end
+
+        def self.pattern
+          /assessment|quiz/
+        end
+      end
+    end
+  end
+end

data/lib/common_cartridge/elements/resources/assignment.rb

@@ -0,0 +1,59 @@
+module CommonCartridge
+  module Elements
+    module Resources
+      class Format
+        include SAXMachine
+
+        attribute :type
+      end
+
+      class SubmissionFormats
+        include SAXMachine
+
+        elements :format, class: Format, as: :formats
+      end
+
+      class Text
+        include SAXMachine
+
+        attribute :href
+        attribute :texttype, as: :text_type
+        value :value
+      end
+
+      class InstructorText
+        include SAXMachine
+
+        attribute :href
+        attribute :texttype, as: :text_type
+        value :value
+      end
+
+      class Assignment
+        attr_accessor :identifier, :points_possible
+
+        include SAXMachine
+
+        element :title
+        element :text, class: Text
+        element :instructor_text, class: InstructorText
+        element :gradable
+
+        element :submission_formats, class: SubmissionFormats
+        element :attachments, class: CommonCartridge::Elements::Resources::Attachments::RootAttachment, as: :attachment_root
+
+        def attachments
+          attachment_root.attachments
+        end
+
+        def self.type
+          :assignment
+        end
+
+        def self.pattern
+          /assignment|associatedcontent\/imscc_xmlv1p1\/learning\-application\-resource/
+        end
+      end
+    end
+  end
+end