moodle2cc 0.1.12 → 0.2.0

data/lib/moodle2cc/canvas_cc/course_setting_writer.rb

@@ -0,0 +1,35 @@
+module Moodle2CC::CanvasCC
+  class CourseSettingWriter
+
+    SETTINGS_POSTFIX = '_settings'
+    COURSE_SETTINGS_FILE = 'course_settings.xml'
+
+    def initialize(work_dir, course)
+      @work_dir = work_dir
+      @course = course
+    end
+
+    def write
+      xml = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+        course(xml) do |xml|
+          @course.settings.each { |k, v| xml.send(k, v) }
+        end
+      end.to_xml
+      File.open(File.join(@work_dir, Moodle2CC::CanvasCC::CartridgeCreator::COURSE_SETTINGS_DIR, COURSE_SETTINGS_FILE), 'w') { |f| f.write(xml) }
+    end
+
+    private
+
+    def course(xml)
+      xml.course(
+        'identifier' => @course.identifier + SETTINGS_POSTFIX,
+        'xmlns' => 'http://canvas.instructure.com/xsd/cccv1p0',
+        'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+        'xsi:schemaLocation' => 'http://canvas.instructure.com/xsd/cccv1p0 http://canvas.instructure.com/xsd/cccv1p0.xsd'
+      ) {
+        yield xml
+      }
+    end
+
+  end
+end

data/lib/moodle2cc/canvas_cc/discussion_writer.rb

@@ -0,0 +1,51 @@
+module Moodle2CC::CanvasCC
+  class DiscussionWriter
+
+    def initialize(work_dir, *canvas_discussions)
+      @work_dir = work_dir
+      @discussions = canvas_discussions
+    end
+
+    def write
+      @discussions.each do |discussion|
+        write_discussion(discussion)
+        write_meta(discussion)
+      end
+    end
+
+
+    private
+
+    def write_discussion(discussion)
+      xml = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+        xml.topic('xmlns' => 'http://www.imsglobal.org/xsd/imsccv1p1/imsdt_v1p1',
+                  'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+                  'xsi:schemaLocation' => 'http://www.imsglobal.org/xsd/imsccv1p1/imsdt_v1p1  http://www.imsglobal.org/profile/cc/ccv1p1/ccv1p1_imsdt_v1p1.xsd'
+        ) { |xml|
+          xml.title discussion.title
+          xml.text_('texttype' => 'text/html') { xml.text discussion.text }
+        }
+      end.to_xml
+      File.open(File.join(@work_dir, discussion.discussion_resource.files.first), 'w') { |f| f.write(xml) }
+    end
+
+    def write_meta(discussion)
+      meta_resource = discussion.meta_resource
+      discussion_resource = discussion.discussion_resource
+      xml = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+        xml.topicMeta('identifier' => meta_resource.identifier, 'xmlns' => 'http://canvas.instructure.com/xsd/cccv1p0',
+                      'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+                      'xsi:schemaLocation' => 'http://canvas.instructure.com/xsd/cccv1p0 http://canvas.instructure.com/xsd/cccv1p0.xsd'
+        ) { |xml|
+          xml.topic_id discussion_resource.identifier
+          xml.title discussion.title
+          xml.position
+          xml.type 'topic'
+          xml.discussion_type discussion.discussion_type
+        }
+      end.to_xml
+      File.open(File.join(@work_dir, meta_resource.href), 'w') { |f| f.write(xml) }
+    end
+
+  end
+end

data/lib/moodle2cc/canvas_cc/essay_question_writer.rb

@@ -0,0 +1,19 @@
+module Moodle2CC::CanvasCC
+  class EssayQuestionWriter < QuestionWriter
+    register_writer_type 'essay_question'
+
+    private
+
+    def self.write_responses(presentation_node, question)
+      ShortAnswerQuestionWriter.write_responses(presentation_node, question)
+    end
+
+    def self.write_response_conditions(processing_node, question)
+      processing_node.respcondition(:continue => 'No') do |condition|
+        condition.conditionvar do |var_node|
+          var_node.other
+        end
+      end
+    end
+  end
+end

data/lib/moodle2cc/canvas_cc/file_meta_writer.rb

