@pie-element/hotspot 4.8.4-next.1097 → 4.8.4-next.1115

package/src/__tests__/rectangle.test.jsx

@@ -0,0 +1,233 @@
+import React from 'react';
+import _ from 'lodash';
+import { shallow } from 'enzyme';
+import toJson from 'enzyme-to-json';
+import Konva from 'konva';
+import { Rect } from 'react-konva';
+
+import { shallowChild } from '@pie-lib/test-utils';
+
+import Rectangle from '../hotspot/rectangle';
+import Image from '../hotspot/image';
+import { faCorrect, faWrong } from '../hotspot/icons';
+
+global.MutationObserver = class {
+  constructor(callback) {}
+  disconnect() {}
+  observe(element, initObject) {}
+};
+
+Konva.isBrowser = false;
+
+describe('Rectangle', () => {
+  let onClick, wrapper;
+
+  const mkWrapper = (opts = {}) => {
+    opts = _.extend(
+      {
+        classes: {
+          base: 'base'
+        },
+        height: 200,
+        hotspotColor: 'rgba(137, 183, 244, 0.65)',
+        id: '1',
+        isCorrect: false,
+        isEvaluateMode: false,
+        evaluateText: null,
+        disabled: false,
+        outlineColor: 'blue',
+        selected: false,
+        width: 300,
+        x: 5,
+        y: 5
+      },
+      opts
+    );
+
+    return shallow(<Rectangle {...opts} onClick={onClick} />);
+  };
+
+  beforeEach(() => {
+    onClick = jest.fn();
+    wrapper = mkWrapper();
+  });
+
+  describe('snapshots', () => {
+    describe('outline color', () => {
+      it('renders', () => {
+        const wrapper = mkWrapper({ outlineColor: 'red' });
+        expect(toJson(wrapper)).toMatchSnapshot();
+      });
+    });
+
+    describe('outline width', () => {
+      it('renders with default border width', () => {
+        const wrapper = mkWrapper();
+        expect(toJson(wrapper)).toMatchSnapshot();
+      });
+
+      it('renders with given border width', () => {
+        const wrapper = mkWrapper({ strokeWidth: 10 });
+        expect(toJson(wrapper)).toMatchSnapshot();
+      });
+    });
+
+    describe('hotspot color', () => {
+      it('renders', () => {
+        const wrapper = mkWrapper({ hotspotColor: 'rgba(217, 30, 24, 0.65)' });
+        expect(toJson(wrapper)).toMatchSnapshot();
+      });
+    });
+
+    describe('evaluate with correct answer', () => {
+      it('renders', () => {
+        const wrapper = mkWrapper({ isEvaluateMode: true, isCorrect: true, evaluateText: 'Correctly\nselected' });
+        expect(toJson(wrapper)).toMatchSnapshot();
+      });
+    });
+  });
+
+  describe('in evaluate mode', () => {
+    const defaultModel = {
+      onClick,
+      id: '1',
+      height: 200,
+      hotspotColor: 'rgba(137, 183, 244, 0.65)',
+      disabled: true,
+      width: 300,
+      x: 5,
+      y: 5,
+      selected: false,
+      isCorrect: false,
+      isEvaluateMode: true,
+      evaluateText: null,
+      strokeWidth: 5,
+      outlineColor: 'blue',
+      markAsCorrect: false,
+      showCorrectEnabled: false
+    };
+
+    const getComponents = (model) => {
+      const testWrapper = shallowChild(Rectangle, {
+        ...defaultModel,
+        ...model
+      }, 1);
+      const rectangleComponent = testWrapper();
+      const rectComponent = rectangleComponent.find(Rect);
+      return {
+        rectangleComponent,
+        rectComponent
+      };
+    }
+
+    describe('when correctly selected', () => {
+      const { rectangleComponent, rectComponent } = getComponents({
+        selected: true,
+        isCorrect: true
+      });
+
+      it('should have a blue outline', () => {
+        expect(rectComponent.prop('stroke')).toEqual('blue');
+        expect(rectComponent.prop('strokeWidth')).toEqual(defaultModel.strokeWidth);
+      });
+
+      it('should have a green checkmark icon', () => {
+        const imgComponent = rectangleComponent.find(Image);
+        expect(imgComponent.length).toEqual(1);
+        expect(imgComponent.prop('src')).toEqual(faCorrect);
+      });
+    });
+
+    describe('when correctly not selected', () => {
+      const { rectangleComponent, rectComponent } = getComponents({
+        selected: false,
+        isCorrect: true
+      });
+
+      it('should have no outline', () => {
+        expect(rectComponent.prop('strokeWidth')).toEqual(0);
+      });
+
+      it('should have no icon', () => {
+        const imgComponent = rectangleComponent.find(Image);
+        expect(imgComponent.length).toEqual(0);
+      });
+    });
+
+    describe('when incorrectly selected', () => {
+      const { rectangleComponent, rectComponent } = getComponents({
+        selected: true,
+        isCorrect: false
+      });
+
+      it('should have a red outline', () => {
+        expect(rectComponent.prop('stroke')).toEqual('red');
+        expect(rectComponent.prop('strokeWidth')).toEqual(defaultModel.strokeWidth);
+      });
+
+      it('should have a red x icon', () => {
+        const imgComponent = rectangleComponent.find(Image);
+        expect(imgComponent.length).toEqual(1);
+        expect(imgComponent.prop('src')).toEqual(faWrong);
+      });
+    });
+
+    describe('when incorrectly not selected', () => {
+      const { rectangleComponent, rectComponent } = getComponents({
+        selected: false,
+        isCorrect: false
+      });
+
+      it('should have no outline', () => {
+        expect(rectComponent.prop('strokeWidth')).toEqual(0);
+      });
+
+      it('should have a red x icon', () => {
+        const imgComponent = rectangleComponent.find(Image);
+        expect(imgComponent.length).toEqual(1);
+        expect(imgComponent.prop('src')).toEqual(faWrong);
+      });
+    });
+
+    describe('when showing correct answer (showCorrectEnabled = true)', () => {
+      it('should have a green outline', () => {
+        const { rectComponent } = getComponents({
+          showCorrectEnabled: true,
+          markAsCorrect: true
+        });
+        expect(rectComponent.prop('stroke')).toEqual('green');
+        expect(rectComponent.prop('strokeWidth')).toEqual(defaultModel.strokeWidth);
+      });
+
+      it('should have a green checkmark icon', () => {
+        const { rectangleComponent } = getComponents({
+          showCorrectEnabled: true,
+          markAsCorrect: true
+        });
+        const imgComponent = rectangleComponent.find(Image);
+        expect(imgComponent.prop('src')).toEqual(faCorrect);
+      });
+
+      it('should not be selected if the answer is incorrect', () => {
+        const { rectComponent } = getComponents({
+          showCorrectEnabled: true,
+          markAsCorrect: false,
+          selected: true,
+          isCorrect: false
+        });
+        expect(rectComponent.prop('strokeWidth')).toEqual(0);
+      });
+
+      it('should not render an icon if the answer is incorrect', () => {
+        const { rectangleComponent } = getComponents({
+          showCorrectEnabled: true,
+          markAsCorrect: false,
+          selected: true,
+          isCorrect: false
+        });
+        const imgComponent = rectangleComponent.find(Image);
+        expect(imgComponent.length).toEqual(0);
+      });
+    });
+  });
+});

