@pie-element/rubric 1.5.16 → 1.5.17-beta.587

package/configure/src/defaults.js

@@ -0,0 +1,21 @@
+export default {
+  model: {
+    points: ['', '', '', ''],
+    sampleAnswers: [null, null, null, null],
+    maxPoints: 4,
+    excludeZero: false,
+    excludeZeroEnabled: true,
+    maxPointsEnabled: true,
+  },
+  configuration: {
+    showExcludeZero: {
+      settings: true,
+      label: 'Ability to exclude zero',
+    },
+    showMaxPoint: {
+      settings: true,
+      label: 'Show max points dropdown',
+    },
+    settingsPanelDisabled: false,
+  },
+};

package/configure/src/index.js

@@ -1,19 +1,31 @@
 import { ModelUpdatedEvent } from '@pie-framework/pie-configure-events';
-
 import React from 'react';
 import ReactDOM from 'react-dom';
-import { Authoring } from '@pie-lib/rubric';
 import debug from 'debug';
 
+import Main from './main';
+import defaults from './defaults';
+
+const modelWithDefaults = (m) => ({ ...defaults.model, ...m });
+const configurationWithDefaults = (c) => ({ ...defaults.configuration, ...c });
+
 export default class RubricElement extends HTMLElement {
   constructor() {
     super();
     debug.log('constructor called');
+    this._model = modelWithDefaults();
+    this._configuration = configurationWithDefaults();
     this.onModelChanged = this.onModelChanged.bind(this);
+    this.onConfigurationChanged = this.onConfigurationChanged.bind(this);
   }
 
-  set model(s) {
-    this._model = s;
+  set model(m) {
+    this._model = modelWithDefaults(m);
+    this._render();
+  }
+
+  set configuration(c) {
+    this._configuration = configurationWithDefaults(c);
     this._render();
   }
 
@@ -23,16 +35,30 @@ export default class RubricElement extends HTMLElement {
     this.dispatchEvent(new ModelUpdatedEvent(this._model, false));
   }
 
+  onConfigurationChanged = (c) => {
+    this._configuration = configurationWithDefaults(c);
+
+    if (this._model) {
+      this.onModelChanged(this._model);
+    }
+
+    this._render();
+  };
+
   connectedCallback() {
     this._render();
   }
 
   _render() {
     if (this._model) {
-      const el = (
-        <Authoring value={this._model} onChange={this.onModelChanged} />
-      );
-      ReactDOM.render(el, this);
+      let element = React.createElement(Main, {
+        model: this._model,
+        configuration: this._configuration,
+        onModelChanged: this.onModelChanged,
+        onConfigurationChanged: this.onConfigurationChanged,
+      });
+
+      ReactDOM.render(element, this);
     }
   }
 }

package/configure/src/main.jsx

@@ -0,0 +1,48 @@
+import React from 'react';
+import { Authoring } from '@pie-lib/rubric';
+import { withStyles } from '@material-ui/core/styles';
+import { layout, settings } from '@pie-lib/config-ui';
+
+const { Panel, toggle } = settings;
+
+const styles = (theme) => ({
+  design: {
+    fontFamily: 'Cerebri Sans',
+    fontSize: theme.typography.fontSize,
+  },
+});
+
+class Main extends React.Component {
+  render() {
+    const { model, classes, configuration, onConfigurationChanged, onModelChanged } = this.props || {};
+    const { settingsPanelDisabled, showExcludeZero = {}, showMaxPoint = {} } = configuration || {};
+
+    const panelProperties = {
+      excludeZeroEnabled: showExcludeZero.settings && toggle(showExcludeZero.label),
+      maxPointsEnabled: showMaxPoint.settings && toggle(showMaxPoint.label),
+    };
+
+    return (
+      <div className={classes.design}>
+        <layout.ConfigLayout
+          hideSettings={settingsPanelDisabled}
+          settings={
+            <Panel
+              model={model}
+              onChangeModel={onModelChanged}
+              configuration={configuration}
+              onChangeConfiguration={onConfigurationChanged}
+              groups={{
+                Properties: panelProperties,
+              }}
+            />
+          }
+        >
+          <Authoring value={model} onChange={onModelChanged} />
+        </layout.ConfigLayout>
+      </div>
+    );
+  }
+}
+
+export default withStyles(styles)(Main);

package/controller/CHANGELOG.md

@@ -3,6 +3,52 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.2.8](https://github.com/pie-framework/pie-elements/compare/@pie-element/rubric-controller@1.2.7...@pie-element/rubric-controller@1.2.8) (2022-12-07)
+
+**Note:** Version bump only for package @pie-element/rubric-controller
+
+
+
+
+
+## [1.2.4](https://github.com/pie-framework/pie-elements/compare/@pie-element/rubric-controller@1.2.2...@pie-element/rubric-controller@1.2.4) (2021-11-11)
+
+**Note:** Version bump only for package @pie-element/rubric-controller
+
+
+
+
+
+## [1.2.3](https://github.com/pie-framework/pie-elements/compare/@pie-element/rubric-controller@1.2.2...@pie-element/rubric-controller@1.2.3) (2021-11-11)
+
+**Note:** Version bump only for package @pie-element/rubric-controller
+
+
+
+
+
+## [1.2.2](https://github.com/pie-framework/pie-elements/compare/@pie-element/rubric-controller@1.2.0...@pie-element/rubric-controller@1.2.2) (2021-08-05)
+
+
+### Bug Fixes
+
+* force bump ([5ea7295](https://github.com/pie-framework/pie-elements/commit/5ea7295e4755fbc492a76e7ec69e5fc35b196919))
+
+
+
+
+
+# [1.2.0](https://github.com/pie-framework/pie-elements/compare/@pie-element/rubric-controller@1.1.8...@pie-element/rubric-controller@1.2.0) (2021-06-29)
+
+
+### Features
+
+* **rubric:** Added sample answers to the model - PD-621 ([#559](https://github.com/pie-framework/pie-elements/issues/559)) ([d436b47](https://github.com/pie-framework/pie-elements/commit/d436b47b1cb8dd7cfbd82dbd2de4dd5eab36905c))
+
+
+
+
+
 ## [1.1.8](https://github.com/pie-framework/pie-elements/compare/@pie-element/rubric-controller@1.1.6...@pie-element/rubric-controller@1.1.8) (2021-03-03)
 
 **Note:** Version bump only for package @pie-element/rubric-controller

package/controller/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.js"],"names":["model","session","env","Promise","resolve","modelResult","role"],"mappings":";;;;;;;AAAO,SAASA,KAAT,CAAeA,KAAf,EAAsBC,OAAtB,EAA+BC,GAA/B,EAAoC;AACzC,SAAO,IAAIC,OAAJ,CAAY,UAAAC,OAAO,EAAI;AAC5B,QAAMC,WAAW,GAAG,CAACL,KAAD,GAAS,EAAT,GAAcA,KAAlC;AACAI,IAAAA,OAAO,CAAEF,GAAG,IAAIA,GAAG,CAACI,IAAX,IAAmBJ,GAAG,CAACI,IAAJ,KAAa,YAAjC,GAAiDD,WAAjD,GAA+D,EAAhE,CAAP;AACD,GAHM,CAAP;AAID","sourcesContent":["export function model(model, session, env) {\n  return new Promise(resolve => {\n    const modelResult = !model ? {} : model;\n    resolve((env && env.role && env.role === 'instructor') ? modelResult : {});\n  });\n}\n"],"file":"index.js"}
+{"version":3,"sources":["../src/index.js"],"names":["model","session","env","Promise","resolve","modelResult","role"],"mappings":";;;;;;;AAAO,SAASA,KAAT,CAAeA,KAAf,EAAsBC,OAAtB,EAA+BC,GAA/B,EAAoC;AACzC,SAAO,IAAIC,OAAJ,CAAY,UAACC,OAAD,EAAa;AAC9B,QAAMC,WAAW,GAAG,CAACL,KAAD,GAAS,EAAT,GAAcA,KAAlC;AACAI,IAAAA,OAAO,CAACF,GAAG,IAAIA,GAAG,CAACI,IAAX,IAAmBJ,GAAG,CAACI,IAAJ,KAAa,YAAhC,GAA+CD,WAA/C,GAA6D,EAA9D,CAAP;AACD,GAHM,CAAP;AAID","sourcesContent":["export function model(model, session, env) {\n  return new Promise((resolve) => {\n    const modelResult = !model ? {} : model;\n    resolve(env && env.role && env.role === 'instructor' ? modelResult : {});\n  });\n}\n"],"file":"index.js"}

package/controller/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pie-element/rubric-controller",
   "private": true,
-  "version": "1.1.8",
+  "version": "1.2.8",
   "main": "lib/index.js",
   "scripts": {
     "test": "./node_modules/.bin/jest"

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

@@ -1,11 +1,11 @@
 import { model } from '../index';
 
 describe('rubric model', () => {
-
   let state = {
     points: ['nothing right', 'a teeny bit right', 'mostly right', 'bingo'],
+    sampleAnswers: [null, 'just right', 'not left', null],
     maxPoints: 4,
-    excludeZero: false
+    excludeZero: false,
   };
 
   let session = {};
@@ -28,7 +28,4 @@ describe('rubric model', () => {
     result = await model(state, session, env);
     expect(result).toEqual(state);
   });
-
-
-
 });

package/controller/src/index.js

@@ -1,6 +1,6 @@
 export function model(model, session, env) {
-  return new Promise(resolve => {
+  return new Promise((resolve) => {
     const modelResult = !model ? {} : model;
-    resolve((env && env.role && env.role === 'instructor') ? modelResult : {});
+    resolve(env && env.role && env.role === 'instructor' ? modelResult : {});
   });
 }

package/docs/config-schema.json

@@ -0,0 +1,79 @@
+{
+  "type": "object",
+  "properties": {
+    "settingsPanelDisabled": {
+      "description": "Indicates if the settings panel is not available",
+      "type": "boolean",
+      "title": "settingsPanelDisabled"
+    },
+    "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"
+        }
+      }
+    },
+    "showMaxPoint": {
+      "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"
+        }
+      }
+    },
+    "showPrompt": {
+      "description": "Determines whether prompt field will be displayed or not",
+      "default": true,
+      "type": "boolean",
+      "title": "showPrompt"
+    },
+    "promptLabel": {
+      "description": "The label for the item stem/prompt field",
+      "default": "Item Stemm",
+      "type": "string",
+      "title": "promptLabel"
+    },
+    "settingsPartialScoring": {
+      "description": "Indicates whether the settings panel wil allow the author to modify settings for partial scoring",
+      "default": true,
+      "type": "boolean",
+      "title": "settingsPartialScoring"
+    }
+  },
+  "definitions": {
+    "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#"
+}

package/docs/config-schema.json.md

@@ -0,0 +1,65 @@
+The schema defines the following properties:
+
+# `settingsPanelDisabled` (boolean)
+
+Indicates if the settings panel is not available
+
+# `showExcludeZero` (object)
+
+Properties of the `showExcludeZero` object:
+
+## `settings` (boolean)
+
+Indicates if the item has to be displayed in the Settings Panel
+
+## `label` (string)
+
+Indicates the label for the item that has to be displayed in the Settings Panel
+
+# `showMaxPoint` (object)
+
+Properties of the `showMaxPoint` object:
+
+## `settings` (boolean)
+
+Indicates if the item has to be displayed in the Settings Panel
+
+## `label` (string)
+
+Indicates the label for the item that has to be displayed in the Settings Panel
+
+# `showPrompt` (boolean)
+
+Determines whether prompt field will be displayed or not
+
+Default: `true`
+
+# `promptLabel` (string)
+
+The label for the item stem/prompt field
+
+Default: `"Item Stemm"`
+
+# `settingsPartialScoring` (boolean)
+
+Indicates whether the settings panel wil allow the author to modify settings for partial scoring
+
+Default: `true`
+
+---
+
+# Sub Schemas
+
+The schema defines the following additional types:
+
+## `ConfigureProp` (object)
+
+Properties of the `ConfigureProp` object:
+
+### `settings` (boolean)
+
+Indicates if the item has to be displayed in the Settings Panel
+
+### `label` (string)
+
+Indicates the label for the item that has to be displayed in the Settings Panel

package/docs/demo/config.js

@@ -2,7 +2,7 @@ const { model } = require('./generate');
 
 module.exports = {
   elements: {
-    'pie-rubric': '../..'
+    'pie-rubric': '../..',
   },
-  models: [model('1', 'pie-rubric')]
+  models: [model('1', 'pie-rubric')],
 };

package/docs/demo/generate.js

@@ -2,6 +2,7 @@ exports.model = (id, element) => ({
   id,
   element,
   points: ['nothing right', 'a teeny bit right', 'mostly right', 'bingo'],
+  sampleAnswers: [null, 'just right', 'not left', null],
   maxPoints: 4,
-  excludeZero: false
+  excludeZero: false,
 });

package/docs/demo/index.html

@@ -1,3 +1,2 @@
-<p/>
+<p />
 <pie-rubric pie-id="1"></pie-rubric>
-

package/docs/pie-schema.json

@@ -0,0 +1,80 @@
+{
+  "description": "Model for the RubricPie Interaction",
+  "additionalProperties": false,
+  "type": "object",
+  "properties": {
+    "points": {
+      "description": "Indicates the score points labels. Starting from 0 to max",
+      "type": "array",
+      "items": {
+        "description": "Allows manipulation and formatting of text strings and determination and location of substrings within strings.",
+        "type": "object",
+        "additionalProperties": false,
+        "patternProperties": {
+          "^[0-9]+$": {
+            "type": "string"
+          }
+        }
+      },
+      "title": "points"
+    },
+    "sampleAnswers": {
+      "description": "Indicates the sample answers labels. Starting from 0 to max",
+      "type": "array",
+      "items": {
+        "description": "Allows manipulation and formatting of text strings and determination and location of substrings within strings.",
+        "type": "object",
+        "additionalProperties": false,
+        "patternProperties": {
+          "^[0-9]+$": {
+            "type": "string"
+          }
+        }
+      },
+      "title": "sampleAnswers"
+    },
+    "maxPoints": {
+      "description": "Indicates the max limit for scoring points",
+      "type": "number",
+      "title": "maxPoints"
+    },
+    "excludeZeros": {
+      "description": "Indicates if point 0 should be shown",
+      "type": "boolean",
+      "title": "excludeZeros"
+    },
+    "id": {
+      "description": "Identifier to identify the Pie Element in html markup, Must be unique within a pie item config.",
+      "type": "string",
+      "title": "id"
+    },
+    "element": {
+      "description": "The html Element tag name",
+      "type": "string",
+      "title": "element"
+    }
+  },
+  "required": [
+    "element",
+    "id"
+  ],
+  "definitions": {
+    "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#"
+}

package/docs/pie-schema.json.md

@@ -0,0 +1,53 @@
+Model for the RubricPie Interaction
+
+The schema defines the following properties:
+
+# `points` (array)
+
+Indicates the score points labels. Starting from 0 to max
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+# `sampleAnswers` (array)
+
+Indicates the sample answers labels. Starting from 0 to max
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+# `maxPoints` (number)
+
+Indicates the max limit for scoring points
+
+# `excludeZeros` (boolean)
+
+Indicates if point 0 should be shown
+
+# `id` (string, required)
+
+Identifier to identify the Pie Element in html markup, Must be unique within a pie item config.
+
+# `element` (string, required)
+
+The html Element tag name
+
+---
+
+# Sub Schemas
+
+The schema defines the following additional types:
+
+## `ConfigureProp` (object)
+
+Properties of the `ConfigureProp` object:
+
+### `settings` (boolean)
+
+Indicates if the item has to be displayed in the Settings Panel
+
+### `label` (string)
+
+Indicates the label for the item that has to be displayed in the Settings Panel

package/lib/index.js

@@ -31,7 +31,7 @@ var _debug = _interopRequireDefault(require("debug"));
 
 function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2["default"])(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2["default"])(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2["default"])(this, result); }; }
 
-function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
 
 var RubricRender = /*#__PURE__*/function (_HTMLElement) {
   (0, _inherits2["default"])(RubricRender, _HTMLElement);

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.js"],"names":["RubricRender","debug","log","onModelChanged","bind","s","_model","_render","m","el","ReactDOM","render","HTMLElement"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA;;AACA;;AACA;;AACA;;;;;;IAGqBA,Y;;;;;AAEnB,0BAAc;AAAA;;AAAA;AACZ;;AACAC,sBAAMC,GAAN,CAAU,oBAAV;;AACA,UAAKC,cAAL,GAAsB,MAAKA,cAAL,CAAoBC,IAApB,gDAAtB;AAHY;AAIb;;;;SAED,aAAUC,CAAV,EAAa;AACX,WAAKC,MAAL,GAAcD,CAAd;;AACA,WAAKE,OAAL;AACD;;;WAED,wBAAeC,CAAf,EAAkB;AAChB,WAAKF,MAAL,GAAcE,CAAd;;AACA,WAAKD,OAAL;AACD;;;WAED,6BAAoB;AAClB,WAAKA,OAAL;AACD;;;WAED,mBAAU;AACR,UAAI,KAAKD,MAAT,EAAiB;AACf,YAAMG,EAAE,gBACN,gCAAC,gBAAD;AAAQ,UAAA,KAAK,EAAE,KAAKH;AAApB,UADF;;AAGAI,6BAASC,MAAT,CAAgBF,EAAhB,EAAoB,IAApB;AACD;AACF;;;kDA7BuCG,W","sourcesContent":["import Rubric from './main';\nimport React from 'react';\nimport ReactDOM from 'react-dom';\nimport debug from 'debug';\n\n\nexport default class RubricRender extends HTMLElement {\n\n  constructor() {\n    super();\n    debug.log('constructor called');\n    this.onModelChanged = this.onModelChanged.bind(this);\n  }\n\n  set model(s) {\n    this._model = s;\n    this._render();\n  }\n\n  onModelChanged(m) {\n    this._model = m;\n    this._render();\n  }\n\n  connectedCallback() {\n    this._render();\n  }\n\n  _render() {\n    if (this._model) {\n      const el = (\n        <Rubric value={this._model}/>\n      );\n      ReactDOM.render(el, this);\n    }\n  }\n}\n"],"file":"index.js"}
+{"version":3,"sources":["../src/index.js"],"names":["RubricRender","debug","log","onModelChanged","bind","s","_model","_render","m","el","ReactDOM","render","HTMLElement"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA;;AACA;;AACA;;AACA;;;;;;IAEqBA,Y;;;;;AACnB,0BAAc;AAAA;;AAAA;AACZ;;AACAC,sBAAMC,GAAN,CAAU,oBAAV;;AACA,UAAKC,cAAL,GAAsB,MAAKA,cAAL,CAAoBC,IAApB,gDAAtB;AAHY;AAIb;;;;SAED,aAAUC,CAAV,EAAa;AACX,WAAKC,MAAL,GAAcD,CAAd;;AACA,WAAKE,OAAL;AACD;;;WAED,wBAAeC,CAAf,EAAkB;AAChB,WAAKF,MAAL,GAAcE,CAAd;;AACA,WAAKD,OAAL;AACD;;;WAED,6BAAoB;AAClB,WAAKA,OAAL;AACD;;;WAED,mBAAU;AACR,UAAI,KAAKD,MAAT,EAAiB;AACf,YAAMG,EAAE,gBAAG,gCAAC,gBAAD;AAAQ,UAAA,KAAK,EAAE,KAAKH;AAApB,UAAX;;AAEAI,6BAASC,MAAT,CAAgBF,EAAhB,EAAoB,IAApB;AACD;AACF;;;kDA3BuCG,W","sourcesContent":["import Rubric from './main';\nimport React from 'react';\nimport ReactDOM from 'react-dom';\nimport debug from 'debug';\n\nexport default class RubricRender extends HTMLElement {\n  constructor() {\n    super();\n    debug.log('constructor called');\n    this.onModelChanged = this.onModelChanged.bind(this);\n  }\n\n  set model(s) {\n    this._model = s;\n    this._render();\n  }\n\n  onModelChanged(m) {\n    this._model = m;\n    this._render();\n  }\n\n  connectedCallback() {\n    this._render();\n  }\n\n  _render() {\n    if (this._model) {\n      const el = <Rubric value={this._model} />;\n\n      ReactDOM.render(el, this);\n    }\n  }\n}\n"],"file":"index.js"}