moodle2cc 0.1.12 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7258b41260e20424fd1f99850e066ab30f206cc4
+  data.tar.gz: c3065280c0c4a880e846de58712345b0e62e6292
+SHA512:
+  metadata.gz: 0ff46d7f34807dcd9d9911e36506826f7cb1a11556d1aeda982cf6bed6c606365d2e7e0045160c621609f7099c5c1c39f9c3b38eb3815f0c9e471d04ad614d7c
+  data.tar.gz: 519aa8dfe4ed0996be52b619be3c5056a74b46a8956fca66ac41671cc1c6a61b9e7fb00d7929bc45f2e046b4237c6ebee884829b47f3c076826c8bf4803e34f8

data/.travis.yml

@@ -1,4 +1,7 @@
-nguage: ruby
+language: ruby
+branches:
+  only:
+    - moodle2
 rvm:
   - "1.9.3"
   - "2.0.0"

data/Changelog

@@ -1,3 +1,8 @@
+2014-04-01 Version 0.2.0
+    * Add support for converting Moodle 2 exports to canvas
+		  flavored common cartridge
+		* TODO of adding better plain CC support for Moodle 2 conversions
+
 2014-01-21 Version 0.1.11
     * files with associated text/html content are now made into
 		  html pages with that text and a link to the file

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in moodle2cc.gemspec
 gemspec
+
+gem 'simplecov'

data/Guardfile

@@ -12,3 +12,9 @@ guard 'minitest' do
   watch(%r|^lib/moodle2cc/(.*?)([^/]+)\.rb|)     { |m| "test/unit/#{m[1]}#{m[2]}_test.rb" }
   watch(%r|^test/test_helper\.rb|)    { "test" }
 end
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -36,7 +36,7 @@ Require the library in your project and use the migrator:
 
 ```ruby
 require 'moodle2cc'
-migrator = Moodle2CC::Migrator.new moodle_zip_path, destination_bath
+migrator = Moodle2CC::Migrator.new moodle_zip_path, destination_path
 migrator.migrate
 ```
 

data/Rakefile

@@ -1,12 +1,25 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
 
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.libs.push "lib"
+  t.libs.push "test"
   t.pattern = "test/**/*_test.rb"
   t.verbose = true
 end
 
-task :default => :test
+Rake::TestTask.new(:moodle2_test) do |t|
+  t.libs.push "lib"
+  t.libs.push "test"
+  t.pattern = "test/unit/moodle2*/**/*_test.rb"
+  t.verbose = true
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :all_tests => [:test, :spec]
+
+task :default => :all_tests

data/lib/moodle2cc.rb

@@ -8,11 +8,14 @@ require 'nokogiri'
 require 'ostruct'
 require 'rdiscount'
 require 'uri'
+require 'securerandom'
 
 require 'moodle2cc/error'
 require 'moodle2cc/logger'
 require 'moodle2cc/migrator'
 
+require 'moodle2cc/moodle2'
+
 module Moodle2CC
   class OpenStruct < ::OpenStruct
     if defined? id
@@ -61,4 +64,67 @@ module Moodle2CC
     autoload :QuestionCategory, 'moodle2cc/moodle/question_category'
     autoload :Section, 'moodle2cc/moodle/section'
   end
