canvas_cc 0.0.1

data/spec/moodle2cc/canvas_cc/question_bank_writer_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+module CanvasCc::CanvasCC
+  describe QuestionBankWriter do
+    subject { CanvasCc::CanvasCC::QuestionBankWriter.new(work_dir, question_bank) }
+    let(:work_dir) { Dir.mktmpdir }
+    let(:question_bank) { CanvasCc::CanvasCC::Models::QuestionBank.new }
+
+    after(:each) do
+      FileUtils.rm_r work_dir
+    end
+
+    it 'creates the question bank xml file' do
+      question = CanvasCc::CanvasCC::Models::Question.new
+      question.identifier = 42
+
+      QuestionWriter.register_writer_type(nil)
+      QuestionWriter.stub(:write_responses)
+      QuestionWriter.stub(:write_response_conditions)
+
+      question_bank.identifier = 'qb_id'
+      question_bank.title = 'Bank title'
+      question_bank.questions = [question]
+
+      subject.write
+      xml = Nokogiri::XML(File.read(File.join(work_dir, question_bank.question_bank_resource.href)))
+
+      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.%('objectbank').attributes['ident'].value).to eq question_bank.identifier
+
+      meta = root.%('objectbank/qtimetadata/qtimetadatafield')
+      expect(meta.%('fieldlabel').text).to eq 'bank_title'
+      expect(meta.%('fieldentry').text).to eq question_bank.title
+
+      expect(root.%('objectbank/item').attributes['ident'].value).to eq question.identifier.to_s
+    end
+  end
+end

data/spec/moodle2cc/canvas_cc/question_writer_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+
+module CanvasCc::CanvasCC
+  describe QuestionWriter do
+    subject { CanvasCc::CanvasCC::QuestionWriter }
+    let(:question) { CanvasCc::CanvasCC::Models::Question.new }
+
+    class FooBarWriter < QuestionWriter
+      def self.write_additional_nodes(item_node, question)
+        write_standard_answer_feedbacks(item_node, question)
+        item_node.randomnode
+      end
+
+      def self.write_responses(item_node, question)
+        item_node.mockresponsesnode
+      end
+
+      def self.write_response_conditions(item_node, question)
+        item_node.mockresponseconditionsnode
+      end
+    end
+
+    before :each do
+      question.question_type = 'foobar_type'
+      FooBarWriter.register_writer_type 'foobar_type'
+    end
+
+    it 'registers a question type for writing' do
+      FooBarWriter.stub(:write_question_item_xml)
+      Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |node|
+        QuestionWriter.write_question(node, question)
+      end
+      expect(FooBarWriter).to have_received(:write_question_item_xml)
+    end
+
+    it 'raises an exception for unknown converter types' do
+      question.question_type = 'nonexistenttype'
+
+      expect {
+        Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |node|
+          QuestionWriter.write_question(node, question)
+        end
+      }.to raise_exception
+    end
+
+    it 'writes item metadata' do
+      question.identifier = 'blah'
+      question.title = 'titled'
+      question.points_possible = 41
+      question.assessment_question_identifierref = 'reffed'
+
+      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
+      expect(xml.at_xpath("item/itemmetadata/qtimetadata/qtimetadatafield[fieldlabel=\"points_possible\" and fieldentry=\"#{question.points_possible}\"]")).to_not be_nil
+      expect(xml.at_xpath("item/itemmetadata/qtimetadata/qtimetadatafield[fieldlabel=\"assessment_question_identifierref\" and fieldentry=\"#{question.assessment_question_identifierref}\"]")).to_not be_nil
+    end
+
+    it 'writes item presentation node' do
+      question.material = 'bunch of stuff in here'
+
+      xml = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |node|
+        QuestionWriter.write_question(node, question)
+      end.doc
+
+      expect(xml.at_xpath('item/presentation/material/mattext[@texttype="text/html"]').text).to eq question.material
+      expect(xml.at_xpath('item/presentation/mockresponsesnode')).to_not be_nil
+    end
+
+    it 'writes item resprocessing node' do
+      xml = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |node|
+        QuestionWriter.write_question(node, question)
+      end.doc
+
+      outcome = xml.at_xpath('item/resprocessing/outcomes/decvar')
+      expect(outcome.attributes['maxvalue'].value).to eq '100'
+      expect(outcome.attributes['minvalue'].value).to eq '0'
+      expect(outcome.attributes['varname'].value).to eq 'SCORE'
+      expect(outcome.attributes['vartype'].value).to eq 'Decimal'
+
+      expect(xml.at_xpath('item/resprocessing/mockresponseconditionsnode')).to_not be_nil
+    end
+
+    it 'writes general feedback' do
+      question.general_feedback = 'here, have some (un)helpful feedback'
+
+      xml = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |node|
+        QuestionWriter.write_question(node, question)
+      end.doc
+
+      general_feedback = xml.at_xpath('item/resprocessing/respcondition[1]')
+      expect(general_feedback.attributes['continue'].value).to eq 'Yes'
+      expect(general_feedback.at_xpath('conditionvar/other')).to_not be_nil
+      expect(general_feedback.at_xpath('displayfeedback').attributes['feedbacktype'].value).to eq 'Response'
+      expect(general_feedback.at_xpath('displayfeedback').attributes['linkrefid'].value).to eq 'general_fb'
+
+      general_feedback = xml.at_xpath('item/itemfeedback[@ident="general_fb"]')
+      expect(general_feedback).to_not be_nil
+      expect(general_feedback.at_xpath('flow_mat/material/mattext[@texttype="text/html"]').text).to eq question.general_feedback
+    end
+
+    it 'writes standard answer feedback if called' do
+      answer = CanvasCc::CanvasCC::Models::Answer.new
+      answer.id = 'an_id'
+      answer.feedback = 'much feedback'
+      question.answers = [answer]
+
+      xml = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |node|
+        QuestionWriter.write_question(node, question)
+      end.doc
+
+      feedback = xml.at_xpath("item/itemfeedback[@ident=\"#{answer.id}_fb\"]/flow_mat/material/mattext[@texttype=\"text/html\"]")
+      expect(feedback.text).to eq answer.feedback
+    end
+
+    it 'writes additional nodes' do
+      xml = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |node|
+        QuestionWriter.write_question(node, question)
+      end.doc
+
+      expect(xml.at_xpath('item/randomnode')).to_not be_nil
+    end
+
+  end
+end

