@pie-element/complex-rubric 7.1.0-next.28 → 7.1.1-next.0

package/module/controller.js

@@ -1,262 +0,0 @@
-// todo the import from pie-lib/rubric WILL break pslb
-//  so don't use it unless you also test "yarn build"
-const RUBRIC_TYPES$1 = {
-  SIMPLE_RUBRIC: 'simpleRubric',
-  MULTI_TRAIT_RUBRIC: 'multiTraitRubric',
-  'rubricless': 'rubricless',
-};
-
-const multiTraitDefaultModel = {
-  description: false,
-  excludeZero: false,
-  halfScoring: false,
-  pointLabels: true,
-  scales: [],
-  standards: false,
-  visibleToStudent: true,
-};
-
-const rubricDefaultModel = {
-  points: ['', '', '', ''],
-  sampleAnswers: [null, null, null, null],
-  maxPoints: 3,
-  excludeZero: false,
-};
-
-const rubriclessDefaultModel = {
-  maxPoints: 100,
-  excludeZero: false,
-  rubriclessInstructionEnabled: true,
-};
-
-var defaults = {
-  rubricType: 'simpleRubric',
-  rubrics: {
-    [RUBRIC_TYPES$1.SIMPLE_RUBRIC]: rubricDefaultModel,
-    [RUBRIC_TYPES$1.MULTI_TRAIT_RUBRIC]: multiTraitDefaultModel,
-    [RUBRIC_TYPES$1.RUBRICLESS]: rubriclessDefaultModel,
-  },
-};
-
-const markupToText = (s) => {
-    return (s || '').replace(/(<([^>]+)>)/ig, '');
-};
-
-// todo the import from pie-lib/rubric WILL break pslb
-//  so don't use it unless you also test "yarn build"
-const RUBRIC_TYPES = {
-  SIMPLE_RUBRIC: 'simpleRubric',
-  MULTI_TRAIT_RUBRIC: 'multiTraitRubric',
-  'rubricless': 'rubricless',
-};
-
-function createDefaultModel(model = {}) {
-  return new Promise((resolve) => resolve({ ...defaults, ...model }));
-}
-
-const normalize = (question) => ({ ...defaults, ...question });
-
-/**
- * @param {*} question
- * @param {*} session
- * @param {*} env
- */
-async function model(question, session, env) {
-  const normalizedQuestion = normalize(question);
-
-  if (
-    normalizedQuestion.rubricType === RUBRIC_TYPES.SIMPLE_RUBRIC ||
-    normalizedQuestion.rubricType === RUBRIC_TYPES.RUBRICLESS
-  ) {
-    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,
-        },
-        rubricless: {
-          ...normalizedQuestion.rubrics.rubricless,
-          visible: false,
-        },
-        multiTraitRubric: {
-          ...normalizedQuestion.rubrics.multiTraitRubric,
-          scales: parsedScales,
-        },
-      },
-    };
-  }
-}
-
-const getScore = () => 0;
-
-/**
- * @param {Object} model - the main model
- * @param {*} session
- * @param {Object} env
- */
-function outcome() {
-  return new Promise((resolve) => resolve({ score: 0, empty: true }));
-}
-
-const createCorrectResponseSession = (question, env) => {
-  return new Promise((resolve) => {
-    if (env.mode !== 'evaluate' && env.role === 'instructor') {
-      resolve({ id: '1' });
-    } else {
-      resolve(null);
-    }
-  });
-};
-
-// IMPORTANT! This function is a duplicate of rubric/controller/validate function!
-// If you make any changes to this function, please make sure you also update rubric/controller/validate function!“.
-const validateSimpleRubric = (model) => {
-  const { points } = model;
-  const errors = {};
-  const pointsDescriptorsErrors = {};
-
-  (points || []).forEach((point, index) => {
-
-    if (!point || point === '<div></div>') {
-      pointsDescriptorsErrors[index] = 'Points descriptors cannot be empty.';
-    } else {
-      const identicalPointDescr = points.slice(index + 1).some((p) => markupToText(p) === markupToText(point));
-
-      if (identicalPointDescr) {
-        pointsDescriptorsErrors[index] = 'Points descriptors should be unique.';
-      }
-    }
-  });
-
-  if (Object.keys(pointsDescriptorsErrors).length > 0) {
-    errors.pointsDescriptorsErrors = pointsDescriptorsErrors;
-  }
-
-  return errors;
-};
-
-// IMPORTANT! This function is a duplicate of multi-trait-rubric/controller/validate function!
-// If you make any changes to this function, please make sure you also update multi-trait-rubric/controller/validate function!“.
-const validateMultiTraitRubric = (model) => {
-  const { scales, description = false, pointLabels = false } = model;
-  const errors = {};
-  const traitsErrors = {};
-  const scorePointsErrors = {};
-
-  (scales || []).forEach((scale, scaleIndex) => {
-    const { traits = [] } = scale;
-    const { scorePointsLabels = [] } = scale;
-    const scaleErrors = {};
-    const scorePointsLabelsErrors = {};
-
-    if (pointLabels) {
-      scorePointsLabels.forEach((scorePointLabel, scoreIndex) => {
-        if (!scorePointLabel || scorePointLabel === '<div></div>') {
-          scorePointsLabelsErrors[scoreIndex] = 'Points labels should not be empty.';
-        } else {
-          const identicalScorePointLabel = scorePointsLabels
-            .slice(scoreIndex + 1)
-            .some((s) => markupToText(s) === markupToText(scorePointLabel));
-
-          if (identicalScorePointLabel) {
-            scorePointsLabelsErrors[scoreIndex] = 'Points labels should be unique.';
-          }
-        }
-      });
-    }
-
-    if (Object.keys(scorePointsLabelsErrors).length > 0) {
-      scorePointsErrors[scaleIndex] = scorePointsLabelsErrors;
-    }
-
-    traits.forEach((trait, traitIndex) => {
-      if (!trait.name || trait.name === '<div></div>') {
-        scaleErrors[traitIndex] = { name: 'Trait names should not be empty.' };
-      } else {
-        const identicalTraitName = traits
-          .slice(traitIndex + 1)
-          .some((t) => markupToText(t.name) === markupToText(trait.name));
-
-        if (identicalTraitName) {
-          scaleErrors[traitIndex] = { name: 'Trait names should be unique.' };
-        }
-      }
-      if (description && (!trait.description || trait.description === '<div></div>')) {
-        scaleErrors[traitIndex] = { ...scaleErrors[traitIndex], description: 'Trait description should not be empty' };
-      } else {
-        const identicalTraitDescr = traits
-          .slice(traitIndex + 1)
-          .some((t) => markupToText(t.description) === markupToText(trait.description));
-
-        if (description && identicalTraitDescr) {
-          scaleErrors[traitIndex] = { ...scaleErrors[traitIndex], description: 'Trait descriptions should be unique.' };
-        }
-      }
-    });
-    if (Object.keys(scaleErrors).length > 0) {
-      traitsErrors[scaleIndex] = scaleErrors;
-    }
-  });
-
-  if (Object.keys(traitsErrors).length > 0) {
-    errors.traitsErrors = traitsErrors;
-  }
-
-  if (Object.keys(scorePointsErrors).length > 0) {
-    errors.scorePointsErrors = scorePointsErrors;
-  }
-
-  return errors;
-};
-
-const validate = (model = {}, config = {}) => {
-  const { rubrics = {}, rubricType } = model;
-  const { multiTraitRubric = {}, simpleRubric = {} } = rubrics;
-  let errors = {};
-
-  switch (rubricType) {
-    case RUBRIC_TYPES.SIMPLE_RUBRIC:
-    default:
-      errors = validateSimpleRubric(simpleRubric);
-      break;
-    case RUBRIC_TYPES.MULTI_TRAIT_RUBRIC:
-      errors = validateMultiTraitRubric(multiTraitRubric);
-      break;
-  }
-
-  return errors;
-};
-
-export { createCorrectResponseSession, createDefaultModel, getScore, model, normalize, outcome, validate };