package/src/hotspot/container.jsx

@@ -43,7 +43,8 @@ export class Container extends React.Component {
       onSelectChoice,
       shapes: { rectangles, polygons },
       scale: SCALE,
-      strokeWidth
+      strokeWidth,
+      showCorrect
     } = this.props;
 
     const width = withProp * SCALE;
@@ -78,6 +79,7 @@ export class Container extends React.Component {
               const selected = this.isSelected(shape);
               const isCorrect = isEvaluateMode ? this.correctness(shape.correct, selected) : undefined;
               const evaluateText = isEvaluateMode ? this.getEvaluateText(shape.correct, selected) : null;
+              const markAsCorrect = !!(isEvaluateMode && showCorrect && shape.correct);
 
               return (
                 <Rectangle
@@ -97,6 +99,8 @@ export class Container extends React.Component {
                   x={shape.x}
                   y={shape.y}
                   strokeWidth={strokeWidth}
+                  markAsCorrect={markAsCorrect}
+                  showCorrectEnabled={showCorrect}
                 />
               )
             })}
@@ -104,6 +108,7 @@ export class Container extends React.Component {
               const selected = this.isSelected(polygon);
               const isCorrect = isEvaluateMode ? this.correctness(polygon.correct, selected) : undefined;
               const evaluateText = isEvaluateMode ? this.getEvaluateText(polygon.correct, selected) : null;
+              const markAsCorrect = !!(isEvaluateMode && showCorrect && polygon.correct);
 
               return (
                 <Polygon
@@ -120,6 +125,8 @@ export class Container extends React.Component {
                   outlineColor={outlineColor}
                   points={polygon.points}
                   strokeWidth={strokeWidth}
+                  markAsCorrect={markAsCorrect}
+                  showCorrectEnabled={showCorrect}
                 />
               )
             })}
