feat: data shape update and mock data paths

Author: muselesscreator

src/data/services/lms/fakeData/dataStates.js

@@ -0,0 +1,67 @@
+import { StrictDict } from '@edx/react-unit-test-utils';
+import oraConfig from './oraConfig';
+import pageData from './pageData';
+
+export const viewKeys = StrictDict({
+  xblock: 'xblock',
+  submission: 'submission',
+  training: 'student_training',
+  self: 'self_assessment',
+  peer: 'peer_assessment',
+  myGrades: 'my_grades',
+});
+
+export const progressKeys = StrictDict({
+  unsaved: 'unsaved',
+  saved: 'saved',
+  training: 'training',
+  self: 'self',
+  peer: 'peer',
+  peerWaiting: 'peerWaiting',
+  staff: 'staff',
+  graded: 'graded',
+});
+
+export const progressStates = {
+  unsaved: pageData.progressStates.submission,
+  saved: pageData.progressStates.submission,
+  training: pageData.progressStates.training(0),
+  self: pageData.progressStates.self,
+  peer: pageData.progressStates.peer(),
+  peerWaiting: pageData.progressStates.peer({ numCompleted: 1, isWaiting: true }),
+  staff: pageData.progressStates.staff,
+  graded: pageData.progressStates.graded,
+};
+
+export const submissionStatesByView = {
+  [viewKeys.xblock]: null,
+  [viewKeys.submission]: pageData.submissionStates.individualSubmission,
+  [viewKeys.self]: pageData.submissionStates.individualSubmission,
+  [viewKeys.training]: pageData.submissionStates.individualSubmission,
+  [viewKeys.peer]: pageData.submissionStates.individualSubmission,
+  [viewKeys.myGrades]: pageData.submissionStates.individualSubmission,
+};
+
+export const assessmentStatesByView = {
+  [viewKeys.xblock]: null,
+  [viewKeys.submission]: null,
+  [viewKeys.self]: null,
+  [viewKeys.training]: null,
+  [viewKeys.peer]: null,
+  [viewKeys.myGrades]: {
+    effectiveAssessmentType: 'staff',
+    ...pageData.assessmentStates.graded,
+  },
+};
+
+export const loadState = ({ view, progressKey }) => {
+  const state = {
+    progress: progressStates[progressKey],
+    submission: submissionStatesByView[view],
+    assessment: assessmentStatesByView[view],
+  };
+  if (view === viewKeys.submission && progressKey === progressKeys.unsaved) {
+    state.submission = pageData.submissionStates.emptySubmission;
+  }
+  return state;
+};

src/data/services/lms/fakeData/pageData/assessments.js

@@ -0,0 +1,66 @@
+/* eslint-disable camelcase */
+
+export const createAssessmentState = ({
+  options_selected = [],
+  criterion_feedback,
+  overall_feedback = '',
+}) => ({
+  options_selected,
+  criterion_feedback,
+  overall_feedback,
+});
+
+export const emptySelections = {
+  'Criterion 1 name': null,
+  'Criterion 2 name': null,
+  'Criterion 3 name': null,
+  'Criterion 4 name': null,
+};
+export const filledSelections = {
+  'Criterion 1 name': 'Option 4 name',
+  'Criterion 2 name': 'Option 3 name',
+  'Criterion 3 name': 'Option 2 name',
+  'Criterion 4 name': 'Option 1 name',
+};
+
+const gradedState = createAssessmentState({
+  options_selected: filledSelections,
+  criterion_feedback: {
+    'Criterion 1 name': 'feedback 1',
+    'Criterion 2 name': 'feedback 2',
+    'Criterion 3 name': 'feedback 3',
+    'Criterion 4 name': 'feedback 4',
+  },
+  overall_feedback: 'nice job',
+});
+
+export default {
+  graded: {
+    staff: {
+      stepScore: { earned: 10, possible: 10 },
+      assessment: gradedState,
+    },
+    peer: {
+      stepScore: { earned: 10, possible: 10 },
+      assessment: [
+        gradedState,
+        gradedState,
+        gradedState,
+        gradedState,
+        gradedState,
+      ],
+    },
+    peerUnweighted: {
+      stepScore: null,
+      assessment: [
+        gradedState,
+        gradedState,
+        gradedState,
+      ],
+    },
+    self: {
+      stepScore: { earned: 10, possible: 10 },
+      assessment: gradedState,
+    },
+  },
+};

