Tour stops if there are no results (closes #189).

Change-Id: I2ed9cab9ac47b7494feddd167c15926bd541e5cc

Author: hebasta

Changes

@@ -1,4 +1,5 @@
-0.60 2025-01-23
+0.60 2025-03-26
+        - Tour stops gracefully if there are no results (closes #189; hebasta)
         - Create top navbar and modify sidebar. (uyen-nhu)
         - Improve appearance of title-addon on logo. (uyen-nhu)
         - Create and style new item on top navbar for 'News'. (uyen-nhu)

dev/js/spec/tourSpec.js

@@ -87,7 +87,12 @@ define(['tour/tours', 'vc', 'vc/unspecified', 'session', 'match', 'hint',  'hint
     return cb(preDefinedStat);
   }; 
 
-
+  var noresultkorap =  
+  "<div id='search' class=''>" + 
+    "<div class='panel result'><div></div></div></div>" +
+    "<p class='no-results'>Unable to perform the action.</p>" +
+  "</div>";
+  
   var resultkorap =  
     "<div id='search'>" +
       "<ol class='align-left' tabindex='-8'>" +
@@ -393,6 +398,11 @@ define(['tour/tours', 'vc', 'vc/unspecified', 'session', 'match', 'hint',  'hint
   let htmlZwei = resultkorap.trim(); 
   resulttemplate.innerHTML = resultkorap;
   var resultkor = resulttemplate.content;
+ 
+  let noresulttemplate = document.createElement('template');
+  noresultkorap.trim(); 
+  noresulttemplate.innerHTML = noresultkorap;
+  var noresultkor = noresulttemplate.content;
 
   resultkor.querySelector('#search > ol > li:not(.active)').addEventListener('click', function (e) {
     if (this._match !== undefined)
@@ -549,7 +559,15 @@ define(['tour/tours', 'vc', 'vc/unspecified', 'session', 'match', 'hint',  'hint
        resultTour.exit();
      } 
    });
-   
+
+   it('Guided Tour should gracefully stop, if no results are retrieved', function(){
+    let resultTour = tourClass.gTshowResults(noresultkor);
+    KorAP.session = sessionClass.create('KalamarJSDem'); 
+    resultTour.start(noresultkor);
+    expect(document.querySelector(".introjs-donebutton").textContent).toEqual(loc.TOUR_ldone);  
+    resultTour.exit();
+  });
+
    it('Guided Tour should hide Hint if aborted',  function(){
      let tourAbort = tourClass.gTstartSearch(intrkorap);
      tourAbort.start(); 

dev/js/src/loc/de.js

@@ -80,6 +80,7 @@ define(function () {
   loc.TOUR_seargo = "Durch das Klicken auf das Lupensymbol wird die Suchanfrage gestartet.";
 
   //Guided Tour: explain the result
+  loc.TOUR_nokwicti = loc.TOUR_nokwicti || "Die Suche ergab keine Ergebnisse, daher wird die Tour hier beendet.";
   loc.TOUR_kwicti = "Ergebnisse";
   loc.TOUR_kwic = "Die Ergebnisse der Suche werden hier als KWIC (keyword in context) angezeigt. Vor dem KWIC steht die jeweilige Textsigle des Treffers.";
   loc.TOUR_snippetti = "KWIC";

dev/js/src/tour/tours.js

@@ -51,6 +51,7 @@ define(['lib/intro', 'vc', 'hint', 'menu', 'vc/doc', 'vc/docgroup'],
   loc.TOUR_seargo = loc.TOUR_seargo || "Start the search by clicking the magnifying glass.";
 
   //localization guided Tour gTshowResults
+  loc.TOUR_nokwicti = loc.TOUR_nokwicti || "The search has no results, therefore the tour ends here.";
   loc.TOUR_kwicti = loc.TOUR_kwicti || "Results";
   loc.TOUR_kwic = loc.TOUR_kwic || "The results of the query are displayed as KWIC (keyword in context). On the left side, you can see the according text sigle.";
   loc.TOUR_snippetti = loc.TOUR_snippetti ||  "KWIC (2)";
@@ -406,13 +407,16 @@ define(['lib/intro', 'vc', 'hint', 'menu', 'vc/doc', 'vc/docgroup'],
         tourR.setOption('scrollToElement', true);
         tourR.setOption('scrollTo','tooltip');
         this.testPrerequ(StepsSR, tourR);
-      
-        //TODO see also: introJS.totalSteps() merge requested: //github.com/usablica/intro.js/pull/268/files
+
         tourR.onbeforechange(function(targetedElement){
-          
-        if(this._currentStep == 1){
-          KorAP.session.set("tour", false);
-        }
+           if(this._currentStep == 0){
+            KorAP.session.set("tour", false);
+            if(doe.querySelector("#search + p.no-results")){
+              tourR._introItems[0].intro = loc.TOUR_nokwicti;
+              tourR.goToStepNumber(10);
+              document.querySelector(".introjs-prevbutton").style.visibility = "hidden";
+            }
+            } 
 
         if(this._currentStep == 2){
           doe.querySelector("#search > ol > li").click();