canvas_cc 0.0.1

data/test/unit/cc/question_test.rb

@@ -0,0 +1,54 @@
+require 'nokogiri'
+require 'minitest/autorun'
+require 'test_helper'
+require 'test_question_helper'
+require 'moodle2cc'
+
+class TestUnitCCQuestion < MiniTest::Unit::TestCase
+  include TestHelper
+  include TestQuestionHelper
+
+  def setup
+    convert_moodle_backup
+    @mod = @backup.course.mods.find { |mod| mod.mod_type == 'quiz' }
+    @question = @mod.questions.first
+  end
+
+  def teardown
+    clean_tmp_folder
+  end
+
+  def test_it_converts_id
+    @question.id = 989
+    question = CanvasCc::CC::Question.new @question
+    assert_equal 989, question.id
+  end
+
+  def test_it_converts_title
+    @question.name = "Basic Arithmetic"
+    question = CanvasCc::CC::Question.new @question
+    assert_equal "Basic Arithmetic", question.title
+  end
+
+  def test_it_converts_title_with_escaped_html
+    @question.name = "the &lt;div&gt; tag"
+    question = CanvasCc::Canvas::Question.new @question
+    assert_equal "the <div> tag", question.title
+  end
+
+  def test_it_has_an_identifier_based_on_id
+    @question.id = 989
+    @question.instance_id = nil
+    question = CanvasCc::CC::Question.new @question
+    assert_equal 'i04823ed56ffd4fd5f9c21db0cf25be6c', question.identifier
+    # question_989
+  end
+
+  def test_it_has_an_identifier_based_on_instance_id
+    @question.instance_id = 787
+    question = CanvasCc::CC::Question.new @question
+    assert_equal 'i2edcb021d100c968ba3f570253a6aa1c', question.identifier
+    # question_instance_787
+  end
+
+end

data/test/unit/cc/web_content_test.rb

@@ -0,0 +1,76 @@
+require 'nokogiri'
+require 'minitest/autorun'
+require 'test_helper'
+require 'moodle2cc'
+
+class TestUnitCCWebContent < MiniTest::Unit::TestCase
+  include TestHelper
+
+  def setup
+    convert_moodle_backup
+    @mod = @backup.course.mods.find { |m| m.mod_type == "resource" && m.type == "html" }
+  end
+
+  def teardown
+    clean_tmp_folder
+  end
+
+  def test_it_converts_id
+    @mod.id = 543
+
+    web_content = CanvasCc::CC::WebContent.new @mod
+    assert_equal 543, web_content.id
+  end
+
+  def test_it_converts_title
+    @mod.name = "Instructor Resources"
+
+    web_content = CanvasCc::CC::WebContent.new @mod
+    assert_equal "Instructor Resources", web_content.title
+  end
+
+  def test_it_converts_body
+    @mod.alltext = %(<h1>Hello World</h1><img src="$@FILEPHP@$$@SLASH@$folder$@SLASH@$stuff.jpg" />)
+
+    web_content = CanvasCc::CC::WebContent.new @mod
+    assert_equal %(<h1>Hello World</h1><img src="$IMS_CC_FILEBASE$/folder/stuff.jpg" />), web_content.body
+  end
+
+  def test_it_has_an_identifier
+    @mod.id = 543
+
+    web_content = CanvasCc::CC::WebContent.new @mod
+    assert_equal 'i6447ff05ab6e342a42302007a6e3bcb4', web_content.identifier
+  end
+
+  def test_it_creates_resource_in_imsmanifest
+    web_content = CanvasCc::CC::WebContent.new @mod
+    node = Builder::XmlMarkup.new
+    xml = Nokogiri::XML(web_content.create_resource_node(node))
+
+    resource = xml.xpath('resource').first
+    assert resource
+    assert_equal 'webcontent', resource.attributes['type'].value
+    assert_equal 'i6447ff05ab6e342a42302007a6e3bcb4', resource.attributes['identifier'].value
+    assert_equal CanvasCc::CC::CCHelper::CC_WIKI_FOLDER + '/instructor-resources.html', resource.attributes['href'].value
+
+    file = resource.xpath(%{file[@href="#{CanvasCc::CC::CCHelper::CC_WIKI_FOLDER}/instructor-resources.html"]}).first
+    assert file
+  end
+
+  def test_it_creates_html
+    @mod.id = 543
+    @mod.name = "Instructor Resources"
+    @mod.alltext = "<p><strong>Instructor Resources</strong></p>"
+
+    tmp_dir = File.expand_path('../../../tmp', __FILE__)
+    web_content = CanvasCc::CC::WebContent.new @mod
+    web_content.create_html(tmp_dir)
+    html = Nokogiri::HTML(File.read(File.join(tmp_dir, CanvasCc::CC::CCHelper::CC_WIKI_FOLDER, 'instructor-resources.html')))
+
+    assert html
+    assert_equal 'i6447ff05ab6e342a42302007a6e3bcb4', html.search('head meta[name="identifier"]').first.attributes['content'].value
+    assert_equal "Instructor Resources", html.search('title').text
+    assert_equal "<p><strong>Instructor Resources</strong></p>", html.search('body').inner_html.strip
+  end
+end

