@oat-sa/tao-test-runner-qti/dist/navigator/navigator.js

TAO Test Runner QTI implementation

define(['lodash', 'taoQtiTest/runner/helpers/map', 'taoQtiTest/runner/helpers/testContextBuilder'], function (_, mapHelper, testContextBuilder) { 'use strict';

    _ = _ && Object.prototype.hasOwnProperty.call(_, 'default') ? _['default'] : _;
    mapHelper = mapHelper && Object.prototype.hasOwnProperty.call(mapHelper, 'default') ? mapHelper['default'] : mapHelper;
    testContextBuilder = testContextBuilder && Object.prototype.hasOwnProperty.call(testContextBuilder, 'default') ? testContextBuilder['default'] : testContextBuilder;

    /**
     * This program is free software; you can redistribute it and/or
     * modify it under the terms of the GNU General Public License
     * as published by the Free Software Foundation; under version 2
     * of the License (non-upgradable).
     *
     * This program is distributed in the hope that it will be useful,
     * but WITHOUT ANY WARRANTY; without even the implied warranty of
     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     * GNU General Public License for more details.
     *
     * You should have received a copy of the GNU General Public License
     * along with this program; if not, write to the Free Software
     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
     *
     * Copyright (c) 2017 (original work) Open Assessment Technologies SA ;
     */

    /**
     * Gives you a navigator
     * @param {Object} testContext
     * @param {Object} testMap
     * @returns {Object} the navigator
     * @throws {TypeError} if the given parameters aren't objects
     */
    var navigatorFactory = function navigatorFactory(testContext, testMap) {
      if (![testContext, testMap].every(_.isPlainObject)) {
        throw new TypeError('The navigator must be built with a testData, a testContext and a testMap');
      }
      return {
        /**
         * Selects and execute the navigation method based on the direction/scope.
         *
         * @param {String} direction - the move direction (next, previous or jump)
         * @param {String} scope - the move scope (item, section, testPart)
         * @param {Number} [position] - the position in case of jump
         * @returns {Object|Boolean} - false if we can't navigate, otherwise the result of the nav
         */
        navigate: function navigate(direction, scope, position) {
          var methodName = direction.toLowerCase() + scope.substr(0, 1).toUpperCase() + scope.substr(1).toLowerCase();
          if (_.isFunction(this[methodName])) {
            return this[methodName](position);
          }
        },
        /**
         * Navigate to the next item
         * @returns {Object} the new test context
         */
        nextItem: function nextItem() {
          return testContextBuilder.buildTestContextFromPosition(testContext, testMap, testContext.itemPosition + 1);
        },
        /**
         * Navigate to the next item
         * @returns {Object} the new test context
         */
        previousItem: function previsousItem() {
          return testContextBuilder.buildTestContextFromPosition(testContext, testMap, testContext.itemPosition - 1);
        },
        /**
         * Navigate to the next item
         * @returns {Object} the new test context
         */
        nextSection: function nextSection() {
          var sectionStats = mapHelper.getSectionStats(testMap, testContext.sectionId);
          var section = mapHelper.getSection(testMap, testContext.sectionId);
          return testContextBuilder.buildTestContextFromPosition(testContext, testMap, section.position + sectionStats.total);
        },
        /**
         * Navigate to the given position
         * @param {Number} position - the position
         * @returns {Object} the new test context
         */
        jumpItem: function jumpItem(position) {
          return testContextBuilder.buildTestContextFromPosition(testContext, testMap, position);
        }
      };
    };

    return navigatorFactory;

});