SWAMPy

✎ CARVE FLESH

EDITING: README.md

# CanvasQuizStatistics

A bunch of objects that can generate statistics from a set of responses to a quiz.

_Work In Progress._

## Extending

### Adding support for a new question type

**Implementing the analyzer**

- define an answer analyzer in `answer_analyzers/question_type.rb`
  - make sure your analyzer implements the common interface, which is defined
    by the `AnswerAnalyzer::Base` class
  - please document both output *and* input formats that you expect to generate the stats

**Registering it**

Edit `lib/canvas_quiz_statistics/answer_analyzers.rb` and:

+ require your analyzer
  + add it to the list of available analyzers in
    `CanvasQuizStatistics::AnswerAnalyzers::AVAILABLE_ANALYZERS`
    where the key should be the question type (with the `_question` suffix)
    and the value would be your analyzer

**Covering it**

You will probably need to simulate question data to cover your analyzer. Grab a JSON snapshot of the `question_data` construct for your question and save it in `spec/support/fixtures/` and check out the fixture helpers in `spec/support/question_helpers.rb` for more information on how to use the fixture.

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 lib/	DIR	—	2023-09-24 03:36
📁 spec/	DIR	—	2023-09-24 03:39
📄 .rspec	RSPEC	118 B	2023-09-24 03:36	EDIT
📄 canvas_quiz_statistics.gemspec	GEMSPEC	819 B	2023-09-24 03:39	EDIT
📄 CHANGELOG.md	MD	367 B	2023-09-24 03:36	EDIT
📄 Gemfile	?	179 B	2023-09-24 03:36	EDIT
📄 Gemfile.lock	LOCK	2 KB	2023-09-24 03:49	EDIT
📄 Guardfile	?	244 B	2023-09-24 03:36	EDIT
📄 LICENSE.txt	TXT	650 B	2023-09-24 03:36	EDIT
📄 Rakefile	?	59 B	2023-09-24 03:36	EDIT
📄 README.md	MD	1.1 KB	2023-09-24 03:36	EDIT
📄 test.sh	SH	74 B	2023-09-24 03:36	EDIT
📄 TODO.md	MD	506 B	2023-09-24 03:36	EDIT