@pie-element/complex-rubric 0.0.2-next.4424

package/controller/src/defaults.js

@@ -0,0 +1,121 @@
+const multiTraitDefaultModel = {
+  visibleToStudent: true,
+  halfScoring: false,
+  pointLabels: true,
+  description: false,
+  standards: false,
+  scales: [],
+  excludeZero: false,
+};
+
+const rubricDefaultModel = {
+  points: ['nothing right', 'a teeny bit right', 'mostly right', 'bingo'],
+  sampleAnswers: [null, 'just right', 'not left', null],
+  maxPoints: 4,
+  excludeZero: false
+};
+
+const multiTraitDefaultConfiguration = {
+  settingsPanelDisabled: true,
+  excludeZeroDialogBoxContent: {
+    title: 'Exclude 0 (Zero) from Score Point Values.',
+    text: `<div>
+        You are about to exclude 0 from score point values.
+        <br/>
+        Some of the existing data has to be changed.
+        <br/>
+        Please choose if you want to:
+        <ul>
+          <li>
+            shift Labels and Descriptions to the left
+          </li>
+          <li>
+            remove 0 column with its Label and Description
+          </li>
+        </ul>
+      </div>`
+  },
+  includeZeroDialogBoxContent: {
+    title: 'Include 0 (Zero) in Score Point Values.',
+    text: `<div>
+        You are about to include 0 in score point values.
+        <br/>
+        Some of the existing data has to be changed.
+        <br/>
+        Please choose if you want to:
+        <ul>
+          <li>
+            shift Labels and Descriptions to the right
+          </li>
+          <li>
+            add 0 column with empty Label and Descriptions
+          </li>
+        </ul>
+      </div>`
+  },
+  deleteTraitDialogBoxContent: {
+    title: 'Delete Trait',
+    text: 'Are you sure you want to delete this trait?'
+  },
+  deleteScaleDialogBoxContent: {
+    title: 'Delete Scale',
+    text: 'Are you sure you want to delete this scale?'
+  },
+  maxPointsDialogBoxContent: {
+    title: 'Decreasing Max Points.',
+    text: ` You are about to decrease max score point value.
+        <br/>
+        All the Labels and Descriptions for scores above Max Point will be deleted.`
+  },
+  spellCheck: {
+    label: 'Spellcheck',
+    settings: false,
+    enabled: true
+  },
+  showExcludeZero: {
+    settings: true,
+    label: 'Exclude Zero',
+  },
+  showScorePointLabels: {
+    settings: true,
+    label: 'Show Score Point Labels',
+  },
+  showDescription: {
+    settings: true,
+    label: 'Show Description',
+  },
+  showVisibleToStudent: {
+    settings: true,
+    label: 'Visible to Student',
+  },
+  showHalfScoring: {
+    settings: true,
+    label: 'Half Scoring',
+  },
+  width: '900px',
+  // these should not be set to true (should not be used) for now
+  showStandards: {
+    settings: false,
+    label: 'Show Standards',
+  },
+  showLevelTagInput: {
+    settings: false,
+    label: 'Show Level Tag Input',
+    enabled: false
+  },
+  dragAndDrop: {
+    settings: true,
+    label: 'Enable Drag and Drop',
+    enabled: false,
+  }
+};
+
+export default {
+  model: {
+    rubricType: 'simpleRubric',
+    rubrics: { simpleRubric: rubricDefaultModel, multiTraitRubric: multiTraitDefaultModel }
+  },
+  configuration: {
+    multiTraitRubric: multiTraitDefaultConfiguration
+  }
+};

package/controller/src/index.js