data/spec/moodle2cc/canvas_cc/short_answer_question_writer_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+module CanvasCc::CanvasCC
+  describe ShortAnswerQuestionWriter do
+
+    let(:question) { CanvasCc::CanvasCC::Models::Question.create('short_answer_question')}
+
+    it 'creates the question item xml for an short_answer_question' do
+      question.identifier = 422
+      question.title = 'hi short answer tiftle'
+      question.general_feedback = 'more constructive feedback'
+      question.material = 'materials galore'
+
+      answer = CanvasCc::CanvasCC::Models::Answer.new
+      answer.id = 'answe_id'
+      answer.answer_text = 'the answer'
+      answer.feedback = 'so much feedback'
+      answer.fraction = 1
+      question.answers = [answer]
+
+      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'
+
+      # Conditions
+      condition = xml.at_xpath("item/resprocessing/respcondition[@continue=\"No\"]/conditionvar/varequal[@respident=\"response1\" and text()=\"#{answer.answer_text}\"]/../..")
+      expect(condition).to_not be_nil
+      set_var = condition.at_xpath('setvar[@varname="SCORE" and @action="Set" and text()="100"]')
+      expect(set_var).to_not be_nil
+
+      # Feedback
+      condition = xml.at_xpath("item/resprocessing/respcondition[@continue=\"Yes\"]/conditionvar/varequal[@respident=\"response1\" and text()=\"#{answer.answer_text}\"]/../..")
+      expect(condition).to_not be_nil
+      feedback = condition.at_xpath("displayfeedback[@feedbacktype=\"Response\" and @linkrefid=\"#{answer.id}_fb\"]")
+      expect(feedback).to_not be_nil
+
+      feedback = xml.at_xpath("item/itemfeedback[@ident=\"#{answer.id}_fb\"]/flow_mat/material/mattext[@texttype=\"text/html\"]")
+      expect(feedback.text).to eq answer.feedback
+    end
+  end
+end

data/spec/moodle2cc/canvas_cc/text_only_question_writer_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+module CanvasCc::CanvasCC
+  describe TextOnlyQuestionWriter do
+
+    let(:question) { CanvasCc::CanvasCC::Models::Question.create('text_only_question')}
+
+    it 'creates the question item xml for a true_false_question' do
+      question.identifier = 300
+      question.title = 'hi title and stuff'
+      question.material = 'heressome material'
+
+      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
+      expect(xml.at_xpath('item/presentation/material/mattext[@texttype="text/html"]').text).to eq question.material
+    end
+  end
+end