+  module CanvasCC
+    autoload :ImsManifestGenerator, 'moodle2cc/canvas_cc/ims_manifest_generator'
+    autoload :CartridgeCreator, 'moodle2cc/canvas_cc/cartridge_creator'
+    autoload :CourseSettingWriter, 'moodle2cc/canvas_cc/course_setting_writer'
+    autoload :ModuleMetaWriter, 'moodle2cc/canvas_cc/module_meta_writer'
+    autoload :FileMetaWriter, 'moodle2cc/canvas_cc/file_meta_writer'
+    autoload :CanvasExportWriter, 'moodle2cc/canvas_cc/canvas_export_writer'
+    autoload :PageWriter, 'moodle2cc/canvas_cc/page_writer'
+    autoload :DiscussionWriter, 'moodle2cc/canvas_cc/discussion_writer'
+    autoload :AssignmentWriter, 'moodle2cc/canvas_cc/assignment_writer'
+
+    autoload :QuestionWriter, 'moodle2cc/canvas_cc/question_writer'
+    autoload :CalculatedQuestionWriter, 'moodle2cc/canvas_cc/calculated_question_writer'
+    autoload :EssayQuestionWriter, 'moodle2cc/canvas_cc/essay_question_writer'
+    autoload :MatchingQuestionWriter, 'moodle2cc/canvas_cc/matching_question_writer'
+    autoload :MultipleBlanksQuestionWriter, 'moodle2cc/canvas_cc/multiple_blanks_question_writer'
+    autoload :MultipleChoiceQuestionWriter, 'moodle2cc/canvas_cc/multiple_choice_question_writer'
+    autoload :NumericalQuestionWriter, 'moodle2cc/canvas_cc/numerical_question_writer'
+    autoload :ShortAnswerQuestionWriter, 'moodle2cc/canvas_cc/short_answer_question_writer'
+    autoload :TextOnlyQuestionWriter, 'moodle2cc/canvas_cc/text_only_question_writer'
+    autoload :TrueFalseQuestionWriter, 'moodle2cc/canvas_cc/true_false_question_writer'
+
+    autoload :QuestionBankWriter, 'moodle2cc/canvas_cc/question_bank_writer'
+    autoload :QuestionGroupWriter, 'moodle2cc/canvas_cc/question_group_writer'
+    autoload :AssessmentWriter, 'moodle2cc/canvas_cc/assessment_writer'
+    module Models
+      autoload :Course, 'moodle2cc/canvas_cc/models/course'
+      autoload :Assignment, 'moodle2cc/canvas_cc/models/assignment'
+      autoload :Assessment, 'moodle2cc/canvas_cc/models/assessment'
+      autoload :DiscussionTopic, 'moodle2cc/canvas_cc/models/discussion_topic'
+      autoload :Question, 'moodle2cc/canvas_cc/models/question'
+      autoload :Answer, 'moodle2cc/canvas_cc/models/answer'
+      autoload :QuestionBank, 'moodle2cc/canvas_cc/models/question_bank'
+      autoload :QuestionGroup, 'moodle2cc/canvas_cc/models/question_group'
+      autoload :WebContent, 'moodle2cc/canvas_cc/models/web_content'
+      autoload :WebLink, 'moodle2cc/canvas_cc/models/web_link'
+      autoload :Resource, 'moodle2cc/canvas_cc/models/resource'
+      autoload :CanvasModule, 'moodle2cc/canvas_cc/models/canvas_module'
+      autoload :ModuleItem, 'moodle2cc/canvas_cc/models/module_item'
+      autoload :CanvasFile, 'moodle2cc/canvas_cc/models/canvas_file'
+      autoload :Page, 'moodle2cc/canvas_cc/models/page'
+      autoload :Discussion, 'moodle2cc/canvas_cc/models/discussion'
+      autoload :WorkflowState, 'moodle2cc/canvas_cc/models/workflow_state'
+    end
+  end
+  module Moodle2Converter
+    autoload :Migrator, 'moodle2cc/moodle2converter/migrator'
+    autoload :CourseConverter, 'moodle2cc/moodle2converter/course_converter'
+    autoload :QuestionConverters, 'moodle2cc/moodle2converter/question_converters'
+    autoload :QuestionBankConverter, 'moodle2cc/moodle2converter/question_bank_converter'
+    autoload :SectionConverter, 'moodle2cc/moodle2converter/section_converter'
+    autoload :FileConverter, 'moodle2cc/moodle2converter/file_converter'
+    autoload :PageConverter, 'moodle2cc/moodle2converter/page_converter'
+    autoload :DiscussionConverter, 'moodle2cc/moodle2converter/discussion_converter'
+    autoload :AssignmentConverter, 'moodle2cc/moodle2converter/assignment_converter'
+    autoload :AssessmentConverter, 'moodle2cc/moodle2converter/assessment_converter'
+    autoload :FolderConverter, 'moodle2cc/moodle2converter/folder_converter'
+    autoload :BookConverter, 'moodle2cc/moodle2converter/book_converter'
+    autoload :ConverterHelper, 'moodle2cc/moodle2converter/converter_helper'
+    autoload :HtmlConverter, 'moodle2cc/moodle2converter/html_converter'
+    autoload :HomepageConverter, 'moodle2cc/moodle2converter/homepage_converter'
+    autoload :GlossaryConverter, 'moodle2cc/moodle2converter/glossary_converter'
+  end
 end

data/lib/moodle2cc/canvas/question.rb

@@ -378,7 +378,7 @@ module Moodle2CC::Canvas
           end
         end
       when 'short_answer_question'