src/data/services/lms/fakeData/pageData/index.jsx

@@ -1,25 +1,9 @@
 import progressStates from './progress';
-import rubricStates from './rubric';
+import assessmentStates from './assessments';
 import submissionStates from './submission';
 
-export const emptySubmission = {
-  progress: progressStates.submission,
-  rubric: rubricStates.criteriaFeedbackEnabled.empty,
-  submission: submissionStates.individialSubmission,
-};
-
-export const peerAssessment = {
-  progress: progressStates.peer(),
-  rubric: rubricStates.criteriaFeedbackEnabled.filled,
-  submission: submissionStates.individialSubmission,
-};
-
 export default {
   progressStates,
-  rubricStates,
+  assessmentStates,
   submissionStates,
-  shapes: {
-    emptySubmission,
-    peerAssessment,
-  },
 };

src/data/services/lms/fakeData/pageData/rubric.js

@@ -1,4 +1,5 @@
 /* eslint-disable camelcase */
+import { StrictDict } from '@edx/react-unit-test-utils';
 
 /// Submission
 export const createFiles = (numFiles) => Array.from(Array(numFiles)).map((_, i) => ({
@@ -53,7 +54,7 @@ export const createSubmission = ({
 
 // Rubric
 
-export default {
+export default StrictDict({
   emptySubmission: createSubmission({
     teamInfo: {},
     submissionStatus: createSubmissionStatus({
@@ -62,14 +63,14 @@ export default {
       has_received_grade: false,
     }),
     response: createSubmissionResponse({
-      text_responses: ['response 1', 'response 2'],
+      text_responses: ['', ''],
       uploaded_files: [],
     }),
   }),
-  individialSubmission: createSubmission({
+  individualSubmission: createSubmission({
     team_info: {},
     submission_status: createSubmissionStatus(),
     response: createSubmissionResponse(),
   }),
   teamSubmission: createSubmission(),
-};
+});

src/data/services/lms/fakeData/pageData/submission.js

@@ -1,3 +1,4 @@
+// Progress data
 export interface ReceivedGradeData {
   earned: number,
   possible: number,
@@ -33,6 +34,7 @@ export interface ProgressData {
   activeStepInfo: ActiveStepInfo,
 }
 
+// Submission Data
 export interface SubmissionStatusData {
   hasSubmitted: boolean,
   hasCancelled: boolean,
@@ -66,14 +68,37 @@ export interface SubmissionData extends SubmissionStatusData {
   response: SubmissionResponseData,
 }
 
-export interface RubricData {
+// Assessments Data
+export interface AssessmentData {
   optionsSelected: { [key: string]: string | null },
   criterionFeedback: { [key: string]: string },
   overallFeedback: string | null,
 }
 
+export interface AssessmentsData {
+  effectiveAssessmentType: 'staff' | 'peer' | 'self',
+  assessments: {
+    staff?: {
+      stepScore: { earned: number, possible: number },
+      assessment: AssessmentData,
+    },
+    peer?: {
+      stepScore: { earned: number, possible: number },
+      assessments: AssessmentData[],
+    },
+    peerUnweighted?: {
+      stepScore: null,
+      assessmenst: AssessmentData[],
+    },
+    self?: {
+      stepScore: { earned: number, possible: number },
+      assessment: AssessmentData,
+    },
+  },
+}
+
 export interface PageData {
   progress: ProgressData,
   submission: SubmissionData,
-  rubric: RubricData,
+  assessments: AssessmentsData
 }