moodle2cc 0.1.12 → 0.2.0

data/spec/moodle2cc/canvas_cc/canvas_export_writer_spec.rb

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

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

data/spec/moodle2cc/canvas_cc/course_setting_writer_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+module Moodle2CC::CanvasCC
+  describe CourseSettingWriter do
+
+    let(:course) { Moodle2CC::CanvasCC::Models::Course.new }
+    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 'xml contains the correct schema' do
+      course.identifier = 'identifier'
+      xml = write_xml(course)
+
+      valid_schema = File.read(fixture_path(File.join('common_cartridge', 'schema', 'cccv1p0.xsd')))
+      xsd = Nokogiri::XML::Schema(valid_schema)
+      expect(xsd.validate(xml)).to be_true
+    end
+
+    it 'applies settings to xml' do
+      course.title = 'course title'
+      course.course_code = 'course code'
+      course.identifier = 'settings_id'
+      xml = write_xml(course)
+      expect(xml.at_xpath('/xmlns:course/@identifier').text).to eq('settings_id_settings')
+      expect(xml.at_xpath('/xmlns:course/xmlns:title').text).to eq(course.title)
+      expect(xml.at_xpath('/xmlns:course/xmlns:course_code').text).to eq(course.course_code)
+    end
+
+    private
+
+    def write_xml(course)
+      CourseSettingWriter.new(tmpdir, course).write
+      path = File.join(tmpdir,
+                       CartridgeCreator::COURSE_SETTINGS_DIR,
+                       CourseSettingWriter::COURSE_SETTINGS_FILE)
+      Nokogiri::XML(File.read(path))
+    end
+
+  end
+end

data/spec/moodle2cc/canvas_cc/discussion_writer_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Moodle2CC::CanvasCC::DiscussionWriter do
+  subject(:writer) { Moodle2CC::CanvasCC::DiscussionWriter.new(work_dir, discussion) }
+  let(:work_dir) { Dir.mktmpdir }
+  let(:discussion) {Moodle2CC::CanvasCC::Models::Discussion.new}
+
+  after(:each) do
+    FileUtils.rm_r work_dir
+  end
+
+  it 'creates the discussion xml' do
+    discussion.identifier = 'discussion_id'
+    discussion.title = 'Discussion Title'
+    discussion.text = '<p>discussion_text</p>'
+    writer.write
+    xml = Nokogiri::XML(File.read(File.join(work_dir, discussion.discussion_resource.files.first)))
+    expect(xml.%('topic/title').text).to eq 'Discussion Title'
+    expect(xml.%('topic/text').text).to eq '<p>discussion_text</p>'
+    expect(xml.at_xpath('xmlns:topic/xmlns:text/@texttype').value).to eq('text/html')
+  end
+
+  it 'creates the meta xml' do
+    discussion.identifier = 'discussion_id'
+    discussion.title = 'Discussion Title'
+    discussion.text = '<p>discussion_text</p>'
+    discussion.discussion_type = 'threaded'
+    writer.write
+    xml = Nokogiri::XML(File.read(File.join(work_dir, discussion.meta_resource.href)))
+    expect(xml.at_xpath('xmlns:topicMeta/@identifier').value).to eq('discussion_id_meta')
+    expect(xml.%('topicMeta/topic_id').text).to eq 'discussion_id'
+    expect(xml.%('topicMeta/title').text).to eq 'Discussion Title'
+    expect(xml.%('topicMeta/type').text).to eq 'topic'
+    expect(xml.%('topicMeta/position').text).to eq ''
+    expect(xml.%('topicMeta/discussion_type').text).to eq 'threaded'
+  end
+
+end

data/spec/moodle2cc/canvas_cc/essay_question_writer_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+module Moodle2CC::CanvasCC
+  describe EssayQuestionWriter do
+
+    let(:question) { Moodle2CC::CanvasCC::Models::Question.create('essay_question')}
+
+    it 'creates the question item xml for an essay_question' do
+      question.identifier = 42
+      question.title = 'hi title'
+      question.general_feedback = 'unconstructive feedback'
+      question.material = 'materia'
+
+      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/response_label').attributes['ident'].value).to eq 'answer1'
+
+      condition = xml.root.at_xpath('resprocessing/respcondition[@continue="No"]')
+      expect(condition.at_xpath('conditionvar/other')).to_not be_nil
+    end
+  end
+end

