quiz/ccm.quiz.mjs at main · ccmjs/quiz · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
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
78
79
80
81
82
83
84
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
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
export const component = {
  name: "quiz",
  ccm: "././libs/ccmjs/ccm.js",
  config: {
    // TODO: user
    // TODO: lang
    // TODO: routing
    // TODO: sounds

    // UI utilities (templating + event binding)
    ui: ["ccm.load", "././libs/ccm-ui/ccm-ui.mjs"],

    // Component views (HTML templates)
    views: ["ccm.load", "././resources/views.mjs"],

    // Component styles (CSS)
    css: ["ccm.load", "././resources/styles.css"],

    /**
     * Quiz questions.
     *
     * Structure:
     * ```
     * [
     *   {
     *     text: "Question text",
     *     description: "Optional description",
     *     type: "radio" | "checkbox",
     *     answers: [
     *       {
     *         text: "Answer text",
     *         correct: true,
     *         comment: "Optional explanation"
     *       }
     *     ]
     *   }
     * ]
     * ```
     */
    questions: [{ text: "", answers: [] }],

    // Whether immediate feedback should be shown
    feedback: true,

    // Static UI labels
    labels: {
      submit: "Submit",
      next: "Next",
      finish: "Finish",
    },

    // Extension points
    extensions: [
      // ["ccm.load", "././resources/extensions.mjs#escapeHTML"],
      // ["ccm.load", "././resources/extensions.mjs#restore"],
      // ["ccm.load", "././resources/extensions.mjs#shuffleQuestions"],
      // ["ccm.load", "././resources/extensions.mjs#randomAnswers"],
      // ["ccm.load", "././resources/extensions.mjs#summary"],
      // ["ccm.load", "././resources/extensions.mjs#progressBar"],
      // ["ccm.load", "././resources/extensions.mjs#paging"],
      // ["ccm.load", "././resources/extensions.mjs#startButton"],
      // ["ccm.load", "././resources/extensions.mjs#noFinishButton"],
      // ["ccm.load", "././resources/extensions.mjs#skippable"],
      // ["ccm.load", "././resources/extensions.mjs#anytimeFinish"],
      // ["ccm.load", "././resources/extensions.mjs#prevButton"],
      // ["ccm.load", "././resources/extensions.mjs#triState"],
      // ["ccm.load", "././resources/extensions.mjs#decisionScore"],
      // ["ccm.load", "././resources/extensions.mjs#store"],
      ["ccm.load", "././resources/extensions.mjs#analytics"],
      ["ccm.load", "././resources/extensions.mjs#restart"],
    ],
  },
  Instance: function () {
    /** Lifecycle hook */
    this.init = async () => {
      await this.emit("init");
    };

    /** Lifecycle hook */
    this.ready = async () => {
      await this.emit("ready");
    };

    /** Starts or restarts the quiz */
    this.start = async () => {
      await this.emit("before-start");
      if (!this.state)
        this.state = { questions: structuredClone(this.questions) };
      this.current = 0;
      await this.renderQuestion();
      await this.emit("start");
    };

    /**
     * DOM event handlers.
     *
     * Bound automatically via `ccm-ui` and `data-on-*` attributes.
     */
    this.events = {
      /** Evaluates the current question and shows feedback. */
      submit: async () => {
        if (!this.feedback) return;
        await this.evaluate();
        await this.renderQuestion();
        await this.emit("submit");
      },

      /** Advances to the next question. */
      next: async () => {
        if (this.current >= this.state.questions.length - 1) return;
        if (!this.feedback) await this.evaluate();
        this.current++;
        await this.renderQuestion(false);
        await this.emit("next");
      },

      /** Finishes the quiz. */
      finish: async () => {
        if (!this.feedback) await this.evaluate();
        await this.emit("finish");
      },
    };

    /**
     * Renders the current question.
     */
    this.renderQuestion = async () => {
      this.ui.render(this.views.question(this), this.element, this);
      await this.emit("render");
    };

    /** Evaluates the current question and stores user input and solution data in the result state. */
    this.evaluate = async () => {
      const question = this.state.questions[this.current];
      const inputs = this.element.querySelectorAll(".input");
      inputs.forEach(
        (input, i) => input.checked && (question.answers[i].selected = true),
      );
      question.evaluated = true;
      await this.emit("evaluate");
    };

    /**
     * Emits an extension event.
     *
     * Extensions can react to the following events:
     *
     * - init
     * - ready
     * - before-start
     * - start
     * - render
     * - submit
     * - evaluate
     * - next
     * - finish
     *
     * Each configured extension receives an object:
     *
     * {
     *   app,      // component instance
     *   type      // emitted event type
     * }
     *
     * Extensions are executed sequentially.
     *
     * @param {string} type - emitted event type
     */
    this.emit = async (type) => {
      const extensions = [].concat(this.extensions || []);

      for (const extension of extensions)
        extension && (await extension({ app: this, type }));
    };
  },
};