@@ -0,0 +1,38 @@
+module Moodle2CC::CanvasCC
+  class FileMetaWriter
+
+    FILE_META_FILE = 'files_meta.xml'
+
+    def initialize(work_dir, *canvas_files)
+      @work_dir = work_dir
+      @canvas_files = canvas_files
+    end
+
+    def write
+      copy_files
+      write_xml
+    end
+
+    private
+
+    def copy_files
+
+      @canvas_files.each do |canvas_file|
+        FileUtils.mkdir_p(File.dirname(File.join(@work_dir, canvas_file.href)))
+        FileUtils.cp(canvas_file.file_location, File.join(@work_dir, canvas_file.href))
+      end
+    end
+
+    def write_xml
+      xml = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+        xml.fileMeta(
+          'xmlns' => 'http://canvas.instructure.com/xsd/cccv1p0',
+          'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+          'xsi:schemaLocation' => 'http://canvas.instructure.com/xsd/cccv1p0 http://canvas.instructure.com/xsd/cccv1p0.xsd'
+        )
+      end.to_xml
+      File.open(File.join(@work_dir, Moodle2CC::CanvasCC::CartridgeCreator::COURSE_SETTINGS_DIR, FILE_META_FILE), 'w') { |f| f.write(xml) }
+    end
+
+  end
+end

data/lib/moodle2cc/canvas_cc/ims_manifest_generator.rb

@@ -0,0 +1,123 @@
+module Moodle2CC::CanvasCC
+  class ImsManifestGenerator
+
+    MANIFEST_FILE_NAME = 'imsmanifest.xml'
+    SCHEMA = 'IMS Common Cartridge'
+    SCHEMA_VERSION = '1.1.0'
+    LOMIMSCC = 'lomimscc'
+    SETTINGS_POSTFIX = '_settings'
+    TYPE_LAR = 'associatedcontent/imscc_xmlv1p1/learning-application-resource'
+    CANVAS_EXPORT_PATH = 'course_settings/canvas_export.txt'
+    ALL_MODULES_IDENTIFIER = 'LearningModules'
+
+    def initialize(work_dir, course)
+      @work_dir = work_dir
+      @course = course
+    end
+
+    def write
+      xml = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+        manifest(xml) do |xml|
+          metadata(xml)
+          organizations(xml)
+          resources(xml, @course.all_resources)
+        end
+      end.to_xml
+      File.open(File.join(@work_dir, MANIFEST_FILE_NAME), 'w') { |f| f.write(xml) }
+    end
+
+    private
+
+    def manifest(xml)
+      xml.manifest(
+          "identifier" => @course.identifier,
+          "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",
+          "xsi:schemaLocation" => "http://www.imsglobal.org/xsd/imsccv1p1/imscp_v1p1 http://www.imsglobal.org/profile/cc/ccv1p1/ccv1p1_imscp_v1p2_v1p0.xsd http://ltsc.ieee.org/xsd/imsccv1p1/LOM/resource http://www.imsglobal.org/profile/cc/ccv1p1/LOM/ccv1p1_lomresource_v1p0.xsd http://ltsc.ieee.org/xsd/imsccv1p1/LOM/manifest http://www.imsglobal.org/profile/cc/ccv1p1/LOM/ccv1p1_lommanifest_v1p0.xsd"
+      ) {
+        yield xml
+      }
+    end
+
+    def metadata(xml)
+      xml.metadata {
+        xml.schema SCHEMA
+        xml.schemaversion SCHEMA_VERSION
+        ns = LOMIMSCC
+        xml[ns].lom {
+          xml[ns].general {
+            xml[ns].title {
+              xml[ns].string @course.title
+            }
+          }
+          rights(xml)
+        }
+      }
+    end
+
+    def rights(xml)
+      ns = LOMIMSCC
+      has_copyright = @course.copyright && !@course.copyright.empty?
+      xml[ns].rights {
+        xml[ns].copyrightAndOtherRestrictions {
+          xml[ns].value has_copyright ? 'yes' : 'no'
+        }
+        if has_copyright
+          xml[ns].description {
+            xml[ns].string @course.copyright
+          }
+        end
+      }
+    end
+
+
+    def organizations(xml)
+      canvas_modules = @course.canvas_modules
+      xml.organizations { |xml|
+        if canvas_modules.count > 0
+          xml.organization('identifier' => 'org_1', 'structure' => 'rooted-hierarchy') { |xml|
+            xml.item('identifier' => ALL_MODULES_IDENTIFIER) do |xml|
+              canvas_modules.each do |mod|
+                xml.item('identifier' => mod.identifier) { |xml|
+                  xml.title mod.title
+                  mod.module_items.each do |module_item|
+                    xml.item('identifier' => module_item.identifier, 'identifierref' => module_item.identifierref ) { |xml|
+                      xml.title(module_item.title)
+                    }
+                  end
+                }
+              end
+            end
+          }
+        end
+      }
+    end
+
+    def resources(xml, resources)
+      xml.resources { |xml|
+        course_setting_resource(xml)
+        resources.each do |resource|
+          xml.resource(resource.attributes) do |xml|
+            resource.files.each { |file| xml.file(href: file) }
+            resource.dependencies.each { |dependency| xml.dependency(identifierref: dependency) }
+          end
+        end
+      }
+    end
+
+    def course_setting_resource(xml)
+      course_setting_dir = Moodle2CC::CanvasCC::CartridgeCreator::COURSE_SETTINGS_DIR
+      export_file = File.join(course_setting_dir, Moodle2CC::CanvasCC::CanvasExportWriter::CANVAS_EXPORT_FILE)
+      course_setting_file = File.join(course_setting_dir, Moodle2CC::CanvasCC::CourseSettingWriter::COURSE_SETTINGS_FILE)
+      module_meta_file = File.join(course_setting_dir, Moodle2CC::CanvasCC::ModuleMetaWriter::MODULE_META_FILE)
+      xml.resource('identifier' => @course.identifier + SETTINGS_POSTFIX, 'type' => TYPE_LAR, 'href' => export_file) { |xml|
+        xml.file('href' => course_setting_file)
+        xml.file('href' => module_meta_file) if @course.canvas_modules.count > 0
+      }
+    end
+
+
+  end
+end

