Class: CanvasQtiToLearnosityConverter::CalculatedQuestion

Inherits:
TemplateQuestion show all
Defined in:
lib/canvas_qti_to_learnosity_converter/questions/calculated.rb

Instance Method Summary collapse

Methods inherited from TemplateQuestion

#extract_template, #get_template

Methods inherited from QuizQuestion

#convert, #extract_feedback, #extract_mattext, #extract_points_possible, #extract_stimulus, for, #initialize, #make_identifier, #process_assets!

Constructor Details

This class inherits a constructor from CanvasQtiToLearnosityConverter::QuizQuestion

Instance Method Details

#add_learnosity_assets(assets, path, learnosity) ⇒ Object 



282
283
284
285
 
# File 'lib/canvas_qti_to_learnosity_converter/questions/calculated.rb', line 282

def add_learnosity_assets(assets, path, learnosity)
  process_assets!(assets, path, learnosity[:template])
  learnosity
end

#build_dynamic_content ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/canvas_qti_to_learnosity_converter/questions/calculated.rb', line 85

def build_dynamic_content()
  var_names = extract_var_names()
  var_ranges = extract_var_ranges()
  formula = extract_formula()
  context = build_mqg_context()
  data = build_generated_math_data()
  count = data.length
  scientific = scientific_notation_enabled?
  response_name = scientific ? "scientific" : "decimal"

  first_row = data.first[:val]
  first_vars = first_row.reject { |v| v[:name] == response_name }
  first_answer = first_row.find { |v| v[:name] == response_name }&.dig(:val)
  seed_with_values = first_vars.reduce(formula) { |f, v| f.gsub(v[:name], v[:val]) }

  # scientific values are already formatted as LaTeX; decimal values need wrapping
  response_sample_val = scientific ? first_answer : (first_answer ? "\\(#{first_answer}\\)" : nil)

  sample = first_answer ? {
    val: [
      { name: "seed", val: "\\(#{seed_with_values}\\)" },
      { name: response_name, val: response_sample_val },
    ],
    length: 2,
    count: 1,
  } : nil

  {
    parameters: var_names.map do |name|
      range = var_ranges[name]
      { name: name, type: "range", min: range[:min], max: range[:max], step: range[:step] }
    end,
    generated_math: {
      type: "formula",
      sample: sample,
      seed: formula,
      response: [response_name],
      params: [var_names, var_names.map { |name|
        r = var_ranges[name]
        "#{r[:min]}..#{r[:max]}:#{r[:step]}"
      }],
      context: context,
      template: "{response==seed}",
      checks: [],
      count: count,
      limit: count,
      randomize: true,
      data: data,
    }.compact,
    question_data: build_question_data(),
    validation_data: build_validation_data(response_sample_val, scientific: scientific),
  }
end

#build_generated_math_data ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/canvas_qti_to_learnosity_converter/questions/calculated.rb', line 165

def build_generated_math_data()
  var_names = extract_var_names()
  var_values = var_names.map do |name|
    @xml.css(%{item > itemproc_extension > calculated > var_sets > var_set > var[name="#{name}"]}).map(&:text)
  end
  answers = @xml.css("item > itemproc_extension var_sets answer").map(&:text)
  scientific = scientific_notation_enabled?

  answers.each_with_index.map do |answer, i|
    row_vals = var_names.each_with_index.map { |name, j| { name: name, val: var_values[j][i] } }
    if scientific
      row_vals << { name: "scientific", val: format_scientific_latex(answer) }
    else
      row_vals << { name: "decimal", val: answer }
    end
    { val: row_vals }
  end
end

#build_mqg_context ⇒ Object 



155
156
157
158
159
160
161
162
163
 
# File 'lib/canvas_qti_to_learnosity_converter/questions/calculated.rb', line 155

def build_mqg_context()
  template = get_template()
  uses_backtick = template.match?(/`[^`]+`/)
  extract_var_names().each do |name|
    pattern = uses_backtick ? "`#{name}`" : "[#{name}]"
    template.sub!(pattern, "{#{name}}")
  end
  template.match?(/__{2,}/) ? template.sub(/__{2,}/, "{{response}}") : template
end

#build_question_data ⇒ Object 



