Module: CanvasQtiToLearnosityConverter

Defined in:
lib/canvas_qti_to_learnosity_converter.rb,
lib/canvas_qti_to_learnosity_converter/convert.rb,
lib/canvas_qti_to_learnosity_converter/version.rb,
lib/canvas_qti_to_learnosity_converter/questions/essay.rb,
lib/canvas_qti_to_learnosity_converter/questions/matching.rb,
lib/canvas_qti_to_learnosity_converter/questions/question.rb,
lib/canvas_qti_to_learnosity_converter/questions/numerical.rb,
lib/canvas_qti_to_learnosity_converter/questions/text_only.rb,
lib/canvas_qti_to_learnosity_converter/questions/calculated.rb,
lib/canvas_qti_to_learnosity_converter/questions/file_upload.rb,
lib/canvas_qti_to_learnosity_converter/questions/short_answer.rb,
lib/canvas_qti_to_learnosity_converter/questions/fill_the_blanks.rb,
lib/canvas_qti_to_learnosity_converter/questions/multiple_choice.rb,
lib/canvas_qti_to_learnosity_converter/questions/template_question.rb,
lib/canvas_qti_to_learnosity_converter/questions/multiple_dropdowns.rb

Defined Under Namespace

Classes: CalculatedQuestion, CanvasQtiQuiz, CanvasQuestionTypeNotSupportedError, EssayQuestion, FileUploadQuestion, FillTheBlanksQuestion, MatchingQuestion, MultipleAnswersQuestion, MultipleChoiceQuestion, MultipleDropdownsQuestion, NumericalQuestion, QuizQuestion, ShortAnswerQuestion, TemplateQuestion, TextOnlyQuestion

Constant Summary collapse

FEATURE_TYPES = 
[ :text_only_question ]
QUESTION_TYPES = 
[
  :multiple_choice_question,
  :true_false_question,
  :multiple_answers_question,
  :short_answer_question,
  :fill_in_multiple_blanks_question,
  :multiple_dropdowns_question,
  :matching_question,
  :essay_question,
  :file_upload_question,
]
TYPE_MAP = 
{
  multiple_choice_question: MultipleChoiceQuestion,
  true_false_question: MultipleChoiceQuestion,
  multiple_answers_question: MultipleAnswersQuestion,
  short_answer_question: ShortAnswerQuestion,
  fill_in_multiple_blanks_question: FillTheBlanksQuestion,
  multiple_dropdowns_question: MultipleDropdownsQuestion,
  matching_question: MatchingQuestion,
  essay_question: EssayQuestion,
  file_upload_question: FileUploadQuestion,
  text_only_question: TextOnlyQuestion,
  numerical_question: NumericalQuestion,
  calculated_question: CalculatedQuestion,

  "cc.multiple_choice.v0p1": MultipleChoiceQuestion,
  "cc.multiple_response.v0p1": MultipleAnswersQuestion,
  "cc.fib.v0p1": ShortAnswerQuestion,
  "cc.true_false.v0p1": MultipleChoiceQuestion,
  "cc.essay.v0p1": EssayQuestion,
}
VERSION = 
"2.5.0"

Class Method Summary collapse

Class Method Details

.add_files_to_assets(assets, path, text) ⇒ Object 



91
92
93
94
95
96
97
 
# File 'lib/canvas_qti_to_learnosity_converter/convert.rb', line 91