data/lib/moodle2cc/canvas_cc/matching_question_writer.rb

@@ -0,0 +1,41 @@
+module Moodle2CC::CanvasCC
+  class MatchingQuestionWriter < QuestionWriter
+    register_writer_type 'matching_question'
+
+    private
+
+    def self.write_responses(presentation_node, question)
+      question.matches.each do |match|
+        presentation_node.response_lid(:ident => "response_#{match[:id]}") do |response_node|
+          response_node.material do |material_node|
+            material_node.mattext(match[:question_text], :texttype => 'text/html')
+          end
+          response_node.render_choice do |choice_node|
+            question.matches.each do |possible_match|
+              choice_node.response_label(:ident => possible_match[:id]) do |label_node|
+                label_node.material do |material_node|
+                  material_node.mattext possible_match[:answer_text]
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def self.write_response_conditions(processing_node, question)
+      score = 100.0 / question.matches.length.to_i
+      question.matches.each do |match|
+        processing_node.respcondition do |condition_node|
+          condition_node.conditionvar do |var_node|
+            var_node.varequal match[:id], :respident => "response_#{match[:id]}"
+          end
+          condition_node.setvar "%.2f" % score, :varname => 'SCORE', :action => 'Add'
+        end
+      end
+    end
+
+    def self.write_additional_nodes(item_node, question)
+    end
+  end
+end

data/lib/moodle2cc/canvas_cc/models/answer.rb

@@ -0,0 +1,12 @@
+module Moodle2CC::CanvasCC::Models
+  class Answer
+    attr_accessor :id, :answer_text, :answer_format, :fraction, :feedback, :feedback_format, :resp_ident
+
+    def initialize(answer=nil)
+      return unless answer
+      answer.instance_variables.each do |var|
+        self.instance_variable_set(var, answer.instance_variable_get(var))
+      end
+    end
+  end
+end

data/lib/moodle2cc/canvas_cc/models/assessment.rb