data/spec/moodle2cc/canvas_cc/file_meta_writer_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+module Moodle2CC::CanvasCC
+  describe FileMetaWriter do
+
+    let(:file) { Models::CanvasFile.new }
+    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 'xml contains the correct schema' do
+      meta_writer = writer(file)
+      meta_writer.stub(:copy_files) { nil }
+      xml = write_xml(meta_writer)
+      assert_xml_schema(xml)
+    end
+
+    it '#write' do
+      Dir.mktmpdir do |dir|
+        source_file = File.join(dir, 'sample.txt')
+        FileUtils.touch(source_file)
+        file.file_location = source_file
+        file.file_path = 'sample.txt'
+        write_xml(writer(file))
+        path = File.join(tmpdir, Models::CanvasFile::WEB_RESOURCES, 'sample.txt')
+        expect(File.exist?(path)).to be_true
+      end
+    end
+
+    private
+
+    def writer(file)
+      FileMetaWriter.new(tmpdir, file)
+    end
+
+    def write_xml(writer)
+      writer.write
+      path = File.join(tmpdir,
+                       CartridgeCreator::COURSE_SETTINGS_DIR,
+                       FileMetaWriter::FILE_META_FILE)
+      Nokogiri::XML(File.read(path))
+    end
+
+    def assert_xml_schema(xml)
+      valid_schema = File.read(fixture_path(File.join('common_cartridge', 'schema', 'cccv1p0.xsd')))
+      xsd = Nokogiri::XML::Schema(valid_schema)
+      expect(xsd.validate(xml)).to be_empty
+    end
+
+  end
+end

data/spec/moodle2cc/canvas_cc/ims_manifest_generator_spec.rb

@@ -0,0 +1,141 @@
+require 'spec_helper'
+
+module Moodle2CC::CanvasCC
+  describe ImsManifestGenerator do
+
+    let(:course) { Models::Course.new }
+    let(:tmpdir) { Dir.mktmpdir }
+
+    before :each do
+      course.identifier = 'manifest_identifier'
+    end
+
+    after :each do
+      FileUtils.rm_r tmpdir
+    end
+
+    it 'xml contains the correct schema' do
+      course.title = 'Course Title'
+      course.copyright = 'copyright text'
+      xml = write_xml(course)
+      assert_xml_schema(xml)
+    end
+
+    describe 'metadata' do
+      it 'has valid metadata' do
+        course.title = 'Course Title'
+        xml = write_xml(course)
+
+        expect(xml.at_xpath('/xmlns:manifest/xmlns:metadata/xmlns:schema').text).to eq('IMS Common Cartridge')
+        expect(xml.at_xpath('/xmlns:manifest/xmlns:metadata/xmlns:schemaversion').text).to eq('1.1.0')
+
+        lom = xml.at_xpath('/xmlns:manifest/xmlns:metadata/lomimscc:lom')
+        expect(lom.at_xpath('lomimscc:general/lomimscc:title/lomimscc:string').text).to eq(course.title)
+      end
+
+      it 'has copyright' do
+        course.copyright = 'copyright text'
+        xml = write_xml(course)
+
+        lom = xml.at_xpath('/xmlns:manifest/xmlns:metadata/lomimscc:lom')
+        expect(lom.at_xpath('lomimscc:rights/lomimscc:copyrightAndOtherRestrictions/lomimscc:value').text).to eq('yes')
+        expect(lom.at_xpath('lomimscc:rights/lomimscc:description/lomimscc:string').text).to eq(course.copyright)
+      end
+
+      it 'has no copyright' do
+        xml = write_xml(course)
+
+        lom = xml.at_xpath('/xmlns:manifest/xmlns:metadata/lomimscc:lom')
+        expect(lom.at_xpath('lomimscc:rights/lomimscc:copyrightAndOtherRestrictions/lomimscc:value').text).to eq('no')
+        expect(lom.at_xpath('lomimscc:rights/lomimscc:description/lomimscc:string')).to be_nil
+      end
+    end
+
+    describe 'resources' do
+      it 'has valid resource settings' do
+        course.canvas_modules << Models::CanvasModule.new
+        xml = write_xml(course)
+
+        resources_node = xml.%('manifest/resources')
+        expect(resources_node.at_xpath('xmlns:resource/@href').value).to eq('course_settings/canvas_export.txt')
+        expect(resources_node.at_xpath('xmlns:resource/@type').value).to eq('associatedcontent/imscc_xmlv1p1/learning-application-resource')
+        expect(resources_node.at_xpath('xmlns:resource/@identifier').value).to eq('manifest_identifier_settings')
+
+        files = resources_node.xpath('xmlns:resource/xmlns:file/@href').map(&:value)
+        expect(files).to include('course_settings/course_settings.xml')
+        expect(files).to include('course_settings/module_meta.xml')
+      end
+
+      it 'has valid resource' do
+        resource = Models::Resource.new
+        resource.identifier = 'resource_identifier'
+        resource.type = 'resource_type'
+        resource.href = 'resource_href'
+        resource.files << 'file_1'
+        resource.files << 'file_2'
+        resource.dependencies << :dependency
+        course.resources << resource
+        xml = write_xml(course)
+
+        base_node = xml.at_xpath("/xmlns:manifest/xmlns:resources/xmlns:resource[@identifier='resource_identifier']")
+        expect(base_node.at_xpath('@type').value).to eq('resource_type')
+        expect(base_node.at_xpath('@href').value).to eq('resource_href')
+        expect(base_node.xpath("xmlns:file[@href='file_1']").count).to eq(1)
+        expect(base_node.xpath("xmlns:file[@href='file_2']").count).to eq(1)
+        expect(base_node.xpath("xmlns:dependency[@identifierref='dependency']").count).to eq(1)
+      end
+    end
+
+    describe 'organizations' do
+      it 'writes learning modules' do
+        canvas_module = Models::CanvasModule.new
+        canvas_module.title = 'my module title'
+        canvas_module.identifier = 'my_id'
+        course.canvas_modules << canvas_module
+        xml = write_xml(course)
+
+        org_node = xml.at_xpath('/xmlns:manifest/xmlns:organizations/xmlns:organization')
+        expect(org_node.at_xpath('@structure').value).to eq('rooted-hierarchy')
+        expect(org_node.at_xpath('@identifier').value).to eq('org_1')
+        expect(org_node.at_xpath('xmlns:item/@identifier').value).to eq('LearningModules')
+        expect(org_node.at_xpath('xmlns:item/xmlns:item/@identifier').value).to eq('my_id')
+        expect(org_node.%('item/title').text).to eq('my module title')
+      end
+
+      it 'writes module items' do
+        canvas_module = Models::CanvasModule.new
+
+        module_item = Models::ModuleItem.new
+        module_item.identifier = 'module_item_unique_identifier'
+        module_item.title = 'Module Item'
+        module_item.identifierref = 'resource_unique_identifier'
+
+        canvas_module.module_items << module_item
+        course.canvas_modules << canvas_module
+
+        xml = write_xml(course)
+        module_node = xml.at_xpath('/xmlns:manifest').%('organizations/organization/item/item')
+        expect(module_node.at_xpath('xmlns:item/@identifier').value).to eq 'module_item_unique_identifier'
+        expect(module_node.at_xpath('xmlns:item/@identifierref').value).to eq 'resource_unique_identifier'
+        expect(module_node.%('item/title').text).to eq 'Module Item'
+      end
+    end
+
+    private
+
+    def write_xml(course)
+      generator = ImsManifestGenerator.new(tmpdir, course)
+      generator.write
+
+      path = File.join(tmpdir, ImsManifestGenerator::MANIFEST_FILE_NAME)
+      Nokogiri::XML(File.read(path))
+    end
+
+    def assert_xml_schema(xml)
+      valid_schema = File.read(fixture_path(File.join('common_cartridge', 'schema', 'ccv1p1_imscp_v1p2_v1p0.xsd')))
+      xsd = Nokogiri::XML::Schema(valid_schema)
+      expect(xsd.validate(xml)).to be_empty
+    end
+
+  end
+end

