moodle2cc 0.1.12 → 0.2.0

data/lib/moodle2cc/moodle2converter/course_converter.rb

@@ -0,0 +1,18 @@
+module Moodle2CC::Moodle2Converter
+  class CourseConverter
+    include ConverterHelper
+
+    def convert(moodle_course)
+      cc_course = Moodle2CC::CanvasCC::Models::Course.new
+      cc_course.title = moodle_course.fullname
+      cc_course.course_code = moodle_course.shortname
+      cc_course.start_at = moodle_course.startdate
+      cc_course.identifier = generate_unique_identifier_for(moodle_course.course_id, COURSE_SUFFIX)
+      cc_course.allow_student_discussion_topics = false
+      cc_course.allow_student_wiki_edits = false
+      cc_course.default_view = 'modules'
+      cc_course
+    end
+
+  end
+end

data/lib/moodle2cc/moodle2converter/discussion_converter.rb

@@ -0,0 +1,18 @@
+module Moodle2CC::Moodle2Converter
+  class DiscussionConverter
+    include ConverterHelper
+
+
+    def convert(forum)
+      discussion = Moodle2CC::CanvasCC::Models::Discussion.new
+      discussion.identifier = generate_unique_identifier_for(forum.id, DISCUSSION_SUFFIX)
+      discussion.title = forum.name
+      discussion.text = forum.intro
+      discussion.discussion_type = 'threaded'
+      discussion.workflow_state = workflow_state(forum.visible)
+
+      discussion
+    end
+
+  end
+end

data/lib/moodle2cc/moodle2converter/file_converter.rb

@@ -0,0 +1,14 @@
+module Moodle2CC::Moodle2Converter
+  class FileConverter
+    include ConverterHelper
+
+    def convert(moodle_file)
+      canvas_file = Moodle2CC::CanvasCC::Models::CanvasFile.new
+      canvas_file.identifier = moodle_file.content_hash
+      canvas_file.file_path = moodle_file.file_path + moodle_file.file_name
+      canvas_file.file_location = moodle_file.file_location
+      canvas_file
+    end
+
+  end
+end

data/lib/moodle2cc/moodle2converter/folder_converter.rb