def self.add_files_to_assets(assets, path, text)
  text.scan(/(%24|\$)IMS-CC-FILEBASE\1\/([^"]+)/) do |_delimiter, asset_path|
    decoded_path = URI::DEFAULT_PARSER.unescape(asset_path)
    assets[decoded_path] ||= []
    assets[decoded_path].push(path)
  end
end

.build_quiz_from_file(path) ⇒ Object 



83
84
85
86
87
88
89
 
# File 'lib/canvas_qti_to_learnosity_converter/convert.rb', line 83

def self.build_quiz_from_file(path)
  qti_file = File.new path
  qti_string = qti_file.read
  CanvasQtiQuiz.new(qti_string: qti_string)
ensure
  qti_file.close
end

.build_quiz_from_qti_string(qti_string) ⇒ Object 



79
80
81
 
# File 'lib/canvas_qti_to_learnosity_converter/convert.rb', line 79

def self.build_quiz_from_qti_string(qti_string)
  CanvasQtiQuiz.new(qti_string: qti_string)
end

.clean_title(title) ⇒ Object 



129
130
131
 
# File 'lib/canvas_qti_to_learnosity_converter/convert.rb', line 129

def self.clean_title(title)
  title.gsub(/["']/, "")
end

.convert(qti, assets, errors) ⇒ Object 



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/canvas_qti_to_learnosity_converter/convert.rb', line 133

def self.convert(qti, assets, errors)
  quiz = CanvasQtiQuiz.new(qti_string: qti)
  assessment = quiz.css("assessment")
  ident = assessment.attribute("ident").value
  assets[ident] = {}
  errors[ident] = []

  items = []

  quiz.css("item").each.with_index do |item, index|
    begin
      next if item.children.length == 0

      item_title = item.attribute("title")&.value || ''
      learnosity_type, quiz_item = convert_item(qti_string: item.to_html)

      item = {
        title: item_title,
        type: learnosity_type,
        data: quiz_item.to_learnosity,
        dynamic_content_data: quiz_item.dynamic_content_data()
      }

      items.push(item)
      path = [items.count - 1, :data]

      quiz_item.add_learnosity_assets(assets[ident], path)
    rescue CanvasQuestionTypeNotSupportedError => e
      errors[ident].push({
        index: index,
        error_type: "unsupported_question",
        question_type: e.question_type.to_s,
        message: e.message,
      })
    rescue StandardError => e
      errors[ident].push({
        index: index,
        error_type: e.class.to_s,
        message: e.message,
      })
    end
  end

  {
    title: clean_title(assessment.attribute("title").value),
    ident: ident,
    items: items,
  }
end

.convert_imscc_export(path) ⇒ Object 



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/canvas_qti_to_learnosity_converter/convert.rb', line 211

def self.convert_imscc_export(path)
  Zip::File.open(path) do |zip_file|
    entry = zip_file.find_entry("imsmanifest.xml")
    manifest = entry.get_input_stream.read
    parsed_manifest = Nokogiri.XML(manifest, &:noblanks)
    paths = imscc_quiz_paths(parsed_manifest)

    assets = {}
    errors = {}
    converted_assesments = paths.map do |qti_path|
      qti = zip_file.find_entry(qti_path).get_input_stream.read
      convert(qti, assets, errors)
    end

    {
      assessments: converted_assesments,
      assets: assets,
      errors: errors,
    }
  end
end

.convert_item(qti_string:) ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/canvas_qti_to_learnosity_converter/convert.rb', line 108

def self.convert_item(qti_string:)
  xml = Nokogiri.XML(qti_string, &:noblanks)
  type = extract_type(xml)

  if FEATURE_TYPES.include?(type)
    learnosity_type = "feature"
  else
    learnosity_type = "question"
  end

  question_class = TYPE_MAP[type]

  if question_class
    question = question_class.new(xml)
  else
    raise CanvasQuestionTypeNotSupportedError.new(type)
  end

  [learnosity_type, question]
end

.convert_qti_file(path) ⇒ Object 



183
184
185
186
187
188
189
190
 
# File 'lib/canvas_qti_to_learnosity_converter/convert.rb', line 183

def self.convert_qti_file(path)
  file = File.new(path)
  qti_string = file.read
  convert(qti_string)
ensure
  file.close
  file.unlink
end

.extract_type(xml) ⇒ Object 



99
100
101
102
103
104
105
106
 
# File 'lib/canvas_qti_to_learnosity_converter/convert.rb', line 99

def self.extract_type(xml)
  xml.css(%{ item > itemmetadata > qtimetadata >
    qtimetadatafield > fieldlabel:contains("question_type")})
    &.first&.next&.text&.to_sym ||
    xml.css(%{ item > itemmetadata > qtimetadata >
      qtimetadatafield > fieldlabel:contains("cc_profile")})
      &.first&.next&.text&.to_sym
end

.imscc_quiz_paths(parsed_manifest) ⇒ Object 



192
193
194
195
196
197
 
# File 'lib/canvas_qti_to_learnosity_converter/convert.rb', line 192

def self.imscc_quiz_paths(parsed_manifest)
  resources = parsed_manifest.css("resources > resource[type^='imsqti_xmlv1p2']")
  resources.map do |entry|
    resource_path(parsed_manifest, entry)
  end
end

.read_file(path) ⇒ Object 



71
72
73
74
75
76
77
 
# File 'lib/canvas_qti_to_learnosity_converter/convert.rb', line 71

def self.read_file(path)
  file = File.new path
  file.read
ensure
  file.close
# Do we need to unlink?
end

.resource_path(parsed_manifest, entry) ⇒ Object 



199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/canvas_qti_to_learnosity_converter/convert.rb', line 199

def self.resource_path(parsed_manifest, entry)
  # Use the Canvas non_cc_assignment qti path when possible.  This works for both classic and new quizzes
  entry.css("dependency").each do |dependency|
    ref = dependency.attribute("identifierref").value
    parsed_manifest.css(%{resources > resource[identifier="#{ref}"] > file}).each do |file|
      path = file.attribute("href").value
      return path if path.match?(/^non_cc_assessments/)
    end
  end
  entry.css("file").first&.attribute("href")&.value
end