moodle2cc 0.2.29 → 0.2.30

data/README.md

@@ -1,112 +0,0 @@
-# Moodle2CC
-
-moodle2cc will convert Moodle 1.9 backup files into IMS Common Cartridge 1.1
-formatted files. 
-
-Moodle information: http://moodle.org/
-
-Common Cartridge information: http://www.imsglobal.org/cc/index.html
-
-Use the [Github Issues](https://github.com/instructure/moodle2cc/issues?state=open)
-for feature requests and bug reports.
-
-## Installation/Usage
-
-### Command line
-Install RubyGems on your system, see http://rubygems.org/ for instructions.
-Once RubyGems is installed you can install this gem:
-
-    $ gem install moodle2cc
-
-Convert a moodle .zip into Common Cartridge format
-
-    $ moodle2cc migrate <path-to-moodle-backup> <path-to-cc-export-directory>
-
-Or into a Canvas-enhanced Common Cartridge format
-
-    $ moodle2cc migrate --format=canvas <path-to-moodle-backup> <path-to-cc-export-directory>
-
-### In a Ruby application
-
-Add this line to your application's Gemfile and run `bundle`:
-
-    gem 'moodle2cc'
-
-Require the library in your project and use the migrator:
-
-```ruby
-require 'moodle2cc'
-migrator = Moodle2CC::Migrator.new moodle_zip_path, destination_path
-migrator.migrate
-```
-
-## Caveats
-
-Common Cartridge (CC) does not support all of the concepts in a Moodle course. 
-CC has no concepts such as assignments or wiki pages, so these things have to
-fit into Common Cartridge as best they can. Here are some of the decisions we 
-made about these things:
-
-<table>
-  <tr>
-    <th>Moodle</th>
-    <th>Common Cartridge</th>
-  </tr>
-  <tr>
-    <td>Course Files</td>
-    <td>All files are in the `web_resources` folder, links to files in HTML are 
-    referenced relative to that directory with the token `$IMS_CC_FILEBASE$`.</td>
-  </tr>
-  <tr>
-    <td>Assignments</td>
-    <td>HTML pages in an `assignments` subfolder in `web_resources`. The description 
-    of the assignment is the body of the page and stuff like points possible are
-    in meta fields.</td>
-  </tr>
-  <tr>
-    <td>Wiki Pages</td>
-    <td>HTML pages in a `pages` subfolder in `web_resources`.</td>
-  </tr>
-  <tr>
-    <td>Discussion Topics</td>
-    <td>The titles and bodies of topics are intact in the conversion.</td>
-  </tr>
-  <tr>
-    <td>Grade Items</td>
-    <td>If the grade item is attached to an assignment its data will be in the
-    meta data of the assignment's HTML page. Otherwise it isn't currently converted.</td>
-  </tr>
-  <tr>
-    <td>Assessments (quizzes)</td>
-    <td>TODO - Coming soon! Only the CC-supported question types will be converted
-    to QTI as documented <a href="http://www.imsglobal.org/cc/ccv1p1/imscc_profilev1p1-Implementation.html#_Toc285616469">here</a> </td>
-  </tr>
-  <tr>
-    <td>Question Categories</td>
-    <td>TODO - Coming soon! Common Cartridge only supports having a single question bank, so all banks
-    will be combined into one. <a href="http://www.imsglobal.org/cc/ccv1p1/imscc_profilev1p1-Implementation.html#_Toc285616457">CC Question Bank Docs</a> </td>
-  </tr>
-</table>
-
-## Todo
-
-- [ ] Support exporting to CC 1.3
-- [ ] Support converting to multiple versions of CC?
-- [ ] Quiz conversion
-- [ ] Question Category conversion
-- [ ] LTI configurations?
-- [ ] Convert more Moodle features as requested
-- [ ] Moodle 2 support for standard CC
-- [x] Moodle 2 support for canvas-flavored CC
-
-## 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/moodle2cc.gemspec

@@ -1,35 +0,0 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/moodle2cc/version', __FILE__)
-
-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.homepage      = "https://github.com/instructure/moodle2cc"
-	gem.license = 'AGPLv3'
-
-  gem.add_runtime_dependency "rubyzip", '>=1.0.0'
-  gem.add_runtime_dependency "instructure-happymapper", '~> 0.5.10'
-  gem.add_runtime_dependency "builder"
-  gem.add_runtime_dependency "thor"
-  gem.add_runtime_dependency "nokogiri"
-  gem.add_runtime_dependency "rdiscount"
-
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "minitest"
-  gem.add_development_dependency "rspec", "~> 2"
-  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 "byebug"
-
-
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "moodle2cc"
-  gem.require_paths = ["lib"]
-  gem.version       = Moodle2CC::VERSION
-end

data/spec/moodle2cc/canvas_cc/assessment_writer_spec.rb

@@ -1,95 +0,0 @@
-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

@@ -1,74 +0,0 @@
-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'
-    assignment.muted = true
-
-    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'
-    expect(xml.%('assignment/muted').text).to eq 'true'
-
-  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

@@ -1,88 +0,0 @@
-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'
-        }
-      ]
-
-      question.var_sets = [{:ident => '1', :vars => {'A' => '3.6', 'B' => '3.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'
-
-      # Var sets
-      var_set = calculated.at_xpath('var_sets/var_set[@ident="3631"]')
-      expect(var_set.at_xpath('var[@name="A"]').text).to eq "3.6"
-      expect(var_set.at_xpath('var[@name="B"]').text).to eq "3.1"
-    end
-  end
-end

data/spec/moodle2cc/canvas_cc/canvas_export_writer_spec.rb

@@ -1,26 +0,0 @@
-require 'spec_helper'
-
-module Moodle2CC::CanvasCC
-  describe CanvasExportWriter do
-
-    subject { CanvasExportWriter.new(tmpdir) }
-    let(:tmpdir) { Dir.mktmpdir }
-
-    before :each do
-      Dir.mkdir(File.join(tmpdir, CartridgeCreator::COURSE_SETTINGS_DIR))
-    end
-
-    after :each do
-      FileUtils.rm_r tmpdir
-    end
-
-    it "writes to the export file" do
-      subject.write
-      path = File.join(tmpdir,
-                       CartridgeCreator::COURSE_SETTINGS_DIR,
-                       CanvasExportWriter::CANVAS_EXPORT_FILE)
-      expect(File.exist?(path)).to be_true
-    end
-
-  end
-end

data/spec/moodle2cc/canvas_cc/cartridge_creator_spec.rb

@@ -1,50 +0,0 @@
-require 'spec_helper'
-
-module Moodle2CC::CanvasCC
-  describe CartridgeCreator do
-    subject { CartridgeCreator.new(course) }
-
-    let(:tmpdir) { Dir.mktmpdir }
-    let(:course) { Models::Course.new }
-
-    before :each do
-      course.identifier = 'setting'
-      course.title = 'My Course'
-      course.canvas_modules << Models::CanvasModule.new
-
-      CanvasExportWriter.any_instance.stub(:write)
-      CourseSettingWriter.any_instance.stub(:write)
-      ModuleMetaWriter.any_instance.stub(:write)
-      ImsManifestGenerator.any_instance.stub(:write)
-      FileMetaWriter.any_instance.stub(:write)
-      PageWriter.any_instance.stub(:write)
-      DiscussionWriter.any_instance.stub(:write)
-      AssignmentWriter.any_instance.stub(:write)
-      QuestionBankWriter.any_instance.stub(:write)
-    end
-
-    after :each do
-      FileUtils.rm_r tmpdir
-    end
-
-    [CanvasExportWriter, CourseSettingWriter, ModuleMetaWriter, ImsManifestGenerator,
-     FileMetaWriter, PageWriter, DiscussionWriter, AssignmentWriter, QuestionBankWriter].each do |klass|
-      it "writes #{klass}" do
-        writer_double = double(write: nil)
-        klass.stub(:new).and_return(writer_double)
-        subject.create(tmpdir)
-        expect(writer_double).to have_received(:write)
-      end
-    end
-
-    describe 'filename' do
-      ['My Stuff', 'my/stuff', 'my.stuff', 'my-stuff', 'my--stuff', 'my---stuff', 'my-./stuff'].each do |title|
-        it "with course title: #{title}" do
-          course.title = title
-          expect(subject.filename).to eq('my_stuff.imscc')
-        end
-      end
-    end
-
-  end
-end