@instructure/quiz-core 17.19.2 → 17.20.0

package/lib/common/records/QtiImport.js

@@ -0,0 +1,63 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.QtiImport = void 0;
+
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+
+var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
+
+var _createSuper2 = _interopRequireDefault(require("@babel/runtime/helpers/createSuper"));
+
+var _reduxRecord = _interopRequireDefault(require("./reduxRecord.js"));
+
+var QtiImport = /*#__PURE__*/function (_ReduxRecord) {
+  (0, _inherits2.default)(QtiImport, _ReduxRecord);
+
+  var _super = (0, _createSuper2.default)(QtiImport);
+
+  function QtiImport() {
+    (0, _classCallCheck2.default)(this, QtiImport);
+    return _super.apply(this, arguments);
+  }
+
+  (0, _createClass2.default)(QtiImport, [{
+    key: "progressNumber",
+    value: function progressNumber() {
+      switch (this.status) {
+        case 'importing':
+          return this.progress;
+
+        case 'completed':
+          return 1.0;
+
+        default:
+          // Scheduled, failed
+          return 0.0;
+      }
+    }
+  }, {
+    key: "isImporting",
+    value: function isImporting() {
+      return this.status === 'importing';
+    }
+  }]);
+  return QtiImport;
+}((0, _reduxRecord.default)({
+  id: 0,
+  quizId: null,
+  status: null,
+  url: null,
+  message: null,
+  progress: 0.0
+}));
+
+exports.QtiImport = QtiImport;
+var _default = QtiImport;
+exports.default = _default;

package/lib/common/records/Quiz.js

