moodle2cc 0.1.12 → 0.2.0

data/spec/moodle2cc/moodle2converter/converter_helper_spec.rb

@@ -0,0 +1,149 @@
+require 'spec_helper'
+
+module Moodle2CC
+  class DummyClass
+    include Moodle2Converter::ConverterHelper
+  end
+
+  describe Moodle2Converter::ConverterHelper do
+    subject { DummyClass.new }
+
+    describe '#generate_unique_resource_path' do
+      before(:each) do
+        subject.stub(:generate_unique_identifier) { 'some_unique_hash' }
+      end
+
+      it 'generates a unique resource path' do
+        path = subject.generate_unique_resource_path('my/base/path', 'name')
+
+        expect(path).to eq 'my/base/path/some_unique_hash/name.html'
+      end
+
+      it 'uses the readable name' do
+        path = subject.generate_unique_resource_path('my/base/path', 'A Readable Name')
+
+        expect(path).to eq 'my/base/path/some_unique_hash/a-readable-name.html'
+      end
+
+      it 'appends the file extension' do
+        path = subject.generate_unique_resource_path('my/base/path', 'name', 'html')
+
+        expect(path).to eq 'my/base/path/some_unique_hash/name.html'
+      end
+    end
+
+    describe '#generate_unique_identifier' do
+      it 'generates a uuid prefixed with m2' do
+        SecureRandom.stub(:uuid) { 'unique-id' }
+        expect(subject.generate_unique_identifier).to eq 'm2uniqueid'
+      end
+    end
+
+    describe '#generate_unique_identifier_for' do
+      before(:each) { Digest::MD5.stub(:hexdigest) { 'hash' } }
+      it 'hashes an id prefixed with m2' do
+        expect(subject.generate_unique_identifier_for('some_id')).to eq 'm2hash'
+        expect(Digest::MD5).to have_received(:hexdigest).with('some_id')
+      end
+
+      it 'accepts a suffix' do
+        expect(subject.generate_unique_identifier_for('some_id', 'suffix')).to eq 'm2hashsuffix'
+        expect(Digest::MD5).to have_received(:hexdigest).with('some_id')
+      end
+    end
+
+    describe '#generate_unique_identifier_for_activity' do
+      before (:each) { subject.stub(:generate_unique_identifier_for) }
+      it 'generates a unique identifier for a page' do
+        page = Moodle2CC::Moodle2::Models::Page.new
+        page.id = 'id'
+
+        subject.generate_unique_identifier_for_activity(page)
+
+        expect(subject).to have_received(:generate_unique_identifier_for).with('id', '_page')
+      end
+
+      it 'generates a unique identifier for a Quiz' do
+        quiz = Moodle2CC::Moodle2::Models::Quizzes::Quiz.new
+        quiz.id = 'id'
+        subject.generate_unique_identifier_for_activity(quiz)
+        expect(subject).to have_received(:generate_unique_identifier_for).with('id', '_assessment')
+      end
+
+      it 'generates a unique identifier for an Assignment' do
+        assignment = Moodle2CC::Moodle2::Models::Assignment.new
+        assignment.id = 'id'
+        subject.generate_unique_identifier_for_activity(assignment)
+        expect(subject).to have_received(:generate_unique_identifier_for).with('id', '_assignment')
+      end
+
+      it 'generates a unique identifier for a Folder' do
+        folder = Moodle2CC::Moodle2::Models::Folder.new
+        folder.id = 'id'
+        subject.generate_unique_identifier_for_activity(folder)
+        expect(subject).to have_received(:generate_unique_identifier_for).with('id', '_folder')
+      end
+
+      it 'generates a unique identifier for a Forum' do
+        forum = Moodle2CC::Moodle2::Models::Forum.new
+        forum.id = 'id'
+        subject.generate_unique_identifier_for_activity(forum)
+        expect(subject).to have_received(:generate_unique_identifier_for).with('id', '_discussion')
+      end
+
+      it 'raises an exception for unknown activity types' do
+        expect { subject.generate_unique_identifier_for_activity(nil) }.to raise_exception
+      end
+    end
+
+    describe '#activity_content_type' do
+      it 'looks up the content type for a page' do
+        page = Moodle2CC::Moodle2::Models::Page.new
+        expect(subject.activity_content_type(page)).to eq CanvasCC::Models::ModuleItem::CONTENT_TYPE_WIKI_PAGE
+      end
+
+      it 'looks up the content type for a Quiz' do
+        quiz = Moodle2CC::Moodle2::Models::Quizzes::Quiz.new
+        expect(subject.activity_content_type(quiz)).to eq CanvasCC::Models::ModuleItem::CONTENT_TYPE_QUIZ
+      end
+
+      it 'looks up the content type for an Assignment' do
+        assignment = Moodle2CC::Moodle2::Models::Assignment.new
+        expect(subject.activity_content_type(assignment)).to eq CanvasCC::Models::ModuleItem::CONTENT_TYPE_ASSIGNMENT
+      end
+
+      it 'looks up the content type for a Folder' do
+        folder = Moodle2CC::Moodle2::Models::Folder.new
+        expect(subject.activity_content_type(folder)).to eq CanvasCC::Models::ModuleItem::CONTENT_TYPE_WIKI_PAGE
+      end
+
+      it 'looks up the content type for a Forum' do
+        forum = Moodle2CC::Moodle2::Models::Forum.new
+        expect(subject.activity_content_type(forum)).to eq CanvasCC::Models::ModuleItem::CONTENT_TYPE_DISCUSSION_TOPIC
+      end
+
+      it 'looks up the content type for a Resource' do
+        resource = Moodle2CC::Moodle2::Models::Resource.new
+        expect(subject.activity_content_type(resource)).to eq CanvasCC::Models::ModuleItem::CONTENT_TYPE_ATTACHMENT
+      end
+
+      it 'raises an exception for unknown activity types' do
+        expect { subject.activity_content_type(nil) }.to raise_exception
+      end
+    end
+
+    describe '#workflow_state' do
+
+      it 'returns "active" for true' do
+        expect(subject.workflow_state(true)).to eq 'active'
+      end
+
+      it 'returns "unpublished" for false' do
+        expect(subject.workflow_state(false)).to eq 'unpublished'
+      end
+
+    end
+
+
+  end
+end