package/module/demo.js

@@ -1,221 +0,0 @@
-import Configure from './configure.js';
-import Element from './element.js';
-import * as controller from './controller.js';
-
-var generate = {};
-
-generate.model = (id, element) => ({
-  id,
-  element,
-  rubricType: 'simpleRubric',
-  rubrics: {
-    simpleRubric: {
-      points: ['nothing right', 'a teeny bit right', 'mostly right', 'bingo'],
-      sampleAnswers: [null, 'just right', 'not left', null],
-      maxPoints: 3,
-      excludeZero: false,
-    },
-    rubricless: {
-      maxPoints: 100,
-      excludeZero: false,
-      rubriclessInstructionEnabled: true,
-    },
-    multiTraitRubric: {
-      visibleToStudent: true,
-      halfScoring: false,
-      excludeZero: true,
-      pointLabels: true,
-      description: false,
-      standards: false,
-      scales: [
-        {
-          maxPoints: 4,
-          scorePointsLabels: ['Non-Scorable', 'Developing', 'Progressing', 'Effective', 'Strong'],
-          traitLabel: 'Trait',
-          traits: [
-            {
-              name: 'Ideas',
-              standards: [],
-              description: 'the main message',
-              scorePointsDescriptors: [
-                'Student’s response is blank, not in English, not legible, or does not respond to the prompt.',
-                'Topic undefined and/or difficult to follow\n' + '\n' + 'Details are unclear',
-                'Topic too broad\n' + '\n' + 'Details are limited',
-                'Writing stays on topic\n' + '\n' + 'Complete details given',
-                'Strong control of topic\n' + '\n' + 'Relevant, accurate, specific details that support topic',
-              ],
-            },
-            {
-              name: 'Organization',
-              standards: [],
-              description: 'the internal structure of the piece',
-              scorePointsDescriptors: [
-                'Student’s response is blank, not in English, not legible, or does not respond to the prompt.',
-                'Does not have a beginning, middle and/or end\n' +
-                  '\n' +
-                  'Does not have a lead and/or conclusion\n' +
-                  '\n' +
-                  'Transitions confusing and/or not present\n' +
-                  '\n' +
-                  'Not written in logical order\n' +
-                  '\n' +
-                  'No sign of paragraphing / incorrect paragraphing',
-                'Weak beginning, middle and end\n' +
-                  '\n' +
-                  'Has evidence of a lead and/or conclusion but missing elements\n' +
-                  '\n' +
-                  'Transitions are used sometimes\n' +
-                  '\n' +
-                  'Some logical order\n' +
-                  '\n' +
-                  'Most paragraphing incorrect',
-                'Has an acceptable beginning, middle and end\n' +
-                  '\n' +
-                  'Includes a lead and conclusion\n' +
-                  '\n' +
-                  'Transitions are used correctly\n' +
-                  '\n' +
-                  'Mostly logical order\n' +
-                  '\n' +
-                  'Mostly correct paragraphing',
-                'Has an effective beginning, middle and end\n' +
-                  '\n' +
-                  'Powerful introduction / lead and conclusion\n' +
-                  '\n' +
-                  'Effective transitions\n' +
-                  '\n' +
-                  'Logical order / sequencing\n' +
-                  '\n' +
-                  'Uses appropriate paragraphing',
-              ],
-            },
-            {
-              name: 'Word Choice',
-              standards: [],
-              description: 'the vocabulary a writer chooses to convey meaning',
-              scorePointsDescriptors: [
-                'Student’s response is blank, not in English, not legible, or does not respond to the prompt.',
-                'Vocabulary is limited/used incorrectly\n' +
-                  '\n' +
-                  'No figurative language; words do not convey meaning',
-                'Generally correct words\n' +
-                  '\n' +
-                  'Attempt at figurative language\n' +
-                  '\n' +
-                  'and/or words convey general meaning',
-                'Some active verbs and precise nouns\n' +
-                  '\n' +
-                  'Effective use of figurative language and/or words that enhance meaning',
-                'Powerful and engaging words\n' + '\n' + 'Artful use of figurative language and/or sensory detail',
-              ],
-            },
-            {
-              name: 'Sentence Fluency',
-              standards: [],
-              description: 'the rhythm and flow of the language',
-              scorePointsDescriptors: [
-                'Student’s response is blank, not in English, not legible, or does not respond to the prompt.',
-                'No sentences are clear\n' +
-                  '\n' +
-                  'No variety in sentence structure\n' +
-                  '\n' +
-                  'Frequent run-ons and/or fragments are present',
-                'Some sentences are clear\n' +
-                  '\n' +
-                  'Sentence variety used rarely\n' +
-                  '\n' +
-                  'Some run-ons and/or fragments are present',
-                'Most sentences are clear\n' +
-                  '\n' +
-                  'Some sentence variety is used\n' +
-                  '\n' +
-                  'Run-ons and/or fragments are rare',
-                'All Sentences are clear\n' +
-                  '\n' +
-                  'Variety of sentence structure is used\n' +
-                  '\n' +
-                  'Run-ons and/or fragments are not present',
-              ],
-            },
-            {
-              name: 'Conventions',
-              standards: [],
-              description: 'the mechanical correctness',
-              scorePointsDescriptors: [
-                'Student’s response is blank, not in English, not legible, or does not respond to the prompt.',
-                'Many distracting errors are present in grammar, punctuation, capitalization and/or spelling',
-                'Errors in grammar, punctuation, capitalization and/or spelling are present and some distract from meaning',
-                'Errors in grammar, punctuation, capitalization and/or spelling are present but don’t distract from meaning',
-                'Few errors in grammar, punctuation,\n' + '\n' + 'capitalization and/or spelling',
-              ],
-            },
-            {
-              name: 'Voice',
-              standards: [],
-              description: 'the personal tone and flavor of the author\'s message',
-              scorePointsDescriptors: [
-                'Student’s response is blank, not in English, not legible, or does not respond to the prompt.',
-                'Not concerned with audience or purpose\n' +
-                  '\n' +
-                  'No viewpoint (perspective) used\n' +
-                  '\n' +
-                  'Writing is mechanical and lifeless',
-                'Shows beginning awareness of audience/purpose\n' +
-                  '\n' +
-                  'Some viewpoint (perspective) used throughout the piece\n' +
-                  '\n' +
-                  'Writing is distant, too formal or informal',
-                'Awareness of audience; purpose is clear most of the time\n' +
-                  '\n' +
-                  'Uses viewpoint (perspective) throughout most of the paper\n' +
-                  '\n' +
-                  'Writing is pleasant, agreeable and satisfying',
-                'Powerful connection with audience; purpose is clearly communicated\n' +
-                  '\n' +
-                  'Maintains strong viewpoint (perspective) throughout entire piece\n' +
-                  '\n' +
-                  'Writing is expressive, engaging and has lots of energy',
-              ],
-            },
-          ],
-        },
-        {
-          maxPoints: 5,
-          scorePointsLabels: ['Non-Scorable', 'Unsatisfactory', 'Satisfactory'],
-          traitLabel: 'Category',
-          traits: [
-            {
-              name: 'Presentation',
-              standards: [],
-              description: '',
-              scorePointsDescriptors: [
-                'Handwriting is unreadable, or response is blank, not in English, or too brief to evaluate. ',
-                'Handwriting poor\n' + '\n' + 'Overall appearance is distracting to unacceptable',
-                'Handwriting is generally legible\n' + '\n' + 'Overall appearance is acceptable or better',
-              ],
-            },
-          ],
-        },
-      ],
-    },
-  },
-});
-
-const { model } = generate;
-
-var config = {
-  elements: {
-    'complex-rubric': '../..',
-  },
-  models: [model('1', 'complex-rubric')],
-};
-
-//Note: demo-el is a custom element loaded in the markup.
-  customElements.whenDefined("demo-el").then(() => {
-    config.models.forEach((m) => {
-      const de = document.createElement("demo-el");
-      document.body.appendChild(de);
-      de.def = { tagName: m.element, Element, Configure, controller };
-      de.model = m;
-    });
-  });