cnx-public/scorm-again
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

More test cases and breaking out valid/invalid values to be reusable

Browse Source
This commit is contained in:
Jonathan Putney
2019-11-13 13:09:01 -05:00
parent 54b56e905f
commit 755259afdf
13 changed files with 1417 additions and 845 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/cmi/aicc_cmi.js
View File

@@ -1,7 +1,7 @@
import * as Scorm12CMI from './scorm12_cmi';
import {BaseCMI, CMIArray, CMIScore} from './common';
import {aicc_constants} from '../constants/api_constants';
import {aicc_regex} from '../regex';
import {aicc_regex} from '../constants/regex';
import {scorm12_error_codes} from '../constants/error_codes';
import {
check12ValidFormat,

16
src/cmi/common.js
View File

@@ -2,7 +2,7 @@
import {scorm12_constants} from '../constants/api_constants';
import {scorm12_error_codes} from '../constants/error_codes';
import {ValidationError} from '../exceptions';
import {scorm12_regex} from '../regex';
import {scorm12_regex} from '../constants/regex';
/**
* Check if the value matches the proper format. If not, throw proper error code.
@@ -10,12 +10,20 @@ import {scorm12_regex} from '../regex';
* @param {string} value
* @param {string} regexPattern
* @param {number} errorCode
* @param {boolean} allowEmptyString
* @return {boolean}
*/
export function checkValidFormat(
value: String, regexPattern: String, errorCode: number) {
value: String,
regexPattern: String,
errorCode: number,
allowEmptyString?: boolean) {
const formatRegex = new RegExp(regexPattern);
if (!value || !value.match(formatRegex)) {
const matches = value.match(formatRegex);
if (allowEmptyString && value === '') {
return true;
}
if (value === undefined || !matches || matches[0] === '') {
throw new ValidationError(errorCode);
}
return true;
@@ -97,7 +105,7 @@ export class CMIScore extends BaseCMI {
score_children :
scorm12_constants.score_children;
this.#_score_range = !score_range ? false : scorm12_regex.score_range;
this.#max = max ? max : '100';
this.#max = (max || max === '') ? max : '100';
this.#_invalid_error_code = invalidErrorCode ?
invalidErrorCode :
scorm12_error_codes.INVALID_SET_VALUE;

2
src/cmi/scorm12_cmi.js
View File

@@ -8,7 +8,7 @@ import {
} from './common';
import {scorm12_constants} from '../constants/api_constants';
import {scorm12_error_codes} from '../constants/error_codes';
import {scorm12_regex} from '../regex';
import {scorm12_regex} from '../constants/regex';
import {ValidationError} from '../exceptions';
const constants = scorm12_constants;

128
src/cmi/scorm2004_cmi.js
View File

@@ -7,7 +7,7 @@ import {
CMIScore,
} from './common';
import {scorm2004_constants} from '../constants/api_constants';
import {scorm2004_regex} from '../regex';
import {scorm2004_regex} from '../constants/regex';
import {scorm2004_error_codes} from '../constants/error_codes';
import {learner_responses} from '../constants/response_constants';
import {ValidationError} from '../exceptions';
@@ -40,11 +40,15 @@ function throwTypeMismatchError() {
* Helper method, no reason to have to pass the same error codes every time
* @param {*} value
* @param {string} regexPattern
* @param {boolean} allowEmptyString
* @return {boolean}
*/
function check2004ValidFormat(value: String, regexPattern: String) {
function check2004ValidFormat(
value: String,
regexPattern: String,
allowEmptyString?: boolean) {
return checkValidFormat(value, regexPattern,
scorm2004_error_codes.TYPE_MISMATCH);
scorm2004_error_codes.TYPE_MISMATCH, allowEmptyString);
}
/**
@@ -943,7 +947,7 @@ export class CMIInteractionsObject extends BaseCMI {
* @param {string} description
*/
set description(description) {
if (check2004ValidFormat(description, regex.CMILangString250)) {
if (check2004ValidFormat(description, regex.CMILangString250, true)) {
this.#description = description;
}
}
@@ -1098,7 +1102,7 @@ export class CMIObjectivesObject extends BaseCMI {
* @param {string} description
*/
set description(description) {
if (check2004ValidFormat(description, regex.CMILangString250)) {
if (check2004ValidFormat(description, regex.CMILangString250, true)) {
this.#description = description;
}
}
@@ -1112,7 +1116,8 @@ export class CMIObjectivesObject extends BaseCMI {
* success_status: string,
* completion_status: string,
* progress_measure: string,
* description: string
* description: string,
* score: Scorm2004CMIScore
* }
* }
*/
@@ -1124,6 +1129,7 @@ export class CMIObjectivesObject extends BaseCMI {
'completion_status': this.completion_status,
'progress_measure': this.progress_measure,
'description': this.description,
'score': this.score,
};
delete this.jsonString;
return result;
@@ -1186,9 +1192,9 @@ class Scorm2004CMIScore extends CMIScore {
this.jsonString = true;
const result = {
'scaled': this.scaled,
'raw': this.raw,
'min': this.min,
'max': this.max,
'raw': super.raw,
'min': super.min,
'max': super.max,
};
delete this.jsonString;
return result;
@@ -1208,6 +1214,9 @@ export class CMICommentsFromLearnerObject extends BaseCMI {
*/
constructor() {
super();
this.#comment = '';
this.#location = '';
this.#timestamp = '';
}
/**
@@ -1223,7 +1232,7 @@ export class CMICommentsFromLearnerObject extends BaseCMI {
* @param {string} comment
*/
set comment(comment) {
if (check2004ValidFormat(comment, regex.CMILangString4000)) {
if (check2004ValidFormat(comment, regex.CMILangString4000, true)) {
this.#comment = comment;
}
}
@@ -1263,6 +1272,27 @@ export class CMICommentsFromLearnerObject extends BaseCMI {
this.#timestamp = timestamp;
}
}
/**
* toJSON for cmi.comments_from_learner.n object
* @return {
* {
* comment: string,
* location: string,
* timestamp: string
* }
* }
*/
toJSON() {
this.jsonString = true;
const result = {
'comment': this.comment,
'location': this.location,
'timestamp': this.timestamp,
};
delete this.jsonString;
return result;
}
}
/**
@@ -1276,12 +1306,28 @@ export class CMICommentsFromLMSObject extends CMICommentsFromLearnerObject {
super();
}
/**
* Getter for #comment
* @return {string}
*/
get comment() {
return super.comment;
}
/**
* Setter for #comment. Can only be called before initialization.
* @param {string} comment
*/
set comment(comment) {
!this.initialized ? this.comment = comment : throwReadOnlyError();
!this.initialized ? super.comment = comment : throwReadOnlyError();
}
/**
* Getter for #location
* @return {string}
*/
get location() {
return super.location;
}
/**
@@ -1289,7 +1335,15 @@ export class CMICommentsFromLMSObject extends CMICommentsFromLearnerObject {
* @param {string} location
*/
set location(location) {
!this.initialized ? this.location = location : throwReadOnlyError();
!this.initialized ? super.location = location : throwReadOnlyError();
}
/**
* Getter for #timestamp
* @return {string}
*/
get timestamp() {
return super.timestamp;
}
/**
@@ -1297,7 +1351,21 @@ export class CMICommentsFromLMSObject extends CMICommentsFromLearnerObject {
* @param {string} timestamp
*/
set timestamp(timestamp) {
!this.initialized ? this.timestamp = timestamp : throwReadOnlyError();
!this.initialized ? super.timestamp = timestamp : throwReadOnlyError();
}
/**
* toJSON for cmi.comments_from_lms.n
* @return {
* {
* comment: string,
* location: string,
* timestamp: string
* }
* }
*/
toJSON() {
return super.toJSON();
}
}
@@ -1331,6 +1399,23 @@ export class CMIInteractionsObjectivesObject extends BaseCMI {
this.#id = id;
}
}
/**
* toJSON for cmi.interactions.n.objectives.n
* @return {
* {
* id: string
* }
* }
*/
toJSON() {
this.jsonString = true;
const result = {
'id': this.id,
};
delete this.jsonString;
return result;
}
}
/**
@@ -1363,6 +1448,23 @@ export class CMIInteractionsCorrectResponsesObject extends BaseCMI {
this.#pattern = pattern;
}
}
/**
* toJSON cmi.interactions.n.correct_responses.n object
* @return {
* {
* pattern: string
* }
* }
*/
toJSON() {
this.jsonString = true;
const result = {
'pattern': this.pattern,
};
delete this.jsonString;
return result;
}
}
/**