-        # Feeback
+        # Feedback
         @answers.each do |answer|
           next unless answer.feedback && answer.feedback.strip.length > 0
           processing_node.respcondition(:continue => 'Yes') do |condition_node|

data/lib/moodle2cc/canvas_cc/assessment_writer.rb

@@ -0,0 +1,82 @@
+module Moodle2CC::CanvasCC
+  class AssessmentWriter
+
+    def initialize(work_dir, *assessments)
+      @work_dir = work_dir
+      @assessments = assessments
+    end
+
+    def write
+      @assessments.each do |assessment|
+        write_assessment(assessment)
+      end
+    end
+
+    private
+
+    def write_assessment(assessment)
+      write_assessment_non_cc_qti_xml(assessment)
+      write_assessment_meta_xml(assessment)
+    end
+
+    def write_assessment_meta_xml(assessment)
+      xml = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+        xml.quiz(
+            :identifier => assessment.identifier,
+            'xsi:schemaLocation' => "http://canvas.instructure.com/xsd/cccv1p0 http://canvas.instructure.com/xsd/cccv1p0.xsd",
+            'xmlns:xsi' => "http://www.w3.org/2001/XMLSchema-instance",
+            'xmlns' => "http://canvas.instructure.com/xsd/cccv1p0"
+        ) do |quiz_node|
+          Moodle2CC::CanvasCC::Models::Assessment::META_ATTRIBUTES.each do |attr|
+            quiz_node.send(attr, assessment.send(attr)) unless assessment.send(attr).nil?
+          end
+          Moodle2CC::CanvasCC::Models::Assessment::DATETIME_ATTRIBUTES.each do |attr|
+            quiz_node.send(attr, Moodle2CC::CC::CCHelper.ims_datetime(assessment.send(attr))) unless assessment.send(attr).nil?
+          end
+        end
+      end.to_xml
+
+      file_path = File.join(@work_dir, assessment.meta_file_path)
+      FileUtils.mkdir_p(File.dirname(file_path)) unless File.exists?(File.dirname(file_path))
+      File.open(file_path, 'w') { |f| f.write(xml) }
+    end
+
+    def write_assessment_non_cc_qti_xml(assessment)
+      raise "need to resolve questions references" if assessment.items.nil?
+
+      xml = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+        xml.questestinterop("xmlns" => "http://www.imsglobal.org/xsd/ims_qtiasiv1p2",
+                            "xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance",
+                            "xsi:schemaLocation"=> "http://www.imsglobal.org/xsd/ims_qtiasiv1p2 http://www.imsglobal.org/xsd/ims_qtiasiv1p2p1.xsd"
+        ) { |xml|
+          xml.assessment(:title => assessment.title, :ident => assessment.identifier) do |assessment_node|
+            assessment_node.qtimetadata do |qtimetadata_node|
+              qtimetadata_node.qtimetadatafield do |qtimetadatafield_node|
+                qtimetadatafield_node.fieldlabel "qmd_timelimit"
+                qtimetadatafield_node.fieldentry assessment.time_limit
+              end
+              qtimetadata_node.qtimetadatafield do |qtimetadatafield_node|
+                qtimetadatafield_node.fieldlabel "cc_maxattempts"
+                qtimetadatafield_node.fieldentry assessment.allowed_attempts
+              end
+            end
+            assessment_node.section(:ident => 'root_section') do |section_node|
+              assessment.items.each do |item|
+                case item
+                when Moodle2CC::CanvasCC::Models::Question
+                  Moodle2CC::CanvasCC::QuestionWriter.write_question(section_node, item)
+                when Moodle2CC::CanvasCC::Models::QuestionGroup
+                  Moodle2CC::CanvasCC::QuestionGroupWriter.write_question_group(section_node, item)
+                end
+              end
+            end
+          end
+        }
+      end.to_xml
+
+      file_path = File.join(@work_dir, assessment.qti_file_path)
+      FileUtils.mkdir_p(File.dirname(file_path)) unless File.exists?(File.dirname(file_path))
+      File.open(file_path, 'w') { |f| f.write(xml) }
+    end
+  end
+end

data/lib/moodle2cc/canvas_cc/assignment_writer.rb