@@ -0,0 +1,205 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.Quiz = void 0;
+
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+
+var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
+
+var _createSuper2 = _interopRequireDefault(require("@babel/runtime/helpers/createSuper"));
+
+var _applyDecoratedDescriptor2 = _interopRequireDefault(require("@babel/runtime/helpers/applyDecoratedDescriptor"));
+
+var _immutable = require("immutable");
+
+var _instructureValidations = require("instructure-validations");
+
+var _quizInteractions = require("@instructure/quiz-interactions");
+
+var _formatMessage = _interopRequireDefault(require("@instructure/quiz-i18n/es/format-message"));
+
+var _QuizAnalysis = _interopRequireDefault(require("./QuizAnalysis.js"));
+
+var _reduxRecord = _interopRequireDefault(require("./reduxRecord.js"));
+
+var _withStateCache = _interopRequireDefault(require("../util/withStateCache.js"));
+
+var _quizSessions = require("../selectors/quizSessions.js");
+
+var _quizzes = require("../selectors/quizzes.js");
+
+var _qtiImports = require("../selectors/qtiImports.js");
+
+var _reporting = require("../selectors/reporting.js");
+
+var _dec, _dec2, _dec3, _class;
+
+var Quiz = (_dec = (0, _withStateCache.default)(function (quiz) {
+  return [['quizEntries'], ['modifications', 'quizEntries']];
+}), _dec2 = (0, _withStateCache.default)(function (quiz) {
+  return [['quizEntries'], ['modifications', 'quizEntries'], ['modifications', 'quizzes', quiz.id, 'quizEntries']];
+}), _dec3 = (0, _withStateCache.default)(function (quiz) {
+  return [['modifications', 'quizzes']];
+}), (_class = /*#__PURE__*/function (_ReduxRecord) {
+  (0, _inherits2.default)(Quiz, _ReduxRecord);
+
+  var _super = (0, _createSuper2.default)(Quiz);
+
+  function Quiz() {
+    (0, _classCallCheck2.default)(this, Quiz);
+    return _super.apply(this, arguments);
+  }
+
+  (0, _createClass2.default)(Quiz, [{
+    key: "getTimeLimit",
+    value: function getTimeLimit() {
+      return this.hasTimeLimit ? this.sessionTimeLimitInSeconds : 0;
+    }
+  }, {
+    key: "getQuizSessions",
+    value: function getQuizSessions() {
+      var _this = this;
+
+      return this.getState().get('quizSessions').filter(function (data) {
+        return data.get('quiz') === _this.id;
+      }).map(function (qsd) {
+        return (0, _quizSessions.getQuizSessionById)(_this.getState(), qsd.get('id'));
+      }).valueSeq().toList();
+    }
+  }, {
+    key: "getQuizSessionsForUser",
+    value: function getQuizSessionsForUser(userId) {
+      return this.getQuizSessions().filter(function (quizSession) {
+        return quizSession.getIn(['user', 'id']) === userId;
+      });
+    }
+  }, {
+    key: "getQuizEntries",
+    value: function getQuizEntries() {
+      return (0, _quizzes.getQuizEntriesByIds)(this.getState(), this.quizEntries).sortBy(function (qe) {
+        return qe.position;
+      });
+    }
+  }, {
+    key: "hasQuestions",
+    value: function hasQuestions() {
+      return this.getQuizEntries().some(function (qe) {
+        return !qe.hasStimulus;
+      });
+    }
+  }, {
+    key: "getItemAnalyses",
+    value: function getItemAnalyses() {
+      // TODO: Sort this based on the ordering on the quiz build page
+      return (0, _reporting.getItemAnalysesByIds)(this.getState(), this.itemAnalyses);
+    }
+  }, {
+    key: "getQuizAnalysis",
+    value: function getQuizAnalysis() {
+      return new _QuizAnalysis.default(this.getState().getIn(['reporting', 'quiz_analysis', this.quizAnalysis]));
+    } // If you call this.getWorkingInstance().getQuizEntries() manually, then
+    // changes to the other parts of a quiz (e.g., changing the title) will
+    // invalidate the cache, since the result of getWorkingInstance() will
+    // be a new object. This method explicitly caches by only the fields that are
+    // relevant to the working quiz entries.
+
+  }, {
+    key: "getWorkingQuizEntries",
+    value: function getWorkingQuizEntries() {
+      return this.getWorkingInstance().getQuizEntries();
+    }
+  }, {
+    key: "getWorkingInstance",
+    value: function getWorkingInstance() {
+      var _this2 = this;
+
+      var modData = this.getState().getIn(['modifications', 'quizzes', this.id]) || (0, _immutable.Map)();
+      var data = this.merge(modData.update('quizEntries', (0, _immutable.List)(), // default
+      function (qi) {
+        // without custom merge, quizEntries List will be
+        // overwritten completely, and wouldnt' support
+        // temporary quizEntry associations well
+        return qi.concat(_this2.quizEntries.toJS());
+      }));
+      return Quiz.create(data, this.getState());
+    }
+  }, {
+    key: "getLatestImport",
+    value: function getLatestImport() {
+      return (0, _qtiImports.getLatestQtiImportForParentWithType)(this.getState(), this.id, 'Quiz');
+    }
+  }, {
+    key: "isLoaded",
+    value: function isLoaded() {
+      return this.id !== '0';
+    }
+  }, {
+    key: "isImporting",
+    value: function isImporting() {
+      return this.status === 'importing';
+    }
+  }, {
+    key: "canImport",
+    value: function canImport() {
+      // associating the quizEntry will change the quiz status in the
+      // db but it wont return this info, we we'll check the quizEntry
+      // count in addition to the status
+      return this.status === 'uninitialized' && this.quizEntries.size === 0;
+    }
+  }, {
+    key: "isOneQuestionAtATime",
+    value: function isOneQuestionAtATime() {
+      return this.oneAtATimeType === 'question';
+    }
+  }, {
+    key: "state",
+    value: function state() {
+      return this.getState();
+    }
+  }], [{
+    key: "validations",
+    value: function validations() {
+      return {
+        title: [(0, _instructureValidations.rule)('presence', {
+          message: (0, _quizInteractions.presenceMessage)((0, _formatMessage.default)('Quiz title'))
+        })]
+      };
+    }
+  }]);
+  return Quiz;
+}((0, _reduxRecord.default)({
+  allowBacktracking: true,
+  calculatorType: 'none',
+  contextId: null,
+  hasTimeLimit: false,
+  id: '0',
+  instructions: (0, _formatMessage.default)('Add Instructions...'),
+  itemAnalyses: (0, _immutable.List)(),
+  items: (0, _immutable.List)(),
+  oneAtATimeType: null,
+  outcomeAlignmentSetGuid: null,
+  owner: null,
+  quizAnalysis: '0',
+  quizEntries: (0, _immutable.List)(),
+  quizEntriesCount: 0,
+  requireStudentAccessCode: false,
+  sessionTimeLimitInSeconds: null,
+  shuffleAnswers: false,
+  shuffleQuestions: false,
+  status: null,
+  studentAccessCode: null,
+  title: (0, _formatMessage.default)('Add Title...'),
+  filterIpAddress: false,
+  filters: (0, _immutable.Map)(),
+  valid: true
+})), ((0, _applyDecoratedDescriptor2.default)(_class.prototype, "getQuizEntries", [_dec], Object.getOwnPropertyDescriptor(_class.prototype, "getQuizEntries"), _class.prototype), (0, _applyDecoratedDescriptor2.default)(_class.prototype, "getWorkingQuizEntries", [_dec2], Object.getOwnPropertyDescriptor(_class.prototype, "getWorkingQuizEntries"), _class.prototype), (0, _applyDecoratedDescriptor2.default)(_class.prototype, "getWorkingInstance", [_dec3], Object.getOwnPropertyDescriptor(_class.prototype, "getWorkingInstance"), _class.prototype)), _class));
+exports.Quiz = Quiz;
+var _default = Quiz;
+exports.default = _default;

