Merge branch 'release' into stable

js/questionset.js

@@ -1,4 +1,4 @@
-var H5P = H5P || {};
+H5P = H5P || {};
 
 /**
  * Will render a Question with multiple choices for answers.
@@ -126,6 +126,7 @@ H5P.QuestionSet = function (options, contentId, contentData) {
   var endTemplate = new EJS({text: resulttemplate});
   var params = $.extend(true, {}, defaults, options);
 
+  var initialParams = $.extend(true, {}, defaults, options);
   var poolOrder; // Order of questions in a pool
   var currentQuestion = 0;
   var questionInstances = [];
@@ -145,14 +146,12 @@ H5P.QuestionSet = function (options, contentId, contentData) {
     questionOrder = contentData.previousState.order;
   }
 
-  // Create a pool of questions if necessary
   /**
    * Randomizes questions in an array and updates an array containing their order
    * @param  {array} questions
-   * @param  {array} questionOrder
    * @return {Object.<array, array>} questionOrdering
    */
-  var randomizeQuestionOrdering = function (questions, questionOrder) {
+  var randomizeQuestionOrdering = function (questions) {
 
     // Save the original order of the questions in a multidimensional array [[question0,0],[question1,1]...
     var questionOrdering = questions.map(function(questionInstance, index) { return [questionInstance, index] });
@@ -171,7 +170,7 @@ H5P.QuestionSet = function (options, contentId, contentData) {
     for (var i = 0; i< questionOrdering.length; i++) {
 
       // Use a previous order if it exists
-      if(questionOrder) {
+      if(contentData.previousState && contentData.previousState.questionOrder) {
         newOrder[i] = questionOrder[questionOrdering[i][1]];
       }
       else {
@@ -179,15 +178,15 @@ H5P.QuestionSet = function (options, contentId, contentData) {
       }
     }
 
-    // Return the questions in their new order *with* their new order
+    // Return the questions in their new order *with* their new indexes
     return {
       questions: questions,
       questionOrder: newOrder
     };
-  }
+  };
 
   // Create a pool (a subset) of questions if necessary
-  if (params.poolSize && params.poolSize < params.questions.length) {
+  if (params.poolSize > 0) {
 
     // If a previous pool exists, recreate it
     if(contentData.previousState && contentData.previousState.poolOrder) {
@@ -204,7 +203,7 @@ H5P.QuestionSet = function (options, contentId, contentData) {
     }
     else { // Otherwise create a new pool
       // Randomize and get the results
-      var poolResult = randomizeQuestionOrdering(params.questions, poolOrder);
+      var poolResult = randomizeQuestionOrdering(params.questions);
       var poolQuestions = poolResult.questions;
       poolOrder = poolResult.questionOrder;
 
@@ -238,17 +237,26 @@ H5P.QuestionSet = function (options, contentId, contentData) {
     }
   }
 
+  /**
+   * Generates question instances from H5P objects
+   *
+   * @param  {object} questions H5P content types to be created as instances
+   * @return {array} Array of questions instances
+   */
+  var createQuestionInstancesFromQuestions = function(questions) {
+    var result = [];
+    // Create question instances from questions
     // Instantiate question instances
-  for (var i = 0; i < params.questions.length; i++) {
+    for (var i = 0; i < questions.length; i++) {
 
       var question;
       // If a previous order exists, use it
       if (questionOrder !== undefined) {
-      question = params.questions[questionOrder[i]];
+        question = questions[questionOrder[i]];
       }
       else {
         // Use a generic order when initialzing for the first time
-      question = params.questions[i];
+        question = questions[i];
       }
 
       if (override) {
@@ -270,12 +278,18 @@ H5P.QuestionSet = function (options, contentId, contentData) {
         up = true;
         self.trigger('resize');
       });
-    questionInstances.push(questionInstance);
+      result.push(questionInstance);
     }
 
+    return result;
+  }
+
+  // Create question instances from questions given by params
+  questionInstances = createQuestionInstancesFromQuestions(params.questions);
+
   // Randomize questions only on instantiation
   if (params.randomQuestions && contentData.previousState === undefined) {
-    var result = randomizeQuestionOrdering(questionInstances,questionOrder);
+    var result = randomizeQuestionOrdering(questionInstances);
     questionInstances = result.questions;
     questionOrder = result.questionOrder;
   }
@@ -440,7 +454,12 @@ H5P.QuestionSet = function (options, contentId, contentData) {
    * @public
    */
   var resetTask = function () {
+
+    // Clear previous state to ensure questions are created cleanly
+    contentData.previousState = [];
+
     showingSolutions = false;
+
     for (var i = 0; i < questionInstances.length; i++) {
       try {
         questionInstances[i].resetTask();
@@ -477,7 +496,28 @@ H5P.QuestionSet = function (options, contentId, contentData) {
     //Force the last page to be reRendered
     rendered = false;
 
-    if (params.randomQuestions) {
+    if(params.poolSize > 0){
+
+      // Make new pool from params.questions
+      // Randomize and get the results
+      var poolResult = randomizeQuestionOrdering(initialParams.questions);
+      var poolQuestions = poolResult.questions;
+      poolOrder = poolResult.questionOrder;
+
+      // Discard extra questions
+      poolQuestions = poolQuestions.slice(0, params.poolSize);
+      poolOrder = poolOrder.slice(0, params.poolSize);
+
+      // Replace original questions with just the ones in the pool
+      params.questions = poolQuestions;
+
+      // Recreate the question instances
+      questionInstances = createQuestionInstancesFromQuestions(params.questions);
+
+      // Update buttons
+      initializeQuestion();
+
+    } else if (params.randomQuestions) {
       randomizeQuestions();
     }
 
@@ -494,10 +534,21 @@ H5P.QuestionSet = function (options, contentId, contentData) {
    */
   var randomizeQuestions = function () {
 
-    var result = randomizeQuestionOrdering(questionInstances,questionOrder);
+    var result = randomizeQuestionOrdering(questionInstances);
     questionInstances = result.questions;
     questionOrder = result.questionOrder;
 
+    replaceQuestionsInDOM(questionInstances);
+  };
+
+
+  /**
+   * Empty the DOM of all questions, attach new questions and update buttons
+   *
+   * @param  {type} questionInstances Array of questions to be attached to the DOM
+   */
+  var replaceQuestionsInDOM = function (questionInstances) {
+
     // Find all question containers and detach questions from them
     $('.question-container', $myDom).each(function (){
       $(this).children().detach();
@@ -542,10 +593,8 @@ H5P.QuestionSet = function (options, contentId, contentData) {
       if (questionInstances[questionInstances.length-1] !== question) {
         question.hideButton('finish');
       }
-
-    }
-
     }
+  };
 
   var moveQuestion = function (direction) {
     if (params.disableBackwardsNavigation && !questionInstances[currentQuestion].getAnswerGiven()) {
@@ -762,51 +811,25 @@ H5P.QuestionSet = function (options, contentId, contentData) {
     self.trigger('resize');
   };
 
-  // Function for attaching the multichoice to a DOM element.
-  this.attach = function (target) {
-    if (this.isRoot()) {
-      this.setActivityStarted();
-    }
-    if (typeof(target) === "string") {
-      $myDom = $('#' + target);
-    }
-    else {
-      $myDom = $(target);
-    }
-
-    // Render own DOM into target.
-    $myDom.children().remove();
-    $myDom.append($template);
-    if (params.backgroundImage !== undefined) {
-      $myDom.css({
-        overflow: 'hidden',
-        background: '#fff url("' + H5P.getPath(params.backgroundImage.path, contentId) + '") no-repeat 50% 50%',
-        backgroundSize: '100% auto'
-      });
-    }
-
-    if (params.introPage.backgroundImage !== undefined) {
-      var $intro = $myDom.find('.intro-page');
-      if ($intro.length) {
-        var bgImg = params.introPage.backgroundImage;
-        var bgImgRatio = (bgImg.height / bgImg.width);
-        $intro.css({
-          background: '#fff url("' + H5P.getPath(bgImg.path, contentId) + '") no-repeat 50% 50%',
-          backgroundSize: 'auto 100%',
-          minHeight: bgImgRatio * +window.getComputedStyle($intro[0]).width.replace('px','')
-        });
-      }
-    }
   var registerImageLoadedListener = function (question) {
     H5P.on(question, 'imageLoaded', function () {
       self.trigger('resize');
     });
   };
 
+
+  /**
+   * Initialize a question and attach it to the DOM
+   *
+   */
+  function initializeQuestion() {
     // Attach questions
     for (var i = 0; i < questionInstances.length; i++) {
       var question = questionInstances[i];
 
+      // Make sure styles are not being added twice
+      $('.question-container:eq(' + i + ')', $myDom).attr('class', 'question-container');
+
       question.attach($('.question-container:eq(' + i + ')', $myDom));
 
       // Listen for image resize
@@ -857,6 +880,44 @@ H5P.QuestionSet = function (options, contentId, contentData) {
       // Mark question if answered
       toggleAnsweredDot(i, question.getAnswerGiven());
     }
+  }
+
+  this.attach = function (target) {
+    if (this.isRoot()) {
+      this.setActivityStarted();
+    }
+    if (typeof(target) === "string") {
+      $myDom = $('#' + target);
+    }
+    else {
+      $myDom = $(target);
+    }
+
+    // Render own DOM into target.
+    $myDom.children().remove();
+    $myDom.append($template);
+    if (params.backgroundImage !== undefined) {
+      $myDom.css({
+        overflow: 'hidden',
+        background: '#fff url("' + H5P.getPath(params.backgroundImage.path, contentId) + '") no-repeat 50% 50%',
+        backgroundSize: '100% auto'
+      });
+    }
+
+    if (params.introPage.backgroundImage !== undefined) {
+      var $intro = $myDom.find('.intro-page');
+      if ($intro.length) {
+        var bgImg = params.introPage.backgroundImage;
+        var bgImgRatio = (bgImg.height / bgImg.width);
+        $intro.css({
+          background: '#fff url("' + H5P.getPath(bgImg.path, contentId) + '") no-repeat 50% 50%',
+          backgroundSize: 'auto 100%',
+          minHeight: bgImgRatio * +window.getComputedStyle($intro[0]).width.replace('px','')
+        });
+      }
+    }
+
+    initializeQuestion();
 
     // Allow other libraries to add transitions after the questions have been inited
     $('.questionset', $myDom).addClass('started');

library.json

@@ -4,7 +4,7 @@
   "contentType": "question",
   "majorVersion": 1,
   "minorVersion": 10,
-  "patchVersion": 0,
+  "patchVersion": 1,
   "embedTypes": [
     "iframe"
   ],