moodle2cc 0.1.12 → 0.2.0

data/lib/moodle2cc/canvas_cc/models/canvas_module.rb

@@ -0,0 +1,10 @@
+module Moodle2CC::CanvasCC::Models
+  class CanvasModule
+
+    attr_accessor :identifier, :title, :workflow_state, :module_items
+
+    def initialize
+      @module_items = []
+    end
+  end
+end

data/lib/moodle2cc/canvas_cc/models/course.rb

@@ -0,0 +1,46 @@
+module Moodle2CC::CanvasCC::Models
+  class Course
+
+    attr_accessor :format, :identifier, :copyright, :settings, :resources, :canvas_modules, :files, :pages, :discussions,
+                  :assignments, :assessments, :question_banks
+
+    def initialize
+      @settings = {}
+      @resources = []
+      @canvas_modules = []
+      @files = []
+      @pages = []
+      @discussions = []
+      @assignments = []
+      @assessments = []
+      @question_banks = []
+    end
+
+    def start_at
+      Moodle2CC::CC::CCHelper.ims_datetime(@settings[:start_at]) if @settings[:start_at]
+    end
+
+
+    def conclude_at
+      Moodle2CC::CC::CCHelper.ims_datetime(@settings[:conclude_at]) if @settings[:conclude_at]
+    end
+
+    def all_resources
+      @resources + @files + @pages + @discussions.map(&:resources).flatten + @assignments.map(&:resources).flatten
+    end
+
+    def method_missing(m, *args, &block)
+      method = m.to_s
+      if method[-1, 1] == '='
+        method.chomp!('=')
+        @settings[method.to_sym] = args.first
+      end
+      @settings[method.to_sym]
+    end
+
+    def resolve_question_references
+      return unless @assessments && @question_banks
+      @assessments.each{|a| a.resolve_question_references(@question_banks)}
+    end
+  end
+end

data/lib/moodle2cc/canvas_cc/models/discussion.rb

@@ -0,0 +1,36 @@
+module Moodle2CC::CanvasCC::Models
+  class Discussion
+    attr_accessor :identifier, :title, :text, :discussion_type, :workflow_state
+    DISCUSSION_ID_POSTFIX = '_DISCUSSION'
+    DISCUSSION_META_POSTFIX = '_meta'
+    IMSDT_TYPE = 'imsdt_xmlv1p1'
+    LAR_TYPE = 'associatedcontent/imscc_xmlv1p1/learning-application-resource'
+
+    def resources
+      #generate_meta_resource
+      [discussion_resource, meta_resource]
+    end
+
+    def discussion_resource
+      resource = Moodle2CC::CanvasCC::Models::Resource.new
+      resource.identifier = @identifier
+      resource.dependencies << resource.identifier + DISCUSSION_META_POSTFIX
+      resource.type = IMSDT_TYPE
+      resource.files << resource.identifier + '.xml'
+
+      resource
+    end
+
+    def meta_resource
+      resource = Moodle2CC::CanvasCC::Models::Resource.new
+      resource.identifier = @identifier + DISCUSSION_META_POSTFIX
+      resource.type = LAR_TYPE
+      file_name = resource.identifier + '.xml'
+      resource.href = file_name
+      resource.files << file_name
+
+      resource
+    end
+
+  end
+end

data/lib/moodle2cc/canvas_cc/models/discussion_topic.rb

@@ -0,0 +1,5 @@
+module Moodle2CC::CanvasCC::Models
+  class DiscussionTopic
+    attr_accessor :text
+  end
+end

data/lib/moodle2cc/canvas_cc/models/matching_question.rb

@@ -0,0 +1,7 @@
+module Moodle2CC::CanvasCC::Models
+  class MatchingQuestion < Question
+    register_question_type 'matching_question'
+
+    attr_accessor :matches
+  end
+end

data/lib/moodle2cc/canvas_cc/models/module_item.rb

