feat(Metadata): Add parsed numeric response (#590 - [LL-255](https://learningpool.atlassian.net/browse/LL-255))

https://learningpool.atlassian.net/browse/LL-255
#590

Author: PrinceWaune

src/apps/statements/service/storeStatements/queriables/getMetadataFromStatement/getNumericQuestionMetadata.ts

@@ -0,0 +1,33 @@
+import { get, has } from 'lodash';
+
+import ActivityInteractionType from '../../../../models/ActivityInteractionType';
+import Statement from '../../../../models/Statement';
+
+export const getNumericQuestionMetadata = (statement: Statement)
+  : {readonly [key: string]: any} => {
+  if (
+    !(
+      get(
+        statement.object,
+        ['definition', 'interactionType'],
+      ) === ActivityInteractionType.NUMERIC
+      && has(statement, ['result', 'response'])
+    )
+  ) {
+    return {};
+  }
+
+  const numericQuestionString = get(statement, ['result', 'response']);
+
+  if (!numericQuestionString.includes('[:]')) {
+    return {'https://learninglocker&46;net/numeric-response': parseFloat(numericQuestionString)};
+  }
+
+  const [min, max] = numericQuestionString.split('[:]');
+  return {
+    'https://learninglocker&46;net/numeric-response': {
+      min,
+      max,
+    },
+  };
+};

src/apps/statements/service/storeStatements/queriables/getMetadataFromStatement/index.ts

@@ -4,6 +4,7 @@ import { getChoiceQuestionMetadata } from './getChoiceQuestionMetadata';
 import { getDurationMetadata } from './getDurationMetadata';
 import { getLikertMetadata } from './getLikertMetadata';
 import { getMatchingQuestionsMetadata } from './getMatchingQuestionsMetadata';
+import { getNumericQuestionMetadata } from './getNumericQuestionMetadata';
 import { getSequencingMetadata } from './getSequencingMetadata';
 
 export default (statement: Statement): { readonly [key: string]: any } => {
@@ -13,10 +14,12 @@ export default (statement: Statement): { readonly [key: string]: any } => {
   const choicesMetadata = getChoiceQuestionMetadata(statement);
   const matchingMetadata = getMatchingQuestionsMetadata(statement);
   const booleanMetadata = getBooleanMetadata(statement);
+  const numericQuestionMetadata = getNumericQuestionMetadata(statement);
 
   return {
     ...durationMetadata,
     ...sequencingMetadata,
+    ...numericQuestionMetadata,
     ...choicesMetadata,
     ...matchingMetadata,
     ...booleanMetadata,

src/apps/statements/tests/storingStatements/queriables/getMetadataFromStatement/fixtures/numeric-question-interaction.fixture.ts

@@ -0,0 +1,46 @@
+import ActivityInteractionType from '../../../../../models/ActivityInteractionType';
+import InteractionActivityDefinition from '../../../../../models/InteractionActivityDefinition';
+import Statement from '../../../../../models/Statement';
+import SubStatementObject from '../../../../../models/SubStatementObject';
+import { statementDefaults } from './statements.fixture';
+
+const numericQuestionInteractionActivityStatement: Statement = {
+  ...statementDefaults,
+  ...{
+    result: {
+      response: '4:',
+    },
+    object: {
+      definition: {
+        name: {'en-US': 'Question 7'},
+        description: {'en-US': 'How many jokes is Chris the butt of each day?'},
+        type: 'http://adlnet.gov/expapi/activities/cmi.interaction',
+        interactionType: ActivityInteractionType.NUMERIC,
+        correctResponsesPattern: ['4:'],
+      } as Partial<InteractionActivityDefinition>,
+    } as SubStatementObject,
+  } as Partial<Statement>,
+};
+
+const numericQuestionWithMinAndMaxInteractionActivityStatement: Statement = {
+  ...statementDefaults,
+  ...{
+    result: {
+      response: '4[:]5',
+    },
+    object: {
+      definition: {
+        name: {'en-US': 'Question 7'},
+        description: {'en-US': 'How many jokes is Chris the butt of each day?'},
+        type: 'http://adlnet.gov/expapi/activities/cmi.interaction',
+        interactionType: ActivityInteractionType.NUMERIC,
+        correctResponsesPattern: ['4[:]5'],
+      } as Partial<InteractionActivityDefinition>,
+    } as SubStatementObject,
+  } as Partial<Statement>,
+};
+
+export {
+  numericQuestionInteractionActivityStatement,
+  numericQuestionWithMinAndMaxInteractionActivityStatement,
+};

src/apps/statements/tests/storingStatements/queriables/getMetadataFromStatement/getNumericQuestionMetadata.test.ts

@@ -0,0 +1,49 @@
+import * as assert from 'assert';
+
+import { getNumericQuestionMetadata } from '../../../../service/storeStatements/queriables/getMetadataFromStatement/getNumericQuestionMetadata';
+import {
+  numericQuestionInteractionActivityStatement as statementFixture,
+  numericQuestionWithMinAndMaxInteractionActivityStatement as statementWithMinAndMaxFixture,
+} from './fixtures/numeric-question-interaction.fixture';
+
+describe('Retrieve numeric question metadata from statement', () => {
+  it('should return empty metadata from empty result', () => {
+    const expectedEmptyMetadata = {};
+
+    const actualEmptyMetadataFromEmptyResult = getNumericQuestionMetadata(
+      {
+        ...statementFixture,
+        ...{
+          result: {},
+        },
+      },
+    );
+
+    assert.deepEqual(actualEmptyMetadataFromEmptyResult, expectedEmptyMetadata);
+  });
+
+  it('should return numeric question for correct result', () => {
+    const actualCorrectMetadata = getNumericQuestionMetadata(
+      statementFixture,
+    );
+    const expectedCorrectMetadata = {
+      'https://learninglocker&46;net/numeric-response': 4,
+    };
+
+    assert.deepEqual(actualCorrectMetadata, expectedCorrectMetadata);
+  });
+
+  it('should return numeric question with min and max values for correct result', () => {
+    const actualCorrectMetadata = getNumericQuestionMetadata(
+      statementWithMinAndMaxFixture,
+    );
+    const expectedCorrectMetadata = {
+      'https://learninglocker&46;net/numeric-response': {
+        min: 4,
+        max: 5,
+      },
+    };
+
+    assert.deepEqual(actualCorrectMetadata, expectedCorrectMetadata);
+  });
+});

yarn.lock

@@ -34,9 +34,10 @@
   dependencies:
     "@babel/highlight" "^7.8.3"
 
-"@babel/highlight@^7.8.0":
-  version "7.8.0"
-  resolved "https://registry.yarnpkg.com/@babel/highlight/-/highlight-7.8.0.tgz#4cc003dc10359919e2e3a1d9459150942913dd1a"
+"@babel/highlight@^7.8.3":
+  version "7.8.3"
+  resolved "https://registry.yarnpkg.com/@babel/highlight/-/highlight-7.8.3.tgz#28f173d04223eaaa59bc1d439a3836e6d1265797"
+  integrity sha512-PX4y5xQUvy0fnEVHrYOarRPXVWafSjTW9T0Hab8gVIawpl2Sj0ORyrygANq+KjcNlSSTw0YCLSNA8OyZ1I4yEg==
   dependencies:
     chalk "^2.0.0"
     esutils "^2.0.2"
@@ -3130,9 +3131,10 @@ [email protected]:
   resolved "https://registry.yarnpkg.com/eyes/-/eyes-0.1.8.tgz#62cf120234c683785d902348a800ef3e0cc20bc0"
   integrity sha1-Ys8SAjTGg3hdkCNIqADvPgzCC8A=
 
-fast-deep-equal@^2.0.1:
-  version "2.0.1"
-  resolved "https://registry.yarnpkg.com/fast-deep-equal/-/fast-deep-equal-2.0.1.tgz#7b05218ddf9667bf7f370bf7fdb2cb15fdd0aa49"
+fast-deep-equal@^3.1.1:
+  version "3.1.1"
+  resolved "https://registry.yarnpkg.com/fast-deep-equal/-/fast-deep-equal-3.1.1.tgz#545145077c501491e33b15ec408c294376e94ae4"
+  integrity sha512-8UEa58QDLauDNfpbrX55Q9jrGHThw2ZMdOky5Gl1CDtVeJDPVrG4Jxx1N8jw2gkWaff5UUuX1KJd+9zGe2B+ZA==
 
 fast-glob@^3.0.3:
   version "3.2.0"