moodle2cc 0.0.1

data/README.md

@@ -0,0 +1,38 @@
+# Moodle2CC
+
+moodle2cc will convert Moodle 1.9 backup files into IMS Common Cartridge
+formatted files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'moodle2cc'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install moodle2cc
+
+## Usage
+
+    For Common Cartridge format
+    $ moodle2cc migrate <path-to-moodle-backup> <path-to-cc-export-directory>
+
+    For Canvas Common Cartridge format
+    $ moodle2cc migrate --format=canvas <path-to-moodle-backup> <path-to-cc-export-directory>
+
+## Contributing
+
+Run the tests:
+
+    $ bundle exec rake
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end
+
+task :default => :test

data/bin/moodle2cc

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'moodle2cc'
+require 'moodle2cc/cli'
+
+Moodle2CC::CLI.start

data/lib/moodle2cc.rb

@@ -0,0 +1,60 @@
+require 'uri'
+require 'cgi'
+require 'ostruct'
+require 'fileutils'
+require 'erb'
+require 'happymapper'
+require 'builder'
+require 'nokogiri'
+
+require 'moodle2cc/error'
+require 'moodle2cc/migrator'
+
+module Moodle2CC
+  class OpenStruct < ::OpenStruct
+    if defined? id
+      undef id
+    end
+  end
+
+  autoload :ResourceFactory, 'moodle2cc/resource_factory'
+
+  module CC
+    autoload :Assessment, 'moodle2cc/cc/assessment'
+    autoload :Assignment, 'moodle2cc/cc/assignment'
+    autoload :CCHelper, 'moodle2cc/cc/cc_helper'
+    autoload :Converter, 'moodle2cc/cc/converter'
+    autoload :Course, 'moodle2cc/cc/course'
+    autoload :DiscussionTopic, 'moodle2cc/cc/discussion_topic'
+    autoload :Label, 'moodle2cc/cc/label'
+    autoload :Question, 'moodle2cc/cc/question'
+    autoload :Resource, 'moodle2cc/cc/resource'
+    autoload :WebContent, 'moodle2cc/cc/web_content'
+    autoload :WebLink, 'moodle2cc/cc/web_link'
+    autoload :Wiki, 'moodle2cc/cc/wiki'
+  end
+  module Canvas
+    autoload :Assessment, 'moodle2cc/canvas/assessment'
+    autoload :Assignment, 'moodle2cc/canvas/assignment'
+    autoload :Converter, 'moodle2cc/canvas/converter'
+    autoload :Course, 'moodle2cc/canvas/course'
+    autoload :DiscussionTopic, 'moodle2cc/canvas/discussion_topic'
+    autoload :Label, 'moodle2cc/canvas/label'
+    autoload :Question, 'moodle2cc/canvas/question'
+    autoload :QuestionBank, 'moodle2cc/canvas/question_bank'
+    autoload :Resource, 'moodle2cc/canvas/resource'
+    autoload :WebContent, 'moodle2cc/canvas/web_content'
+    autoload :WebLink, 'moodle2cc/canvas/web_link'
+    autoload :Wiki, 'moodle2cc/canvas/wiki'
+  end
+  module Moodle
+    autoload :Backup, 'moodle2cc/moodle/backup'
+    autoload :Course, 'moodle2cc/moodle/course'
+    autoload :GradeItem, 'moodle2cc/moodle/grade_item'
+    autoload :Info, 'moodle2cc/moodle/info'
+    autoload :Mod, 'moodle2cc/moodle/mod'
+    autoload :Question, 'moodle2cc/moodle/question'
+    autoload :QuestionCategory, 'moodle2cc/moodle/question_category'
+    autoload :Section, 'moodle2cc/moodle/section'
+  end
+end

data/lib/moodle2cc/canvas/assessment.rb