@@ -0,0 +1,81 @@
+import defaults from './defaults';
+import { RUBRIC_TYPES } from '@pie-lib/rubric';
+
+export function createDefaultModel(model = {}) {
+  return new Promise(resolve => resolve({ ...defaults.model, ...model }));
+}
+
+export const normalize = question => ({ ...defaults.model, ...question });
+
+/**
+ *
+ * @param {*} question
+ * @param {*} session
+ * @param {*} env
+ */
+export async function model(question, session, env) {
+  const normalizedQuestion = normalize(question);
+
+  if (normalizedQuestion.rubricType === RUBRIC_TYPES.SIMPLE_RUBRIC) {
+    return new Promise(resolve => {
+      resolve((env && env.role && env.role === 'instructor') ?
+        {
+          ...normalizedQuestion,
+          rubrics: {
+            ...normalizedQuestion.rubrics,
+            multiTraitRubric: {
+              ...normalizedQuestion.rubrics.multiTraitRubric,
+              visible: false
+            }
+          }
+        }
+        : {});
+    });
+  } else {
+    if (!env.role || env.role === 'student' && normalizedQuestion.rubrics && normalizedQuestion.rubrics.multiTraitRubric) {
+      normalizedQuestion.rubrics.multiTraitRubric.visible = normalizedQuestion.visibleToStudent;
+    } else {
+      normalizedQuestion.rubrics.multiTraitRubric.visible = true;
+    }
+
+    // todo update pie-ui instead of parsing this here:
+    const { scales, excludeZero } = normalizedQuestion.rubrics.multiTraitRubric || {};
+    const parsedScales = (scales || []).map(scale => ({ ...scale, excludeZero }));
+
+    return {
+      ...normalizedQuestion,
+      rubrics: {
+        ...normalizedQuestion.rubrics,
+        simpleRubric: {
+          ...normalizedQuestion.rubrics.simpleRubric,
+          visible: false
+        },
+        multiTraitRubric: {
+          ...normalizedQuestion.rubrics.multiTraitRubric,
+          scales: parsedScales
+        }
+      }
+    };
+  }
+}
+
+export const getScore = () => 0;
+
+/**
+ * @param {Object} model - the main model
+ * @param {*} session
+ * @param {Object} env
+ */
+export function outcome(model, session, env) {
+  return new Promise(resolve => resolve({ score: 0, empty: true }));
+}
+
+export const createCorrectResponseSession = (question, env) => {
+  return new Promise(resolve => {
+    if (env.mode !== 'evaluate' && env.role === 'instructor') {
+      resolve({ id: '1' });
+    } else {
+      resolve(null);
+    }
+  });
+};

package/docs/config-schema.json

