canvas_cc 0.0.1

data/lib/canvas_cc/canvas_cc/matching_question_writer.rb

@@ -0,0 +1,43 @@
+module CanvasCc::CanvasCC
+  class MatchingQuestionWriter < QuestionWriter
+    register_writer_type 'matching_question'
+
+    private
+
+    def self.write_responses(presentation_node, question)
+      question.matches.each do |match|
+        presentation_node.response_lid(:ident => "response_#{match[:id]}") do |response_node|
+          next unless match[:question_text].length > 0
+          response_node.material do |material_node|
+            material_node.mattext(match[:question_text], :texttype => 'text/plain')
+          end
+          response_node.render_choice do |choice_node|
+            question.matches.each do |possible_match|
+              choice_node.response_label(:ident => possible_match[:id]) do |label_node|
+                label_node.material do |material_node|
+                  material_node.mattext(possible_match[:answer_text], :texttype => 'text/plain')
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def self.write_response_conditions(processing_node, question)
+      real_matches = question.matches.select{|m| m[:question_text].length > 0}
+      score = 100.0 / real_matches.length.to_i
+      real_matches.each do |match|
+        processing_node.respcondition do |condition_node|
+          condition_node.conditionvar do |var_node|
+            var_node.varequal match[:id], :respident => "response_#{match[:id]}"
+          end
+          condition_node.setvar "%.2f" % score, :varname => 'SCORE', :action => 'Add'
+        end
+      end
+    end
+
+    def self.write_additional_nodes(item_node, question)
+    end
+  end
+end

data/lib/canvas_cc/canvas_cc/models/answer.rb

@@ -0,0 +1,12 @@
+module CanvasCc::CanvasCC::Models
+  class Answer
+    attr_accessor :id, :answer_text, :answer_format, :fraction, :feedback, :feedback_format, :resp_ident
+
+    def initialize(answer=nil)
+      return unless answer
+      answer.instance_variables.each do |var|
+        self.instance_variable_set(var, answer.instance_variable_get(var))
+      end
+    end
+  end
+end

data/lib/canvas_cc/canvas_cc/models/assessment.rb

@@ -0,0 +1,102 @@
+module CanvasCc::CanvasCC::Models
+  class Assessment
+    META_ATTRIBUTES = [:title, :description, :allowed_attempts,
+                       :scoring_policy, :access_code, :ip_filter, :shuffle_answers, :time_limit, :quiz_type]
+    DATETIME_ATTRIBUTES = [:lock_at, :unlock_at]
+
+    ASSESSMENT_TYPE = 'imsqti_xmlv1p2/imscc_xmlv1p1/assessment'
+    LAR_TYPE = 'associatedcontent/imscc_xmlv1p1/learning-application-resource'
+    ASSESSMENT_NON_CC_FOLDER = 'non_cc_assessments'
+
+    attr_accessor :identifier, :workflow_state, :question_references, :items, *META_ATTRIBUTES, *DATETIME_ATTRIBUTES
+
+    def initialize
+      @question_references = []
+    end
+
+    def resources
+      [cc_assessment_resource, canvas_assessment_resource]
+    end
+
+    def cc_assessment_resource
+      resource = CanvasCc::CanvasCC::Models::Resource.new
+      resource.identifier = @identifier
+      resource.type = ASSESSMENT_TYPE
+      resource.dependencies = ["#{@identifier}_meta"]
+      resource.files = [] # TODO: export cc qti file
+      resource
+    end
+
+    def canvas_assessment_resource
+      resource = CanvasCc::CanvasCC::Models::Resource.new
+      resource.identifier = "#{@identifier}_meta"
+      resource.href = meta_file_path
+      resource.type = LAR_TYPE
+      resource.files = [meta_file_path, qti_file_path]
+      resource
+    end
+
+    def meta_file_path
+      "#{@identifier}/assessment_meta.xml"
+    end
+
+    def qti_file_path
+      "#{ASSESSMENT_NON_CC_FOLDER}/#{@identifier}.xml.qti"
+    end
+
+    def resolve_question_references!(question_banks)
+      @items ||= []
+
+      # keep track of each time a bank is referenced through a random question reference
+      random_bank_counts = {}
+
+      @question_references.each do |ref|
+        question = nil
+        group = nil
+        question_banks.each do |bank|
+          break if (question = bank.questions.detect{|q| q.original_identifier.to_s == ref[:question]}) ||
+            (group = bank.question_groups.detect{|g| g.identifier.to_s == ref[:question]})
+
+          if bank.random_question_references.any?{|r| r.to_s == ref[:question]}
+            random_bank_counts[bank] ||= 0
+            random_bank_counts[bank] += 1
+            break
+          end
+        end
+
+        if question
+          question.assessment_question_identifierref ||= "question_#{question.identifier}"
+          copy = question.dup
+          copy.points_possible = ref[:grade] if ref[:grade]
+          @items << copy
+        elsif group
+          copy = group.dup
+          if ref[:grade] && copy.selection_number.to_i != 0
+            copy.points_per_item = ref[:grade].to_f / copy.selection_number.to_i
+          end
+          @items << copy
+        end
+      end
+
+      random_bank_counts.each do |bank, count|
+        new_group = CanvasCc::CanvasCC::Models::QuestionGroup.new
+        new_group.identifier = "#{@identifier}#{bank.identifier}_random_group"
+        new_group.selection_number = count
+
+        new_group.questions = bank.questions.map(&:dup)
+        child_banks = bank.find_children_banks(question_banks)
+        child_banks.each do |child|
+          new_group.questions += child.questions.map(&:dup)
+        end
+
+        @items << new_group
+      end
+
+      @items.select{|i| i.is_a?(CanvasCc::CanvasCC::Models::QuestionGroup)}.each do |group|
+        group.questions.each do |q|
+          @items.delete_if{|i| i.respond_to?(:original_identifier) && i.original_identifier == q.original_identifier}
+        end
+      end
+    end
+  end
+end