@@ -0,0 +1,109 @@
+module Moodle2CC::Canvas
+  class Assessment < Moodle2CC::CC::Assessment
+    include Resource
+    META_ATTRIBUTES = [:title, :description, :lock_at, :unlock_at, :allowed_attempts,
+      :scoring_policy, :access_code, :ip_filter, :shuffle_answers, :time_limit, :quiz_type]
+
+    attr_accessor :non_cc_assessments_identifier, *META_ATTRIBUTES
+
+    def initialize(mod, position=0)
+      super
+      description = [mod.intro, mod.content, mod.text, mod.summary].compact.reject { |d| d.length == 0 }.first || ''
+      @description = convert_file_path_tokens(description)
+      if mod.time_close.to_i > 0
+        @lock_at = ims_datetime(Time.at(mod.time_close))
+      end
+      if mod.time_open.to_i > 0
+        @unlock_at = ims_datetime(Time.at(mod.time_open))
+      end
+      @time_limit = mod.time_limit
+      @allowed_attempts = mod.attempts_number
+      @scoring_policy = mod.grade_method == 4 ? 'keep_latest' : 'keep_highest'
+      @access_code = mod.password
+      @ip_filter = mod.subnet
+      @shuffle_answers = mod.shuffle_answers
+      @quiz_type = mod.mod_type == 'quiz' ? 'practice_quiz' : 'survey'
+      @non_cc_assessments_identifier = create_key(@id, 'non_cc_assessments_')
+    end
+
+    def create_resource_node(resources_node)
+      super
+
+      href = File.join(identifier, ASSESSMENT_META)
+      resources_node.resource(
+        :href => href,
+        :type => LOR,
+        :identifier => non_cc_assessments_identifier
+      ) do |resource_node|
+        resource_node.file(:href => href)
+        resource_node.file(:href => File.join(ASSESSMENT_NON_CC_FOLDER, "#{identifier}.xml.qti"))
+      end
+    end
+
+    def create_resource_sub_nodes(resource_node)
+      resource_node.dependency :identifierref => non_cc_assessments_identifier
+    end
+
+    def create_files(export_dir)
+      create_assessment_meta_xml(export_dir)
+      create_non_cc_qti_xml(export_dir)
+    end
+
+    def create_assessment_meta_xml(export_dir)
+      path = File.join(export_dir, identifier, ASSESSMENT_META)
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'w') do |file|
+        node = Builder::XmlMarkup.new(:target => file, :indent => 2)
+        node.instruct!
+        node.quiz(
+          :identifier => identifier,
+          'xsi:schemaLocation' => "http://canvas.instructure.com/xsd/cccv1p0 http://canvas.instructure.com/xsd/cccv1p0.xsd",
+          'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
+          'xmlns' => "http://canvas.instructure.com/xsd/cccv1p0"
+        ) do |quiz_node|
+          META_ATTRIBUTES.each do |attr|
+            quiz_node.tag!(attr, send(attr)) unless send(attr).nil?
+          end
+        end
+      end
+    end
+
+    def create_non_cc_qti_xml(export_dir)
+      path = File.join(export_dir, ASSESSMENT_NON_CC_FOLDER, "#{identifier}.xml.qti")
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'w') do |file|
+        node = Builder::XmlMarkup.new(:target => file, :indent => 2)
+        node.instruct!
+        node.questestinterop(
+          'xsi:schemaLocation' => "http://www.imsglobal.org/xsd/ims_qtiasiv1p2 http://www.imsglobal.org/xsd/ims_qtiasiv1p2p1.xsd",
+          'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
+          'xmlns' => "http://www.imsglobal.org/xsd/ims_qtiasiv1p2"
+        ) do |root_node|
+          root_node.assessment(:title => title, :ident => identifier) do |assessment_node|
+            assessment_node.qtimetadata do |qtimetadata_node|
+              qtimetadata_node.qtimetadatafield do |qtimetadatafield_node|
+                qtimetadatafield_node.fieldlabel "qmd_timelimit"
+                qtimetadatafield_node.fieldentry time_limit
+              end
+              qtimetadata_node.qtimetadatafield do |qtimetadatafield_node|
+                qtimetadatafield_node.fieldlabel "cc_maxattempts"
+                qtimetadatafield_node.fieldentry allowed_attempts
+              end
+            end
+            assessment_node.section(:ident => 'root_section') do |section_node|
+              @mod.questions.each do |question|
+                question = Question.new question, self
+                question.create_item_xml(section_node)
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def create_module_meta_item_elements(item_node)
+      item_node.content_type 'Quiz'
+      item_node.identifierref @identifier
+    end
+  end
+end

