jclic 2.2.1 → 2.3.0

package/src/bags/ActivitySequence.js

@@ -1,318 +0,0 @@
-/**
- *  File    : bags/ActivitySequence.js
- *  Created : 05/04/2015
- *  By      : Francesc Busquets <francesc@gmail.com>
- *
- *  JClic.js
- *  An HTML5 player of JClic activities
- *  https://projectestac.github.io/jclic.js
- *
- *  @source https://github.com/projectestac/jclic.js
- *
- *  @license EUPL-1.2
- *  @licstart
- *  (c) 2000-2020 Educational Telematic Network of Catalonia (XTEC)
- *
- *  Licensed under the EUPL, Version 1.1 or -as soon they will be approved by
- *  the European Commission- subsequent versions of the EUPL (the "Licence");
- *  You may not use this work except in compliance with the Licence.
- *
- *  You may obtain a copy of the Licence at:
- *  https://joinup.ec.europa.eu/software/page/eupl
- *
- *  Unless required by applicable law or agreed to in writing, software
- *  distributed under the Licence is distributed on an "AS IS" basis, WITHOUT
- *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- *  Licence for the specific language governing permissions and limitations
- *  under the Licence.
- *  @licend
- *  @module
- */
-
-import $ from 'jquery';
-import JumpInfo from './JumpInfo.js';
-import ActivitySequenceElement from './ActivitySequenceElement.js';
-import ActivitySequenceJump from './ActivitySequenceJump.js';
-import { nSlash } from '../Utils.js';
-
-/**
- * This class stores the definition of the sequence to follow to show the activities of a
- * {@link module:project/JClicProject.JClicProject JClicProject}. The sequence are formed by an ordered list of objects of type
- * {@link module:bags/ActivitySequenceElement.ActivitySequenceElement ActivitySequenceElement}.
- * It stores also a transient pointer to the current sequence element.
- */
-export class ActivitySequence {
-  /**
-   * ActivitySequence constructor
-   * @param {module:project/JClicProject.JClicProject} project - The JClic project to which this ActivitySequence belongs
-   */
-  constructor(project) {
-    this.project = project;
-    this.elements = [];
-  }
-
-  /**
-   * Loads the object settings from a specific JQuery XML element
-   * @param {external:jQuery} $xml - The XML element to parse
-   */
-  setProperties($xml) {
-    $xml.children('item').each((_i, data) => this.elements.push(new ActivitySequenceElement().setProperties($(data))));
-    return this;
-  }
-
-  /**
-   * Gets a object with the basic attributes needed to rebuild this instance excluding functions,
-   * parent references, constants and also attributes retaining the default value.
-   * The resulting object is commonly usued to serialize elements in JSON format.
-   * @returns {object} - The resulting object, with minimal attrributes
-   */
-  getAttributes() {
-    return this.elements.map(el => el.getAttributes());
-  }
-
-  /**
-   * Loads the object settings from a data object
-   * @param {object} data - The data object to parse
-   */
-  setAttributes(data) {
-    data.forEach(el => this.elements.push(new ActivitySequenceElement().setAttributes(el)));
-    return this;
-  }
-
-  /**
-   * Returns the index of the specified element in the sequence.
-   * @param {module:bags/ActivitySequenceElement.ActivitySequenceElement} ase - The element to search.
-   * @returns {number} - The requested index, or `null` if not found.
-   */
-  getElementIndex(ase) {
-    return ase === null ? -1 : this.elements.indexOf(ase);
-  }
-
-  /**
-   * Returns the nth element of the sequence.
-   * @param {number} n - Index of the requested element
-   * @param {boolean} updateCurrentAct - when `true`, the `currentAct` index will be updated.
-   * @returns {module:bags/ActivitySequenceElement.ActivitySequenceElement} - The requested element, or `null` if out of range.
-   */
-  getElement(n, updateCurrentAct) {
-    let result = null;
-    if (n >= 0 && n < this.elements.length) {
-      result = this.elements[n];
-      if (updateCurrentAct)
-        this.currentAct = n;
-    }
-    return result;
-  }
-
-  /**
-   * Search into the sequence for a element with the provided tag
-   * @param {string} tag - The tag to search
-   * @param {boolean} updateCurrentAct - when `true`, the `currentAct` index will be updated.
-   * @returns {module:bags/ActivitySequenceElement.ActivitySequenceElement} - The requested element, or `null` if not found.
-   */
-  getElementByTag(tag, updateCurrentAct) {
-    let
-      result = null,
-      resultIndex = -1;
-    if (tag) {
-      tag = nSlash(tag);
-      this.elements.some((el, index) => {
-        if (el.tag === tag) {
-          result = el;
-          resultIndex = index;
-        }
-        return resultIndex !== -1;
-      });
-      if (resultIndex !== -1 && updateCurrentAct)
-        this.currentAct = resultIndex;
-    }
-    return result;
-  }
-
-  /**
-   * Gets the sequence element pointed by the `currentAct` member.
-   * @returns {module:bags/ActivitySequenceElement.ActivitySequenceElement} - The current sequence element, or `null` if not set.
-   */
-  getCurrentAct() {
-    return this.getElement(this.currentAct, false);
-  }
-
-  /**
-   * Checks if it's possible to go forward from the current position in the sequence.
-   * @param {boolean} hasReturn - Indicates whether the history of jumps done since the beginning
-   * of the JClic session is empty or not. When not empty, a `RETURN` action is still possible.
-   * @returns {boolean} - `true` when the user is allowed to go ahead to a next activity,
-   * `false` otherwise. */
-  hasNextAct(hasReturn) {
-    let result = false;
-    const ase = this.getCurrentAct();
-    if (ase) {
-      if (ase.fwdJump === null)
-        result = true;
-      else
-        switch (ase.fwdJump.action) {
-          case 'STOP':
-            break;
-          case 'RETURN':
-            result = hasReturn;
-            break;
-          default:
-            result = true;
-        }
-    }
-    return result;
-  }
-
-  /**
-   * Checks if it's possible to go back from the current position in the sequence.
-   * @param {boolean} hasReturn - Indicates whether the history of jumps done since the beginning
-   * of the JClic session is empty or not. When not empty, a `RETURN` action is still possible.
-   * @returns {boolean} - `true` when the user is allowed to go back to a previous activity,
-   * `false` otherwise. */
-  hasPrevAct(hasReturn) {
-    let result = false;
-    const ase = this.getCurrentAct();
-    if (ase) {
-      if (ase.backJump === null)
-        result = true;
-      else
-        switch (ase.backJump.action) {
-          case 'STOP':
-            break;
-          case 'RETURN':
-            result = hasReturn;
-            break;
-          default:
-            result = true;
-        }
-    }
-    return result;
-  }
-
-  /**
-   * Gets the current state for the 'next' and 'prev' buttons.
-   * @returns {string} - One of the possible values of {@link module:bags/ActivitySequenceElement.ActivitySequenceElement#navButtons navButtons},
-   * thus: `none`, `fwd`, `back` or `both`
-   */
-  getNavButtonsFlag() {
-    let flag = 'none';
-    const ase = this.getCurrentAct();
-    if (ase)
-      flag = ase.navButtons;
-    return flag;
-  }
-
-  /**
-   * Computes the jump to perform from the current position on the sequence
-   * @param {boolean} back - When `true`, the request is for the 'go back' button. Otherwise, is
-   * for the 'next' one.
-   * @param {module:report/Reporter.Reporter} reporter - The reporting engine that will provide values about score average
-   * and time spend on the activities, used only to compute conditional jumps.
-   * @returns {module:bags/JumpInfo.JumpInfo} - The jump info if a valid jump is possible, `null` otherwise.
-   */
-  getJump(back, reporter) {
-    const ase = this.getCurrentAct();
-    let result = null;
-    if (ase) {
-      const asj = back ? ase.backJump : ase.fwdJump;
-      if (asj === null) {
-        let i = this.currentAct + (back ? -1 : 1);
-        if (i >= this.elements.length || i < 0)
-          i = 0;
-        result = new JumpInfo('JUMP', i);
-      } else {
-        let
-          rating = -1,
-          time = -1;
-        if (reporter !== null) {
-          const seqRegInfo = reporter.getCurrentSequenceInfo();
-          if (seqRegInfo !== null) {
-            rating = Math.round(seqRegInfo.tScore);
-            time = Math.round(seqRegInfo.tTime / 1000);
-          }
-        }
-        result = asj.resolveJump(rating, time);
-      }
-    }
-    return result;
-  }
-
-  /**
-   * Finds the nearest sequence element with a valid 'tag', looking back in the `elements` list.
-   * @param {number} num - The point of the sequence from which to start looking back.
-   * @returns {string} - The nearest 'tag', or `null` if not found.
-   */
-  getSequenceForElement(num) {
-    let tag = null;
-    if (num >= 0 && num < this.elements.length)
-      for (let i = num; tag === null && i >= 0; i--) {
-        tag = this.getElement(i, false).tag;
-      }
-    return tag;
-  }
-
-  /**
-   * Gets the first {@link module:bags/ActivitySequenceElement.ActivitySequenceElement ActivitySequenceElement} in the `elements` list pointing to the
-   * specified activity name.
-   * The search is always case-insensitive.
-   * @param {string} activity - The name of the activity to search for.
-   * @returns {module:bags/ActivitySequenceElement.ActivitySequenceElement} The requested element or `null` if not found.
-   */
-  getElementByActivityName(activity) {
-    let result = null;
-    if (activity !== null) {
-      for (let i = 0; result === null && i < this.elements.length; i++) {
-        const ase = this.getElement(i, false);
-        if (ase.activity.toLowerCase() === activity.toLowerCase())
-          result = ase;
-      }
-    }
-    return result;
-  }
-
-  /**
-   * Utility function to check if the current sequence element corresponds to the specified
-   * activity. If negative, the `currentAct` will be accordingly set.
-   * @param {string} activity - The name of the activity to check
-   */
-  checkCurrentActivity(activity) {
-    let ase = this.getCurrentAct();
-    if (ase === null || ase.activity.toUpperCase() !== activity.toUpperCase()) {
-      for (let i = 0; i < this.elements.length; i++) {
-        if (this.getElement(i, false).activity.toUpperCase() === activity.toUpperCase()) {
-          this.currentAct = i;
-          return false;
-        }
-      }
-      ase = new ActivitySequenceElement();
-      ase.activity = activity;
-      ase.fwdJump = new ActivitySequenceJump('STOP');
-      ase.backJump = new ActivitySequenceJump('STOP');
-      this.elements.push(ase);
-      this.currentAct = this.elements.length - 1;
-      return false;
-    }
-    return true;
-  }
-}
-
-Object.assign(ActivitySequence.prototype, {
-  /**
-   * The ordered list of {@link module:bags/ActivitySequenceElement.ActivitySequenceElement ActivitySequenceElement} objects
-   * @name module:bags/ActivitySequence.ActivitySequence#elements
-   * @type {module:bags/ActivitySequenceElement.ActivitySequenceElement[]} */
-  elements: null,
-  /**
-   * The JClic project to which this ActivitySequence belongs.
-   * @name module:bags/ActivitySequence.ActivitySequence#project
-   * @type {module:project/JClicProject.JClicProject} */
-  project: null,
-  /**
-   * Pointer to the {@link module:bags/ActivitySequenceElement.ActivitySequenceElement ActivitySequenceElement} currently running (points inside
-   * the `elements` array).
-   * @name module:bags/ActivitySequence.ActivitySequence#currentAct
-   * @type {number} */
-  currentAct: -1,
-});
-
-export default ActivitySequence;