data/spec/moodle2cc/canvas_cc/true_false_question_writer_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+module CanvasCc::CanvasCC
+  describe TrueFalseQuestionWriter do
+
+    let(:question) { CanvasCc::CanvasCC::Models::Question.create('true_false_question')}
+
+    it 'creates the question item xml for a true_false_question' do
+      question.identifier = 42
+      question.title = 'hi title'
+      question.general_feedback = 'unconstructive feedback'
+      question.material = 'materia'
+
+      true_answer = CanvasCc::CanvasCC::Models::Answer.new
+      true_answer.id = 'tr00'
+      true_answer.fraction = 1.0
+      true_answer.answer_text = 'so true'
+      true_answer.feedback = 'was there ever any doubt?'
+      false_answer = CanvasCc::CanvasCC::Models::Answer.new
+      false_answer.id = 'furse'
+      false_answer.fraction = 0.0
+      false_answer.answer_text = 'falrse'
+      false_answer.feedback = 'bakaaaa'
+      question.answers = [true_answer, false_answer]
+
+      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')
+      expect(response.attributes['rcardinality'].value).to eq 'Single'
+      expect(response.attributes['ident'].value).to eq 'response1'
+
+      expect(response.at_xpath("render_choice/response_label[@ident=\"#{true_answer.id}\"]/material/mattext[@texttype=\"text/html\" and text()=\"#{true_answer.answer_text}\"]")).not_to be_nil
+      expect(response.at_xpath("render_choice/response_label[@ident=\"#{false_answer.id}\"]/material/mattext[@texttype=\"text/html\" and text()=\"#{false_answer.answer_text}\"]")).not_to be_nil
+
+      condition = xml.at_xpath("item/resprocessing/respcondition[@continue=\"No\"]/conditionvar/varequal[@respident=\"response1\" and text()=\"#{true_answer.id}\"]/../..")
+      expect(condition).not_to be_nil
+      feedback = condition.at_xpath("displayfeedback[@feedbacktype=\"Response\" and @linkrefid=\"#{true_answer.id}_fb\"]")
+      expect(feedback).not_to be_nil
+      setvar = condition.at_xpath('setvar[@varname="SCORE" and @action="Set" and text()="100"]')
+      expect(setvar).not_to be_nil
+
+      condition = xml.at_xpath("item/resprocessing/respcondition[@continue=\"No\"]/conditionvar/varequal[@respident=\"response1\" and text()=\"#{false_answer.id}\"]/../..")
+      expect(condition).not_to be_nil
+      feedback = condition.at_xpath("displayfeedback[@feedbacktype=\"Response\" and @linkrefid=\"#{false_answer.id}_fb\"]")
+      expect(feedback).not_to be_nil
+      setvar = condition.at_xpath('setvar[@varname="SCORE" and @action="Set" and text()="0"]')
+      expect(setvar).not_to be_nil
+
+      feedback = xml.at_xpath("item/itemfeedback[@ident=\"#{true_answer.id}_fb\"]/flow_mat/material/mattext[@texttype=\"text/html\"]")
+      expect(feedback.text).to eq true_answer.feedback
+
+      feedback = xml.at_xpath("item/itemfeedback[@ident=\"#{false_answer.id}_fb\"]/flow_mat/material/mattext[@texttype=\"text/html\"]")
+      expect(feedback.text).to eq false_answer.feedback
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rspec'
+require 'canvas_cc'
+require 'tmpdir'
+Dir["./spec/support/**/*.rb"].sort.each {|f| require f}
+
+def fixture_path(path)
+  File.join(File.expand_path("../../test/fixtures", __FILE__), path)
+end
+
+def moodle2_backup_dir
+  fixture_path(File.join('moodle2', 'backup'))
+end

data/spec/support/shared_examples_for_models.rb

@@ -0,0 +1,26 @@
+shared_examples 'it has an attribute for' do |attribute, default_value = nil|
+  it "the attribute '#{attribute}'" do
+    obj = described_class.new
+    expect(obj.send(attribute)).to eq default_value
+    obj.send("#{attribute}=", :foo)
+    expect(obj.send(attribute)).to eq :foo
+  end
+end
+
+shared_examples 'a CanvasCc::CanvasCC::Models::Resource' do
+  it "by inheriting CanvasCc::CanvasCC::Models::Resource" do
+    expect(described_class.ancestors).to include CanvasCc::CanvasCC::Models::Resource
+  end
+end
+
+shared_examples 'a CanvasCc::Moodle2::Models::Quizzes::Question' do
+  it "by inheriting CanvasCc::Moodle2::Models::Quizzes:Question" do
+    expect(described_class.ancestors).to include CanvasCc::Moodle2::Models::Quizzes::Question
+  end
+end
+
+shared_examples 'it is registered as a Question' do |type|
+  it "for the type '#{type}'" do
+    expect(CanvasCc::Moodle2::Models::Quizzes::Question.create(type)).to be_instance_of described_class
+  end
+end

