Merge branch 'MDL-71528-master' of git://github.com/aanabit/moodle

admin/tool/usertours/amd/src/usertours.js

@@ -79,37 +79,32 @@ function(ajax, BootstrapTour, $, templates, str, log, notification) {
          * @method  fetchTour
          * @param   {Number}    tourId      The ID of the tour to start.
          */
-        fetchTour: function(tourId) {
+        fetchTour: async function(tourId) {
             M.util.js_pending('admin_usertour_fetchTour' + tourId);
-            $.when(
-                ajax.call([
+
+            try {
+                const response = await ajax.call([
                     {
                         methodname: 'tool_usertours_fetch_and_start_tour',
                         args: {
-                            tourid:     tourId,
-                            context:    M.cfg.contextid,
-                            pageurl:    window.location.href,
+                            tourid: tourId,
+                            context: M.cfg.contextid,
+                            pageurl: window.location.href,
                         }
                     }
-                ])[0],
-                templates.render('tool_usertours/tourstep', {})
-            )
-            .then(function(response, template) {
-                // If we don't have any tour config (because it doesn't need showing for the current user), return early.
-                if (!response.hasOwnProperty('tourconfig')) {
-                    return;
-                }
+                ])[0];
+                if (response.hasOwnProperty('tourconfig')) {
+                    const template = await templates.renderForPromise('tool_usertours/tourstep', response.tourconfig);
 
-                return usertours.startBootstrapTour(tourId, template[0], response.tourconfig);
-            })
-            .always(function() {
-                M.util.js_complete('admin_usertour_fetchTour' + tourId);
-
-                return;
-            })
-            .fail(notification.exception);
+                    usertours.startBootstrapTour(tourId, template.html, response.tourconfig);
+                }
+            } catch (error) {
+                notification.exception(error);
+            }
+            M.util.js_complete('admin_usertour_fetchTour' + tourId);
         },
 
+
         /**
          * Add a reset link to the page.
          *

admin/tool/usertours/classes/external/tour.php

@@ -101,9 +101,10 @@ public static function fetch_and_start_tour_parameters() {
      */
     public static function fetch_and_start_tour_returns() {
         return new external_single_structure([
-            'tourconfig'    => new external_single_structure([
-                'name'      => new external_value(PARAM_RAW, 'Tour Name'),
-                'steps'     => new external_multiple_structure(self::step_structure_returns()),
+            'tourconfig'        => new external_single_structure([
+                'name'          => new external_value(PARAM_RAW, 'Tour Name'),
+                'steps'         => new external_multiple_structure(self::step_structure_returns()),
+                'onesteptour'   => new external_value(PARAM_BOOL, 'Is a one step tour', VALUE_DEFAULT, false),
             ], 'Tour config', VALUE_OPTIONAL)
         ]);
     }

admin/tool/usertours/classes/output/tour.php

@@ -60,12 +60,18 @@ public function export_for_template(\renderer_base $output) {
         $result = (object) [
             'name'  => $this->tour->get_tour_key(),
             'steps' => [],
+            'onesteptour' => false,
         ];
 
         foreach ($this->tour->get_steps() as $step) {
             $result->steps[] = (new step($step))->export_for_template($output);
         }
 
+        // Check if its a only one step tour.
+        if (count($result->steps) == 1) {
+            $result->onesteptour = true;
+        }
+
         return $result;
     }
 }

admin/tool/usertours/lang/en/tool_usertours.php

@@ -130,6 +130,7 @@
 $string['tours'] = 'Tours';
 $string['pausetour'] = 'Pause';
 $string['resumetour'] = 'Resume';
+$string['endonesteptour'] = 'Got it!';
 $string['endtour'] = 'End tour';
 $string['orphan'] = 'Show if target not found';
 $string['orphan_help'] = 'Show the step if the target could not be found on the page.';

admin/tool/usertours/templates/tourstep.mustache

@@ -42,6 +42,14 @@
 
     Example context (json):
     {
+      "name" : "tour_activity_completion",
+      "onesteptour" : true,
+      "steps": [
+        {
+          "stepid": 10,
+          "title": "Activity information"
+        }
+      ]
     }
 
 }}
@@ -60,7 +68,12 @@
     <div class="modal-footer">
       <button type="button" class="btn btn-secondary" data-role="previous">{{# str }} previousstep, tool_usertours {{/ str }}</button>
       <button type="button" class="btn btn-primary" data-role="next">{{# str }} nextstep, tool_usertours {{/ str }}</button>
-      <button class="btn btn-secondary" data-role="end"> {{# str }} endtour, tool_usertours {{/ str }} </button>
+      {{#onesteptour}}
+          <button class="btn btn-secondary" data-role="end"> {{# str }} endonesteptour, tool_usertours {{/ str }} </button>
+      {{/onesteptour}}
+      {{^onesteptour}}
+          <button class="btn btn-secondary" data-role="end"> {{# str }} endtour, tool_usertours {{/ str }} </button>
+      {{/onesteptour}}
     </div>
   </div>
 </div>

admin/tool/usertours/tests/behat/tour_filter.feature

@@ -37,7 +37,7 @@ Feature: Apply tour filters to a tour
     And I log in as "student1"
     And I am on "Course 1" course homepage
     And I should see "Welcome to your course tour."
-    And I click on "End tour" "button"
+    And I click on "Got it!" "button"
     And I log out
     And I log in as "teacher1"
     And I am on "Course 1" course homepage

admin/tool/usertours/tests/behat/tour_navigation.feature

@@ -22,3 +22,41 @@ Feature: Steps can be navigated within a tour
     When I click on ".block_calendar_month .calendar-controls .next" "css_element"
     And I wait until the page is ready
     Then I should see "Calendar events"
+
+  @javascript
+  Scenario: End tour button text for one step tours
+    Given I log in as "admin"
+    And I add a new user tour with:
+      | Name                | Calendar tour |
+      | Description         | Calendar tour |
+      | Apply to URL match  | /my/% |
+      | Tour is enabled     | 1 |
+    And I add steps to the "Calendar tour" tour:
+      | targettype   | Block        | Title             | Content |
+      | Block        | Calendar     | Calendar events   | This is the calendar block |
+    And I change window size to "large"
+    And I follow "Dashboard" in the user menu
+    And I wait until the page is ready
+    And I should see "This is the calendar block"
+    Then I should see "Got it!"
+
+  @javascript
+  Scenario: End tour button text for multiple step tours
+    Given I log in as "admin"
+    And I add a new user tour with:
+      | Name                | First tour |
+      | Description         | My first tour |
+      | Apply to URL match  | /my/% |
+      | Tour is enabled     | 1 |
+    And I add steps to the "First tour" tour:
+      | targettype                  | Title             | Content |
+      | Display in middle of page   | Welcome           | Welcome to your personal learning space. We'd like to give you a quick tour to show you some of the areas you may find helpful |
+    And I add steps to the "First tour" tour:
+      | targettype                  | targetvalue_block | Title             | Content |
+      | Block                       | Course overview   | Course overview   | This area shows you what's happening in some of your courses  |
+      | Block                       | Calendar          | Calendar          | This is the Calendar. All of your assignments and due dates can be found here |
+    When I am on homepage
+    Then I should see "End tour"
+    And I should see "Next"
+    And I click on "Next" "button"
+    And I should see "End tour"

admin/tool/usertours/upgrade.txt

@@ -1,5 +1,10 @@
 This files describes API changes in the tool_usertours code.
 
+=== 4.0 ===
+* The `tourconfig` property returned by the `tool_usertours_fetch_and_start_tour`
+  external method has also a `onsteptour` property to differentiate between
+  one step tours and multiple step tours.
+
 === 3.9 ===
 * The `tourconfig` property returned by the `tool_usertours_fetch_and_start_tour`
   external method is now optional, and will be omitted if the tour shouldn't be