package/lib/common/records/QuizAnalysis.js

@@ -0,0 +1,121 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.QuizAnalysis = void 0;
+
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+
+var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
+
+var _createSuper2 = _interopRequireDefault(require("@babel/runtime/helpers/createSuper"));
+
+var _reduxRecord = _interopRequireDefault(require("./reduxRecord.js"));
+
+var _formatMessage = _interopRequireDefault(require("@instructure/quiz-i18n/es/format-message"));
+
+var QuizAnalysis = /*#__PURE__*/function (_ReduxRecord) {
+  (0, _inherits2.default)(QuizAnalysis, _ReduxRecord);
+
+  var _super = (0, _createSuper2.default)(QuizAnalysis);
+
+  function QuizAnalysis() {
+    (0, _classCallCheck2.default)(this, QuizAnalysis);
+    return _super.apply(this, arguments);
+  }
+
+  (0, _createClass2.default)(QuizAnalysis, [{
+    key: "isLoaded",
+    value: function isLoaded() {
+      return this.quizId !== '0';
+    }
+  }, {
+    key: "isPresent",
+    value: function isPresent() {
+      return !this.notFound;
+    }
+  }, {
+    key: "scoreInfo",
+    value: function scoreInfo() {
+      return this.quizAnalysis.get('scoreInfo', {});
+    }
+  }, {
+    key: "pointsPossible",
+    value: function pointsPossible() {
+      return this.scoreInfo().get('pointsPossible') || 0;
+    }
+  }, {
+    key: "scoreCount",
+    value: function scoreCount() {
+      return this.scoreInfo().get('scoreCount') || 0;
+    }
+  }, {
+    key: "formatRatio",
+    value: function formatRatio(ratio) {
+      return isFinite(ratio) ? _formatMessage.default.number(ratio, 'percent') : '--';
+    }
+  }, {
+    key: "meanElapsedTime",
+    value: function meanElapsedTime() {
+      var scoreCount = this.scoreCount();
+      if (scoreCount === 0) return 0;
+      var elapsedTimeSum = this.scoreInfo().get('elapsedTimeSum') || 0;
+      return Math.round(elapsedTimeSum / scoreCount);
+    }
+  }, {
+    key: "meanScore",
+    value: function meanScore() {
+      var scoreSum = this.scoreInfo().get('scoreSum') || 0;
+      return this.formatRatio(scoreSum / this.scoreCount() / this.pointsPossible());
+    }
+  }, {
+    key: "highScore",
+    value: function highScore() {
+      var scoreMax = this.scoreInfo().get('scoreMax') || 0;
+      return this.formatRatio(scoreMax / this.pointsPossible());
+    }
+  }, {
+    key: "lowScore",
+    value: function lowScore() {
+      var scoreMin = this.scoreInfo().get('scoreMin') || 0;
+      return this.formatRatio(scoreMin / this.pointsPossible());
+    }
+  }, {
+    key: "standardDeviation",
+    value: function standardDeviation() {
+      var stdDeviation = this.scoreInfo().get('scoreStddevPop');
+      return isFinite(stdDeviation) ? _formatMessage.default.number(stdDeviation) : null;
+    }
+  }, {
+    key: "centileDistribution",
+    value: function centileDistribution() {
+      return this.quizAnalysis.get('centile').toArray();
+    }
+  }, {
+    key: "decileDistribution",
+    value: function decileDistribution() {
+      return this.quizAnalysis.get('decile').toArray();
+    }
+  }, {
+    key: "cronbachsAlpha",
+    value: function cronbachsAlpha() {
+      var alpha = this.quizAnalysis.get('cronbachsAlpha');
+      return isFinite(alpha) ? _formatMessage.default.number(alpha) : null;
+    }
+  }]);
+  return QuizAnalysis;
+}((0, _reduxRecord.default)({
+  quizId: '0',
+  quizAnalysis: null,
+  batchTimestamp: null,
+  notFound: false
+}));
+
+exports.QuizAnalysis = QuizAnalysis;
+var _default = QuizAnalysis;
+exports.default = _default;