data/lib/moodle2cc/canvas/assignment.rb

@@ -0,0 +1,108 @@
+module Moodle2CC::Canvas
+  class Assignment < Moodle2CC::CC::Assignment
+    include Resource
+    SETTINGS_ATTRIBUTES = [:title, :points_possible, :grading_type, :due_at,
+      :lock_at, :unlock_at, :all_day, :all_day_date, :submission_types,
+      :position, :peer_reviews, :automatic_peer_reviews, :peer_review_count,
+      :anonymous_peer_reviews, :assignment_group_identifierref]
+
+    attr_accessor *SETTINGS_ATTRIBUTES
+
+    def initialize(mod, position=0)
+      super
+      @body = convert_file_path_tokens(mod.description)
+      @points_possible = mod.grade_item ? mod.grade_item.grade_max : mod.grade
+      @grading_type = 'points'
+      if mod.time_due.to_i > 0
+        @due_at = ims_datetime(Time.at(mod.time_due))
+        @all_day = Time.at(mod.time_due).utc.strftime('%H:%M') == '23:59' ? true : false
+        if @all_day
+          @all_day_date = ims_date(Time.at(mod.time_due))
+        end
+        if mod.prevent_late
+          @lock_at = @due_at
+        end
+      end
+      if mod.time_available.to_i > 0
+        @unlock_at = ims_datetime(Time.at(mod.time_available))
+      end
+      if mod.submission_end.to_i > 0
+        @due_at = ims_datetime(Time.at(mod.submission_end))
+      end
+      @submission_types = get_submission_types(mod)
+      @position = position
+      @peer_reviews = @automatic_peer_reviews = mod.mod_type == 'workshop'
+      @peer_review_count = mod.number_of_student_assessments
+      @anonymous_peer_reviews = mod.anonymous
+      @assignment_group_identifierref = create_key(mod.section_mod.section.id, 'assignment_group_')
+    end
+
+    def get_submission_types(mod)
+      if mod.mod_type == 'assignment'
+        case mod.assignment_type
+        when 'online'
+          'online_text_entry'
+        when 'upload'
+          if mod.var2 == 1
+            'online_upload,online_text_entry'
+          else
+            'online_upload'
+          end
+        when 'uploadsingle'
+          'online_upload'
+        else
+          'none'
+        end
+      elsif mod.mod_type == 'workshop'
+        submission_types = ['online_text_entry']
+        submission_types.unshift('online_upload') if mod.number_of_attachments > 0
+        submission_types.join(',')
+      end
+    end
+
+    def create_resource_node(resources_node)
+      href = "#{identifier}/#{file_slug(@title)}.html"
+      resources_node.resource(
+        :href => href,
+        :type => LOR,
+        :identifier => identifier
+      ) do |resource_node|
+        resource_node.file(:href => href)
+        resource_node.file(:href => File.join(identifier, ASSIGNMENT_SETTINGS))
+      end
+    end
+
+    def create_resource_sub_nodes(resource_node)
+      resource_node.file(:href => File.join(identifier, ASSIGNMENT_SETTINGS))
+    end
+
+    def create_files(export_dir)
+      super
+      create_settings_xml(export_dir)
+    end
+
+    def create_settings_xml(export_dir)
+      path = File.join(export_dir, identifier, ASSIGNMENT_SETTINGS)
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'w') do |file|
+        settings_node = Builder::XmlMarkup.new(:target => file, :indent => 2)
+        settings_node.instruct!
+        settings_node.assignment(
+          :identifier => identifier,
+          'xsi:schemaLocation' => "http://canvas.instructure.com/xsd/cccv1p0 http://canvas.instructure.com/xsd/cccv1p0.xsd",
+          'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
+          'xmlns' => "http://canvas.instructure.com/xsd/cccv1p0"
+        ) do |assignment_node|
+          SETTINGS_ATTRIBUTES.each do |attr|
+            assignment_node.tag!(attr, send(attr)) unless send(attr).nil?
+          end
+        end
+      end
+    end
+
+    def create_module_meta_item_elements(item_node)
+      item_node.content_type 'Assignment'
+      item_node.identifierref @identifier
+    end
+  end
+end

