moodle2cc 0.1.12 → 0.2.0

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

@@ -0,0 +1,26 @@
+module Moodle2CC::Moodle2Converter
+  module QuestionConverters
+    class MultipleBlanksConverter < QuestionConverter
+      register_converter_type 'multianswer'
+      self.canvas_question_type = 'fill_in_multiple_blanks_question'
+
+      def convert_question(moodle_question)
+        canvas_question = super
+
+        canvas_question.material.gsub!(/\[\#(\d+)\]/) do |match|
+          "[response#{$1}]"
+        end
+
+        moodle_question.embedded_questions.each_with_index do |sub_question, index|
+          canvas_question.answers += sub_question.answers.select{|a| a.fraction == 1}.map do |moodle_answer|
+            converted_answer = Moodle2CC::CanvasCC::Models::Answer.new(moodle_answer)
+            converted_answer.resp_ident = "response#{index + 1}"
+            converted_answer
+          end
+        end
+
+        canvas_question
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Moodle2CC::Moodle2Converter
+  module QuestionConverters
+    class NumericalConverter < QuestionConverter
+      register_converter_type 'numerical'
+      self.canvas_question_type = 'numerical_question'
+
+      def convert_question(moodle_question)
+        canvas_question = super
+        canvas_question.tolerances = moodle_question.tolerances
+        canvas_question
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+module Moodle2CC::Moodle2Converter
+  module QuestionConverters
+    class QuestionConverter
+      class << self
+        attr_accessor :canvas_question_type
+      end
+
+      @@subclasses = {}
+      def self.register_converter_type(name)
+        @@subclasses[name] = self
+      end
+
+      STANDARD_CONVERSIONS = {
+        'description' => 'text_only_question',
+        'essay' => 'essay_question',
+        'multichoice' => 'multiple_choice_question',
+        'shortanswer' => 'short_answer_question'
+      }
+
+      def convert(moodle_question)
+        type = moodle_question.type
+        if type && c = @@subclasses[type]
+          c.new.convert_question(moodle_question)
+        elsif type && question_type = STANDARD_CONVERSIONS[type]
+          self.convert_question(moodle_question, question_type)
+        else
+          raise "Unknown converter type: #{type}"
+        end
+      end
+
+      def convert_question(moodle_question, question_type = nil)
+        canvas_question = create_canvas_question(question_type)
+        canvas_question.identifier = moodle_question.id
+        canvas_question.title = moodle_question.name
+        canvas_question.general_feedback = moodle_question.general_feedback
+        canvas_question.answers = moodle_question.answers.map do |moodle_answer|
+           Moodle2CC::CanvasCC::Models::Answer.new(moodle_answer)
+        end
+        canvas_question.material = convert_question_text(moodle_question)
+        canvas_question
+      end
+
+      def convert_question_text(moodle_question)
+        material = moodle_question.question_text || ''
+        material = material.gsub(/\{(.*?)\}/, '[\1]')
+        material = RDiscount.new(material).to_html if moodle_question.question_text_format.to_i == 4 # markdown
+        material
+      end
+
+      def create_canvas_question(question_type = nil)
+        question_type ||= self.class.canvas_question_type
+        raise 'set canvas_question_type in question converter subclasses' unless question_type
+        Moodle2CC::CanvasCC::Models::Question.create(question_type)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Moodle2CC::Moodle2Converter
+  module QuestionConverters
+    class RandomSAConverter < QuestionConverter
+      register_converter_type 'randomsamatch'
+
+      def convert_question(moodle_question)
+        canvas_group = Moodle2CC::CanvasCC::Models::QuestionGroup.new
+
+        canvas_group.identifier = moodle_question.id
+        canvas_group.title = moodle_question.name
+        canvas_group.selection_number = moodle_question.choose
+        canvas_group.group_type = 'random_short_answer'
+
+        canvas_group
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Moodle2CC::Moodle2Converter
+  module QuestionConverters
+    class TrueFalseConverter < QuestionConverter
+      register_converter_type 'truefalse'
+      self.canvas_question_type = 'true_false_question'
+
+      def convert_question(moodle_question)
+        moodle_question.answers = moodle_question.answers.select{|a|
+          [moodle_question.true_answer.to_s, moodle_question.false_answer.to_s].include?(a.id.to_s)
+        }.map do |a|
+          a.fraction = (moodle_question.true_answer.to_s == a.id.to_s) ? 1.0 : 0.0
+          a
+        end
+
+        canvas_question = super(moodle_question)
+        canvas_question
+      end
+    end
+  end
+end

data/lib/moodle2cc/moodle2converter/section_converter.rb

@@ -0,0 +1,75 @@
+module Moodle2CC
+  class Moodle2Converter::SectionConverter
+    include Moodle2Converter::ConverterHelper
+
+    ACTIVITY_CONVERTERS = {
+      Moodle2::Models::Book => Moodle2Converter::BookConverter
+    }
+
+    def initialize
+      @converters ={}
+    end
+
+    def convert(moodle_section)
+      canvas_module = CanvasCC::Models::CanvasModule.new
+      canvas_module.identifier = generate_unique_identifier_for(moodle_section.id, MODULE_SUFFIX)
+      canvas_module.title = moodle_section.name
+      canvas_module.workflow_state = workflow_state(moodle_section.visible)
+
+      canvas_module.module_items += convert_activity(moodle_section) if moodle_section.summary && !moodle_section.summary.strip.empty?
+      canvas_module.module_items += moodle_section.activities.map { |a| convert_activity(a) }
+      canvas_module.module_items = canvas_module.module_items.flatten.compact
+
+      canvas_module
+    end
+
+    def convert_to_summary_page(moodle_section)
+      canvas_page = CanvasCC::Models::Page.new
+      canvas_page.identifier = generate_unique_identifier_for_activity(moodle_section)
+      canvas_page.title = moodle_section.name
+      canvas_page.workflow_state = workflow_state(moodle_section.visible)
+      canvas_page.editing_roles = CanvasCC::Models::Page::EDITING_ROLE_TEACHER
+      canvas_page.body = moodle_section.summary
+      canvas_page.href = generate_unique_resource_path(CanvasCC::Models::Page::WIKI_CONTENT, CGI::escape("#{moodle_section.name}-summary"))
+
+      canvas_page
+    end
+
+    def convert_activity(moodle_activity)
+      begin
+        activity_converter_for(moodle_activity).convert_to_module_items(moodle_activity)
+      rescue Exception => e
+        puts e.message
+      end
+    end
+
+    def convert_to_module_items(moodle_activity)
+      module_item = CanvasCC::Models::ModuleItem.new
+      module_item.identifier = generate_unique_identifier
+      module_item.workflow_state = workflow_state(moodle_activity.visible)
+      module_item.title = moodle_activity.name
+      unless moodle_activity.is_a? Moodle2::Models::Label
+        if  moodle_activity.is_a? Moodle2::Models::ExternalUrl
+          module_item.identifierref = module_item.identifier
+          module_item.url = moodle_activity.external_url.gsub(/\s/, '%20')
+        elsif moodle_activity.is_a? Moodle2::Models::Resource
+          module_item.identifierref = moodle_activity.file.content_hash
+        else
+          module_item.identifierref = generate_unique_identifier_for_activity(moodle_activity)
+        end
+      end
+      module_item.content_type = activity_content_type(moodle_activity)
+      module_item.indent = '0'
+
+      [module_item]
+    end
+
+    private
+
+    def activity_converter_for(moodle_activity)
+      @converters[moodle_activity.class] ||=
+        ACTIVITY_CONVERTERS[moodle_activity.class] ? ACTIVITY_CONVERTERS[moodle_activity.class].new : self
+    end
+
+  end
+end

data/lib/moodle2cc/version.rb

@@ -1,3 +1,3 @@
 module Moodle2CC
-  VERSION = "0.1.12"
+  VERSION = "0.2.0"
 end

data/moodle2cc.gemspec

@@ -5,8 +5,9 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Christopher Durtschi", "Kevin Carter", "Instructure"]
   gem.email         = ["christopher.durtschi@gmail.com", "cartkev@gmail.com", "eng@instructure.com"]
   gem.description   = %q{Migrates Moodle backup ZIP to IMS Common Cartridge package}
-  gem.summary       = %q{Migrates Moodle backup ZIP to IMS Common Cartridge package}
+  gem.summary   = %q{Migrates Moodle backup ZIP to IMS Common Cartridge package}
   gem.homepage      = "https://github.com/instructure/moodle2cc"
+	gem.license = 'AGPLv3'
 
   gem.add_runtime_dependency "rubyzip", '>=1.0.0'
   gem.add_runtime_dependency "happymapper"
@@ -17,9 +18,13 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "minitest"
+  gem.add_development_dependency "rspec"
   gem.add_development_dependency "guard"
   gem.add_development_dependency "guard-bundler"
   gem.add_development_dependency "guard-minitest"
+  gem.add_development_dependency "guard-rspec"
+  gem.add_development_dependency "debugger"
+
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/spec/moodle2cc/canvas_cc/assessment_writer_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+module Moodle2CC::CanvasCC
+  describe AssessmentWriter do
+    subject { Moodle2CC::CanvasCC::AssessmentWriter.new(work_dir, assessment) }
+    let(:work_dir) { Dir.mktmpdir }
+    let(:assessment) { Moodle2CC::CanvasCC::Models::Assessment.new }
+
+    after(:each) do
+      FileUtils.rm_r work_dir
+    end
+
+    it 'raises an error unless question references are first resolved' do
+      expect { subject.write }.to raise_exception
+    end
+
+    it 'creates the assessment meta file' do
+
+      assessment.identifier = 'someidthing'
+      assessment.title = 'assersemurnt'
+      assessment.description = 'this is a bunch of description'
+      assessment.lock_at = Time.parse('Sat, 08 Feb 2014 17:00:00 GMT')
+      assessment.unlock_at = Time.parse('Sat, 08 Feb 2014 18:00:00 GMT')
+      assessment.time_limit = '12'
+      assessment.allowed_attempts = '13'
+      assessment.scoring_policy = '14'
+      assessment.access_code = 'tired of counting'
+      assessment.ip_filter = '42.42.42.42'
+      assessment.shuffle_answers = "every day i'm shuffling answers"
+      assessment.quiz_type = 'the best kind of quiz'
+
+      assessment.items = []
+      subject.write
+
+      xml = Nokogiri::XML(File.read(File.join(work_dir, assessment.meta_file_path)))
+
+      expect(xml.root.attributes['schemaLocation'].value).to eq "http://canvas.instructure.com/xsd/cccv1p0 http://canvas.instructure.com/xsd/cccv1p0.xsd"
+      expect(xml.namespaces['xmlns:xsi']).to eq "http://www.w3.org/2001/XMLSchema-instance"
+      expect(xml.namespaces['xmlns']).to eq "http://canvas.instructure.com/xsd/cccv1p0"
+
+      root = xml.at_xpath('xmlns:quiz')
+      expect(root.attributes['identifier'].value).to eq assessment.identifier
+      expect(root.%('title').text).to eq assessment.title
+      expect(root.%('description').text).to eq assessment.description
+      expect(root.%('lock_at').text).to eq '2014-02-08T17:00:00'
+      expect(root.%('unlock_at').text).to eq '2014-02-08T18:00:00'
+      expect(root.%('time_limit').text).to eq assessment.time_limit
+      expect(root.%('allowed_attempts').text).to eq assessment.allowed_attempts
+      expect(root.%('scoring_policy').text).to eq assessment.scoring_policy
+      expect(root.%('access_code').text).to eq assessment.access_code
+      expect(root.%('ip_filter').text).to eq assessment.ip_filter
+      expect(root.%('shuffle_answers').text).to eq assessment.shuffle_answers
+      expect(root.%('quiz_type').text).to eq assessment.quiz_type
+    end
+
+    it 'creates the assessment qti file' do
+      assessment.identifier = 'someidthing'
+      assessment.title = 'assersemurnt'
+      assessment.time_limit = 10
+      assessment.allowed_attempts = 2
+
+      question = Moodle2CC::CanvasCC::Models::Question.new
+      question.identifier = 42
+      assessment.items = [question]
+
+      QuestionWriter.register_writer_type(nil)
+      QuestionWriter.stub(:write_responses)
+      QuestionWriter.stub(:write_response_conditions)
+
+      subject.write
+
+      xml = Nokogiri::XML(File.read(File.join(work_dir, assessment.qti_file_path)))
+
+      expect(xml.root.attributes['schemaLocation'].value).to eq "http://www.imsglobal.org/xsd/ims_qtiasiv1p2 http://www.imsglobal.org/xsd/ims_qtiasiv1p2p1.xsd"
+      expect(xml.namespaces['xmlns:xsi']).to eq "http://www.w3.org/2001/XMLSchema-instance"
+      expect(xml.namespaces['xmlns']).to eq "http://www.imsglobal.org/xsd/ims_qtiasiv1p2"
+
+      root = xml.at_xpath('xmlns:questestinterop')
+      expect(root).to_not be_nil
+      expect(root.%('assessment').attributes['ident'].value).to eq assessment.identifier
+      expect(root.%('assessment').attributes['title'].value).to eq assessment.title
+
+      meta_fields = root.search('assessment/qtimetadata/qtimetadatafield')
+      expect(meta_fields[0].%('fieldlabel').text).to eq 'qmd_timelimit'
+      expect(meta_fields[0].%('fieldentry').text).to eq assessment.time_limit.to_s
+      expect(meta_fields[1].%('fieldlabel').text).to eq 'cc_maxattempts'
+      expect(meta_fields[1].%('fieldentry').text).to eq assessment.allowed_attempts.to_s
+
+      section = root.%('assessment/section')
+      expect(section.attributes['ident'].value).to eq 'root_section'
+      expect(section.%('item').attributes['ident'].value).to eq question.identifier.to_s
+    end
+
+  end
+end

data/spec/moodle2cc/canvas_cc/assignment_writer_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe Moodle2CC::CanvasCC::AssignmentWriter do
+  subject { Moodle2CC::CanvasCC::AssignmentWriter.new(work_dir, assignment) }
+  let(:work_dir) { Dir.mktmpdir }
+  let(:assignment) { Moodle2CC::CanvasCC::Models::Assignment.new }
+
+  after(:each) do
+    FileUtils.rm_r work_dir
+  end
+
+  it 'creates the assignment settings xml' do
+    assignment.identifier = 'assignment_id'
+    assignment.title = 'Assignment Title'
+    assignment.due_at = Time.parse('Sat, 08 Feb 2014 16:00:00 GMT')
+    assignment.lock_at = Time.parse('Sat, 08 Feb 2014 17:00:00 GMT')
+    assignment.unlock_at = Time.parse('Sat, 08 Feb 2014 18:00:00 GMT')
+    assignment.peer_reviews_due_at = Time.parse('Sat, 08 Feb 2014 19:00:00 GMT')
+    assignment.all_day_date = Time.parse('Sat, 08 Feb 2014 00:00:00 GMT')
+    assignment.assignment_group_identifier_ref = 'assignment_group_id'
+    assignment.workflow_state = 'active'
+    assignment.points_possible = '30'
+    assignment.grading_type = 'points'
+    assignment.all_day = 'true'
+    assignment.submission_types = %w(online_text_entry online_url online_upload)
+    assignment.position = '2'
+    assignment.peer_review_count = '0'
+    assignment.peer_reviews_assigned = 'false'
+    assignment.peer_reviews = 'false'
+    assignment.automatic_peer_reviews = 'true'
+    assignment.grade_group_students_individually = 'false'
+
+    subject.write
+    xml = Nokogiri::XML(File.read(File.join(work_dir, assignment.assignment_resource.files.select{ |f| f.split(//).last(4).join("").to_s == '.xml'}.first)))
+    expect(xml.at_xpath('xmlns:assignment/@identifier').value).to eq('assignment_id')
+    expect(xml.%('assignment/title').text).to eq 'Assignment Title'
+    expect(xml.%('assignment/due_at').text).to eq '2014-02-08T16:00:00'
+    expect(xml.%('assignment/lock_at').text).to eq '2014-02-08T17:00:00'
+    expect(xml.%('assignment/unlock_at').text).to eq '2014-02-08T18:00:00'
+    expect(xml.%('assignment/all_day_date').text).to eq '2014-02-08T00:00:00'
+    expect(xml.%('assignment/peer_reviews_due_at').text).to eq '2014-02-08T19:00:00'
+    expect(xml.%('assignment/assignment_group_identifierref').text).to eq 'assignment_group_id'
+    expect(xml.%('assignment/workflow_state').text).to eq 'active'
+    expect(xml.%('assignment/points_possible').text).to eq '30'
+    expect(xml.%('assignment/grading_type').text).to eq 'points'
+    expect(xml.%('assignment/all_day').text).to eq 'true'
+    expect(xml.%('assignment/submission_types').text).to eq 'online_text_entry,online_url,online_upload'
+    expect(xml.%('assignment/position').text).to eq '2'
+    expect(xml.%('assignment/peer_review_count').text).to eq '0'
+    expect(xml.%('assignment/peer_reviews_assigned').text).to eq 'false'
+    expect(xml.%('assignment/peer_reviews').text).to eq 'false'
+    expect(xml.%('assignment/automatic_peer_reviews').text).to eq 'true'
+    expect(xml.%('assignment/grade_group_students_individually').text).to eq 'false'
+
+  end
+
+  it 'creates the assignment html' do
+    assignment.identifier = 'assignment_id'
+    assignment.title = 'Assignment Title'
+    assignment.body = '<p>My Body Content</p>'
+
+    subject.write
+    html = Nokogiri::HTML(File.read(File.join(work_dir, assignment.assignment_resource.href)))
+
+    expect(html.at_css('meta[http-equiv]')[:'http-equiv']).to eq 'Content-Type'
+    expect(html.at_css('meta[http-equiv]')[:content]).to eq 'text/html; charset=utf-8'
+    expect(html.at_css('title').text).to eq 'Assignment: Assignment Title'
+    expect(html.at_css('body').inner_html.to_s).to eq '<p>My Body Content</p>'
+
+  end
+
+end

data/spec/moodle2cc/canvas_cc/calculated_question_writer_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+module Moodle2CC::CanvasCC
+  describe CalculatedQuestionWriter do
+
+    let(:question) { Moodle2CC::CanvasCC::Models::Question.create('calculated_question')}
+
+    it 'creates the question item xml for a calculated question' do
+      question.identifier = 42
+      question.title = 'hi title'
+      question.general_feedback = 'unconstructive feedback'
+      question.material = 'materlia'
+
+      question.correct_answer_format = '1'
+      question.correct_answer_length = '2'
+      question.tolerance = '0.01'
+
+      answer = Moodle2CC::CanvasCC::Models::Answer.new
+      answer.answer_text = '{A}*{B}'
+      answer.fraction = 1
+      question.answers = [answer]
+
+      question.dataset_definitions = [
+        {
+          :name => 'A',
+          :options => 'uniform:1.0:10.0:1'
+        },
+        {
+          :name => 'B',
+          :options => 'uniform:10.0:20.0:1'
+        }
+      ]
+
+      xml = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |node|
+        QuestionWriter.write_question(node, question)
+      end.doc
+
+      expect(xml.at_xpath('item/@ident').value).to eq question.identifier.to_s
+      expect(xml.at_xpath('item/@title').value).to eq question.title
+      expect(xml.at_xpath("item/itemmetadata/qtimetadata/qtimetadatafield[fieldlabel=\"question_type\" and fieldentry=\"#{question.question_type}\"]")).to_not be_nil
+
+      response = xml.at_xpath('item/presentation/response_str')
+      expect(response.attributes['rcardinality'].value).to eq 'Single'
+      expect(response.attributes['ident'].value).to eq 'response1'
+      expect(response.at_xpath('render_fib').attributes['fibtype'].value).to eq 'Decimal'
+      expect(response.at_xpath('render_fib/response_label').attributes['ident'].value).to eq 'answer1'
+
+      # Correct Condition
+      condition = xml.root.at_xpath('resprocessing/respcondition[@title="correct"]')
+      expect(condition.at_xpath('conditionvar/other')).to_not be_nil
+      setvar = condition.at_xpath('setvar')
+      expect(setvar.text).to eq '100'
+      expect(setvar.attributes['varname'].value).to eq 'SCORE'
+      expect(setvar.attributes['action'].value).to eq 'Set'
+
+      condition = xml.root.at_xpath('resprocessing/respcondition[@title="incorrect"]')
+      expect(condition.at_xpath('conditionvar/other')).to_not be_nil
+      setvar = condition.at_xpath('setvar')
+      expect(setvar.text).to eq '0'
+      expect(setvar.attributes['varname'].value).to eq 'SCORE'
+      expect(setvar.attributes['action'].value).to eq 'Set'
+
+      # Calculations
+      calculated = xml.root.at_xpath('itemproc_extension/calculated')
+      expect(calculated.at_xpath('answer_tolerance').text).to eq question.tolerance
+
+      # Formulas
+      expect(calculated.at_xpath('formulas[@decimal_places="2"]')).to_not be_nil
+      expect(calculated.at_xpath('formulas/formula["A*B"]')).to_not be_nil
+
+      # Var
+      a_var = calculated.at_xpath('vars/var[@scale="1"][@name="A"]')
+      expect(a_var.at_xpath('min').text).to eq '1.0'
+      expect(a_var.at_xpath('max').text).to eq '10.0'
+
+      b_var = calculated.at_xpath('vars/var[@scale="1"][@name="B"]')
+      expect(b_var.at_xpath('min').text).to eq '10.0'
+      expect(b_var.at_xpath('max').text).to eq '20.0'
+    end
+  end
+end