package/src/bags/ActivitySequenceElement.js

@@ -1,161 +0,0 @@
-/**
- *  File    : bags/ActivitySequenceElement.js
- *  Created : 05/04/2015
- *  By      : Francesc Busquets <francesc@gmail.com>
- *
- *  JClic.js
- *  An HTML5 player of JClic activities
- *  https://projectestac.github.io/jclic.js
- *
- *  @source https://github.com/projectestac/jclic.js
- *
- *  @license EUPL-1.2
- *  @licstart
- *  (c) 2000-2020 Educational Telematic Network of Catalonia (XTEC)
- *
- *  Licensed under the EUPL, Version 1.1 or -as soon they will be approved by
- *  the European Commission- subsequent versions of the EUPL (the "Licence");
- *  You may not use this work except in compliance with the Licence.
- *
- *  You may obtain a copy of the Licence at:
- *  https://joinup.ec.europa.eu/software/page/eupl
- *
- *  Unless required by applicable law or agreed to in writing, software
- *  distributed under the Licence is distributed on an "AS IS" basis, WITHOUT
- *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- *  Licence for the specific language governing permissions and limitations
- *  under the Licence.
- *  @licend
- *  @module
- */
-
-import $ from 'jquery';
-import ActivitySequenceJump from './ActivitySequenceJump.js';
-import { attrForEach, nSlash, getAttr, isEmpty } from '../Utils.js';
-
-/**
- *
- * This class is the basic component of {@link module:bags/ActivitySequence.ActivitySequence ActivitySequence} objects. It represents a specific
- * point in the project's sequence of JClic activities.
- *
- * For each point of the sequence, some options can be set:
- * - What activity must run at this point
- * - What to do or where to jump when the activity finishes
- * - The behavior of the "next" button
- * - The behavior of the  "prev" button
- *
- * Sequence points can also have a "tag", used to refer to them with a unique name.
- */
-export class ActivitySequenceElement {
-  constructor() {
-  }
-
-  /**
-   * Loads the object settings from a specific JQuery XML element
-   * @param {external:jQuery} $xml
-   */
-  setProperties($xml) {
-
-    // Iterate on all provided attributes
-    attrForEach($xml.get(0).attributes, (name, val) => {
-      switch (name) {
-        case 'id':
-          this['tag'] = nSlash(val);
-          break;
-        case 'name':
-          this['activity'] = val;
-          break;
-        case 'description':
-        // possible navButtons values are: `none`, `fwd`, `back` or `both`
-        case 'navButtons':
-          this[name] = val;
-          break;
-        case 'delay':
-          this[name] = Number(val);
-          break;
-      }
-    });
-
-    // Iterate on 'jump' elements to load fwdJump and/or backJump
-    $xml.children('jump').each((_n, data) => {
-      const jmp = new ActivitySequenceJump().setProperties($(data));
-      if (jmp.id === 'forward')
-        this.fwdJump = jmp;
-      else if (jmp.id === 'back')
-        this.backJump = jmp;
-    });
-    return this;
-  }
-
-  /**
-   * Gets a object with the basic attributes needed to rebuild this instance excluding functions,
-   * parent references, constants and also attributes retaining the default value.
-   * The resulting object is commonly usued to serialize elements in JSON format.
-   * @returns {object} - The resulting object, with minimal attrributes
-   */
-  getAttributes() {
-    return getAttr(this, ['tag', 'description', 'activity', 'fwdJump', 'backJump', 'navButtons', 'delay']);
-  }
-
-  /**
-   * Loads sequence element settings from a data object
-   * @param {object} data
-   */
-  setAttributes(data) {
-    ['tag', 'description', 'activity', 'navButtons', 'delay'].forEach(t => {
-      if (!isEmpty(data[t]))
-        this[t] = data[t];
-    });
-
-    ['fwdJump', 'backJump'].forEach(jmp => {
-      if (data[jmp]) {
-        this[jmp] = new ActivitySequenceJump().setAttributes(data[jmp]);
-      }
-    });
-    return this;
-  }
-}
-
-Object.assign(ActivitySequenceElement.prototype, {
-  /**
-   * Optional unique identifier of this element in the {@link module:bags/ActivitySequence.ActivitySequence ActivitySequence}.
-   * @name module:bags/ActivitySequenceElement.ActivitySequenceElement#tag
-   * @type {string} */
-  tag: null,
-  /**
-   * Optional description of this sequence element.
-   * @name module:bags/ActivitySequenceElement.ActivitySequenceElement#description
-   * @type {string} */
-  description: null,
-  /**
-   * Name of the {@link module:Activity.Activity Activity} pointed by this element.
-   * @name module:bags/ActivitySequenceElement.ActivitySequenceElement#activity
-   * @type {string} */
-  activity: '',
-  /**
-   * Jump to be processed by the 'next' button action
-   * @name module:bags/ActivitySequenceElement.ActivitySequenceElement#fwdJump
-   * @type {module:bags/ActivitySequenceJump.ActivitySequenceJump} */
-  fwdJump: null,
-  /**
-   * Jump to be processed by the 'prev' button action.
-   * @name module:bags/ActivitySequenceElement.ActivitySequenceElement#backJump
-   * @type {module:bags/ActivitySequenceJump.ActivitySequenceJump} */
-  backJump: null,
-  /**
-   * What buttons should be active at this point of the sequence. Valid values are:
-   * - 'none'
-   * - 'fwd'
-   * - 'back'
-   * - 'both'
-   * @name module:bags/ActivitySequenceElement.ActivitySequenceElement#navButtons
-   * @type {string} */
-  navButtons: 'both',
-  /**
-   * Time delay (in seconds) before passing to the next/prev activity
-   * @name module:bags/ActivitySequenceElement.ActivitySequenceElement#delay
-   * @type {number} */
-  delay: 0,
-});
-
-export default ActivitySequenceElement;