data/lib/canvas_cc/canvas_cc/models/assignment.rb

@@ -0,0 +1,30 @@
+module CanvasCc::CanvasCC::Models
+  class Assignment
+    attr_accessor :identifier, :title, :body, :due_at, :lock_at, :unlock_at, :all_day_date, :peer_reviews_due_at,
+                  :assignment_group_identifier_ref, :workflow_state, :points_possible, :grading_type, :all_day,
+                  :submission_types, :position, :peer_review_count, :peer_reviews_assigned, :peer_reviews,
+                  :automatic_peer_reviews, :grade_group_students_individually, :muted
+
+    LAR_TYPE = 'associatedcontent/imscc_xmlv1p1/learning-application-resource'
+    ASSIGNMENT_SETTINGS_FILE = 'assignment_settings.xml'
+
+    def initialize
+      @submission_types = []
+    end
+
+    def resources
+      [assignment_resource]
+    end
+
+    def assignment_resource
+      resource = CanvasCc::CanvasCC::Models::Resource.new
+      resource.identifier = @identifier
+      resource.href = "#{resource.identifier}/assignment-#{CGI::escape(title.downcase.gsub(/\s/, '-'))}.html"
+      resource.type = LAR_TYPE
+      resource.files = [resource.href, "#{resource.identifier}/#{ASSIGNMENT_SETTINGS_FILE}"]
+
+      resource
+    end
+
+  end
+end

data/lib/canvas_cc/canvas_cc/models/assignment_group.rb

@@ -0,0 +1,9 @@
+module CanvasCc::CanvasCC::Models
+  class AssignmentGroup
+    attr_accessor :identifier, :title, :position, :group_weight, :rules
+
+    def initialize
+      @rules = []
+    end
+  end
+end

data/lib/canvas_cc/canvas_cc/models/calculated_question.rb

@@ -0,0 +1,19 @@
+module CanvasCc::CanvasCC::Models
+  class CalculatedQuestion < Question
+    register_question_type 'calculated_question'
+
+    attr_accessor :correct_answer_format, :correct_answer_length, :dataset_definitions, :tolerance, :var_sets
+
+    def post_process!
+      @material.gsub!(/\{([\w\s]*?)\}/, '[\1]') if @material
+
+      return unless @answers
+      @answers.each do |answer|
+        if answer.answer_text
+          answer.answer_text.gsub!(/\{([\w\s]*?)\}/, '\1')
+          answer.answer_text = answer.answer_text.sub('=', '') if answer.answer_text.start_with?('=')
+        end
+      end
+    end
+  end
+end

data/lib/canvas_cc/canvas_cc/models/canvas_file.rb

@@ -0,0 +1,22 @@
+module CanvasCc::CanvasCC::Models
+  class CanvasFile < CanvasCc::CanvasCC::Models::Resource
+
+    WEB_RESOURCES = 'web_resources'
+
+    attr_reader :file_path
+    attr_accessor :file_location
+
+    def initialize
+      super
+      @type = WEB_CONTENT_TYPE
+    end
+
+    def file_path=(file_path)
+      @href = File.join(WEB_RESOURCES, file_path)
+      @files << self.href
+      @file_path = file_path
+    end
+
+
+  end
+end

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

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

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