@@ -0,0 +1,427 @@
+{
+  "type": "object",
+  "properties": {
+    "multiTraitRubric": {
+      "description": "Config Object for @pie-elements/multi-trait-rubric",
+      "additionalProperties": false,
+      "title": "MultiTraitRubricConfigure",
+      "type": "object",
+      "properties": {
+        "excludeZeroDialogBoxContent": {
+          "title": "DialogContent",
+          "type": "object",
+          "properties": {
+            "title": {
+              "description": "Dialog box title",
+              "type": "string",
+              "title": "title"
+            },
+            "text": {
+              "description": "Dialog box text",
+              "type": "string",
+              "title": "text"
+            }
+          }
+        },
+        "includeZeroDialogBoxContent": {
+          "title": "DialogContent",
+          "type": "object",
+          "properties": {
+            "title": {
+              "description": "Dialog box title",
+              "type": "string",
+              "title": "title"
+            },
+            "text": {
+              "description": "Dialog box text",
+              "type": "string",
+              "title": "text"
+            }
+          }
+        },
+        "deleteTraitDialogBoxContent": {
+          "title": "DialogContent",
+          "type": "object",
+          "properties": {
+            "title": {
+              "description": "Dialog box title",
+              "type": "string",
+              "title": "title"
+            },
+            "text": {
+              "description": "Dialog box text",
+              "type": "string",
+              "title": "text"
+            }
+          }
+        },
+        "deleteScaleDialogBoxContent": {
+          "title": "DialogContent",
+          "type": "object",
+          "properties": {
+            "title": {
+              "description": "Dialog box title",
+              "type": "string",
+              "title": "title"
+            },
+            "text": {
+              "description": "Dialog box text",
+              "type": "string",
+              "title": "text"
+            }
+          }
+        },
+        "maxPointsDialogBoxContent": {
+          "title": "DialogContent",
+          "type": "object",
+          "properties": {
+            "title": {
+              "description": "Dialog box title",
+              "type": "string",
+              "title": "title"
+            },
+            "text": {
+              "description": "Dialog box text",
+              "type": "string",
+              "title": "text"
+            }
+          }
+        },
+        "showExcludeZero": {
+          "title": "ConfigureProp",
+          "type": "object",
+          "properties": {
+            "settings": {
+              "description": "Indicates if the item has to be displayed in the Settings Panel",
+              "type": "boolean",
+              "title": "settings"
+            },
+            "label": {
+              "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
+              "type": "string",
+              "title": "label"
+            }
+          }
+        },
+        "showScorePointLabels": {
+          "title": "ConfigureProp",
+          "type": "object",
+          "properties": {
+            "settings": {
+              "description": "Indicates if the item has to be displayed in the Settings Panel",
+              "type": "boolean",
+              "title": "settings"
+            },
+            "label": {
+              "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
+              "type": "string",
+              "title": "label"
+            }
+          }
+        },
+        "showDescription": {
+          "title": "ConfigureProp",
+          "type": "object",
+          "properties": {
+            "settings": {
+              "description": "Indicates if the item has to be displayed in the Settings Panel",
+              "type": "boolean",
+              "title": "settings"
+            },
+            "label": {
+              "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
+              "type": "string",
+              "title": "label"
+            }
+          }
+        },
+        "showVisibleToStudent": {
+          "title": "ConfigureProp",
+          "type": "object",
+          "properties": {
+            "settings": {
+              "description": "Indicates if the item has to be displayed in the Settings Panel",
+              "type": "boolean",
+              "title": "settings"
+            },
+            "label": {
+              "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
+              "type": "string",
+              "title": "label"
+            }
+          }
+        },
+        "showHalfScoring": {
+          "title": "ConfigureProp",
+          "type": "object",
+          "properties": {
+            "settings": {
+              "description": "Indicates if the item has to be displayed in the Settings Panel",
+              "type": "boolean",
+              "title": "settings"
+            },
+            "label": {
+              "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
+              "type": "string",
+              "title": "label"
+            }
+          }
+        },
+        "spellCheck": {
+          "title": "ConfigureProp",
+          "type": "object",
+          "properties": {
+            "settings": {
+              "description": "Indicates if the item has to be displayed in the Settings Panel",
+              "type": "boolean",
+              "title": "settings"
+            },
+            "label": {
+              "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
+              "type": "string",
+              "title": "label"
+            }
+          }
+        },
+        "width": {
+          "description": "How large (in px) should multi-trait-rubric be",
+          "type": "string",
+          "title": "width"
+        }
+      },
+      "required": [
+        "width"
+      ]
+    }
+  },
+  "required": [
+    "multiTraitRubric"
+  ],
+  "definitions": {
+    "MultiTraitRubricConfigure": {
+      "description": "Config Object for @pie-elements/multi-trait-rubric",
+      "additionalProperties": false,
+      "title": "MultiTraitRubricConfigure",
+      "type": "object",
+      "properties": {
+        "excludeZeroDialogBoxContent": {
+          "title": "DialogContent",
+          "type": "object",
+          "properties": {
+            "title": {
+              "description": "Dialog box title",
+              "type": "string",
+              "title": "title"
+            },
+            "text": {
+              "description": "Dialog box text",
+              "type": "string",
+              "title": "text"
+            }
+          }
+        },
+        "includeZeroDialogBoxContent": {
+          "title": "DialogContent",
+          "type": "object",
+          "properties": {
+            "title": {
+              "description": "Dialog box title",
+              "type": "string",
+              "title": "title"
+            },
+            "text": {
+              "description": "Dialog box text",
+              "type": "string",
+              "title": "text"
+            }
+          }
+        },
+        "deleteTraitDialogBoxContent": {
+          "title": "DialogContent",
+          "type": "object",
+          "properties": {
+            "title": {
+              "description": "Dialog box title",
+              "type": "string",
+              "title": "title"
+            },
+            "text": {
+              "description": "Dialog box text",
+              "type": "string",
+              "title": "text"
+            }
+          }
+        },
+        "deleteScaleDialogBoxContent": {
+          "title": "DialogContent",
+          "type": "object",
+          "properties": {
+            "title": {
+              "description": "Dialog box title",
+              "type": "string",
+              "title": "title"
+            },
+            "text": {
+              "description": "Dialog box text",
+              "type": "string",
+              "title": "text"
+            }
+          }
+        },
+        "maxPointsDialogBoxContent": {
+          "title": "DialogContent",
+          "type": "object",
+          "properties": {
+            "title": {
+              "description": "Dialog box title",
+              "type": "string",
+              "title": "title"
+            },
+            "text": {
+              "description": "Dialog box text",
+              "type": "string",
+              "title": "text"
+            }
+          }
+        },
+        "showExcludeZero": {
+          "title": "ConfigureProp",
+          "type": "object",
+          "properties": {
+            "settings": {
+              "description": "Indicates if the item has to be displayed in the Settings Panel",
+              "type": "boolean",
+              "title": "settings"
+            },
+            "label": {
+              "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
+              "type": "string",
+              "title": "label"
+            }
+          }
+        },
+        "showScorePointLabels": {
+          "title": "ConfigureProp",
+          "type": "object",
+          "properties": {
+            "settings": {
+              "description": "Indicates if the item has to be displayed in the Settings Panel",
+              "type": "boolean",
+              "title": "settings"
+            },
+            "label": {
+              "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
+              "type": "string",
+              "title": "label"
+            }
+          }
+        },
+        "showDescription": {
+          "title": "ConfigureProp",
+          "type": "object",
+          "properties": {
+            "settings": {
+              "description": "Indicates if the item has to be displayed in the Settings Panel",
+              "type": "boolean",
+              "title": "settings"
+            },
+            "label": {
+              "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
+              "type": "string",
+              "title": "label"
+            }
+          }
+        },
+        "showVisibleToStudent": {
+          "title": "ConfigureProp",
+          "type": "object",
+          "properties": {
+            "settings": {
+              "description": "Indicates if the item has to be displayed in the Settings Panel",
+              "type": "boolean",
+              "title": "settings"
+            },
+            "label": {
+              "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
+              "type": "string",
+              "title": "label"
+            }
+          }
+        },
+        "showHalfScoring": {
+          "title": "ConfigureProp",
+          "type": "object",
+          "properties": {
+            "settings": {
+              "description": "Indicates if the item has to be displayed in the Settings Panel",
+              "type": "boolean",
+              "title": "settings"
+            },
+            "label": {
+              "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
+              "type": "string",
+              "title": "label"
+            }
+          }
+        },
+        "spellCheck": {
+          "title": "ConfigureProp",
+          "type": "object",
+          "properties": {
+            "settings": {
+              "description": "Indicates if the item has to be displayed in the Settings Panel",
+              "type": "boolean",
+              "title": "settings"
+            },
+            "label": {
+              "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
+              "type": "string",
+              "title": "label"
+            }
+          }
+        },
+        "width": {
+          "description": "How large (in px) should multi-trait-rubric be",
+          "type": "string",
+          "title": "width"
+        }
+      },
+      "required": [
+        "width"
+      ]
+    },
+    "DialogContent": {
+      "title": "DialogContent",
+      "type": "object",
+      "properties": {
+        "title": {
+          "description": "Dialog box title",
+          "type": "string",
+          "title": "title"
+        },
+        "text": {
+          "description": "Dialog box text",
+          "type": "string",
+          "title": "text"
+        }
+      }
+    },
+    "ConfigureProp": {
+      "title": "ConfigureProp",
+      "type": "object",
+      "properties": {
+        "settings": {
+          "description": "Indicates if the item has to be displayed in the Settings Panel",
+          "type": "boolean",
+          "title": "settings"
+        },
+        "label": {
+          "description": "Indicates the label for the item that has to be displayed in the Settings Panel",
+          "type": "string",
+          "title": "label"
+        }
+      }
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}