@@ -0,0 +1,16 @@
+module Moodle2CC::CanvasCC::Models
+  class ModuleItem
+    attr_accessor :identifier, :content_type, :workflow_state, :title,
+                  :new_tab, :indent, :resource, :identifierref, :url
+
+    CONTENT_TYPE_WIKI_PAGE = 'WikiPage'
+    CONTENT_TYPE_ATTACHMENT = 'Attachment'
+    CONTENT_TYPE_CONTEXT_MODULE_SUB_HEADER = 'ContextModuleSubHeader'
+    CONTENT_TYPE_DISCUSSION_TOPIC = 'DiscussionTopic'
+    CONTENT_TYPE_ASSIGNMENT = 'Assignment'
+    CONTENT_TYPE_CONTEXT_EXTERNAL_TOOL = 'ContextExternalTool'
+    CONTENT_TYPE_QUIZ = 'Quizzes::Quiz'
+    CONTENT_TYPE_EXTERNAL_URL = 'ExternalUrl'
+
+  end
+end

data/lib/moodle2cc/canvas_cc/models/numerical_question.rb

@@ -0,0 +1,7 @@
+module Moodle2CC::CanvasCC::Models
+  class NumericalQuestion < Question
+    register_question_type 'numerical_question'
+
+    attr_accessor :tolerances
+  end
+end

data/lib/moodle2cc/canvas_cc/models/page.rb

@@ -0,0 +1,31 @@
+module Moodle2CC::CanvasCC::Models
+  class Page < Moodle2CC::CanvasCC::Models::Resource
+
+    PAGE_ID_POSTFIX = '_PAGE'
+    WIKI_CONTENT = 'wiki_content'
+    BOOK_PATH = WIKI_CONTENT + '/books'
+
+    EDITING_ROLE_TEACHER = 'teachers'
+
+    attr_accessor :workflow_state, :editing_roles, :body, :title
+
+    def initialize
+      super
+      @type = WEB_CONTENT_TYPE
+    end
+
+    def identifier=(identifier)
+      @identifier = identifier
+    end
+
+    def identifier
+      @identifier
+    end
+
+    def page_name= name
+      @title = name
+      @href = "#{WIKI_CONTENT}/#{CGI::escape(name.downcase.gsub(/\s/, '-'))}.html"
+    end
+
+  end
+end

data/lib/moodle2cc/canvas_cc/models/question.rb

@@ -0,0 +1,36 @@
+module Moodle2CC::CanvasCC::Models
+  class Question
+    QTI_META_ATTRIBUTES = [:question_type, :points_possible, :assessment_question_identifierref]
+    STANDARD_QUESTION_TYPES = ['essay_question', 'fill_in_multiple_blanks_question',
+                               'multiple_choice_question', 'short_answer_question',
+                               'text_only_question', 'true_false_question']
+
+    attr_accessor :identifier, :title, :material, :answers, :general_feedback, *QTI_META_ATTRIBUTES
+
+    @@subclasses = {}
+
+    def self.create(type)
+      q = if STANDARD_QUESTION_TYPES.include?(type)
+        self.new
+      elsif c = @@subclasses[type]
+        c.new
+      else
+        raise "Unknown question type: #{type}"
+      end
+      q.question_type = type
+      q
+    end
+
+    def self.register_question_type(name)
+      @@subclasses[name] = self
+    end
+
+    def initialize
+      @answers = []
+    end
+  end
+end
+
+require_relative 'calculated_question'
+require_relative 'matching_question'
+require_relative 'numerical_question'

data/lib/moodle2cc/canvas_cc/models/question_bank.rb