data/test/unit/cc/web_link_test.rb

@@ -0,0 +1,159 @@
+require 'nokogiri'
+require 'minitest/autorun'
+require 'test_helper'
+require 'moodle2cc'
+
+class TestUnitCCWebLink < MiniTest::Unit::TestCase
+  include TestHelper
+
+  def setup
+    convert_moodle_backup
+    @mod = @backup.course.mods.find { |m| m.mod_type == "resource" && m.type == "file" }
+  end
+
+  def teardown
+    clean_tmp_folder
+  end
+
+  def test_it_converts_id
+    @mod.id = 123
+
+    web_link = CanvasCc::CC::WebLink.new @mod
+    assert_equal 123, web_link.id
+  end
+
+  def test_it_converts_title
+    @mod.name = "About Your Instructor"
+
+    web_link = CanvasCc::CC::WebLink.new @mod
+    assert_equal "About Your Instructor", web_link.title
+  end
+
+  def test_it_converts_url
+    @mod.reference = "http://en.wikipedia.org/wiki/Einstein"
+
+    web_link = CanvasCc::CC::WebLink.new @mod
+    assert_equal "http://en.wikipedia.org/wiki/Einstein", web_link.url
+  end
+
+  def test_it_strips_whitespace_from_url
+    @mod.reference = " http://en.wikipedia.org/wiki/Einstein "
+
+    web_link = CanvasCc::CC::WebLink.new @mod
+    assert_equal "http://en.wikipedia.org/wiki/Einstein", web_link.url
+  end
+
+  def test_it_converts_external_link
+    @mod.reference = "http://en.wikipedia.org/wiki/Einstein"
+    web_link = CanvasCc::CC::WebLink.new @mod
+    assert_equal true, web_link.external_link
+
+    @mod.reference = "files/myfile.txt"
+    web_link = CanvasCc::CC::WebLink.new @mod
+    assert_equal false, web_link.external_link
+  end
+
+  def test_it_converts_external_link_with_spaces_in_the_url
+    @mod.reference = "http://en.wikipedia.org/wiki/Einstein with a Space"
+    web_link = CanvasCc::CC::WebLink.new @mod
+    assert_equal true, web_link.external_link
+
+    @mod.reference = "files/my file.txt"
+    web_link = CanvasCc::CC::WebLink.new @mod
+    assert_equal false, web_link.external_link
+  end
+
+  def test_it_converts_external_link_with_completely_invalid_url
+    @mod.reference = 'http://!@#$%^&*'
+    web_link = CanvasCc::CC::WebLink.new @mod
+    assert_equal true, web_link.external_link
+
+    @mod.reference = 'files/!@#$%^&*.txt'
+    web_link = CanvasCc::CC::WebLink.new @mod
+    assert_equal false, web_link.external_link
+  end
+
+  def test_if_converts_href
+    @mod.reference = "http://en.wikipedia.org/wiki/Einstein"
+    web_link = CanvasCc::CC::WebLink.new @mod
+    assert_equal "#{web_link.identifier}.xml", web_link.href
+
+    @mod.reference = "files/myfile.txt"
+    web_link = CanvasCc::CC::WebLink.new @mod
+    assert_equal 'web_resources/files/myfile.txt', web_link.href
+  end
+
+  def test_it_has_an_identifier_for_external_link
+    @mod.id = 123
+
+    web_link = CanvasCc::CC::WebLink.new @mod
+    assert_equal 'iecc4b622fbc1adf8b8a2085e0974ac7d', web_link.identifier
+  end
+
+  def test_it_has_an_identifier_for_local_file
+    @mod.reference = "files/myfile.txt"
+
+    web_link = CanvasCc::CC::WebLink.new @mod
+    assert_equal 'i5cfabae035bff8857137d83c2a067809', web_link.identifier
+  end
+
+  def test_it_creates_resource_in_imsmanifest_for_external_link
+    @mod.reference = "http://en.wikipedia.org/wiki/Einstein"
+    web_link = CanvasCc::CC::WebLink.new @mod
+    node = Builder::XmlMarkup.new
+    xml = Nokogiri::XML(web_link.create_resource_node(node))
+
+    resource = xml.xpath('resource').first
+    assert resource
+    assert_equal 'imswl_xmlv1p1', resource.attributes['type'].value
+    assert_equal 'i15aaccec404aa2ad557108a689bbba8f', resource.attributes['identifier'].value
+
+    file = resource.xpath('file[@href="i15aaccec404aa2ad557108a689bbba8f.xml"]').first
+    assert file
+  end
+
+  def test_it_creates_resource_in_imsmanifest_for_local_file
+    @mod.reference = "files/myfile.txt"
+    web_link = CanvasCc::CC::WebLink.new @mod
+    node = Builder::XmlMarkup.new
+    xml = Nokogiri::XML(web_link.create_resource_node(node))
+
+    resource = xml.xpath('resource').first
+    assert resource
+    assert_equal 'webcontent', resource.attributes['type'].value
+    assert_equal 'web_resources/files/myfile.txt', resource.attributes['href'].value
+    assert_equal 'i5cfabae035bff8857137d83c2a067809', resource.attributes['identifier'].value
+
+    file = resource.xpath('file[@href="web_resources/files/myfile.txt"]').first
+    assert file
+  end
+
+  def test_it_creates_xml
+    @mod.id = 123
+    @mod.name = "About Your Instructor"
+    @mod.reference = "http://en.wikipedia.org/wiki/Einstein"
+
+    tmp_dir = File.expand_path('../../../tmp', __FILE__)
+    web_link = CanvasCc::CC::WebLink.new @mod
+    web_link.create_xml(tmp_dir)
+    xml = Nokogiri::XML(File.read(File.join(tmp_dir, "#{web_link.identifier}.xml")))
+
+    assert xml
+    assert_equal "http://www.imsglobal.org/xsd/imsccv1p1/imswl_v1p1 http://www.imsglobal.org/profile/cc/ccv1p1/ccv1p1_imswl_v1p1.xsd", xml.root.attributes['schemaLocation'].value
+    assert_equal "http://www.w3.org/2001/XMLSchema-instance", xml.namespaces['xmlns:xsi']
+    assert_equal "http://www.imsglobal.org/xsd/imsccv1p1/imswl_v1p1", xml.namespaces['xmlns']
+    assert_equal web_link.identifier, xml.xpath('xmlns:webLink').first.attributes['identifier'].value
+
+    assert_equal "About Your Instructor", xml.xpath('xmlns:webLink/xmlns:title').text
+    assert xml.xpath('xmlns:webLink/xmlns:url[@href="http://en.wikipedia.org/wiki/Einstein"]').first
+  end
+
+  def test_it_does_not_create_xml_for_local_files
+    @mod.reference = "files/myfile.txt"
+
+    tmp_dir = File.expand_path('../../../tmp', __FILE__)
+    web_link = CanvasCc::CC::WebLink.new @mod
+    web_link.create_xml(tmp_dir)
+    refute File.exists?(File.join(tmp_dir, "#{web_link.identifier}.xml")), 'xml file was created for local file'
+  end
+end

