moodle2cc 0.0.1

data/lib/moodle2cc/cli.rb

@@ -0,0 +1,14 @@
+require 'thor'
+
+module Moodle2CC
+  class CLI < Thor
+    desc "migrate MOODLE_BACKUP_ZIP EXPORT_DIR", "Migrates Moodle backup ZIP to IMS Common Cartridge package"
+    method_option :format, :default => 'cc'
+    method_options :format => :string
+    def migrate(source, destination)
+      migrator = Moodle2CC::Migrator.new source, destination, options
+      migrator.migrate
+      puts "#{source} converted to #{migrator.imscc_path}"
+    end
+  end
+end

data/lib/moodle2cc/error.rb

@@ -0,0 +1,3 @@
+module Moodle2CC
+  class Error < StandardError; end
+end

data/lib/moodle2cc/migrator.rb

@@ -0,0 +1,23 @@
+module Moodle2CC
+  class Migrator
+    def initialize(source, destination, options={})
+      @source = source
+      @destination = destination
+      @format = options['format'] || 'cc'
+      raise(Moodle2CC::Error, "'#{@source}' does not exist") unless File.exists?(@source)
+      raise(Moodle2CC::Error, "'#{@destination}' is not a directory") unless File.directory?(@destination)
+      raise(Moodle2CC::Error, "'#{@format}' is not a valid format. Please use 'cc' or 'canvas'.") unless ['cc', 'canvas'].include?(@format)
+      @converter_class = @format == 'cc' ? Moodle2CC::CC::Converter : Moodle2CC::Canvas::Converter
+    end
+
+    def migrate
+      backup = Moodle2CC::Moodle::Backup.read @source
+      @converter = @converter_class.new backup, @destination
+      @converter.convert
+    end
+
+    def imscc_path
+      @converter.imscc_path
+    end
+  end
+end

data/lib/moodle2cc/moodle/backup.rb

@@ -0,0 +1,38 @@
+require 'zip/zipfilesystem'
+
+module Moodle2CC::Moodle
+  class Backup
+    include HappyMapper
+
+    attr_accessor :backup_file, :files
+
+    tag 'MOODLE_BACKUP'
+    has_one :info, Info
+    has_one :course, Course
+
+    def self.read(backup_file)
+      Zip::ZipFile.open(backup_file) do |zipfile|
+        xml = zipfile.file.read("moodle.xml")
+        backup = parse xml
+        backup.backup_file = backup_file
+        backup.files = zipfile.entries.select { |e| e.name =~ /^course_files/ && !e.directory? }.
+          map { |e| e.name.sub('course_files/', '') }.sort
+        backup
+      end
+    end
+
+    def copy_files_to(dir)
+      Zip::ZipFile.open(@backup_file) do |zipfile|
+        @files.each do |file|
+          zipfile.file.open("course_files/#{file}") do |zip|
+            destination_file = File.join(dir, file)
+            FileUtils.mkdir_p(File.dirname(destination_file))
+            File.open(destination_file, 'w') do |f|
+              f.write zip.read
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/moodle2cc/moodle/course.rb

@@ -0,0 +1,24 @@
+module Moodle2CC::Moodle
+  class Course
+    include HappyMapper
+
+    tag 'COURSE'
+    element :id, Integer, :tag => 'HEADER/ID'
+    element :fullname, String, :tag => 'HEADER/FULLNAME'
+    element :shortname, String, :tag => 'HEADER/SHORTNAME'
+    element :startdate, Integer, :tag => 'HEADER/STARTDATE'
+    element :format, String, :tag => 'HEADER/FORMAT'
+    element :visible, Boolean, :tag => 'HEADER/VISIBLE'
+    has_many :sections, Section
+    has_many :mods, Mod
+    has_many :grade_items, GradeItem
+    has_many :question_categories, QuestionCategory
+
+    after_parse do |course|
+      course.sections.each { |section| section.course = course }
+      course.mods.each { |mod| mod.course = course }
+      course.grade_items.each { |grade_item| grade_item.course = course }
+      course.question_categories.each { |question_category| question_category.course = course }
+    end
+  end
+end

data/lib/moodle2cc/moodle/grade_item.rb

