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

Minor code cleanup and additional test cases

Browse Source
This commit is contained in:
Jonathan Putney
2020-08-17 09:09:52 -04:00
parent 576d417365
commit ab1f3b061b
4 changed files with 171 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
package-lock.json generated
View File

@@ -1,6 +1,6 @@
{ {
"name": "scorm-again", "name": "scorm-again",
"version": "1.4.0", "version": "1.4.1",
"lockfileVersion": 1, "lockfileVersion": 1,
"requires": true, "requires": true,
"dependencies": { "dependencies": {

96
src/Scorm2004API.js
View File

@@ -199,36 +199,14 @@ export default class Scorm2004API extends BaseAPI {
this.throwSCORMError( this.throwSCORMError(
scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED); scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED);
} else { } else {
const interaction_type = interaction.type; this.checkDuplicateChoiceResponse(interaction, value);
const interaction_count = interaction.correct_responses._count;
if (interaction_type === 'choice') {
for (let i = 0; i < interaction_count && this.lastErrorCode ===
0; i++) {
const response = interaction.correct_responses.childArray[i];
if (response.pattern === value) {
this.throwSCORMError(scorm2004_error_codes.GENERAL_SET_FAILURE);
}
}
}
const response_type = correct_responses[interaction_type]; const response_type = correct_responses[interaction.type];
if (response_type) { if (response_type) {
let nodes = []; this.checkValidResponseType(response_type, value, interaction.type);
if (response_type?.delimiter) {
nodes = String(value).split(response_type.delimiter);
} else {
nodes[0] = value;
}
if (nodes.length > 0 && nodes.length <= response_type.max) {
this.checkCorrectResponseValue(interaction_type, nodes, value);
} else if (nodes.length > response_type.max) {
this.throwSCORMError(scorm2004_error_codes.GENERAL_SET_FAILURE,
'Data Model Element Pattern Too Long');
}
} else { } else {
this.throwSCORMError(scorm2004_error_codes.GENERAL_SET_FAILURE, this.throwSCORMError(scorm2004_error_codes.GENERAL_SET_FAILURE,
'Incorrect Response Type: ' + interaction_type); 'Incorrect Response Type: ' + interaction.type);
} }
} }
} }
@@ -253,30 +231,12 @@ export default class Scorm2004API extends BaseAPI {
} }
/** /**
* Validate correct response. * Checks for valid response types
* @param {string} CMIElement * @param {object} response_type
* @param {*} value * @param {any} value
* @param {string} interaction_type
*/ */
validateCorrectResponse(CMIElement, value) { checkValidResponseType(response_type, value, interaction_type) {
const parts = CMIElement.split('.');
const index = Number(parts[2]);
const pattern_index = Number(parts[4]);
const interaction = this.cmi.interactions.childArray[index];
const interaction_type = interaction.type;
const interaction_count = interaction.correct_responses._count;
if (interaction_type === 'choice') {
for (let i = 0; i < interaction_count && this.lastErrorCode === 0; i++) {
const response = interaction.correct_responses.childArray[i];
if (response.pattern === value) {
this.throwSCORMError(scorm2004_error_codes.GENERAL_SET_FAILURE);
}
}
}
const response_type = correct_responses[interaction_type];
if (typeof response_type.limit === 'undefined' || interaction_count <=
response_type.limit) {
let nodes = []; let nodes = [];
if (response_type?.delimiter) { if (response_type?.delimiter) {
nodes = String(value).split(response_type.delimiter); nodes = String(value).split(response_type.delimiter);
@@ -290,6 +250,44 @@ export default class Scorm2004API extends BaseAPI {
this.throwSCORMError(scorm2004_error_codes.GENERAL_SET_FAILURE, this.throwSCORMError(scorm2004_error_codes.GENERAL_SET_FAILURE,
'Data Model Element Pattern Too Long'); 'Data Model Element Pattern Too Long');
} }
}
/**
* Checks for duplicate 'choice' responses.
* @param {CMIInteractionsObject} interaction
* @param {any} value
*/
checkDuplicateChoiceResponse(interaction, value) {
const interaction_count = interaction.correct_responses._count;
if (interaction.type === 'choice') {
for (let i = 0; i < interaction_count && this.lastErrorCode ===
0; i++) {
const response = interaction.correct_responses.childArray[i];
if (response.pattern === value) {
this.throwSCORMError(scorm2004_error_codes.GENERAL_SET_FAILURE);
}
}
}
}
/**
* Validate correct response.
* @param {string} CMIElement
* @param {*} value
*/
validateCorrectResponse(CMIElement, value) {
const parts = CMIElement.split('.');
const index = Number(parts[2]);
const pattern_index = Number(parts[4]);
const interaction = this.cmi.interactions.childArray[index];
const interaction_count = interaction.correct_responses._count;
this.checkDuplicateChoiceResponse(interaction, value);
const response_type = correct_responses[interaction.type];
if (typeof response_type.limit === 'undefined' || interaction_count <=
response_type.limit) {
this.checkValidResponseType(response_type, value, interaction.type);
if (this.lastErrorCode === 0 && if (this.lastErrorCode === 0 &&
(!response_type.duplicate || (!response_type.duplicate ||

21
src/cmi/scorm2004_cmi.js
View File

@@ -819,7 +819,7 @@ export class CMIInteractionsObject extends BaseCMI {
* @param {string} type * @param {string} type
*/ */
set type(type) { set type(type) {
if (this.initialized && typeof this.id === 'undefined') { if (this.initialized && this.#id === '') {
throw new ValidationError( throw new ValidationError(
scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED); scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED);
} else { } else {
@@ -842,7 +842,7 @@ export class CMIInteractionsObject extends BaseCMI {
* @param {string} timestamp * @param {string} timestamp
*/ */
set timestamp(timestamp) { set timestamp(timestamp) {
if (this.initialized && typeof this.id === 'undefined') { if (this.initialized && this.#id === '') {
throw new ValidationError( throw new ValidationError(
scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED); scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED);
} else { } else {
@@ -865,7 +865,7 @@ export class CMIInteractionsObject extends BaseCMI {
* @param {string} weighting * @param {string} weighting
*/ */
set weighting(weighting) { set weighting(weighting) {
if (this.initialized && typeof this.id === 'undefined') { if (this.initialized && this.#id === '') {
throw new ValidationError( throw new ValidationError(
scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED); scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED);
} else { } else {
@@ -889,8 +889,7 @@ export class CMIInteractionsObject extends BaseCMI {
* @param {string} learner_response * @param {string} learner_response
*/ */
set learner_response(learner_response) { set learner_response(learner_response) {
if (this.initialized && (typeof this.type === 'undefined' || if (this.initialized && (this.#type === '' || this.#id === '')) {
typeof this.id === 'undefined')) {
throw new ValidationError( throw new ValidationError(
scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED); scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED);
} else { } else {
@@ -975,7 +974,7 @@ export class CMIInteractionsObject extends BaseCMI {
* @param {string} latency * @param {string} latency
*/ */
set latency(latency) { set latency(latency) {
if (this.initialized && typeof this.id === 'undefined') { if (this.initialized && this.#id === '') {
throw new ValidationError( throw new ValidationError(
scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED); scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED);
} else { } else {
@@ -998,7 +997,7 @@ export class CMIInteractionsObject extends BaseCMI {
* @param {string} description * @param {string} description
*/ */
set description(description) { set description(description) {
if (this.initialized && typeof this.id === 'undefined') { if (this.initialized && this.#id === '') {
throw new ValidationError( throw new ValidationError(
scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED); scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED);
} else { } else {
@@ -1104,7 +1103,7 @@ export class CMIObjectivesObject extends BaseCMI {
* @param {string} success_status * @param {string} success_status
*/ */
set success_status(success_status) { set success_status(success_status) {
if (this.initialized && typeof this.id === 'undefined') { if (this.initialized && this.#id === '') {
throw new ValidationError( throw new ValidationError(
scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED); scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED);
} else { } else {
@@ -1127,7 +1126,7 @@ export class CMIObjectivesObject extends BaseCMI {
* @param {string} completion_status * @param {string} completion_status
*/ */
set completion_status(completion_status) { set completion_status(completion_status) {
if (this.initialized && typeof this.id === 'undefined') { if (this.initialized && this.#id === '') {
throw new ValidationError( throw new ValidationError(
scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED); scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED);
} else { } else {
@@ -1150,7 +1149,7 @@ export class CMIObjectivesObject extends BaseCMI {
* @param {string} progress_measure * @param {string} progress_measure
*/ */
set progress_measure(progress_measure) { set progress_measure(progress_measure) {
if (this.initialized && typeof this.id === 'undefined') { if (this.initialized && this.#id === '') {
throw new ValidationError( throw new ValidationError(
scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED); scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED);
} else { } else {
@@ -1175,7 +1174,7 @@ export class CMIObjectivesObject extends BaseCMI {
* @param {string} description * @param {string} description
*/ */
set description(description) { set description(description) {
if (this.initialized && typeof this.id === 'undefined') { if (this.initialized && this.#id === '') {
throw new ValidationError( throw new ValidationError(
scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED); scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED);
} else { } else {

131
test/Scorm2004API.spec.js
View File

@@ -17,9 +17,7 @@ const api = (settings = {}, startingData = {}) => {
}; };
const apiInitialized = (startingData) => { const apiInitialized = (startingData) => {
const API = api(); const API = api();
if (startingData) { API.loadFromJSON(startingData, '');
API.startingData = startingData;
}
API.lmsInitialize(); API.lmsInitialize();
return API; return API;
}; };
@@ -299,61 +297,151 @@ describe('SCORM 2004 API Tests', () => {
it('should allow cmi.interactions.0.correct_responses.0.pattern to be set - T/F', it('should allow cmi.interactions.0.correct_responses.0.pattern to be set - T/F',
() => { () => {
const scorm2004API = apiInitialized(); const scorm2004API = apiInitialized();
scorm2004API.setCMIValue('cmi.interactions.0.id',
'Scene1_Slide3_MultiChoice_0_0');
scorm2004API.setCMIValue('cmi.interactions.0.type', 'true-false'); scorm2004API.setCMIValue('cmi.interactions.0.type', 'true-false');
scorm2004API.setCMIValue('cmi.interactions.0.correct_responses.0.pattern', 'true'); scorm2004API.setCMIValue(
'cmi.interactions.0.correct_responses.0.pattern', 'true');
expect( expect(
String(scorm2004API.lmsGetLastError()) String(scorm2004API.lmsGetLastError()),
).to.equal(String(0)); ).to.equal(String(0));
}); });
it('should allow cmi.interactions.10.correct_responses.0.pattern to be set - T/F', it('should allow cmi.interactions.10.correct_responses.0.pattern to be set - T/F',
() => { () => {
const scorm2004API = apiInitialized(); const scorm2004API = apiInitialized();
scorm2004API.setCMIValue('cmi.interactions.0.id',
'Scene1_Slide3_MultiChoice_0_0');
scorm2004API.setCMIValue('cmi.interactions.0.type', 'true-false'); scorm2004API.setCMIValue('cmi.interactions.0.type', 'true-false');
scorm2004API.setCMIValue('cmi.interactions.0.correct_responses.0.pattern', 'true'); scorm2004API.setCMIValue(
'cmi.interactions.0.correct_responses.0.pattern', 'true');
expect( expect(
String(scorm2004API.lmsGetLastError()) String(scorm2004API.lmsGetLastError()),
).to.equal(String(0)); ).to.equal(String(0));
}); });
it('should allow cmi.interactions.0.correct_responses.0.pattern to be set - choice', it('should allow cmi.interactions.0.correct_responses.0.pattern to be set - choice',
() => { () => {
const scorm2004API = apiInitialized(); const scorm2004API = apiInitialized();
scorm2004API.setCMIValue('cmi.interactions.0.id', 'Scene1_Slide3_MultiChoice_0_0'); scorm2004API.setCMIValue('cmi.interactions.0.id',
'Scene1_Slide3_MultiChoice_0_0');
scorm2004API.setCMIValue('cmi.interactions.0.type', 'choice'); scorm2004API.setCMIValue('cmi.interactions.0.type', 'choice');
scorm2004API.setCMIValue('cmi.interactions.0.correct_responses.0.pattern', 'VP_on-call_or_President'); scorm2004API.setCMIValue(
'cmi.interactions.0.correct_responses.0.pattern',
'VP_on-call_or_President');
expect( expect(
String(scorm2004API.lmsGetLastError()) String(scorm2004API.lmsGetLastError()),
).to.equal(String(0)); ).to.equal(String(0));
}); });
it('should allow cmi.interactions.0.objectives.0.id to be set', it('should allow cmi.interactions.0.objectives.0.id to be set',
() => { () => {
const scorm2004API = apiInitialized(); const scorm2004API = apiInitialized();
scorm2004API.setCMIValue('cmi.interactions.0.objectives.0.id', 'ID of the Obj - ID 2'); scorm2004API.setCMIValue('cmi.interactions.0.objectives.0.id',
'ID of the Obj - ID 2');
expect( expect(
String(scorm2004API.lmsGetLastError()) String(scorm2004API.lmsGetLastError()),
).to.equal(String(0)); ).to.equal(String(0));
}); });
it('should allow cmi.interactions.0.learner_response to be set', it('should allow cmi.interactions.0.learner_response to be set',
() => { () => {
const scorm2004API = apiInitialized(); const scorm2004API = apiInitialized();
scorm2004API.setCMIValue('cmi.interactions.0.id', 'Scene1_Slide3_MultiChoice_0_0'); scorm2004API.setCMIValue('cmi.interactions.0.id',
'Scene1_Slide3_MultiChoice_0_0');
scorm2004API.setCMIValue('cmi.interactions.0.type', 'choice'); scorm2004API.setCMIValue('cmi.interactions.0.type', 'choice');
scorm2004API.setCMIValue('cmi.interactions.0.learner_response', 'VP_on-call_or_President'); scorm2004API.setCMIValue('cmi.interactions.0.learner_response',
'VP_on-call_or_President');
expect( expect(
String(scorm2004API.lmsGetLastError()) String(scorm2004API.lmsGetLastError()),
).to.equal(String(0)); ).to.equal(String(0));
expect( expect(
scorm2004API.getCMIValue('cmi.interactions.0.id') scorm2004API.getCMIValue('cmi.interactions.0.id'),
).to.equal('Scene1_Slide3_MultiChoice_0_0'); ).to.equal('Scene1_Slide3_MultiChoice_0_0');
expect( expect(
scorm2004API.getCMIValue('cmi.interactions.0.type') scorm2004API.getCMIValue('cmi.interactions.0.type'),
).to.equal('choice'); ).to.equal('choice');
expect( expect(
scorm2004API.getCMIValue('cmi.interactions.0.learner_response') scorm2004API.getCMIValue('cmi.interactions.0.learner_response'),
).to.equal('VP_on-call_or_President'); ).to.equal('VP_on-call_or_President');
}); });
}); });
describe('Initialized - Should Fail', () => { describe('Initialized - Should Fail', () => {
h.checkLMSSetValue({
api: apiInitialized(
{cmi: {interactions: {'0': {id: 'interaction-id-1'}}}}),
fieldName: 'cmi.interactions.0.type',
valueToTest: 'unknown',
errorThrown: false,
expectedError: scorm2004_error_codes.TYPE_MISMATCH,
});
h.checkLMSSetValue({
api: apiInitialized(),
fieldName: 'cmi.interactions.0.type',
valueToTest: 'true-false',
errorThrown: false,
expectedError: scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED,
});
h.checkLMSSetValue({
api: apiInitialized(),
fieldName: 'cmi.interactions.0.description',
valueToTest: 'this is an interaction',
errorThrown: false,
expectedError: scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED,
});
h.checkLMSSetValue({
api: apiInitialized(),
fieldName: 'cmi.interactions.0.timestamp',
valueToTest: 'PT1S',
errorThrown: false,
expectedError: scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED,
});
h.checkLMSSetValue({
api: apiInitialized(),
fieldName: 'cmi.interactions.0.weighting',
valueToTest: 1.0,
errorThrown: false,
expectedError: scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED,
});
h.checkLMSSetValue({
api: apiInitialized(),
fieldName: 'cmi.interactions.0.learner_response',
valueToTest: 'true',
errorThrown: false,
expectedError: scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED,
});
h.checkLMSSetValue({
api: apiInitialized(),
fieldName: 'cmi.interactions.0.latency',
valueToTest: 'PT1S',
errorThrown: false,
expectedError: scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED,
});
h.checkLMSSetValue({
api: apiInitialized(),
fieldName: 'cmi.objectives.0.success_status',
valueToTest: 'passed',
errorThrown: false,
expectedError: scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED,
});
h.checkLMSSetValue({
api: apiInitialized(),
fieldName: 'cmi.objectives.0.completion_status',
valueToTest: 'completed',
errorThrown: false,
expectedError: scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED,
});
h.checkLMSSetValue({
api: apiInitialized(),
fieldName: 'cmi.objectives.0.progress_measure',
valueToTest: 1.0,
errorThrown: false,
expectedError: scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED,
});
h.checkLMSSetValue({
api: apiInitialized(),
fieldName: 'cmi.objectives.0.description',
valueToTest: 'this is an objective',
errorThrown: false,
expectedError: scorm2004_error_codes.DEPENDENCY_NOT_ESTABLISHED,
});
h.checkLMSSetValue({ h.checkLMSSetValue({
api: apiInitialized(), api: apiInitialized(),
fieldName: 'cmi.comments_from_lms.0.comment', fieldName: 'cmi.comments_from_lms.0.comment',
@@ -375,6 +463,13 @@ describe('SCORM 2004 API Tests', () => {
errorThrown: false, errorThrown: false,
expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT, expectedError: scorm2004_error_codes.READ_ONLY_ELEMENT,
}); });
h.checkLMSSetValue({
api: apiInitialized(),
fieldName: 'cmi.unknown',
valueToTest: 'uknown',
errorThrown: false,
expectedError: scorm2004_error_codes.UNDEFINED_DATA_MODEL,
});
}); });
}); });