@@ -0,0 +1,50 @@
+module Moodle2CC::Moodle2Converter
+  class FolderConverter
+    include ConverterHelper
+
+    def initialize(moodle_course)
+      @moodle_course = moodle_course
+    end
+
+    def convert(moodle_folder)
+      canvas_page = Moodle2CC::CanvasCC::Models::Page.new
+      canvas_page.identifier = generate_unique_identifier_for(moodle_folder.id) + FOLDER_SUFFIX
+      canvas_page.page_name = moodle_folder.name
+      canvas_page.workflow_state = workflow_state(moodle_folder.visible)
+      canvas_page.editing_roles = 'teachers'
+      canvas_page.body = generate_body(moodle_folder)
+      canvas_page
+    end
+
+    private
+
+    def parse_files_from_course(moodle_folder)
+      @moodle_course.files.select { |f| moodle_folder.file_ids.include? f.id }
+    end
+
+    def generate_body(moodle_folder)
+      files = sort_files(parse_files_from_course(moodle_folder))
+      html = "<ul>\n"
+      files.each do |f|
+        #create a moodle style link that will be replaced in the html converter
+        link = "<a href=\"@@PLUGINFILE@@#{f.file_path}#{f.file_name}\">#{f.file_path[1..-1]}#{f.file_name}</a>"
+        html += "<li><p>#{link}</p></li>\n"
+      end
+      html += "</ul>\n"
+      html.strip
+    end
+
+    def sort_files(files)
+      files.sort do |a, b|
+        a_depth = a.file_path.scan(/\//).count
+        b_depth = b.file_path.scan(/\//).count
+        if a_depth == b_depth
+          "#{a.file_path[1..-1]}#{a.file_name}" <=> "#{b.file_path[1..-1]}#{b.file_name}"
+        else
+          a_depth <=> b_depth
+        end
+      end
+    end
+
+  end
+end

data/lib/moodle2cc/moodle2converter/glossary_converter.rb

@@ -0,0 +1,36 @@
+module Moodle2CC::Moodle2Converter
+  class GlossaryConverter
+    include ConverterHelper
+
+    def initialize(moodle_course)
+      @moodle_course = moodle_course
+    end
+
+    def convert(moodle_glossary)
+      canvas_page = Moodle2CC::CanvasCC::Models::Page.new
+      canvas_page.identifier = generate_unique_identifier_for(moodle_glossary.id) + GLOSSARY_SUFFIX
+      canvas_page.page_name = moodle_glossary.name
+      canvas_page.workflow_state = 'active'
+      canvas_page.editing_roles = 'teachers,students'
+      canvas_page.body = generate_body(moodle_glossary)
+      canvas_page.workflow_state = workflow_state(moodle_glossary.visible)
+      canvas_page
+    end
+
+    private
+
+    def parse_files_from_course(moodle_glossary)
+      @moodle_course.files.select { |f| moodle_glossary.file_ids.include? f.id }
+    end
+
+    def generate_body(moodle_glossary)
+      html = "<h2>#{moodle_glossary.name}</h2>"
+      html += '<table><tr><th>Concept</th><th>Definition</th></tr>'
+      moodle_glossary.entries.each { |entry| html += "<tr><td style='padding-right:10px'>#{entry.concept}</td><td>#{entry.definition}</td></tr>" }
+      html += '</table>'
+      html
+    end
+
+
+  end
+end

data/lib/moodle2cc/moodle2converter/html_converter.rb

@@ -0,0 +1,96 @@
+module Moodle2CC::Moodle2Converter
+  class HtmlConverter
+    include ConverterHelper
+
+    OBJECT_TOKEN = "$CANVAS_OBJECT_REFERENCE$"
+    COURSE_TOKEN = "$CANVAS_COURSE_REFERENCE$"
+    WIKI_TOKEN = "$WIKI_REFERENCE$"
+    WEB_CONTENT_TOKEN = "$IMS_CC_FILEBASE$"
+    MEDIA_TYPES = {'mp3' => 'audio/mp3', 'wav' => 'audio/wav', 'mp4' => 'video/mp4', 'webm' => 'video/webm'}
+
+    def initialize(canvas_files, moodle_course)
+      @moodle_course = moodle_course
+      @file_index = {}
+      @moodle_course.files.each do |f|
+        @file_index[f.file_path.downcase + f.file_name.downcase] = canvas_files.find { |cc_f| cc_f.identifier == f.content_hash }
+      end
+    end
+
+    def convert(content)
+      update_links(content.gsub('id="main"', ''))
+    end
+
+    private
+
+    def update_links(content)
+      html = Nokogiri::HTML.fragment(content)
+      html.css('img').each { |img| img['src'] = update_url(img.attr('src')) }
+      html.css('a[href]').each do |tag|
+        tag['href'] = update_url(tag.attr('href'))
+        replace_media_anchor(tag)
+      end
+      html.css('link[href]').each { |tag| tag.remove }
+      html.to_s
+    end
+
+    def replace_media_anchor(tag)
+      if tag.name == 'a'
+        href = tag['href']
+        match = href.match(/\.([A-z0-9]+)?/)
+        if (match && MEDIA_TYPES.key?(match.captures[0]))
+          html = tag.to_s
+          tag.delete('href')
+          tag.name = 'audio'
+          tag['controls'] = 'controls'
+          tag.children = "<source src=\"#{href}\" type=\"#{MEDIA_TYPES[match.captures[0]]}\"></source>#{html.to_s}"
+        end
+      end
+    end
+
+    def update_url(link)
+      if canvas_link = lookup_cc_file(link)
+        canvas_link
+      elsif match = link.match(/\/mod\/(page|forum|assignment)\/view\.php\?.*id=(\d*)(#.*)?/)
+        lookup_cc_link(match.captures[0], match.captures[1], match.captures[2]) || link
+      elsif match = CGI::unescape(link).match(/\$\@ASSIGNVIEWBYID\*(\d*)@\$/)
+        lookup_cc_link('assignment', match.captures[0], nil) || link
+      elsif match = link.match(/file.php\/\d*(\/.*)/)
+        file_link(match.captures.first) || link
+      else
+        link
+      end
+    end
+
+    def lookup_cc_file(link)
+      if match = link.match(/@@PLUGINFILE@@(.*)/)
+        file_link(match.captures.first) || link
+      end
+    end
+
+    def file_link(moodle_path)
+      if cc_file = @file_index[CGI::unescape(moodle_path).downcase]
+        "#{WEB_CONTENT_TOKEN}#{cc_file.file_path}"
+      end
+    end
+
+    def lookup_cc_link(activity, id, anchor)
+      case activity
+        when 'assignment'
+          if assignment = @moodle_course.assignments.find { |assignment| assignment.id == id }
+            "#{OBJECT_TOKEN}/assignments/#{generate_unique_identifier_for_activity(assignment)}#{anchor}"
+          end
+        when 'page'
+          if page = @moodle_course.pages.find { |page| page.id == id }
+            "#{WIKI_TOKEN}/pages/#{page.name}#{anchor}"
+          end
+        when 'forum'
+          if forum = @moodle_course.forums.find { |forum| forum.id == id }
+            "#{OBJECT_TOKEN}/discussion_topics/#{generate_unique_identifier_for_activity(forum)}#{anchor}"
+          end
+        else
+          puts "unknown activity to replace link for. activity:#{activity} id:#{id}"
+      end
+    end
+
+  end
+end

data/lib/moodle2cc/moodle2converter/migrator.rb

@@ -0,0 +1,111 @@
+module Moodle2CC::Moodle2Converter
+  class Migrator
+
+    def initialize(source_file, output_dir)
+      @extractor = Moodle2CC::Moodle2::Extractor.new(source_file)
+      @output_dir = output_dir
+    end
+
+    def migrate
+      @extractor.extract do |moodle_course|
+        cc_course = convert_course(moodle_course)
+        cc_course.files += convert_files(moodle_course.files)
+        cc_course.pages += convert_pages(moodle_course.pages)
+        cc_course.discussions += convert_discussions(moodle_course.forums)
+        cc_course.assignments += convert_assignments(moodle_course.assignments)
+
+        cc_course.assessments += convert_assessments(moodle_course.quizzes)
+        cc_course.question_banks += convert_question_banks(moodle_course.question_categories)
+        cc_course.resolve_question_references
+
+        cc_course.pages += convert_sections_to_pages(moodle_course.sections)
+        cc_course.pages += convert_folders(moodle_course)
+        cc_course.pages += convert_books(moodle_course.books)
+        cc_course.pages += convert_glossaries(moodle_course)
+
+        cc_course.canvas_modules += convert_sections(moodle_course.sections)
+
+        convert_html!(cc_course, moodle_course)
+
+        @path = Moodle2CC::CanvasCC::CartridgeCreator.new(cc_course).create(@output_dir)
+      end
+      @path
+    end
+
+    def imscc_path
+      @path
+    end
+
+    private
+
+    def convert_course(moodle_course)
+      Moodle2CC::Moodle2Converter::CourseConverter.new.convert(moodle_course)
+    end
+
+    def convert_sections(sections)
+      section_converter = Moodle2CC::Moodle2Converter::SectionConverter.new
+      sections.map { |section| section_converter.convert(section) if !section.empty? }.compact
+    end
+
+    def convert_files(files)
+      file_converter = Moodle2CC::Moodle2Converter::FileConverter.new
+      Array.new(files.uniq { |f| f.content_hash }).map { |file| file_converter.convert(file) }
+    end
+
+    def convert_pages(pages)
+      page_converter = Moodle2CC::Moodle2Converter::PageConverter.new
+      pages.map { |page| page_converter.convert(page) }
+    end
+
+    def convert_discussions(discussions)
+      discussion_converter = Moodle2CC::Moodle2Converter::DiscussionConverter.new
+      discussions.map { |discussion| discussion_converter.convert(discussion) }
+    end
+
+    def convert_assignments(assignments)
+      assignment_converter = Moodle2CC::Moodle2Converter::AssignmentConverter.new
+      assignments.map { |assignment| assignment_converter.convert(assignment) }
+    end
+
+    def convert_sections_to_pages(sections)
+      converter = Moodle2CC::Moodle2Converter::SectionConverter.new
+      sections.map{|s| converter.convert_to_summary_page(s) if s.summary?}.compact
+    end
+
+    def convert_folders(moodle_course)
+      folder_converter = Moodle2CC::Moodle2Converter::FolderConverter.new(moodle_course)
+      moodle_course.folders.map { |folder| folder_converter.convert(folder) }
+    end
+
+    def convert_books(books)
+      book_converter = Moodle2CC::Moodle2Converter::BookConverter.new
+      books.map { |book| book_converter.convert_to_pages(book) }.flatten
+    end
+
+    def convert_glossaries(moodle_course)
+      glossary_converter = Moodle2CC::Moodle2Converter::GlossaryConverter.new(moodle_course)
+      moodle_course.glossaries.map { |glossary| glossary_converter.convert(glossary) }
+    end
+
+    # convert quizzes to assessments
+    def convert_assessments(quizzes)
+      assessment_converter = Moodle2CC::Moodle2Converter::AssessmentConverter.new
+      quizzes.map { |quiz| assessment_converter.convert(quiz) }
+    end
+
+    # convert question categories to question banks
+    def convert_question_banks(question_categories)
+      bank_converter = Moodle2CC::Moodle2Converter::QuestionBankConverter.new
+      question_categories.map { |category| bank_converter.convert(category) }
+    end
+
+    def convert_html!(cc_course, moodle_course)
+      html_converter = HtmlConverter.new(cc_course.files, moodle_course)
+      cc_course.pages.each {|page| page.body = html_converter.convert(page.body)}
+      cc_course.discussions.each {|discussion| discussion.text = html_converter.convert(discussion.text)}
+      cc_course.assignments.each {|assignment| assignment.body = html_converter.convert(assignment.body)}
+      cc_course.assessments.each {|assessment| assessment.description = html_converter.convert(assessment.description)}
+    end
+
+  end
+end

data/lib/moodle2cc/moodle2converter/page_converter.rb

@@ -0,0 +1,16 @@
+module Moodle2CC::Moodle2Converter
+  class PageConverter
+    include ConverterHelper
+
+    def convert(moodle_page)
+      canvas_page = Moodle2CC::CanvasCC::Models::Page.new
+      canvas_page.identifier = generate_unique_identifier_for(moodle_page.id) + PAGE_SUFFIX
+      canvas_page.page_name = moodle_page.name
+      canvas_page.workflow_state = workflow_state(moodle_page.visible)
+      canvas_page.editing_roles = 'teachers'
+      canvas_page.body = moodle_page.content
+      canvas_page
+    end
+
+  end
+end

data/lib/moodle2cc/moodle2converter/question_bank_converter.rb

@@ -0,0 +1,31 @@
+module Moodle2CC::Moodle2Converter
+  class QuestionBankConverter
+    include ConverterHelper
+
+    def convert(moodle_category)
+      canvas_bank = Moodle2CC::CanvasCC::Models::QuestionBank.new
+
+      canvas_bank.identifier = generate_unique_identifier_for(moodle_category.id, QUESTION_BANK_SUFFIX)
+      canvas_bank.title = moodle_category.name
+
+      question_converter = Moodle2CC::Moodle2Converter::QuestionConverters::QuestionConverter.new
+      moodle_category.questions.each do |moodle_question|
+        item = question_converter.convert(moodle_question)
+        case item
+        when Moodle2CC::CanvasCC::Models::Question
+          canvas_bank.questions << item
+        when Moodle2CC::CanvasCC::Models::QuestionGroup
+          canvas_bank.question_groups << item
+        end
+      end
+
+      canvas_bank.question_groups.each do |question_group|
+        if question_group.group_type == 'random_short_answer'
+          question_group.questions = canvas_bank.questions.select{|q| q.question_type == 'short_answer_question'}
+        end
+      end
+
+      canvas_bank
+    end
+  end
+end

data/lib/moodle2cc/moodle2converter/question_converters.rb

@@ -0,0 +1,11 @@
+module Moodle2CC::Moodle2Converter
+  module QuestionConverters
+    require_relative 'question_converters/question_converter'
+    require_relative 'question_converters/calculated_converter'
+    require_relative 'question_converters/matching_converter'
+    require_relative 'question_converters/multiple_blanks_converter'
+    require_relative 'question_converters/numerical_converter'
+    require_relative 'question_converters/random_sa_converter'
+    require_relative 'question_converters/true_false_converter'
+  end
+end

data/lib/moodle2cc/moodle2converter/question_converters/calculated_converter.rb

@@ -0,0 +1,17 @@
+module Moodle2CC::Moodle2Converter
+  module QuestionConverters
+    class CalculatedConverter < QuestionConverter
+      register_converter_type 'calculated'
+      self.canvas_question_type = 'calculated_question'
+
+      def convert_question(moodle_question)
+        canvas_question = super
+        canvas_question.correct_answer_format = moodle_question.correct_answer_format
+        canvas_question.correct_answer_length = moodle_question.correct_answer_length
+        canvas_question.dataset_definitions = moodle_question.dataset_definitions
+        canvas_question.tolerance = moodle_question.tolerance
+        canvas_question
+      end
+    end
+  end
+end

data/lib/moodle2cc/moodle2converter/question_converters/matching_converter.rb

@@ -0,0 +1,22 @@
+module Moodle2CC::Moodle2Converter
+  module QuestionConverters
+    class MatchingConverter < QuestionConverter
+      register_converter_type 'match'
+      self.canvas_question_type = 'matching_question'
+
+      def convert_question(moodle_question)
+        canvas_question = super
+        canvas_question.matches = []
+
+        moodle_question.matches.each do |match|
+          copy = match.dup
+          copy[:question_text] ||= ''
+          copy[:question_text].gsub(/\{(.*?)\}/, '[\1]')
+          copy[:question_text] = RDiscount.new(copy[:question_text]).to_html if copy[:question_text_format].to_i == 4 # markdown
+          canvas_question.matches << copy
+        end
+        canvas_question
+      end
+    end
+  end
+end