@@ -0,0 +1,24 @@
+module Moodle2CC::Moodle
+  class GradeItem
+    include HappyMapper
+
+    attr_accessor :course
+
+    tag 'GRADEBOOK/GRADE_ITEMS/GRADE_ITEM'
+    element :id, Integer, :tag => 'ID'
+    element :category_id, Integer, :tag => 'CATEGORYID'
+    element :item_name, String, :tag => 'ITEMNAME'
+    element :item_type, String, :tag => 'ITEMTYPE'
+    element :item_module, String, :tag => 'ITEMMODULE'
+    element :item_instance, Integer, :tag => 'ITEMINSTANCE'
+    element :item_number, Integer, :tag => 'ITEMNUMBER'
+    element :grade_type, Integer, :tag => 'GRADETYPE'
+    element :grade_max, Float, :tag => 'GRADEMAX'
+    element :grade_min, Float, :tag => 'GRADEMIN'
+    element :scale_id, Integer, :tag => 'SCALEID'
+
+    def instance
+      course.mods.find { |mod| mod.id == item_instance }
+    end
+  end
+end

data/lib/moodle2cc/moodle/info.rb

@@ -0,0 +1,8 @@
+module Moodle2CC::Moodle
+  class Info
+    include HappyMapper
+
+    tag 'INFO'
+    element :name, String, :tag => 'NAME'
+  end
+end

data/lib/moodle2cc/moodle/mod.rb

@@ -0,0 +1,127 @@
+module Moodle2CC::Moodle
+  class Mod
+    include HappyMapper
+
+    attr_accessor :course
+
+    class QuestionInstance
+      include HappyMapper
+
+      attr_accessor :mod
+
+      tag 'QUESTION_INSTANCES/QUESTION_INSTANCE'
+      element :id, Integer, :tag => 'ID'
+      element :question_id, Integer, :tag => 'QUESTION'
+      element :grade, Integer, :tag => 'GRADE'
+
+      def question
+        mod.course.question_categories.map do |qc|
+          qc.questions.find { |q| q.id == question_id }
+        end.compact.first
+      end
+    end
+
+    class Page
+      include HappyMapper
+
+      tag 'ENTRIES/ENTRY/PAGES/PAGE'
+      element :page_name, String, :tag => 'PAGENAME'
+      element :version, Integer, :tag => 'VERSION'
+      element :content, String, :tag => 'CONTENT'
+    end
+
+    class Option
+      include HappyMapper
+
+      tag 'OPTIONS/OPTION'
+      element :id, Integer, :tag => 'ID'
+      element :text, String, :tag => 'TEXT'
+    end
+
+    tag 'MODULES/MOD'
+    element :id, Integer, :tag => 'ID'
+    element :var1, Integer, :tag => 'VAR1'
+    element :var2, Integer, :tag => 'VAR2'
+    element :var3, Integer, :tag => 'VAR3'
+    element :var4, Integer, :tag => 'VAR4'
+    element :var5, Integer, :tag => 'VAR5'
+    element :mod_type, String, :tag => 'MODTYPE'
+    element :type, String, :tag => 'TYPE'
+    element :name, String, :tag => 'NAME'
+    element :description, String, :tag => 'DESCRIPTION'
+    element :summary, String, :tag => 'SUMMARY'
+    element :alltext, String, :tag => 'ALLTEXT'
+    element :text, String, :tag => 'TEXT'
+    element :content, String, :tag => 'CONTENT'
+    element :assignment_type, String, :tag => 'ASSIGNMENTTYPE'
+    element :reference, String, :tag => 'REFERENCE'
+    element :intro, String, :tag => 'INTRO'
+    element :resubmit, Boolean, :tag => 'RESUBMIT'
+    element :prevent_late, Boolean, :tag => 'PREVENTLATE'
+    element :grade, Integer, :tag => 'GRADE'
+    element :number_of_attachments, Integer, :tag => 'NATTACHMENTS'
+    element :number_of_student_assessments, Integer, :tag => 'NSASSESSMENTS'
+    element :anonymous, Boolean, :tag => 'ANONYMOUS'
+    element :submission_start, Integer, :tag => 'SUBMISSIONSTART'
+    element :submission_end, Integer, :tag => 'SUBMISSIONEND'
+    element :assessment_start, Integer, :tag => 'ASSESSMENTSTART'
+    element :assessment_end, Integer, :tag => 'ASSESSMENTEND'
+    element :time_due, Integer, :tag => 'TIMEDUE'
+    element :time_available, Integer, :tag => 'TIMEAVAILABLE'
+    element :time_open, Integer, :tag => 'TIMEOPEN'
+    element :time_close, Integer, :tag => 'TIMECLOSE'
+    element :time_limit, Integer, :tag => 'TIMELIMIT'
+    element :attempts_number, Integer, :tag => 'ATTEMPTS_NUMBER'
+    element :grade_method, Integer, :tag => 'GRADEMETHOD'
+    element :password, String, :tag => 'PASSWORD'
+    element :subnet, String, :tag => 'SUBNET'
+    element :shuffle_answers, Boolean, :tag => 'SHUFFLEANSWERS'
+    element :page_name, String, :tag => 'PAGENAME'
+    has_many :question_instances, QuestionInstance
+    has_many :questions, Question
+    has_many :pages, Page
+    has_many :options, Option
+
+    after_parse do |mod|
+      mod.question_instances.each { |question_instance| question_instance.mod = mod }
+    end
+
+    def section_mod
+      course.sections.map { |section| section.mods.find { |mod| mod.instance_id == id && mod.mod_type == mod_type } }.compact.first
+    end
+
+    def grade_item
+      course.grade_items.find { |grade_item| grade_item.item_instance == id }
+    end
+
+    def questions
+      if mod_type == 'questionnaire'
+        @questions.sort! { |a,b| a.position <=> b.position }
+        return @questions
+      end
+      if mod_type == 'choice'
+        question = Question.new
+        question.id = "choice_question_#{@id}"
+        question.name = @name
+        question.text = @text
+        question.type = @mod_type
+        question.grade = 1
+        question.answers = []
+        @options.each do |option|
+          answer = Question::Answer.new
+          answer.id = option.id
+          answer.text = option.text
+          question.answers << answer
+        end
+        @questions = [question]
+      else
+        @questions = question_instances.map do |qi|
+          question = qi.question
+          question.grade = qi.grade
+          question.instance_id = qi.id
+          question
+        end
+      end
+    end
+  end
+end