data/spec/moodle2cc/moodle2converter/course_converter_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+module Moodle2CC
+  describe Moodle2Converter::CourseConverter do
+
+    it 'should convert a moodle course to a canvas course' do
+      moodle_course = Moodle2::Models::Course.new
+      moodle_course.fullname = 'Full Name'
+      moodle_course.shortname = 'Short Name'
+      moodle_course.startdate = Time.parse('Sat, 08 Feb 2014 16:00:00 GMT')
+      moodle_course.summary = 'Summary'
+      moodle_course.course_id = 'course_id'
+      cc_course = subject.convert(moodle_course)
+      expect(cc_course.title).to eq('Full Name')
+      expect(cc_course.course_code).to eq('Short Name')
+      expect(cc_course.start_at).to eq('2014-02-08T16:00:00')
+      expect(cc_course.identifier).to eq('m2ea134da7ce0152b54fb73853f6d62644_course')
+      expect(cc_course.allow_student_discussion_topics).to be_false
+      expect(cc_course.allow_student_wiki_edits).to be_false
+      expect(cc_course.default_view).to eq 'modules'
+    end
+
+  end
+end

data/spec/moodle2cc/moodle2converter/discussion_converter_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+module Moodle2CC::Moodle2Converter
+describe DiscussionConverter do
+  let(:forum){Moodle2CC::Moodle2::Models::Forum.new}
+
+    it 'converts a moodle forum to a canvas discussion' do
+      forum.id = '3'
+      forum.name = 'Forum Name'
+      forum.intro = 'Forum Introduction'
+      forum.visible = false
+
+      discussion = subject.convert(forum)
+
+      expect(discussion.identifier).to eq 'm2eccbc87e4b5ce2fe28308fd9f2a7baf3_discussion'
+      expect(discussion.title).to eq 'Forum Name'
+      expect(discussion.text).to eq 'Forum Introduction'
+      expect(discussion.discussion_type).to eq 'threaded'
+      expect(discussion.workflow_state).to eq 'unpublished'
+
+    end
+  end
+end