@@ -0,0 +1,53 @@
+module CanvasCc::CanvasCC::Models
+  class Course
+
+    attr_accessor :format, :identifier, :copyright, :settings, :resources, :canvas_modules, :files, :pages, :discussions,
+                  :assignments, :assessments, :question_banks, :assignment_groups
+
+    def initialize
+      @settings = {}
+      @resources = []
+      @canvas_modules = []
+      @files = []
+      @pages = []
+      @discussions = []
+      @assignments = []
+      @assessments = []
+      @question_banks = []
+      @assignment_groups = []
+    end
+
+    def start_at
+      CanvasCc::CC::CCHelper.ims_datetime(@settings[:start_at]) if @settings[:start_at]
+    end
+
+
+    def conclude_at
+      CanvasCc::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 + @assessments.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
+
+    def mute_assignments!
+      @assignments.each do |assignment|
+        assignment.muted = true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module CanvasCc::CanvasCC::Models
+  class Discussion
+    attr_accessor :identifier, :title, :text, :discussion_type, :workflow_state, :require_initial_post
+    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 = CanvasCc::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 = CanvasCc::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/canvas_cc/canvas_cc/models/discussion_topic.rb

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

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

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

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

@@ -0,0 +1,16 @@
+module CanvasCc::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/canvas_cc/canvas_cc/models/multiple_dropdowns_question.rb

@@ -0,0 +1,7 @@
+module CanvasCc::CanvasCC::Models
+  class MultipleDropdownsQuestion < Question
+    register_question_type 'multiple_dropdowns_question'
+
+    attr_accessor :responses
+  end
+end

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

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

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

@@ -0,0 +1,41 @@
+module CanvasCc::CanvasCC::Models
+  class Page < CanvasCc::CanvasCC::Models::Resource
+
+    PAGE_ID_POSTFIX = '_PAGE'
+    WIKI_CONTENT = 'wiki_content'
+    BOOK_PATH = WIKI_CONTENT + '/books'
+
+    EDITING_ROLE_TEACHER = 'teachers'
+
+    MAX_URL_LENGTH = 80
+
+    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}/#{self.class.convert_name_to_url(name)}.html"
+    end
+
+    def self.convert_name_to_url(name)
+      url = CGI::escape(name.downcase.gsub(/\s/, '-').gsub('.', 'dot'))
+      if url.length > MAX_URL_LENGTH
+        url = url[0,MAX_URL_LENGTH][/.{0,#{MAX_URL_LENGTH}}/mu]
+      end
+      url
+    end
+
+  end
+end

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

@@ -0,0 +1,37 @@
+module CanvasCc::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', 'multiple_answers_question',
+                               'short_answer_question', 'text_only_question', 'true_false_question']
+
+    attr_accessor :identifier, :original_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 'multiple_dropdowns_question'
+require_relative 'numerical_question'

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

@@ -0,0 +1,42 @@
+module CanvasCc::CanvasCC::Models
+  class QuestionBank
+
+    attr_accessor :identifier, :title, :questions, :question_groups, :random_question_references, :original_id, :parent_id
+
+    def initialize
+      @questions = []
+      @question_groups = []
+      @random_question_references = []
+    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 = CanvasCc::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
+
+    # recursively find all banks that belong to this one
+    def find_children_banks(all_banks, visited_banks=[])
+      visited_banks << self
+      children = []
+      sub_children = []
+      all_banks.each do |bank|
+        children << bank if bank.parent_id && bank.parent_id == self.original_id && !visited_banks.include?(bank)
+      end
+      children.each do |child|
+        sub_children += child.find_children_banks(all_banks, visited_banks)
+      end
+      return children + sub_children
+    end
+  end
+end

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

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

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

@@ -0,0 +1,23 @@
+module CanvasCc::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/canvas_cc/canvas_cc/models/web_content.rb

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

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

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

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

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

data/lib/canvas_cc/canvas_cc/module_meta_writer.rb

@@ -0,0 +1,52 @@
+module CanvasCc::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, CanvasCc::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/canvas_cc/canvas_cc/multiple_answers_question_writer.rb

@@ -0,0 +1,41 @@
+module CanvasCc::CanvasCC
+  class MultipleAnswersQuestionWriter < QuestionWriter
+    register_writer_type 'multiple_answers_question'
+
+    private
+
+    def self.write_responses(presentation_node, question)
+      presentation_node.response_lid(:ident => 'response1', :rcardinality => 'Multiple') 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)
+      return unless question.answers.count > 0
+      processing_node.respcondition(:continue => 'No') do |condition_node|
+        condition_node.conditionvar do |var_node|
+          var_node.and do |and_node|
+            question.answers.each do |answer|
+              if answer.fraction.to_f > 0
+                and_node.varequal answer.id, :respident => 'response1'
+              else
+                and_node.not do |not_node|
+                  not_node.varequal answer.id, :respident => 'response1'
+                end
+              end
+            end
+          end
+        end
+        condition_node.setvar('100', :varname => 'SCORE', :action => 'Set')
+      end
+    end
+  end
+end