SWAMPy

✎ CARVE FLESH

EDITING: base.rb

# frozen_string_literal: true

#
# Copyright (C) 2012 - present Instructure, Inc.
#
# This file is part of Canvas.
#
# Canvas is free software: you can redistribute it and/or modify it under
# the terms of the GNU Affero General Public License as published by the Free
# Software Foundation, version 3 of the License.
#
# Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
# details.
#
# You should have received a copy of the GNU Affero General Public License along
# with this program. If not, see <http://www.gnu.org/licenses/>.
#

class Quizzes::QuizQuestion::Base
  # typically you'll call this factory method rather than instantiating a subclass directly
  def self.from_question_data(data)
    type_name = data[:question_type]
    klass = question_types[type_name]
    klass ||= Quizzes::QuizQuestion::UnknownQuestion
    klass.new(data)
  end

@@question_types = {}
  mattr_reader :question_types

def self.inherited(klass)
    type_name = klass.question_type
    raise("question type #{type_name} already exists") if question_types.key?(type_name)

super

# because this is where subclass registration happens, we need this to be populated
    # before we start trying to load any question data.
    # This is taken care of by the Quizzes::Preloader
    question_types[type_name] = klass
  end

# override to change the name of the question type, defaults to the underscore-ized class name
  def self.question_type
    name.demodulize.underscore
  end

def initialize(question_data)
    # currently all the attributes are synthesized from @question_data
    # since questions are stored in this format anyway, it prevents us from
    # having to do a bunch of translation to some other format
    @question_data = if question_data.is_a? Quizzes::QuizQuestion::QuestionData
                       question_data
                     else
                       Quizzes::QuizQuestion::QuestionData.new(question_data)
                     end
  end

def question_id
    @question_data[:id]
  end

def points_possible
    @question_data[:points_possible].to_f
  end

def incorrect_dock
    @question_data[:incorrect_dock].try(:to_f)
  end

def sorted_by_weight
    @question_data[:answers].sort_by { |a| a[:weight] || 0 }
  end

#
  # Scoring Methods to override in the subclass
  #

# the total number of parts to a question
  # many questions have just one part (fill in the blank, etc)
  # some questions have many parts and the score is (correct / total) * points_possible
  # text-only questions have no parts
  def total_answer_parts
    1
  end

# where the scoring of the question happens
  #
  # a UserAnswer is passed in, and the # of parts correct in the answer is returned
  #
  # for questions types with just one answer part, return 1 for correct and 0 for incorrect
  # for questions types with multiple answer parts, return the total # of parts that are correct
  #
  # you can also return true for full credit, or false for no credit
  #
  # if no answer is given at all, return nil
  #
  # (note this means nil != false in this return value)
  def correct_answer_parts(user_answer); end

# Return the number of explicitly incorrect answer parts
  #
  # This will never be called before correct_answer_parts is called, so it can
  # be calculated there if that's easier.
  #
  # If this is > 0, the user will be docked for each answer part that they got
  # incorrect. Most question types leave this at 0, so the user isn't punished
  # extra for wrong answers.
  def incorrect_answer_parts(_user_answer)
    0
  end

# override and return true if the answer can't be auto-scored
  def requires_manual_scoring?(_user_answer)
    false
  end

def score_question(answer_data, user_answer = nil)
    user_answer ||= Quizzes::QuizQuestion::UserAnswer.new(question_id, points_possible, answer_data)
    user_answer.total_parts = total_answer_parts
    correct_parts = correct_answer_parts(user_answer)
    if !correct_parts.nil?
      correct_parts = 0 if correct_parts == false
      correct_parts = user_answer.total_parts if correct_parts == true

user_answer.incorrect_parts = incorrect_answer_parts(user_answer)
      correct_parts = 0 if ((correct_parts - user_answer.incorrect_parts) < user_answer.total_parts) && !@question_data.allows_partial_credit?

user_answer.correct_parts = correct_parts
      user_answer.incorrect_dock = incorrect_dock if user_answer.incorrect_parts > 0
    elsif user_answer.undefined_if_blank? || requires_manual_scoring?(user_answer)
      user_answer.undefined = true
    end

user_answer
  end

# TODO: remove once new stats is on for everybody
  def stats(responses)
    answers = @question_data.answers

responses.each do |response|
      found = nil
      if response[:text].try(:strip).present?
        answer_md5 = Digest::MD5.hexdigest(response[:text].strip)
      end

answers.each do |answer|
        next unless answer[:id] == response[:answer_id] || answer[:id] == answer_md5

found = true
        answer[:responses] += 1
        answer[:user_ids] << response[:user_id]
      end

next unless !found && answer_md5 && (@question_data.is_type?(:numerical) || @question_data.is_type?(:short_answer))

answers << {
        id: answer_md5,
        responses: 1,
        user_ids: [response[:user_id]],
        text: response[:text]
      }
    end
    @question_data.answers = answers
    @question_data.to_hash
  end
end

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 answer_parsers/	DIR	—	2023-09-24 03:36
📁 answer_serializers/	DIR	—	2023-09-24 03:36
📄 answer_group.rb	RB	2.7 KB	2023-09-24 03:36	EDIT
📄 answer_serializers.rb	RB	1.8 KB	2023-09-24 03:36	EDIT
📄 base.rb	RB	5.5 KB	2023-09-24 03:36	EDIT
📄 calculated_question.rb	RB	2.3 KB	2023-09-24 03:36	EDIT
📄 essay_question.rb	RB	1.3 KB	2023-09-24 03:36	EDIT
📄 file_upload_answer.rb	RB	1.1 KB	2023-09-24 03:36	EDIT
📄 file_upload_question.rb	RB	1.5 KB	2023-09-24 03:36	EDIT
📄 fill_in_multiple_blanks_question.rb	RB	4.2 KB	2023-09-24 03:36	EDIT
📄 match_group.rb	RB	1.7 KB	2023-09-24 03:36	EDIT
📄 matching_question.rb	RB	2.7 KB	2023-09-24 03:36	EDIT
📄 multiple_answers_question.rb	RB	2.2 KB	2023-09-24 03:36	EDIT
📄 multiple_choice_question.rb	RB	1.3 KB	2023-09-24 03:36	EDIT
📄 multiple_dropdowns_question.rb	RB	1.6 KB	2023-09-24 03:36	EDIT
📄 numerical_question.rb	RB	3.9 KB	2023-09-24 03:36	EDIT
📄 question_data.rb	RB	5.2 KB	2023-09-24 03:36	EDIT
📄 raw_fields.rb	RB	1.6 KB	2023-09-24 03:36	EDIT
📄 short_answer_question.rb	RB	1.6 KB	2023-09-24 03:36	EDIT
📄 text_only_question.rb	RB	830 B	2023-09-24 03:36	EDIT
📄 unknown_question.rb	RB	792 B	2023-09-24 03:36	EDIT
📄 user_answer.rb	RB	2.6 KB	2023-09-24 03:36	EDIT