@@ -0,0 +1,27 @@
+module Moodle2CC::CanvasCC::Models
+  class QuestionBank
+
+    attr_accessor :identifier, :title, :questions, :question_groups
+
+    def initialize
+      @questions = []
+      @question_groups = []
+    end
+
+    LAR_TYPE = 'associatedcontent/imscc_xmlv1p1/learning-application-resource'
+    ASSESSMENT_NON_CC_FOLDER = 'non_cc_assessments'
+
+    def resources
+      [question_bank_resource]
+    end
+
+    def question_bank_resource
+      resource = Moodle2CC::CanvasCC::Models::Resource.new
+      resource.identifier = @identifier
+      resource.href = "#{ASSESSMENT_NON_CC_FOLDER}/#{resource.identifier}.xml.qti"
+      resource.type = LAR_TYPE
+      resource.files = [resource.href]
+      resource
+    end
+  end
+end

data/lib/moodle2cc/canvas_cc/models/question_group.rb

@@ -0,0 +1,10 @@
+module Moodle2CC::CanvasCC::Models
+  class QuestionGroup
+
+    attr_accessor :identifier, :title, :questions, :group_type, :selection_number, :points_per_item
+
+    def initialize
+      @questions = []
+    end
+  end
+end

data/lib/moodle2cc/canvas_cc/models/resource.rb

@@ -0,0 +1,23 @@
+module Moodle2CC::CanvasCC::Models
+  class Resource
+
+    WEB_CONTENT_TYPE = 'webcontent'
+
+    attr_accessor :files, :href, :type, :dependencies, :identifier
+
+    def initialize
+      @files = []
+      @dependencies = []
+      @ident_postfix = ''
+    end
+
+    def attributes
+      {
+        href: href,
+        type: type,
+        identifier: identifier
+      }.delete_if { |_, v| v.nil? }
+    end
+
+  end
+end

data/lib/moodle2cc/canvas_cc/models/web_content.rb

@@ -0,0 +1,7 @@
+module Moodle2CC::CanvasCC::Models
+  class WebContent
+
+    attr_accessor :body
+
+  end
+end

data/lib/moodle2cc/canvas_cc/models/web_link.rb

@@ -0,0 +1,7 @@
+module Moodle2CC::CanvasCC::Models
+  class WebLink
+
+    attr_accessor :url, :external_link, :href
+
+  end
+end

data/lib/moodle2cc/canvas_cc/models/workflow_state.rb

@@ -0,0 +1,6 @@
+module Moodle2CC::CanvasCC::Models
+  module WorkflowState
+    ACTIVE = 'active'
+    UNPUBLISHED = 'unpublished'
+  end
+end

data/lib/moodle2cc/canvas_cc/module_meta_writer.rb

@@ -0,0 +1,52 @@
+module Moodle2CC::CanvasCC
+  class ModuleMetaWriter
+    MODULE_META_FILE = 'module_meta.xml'
+
+    def initialize(work_dir, *canvas_modules)
+      @work_dir = work_dir
+      @canvas_modules = canvas_modules
+    end
+
+    def write
+      xml = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+        xml.modules(
+            '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|
+          @canvas_modules.each_with_index { |mod, position| canvas_module(mod, xml, position) }
+        }
+      end.to_xml
+      File.open(File.join(@work_dir, Moodle2CC::CanvasCC::CartridgeCreator::COURSE_SETTINGS_DIR, MODULE_META_FILE), 'w') { |f| f.write(xml) }
+    end
+
+    private
+
+    def canvas_module(mod, xml, position)
+      xml.module('identifier' => mod.identifier) {
+        xml.title mod.title
+        xml.workflow_state mod.workflow_state
+        xml.position(position)
+        xml.items { |xml|
+          add_module_items_to_xml(mod.module_items, xml)
+        }
+      }
+    end
+
+    def add_module_items_to_xml(module_items, xml)
+      module_items.each_with_index do |item, position|
+        xml.item('identifier' => item.identifier) { |xml|
+          xml.content_type(item.content_type)
+          xml.workflow_state(item.workflow_state)
+          xml.title(item.title)
+          xml.position(position)
+          xml.new_tab(item.new_tab) if item.new_tab
+          xml.indent(item.indent)
+          xml.identifierref(item.identifierref) if item.identifierref
+          xml.url(item.url) if item.url
+        }
+      end
+    end
+
+  end
+end