data/test/unit/cc/wiki_test.rb

@@ -0,0 +1,139 @@
+require 'nokogiri'
+require 'minitest/autorun'
+require 'test_helper'
+require 'test_wiki_helper'
+require 'moodle2cc'
+
+class TestUnitCCWiki < MiniTest::Unit::TestCase
+  include TestHelper
+  include TestWikiHelper
+
+  def setup
+    convert_moodle_backup
+    @mod = @backup.course.mods.find { |m| m.mod_type == "wiki" }
+    @wiki = CanvasCc::CC::Wiki.new @mod
+  end
+
+  def teardown
+    clean_tmp_folder
+  end
+
+  def test_it_converts_id
+    @mod.id = 210
+    wiki = CanvasCc::CC::Wiki.new @mod
+    assert_equal 210, wiki.id
+  end
+
+  def test_it_converts_title
+    @mod.name = 'My Wiki'
+    wiki = CanvasCc::CC::Wiki.new @mod
+    assert_equal 'My Wiki', wiki.title
+  end
+
+  def test_it_converts_page_name
+    @mod.name = 'My Wiki'
+    wiki = CanvasCc::CC::Wiki.new @mod
+    assert_equal 'My Wiki', wiki.title
+  end
+
+  def test_it_converts_pages
+    pages!
+    wiki = CanvasCc::CC::Wiki.new @mod
+    assert_equal 2, wiki.pages.length
+
+    assert_equal 'My Wiki', wiki.pages[0].title
+    assert_equal 'Second version', wiki.pages[0].body
+    assert_equal CanvasCc::CC::CCHelper::CC_WIKI_FOLDER + '/my-wiki-my-wiki.html', wiki.pages[0].href
+    assert_equal 'i2eb0de275c9d8430f49bbf4cdf96286c', wiki.pages[0].identifier
+
+    assert_equal 'New Page', wiki.pages[1].title
+    assert_equal 'This is a link to [My Wiki]', wiki.pages[1].body
+    assert_equal CanvasCc::CC::CCHelper::CC_WIKI_FOLDER + '/my-wiki-new-page.html', wiki.pages[1].href
+    assert_equal 'i2eb0de275c9d8430f49bbf4cdf96286c', wiki.pages[0].identifier
+  end
+
+  def test_it_converts_summary_to_page_if_no_pages_exist
+    @mod.page_name = 'My Wiki'
+    @mod.summary = 'This is the summary'
+    @mod.pages = []
+
+    wiki = CanvasCc::CC::Wiki.new @mod
+    assert_equal 1, wiki.pages.length
+
+    assert_equal 'My wiki', wiki.pages[0].title
+    assert_equal 'This is the summary', wiki.pages[0].body
+    assert_equal CanvasCc::CC::CCHelper::CC_WIKI_FOLDER + '/my-wiki.html', wiki.pages[0].href
+    assert_equal 'ib1bfc2398c654e88470adb5a882f83e5', wiki.pages[0].identifier
+  end
+
+  def test_it_has_a_root_page_for_defined_pages
+    pages!
+    wiki = CanvasCc::CC::Wiki.new @mod
+    page = wiki.pages.find { |page| page.title == 'My Wiki' }
+    assert_equal page, wiki.root_page
+  end
+
+  def test_it_has_a_root_page_for_summary
+    @mod.page_name = 'My Wiki'
+    @mod.summary = 'This is the summary'
+    @mod.pages = []
+
+    wiki = CanvasCc::CC::Wiki.new @mod
+    page = wiki.pages.first
+    assert_equal page, wiki.root_page
+  end
+
+  def test_it_has_a_identifier_for_root_page
+    @mod.page_name = 'My Wiki'
+    @mod.summary = 'This is the summary'
+    @mod.pages = []
+
+    wiki = CanvasCc::CC::Wiki.new @mod
+    assert_equal 'ib1bfc2398c654e88470adb5a882f83e5', wiki.identifier
+  end
+
+  def test_it_creates_resource_in_imsmanifest
+    wiki = CanvasCc::CC::Wiki.new @mod
+    node = Builder::XmlMarkup.new
+    xml = node.root do |root_node|
+      wiki.create_resource_node(node)
+    end
+    xml = Nokogiri::XML(xml)
+
+    resource = xml.root.xpath('resource[1]').first
+    assert resource
+    assert_equal 'webcontent', resource.attributes['type'].value
+    assert_equal CanvasCc::CC::CCHelper::CC_WIKI_FOLDER + '/my-wiki-link.html', resource.attributes['href'].value
+    assert_equal 'ie8b2c8b5a9156a6994b13abae6b18da6', resource.attributes['identifier'].value
+
+    file = resource.xpath(%{file[@href="#{CanvasCc::CC::CCHelper::CC_WIKI_FOLDER}/my-wiki-link.html"]}).first
+    assert file
+
+    resource = xml.root.xpath('resource[2]').first
+    assert resource
+    assert_equal 'webcontent', resource.attributes['type'].value
+    assert_equal CanvasCc::CC::CCHelper::CC_WIKI_FOLDER + '/my-wiki-my-wiki.html', resource.attributes['href'].value
+    assert_equal 'i2eb0de275c9d8430f49bbf4cdf96286c', resource.attributes['identifier'].value
+
+    file = resource.xpath(%{file[@href="#{CanvasCc::CC::CCHelper::CC_WIKI_FOLDER}/my-wiki-my-wiki.html"]}).first
+    assert file
+  end
+
+  def test_it_creates_wiki_html
+    wiki = CanvasCc::CC::Wiki.new @mod
+    tmp_dir = File.expand_path('../../../tmp', __FILE__)
+    wiki.create_html(tmp_dir)
+
+    html = Nokogiri::HTML(File.read(File.join(tmp_dir, CanvasCc::CC::CCHelper::CC_WIKI_FOLDER + '/my-wiki-my-wiki.html')))
+    assert html
+    assert_equal 'i2eb0de275c9d8430f49bbf4cdf96286c', html.search('meta[name="identifier"]').first.attributes['content'].value
+    assert_equal 'My Wiki', html.search('title').text
+    assert_equal 'Hello [link]', html.search('body').inner_html.strip
+
+    html = Nokogiri::HTML(File.read(File.join(tmp_dir, CanvasCc::CC::CCHelper::CC_WIKI_FOLDER + '/my-wiki-link.html')))
+    assert html
+    assert_equal 'ie8b2c8b5a9156a6994b13abae6b18da6', html.search('meta[name="identifier"]').first.attributes['content'].value
+    assert_equal 'link', html.search('title').text
+    assert_equal 'This is a linked page', html.search('body').inner_html.strip
+  end
+end