@@ -0,0 +1,67 @@
+module Moodle2CC::CanvasCC
+  class AssignmentWriter
+
+    def initialize(work_dir, *assignments)
+      @work_dir = work_dir
+      @assignments = assignments
+    end
+
+    def write
+      @assignments.each do |assignment|
+        assignment_dir = File.join(@work_dir, assignment.assignment_resource.identifier)
+        Dir.mkdir(assignment_dir)
+        write_html(assignment_dir, assignment)
+        write_settings(assignment_dir, assignment)
+      end
+    end
+
+    private
+
+    def write_settings(assignment_dir, assignment)
+      xml = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+        xml.assignment('identifier' => assignment.assignment_resource.identifier,
+                       'xmlns' => 'http://canvas.instructure.com/xsd/cccv1p0',
+                       'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+                       'xsi:schemaLocation' => 'http://canvas.instructure.com/xsd/cccv1p0 http://canvas.instructure.com/xsd/cccv1p0.xsd'
+        ) { |xml|
+          xml.title assignment.title
+          xml.due_at Moodle2CC::CC::CCHelper.ims_datetime(assignment.due_at) if assignment.due_at
+          xml.lock_at Moodle2CC::CC::CCHelper.ims_datetime(assignment.lock_at) if assignment.lock_at
+          xml.unlock_at Moodle2CC::CC::CCHelper.ims_datetime(assignment.unlock_at) if assignment.unlock_at
+          xml.all_day_date Moodle2CC::CC::CCHelper.ims_datetime(assignment.all_day_date) if assignment.all_day_date
+          xml.peer_reviews_due_at Moodle2CC::CC::CCHelper.ims_datetime(assignment.peer_reviews_due_at) if assignment.peer_reviews_due_at
+          xml.assignment_group_identifierref assignment.assignment_group_identifier_ref if assignment.assignment_group_identifier_ref
+          xml.workflow_state assignment.workflow_state if assignment.workflow_state
+          xml.points_possible assignment.points_possible if assignment.points_possible
+          xml.grading_type assignment.grading_type if assignment.grading_type
+          xml.all_day assignment.all_day unless assignment.all_day.nil?
+          xml.submission_types assignment.submission_types.join(',') unless assignment.submission_types.empty?
+          xml.position assignment.position if assignment.position
+          xml.peer_review_count assignment.peer_review_count if assignment.peer_review_count
+          xml.peer_reviews_assigned assignment.peer_reviews_assigned unless assignment.peer_reviews_assigned.nil?
+          xml.peer_reviews assignment.peer_reviews unless assignment.peer_reviews.nil?
+          xml.automatic_peer_reviews assignment.automatic_peer_reviews unless assignment.automatic_peer_reviews.nil?
+          xml.grade_group_students_individually assignment.grade_group_students_individually unless assignment.grade_group_students_individually.nil?
+        }
+      end.to_xml
+      File.open(File.join(assignment_dir, Moodle2CC::CanvasCC::Models::Assignment::ASSIGNMENT_SETTINGS_FILE), 'w') { |f| f.write(xml) }
+    end
+
+
+    def write_html(assignment_dir, assignment)
+      builder = Nokogiri::HTML::Builder.new(:encoding => 'UTF-8') do |doc|
+        doc.html { |html|
+          html.head { |head|
+            head.meta('http-equiv' => 'Content-Type', content: 'text/html; charset=utf-8')
+            head.title "Assignment: #{assignment.title}"
+          }
+          html.body { |body|
+            body << Nokogiri::HTML::fragment(assignment.body)
+          }
+        }
+      end
+      File.open(File.join(@work_dir, assignment.assignment_resource.href), 'w') { |f| f.write(builder.to_html) }
+    end
+
+  end
+end

data/lib/moodle2cc/canvas_cc/calculated_question_writer.rb

