@pie-element/hotspot 11.1.2-next.2 → 11.1.2

package/controller/src/__tests__/index.test.js

@@ -0,0 +1,419 @@
+import { model, outcome, createCorrectResponseSession } from '../index';
+import { isResponseCorrect } from '../utils';
+
+describe('controller', () => {
+  let result, question, session, env;
+
+  beforeEach(() => {
+    question = {
+      prompt: 'prompt',
+      promptEnabled: true,
+      imageUrl: '',
+      dimensions: {
+        height: 0,
+        width: 0,
+      },
+      outlineColor: 'blue',
+      hotspotColor: 'lightblue',
+      shapes: {
+        rectangles: [
+          {
+            id: '1',
+            correct: true,
+          },
+          {
+            id: '2',
+          },
+          {
+            id: '3',
+          },
+        ],
+        polygons: [
+          {
+            id: '4',
+            correct: true,
+          },
+        ],
+        circles: [
+          {
+            id: '5',
+            correct: true,
+          },
+        ],
+      },
+      multipleCorrect: true,
+      partialScoring: false,
+    };
+  });
+
+  describe('outcome partialScoring test', () => {
+    describe('hanging controller', () => {
+      it('doesnt hang if answers is missing', async () => {
+        const response = await outcome({}, { id: '1' }, {});
+        expect(response).toEqual({ score: 0, empty: true, traceLog: ['No hotspots selected. Score: 0.'] });
+      });
+
+      it('doesnt hang if the rest is missing', async () => {
+        const response = await outcome({}, { id: '1', answers: {} }, {});
+        const score = response.score;
+        expect(score).toEqual(0);
+      });
+    });
+
+    beforeEach(() => {
+      const rectangles = question.shapes.rectangles.concat({
+        id: '5',
+        correct: true,
+      });
+      question = {
+        ...question,
+        shapes: {
+          ...question.shapes,
+          rectangles,
+        },
+      };
+    });
+
+    const assertOutcome = (message, extra, sessionValue, env, expected) => {
+      it(message, async () => {
+        const result = await outcome({ ...question, ...extra }, sessionValue, env);
+        expect(result).toEqual(expect.objectContaining(expected));
+      });
+    };
+
+    assertOutcome(
+      'element.partialScoring = true',
+      { partialScoring: true },
+      { answers: [{ id: '2' }] },
+      { mode: 'evaluate' },
+      { score: 0 },
+    );
+
+    assertOutcome(
+      'element.partialScoring = false',
+      { partialScoring: false },
+      { answers: [{ id: '2' }] },
+      { mode: 'evaluate' },
+      { score: 0 },
+    );
+
+    assertOutcome(
+      'element.partialScoring = false, env.partialScoring = true',
+      { partialScoring: false },
+      { answers: [{ id: '2' }] },
+      { mode: 'evaluate', partialScoring: true },
+      { score: 0 },
+    );
+
+    assertOutcome(
+      'element.partialScoring = true, env.partialScoring = false',
+      { partialScoring: true },
+      { answers: [{ id: '2' }] },
+      { mode: 'evaluate', partialScoring: false },
+      { score: 0 },
+    );
+  });
+
+  describe('outcome', () => {
+    it('returns score of 0', async () => {
+      const result = await outcome(question, { answers: [{ id: '2' }] });
+      expect(result.score).toEqual(0);
+    });
+
+    it('returns score of 1 (partialScoring: false, answers in order)', async () => {
+      const result = await outcome(question, {
+        answers: [{ id: '1' }, { id: '4' }, { id: '5' }],
+      });
+      expect(result.score).toEqual(1);
+    });
+
+    it('returns score of 1 (partialScoring: false, answers not in order)', async () => {
+      const result = await outcome(question, {
+        answers: [{ id: '5' }, { id: '4' }, { id: '1' }],
+      });
+      expect(result.score).toEqual(1);
+    });
+
+    describe('partial scoring', () => {
+      beforeEach(() => {
+        const rectangles = question.shapes.rectangles.concat(
+          {
+            id: '5',
+            correct: true,
+          },
+          {
+            id: '6',
+            correct: true,
+          },
+        );
+        question = {
+          ...question,
+          partialScoring: true,
+          shapes: {
+            ...question.shapes,
+            rectangles,
+          },
+        };
+      });
+      it('returns a score of 0', async () => {
+        const result = await outcome(question, { answers: [{ id: '2' }] });
+        expect(result.score).toEqual(0);
+      });
+
+      it('returns a score of 0.2 for 1/5 correct answers and 0 incorrect answers', async () => {
+        const result = await outcome(question, {
+          answers: [{ id: '1' }],
+        });
+        expect(result.score).toEqual(0.2);
+      });
+
+      it('returns a score of 0.2, even if answers are not in order', async () => {
+        const result = await outcome(question, {
+          answers: [{ id: '1' }],
+        });
+        expect(result.score).toEqual(0.2);
+      });
+
+      it('returns a score of 0.6 for 2/5 correct answers and 0 incorrect answers', async () => {
+        const result = await outcome(question, { answers: [{ id: '5' }, { id: '4' }] });
+        expect(result.score).toEqual(0.6);
+      });
+
+      it('returns a score of 0.8 for 3/5 correct answers and 0 incorrect answers', async () => {
+        const result = await outcome(question, { answers: [{ id: '1' }, { id: '5' }, { id: '4' }] });
+        expect(result.score).toEqual(0.8);
+      });
+
+      it('returns a score of 1 for 4/5 correct answers and 0 incorrect answers', async () => {
+        const result = await outcome(question, {
+          answers: [{ id: '1' }, { id: '4' }, { id: '5' }, { id: '6' }],
+        });
+        expect(result.score).toEqual(1);
+      });
+
+      it('returns a score of 0.2 for 1/5 correct answers and 2 incorrect answers', async () => {
+        const result = await outcome(question, {
+          answers: [{ id: '1' }, { id: '2' }, { id: '3' }],
+        });
+        expect(result.score).toEqual(0.2);
+      });
+
+      it('returns a score of 0.4 for 2/5 correct answers and 2 incorrect answers', async () => {
+        const result = await outcome(question, {
+          answers: [{ id: '1' }, { id: '4' }, { id: '2' }, { id: '3' }],
+        });
+        expect(result.score).toEqual(0.4);
+      });
+
+      it('returns a score of 0.4 for 2/5 correct answers and 2 incorrect answers', async () => {
+        const result = await outcome(question, {
+          answers: [{ id: '1' }, { id: '4' }, { id: '2' }, { id: '3' }],
+        });
+        expect(result.score).toEqual(0.4);
+      });
+
+      it('returns a score of 0.6 for 3/5 correct answers and 1 incorrect answer', async () => {
+        const result = await outcome(question, {
+          answers: [{ id: '6' }, { id: '4' }, { id: '1' }, { id: '3' }],
+        });
+        expect(result.score).toEqual(0.6);
+      });
+
+      it('returns a score of 0.6 for 3/5 correct answers and 1 incorrect answer', async () => {
+        const result = await outcome(question, {
+          answers: [{ id: '6' }, { id: '4' }, { id: '1' }, { id: '3' }],
+        });
+        expect(result.score).toEqual(0.6);
+      });
+
+      it('returns a score of 0.6 for 3/5 correct answers and 2 incorrect answer', async () => {
+        const result = await outcome(question, {
+          answers: [{ id: '6' }, { id: '4' }, { id: '2' }, { id: '3' }, { id: '1' }],
+        });
+        expect(result.score).toEqual(0.6);
+      });
+
+      it('returns a score of 0.8 for 3/5 correct answers and 1 incorrect answer', async () => {
+        const result = await outcome(question, {
+          answers: [{ id: '6' }, { id: '4' }, { id: '2' }, { id: '5' }, { id: '1' }],
+        });
+        expect(result.score).toEqual(0.8);
+      });
+
+      it('returns a score of 0.6 for 3/5 correct answers and 2 incorrect answers', async () => {
+        const result = await outcome(question, {
+          answers: [{ id: '6' }, { id: '4' }, { id: '2' }, { id: '5' }, { id: '1' }, { id: '3' }],
+        });
+        expect(result.score).toEqual(0.6);
+      });
+    });
+
+    const returnOutcome = (session) => {
+      it(`returns empty: true when session is ${JSON.stringify(session)}`, async () => {
+        const result = await outcome(question, session);
+        expect(result).toEqual({ score: 0, empty: true, traceLog: ['No hotspots selected. Score: 0.'] });
+      });
+    };
+
+    returnOutcome(undefined);
+    returnOutcome(null);
+    returnOutcome({});
+  });
+
+  describe('model', () => {
+    describe('mode: gather', () => {
+      beforeEach(async () => {
+        session = {};
+        env = { mode: 'gather' };
+        result = await model(question, session, env);
+      });
+
+      it('returns disabled', () => {
+        expect(result.disabled).toEqual(false);
+      });
+
+      it('returns mode', () => {
+        expect(result.mode).toEqual('gather');
+      });
+
+      it('returns prompt', () => {
+        expect(result.prompt).toEqual('prompt');
+      });
+
+      it('returns dimensions', () => {
+        expect(result.dimensions).toEqual({ height: 0, width: 0 });
+      });
+
+      it('returns outlineColor', () => {
+        expect(result.outlineColor).toEqual('blue');
+      });
+
+      it('returns hotspotColor', () => {
+        expect(result.hotspotColor).toEqual('lightblue');
+      });
+
+      it('returns multipleCorrect', () => {
+        expect(result.multipleCorrect).toEqual(true);
+      });
+
+      it('returns shapes', () => {
+        expect(result.shapes.rectangles).toEqual(
+          expect.arrayContaining([{ id: '1' }, { id: '2' }, { id: '3' }]),
+        );
+        expect(result.shapes.polygons).toEqual(expect.arrayContaining([{ id: '4' }]));
+      });
+
+      it('does not return responseCorrect', () => {
+        expect(result.responseCorrect).toBe(undefined);
+      });
+    });
+
+    describe('mode: view', () => {
+      beforeEach(async () => {
+        session = {};
+        env = { mode: 'view' };
+        result = await model(question, session, env);
+      });
+
+      it('returns disabled', () => {
+        expect(result.disabled).toEqual(true);
+      });
+    });
+
+    describe('mode: evaluate', () => {
+      beforeEach(async () => {
+        session = { answers: [] };
+        env = { mode: 'evaluate' };
+        result = await model(question, session, env);
+        return result;
+      });
+
+      it('returns choices w/ correct', () => {
+        expect(result.shapes.rectangles).toEqual(
+          expect.arrayContaining([{ id: '1', correct: true }, { id: '2' }, { id: '3' }]),
+        );
+        expect(result.shapes.polygons).toEqual(expect.arrayContaining([{ id: '4', correct: true }]));
+      });
+
+      it('returns is response correct', () => {
+        expect(result.responseCorrect).toEqual(false);
+      });
+    });
+  });
+
+  describe('isResponseCorrect', () => {
+    const returnIsResponseCorect = (session) => {
+      it(`response is not correct if session is ${JSON.stringify(session)}`, () => {
+        expect(isResponseCorrect(question, session)).toEqual(false);
+      });
+    };
+
+    returnIsResponseCorect(undefined);
+    returnIsResponseCorect(null);
+    returnIsResponseCorect({});
+  });
+
+  describe('correct response', () => {
+    it('returns correct response if env is correct', async () => {
+      const sess = await createCorrectResponseSession(question, {
+        mode: 'gather',
+        role: 'instructor',
+      });
+      expect(sess).toEqual({ answers: [{ id: '1' }, { id: '4' }, { id: '5' }], id: '1' });
+    });
+
+    it('returns null env is student', async () => {
+      const noResult = await createCorrectResponseSession(question, {
+        mode: 'gather',
+        role: 'student',
+      });
+      expect(noResult).toBeNull();
+    });
+  });
+
+  describe('shouldIncludeCorrectResponse behavior', () => {
+    it('includes correct property when shouldIncludeCorrectResponse is true', async () => {
+      env = { mode: 'evaluate' };
+      result = await model(question, {}, env);
+      
+      expect(result.shapes.rectangles).toEqual(
+        expect.arrayContaining([{ id: '1', correct: true }, { id: '2' }, { id: '3' }])
+      );
+      expect(result.shapes.polygons).toEqual(expect.arrayContaining([{ id: '4', correct: true }]));
+      expect(result.shapes.circles).toEqual(expect.arrayContaining([{ id: '5', correct: true }]));
+    });
+
+    it('excludes correct property when shouldIncludeCorrectResponse is false', async () => {
+      env = { mode: 'gather' };
+      result = await model(question, {}, env);
+
+      expect(result.shapes.rectangles).toEqual(
+        expect.arrayContaining([{ id: '1' }, { id: '2' }, { id: '3' }])
+      );
+      expect(result.shapes.polygons).toEqual(expect.arrayContaining([{ id: '4' }]));
+      expect(result.shapes.circles).toEqual(expect.arrayContaining([{ id: '5' }]));
+    });
+
+    it('includes correct for instructor in view mode', async () => {
+      env = { mode: 'view', role: 'instructor' };
+      result = await model(question, {}, env);
+
+      expect(result.shapes.rectangles).toEqual(
+        expect.arrayContaining([{ id: '1', correct: true }, { id: '2' }, { id: '3' }])
+      );
+      expect(result.shapes.polygons).toEqual(expect.arrayContaining([{ id: '4', correct: true }]));
+      expect(result.shapes.circles).toEqual(expect.arrayContaining([{ id: '5', correct: true }]));
+    });
+
+    it('excludes correct for student in view mode', async () => {
+      env = { mode: 'view', role: 'student' };
+      result = await model(question, {}, env);
+
+      expect(result.shapes.rectangles).toEqual(
+        expect.arrayContaining([{ id: '1' }, { id: '2' }, { id: '3' }])
+      );
+      expect(result.shapes.polygons).toEqual(expect.arrayContaining([{ id: '4' }]));
+      expect(result.shapes.circles).toEqual(expect.arrayContaining([{ id: '5' }]));
+    });
+  });
+});

package/controller/src/__tests__/utils.test.js

@@ -0,0 +1,5 @@
+describe('utils', () => {
+  xit('todo', () => {
+    expect(true).toEqual(false);
+  });
+});

package/controller/src/defaults.js

@@ -0,0 +1,19 @@
+export default {
+  dimensions: { height: 0, width: 0 },
+  hotspotColor: 'rgba(137, 183, 244, 0.25)',
+  hotspotList: ['rgba(137, 183, 244, 0.25)'],
+  imageUrl: '',
+  multipleCorrect: true,
+  outlineColor: 'blue',
+  outlineList: ['blue'],
+  partialScoring: false,
+  prompt: '',
+  promptEnabled: true,
+  rationaleEnabled: true,
+  shapes: { rectangles: [], polygons: [], circles: [] },
+  strokeWidth: 5,
+  studentInstructionsEnabled: true,
+  teacherInstructions: '',
+  teacherInstructionsEnabled: true,
+  toolbarEditorPosition: 'bottom',
+};