data/lib/moodle2cc/moodle/question.rb

@@ -0,0 +1,98 @@
+module Moodle2CC::Moodle
+  class Question
+    include HappyMapper
+
+    attr_accessor :question_category, :grade, :instance_id
+
+    class Answer
+      include HappyMapper
+
+      tag 'ANSWERS/ANSWER'
+      element :id, Integer, :tag => 'ID'
+      element :text, String, :tag => 'ANSWER_TEXT'
+      element :fraction, Float, :tag => 'FRACTION'
+      element :feedback, String, :tag => 'FEEDBACK'
+    end
+
+    class Calculation
+      include HappyMapper
+
+      class DatasetDefinition
+        include HappyMapper
+
+        class DatasetItem
+          include HappyMapper
+
+          tag 'DATASET_ITEMS/DATASET_ITEM'
+          element :number, Integer, :tag => 'NUMBER'
+          element :value, Float, :tag => 'VALUE'
+        end
+
+        tag 'DATASET_DEFINITIONS/DATASET_DEFINITION'
+        element :name, String, :tag => 'NAME'
+        element :options, String, :tag => 'OPTIONS'
+        has_many :dataset_items, DatasetItem
+      end
+
+      tag 'CALCULATED'
+      element :answer_id, Integer, :tag => 'ANSWER'
+      element :tolerance, Float, :tag => 'TOLERANCE'
+      element :correct_answer_length, Integer, :tag => 'CORRECTANSWERLENGTH'
+      element :correct_answer_format, Integer, :tag => 'CORRECTANSWERFORMAT'
+      has_many :dataset_definitions, DatasetDefinition
+    end
+
+    class Match
+      include HappyMapper
+
+      tag 'MATCHS/MATCH'
+      element :id, Integer, :tag => 'ID'
+      element :code, Integer, :tag => 'CODE'
+      element :question_text, String, :tag => 'QUESTIONTEXT'
+      element :answer_text, String, :tag => 'ANSWERTEXT'
+    end
+
+    class Numerical
+      include HappyMapper
+
+      tag 'NUMERICAL'
+      element :answer_id, Integer, :tag => 'ANSWER'
+      element :tolerance, Integer, :tag => 'TOLERANCE'
+    end
+
+    class Choice
+      include HappyMapper
+
+      tag 'QUESTION_CHOICE'
+      element :id, Integer, :tag => 'ID'
+      element :content, String, :tag => 'CONTENT'
+    end
+
+    tag 'QUESTION'
+    element :id, Integer, :tag => 'ID'
+    element :name, String, :tag => 'NAME'
+    element :text, String, :tag => 'QUESTIONTEXT'
+    element :content, String, :tag => 'CONTENT'
+    element :length, Integer, :tag => 'LENGTH'
+    element :general_feedback, String, :tag => 'GENERALFEEDBACK'
+    element :default_grade, Integer, :tag => 'DEFAULTGRADE'
+    element :position, Integer, :tag => 'POSITION'
+    element :type, String, :tag => 'QTYPE'
+    element :type_id, Integer, :tag => 'TYPE_ID'
+    has_many :numericals, Numerical
+    has_many :answers, Answer
+    has_many :calculations, Calculation
+    has_many :matches, Match
+    has_many :choices, Choice
+
+    def instance
+      question_category.course.mods.select do |mod|
+        mod.mod_type == 'quiz'
+      end.map do |mod|
+        mod.question_instances.find do |qi|
+          qi.question_id == id
+        end
+      end.compact.first
+    end
+  end
+end