data/test/acceptance/migrator_test.rb

@@ -0,0 +1,24 @@
+puts $LOAD_PATH
+require 'minitest/autorun'
+require 'test_helper'
+require 'moodle2cc'
+
+class TestAcceptanceMigrator < MiniTest::Unit::TestCase
+  include TestHelper
+
+  def setup
+    @source = create_moodle_backup_zip
+    @destination = File.expand_path("../../tmp", __FILE__)
+    @package = File.expand_path("../../tmp/my-course.imscc", __FILE__)
+  end
+
+  def teardown
+    clean_tmp_folder
+  end
+
+  def test_it_creates_a_cc_package
+    migrator = CanvasCc::Migrator.new @source, @destination
+    migrator.migrate
+    assert File.exists?(@package), "#{@package} not created"
+  end
+end

data/test/fixtures/common_cartridge/ims_manifest_simple.xml

@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<manifest identifier="icc16454176b28467d5eaeb311a7a107d" xmlns="http://www.imsglobal.org/xsd/imsccv1p1/imscp_v1p1" xmlns:lom="http://ltsc.ieee.org/xsd/imsccv1p1/LOM/resource" xmlns:lomimscc="http://ltsc.ieee.org/xsd/imsccv1p1/LOM/manifest" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.imsglobal.org/xsd/imsccv1p1/imscp_v1p1 http://www.imsglobal.org/profile/cc/ccv1p1/ccv1p1_imscp_v1p2_v1p0.xsd http://ltsc.ieee.org/xsd/imsccv1p1/LOM/resource http://www.imsglobal.org/profile/cc/ccv1p1/LOM/ccv1p1_lomresource_v1p0.xsd http://ltsc.ieee.org/xsd/imsccv1p1/LOM/manifest http://www.imsglobal.org/profile/cc/ccv1p1/LOM/ccv1p1_lommanifest_v1p0.xsd">
+    <metadata>
+        <schema>IMS Common Cartridge</schema>
+        <schemaversion>1.1.0</schemaversion>
+        <lomimscc:lom>
+            <lomimscc:general>
+                <lomimscc:title>
+                    <lomimscc:string>Sample Course</lomimscc:string>
+                </lomimscc:title>
+            </lomimscc:general>
+            <lomimscc:lifeCycle>
+                <lomimscc:contribute>
+                    <lomimscc:date>
+                        <lomimscc:dateTime>2014-02-05</lomimscc:dateTime>
+                    </lomimscc:date>
+                </lomimscc:contribute>
+            </lomimscc:lifeCycle>
+            <lomimscc:rights>
+                <lomimscc:copyrightAndOtherRestrictions>
+                    <lomimscc:value>yes</lomimscc:value>
+                </lomimscc:copyrightAndOtherRestrictions>
+                <lomimscc:description>
+                    <lomimscc:string>Private (Copyrighted) - http://en.wikipedia.org/wiki/Copyright</lomimscc:string>
+                </lomimscc:description>
+            </lomimscc:rights>
+        </lomimscc:lom>
+    </metadata>
+    <organizations>
+        <organization identifier="org_1" structure="rooted-hierarchy">
+            <item identifier="LearningModules">
+            </item>
+        </organization>
+    </organizations>
+    <resources>
+        <resource identifier="i1df71e5dc5307ca91998f80fc71275e7_syllabus" type="associatedcontent/imscc_xmlv1p1/learning-application-resource" href="course_settings/syllabus.html" intendeduse="syllabus">
+            <file href="course_settings/syllabus.html"/>
+        </resource>
+        <resource identifier="i1df71e5dc5307ca91998f80fc71275e7" type="associatedcontent/imscc_xmlv1p1/learning-application-resource" href="course_settings/canvas_export.txt">
+            <file href="course_settings/course_settings.xml"/>
+            <file href="course_settings/files_meta.xml"/>
+            <file href="course_settings/canvas_export.txt"/>
+        </resource>
+    </resources>
+</manifest>