@@ -0,0 +1,68 @@
+module Moodle2CC::CanvasCC::Models
+  class Assessment
+    META_ATTRIBUTES = [:title, :description, :allowed_attempts,
+                       :scoring_policy, :access_code, :ip_filter, :shuffle_answers, :time_limit, :quiz_type]
+    DATETIME_ATTRIBUTES = [:lock_at, :unlock_at]
+
+    LAR_TYPE = 'associatedcontent/imscc_xmlv1p1/learning-application-resource'
+    ASSESSMENT_NON_CC_FOLDER = 'non_cc_assessments'
+
+    attr_accessor :identifier, :workflow_state, :question_references, :items, *META_ATTRIBUTES, *DATETIME_ATTRIBUTES
+
+    def initialize
+      @question_references = []
+    end
+
+    def resources
+      [assessment_resource]
+    end
+
+    def assessment_resource
+      resource = Moodle2CC::CanvasCC::Models::Resource.new
+      resource.identifier = @identifier
+      resource.href = meta_file_path
+      resource.type = LAR_TYPE
+      resource.files = [meta_file_path, qti_file_path]
+      resource
+    end
+
+    def meta_file_path
+      "#{@identifier}/assessment_meta.xml"
+    end
+
+    def qti_file_path
+      "#{ASSESSMENT_NON_CC_FOLDER}/#{@identifier}.xml.qti"
+    end
+
+    def resolve_question_references(question_banks)
+      @items ||= []
+      @question_references.each do |ref|
+        question = nil
+        group = nil
+        question_banks.each do |bank|
+          break if (question = bank.questions.detect{|q| q.identifier.to_s == ref[:question]}) ||
+            (group = bank.question_groups.detect{|g| g.identifier.to_s == ref[:question]})
+        end
+
+        if question
+          question.assessment_question_identifierref ||= "question_#{question.identifier}"
+          copy = question.dup
+          copy.points_possible = ref[:grade] if ref[:grade]
+          @items << copy
+        elsif group
+          copy = group.dup
+          if ref[:grade] && copy.selection_number.to_i != 0
+            copy.points_per_item = ref[:grade].to_f / copy.selection_number.to_i
+          end
+          @items << copy
+        end
+      end
+
+      @items.select{|i| i.is_a?(Moodle2CC::CanvasCC::Models::QuestionGroup)}.each do |group|
+        group.questions.each do |q|
+          @items.delete_if{|i| i.identifier.to_s == q.identifier}
+        end
+      end
+    end
+  end
+end

data/lib/moodle2cc/canvas_cc/models/assignment.rb

@@ -0,0 +1,30 @@
+module Moodle2CC::CanvasCC::Models
+  class Assignment
+    attr_accessor :identifier, :title, :body, :due_at, :lock_at, :unlock_at, :all_day_date, :peer_reviews_due_at,
+                  :assignment_group_identifier_ref, :workflow_state, :points_possible, :grading_type, :all_day,
+                  :submission_types, :position, :peer_review_count, :peer_reviews_assigned, :peer_reviews,
+                  :automatic_peer_reviews, :grade_group_students_individually
+
+    LAR_TYPE = 'associatedcontent/imscc_xmlv1p1/learning-application-resource'
+    ASSIGNMENT_SETTINGS_FILE = 'assignment_settings.xml'
+
+    def initialize
+      @submission_types = []
+    end
+
+    def resources
+      [assignment_resource]
+    end
+
+    def assignment_resource
+      resource = Moodle2CC::CanvasCC::Models::Resource.new
+      resource.identifier = @identifier
+      resource.href = "#{resource.identifier}/assignment-#{title.downcase.gsub(/\s/, '-')}.html"
+      resource.type = LAR_TYPE
+      resource.files = [resource.href, "#{resource.identifier}/#{ASSIGNMENT_SETTINGS_FILE}"]
+
+      resource
+    end
+
+  end
+end

data/lib/moodle2cc/canvas_cc/models/calculated_question.rb

@@ -0,0 +1,7 @@
+module Moodle2CC::CanvasCC::Models
+  class CalculatedQuestion < Question
+    register_question_type 'calculated_question'
+
+    attr_accessor :correct_answer_format, :correct_answer_length, :dataset_definitions, :tolerance
+  end
+end

data/lib/moodle2cc/canvas_cc/models/canvas_file.rb

@@ -0,0 +1,22 @@
+module Moodle2CC::CanvasCC::Models
+  class CanvasFile < Moodle2CC::CanvasCC::Models::Resource
+
+    WEB_RESOURCES = 'web_resources'
+
+    attr_reader :file_path
+    attr_accessor :file_location
+
+    def initialize
+      super
+      @type = WEB_CONTENT_TYPE
+    end
+
+    def file_path=(file_path)
+      @href = File.join(WEB_RESOURCES, file_path)
+      @files << self.href
+      @file_path = file_path
+    end
+
+
+  end
+end