data/test/unit/logger_test.rb

@@ -0,0 +1,33 @@
+require 'minitest/autorun'
+require 'moodle2cc'
+require 'stringio'
+
+class TestUnitLogger < MiniTest::Unit::TestCase
+  class MyLogger
+    attr_accessor :message, :exception
+
+    def add_warning(message, exception)
+      @message   = message
+      @exception = exception
+    end
+  end
+
+  def test_it_logs_a_warning
+    stdout = StringIO.new
+    CanvasCc::Logger.logger = ::Logger.new(stdout)
+    ex = StandardError.new 'Kablooey!!!'
+    CanvasCc::Logger.add_warning 'got an error', ex
+    assert_match /got an error/, stdout.string
+    assert_match /Kablooey!!!/, stdout.string
+  end
+
+  def test_it_adds_a_warning
+    my_logger = MyLogger.new
+    CanvasCc::Logger.logger = my_logger
+    ex  = StandardError.new 'Kablooey!!!'
+    msg = 'got an error'
+    CanvasCc::Logger.add_warning msg, ex
+    assert_equal msg, my_logger.message
+    assert_equal ex, my_logger.exception
+  end
+end

data/test/unit/migrator_test.rb

@@ -0,0 +1,67 @@
+require 'minitest/autorun'
+require 'test_helper'
+require 'moodle2cc'
+
+class TestUnitMigrator < MiniTest::Unit::TestCase
+  include TestHelper
+
+  def setup
+    @valid_source = create_moodle_backup_zip
+    @valid_destination = File.expand_path("../../tmp", __FILE__)
+  end
+
+  def teardown
+    clean_tmp_folder
+  end
+
+  def test_it_accepts_a_source_and_destination
+    migrator = CanvasCc::Migrator.new @valid_source, @valid_destination
+    assert migrator
+  end
+
+  def test_source_must_exist
+    assert_raises CanvasCc::Error, "'does_not_exist' does not exist" do
+      CanvasCc::Migrator.new 'does_not_exist', 'there'
+    end
+  end
+
+  def test_destination_must_be_a_directory
+    assert_raises CanvasCc::Error, "'is_not_a_directory' is not a directory" do
+      CanvasCc::Migrator.new @valid_source, 'is_not_a_directory'
+    end
+  end
+
+  def test_it_allows_cc_format
+    migrator = CanvasCc::Migrator.new @valid_source, @valid_destination, 'format' => 'cc'
+    assert_equal CanvasCc::CC::Converter, migrator.instance_variable_get(:@converter_class)
+  end
+
+  def test_it_allows_canvas_format
+    migrator = CanvasCc::Migrator.new @valid_source, @valid_destination, 'format' => 'canvas'
+    assert_equal CanvasCc::Canvas::Converter, migrator.instance_variable_get(:@converter_class)
+  end
+
+  def test_it_does_not_allow_any_other_format
+    assert_raises CanvasCc::Error, "'angel' is not a valid format. Please use 'cc' or 'canvas'." do
+      CanvasCc::Migrator.new @valid_source, @valid_destination, 'format' => 'angel'
+    end
+  end
+
+  def test_it_converts_moodle_backup
+    migrator = CanvasCc::Migrator.new @valid_source, @valid_destination
+    migrator.migrate
+    imscc_file = File.join(@valid_destination, "my-course.imscc")
+    assert File.exists?(imscc_file), "#{imscc_file} does not exist"
+  end
+
+  def test_it_detects_moodle2_package
+    migrator = CanvasCc::Migrator.new(fixture_path(File.join('moodle2', 'moodle2_shell.mbz')), @valid_destination)
+    expect(migrator, :migrate_moodle_2) { migrator.migrate }
+  end
+
+  def test_it_detects_moodle_1_9_package
+    migrator = CanvasCc::Migrator.new(@valid_source, @valid_destination)
+    expect(migrator, :migrate_moodle_1_9) { migrator.migrate }
+  end
+
+end