@@ -173,7 +180,8 @@ Container.propTypes = {
   session:PropTypes.object.isRequired,
   shapes:PropTypes.object.isRequired,
   strokeWidth: PropTypes.number,
-  scale: PropTypes.number
+  scale: PropTypes.number,
+  showCorrect: PropTypes.bool
 };
 
 Container.defaultProps = {

package/src/hotspot/index.jsx

@@ -1,6 +1,7 @@
 import React from 'react';
 import PropTypes from 'prop-types';
 import Typography from '@material-ui/core/Typography';
+import CorrectAnswerToggle from '@pie-lib/correct-answer-toggle';
 import {Collapsible, hasText, PreviewPrompt} from '@pie-lib/render-ui';
 import { withStyles } from '@material-ui/core/styles';
 
@@ -71,16 +72,26 @@ class HotspotComponent extends React.Component {
         dimensions,
         rationale,
         teacherInstructions,
-        strokeWidth
+        strokeWidth,
+        responseCorrect
       },
       onSelectChoice,
       classes
     } = this.props;
-
+    const { showCorrect } = this.state;
     const isEvaluateMode = mode === 'evaluate';
+    const showCorrectAnswerToggle = isEvaluateMode && !responseCorrect;
 
     return (
       <div>
+        {showCorrectAnswerToggle && (
+          <CorrectAnswerToggle
+            show={showCorrectAnswerToggle}
+            toggled={showCorrect}
+            onToggle={this.onToggle.bind(this)}
+          />
+        )}
+        {showCorrectAnswerToggle && <br />}
         {
           teacherInstructions && hasText(teacherInstructions) && (
             <Collapsible
@@ -116,6 +127,7 @@ class HotspotComponent extends React.Component {
             disabled={disabled}
             strokeWidth={strokeWidth}
             scale={this.state.scale}
+            showCorrect={showCorrect}
           />
         ) : null}
 

package/src/hotspot/polygon.jsx

@@ -51,9 +51,9 @@ class PolygonComponent extends React.Component {
     document.body.style.cursor = 'default';
   };
 
-  getEvaluateOutlineColor = (isCorrect, outlineColor) => isCorrect ? outlineColor : 'red';
+  getEvaluateOutlineColor = (isCorrect, markAsCorrect, outlineColor) => markAsCorrect ? 'green' : (isCorrect ? outlineColor : 'red')
 
-  getOutlineWidth = (selected, strokeWidth) => selected ? strokeWidth : 0;
+  getOutlineWidth = (showCorrectEnabled, selected, markAsCorrect, strokeWidth) => markAsCorrect || (!markAsCorrect && !showCorrectEnabled && selected) ? strokeWidth : 0;
 
   render() {
     const {
@@ -66,33 +66,51 @@ class PolygonComponent extends React.Component {
       points,
       evaluateText,
       strokeWidth,
-      scale
+      scale,
+      markAsCorrect,
+      showCorrectEnabled
     } = this.props;
 
     const outlineColorParsed = isEvaluateMode
-      ? this.getEvaluateOutlineColor(isCorrect, outlineColor)
+      ? this.getEvaluateOutlineColor(isCorrect, markAsCorrect, outlineColor)
       : outlineColor;
-    const outlineWidth = this.getOutlineWidth(selected, strokeWidth);
+    const outlineWidth = this.getOutlineWidth(showCorrectEnabled, selected, markAsCorrect, strokeWidth);
 
     const pointsParsed = this.parsePointsForKonva(points);
     const center = this.getPolygonCenter(points);
     const iconX = center[0];
     const iconY = center[1];
 
-    // Correctly selected hotspot: white checkmark in green circle (plus the selected hotspot will have a heavy outline, as on “Gather”)
-    // Correctly not selected hotspot: none
-    // Incorrectly selected hostpot: white “X” in red circle, plus the heavy outline around the selection should appear in red
-    // Incorrectly not selected hotspot: white “X” in red circle
+    // "Show Correct Answer" Enabled:
+    //   - Correctly Selected: white checkmark in green circle
+    //   - Correctly Not Selected: none
+    //   - Incorrectly Selected: none
+    //   - Incorrectly Not Selected: white checkmark in green circle
+    // "Show Correct Answer" Disabled:
+    //   - Correctly Selected:
+    //     - white checkmark in green circle
+    //     - heavy outline, as on “Gather”
+    //   - Correctly Not Selected: none
+    //   - Incorrectly Selected:
+    //     - white "X" in red circle
+    //     - heavy outline around the selection should appear in red
+    //   - Incorrectly Not Selected: white "X" in red circle
     let iconSrc;
 
-    if (selected) {
-      if (isCorrect) {
+    if (showCorrectEnabled) {
+      if ((selected && isCorrect) || (!selected && !isCorrect)) {
         iconSrc = faCorrect;
-      } else {
+      }
+    } else {
+      if (selected) {
+        if (isCorrect) {
+          iconSrc = faCorrect;
+        } else {
+          iconSrc = faWrong;
+        }
+      } else if (!isCorrect) {
         iconSrc = faWrong;
       }
-    } else if (!isCorrect) {
-      iconSrc = faWrong;
     }
 
     return (
@@ -144,7 +162,9 @@ PolygonComponent.propTypes = {
   selected: PropTypes.bool.isRequired,
   evaluateText: PropTypes.string,
   strokeWidth: PropTypes.number,
-  scale: PropTypes.number
+  scale: PropTypes.number,
+  markAsCorrect: PropTypes.bool.isRequired,
+  showCorrectEnabled: PropTypes.bool.isRequired
 };
 
 PolygonComponent.defaultProps = {

package/src/hotspot/rectangle.jsx

@@ -32,9 +32,9 @@ class RectComponent extends React.Component {
     document.body.style.cursor = 'default';
   };
 
-  getEvaluateOutlineColor = (isCorrect, outlineColor) => isCorrect ? outlineColor : 'red';
+  getEvaluateOutlineColor = (isCorrect, markAsCorrect, outlineColor) => markAsCorrect ? 'green' : (isCorrect ? outlineColor : 'red')
 
-  getOutlineWidth = (selected, strokeWidth) => selected ? strokeWidth : 0;
+  getOutlineWidth = (showCorrectEnabled, selected, markAsCorrect, strokeWidth) => markAsCorrect || (!markAsCorrect && !showCorrectEnabled && selected) ? strokeWidth : 0;
 
   render() {
     const {
@@ -50,32 +50,50 @@ class RectComponent extends React.Component {
       y,
       evaluateText,
       strokeWidth,
-      scale
+      scale,
+      markAsCorrect,
+      showCorrectEnabled
     } = this.props;
 
     const outlineColorParsed = isEvaluateMode
-      ? this.getEvaluateOutlineColor(isCorrect, outlineColor)
+      ? this.getEvaluateOutlineColor(isCorrect, markAsCorrect, outlineColor)
       : outlineColor;
 
-    const outlineWidth = this.getOutlineWidth(selected, strokeWidth);
+    const outlineWidth = this.getOutlineWidth(showCorrectEnabled, selected, markAsCorrect, strokeWidth);
 
     const iconX = (x + (width / 2)) - 10;
     const iconY = (y + (height / 2)) - 10;
 
-    // Correctly selected hotspot: white checkmark in green circle (plus the selected hotspot will have a heavy outline, as on “Gather”)
-    // Correctly not selected hotspot: none
-    // Incorrectly selected hostpot: white “X” in red circle, plus the heavy outline around the selection should appear in red
-    // Incorrectly not selected hotspot: white “X” in red circle
+    // "Show Correct Answer" Enabled:
+    //   - Correctly Selected: white checkmark in green circle
+    //   - Correctly Not Selected: none
+    //   - Incorrectly Selected: none
+    //   - Incorrectly Not Selected: white checkmark in green circle
+    // "Show Correct Answer" Disabled:
+    //   - Correctly Selected:
+    //     - white checkmark in green circle
+    //     - heavy outline, as on “Gather”
+    //   - Correctly Not Selected: none
+    //   - Incorrectly Selected:
+    //     - white "X" in red circle
+    //     - heavy outline around the selection should appear in red
+    //   - Incorrectly Not Selected: white "X" in red circle
     let iconSrc;
 
-    if (selected) {
-      if (isCorrect) {
+    if (showCorrectEnabled) {
+      if ((selected && isCorrect) || (!selected && !isCorrect)) {
         iconSrc = faCorrect;
-      } else {
+      }
+    } else {
+      if (selected) {
+        if (isCorrect) {
+          iconSrc = faCorrect;
+        } else {
+          iconSrc = faWrong;
+        }
+      } else if (!isCorrect) {
         iconSrc = faWrong;
       }
-    } else if (!isCorrect) {
-      iconSrc = faWrong;
     }
 
     return (
@@ -132,7 +150,9 @@ RectComponent.propTypes = {
   y: PropTypes.number.isRequired,
   evaluateText: PropTypes.string,
   strokeWidth: PropTypes.number,
-  scale: PropTypes.number
+  scale: PropTypes.number,
+  markAsCorrect: PropTypes.bool.isRequired,
+  showCorrectEnabled: PropTypes.bool.isRequired
 };
 
 RectComponent.defaultProps = {

package/src/__tests__/__snapshots__/image-test.jsx.snap

@@ -1,21 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`Image snapshots image renders 1`] = `
-<Image
-  height={20}
-  image={null}
-  width={20}
-  x={5}
-  y={5}
-/>
-`;
-
-exports[`Image snapshots x y position renders 1`] = `
-<Image
-  height={20}
-  image={null}
-  width={20}
-  x={10}
-  y={10}
-/>
-`;

package/src/__tests__/polygon-test.jsx

@@ -1,77 +0,0 @@
-import React from 'react';
-import _ from 'lodash';
-import { shallow } from 'enzyme';
-import toJson from 'enzyme-to-json';
-import Konva from 'konva';
-
-import Polygon from '../hotspot/polygon';
-
-Konva.isBrowser = false;
-
-describe('Polygon', () => {
-  let onClick, wrapper;
-
-  const mkWrapper = (opts = {}) => {
-    opts = _.extend(
-      {
-        classes: {
-          base: 'base'
-        },
-        height: 200,
-        hotspotColor: 'rgba(137, 183, 244, 0.65)',
-        id: '1',
-        isCorrect: false,
-        isEvaluateMode: false,
-        evaluateText: null,
-        disabled: false,
-        outlineColor: 'blue',
-        selected: false,
-        points: [{ x: 94, y: 4 }, { x: 89, y: 4 }, { x: 36, y: 40 }]
-      },
-      opts
-    );
-
-    return shallow(<Polygon {...opts} onClick={onClick} />);
-  };
-
-  beforeEach(() => {
-    onClick = jest.fn();
-    wrapper = mkWrapper();
-  });
-
-  describe('snapshots', () => {
-    describe('outline color', () => {
-      it('renders', () => {
-        const wrapper = mkWrapper({ outlineColor: 'red' });
-        expect(toJson(wrapper)).toMatchSnapshot();
-      });
-    });
-
-    describe('outline width', () => {
-      it('renders with default border width', () => {
-        const wrapper = mkWrapper();
-        expect(toJson(wrapper)).toMatchSnapshot();
-      });
-
-      it('renders with given border width', () => {
-        const wrapper = mkWrapper({ strokeWidth: 10 });
-        expect(toJson(wrapper)).toMatchSnapshot();
-      });
-    });
-
-
-    describe('hotspot color', () => {
-      it('renders', () => {
-        const wrapper = mkWrapper({ hotspotColor: 'rgba(217, 30, 24, 0.65)' });
-        expect(toJson(wrapper)).toMatchSnapshot();
-      });
-    });
-
-    describe('evaluate with correct answer', () => {
-      it('renders', () => {
-        const wrapper = mkWrapper({ isEvaluateMode: true, isCorrect: true, evaluateText: 'Correctly\nselected' });
-        expect(toJson(wrapper)).toMatchSnapshot();
-      });
-    });
-  });
-});

package/src/__tests__/rectangle-test.jsx

@@ -1,78 +0,0 @@
-import React from 'react';
-import _ from 'lodash';
-import { shallow } from 'enzyme';
-import toJson from 'enzyme-to-json';
-import Konva from 'konva';
-
-import Rectangle from '../hotspot/rectangle';
-
-Konva.isBrowser = false;
-
-describe('Rectangle', () => {
-  let onClick, wrapper;
-
-  const mkWrapper = (opts = {}) => {
-    opts = _.extend(
-      {
-        classes: {
-          base: 'base'
-        },
-        height: 200,
-        hotspotColor: 'rgba(137, 183, 244, 0.65)',
-        id: '1',
-        isCorrect: false,
-        isEvaluateMode: false,
-        evaluateText: null,
-        disabled: false,
-        outlineColor: 'blue',
-        selected: false,
-        width: 300,
-        x: 5,
-        y: 5
-      },
-      opts
-    );
-
-    return shallow(<Rectangle {...opts} onClick={onClick} />);
-  };
-
-  beforeEach(() => {
-    onClick = jest.fn();
-    wrapper = mkWrapper();
-  });
-
-  describe('snapshots', () => {
-    describe('outline color', () => {
-      it('renders', () => {
-        const wrapper = mkWrapper({ outlineColor: 'red' });
-        expect(toJson(wrapper)).toMatchSnapshot();
-      });
-    });
-
-    describe('outline width', () => {
-      it('renders with default border width', () => {
-        const wrapper = mkWrapper();
-        expect(toJson(wrapper)).toMatchSnapshot();
-      });
-
-      it('renders with given border width', () => {
-        const wrapper = mkWrapper({ strokeWidth: 10 });
-        expect(toJson(wrapper)).toMatchSnapshot();
-      });
-    });
-
-    describe('hotspot color', () => {
-      it('renders', () => {
-        const wrapper = mkWrapper({ hotspotColor: 'rgba(217, 30, 24, 0.65)' });
-        expect(toJson(wrapper)).toMatchSnapshot();
-      });
-    });
-
-    describe('evaluate with correct answer', () => {
-      it('renders', () => {
-        const wrapper = mkWrapper({ isEvaluateMode: true, isCorrect: true, evaluateText: 'Correctly\nselected' });
-        expect(toJson(wrapper)).toMatchSnapshot();
-      });
-    });
-  });
-});