package/src/bags/ActivitySequenceJump.js

@@ -1,140 +0,0 @@
-/**
- *  File    : bags/ActivitySequenceJump.js
- *  Created : 05/04/2015
- *  By      : Francesc Busquets <francesc@gmail.com>
- *
- *  JClic.js
- *  An HTML5 player of JClic activities
- *  https://projectestac.github.io/jclic.js
- *
- *  @source https://github.com/projectestac/jclic.js
- *
- *  @license EUPL-1.2
- *  @licstart
- *  (c) 2000-2020 Catalan Educational Telematic Network (XTEC)
- *
- *  Licensed under the EUPL, Version 1.1 or -as soon they will be approved by
- *  the European Commission- subsequent versions of the EUPL (the "Licence");
- *  You may not use this work except in compliance with the Licence.
- *
- *  You may obtain a copy of the Licence at:
- *  https://joinup.ec.europa.eu/software/page/eupl
- *
- *  Unless required by applicable law or agreed to in writing, software
- *  distributed under the Licence is distributed on an "AS IS" basis, WITHOUT
- *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- *  Licence for the specific language governing permissions and limitations
- *  under the Licence.
- *  @licend
- *  @module
- */
-
-import $ from 'jquery';
-import JumpInfo from './JumpInfo.js';
-import ConditionalJumpInfo from './ConditionalJumpInfo.js';
-import { getAttr } from '../Utils.js';
-
-/**
- * This is a special case of {@link module:bags/JumpInfo.JumpInfo JumpInfo}, used only in {@link module:bags/ActivitySequenceElement.ActivitySequenceElement ActivitySequenceElement} objects.
- * Sequence elements can contain up to two ActivitySequenceJump objects: one to be processed
- * when the user clicks on the "next" button (or when the activity finishes, if in automatic mode),
- * and the other used with the "prev" button. ActivitySequenceJump objects define a default jump
- * or action to be performed, but can also have up to two {@link module:bags/ConditionalJumpInfo.ConditionalJumpInfo ConditionalJumpInfo} objects. These
- * define alternative jumps that are performed only when score or time are below or over a specific
- * threshold.
- * @extends module:bags/JumpInfo.JumpInfo
- */
-export class ActivitySequenceJump extends JumpInfo {
-  /**
-   * ActivitySequenceJump constructor
-   * @param {string} action - Must be one of the described actions.
-   * @param {number|string} [sq] - Can be the tag of the sequence element to jump to, or its
-   * cardinal number in the list.
-   */
-  constructor(action, sq) {
-    super(action, sq);
-  }
-
-  /**
-   * Loads the object settings from a specific JQuery XML element.
-   * @param {external:jQuery} $xml - The XML element to parse
-   */
-  setProperties($xml) {
-    super.setProperties($xml);
-
-    // Read conditional jumps
-    $xml.children('jump').each((_n, child) => {
-      const condJmp = new ConditionalJumpInfo().setProperties($(child));
-      if (condJmp.id === 'upper')
-        this.upperJump = condJmp;
-      else if (condJmp.id === 'lower')
-        this.lowerJump = condJmp;
-    });
-    return this;
-  }
-
-  /**
-   * Gets a object with the basic attributes needed to rebuild this instance excluding functions,
-   * parent references, constants and also attributes retaining the default value.
-   * The resulting object is commonly usued to serialize elements in JSON format.
-   * @returns {object} - The resulting object, with minimal attrributes
-   */
-  getAttributes() {
-    return Object.assign(super.getAttributes(), getAttr(this, ['upperJump', 'lowerJump']));
-  }
-
-  /**
-    * Loads the jump settings from a data object
-    * @param {object} data - The data object to parse
-    */
-  setAttributes(data) {
-    super.setAttributes(data);
-
-    ['upperJump', 'lowerJump'].forEach(cj => {
-      if (data[cj])
-        this[cj] = new ConditionalJumpInfo().setAttributes(data[cj]);
-    });
-
-    return this;
-  }
-
-
-  /**
-   * Resolves what {@link module:bags/JumpInfo.JumpInfo JumpInfo} must be taken, based on a done time and average rating obtained
-   * in activities.
-   * @param {number} rating - Average rating obtained by the user in the activities done during the
-   * last sequence stretch.
-   * @param {number} time - Total time spend doing the activities.
-   * @returns {module:bags/JumpInfo.JumpInfo}
-   */
-  resolveJump(rating, time) {
-    let result = this;
-    if (rating >= 0 && time >= 0) {
-      if (this.upperJump !== null &&
-        rating > this.upperJump.threshold &&
-        (this.upperJump.time <= 0 || time < this.upperJump.time)) {
-        result = this.upperJump;
-      } else if (this.lowerJump !== null &&
-        (rating < this.lowerJump.threshold ||
-          this.lowerJump.time > 0 && time > this.lowerJump.time)) {
-        result = this.lowerJump;
-      }
-    }
-    return result;
-  }
-}
-
-Object.assign(ActivitySequenceJump.prototype, {
-  /**
-   * Optional jump to be performed when the results (score and time) are above a specific threshold.
-   * @name module:bags/ActivitySequenceJump.ActivitySequenceJump#upperJump
-   * @type {module:bags/ConditionalJumpInfo.ConditionalJumpInfo} */
-  upperJump: null,
-  /**
-   * Optional jump to be performed when the results (score or time) are below a specific threshold.
-   * @name module:bags/ActivitySequenceJump.ActivitySequenceJump#lowerJump
-   * @type {module:bags/ConditionalJumpInfo.ConditionalJumpInfo} */
-  lowerJump: null,
-});
-
-export default ActivitySequenceJump;