data/spec/moodle2cc/moodle2converter/file_converter_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+module Moodle2CC
+  describe Moodle2Converter::FileConverter do
+
+    it 'should convert a moodle file to a canvas file' do
+      moodle_file = Moodle2::Models::Moodle2File.new
+      moodle_file.content_hash = 'abcde'
+      moodle_file.file_location = 'path_to_file'
+      moodle_file.file_path = '/'
+      moodle_file.file_name = 'my_file_name'
+      moodle_file.id = 'my_file_id'
+      canvas_file = subject.convert(moodle_file)
+      expect(canvas_file.identifier).to eq('abcde')
+      expect(canvas_file.file_location).to eq('path_to_file')
+      expect(canvas_file.file_path).to eq('/my_file_name')
+    end
+
+  end
+end

data/spec/moodle2cc/moodle2converter/folder_converter_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+module Moodle2CC
+  describe Moodle2Converter::FolderConverter do
+
+    let(:moodle2_folder) { Moodle2::Models::Folder.new }
+    let(:moodle2_course) { Moodle2::Models::Course.new }
+
+    before(:each) do
+      files = 4.times.map do |i|
+        f = Moodle2::Models::Moodle2File.new
+        f.id = "#{i+1}"
+        f.file_name = "file#{i+1}.txt"
+        f.file_path = "/"
+        f
+      end
+      files[2].file_path = '/subfolder1/subfolder2/'
+      files[3].file_path = '/subfolder1/'
+      moodle2_folder.file_ids = ['1', '2', '3', '4']
+      moodle2_course.files += files
+    end
+
+    subject { Moodle2Converter::FolderConverter.new(moodle2_course) }
+
+    it 'converts a moodle folder to a canvas page' do
+      moodle2_folder.id = '3'
+      moodle2_folder.name = 'Folder Name'
+      moodle2_folder.visible = true
+      canvas_page = subject.convert(moodle2_folder)
+      expect(canvas_page.identifier).to eq 'm2eccbc87e4b5ce2fe28308fd9f2a7baf3_folder'
+      expect(canvas_page.title).to eq 'Folder Name'
+      expect(canvas_page.workflow_state).to eq('active')
+      expect(canvas_page.editing_roles).to eq('teachers')
+      expect(canvas_page.body).to include('ul')
+      expect(canvas_page.body).to include('<li><p><a href="@@PLUGINFILE@@/file1.txt">file1.txt</a></p></li>')
+      expect(canvas_page.body).to include('<li><p><a href="@@PLUGINFILE@@/file2.txt">file2.txt</a></p></li>')
+      expect(canvas_page.body).to include('<li><p><a href="@@PLUGINFILE@@/subfolder1/file4.txt">subfolder1/file4.txt</a></p></li>')
+      expect(canvas_page.body).to include('<li><p><a href="@@PLUGINFILE@@/subfolder1/subfolder2/file3.txt">subfolder1/subfolder2/file3.txt</a></p></li>')
+    end
+
+  end
+end

data/spec/moodle2cc/moodle2converter/glossary_converter_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+module Moodle2CC
+  describe Moodle2Converter::GlossaryConverter do
+    let(:moodle2_course) { Moodle2::Models::Course.new }
+    subject { Moodle2Converter::GlossaryConverter.new(moodle2_course) }
+
+    let(:moodle_glossary) do
+      glossary = Moodle2::Models::Glossary.new
+      glossary.name = 'Glossary Name'
+      glossary.visible = false
+      glossary.id = '1'
+      2.times do |i|
+        entry = Moodle2::Models::GlossaryEntry.new
+        entry.concept = "Concept number #{i}"
+        entry.definition = "Definition number #{i}"
+        glossary.entries << entry
+      end
+
+      glossary
+    end
+
+    it 'converts a moodle glossary to a canvas page' do
+      canvas_page = subject.convert(moodle_glossary)
+      expect(canvas_page.identifier).to eq 'm2c4ca4238a0b923820dcc509a6f75849b_glossary'
+      expect(canvas_page.title).to eq 'Glossary Name'
+      expect(canvas_page.workflow_state).to eq('unpublished')
+      expect(canvas_page.editing_roles).to eq('teachers,students')
+
+      expect(canvas_page.body).to include('<h2>Glossary Name</h2>')
+      expect(canvas_page.body).to include('<table><tr><th>Concept</th><th>Definition</th></tr>')
+      expect(canvas_page.body).to include("<tr><td style='padding-right:10px'>Concept number 0</td><td>Definition number 0</td></tr>")
+      expect(canvas_page.body).to include("<tr><td style='padding-right:10px'>Concept number 1</td><td>Definition number 1</td></tr>")
+    end
+  end
+end