data/lib/moodle2cc/moodle/question_category.rb

@@ -0,0 +1,17 @@
+module Moodle2CC::Moodle
+  class QuestionCategory
+    include HappyMapper
+
+    attr_accessor :course
+
+    tag 'QUESTION_CATEGORIES/QUESTION_CATEGORY'
+    element :id, Integer, :tag => 'ID'
+    element :name, String, :tag => 'NAME'
+    element :info, String, :tag => 'INFO'
+    has_many :questions, Question
+
+    after_parse do |qc|
+      qc.questions.each { |q| q.question_category = qc }
+    end
+  end
+end

data/lib/moodle2cc/moodle/section.rb

@@ -0,0 +1,37 @@
+module Moodle2CC::Moodle
+  class Section
+    include HappyMapper
+
+    attr_accessor :course
+
+    class Mod
+      include HappyMapper
+
+      attr_accessor :section
+
+      tag 'MODS/MOD'
+
+      element :id, Integer, :tag => 'ID'
+      element :mod_type, String, :tag => 'TYPE'
+      element :instance_id, Integer, :tag => 'INSTANCE'
+      element :added, Integer, :tag => 'ADDED'
+      element :indent, Integer, :tag => 'INDENT'
+      element :visible, Boolean, :tag => 'VISIBLE'
+
+      def instance
+        section.course.mods.find { |mod| mod.id == instance_id && mod.mod_type == mod_type }
+      end
+    end
+
+    tag 'SECTIONS/SECTION'
+    element :id, Integer, :tag => 'ID'
+    element :number, Integer, :tag => 'NUMBER'
+    element :summary, String, :tag => 'SUMMARY'
+    element :visible, Boolean, :tag => 'VISIBLE'
+    has_many :mods, Mod
+
+    after_parse do |section|
+      section.mods.each { |mod| mod.section = section }
+    end
+  end
+end

data/lib/moodle2cc/resource_factory.rb

@@ -0,0 +1,32 @@
+class Moodle2CC::ResourceFactory
+
+  def initialize(namespace)
+    @namespace = namespace
+  end
+
+  def get_resource_from_mod(mod, position=0)
+    case mod.mod_type
+    when 'assignment', 'workshop'
+      @namespace.const_get(:Assignment).new(mod, position)
+    when 'resource'
+      if mod.type == 'file'
+        @namespace.const_get(:WebLink).new(mod)
+      elsif mod.type == 'html'
+        @namespace.const_get(:WebContent).new(mod)
+      end
+    when 'forum'
+      @namespace.const_get(:DiscussionTopic).new(mod, position)
+    when 'quiz', 'questionnaire', 'choice'
+      @namespace.const_get(:Assessment).new(mod, position)
+    when 'wiki'
+      @namespace.const_get(:Wiki).new(mod)
+    when 'label'
+      html = Nokogiri::HTML(mod.content)
+      if html.text == mod.content && mod.content.length < 50 # label doesn't contain HTML
+        @namespace.const_get(:Label).new(mod)
+      else
+        @namespace.const_get(:WebContent).new(mod)
+      end
+    end
+  end
+end