@@ -0,0 +1,61 @@
+module Moodle2CC::CanvasCC
+  class CalculatedQuestionWriter < QuestionWriter
+    register_writer_type 'calculated_question'
+
+    private
+
+    def self.write_responses(presentation_node, question)
+      presentation_node.response_str(:rcardinality => 'Single', :ident => 'response1') do |response_node|
+        response_node.render_fib(:fibtype => 'Decimal') do |render_node|
+          render_node.response_label(:ident => 'answer1')
+        end
+      end
+    end
+
+    def self.write_response_conditions(processing_node, question)
+      processing_node.respcondition(:title => 'correct') do |condition|
+        condition.conditionvar do |var_node|
+          var_node.other
+        end
+        condition.setvar('100', :varname => 'SCORE', :action => 'Set')
+      end
+      processing_node.respcondition(:title => 'incorrect') do |condition|
+        condition.conditionvar do |var_node|
+          var_node.other
+        end
+        condition.setvar('0', :varname => 'SCORE', :action => 'Set')
+      end
+    end
+
+    def self.write_additional_nodes(item_node, question)
+      item_node.itemproc_extension do |extension_node|
+        extension_node.calculated do |calculated_node|
+          calculated_node.answer_tolerance question.tolerance
+
+          formula_decimal_places = question.correct_answer_format.to_i == 1 ? question.correct_answer_length : 0
+          calculated_node.formulas(:decimal_places => formula_decimal_places) do |formulas_node|
+            formulas = question.answers.map { |a| a.answer_text.gsub(/[\{\}\s]/, '') }
+            formulas.each do |formula|
+              formulas_node.formula formula
+            end
+          end
+          calculated_node.vars do |vars_node|
+            vars = question.dataset_definitions.map do |ds_def|
+              name = ds_def[:name]
+              type, min, max, scale = ds_def[:options].split(':')
+              {:name => name, :min => min, :max => max, :scale => scale}
+            end
+
+            vars.each do |var|
+              vars_node.var(:name => var[:name], :scale => var[:scale]) do |var_node|
+                var_node.min var[:min]
+                var_node.max var[:max]
+              end
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/moodle2cc/canvas_cc/canvas_export_writer.rb

@@ -0,0 +1,18 @@
+module Moodle2CC::CanvasCC
+  class CanvasExportWriter
+
+    CANVAS_EXPORT_FILE = 'canvas_export.txt'
+
+    def initialize(work_dir)
+      @work_dir = work_dir
+    end
+
+    def write
+      File.open(File.join(@work_dir, Moodle2CC::CanvasCC::CartridgeCreator::COURSE_SETTINGS_DIR, CANVAS_EXPORT_FILE), 'w') do |f|
+        f.write("Q: What did the panda say when he was forced out of his natural habitat?\nA: This is un-BEAR-able")
+      end
+    end
+
+
+  end
+end

data/lib/moodle2cc/canvas_cc/cartridge_creator.rb

@@ -0,0 +1,57 @@
+module Moodle2CC::CanvasCC
+  class CartridgeCreator
+
+    COURSE_SETTINGS_DIR = 'course_settings'
+
+    def initialize(course)
+      @course = course
+    end
+
+    def create(out_dir)
+      out_file = File.join(out_dir, filename)
+      Dir.mktmpdir do |dir|
+        write_cartridge(dir)
+
+        tmp_file = File.join(dir, filename)
+        zip_dir(tmp_file, dir)
+        FileUtils.mv(tmp_file, out_file)
+      end
+      out_file
+    end
+
+    def filename
+      title = @course.title.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+        gsub(/([a-z\d])([A-Z])/, '\1_\2').
+        gsub(/[\/|\.]/, '_').
+        tr('- ', '_').downcase.
+        gsub(/_{2,}/, '_')
+      "#{title}.imscc"
+    end
+
+    private
+
+    def write_cartridge(dir)
+      Dir.mkdir(File.join(dir, COURSE_SETTINGS_DIR))
+      Moodle2CC::CanvasCC::CanvasExportWriter.new(dir).write
+      Moodle2CC::CanvasCC::CourseSettingWriter.new(dir, @course).write
+      Moodle2CC::CanvasCC::ModuleMetaWriter.new(dir, *@course.canvas_modules).write
+      Moodle2CC::CanvasCC::ImsManifestGenerator.new(dir, @course).write
+      Moodle2CC::CanvasCC::FileMetaWriter.new(dir, *@course.files).write
+      Moodle2CC::CanvasCC::PageWriter.new(dir, *@course.pages).write
+      Moodle2CC::CanvasCC::DiscussionWriter.new(dir, *@course.discussions).write
+      Moodle2CC::CanvasCC::AssignmentWriter.new(dir, *@course.assignments).write
+      Moodle2CC::CanvasCC::QuestionBankWriter.new(dir, *@course.question_banks).write
+      Moodle2CC::CanvasCC::AssessmentWriter.new(dir, *@course.assessments).write
+    end
+
+    def zip_dir(out_file, dir)
+      Zip::File.open(out_file, Zip::File::CREATE) do |zipfile|
+        Dir["#{dir}/**/*"].each do |file|
+          zipfile.add(file.sub(dir + '/', ''), file)
+        end
+      end
+    end
+
+  end
+end