data/spec/moodle2cc/moodle2converter/html_converter_spec.rb

@@ -0,0 +1,186 @@
+require 'spec_helper'
+
+module Moodle2CC
+  describe Moodle2Converter::HtmlConverter do
+    subject { Moodle2Converter::HtmlConverter.new(canvas_course.files, moodle_course) }
+    let(:canvas_course) do
+      course = CanvasCC::Models::Course.new
+      course.files = ('a'..'c').map do |id|
+        file = CanvasCC::Models::CanvasFile.new
+        file.identifier = id
+        file.file_path = '/path/'+ id
+        file
+      end
+      course
+    end
+
+    let(:moodle_course) do
+      course = Moodle2::Models::Course.new
+      ('a'..'c').map do |hash|
+        file = Moodle2::Models::Moodle2File.new
+        file.id = hash.ord
+        file.content_hash = hash
+        file.file_name = "#{hash}#{hash.ord}"
+        file.file_path = '/'
+        course.files << file
+      end
+      course
+    end
+
+    it 'removes id="main" attributes' do
+      html = '<div id="main">Some Content</div>'
+      expect(subject.convert(html)).to_not include('id="main"')
+    end
+
+    it 'replaces moodle2 img src with canvas url' do
+      content = '<p>a link to <img src="@@PLUGINFILE@@/a97" alt="Image Description" ></p>'
+      html = Nokogiri::HTML.fragment(subject.convert(content))
+      expect(html.css('img').first.attr('src')).to eq '%24IMS_CC_FILEBASE%24/path/a'
+    end
+
+    it 'replaces moodle 2 url in hrefs with cavans url' do
+      content = '<p>a link to <a href="@@PLUGINFILE@@/a97"></p>'
+      html = Nokogiri::HTML.fragment(subject.convert(content))
+      expect(html.css('a[href]').first.attr('href')).to eq '%24IMS_CC_FILEBASE%24/path/a'
+    end
+
+    it 'removes link tags' do
+      content = '<p>a link to <link href="@@PLUGINFILE@@/a97"></p>'
+      expect(subject.convert(content)).to eq ('<p>a link to </p>')
+    end
+
+    it "doesn't replace external links" do
+      content = '<p>a link to <img src="www.example.com/sample.gif" alt="Image Description"></p>'
+      expect(subject.convert(content)).to eq content
+    end
+
+    it 'replaces links with spaces in path' do
+      file = CanvasCC::Models::CanvasFile.new
+      file.identifier = 'content_hash'
+      file.file_path = '/my_dir/'+ 'test.txt'
+      file
+      canvas_course.files << file
+
+      file = Moodle2::Models::Moodle2File.new
+      file.id = 'moodle_file_id'
+      file.content_hash = 'content_hash'
+      file.file_name = 'text.txt'
+      file.file_path = '/path with space/'
+      moodle_course.files << file
+
+      content = '<p>a link to <a href="@@PLUGINFILE@@/path%20with%20space/text.txt"></p>'
+      html = Nokogiri::HTML.fragment(subject.convert(content))
+      expect(html.css('a[href]').first.attr('href')).to eq '%24IMS_CC_FILEBASE%24/my_dir/test.txt'
+    end
+
+    it 'replaces a moodle2 page url with a canvas url' do
+      page = Moodle2::Models::Page.new
+      page.id = '56439'
+      page.name = 'my_page_name'
+      moodle_course.pages << page
+      content = '<p>a link to <a href="http://moodle.install.edu/mod/page/view.php?id=56439#Lesson3-1"></a></p>'
+
+      html = Nokogiri::HTML.fragment(subject.convert(content))
+
+      expect(html.css('a[href]').first.attr('href')).to eq '%24WIKI_REFERENCE%24/pages/my_page_name#Lesson3-1'
+    end
+
+    it 'replaces a moodle2 forum url with a canvas url' do
+      forum = Moodle2::Models::Forum.new
+      forum.id = '56439'
+      forum.name = 'my_page_name'
+      moodle_course.forums << forum
+      content = '<p>a link to <a href="http://moodle.install.edu/mod/forum/view.php?id=56439#Lesson3-1"></a></p>'
+
+      html = Nokogiri::HTML.fragment(subject.convert(content))
+
+      expect(html.css('a[href]').first.attr('href')).to eq '%24CANVAS_OBJECT_REFERENCE%24/discussion_topics/m2c98831cde22c0529955a2218a2ed66bc_discussion#Lesson3-1'
+    end
+
+    it 'replaces a moodle2 assignment url with a canvas url' do
+      assignment = Moodle2::Models::Assignment.new
+      assignment.id = '56439'
+      assignment.name = 'my_page_name'
+      moodle_course.assignments << assignment
+      content = '<p>a link to <a href="http://moodle.install.edu/mod/assignment/view.php?id=56439"></a></p>'
+
+      html = Nokogiri::HTML.fragment(subject.convert(content))
+
+      expect(html.css('a[href]').first.attr('href')).to eq '%24CANVAS_OBJECT_REFERENCE%24/assignments/m2c98831cde22c0529955a2218a2ed66bc_assignment'
+    end
+
+    it 'replaces @assignview links with canvas links' do
+      assignment = Moodle2::Models::Assignment.new
+      assignment.id = '56439'
+      assignment.name = 'my_page_name'
+      moodle_course.assignments << assignment
+      content = '<p>a link to <a href="$@ASSIGNVIEWBYID*56439@$"></a></p>'
+
+      html = Nokogiri::HTML.fragment(subject.convert(content))
+
+      expect(html.css('a[href]').first.attr('href')).to eq '%24CANVAS_OBJECT_REFERENCE%24/assignments/m2c98831cde22c0529955a2218a2ed66bc_assignment'
+    end
+
+    it 'returns the original url if a matching moodle activity is not found' do
+      content = '<p>a link to <a href="http://moodle.install.edu/mod/assignment/view.php?id=56439"></a></p>'
+
+      html = Nokogiri::HTML.fragment(subject.convert(content))
+
+      expect(html.css('a[href]').first.attr('href')).to eq 'http://moodle.install.edu/mod/assignment/view.php?id=56439'
+    end
+
+    it 'replaces moodle file urls' do
+      file = CanvasCC::Models::CanvasFile.new
+      file.identifier = 'content_hash'
+      file.file_path = '/graphics/'+ 'arrow.JPG'
+      file
+      canvas_course.files << file
+
+      file = Moodle2::Models::Moodle2File.new
+      file.id = 'moodle_file_id'
+      file.content_hash = 'content_hash'
+      file.file_name = 'arrow.JPG'
+      file.file_path = '/graphics/'
+      moodle_course.files << file
+
+      content = '<p> a link to <a href="http://moodle.extn.washington.edu/file.php/908/graphics/arrow.JPG">link</a></p>'
+      html = Nokogiri::HTML.fragment(subject.convert(content))
+      expect(html.css('a[href]').first.attr('href')).to eq '%24IMS_CC_FILEBASE%24/graphics/arrow.JPG'
+
+    end
+
+    context 'audio link conversion' do
+      it 'converts mp3 links to html5 audio tags' do
+        content = '<a href="/some/path/to/music.mp3">My Music</a>'
+        html = subject.convert(content)
+
+        expect(html).to eq '<audio controls="controls"><source src="/some/path/to/music.mp3" type="audio/mp3"></source><a href="/some/path/to/music.mp3">My Music</a></audio>'
+      end
+
+      it 'converts wav links to html5 audio tags' do
+        content = '<a href="/some/path/to/music.wav">My Music</a>'
+        html = subject.convert(content)
+
+        expect(html).to eq '<audio controls="controls"><source src="/some/path/to/music.wav" type="audio/wav"></source><a href="/some/path/to/music.wav">My Music</a></audio>'
+      end
+    end
+
+    context 'video link conversion' do
+      it 'converts mp4 links to html5 video tags' do
+        content = '<a href="/some/path/to/video.mp4">My Video</a>'
+        html = subject.convert(content)
+
+        expect(html).to eq '<audio controls="controls"><source src="/some/path/to/video.mp4" type="video/mp4"></source><a href="/some/path/to/video.mp4">My Video</a></audio>'
+      end
+
+      it 'converts webm links to html5 video tags' do
+        content = '<a href="/some/path/to/video.webm">My Video</a>'
+        html = subject.convert(content)
+
+        expect(html).to eq '<audio controls="controls"><source src="/some/path/to/video.webm" type="video/webm"></source><a href="/some/path/to/video.webm">My Video</a></audio>'
+      end
+   end
+
+
+  end
+end