data/spec/moodle2cc/canvas_cc/matching_question_writer_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+module Moodle2CC::CanvasCC
+  describe MatchingQuestionWriter do
+
+    let(:question) { Moodle2CC::CanvasCC::Models::Question.create('matching_question')}
+
+    it 'creates the question item xml for a matching question' do
+      question.identifier = 9001
+      question.title = 'its over nine thousannnd'
+      question.general_feedback = 'ur totes awesome'
+      question.material = 'this is a question, or is it?'
+
+      match1 = {:id => '1', :question_text => 'qtext', :question_text_format => '1', :answer_text => 'answer1'}
+      match2 = {:id => '2', :question_text => 'qtext2', :question_text_format => '1', :answer_text => 'answer2'}
+      question.matches = [match1, match2]
+
+      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_lid[@ident=\"response_#{match1[:id]}\"]")
+      expect(response.at_xpath('material/mattext[@texttype="text/html"]').text).to eq match1[:question_text]
+      expect(response.at_xpath("render_choice/response_label[@ident=\"#{match1[:id]}\"]/material/mattext").text).to eq match1[:answer_text]
+      expect(response.at_xpath("render_choice/response_label[@ident=\"#{match2[:id]}\"]/material/mattext").text).to eq match2[:answer_text]
+
+      response = xml.at_xpath("item/presentation/response_lid[@ident=\"response_#{match2[:id]}\"]")
+      expect(response.at_xpath('material/mattext[@texttype="text/html"]').text).to eq match2[:question_text]
+      expect(response.at_xpath("render_choice/response_label[@ident=\"#{match1[:id]}\"]/material/mattext").text).to eq match1[:answer_text]
+      expect(response.at_xpath("render_choice/response_label[@ident=\"#{match2[:id]}\"]/material/mattext").text).to eq match2[:answer_text]
+
+      condition = xml.at_xpath("item/resprocessing/respcondition/conditionvar[varequal=\"#{match1[:id]}\"]/..")
+      expect(condition.at_xpath("conditionvar/varequal[@respident=\"response_#{match1[:id]}\"]")).not_to be_nil
+      set_var = condition.at_xpath('setvar')
+      expect(set_var.attributes['varname'].value).to eq 'SCORE'
+      expect(set_var.attributes['action'].value).to eq 'Add'
+      expect(set_var.text).to eq '50.00'
+
+      condition = xml.at_xpath("item/resprocessing/respcondition/conditionvar[varequal=\"#{match2[:id]}\"]/..")
+      expect(condition.at_xpath("conditionvar/varequal[@respident=\"response_#{match2[:id]}\"]")).not_to be_nil
+      set_var = condition.at_xpath('setvar')
+      expect(set_var.attributes['varname'].value).to eq 'SCORE'
+      expect(set_var.attributes['action'].value).to eq 'Add'
+      expect(set_var.text).to eq '50.00'
+    end
+  end
+end