184
185
186
187
188
189
190
191
192
193
 
# File 'lib/canvas_qti_to_learnosity_converter/questions/calculated.rb', line 184

def build_question_data()
  formula = extract_formula()
  expression = extract_var_names().reduce(formula) do |f, name|
    f.gsub(/\b#{Regexp.escape(name)}\b/, "{{var:#{name}}}")
  end
  {
    expression: expression,
    template: build_template_field(),
  }
end

#build_template_field ⇒ Object 



15
16
17
18
19
20
21
22
23
 
# File 'lib/canvas_qti_to_learnosity_converter/questions/calculated.rb', line 15

def build_template_field()
  template = get_template()
  uses_backtick = template.match?(/`[^`]+`/)
  extract_var_names().each do |name|
    pattern = uses_backtick ? "`#{name}`" : "[#{name}]"
    template.sub!(pattern, "{{var:#{name}}}")
  end
  template.match?(/__{2,}/) ? template.sub(/__{2,}/, "{{response}}") : template + "{{response}}"
end

#build_validation_data(sample_val = nil, scientific: false) ⇒ Object 



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/canvas_qti_to_learnosity_converter/questions/calculated.rb', line 195

def build_validation_data(sample_val = nil, scientific: false)
  decimal_places = @xml.css("item > itemproc_extension > calculated > formulas")
    .first["decimal_places"].to_i

  if scientific
    {
      availableFormats: [{ name: "scientific", val: sample_val || "", isSelected: true }],
      formatsData: {
        scientific: {
          value: [[
            {
              method: "equivValue",
              value: "{{var:scientific}}",
              options: {
                allowThousandsSeparator: false,
                setThousandsSeparator: [","],
                setDecimalSeparator: ["."],
              },
            },
            {
              method: "equivSyntax",
              value: "\\format{\\scientific}",
              options: {
                allowThousandsSeparator: false,
                setThousandsSeparator: [","],
                setDecimalSeparator: ["."],
              },
            },
          ]]
        }
      },
      options: {
        score: extract_points_possible,
        decimalPlaces: decimal_places.to_s,
        allowThousandsSeparator: false,
        setDecimalSeparator: ".",
        setThousandsSeparator: ",",
      },
    }
  else
    {
      availableFormats: [{ name: "decimal", val: sample_val || "", isSelected: true }],
      formatsData: {
        decimal: {
          value: [[{
            method: "equivValue",
            value: "{{var:decimal}}",
            options: {
              decimalPlaces: decimal_places,
              allowThousandsSeparator: false,
              setThousandsSeparator: [","],
              setDecimalSeparator: ["."],
            },
          }]]
        }
      },
      options: {
        score: extract_points_possible,
        decimalPlaces: decimal_places.to_s,
        allowThousandsSeparator: false,
        setDecimalSeparator: ".",
        setThousandsSeparator: ",",
      },
    }
  end
end

#dynamic_content_data ⇒ Object 



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/canvas_qti_to_learnosity_converter/questions/calculated.rb', line 287

def dynamic_content_data()
  var_names = extract_var_names()
  var_values = var_names.map do |name|
    @xml.css(%{item > itemproc_extension > calculated > var_sets > var_set > var[name="#{name}"]}).map(&:text)
  end
  answers = @xml.css("item > itemproc_extension var_sets answer").map(&:text)
  response_name = scientific_notation_enabled? ? "scientific" : "decimal"

  columns = var_names + ["seed", response_name]

  rows = Hash[answers.each_with_index.map do |answer, i|
    row_vals = var_names.each_with_index.map { |_, j| var_values[j][i] }
    row_vals << answer  # seed
    row_vals << answer  # response value
    [make_identifier(), { values: row_vals, index: i }]
  end]

  { cols: columns, rows: rows }
end

#extract_formula ⇒ Object 



151
152
153
 
# File 'lib/canvas_qti_to_learnosity_converter/questions/calculated.rb', line 151

def extract_formula()
  @xml.css("item > itemproc_extension > calculated > formulas > formula").first&.text || ""
end

#extract_template_values(template) ⇒ Object

New Quizzes exports variables with backtick notation (e.g. ‘w`), while Classic Quizzes uses square bracket notation (e.g. [w]). Detect which format is in use and return plain variable names either way.



28
29
30
31
 
# File 'lib/canvas_qti_to_learnosity_converter/questions/calculated.rb', line 28

def extract_template_values(template)
  backtick_vars = template.scan(/`([^`]+)`/).map(&:first)
  backtick_vars.any? ? backtick_vars : super
end

#extract_validation ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/canvas_qti_to_learnosity_converter/questions/calculated.rb', line 33

def extract_validation()
  decimal_places = @xml.css("item > itemproc_extension > calculated > formulas")
    .first["decimal_places"].to_i

  if scientific_notation_enabled?
    {
      "scoring_type" => "exactMatch",
      "valid_response" => {
        "score" => extract_points_possible,
        "value" => [[
          {
            "method" => "equivValue",
            "value" => "{{var:scientific}}",
            "options" => {
              "allowThousandsSeparator" => false,
              "setThousandsSeparator" => [","],
              "setDecimalSeparator" => ["."],
            }
          },
          {
            "method" => "equivSyntax",
            "value" => "\\format{\\scientific}",
            "options" => {
              "allowThousandsSeparator" => false,
              "setThousandsSeparator" => [","],
              "setDecimalSeparator" => ["."],
            }
          }
        ]]
      }
    }
  else
    {
      "scoring_type" => "exactMatch",
      "valid_response" => {
        "score" => extract_points_possible,
        "value" => [[{
          "method" => "equivValue",
          "value" => "{{var:decimal}}",
          "options" => { "decimalPlaces" => decimal_places }
        }]]
      }
    }
  end
end

#extract_var_names ⇒ Object 



139
140
141
 
# File 'lib/canvas_qti_to_learnosity_converter/questions/calculated.rb', line 139

def extract_var_names()
  @xml.css("item > itemproc_extension > calculated > vars > var").map { |v| v["name"] }
end

#extract_var_ranges ⇒ Object 



143
144
145
146
147
148
149
 
# File 'lib/canvas_qti_to_learnosity_converter/questions/calculated.rb', line 143

def extract_var_ranges()
  @xml.css("item > itemproc_extension > calculated > vars > var").each_with_object({}) do |v, hash|
    scale = v["scale"].to_i
    step = scale == 0 ? 1 : (10.0 ** -scale).round(scale)
    hash[v["name"]] = { min: v.css("min").first.text, max: v.css("max").first.text, step: step }
  end
end

#format_scientific_latex(value_str) ⇒ Object 



267
268
269
270
271
272
273
 
# File 'lib/canvas_qti_to_learnosity_converter/questions/calculated.rb', line 267

def format_scientific_latex(value_str)
  value = value_str.to_f
  return "\\(0\\)" if value == 0
  exp = Math.log10(value.abs).floor.to_i
  coefficient = value / 10.0 ** exp
  "\\(#{coefficient}\\times {10^{#{exp}}}\\)"
end

#item_metadata ⇒ Object 



79
80
81
82
83
 
# File 'lib/canvas_qti_to_learnosity_converter/questions/calculated.rb', line 79

def item_metadata()
  {
    dynamic_content: build_dynamic_content(),
  }
end

#scientific_notation_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


262
263
264
265
 
# File 'lib/canvas_qti_to_learnosity_converter/questions/calculated.rb', line 262

def scientific_notation_enabled?
  @xml.css("item > itemproc_extension > calculated > formulas")
    .first&.[]("scientific_notation") == "true"
end

#to_learnosity ⇒ Object 



5
6
7
8
9
10
11
12
13
 
# File 'lib/canvas_qti_to_learnosity_converter/questions/calculated.rb', line 5

def to_learnosity
  {
    type: "clozeformulaV2",
    is_math: true,
    is_dynamic_content: true,
    template: build_template_field(),
    validation: extract_validation(),
  }
end

#widget_metadata ⇒ Object 



275
276
277
278
279
280
 
# File 'lib/canvas_qti_to_learnosity_converter/questions/calculated.rb', line 275

def widget_metadata()
  {
    name: "Math Question Generator",
    template_reference: "17149c09-83ba-4b1b-afff-a681e7edd8ff" # This is Learnosity's internal reference for the MQG widget;
  }
end