moodle2cc 0.1.4 → 0.1.5

data/README.md

@@ -7,35 +7,32 @@ Moodle information: http://moodle.org/
 
 Common Cartridge information: http://www.imsglobal.org/cc/index.html
 
-## Installation
+Use the [Github Issues](https://github.com/instructure/moodle2cc/issues?state=open)
+for feature requests and bug reports.
 
-### Command line-only use
+## 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
 
-### For use in a Ruby application
-
-Add this line to your application's Gemfile:
+Convert a moodle .zip into Common Cartridge format
 
-    gem 'moodle2cc'
-
-And then execute:
+    $ moodle2cc migrate <path-to-moodle-backup> <path-to-cc-export-directory>
 
-    $ bundle
+Or into a Canvas-enhanced Common Cartridge format
 
-## Usage
+    $ moodle2cc migrate --format=canvas <path-to-moodle-backup> <path-to-cc-export-directory>
 
-### Command Line
+### In a Ruby application
 
-    For Common Cartridge format
-    $ moodle2cc migrate <path-to-moodle-backup> <path-to-cc-export-directory>
+Add this line to your application's Gemfile and run `bundle`:
 
-    For Canvas Common Cartridge format
-    $ moodle2cc migrate --format=canvas <path-to-moodle-backup> <path-to-cc-export-directory>
+    gem 'moodle2cc'
 
-### Ruby Application
+Require the library in your project and use the migrator:
 
 ```ruby
 require 'moodle2cc'
@@ -43,6 +40,62 @@ migrator = Moodle2CC::Migrator.new moodle_zip_path, destination_bath
 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.2
+ * Quiz conversion
+ * Question Category conversion
+ * LTI configurations?
+ * Convert more Moodle features as requested
+
 ## Contributing
 
 Run the tests:

data/lib/moodle2cc/canvas/assignment.rb

@@ -10,6 +10,8 @@ module Moodle2CC::Canvas
 
     def initialize(mod, position=0)
       super
+      @rel_path = "#{identifier}/#{file_slug(@title)}.html"
+      @resource_type = LOR
       @body = convert_file_path_tokens(mod.description)
       @points_possible = mod.grade_item ? mod.grade_item.grade_max : mod.grade
       @grading_type = 'points'
@@ -60,18 +62,6 @@ module Moodle2CC::Canvas
       end
     end
 
-    def create_resource_node(resources_node)
-      href = "#{identifier}/#{file_slug(@title)}.html"
-      resources_node.resource(
-        :href => href,
-        :type => LOR,
-        :identifier => identifier
-      ) do |resource_node|
-        resource_node.file(:href => href)
-        resource_node.file(:href => File.join(identifier, ASSIGNMENT_SETTINGS))
-      end
-    end
-
     def create_resource_sub_nodes(resource_node)
       resource_node.file(:href => File.join(identifier, ASSIGNMENT_SETTINGS))
     end

data/lib/moodle2cc/canvas/web_content.rb

@@ -1,6 +1,11 @@
 module Moodle2CC::Canvas
   class WebContent < Moodle2CC::CC::WebContent
     include Resource
+    
+    def initialize(mod)
+      super
+      @rel_path = File.join(WIKI_FOLDER, "#{file_slug(@title)}.html")
+    end
 
     def create_module_meta_item_elements(item_node)
       item_node.content_type 'WikiPage'

data/lib/moodle2cc/canvas/wiki.rb

@@ -4,6 +4,7 @@ module Moodle2CC::Canvas
     attr_accessor :pages
 
     def initialize(mod)
+      @href_template = "#{WIKI_FOLDER}/%s.html"
       super
 
       @pages.map! do |page|

data/lib/moodle2cc/cc/assignment.rb

@@ -3,46 +3,41 @@ module Moodle2CC::CC
     include CCHelper
     include Resource
 
-
-    attr_accessor :body
+    attr_accessor :body, :meta_fields
 
     def initialize(mod, position=0)
       super
       @body = convert_file_path_tokens(mod.description)
+      @meta_fields = build_meta_fields(mod)
+      @rel_path = File.join(CC_ASSIGNMENT_FOLDER, "#{file_slug(@title)}.html")
+      @resource_type = nil
     end
-
-    def get_submission_types(mod)
-      if mod.mod_type == 'assignment'
-        case mod.assignment_type
-        when 'online'
-          'online_text_entry'
-        when 'upload'
-          if mod.var2 == 1
-            'online_upload,online_text_entry'
-          else
-            'online_upload'
-          end
-        when 'uploadsingle'
-          'online_upload'
-        else
-          'none'
+    
+    # Common Cartridge doesn't have anywhere to put assignment meta data like this
+    # So add them as HTML meta fields in the HTML file
+    def build_meta_fields(mod)
+      fields = {}
+      %w{mod_type assignment_type}.each do |key|
+        fields[key] = mod.send(key) if mod.respond_to?(key)
+      end
+      if mod.grade_item
+        Moodle2CC::Moodle::GradeItem::PROPERTIES.each do |key|
+          fields[key] = mod.grade_item.send(key) if mod.grade_item.respond_to?(key)
         end
-      elsif mod.mod_type == 'workshop'
-        submission_types = ['online_text_entry']
-        submission_types.unshift('online_upload') if mod.number_of_attachments > 0
-        submission_types.join(',')
       end
+      
+      fields
     end
 
     def create_resource_node(resources_node)
-      href = "#{identifier}/#{file_slug(@title)}.html"
       resources_node.resource(
-        :href => href,
-        :type => LOR,
+        :href => @rel_path,
+        :type => @resource_type || WEBCONTENT,
         :identifier => identifier
       ) do |resource_node|
-        resource_node.file(:href => href)
+        resource_node.file(:href => @rel_path)
         create_resource_sub_nodes(resource_node)
+        # todo if CC 1.2 add assignment meta tag
       end
     end
 
@@ -55,7 +50,7 @@ module Moodle2CC::CC
 
     def create_html(export_dir)
       template = File.expand_path('../templates/assignment.html.erb', __FILE__)
-      path = File.join(export_dir, identifier, "#{file_slug(title)}.html")
+      path = File.join(export_dir, @rel_path)
       FileUtils.mkdir_p(File.dirname(path))
       File.open(path, 'w') do |file|
         erb = ERB.new(File.read(template))

data/lib/moodle2cc/cc/cc_helper.rb

@@ -70,6 +70,9 @@ module CCHelper
   WEB_RESOURCES_FOLDER = 'web_resources'
   WIKI_FOLDER = 'wiki_content'
   MEDIA_OBJECTS_FOLDER = 'media_objects'
+  
+  CC_ASSIGNMENT_FOLDER = File.join(WEB_RESOURCES_FOLDER, "assignments")
+  CC_WIKI_FOLDER = File.join(WEB_RESOURCES_FOLDER, "pages")
 
   def create_key(object, prepend="")
     CCHelper.create_key(object, prepend)

data/lib/moodle2cc/cc/converter.rb

@@ -129,7 +129,7 @@ module Moodle2CC::CC
 
     def create_web_resources
       web_resources_folder = File.join(@export_dir, WEB_RESOURCES_FOLDER)
-      FileUtils.mkdir(web_resources_folder)
+      FileUtils.mkdir_p(web_resources_folder)
       @moodle_backup.copy_files_to(web_resources_folder)
     end
 

data/lib/moodle2cc/cc/templates/assignment.html.erb

@@ -1,9 +1,13 @@
 <html>
 <head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-<title>Assignment: <%= title %></title>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+  <% if meta_fields
+       meta_fields.each_pair do |key, val|%>
+  <meta name="<%= key %>" content="<%= val %>" /> <% end %>
+  <% end %>
+  <title>Assignment: <%= title %></title>
 </head>
 <body>
-  <%= body %>
+<%= body %>
 </body>
 </html>

data/lib/moodle2cc/cc/web_content.rb

@@ -7,13 +7,14 @@ module Moodle2CC::CC
 
     def initialize(mod)
       super
+      @rel_path = File.join(CC_WIKI_FOLDER, "#{file_slug(@title)}.html")
       body = mod.alltext
       body = mod.content || '' if body.nil? || body.length == 0
       @body = convert_file_path_tokens(body)
     end
 
     def create_resource_node(resources_node)
-      href = File.join(WIKI_FOLDER, "#{file_slug(@title)}.html")
+      href = @rel_path
       resources_node.resource(
         :type => WEBCONTENT,
         :identifier => identifier,
@@ -29,7 +30,7 @@ module Moodle2CC::CC
 
     def create_html(export_dir)
       template = File.expand_path('../templates/wiki_content.html.erb', __FILE__)
-      path = File.join(export_dir, 'wiki_content', "#{file_slug(title)}.html")
+      path = File.join(export_dir, @rel_path)
       FileUtils.mkdir_p(File.dirname(path))
       File.open(path, 'w') do |file|
         erb = ERB.new(File.read(template))

data/lib/moodle2cc/cc/wiki.rb

@@ -7,6 +7,7 @@ module Moodle2CC::CC
 
     def initialize(mod)
       super
+      @href_template ||= "#{CC_WIKI_FOLDER}/%s.html"
       page_versions = mod.pages.inject({}) do |result, page|
         version = result[page.page_name]
         result[page.page_name] = page.version if version.nil? || page.version > version
@@ -18,14 +19,14 @@ module Moodle2CC::CC
           title_slug = file_slug(@title)
           body = page.content
           slug = [title_slug, file_slug(page.page_name)].join('-')
-          href = "#{WIKI_FOLDER}/#{slug}.html"
+          href = @href_template % slug
           Moodle2CC::OpenStruct.new(:title => page.page_name, :body => body, :href => href, :identifier => create_key(href))
         end
       end.compact
 
       if @pages.empty?
         slug = file_slug(@title)
-        href = File.join(WIKI_FOLDER, "#{slug}.html")
+        href = @href_template % slug
         @pages = [Moodle2CC::OpenStruct.new(:title => @title, :body => mod.summary, :href => href, :identifier => create_key(href))]
       end
 

data/lib/moodle2cc/moodle/grade_item.rb

@@ -1,6 +1,9 @@
 module Moodle2CC::Moodle
   class GradeItem
     include HappyMapper
+    
+    PROPERTIES = %w{id category_id item_name item_type item_module item_instance 
+                    item_number grade_type grade_max grade_min scale_id}
 
     attr_accessor :course
 

data/lib/moodle2cc/version.rb

@@ -1,3 +1,3 @@
 module Moodle2CC
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/test/unit/canvas/converter_test.rb

@@ -7,7 +7,7 @@ class TestUnitCCConverter < MiniTest::Unit::TestCase
   include TestHelper
 
   def setup
-    convert_moodle_backup
+    convert_moodle_backup('canvas')
   end
 
   def teardown

data/test/unit/cc/assignment_test.rb

@@ -47,21 +47,26 @@ class TestUnitCCAssignment < MiniTest::Unit::TestCase
 
     resource = xml.xpath('resource').first
     assert resource
-    assert_equal 'associatedcontent/imscc_xmlv1p1/learning-application-resource', resource.attributes['type'].value
-    assert_equal 'i6b162484accdf6081cea43b39219d129/create-a-rails-site.html', resource.attributes['href'].value
+    assert_equal 'webcontent', resource.attributes['type'].value
+    assert_equal 'web_resources/assignments/create-a-rails-site.html', resource.attributes['href'].value
     assert_equal 'i6b162484accdf6081cea43b39219d129', resource.attributes['identifier'].value
 
-    file = resource.xpath('file[@href="i6b162484accdf6081cea43b39219d129/create-a-rails-site.html"]').first
+    file = resource.xpath('file[@href="web_resources/assignments/create-a-rails-site.html"]').first
     assert file
   end
 
   def test_it_creates_assignment_html
     tmp_dir = File.expand_path('../../../tmp', __FILE__)
     @assignment.create_html(tmp_dir)
-    html = Nokogiri::HTML(File.read(File.join(tmp_dir, @assignment.identifier, 'create-a-rails-site.html')))
+    html = Nokogiri::HTML(File.read(File.join(tmp_dir, Moodle2CC::CC::CCHelper::CC_ASSIGNMENT_FOLDER, 'create-a-rails-site.html')))
 
     assert html
     assert_equal 'Assignment: Create a Rails site', html.search('title').text
     assert_equal '<h1>Hello World</h1>', html.search('body').inner_html.strip
+    assert_equal 'assignment', html.at_css('meta[name=mod_type]')['content']
+    assert_equal 'offline', html.at_css('meta[name=assignment_type]')['content']
+    assert_equal '1.0', html.at_css('meta[name=grade_min]')['content']
+    assert_equal '150.0', html.at_css('meta[name=grade_max]')['content']
+    assert_equal '2', html.at_css('meta[name=grade_type]')['content']
   end
 end

data/test/unit/cc/web_content_test.rb

@@ -52,9 +52,9 @@ class TestUnitCCWebContent < MiniTest::Unit::TestCase
     assert resource
     assert_equal 'webcontent', resource.attributes['type'].value
     assert_equal 'i6447ff05ab6e342a42302007a6e3bcb4', resource.attributes['identifier'].value
-    assert_equal 'wiki_content/instructor-resources.html', resource.attributes['href'].value
+    assert_equal Moodle2CC::CC::CCHelper::CC_WIKI_FOLDER + '/instructor-resources.html', resource.attributes['href'].value
 
-    file = resource.xpath('file[@href="wiki_content/instructor-resources.html"]').first
+    file = resource.xpath(%{file[@href="#{Moodle2CC::CC::CCHelper::CC_WIKI_FOLDER}/instructor-resources.html"]}).first
     assert file
   end
 
@@ -66,7 +66,7 @@ class TestUnitCCWebContent < MiniTest::Unit::TestCase
     tmp_dir = File.expand_path('../../../tmp', __FILE__)
     web_content = Moodle2CC::CC::WebContent.new @mod
     web_content.create_html(tmp_dir)
-    html = Nokogiri::HTML(File.read(File.join(tmp_dir, 'wiki_content', 'instructor-resources.html')))
+    html = Nokogiri::HTML(File.read(File.join(tmp_dir, Moodle2CC::CC::CCHelper::CC_WIKI_FOLDER, 'instructor-resources.html')))
 
     assert html
     assert_equal 'i6447ff05ab6e342a42302007a6e3bcb4', html.search('head meta[name="identifier"]').first.attributes['content'].value

data/test/unit/cc/wiki_test.rb

@@ -43,13 +43,13 @@ class TestUnitCCWiki < MiniTest::Unit::TestCase
 
     assert_equal 'My Wiki', wiki.pages[0].title
     assert_equal 'Second version', wiki.pages[0].body
-    assert_equal 'wiki_content/my-wiki-my-wiki.html', wiki.pages[0].href
-    assert_equal 'i56eb35e2b44710c48f7aa6b6297e9c98', wiki.pages[0].identifier
+    assert_equal Moodle2CC::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 'wiki_content/my-wiki-new-page.html', wiki.pages[1].href
-    assert_equal 'i56eb35e2b44710c48f7aa6b6297e9c98', wiki.pages[0].identifier
+    assert_equal Moodle2CC::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
@@ -62,8 +62,8 @@ class TestUnitCCWiki < MiniTest::Unit::TestCase
 
     assert_equal 'My wiki', wiki.pages[0].title
     assert_equal 'This is the summary', wiki.pages[0].body
-    assert_equal 'wiki_content/my-wiki.html', wiki.pages[0].href
-    assert_equal 'ib87fd4bafae6f3e3ee7dadb65b0e45a3', wiki.pages[0].identifier
+    assert_equal Moodle2CC::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
@@ -89,7 +89,7 @@ class TestUnitCCWiki < MiniTest::Unit::TestCase
     @mod.pages = []
 
     wiki = Moodle2CC::CC::Wiki.new @mod
-    assert_equal 'ib87fd4bafae6f3e3ee7dadb65b0e45a3', wiki.identifier
+    assert_equal 'ib1bfc2398c654e88470adb5a882f83e5', wiki.identifier
   end
 
   def test_it_creates_resource_in_imsmanifest
@@ -103,19 +103,19 @@ class TestUnitCCWiki < MiniTest::Unit::TestCase
     resource = xml.root.xpath('resource[1]').first
     assert resource
     assert_equal 'webcontent', resource.attributes['type'].value
-    assert_equal 'wiki_content/my-wiki-link.html', resource.attributes['href'].value
-    assert_equal 'i13d1eba598141a33bd00dc38186d148a', resource.attributes['identifier'].value
+    assert_equal Moodle2CC::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="wiki_content/my-wiki-link.html"]').first
+    file = resource.xpath(%{file[@href="#{Moodle2CC::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 'wiki_content/my-wiki-my-wiki.html', resource.attributes['href'].value
-    assert_equal 'i56eb35e2b44710c48f7aa6b6297e9c98', resource.attributes['identifier'].value
+    assert_equal Moodle2CC::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="wiki_content/my-wiki-my-wiki.html"]').first
+    file = resource.xpath(%{file[@href="#{Moodle2CC::CC::CCHelper::CC_WIKI_FOLDER}/my-wiki-my-wiki.html"]}).first
     assert file
   end
 
@@ -124,15 +124,15 @@ class TestUnitCCWiki < MiniTest::Unit::TestCase
     tmp_dir = File.expand_path('../../../tmp', __FILE__)
     wiki.create_html(tmp_dir)
 
-    html = Nokogiri::HTML(File.read(File.join(tmp_dir, 'wiki_content/my-wiki-my-wiki.html')))
+    html = Nokogiri::HTML(File.read(File.join(tmp_dir, Moodle2CC::CC::CCHelper::CC_WIKI_FOLDER + '/my-wiki-my-wiki.html')))
     assert html
-    assert_equal 'i56eb35e2b44710c48f7aa6b6297e9c98', html.search('meta[name="identifier"]').first.attributes['content'].value
+    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, 'wiki_content/my-wiki-link.html')))
+    html = Nokogiri::HTML(File.read(File.join(tmp_dir, Moodle2CC::CC::CCHelper::CC_WIKI_FOLDER + '/my-wiki-link.html')))
     assert html
-    assert_equal 'i13d1eba598141a33bd00dc38186d148a', html.search('meta[name="identifier"]').first.attributes['content'].value
+    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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: moodle2cc
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Christopher Durtschi
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-15 00:00:00 Z
+date: 2012-08-21 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rubyzip
@@ -193,8 +193,6 @@ files:
 - Rakefile
 - bin/moodle2cc
 - lib/moodle2cc.rb
-- lib/moodle2cc/canvas/.converter.rb.swo
-- lib/moodle2cc/canvas/.wiki.rb.swo
 - lib/moodle2cc/canvas/assessment.rb
 - lib/moodle2cc/canvas/assignment.rb
 - lib/moodle2cc/canvas/converter.rb