data/lib/moodle2cc/canvas_cc/multiple_blanks_question_writer.rb

@@ -0,0 +1,51 @@
+module Moodle2CC::CanvasCC
+  class MultipleBlanksQuestionWriter < QuestionWriter
+    register_writer_type 'fill_in_multiple_blanks_question'
+
+    private
+
+    def self.write_responses(presentation_node, question)
+      resp_idents = question.answers.map{|a| a.resp_ident}.uniq
+      resp_idents.each do |resp_ident|
+        presentation_node.response_lid(:ident => resp_ident, :rcardinality => 'Single') do |response_node|
+          response_node.render_choice do |choice_node|
+            question.answers.select{|a| a.resp_ident == resp_ident}.each do |answer|
+              choice_node.response_label(:ident => answer.id) do |label_node|
+                label_node.material do |material_node|
+                  material_node.mattext answer.answer_text, :texttype => 'text/html'
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def self.write_response_conditions(processing_node, question)
+      # Feedback
+      question.answers.each do |answer|
+        next unless answer.feedback && answer.feedback.strip.length > 0
+        processing_node.respcondition(:continue => 'Yes') do |condition_node|
+          condition_node.conditionvar do |var_node|
+            var_node.varequal answer.id, :respident => answer.resp_ident
+          end
+          condition_node.displayfeedback(:feedbacktype => 'Response', :linkrefid => "#{answer.id}_fb")
+        end
+      end
+
+      # Scores
+      question.answers.each do |answer|
+        processing_node.respcondition(:continue => 'No') do |condition_node|
+          condition_node.conditionvar do |var_node|
+            var_node.varequal answer.id, :respident => answer.resp_ident
+          end
+          condition_node.setvar(convert_fraction_to_score(answer.fraction), :varname => 'SCORE', :action => 'Set')
+        end
+      end
+    end
+
+    def self.write_additional_nodes(item_node, question)
+      write_standard_answer_feedbacks(item_node, question)
+    end
+  end
+end

data/lib/moodle2cc/canvas_cc/multiple_choice_question_writer.rb

@@ -0,0 +1,48 @@
+module Moodle2CC::CanvasCC
+  class MultipleChoiceQuestionWriter < QuestionWriter
+    register_writer_type 'multiple_choice_question'
+
+    private
+
+    def self.write_responses(presentation_node, question)
+      presentation_node.response_lid(:ident => 'response1', :rcardinality => 'Single') do |response_node|
+        response_node.render_choice do |choice_node|
+          question.answers.each do |answer|
+            choice_node.response_label(:ident => answer.id) do |label_node|
+              label_node.material do |material_node|
+                material_node.mattext answer.answer_text, :texttype => 'text/html'
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def self.write_response_conditions(processing_node, question)
+      # Feedback
+      question.answers.each do |answer|
+        next unless answer.feedback && answer.feedback.strip.length > 0
+        processing_node.respcondition(:continue => 'Yes') do |condition_node|
+          condition_node.conditionvar do |var_node|
+            var_node.varequal answer.id, :respident => 'response1'
+          end
+          condition_node.displayfeedback(:feedbacktype => 'Response', :linkrefid => "#{answer.id}_fb")
+        end
+      end
+
+      # Scores
+      question.answers.each do |answer|
+        processing_node.respcondition(:continue => 'No') do |condition_node|
+          condition_node.conditionvar do |var_node|
+            var_node.varequal answer.id, :respident => 'response1'
+          end
+          condition_node.setvar(convert_fraction_to_score(answer.fraction), :varname => 'SCORE', :action => 'Set')
+        end
+      end
+    end
+
+    def self.write_additional_nodes(item_node, question)
+      write_standard_answer_feedbacks(item_node, question)
+    end
+  end
+end