data/lib/moodle2cc/canvas/converter.rb

@@ -0,0 +1,28 @@
+module Moodle2CC::Canvas
+  class Converter < Moodle2CC::CC::Converter
+    def initialize(moodle_backup, destination_dir)
+      super
+      @resource_factory = Moodle2CC::ResourceFactory.new Moodle2CC::Canvas
+    end
+
+    def create_resources(resources_node)
+      create_course_content(resources_node)
+      @moodle_backup.course.question_categories.each do |question_category|
+        create_question_bank_resource(resources_node, question_category)
+      end
+      super
+    end
+
+    def create_question_bank_resource(resources_node, question_category)
+      question_bank = QuestionBank.new(question_category)
+      question_bank.create_resource_node(resources_node)
+      question_bank.create_files(@export_dir)
+    end
+
+    def create_course_content(resources_node)
+      course = Course.new(@moodle_backup.course)
+      course.create_resource_node(resources_node)
+      course.create_files(@export_dir)
+    end
+  end
+end

data/lib/moodle2cc/canvas/course.rb

@@ -0,0 +1,145 @@
+module Moodle2CC::Canvas
+  class Course < Moodle2CC::CC::Course
+
+    attr_accessor :id, :title, :course_code, :start_at, :format, :is_public, :syllabus_body
+
+    def initialize(course)
+      super
+
+      @course = course
+
+      @id = course.id
+      @title = course.fullname
+      @course_code = course.shortname
+      @start_at = ims_datetime(Time.at(course.startdate))
+      @is_public = course.visible
+      @syllabus_body = convert_file_path_tokens(course.sections.first.summary)
+      @resource_factory = Moodle2CC::ResourceFactory.new Moodle2CC::Canvas
+    end
+
+    def identifier
+      create_key(id, 'course_')
+    end
+
+    def create_resource_node(resources_node)
+      syllabus_href = File.join(COURSE_SETTINGS_DIR, SYLLABUS)
+      resources_node.resource(
+        :intendeduse => 'syllabus',
+        :href => syllabus_href,
+        :type => LOR,
+        :identifier => create_key(syllabus_href, 'resource_')
+      ) do |resource_node|
+        resource_node.file(:href => File.join(COURSE_SETTINGS_DIR, SYLLABUS))
+        resource_node.file(:href => File.join(COURSE_SETTINGS_DIR, COURSE_SETTINGS))
+        resource_node.file(:href => File.join(COURSE_SETTINGS_DIR, FILES_META))
+        resource_node.file(:href => File.join(COURSE_SETTINGS_DIR, MODULE_META))
+        resource_node.file(:href => File.join(COURSE_SETTINGS_DIR, ASSIGNMENT_GROUPS))
+      end
+    end
+
+    def create_files(export_dir)
+      create_syllabus_file(export_dir)
+      create_course_settings_xml(export_dir)
+      create_files_meta_xml(export_dir)
+      create_assignment_groups_xml(export_dir)
+      create_module_meta_xml(export_dir)
+    end
+
+    def create_syllabus_file(export_dir)
+      template = File.expand_path('../templates/syllabus.html.erb', __FILE__)
+      path = File.join(export_dir, COURSE_SETTINGS_DIR, SYLLABUS)
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'w') do |file|
+        erb = ERB.new(File.read(template))
+        file.write(erb.result(binding))
+      end
+    end
+
+    def create_course_settings_xml(export_dir)
+      path = File.join(export_dir, COURSE_SETTINGS_DIR, COURSE_SETTINGS)
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'w') do |file|
+        document = Builder::XmlMarkup.new(:target => file, :indent => 2)
+        document.instruct!
+        document.course(
+          :identifier => identifier,
+          'xsi:schemaLocation' => "http://canvas.instructure.com/xsd/cccv1p0 http://canvas.instructure.com/xsd/cccv1p0.xsd",
+          'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
+          'xmlns' => "http://canvas.instructure.com/xsd/cccv1p0"
+        ) do |course_node|
+          course_node.title @title
+          course_node.course_code @course_code
+          course_node.start_at @start_at
+          course_node.is_public @is_public
+          course_node.license 'private'
+        end
+      end
+    end
+
+    def create_module_meta_xml(export_dir)
+      path = File.join(export_dir, COURSE_SETTINGS_DIR, MODULE_META)
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'w') do |file|
+        document = Builder::XmlMarkup.new(:target => file, :indent => 2)
+        document.instruct!
+        document.modules(
+          'xsi:schemaLocation' => "http://canvas.instructure.com/xsd/cccv1p0 http://canvas.instructure.com/xsd/cccv1p0.xsd",
+          'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
+          'xmlns' => "http://canvas.instructure.com/xsd/cccv1p0"
+        ) do |modules_node|
+          @course.sections.each do |section|
+            next unless section.visible
+            modules_node.module(:identifier => create_key(section.id, 'section_')) do |module_node|
+              module_node.title "#{@format} #{section.number}"
+              module_node.position section.number
+              module_node.require_sequential_progress false
+              module_node.items do |items_node|
+                section.mods.each_with_index do |mod, index|
+                  next unless mod.visible
+                  resource = @resource_factory.get_resource_from_mod(mod.instance)
+                  resource.create_module_meta_item_node(items_node, index) if resource
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def create_assignment_groups_xml(export_dir)
+      path = File.join(export_dir, COURSE_SETTINGS_DIR, ASSIGNMENT_GROUPS)
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'w') do |file|
+        document = Builder::XmlMarkup.new(:target => file, :indent => 2)
+        document.instruct!
+        document.assignmentGroups(
+          'xsi:schemaLocation' => "http://canvas.instructure.com/xsd/cccv1p0 http://canvas.instructure.com/xsd/cccv1p0.xsd",
+          'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
+          'xmlns' => "http://canvas.instructure.com/xsd/cccv1p0"
+        ) do |assignment_groups_node|
+          @course.sections.each do |section|
+            next unless section.visible
+            next unless section.mods.select { |mod| mod.visible && mod.instance.mod_type == "assignment" }.length > 0
+            assignment_groups_node.assignmentGroup(:identifier => create_key(section.id, "assignment_group_")) do |assignment_group_node|
+              assignment_group_node.title "Week #{section.number}"
+            end
+          end
+        end
+      end
+    end
+
+    def create_files_meta_xml(export_dir)
+      path = File.join(export_dir, COURSE_SETTINGS_DIR, FILES_META)
+      FileUtils.mkdir_p(File.dirname(path))
+      File.open(path, 'w') do |file|
+        document = Builder::XmlMarkup.new(:target => file, :indent => 2)
+        document.instruct!
+        document.filesMeta(
+          'xsi:schemaLocation' => "http://canvas.instructure.com/xsd/cccv1p0 http://canvas.instructure.com/xsd/cccv1p0.xsd",
+          'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
+          'xmlns' => "http://canvas.instructure.com/xsd/cccv1p0")
+      end
+    end
+
+  end
+end