upgrades core to 8.4.2
This commit is contained in:
Bachir Soussi Chiadmi
@@ -0,0 +1,268 @@
|
||||
/**
|
||||
* @file
|
||||
* Attaches behaviors for the Tour module's toolbar tab.
|
||||
*/
|
||||
|
||||
(function ($, Backbone, Drupal, document) {
|
||||
const queryString = decodeURI(window.location.search);
|
||||
|
||||
/**
|
||||
* Attaches the tour's toolbar tab behavior.
|
||||
*
|
||||
* It uses the query string for:
|
||||
* - tour: When ?tour=1 is present, the tour will start automatically after
|
||||
* the page has loaded.
|
||||
* - tips: Pass ?tips=class in the url to filter the available tips to the
|
||||
* subset which match the given class.
|
||||
*
|
||||
* @example
|
||||
* http://example.com/foo?tour=1&tips=bar
|
||||
*
|
||||
* @type {Drupal~behavior}
|
||||
*
|
||||
* @prop {Drupal~behaviorAttach} attach
|
||||
* Attach tour functionality on `tour` events.
|
||||
*/
|
||||
Drupal.behaviors.tour = {
|
||||
attach(context) {
|
||||
$('body').once('tour').each(() => {
|
||||
const model = new Drupal.tour.models.StateModel();
|
||||
new Drupal.tour.views.ToggleTourView({
|
||||
el: $(context).find('#toolbar-tab-tour'),
|
||||
model,
|
||||
});
|
||||
|
||||
model
|
||||
// Allow other scripts to respond to tour events.
|
||||
.on('change:isActive', (model, isActive) => {
|
||||
$(document).trigger((isActive) ? 'drupalTourStarted' : 'drupalTourStopped');
|
||||
})
|
||||
// Initialization: check whether a tour is available on the current
|
||||
// page.
|
||||
.set('tour', $(context).find('ol#tour'));
|
||||
|
||||
// Start the tour immediately if toggled via query string.
|
||||
if (/tour=?/i.test(queryString)) {
|
||||
model.set('isActive', true);
|
||||
}
|
||||
});
|
||||
},
|
||||
};
|
||||
|
||||
/**
|
||||
* @namespace
|
||||
*/
|
||||
Drupal.tour = Drupal.tour || {
|
||||
|
||||
/**
|
||||
* @namespace Drupal.tour.models
|
||||
*/
|
||||
models: {},
|
||||
|
||||
/**
|
||||
* @namespace Drupal.tour.views
|
||||
*/
|
||||
views: {},
|
||||
};
|
||||
|
||||
/**
|
||||
* Backbone Model for tours.
|
||||
*
|
||||
* @constructor
|
||||
*
|
||||
* @augments Backbone.Model
|
||||
*/
|
||||
Drupal.tour.models.StateModel = Backbone.Model.extend(/** @lends Drupal.tour.models.StateModel# */{
|
||||
|
||||
/**
|
||||
* @type {object}
|
||||
*/
|
||||
defaults: /** @lends Drupal.tour.models.StateModel# */{
|
||||
|
||||
/**
|
||||
* Indicates whether the Drupal root window has a tour.
|
||||
*
|
||||
* @type {Array}
|
||||
*/
|
||||
tour: [],
|
||||
|
||||
/**
|
||||
* Indicates whether the tour is currently running.
|
||||
*
|
||||
* @type {bool}
|
||||
*/
|
||||
isActive: false,
|
||||
|
||||
/**
|
||||
* Indicates which tour is the active one (necessary to cleanly stop).
|
||||
*
|
||||
* @type {Array}
|
||||
*/
|
||||
activeTour: [],
|
||||
},
|
||||
});
|
||||
|
||||
Drupal.tour.views.ToggleTourView = Backbone.View.extend(/** @lends Drupal.tour.views.ToggleTourView# */{
|
||||
|
||||
/**
|
||||
* @type {object}
|
||||
*/
|
||||
events: { click: 'onClick' },
|
||||
|
||||
/**
|
||||
* Handles edit mode toggle interactions.
|
||||
*
|
||||
* @constructs
|
||||
*
|
||||
* @augments Backbone.View
|
||||
*/
|
||||
initialize() {
|
||||
this.listenTo(this.model, 'change:tour change:isActive', this.render);
|
||||
this.listenTo(this.model, 'change:isActive', this.toggleTour);
|
||||
},
|
||||
|
||||
/**
|
||||
* @inheritdoc
|
||||
*
|
||||
* @return {Drupal.tour.views.ToggleTourView}
|
||||
* The `ToggleTourView` view.
|
||||
*/
|
||||
render() {
|
||||
// Render the visibility.
|
||||
this.$el.toggleClass('hidden', this._getTour().length === 0);
|
||||
// Render the state.
|
||||
const isActive = this.model.get('isActive');
|
||||
this.$el.find('button')
|
||||
.toggleClass('is-active', isActive)
|
||||
.prop('aria-pressed', isActive);
|
||||
return this;
|
||||
},
|
||||
|
||||
/**
|
||||
* Model change handler; starts or stops the tour.
|
||||
*/
|
||||
toggleTour() {
|
||||
if (this.model.get('isActive')) {
|
||||
const $tour = this._getTour();
|
||||
this._removeIrrelevantTourItems($tour, this._getDocument());
|
||||
const that = this;
|
||||
if ($tour.find('li').length) {
|
||||
$tour.joyride({
|
||||
autoStart: true,
|
||||
postRideCallback() {
|
||||
that.model.set('isActive', false);
|
||||
},
|
||||
// HTML segments for tip layout.
|
||||
template: {
|
||||
link: '<a href=\"#close\" class=\"joyride-close-tip\">×</a>',
|
||||
button: '<a href=\"#\" class=\"button button--primary joyride-next-tip\"></a>',
|
||||
},
|
||||
});
|
||||
this.model.set({ isActive: true, activeTour: $tour });
|
||||
}
|
||||
}
|
||||
else {
|
||||
this.model.get('activeTour').joyride('destroy');
|
||||
this.model.set({ isActive: false, activeTour: [] });
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* Toolbar tab click event handler; toggles isActive.
|
||||
*
|
||||
* @param {jQuery.Event} event
|
||||
* The click event.
|
||||
*/
|
||||
onClick(event) {
|
||||
this.model.set('isActive', !this.model.get('isActive'));
|
||||
event.preventDefault();
|
||||
event.stopPropagation();
|
||||
},
|
||||
|
||||
/**
|
||||
* Gets the tour.
|
||||
*
|
||||
* @return {jQuery}
|
||||
* A jQuery element pointing to a `<ol>` containing tour items.
|
||||
*/
|
||||
_getTour() {
|
||||
return this.model.get('tour');
|
||||
},
|
||||
|
||||
/**
|
||||
* Gets the relevant document as a jQuery element.
|
||||
*
|
||||
* @return {jQuery}
|
||||
* A jQuery element pointing to the document within which a tour would be
|
||||
* started given the current state.
|
||||
*/
|
||||
_getDocument() {
|
||||
return $(document);
|
||||
},
|
||||
|
||||
/**
|
||||
* Removes tour items for elements that don't have matching page elements.
|
||||
*
|
||||
* Or that are explicitly filtered out via the 'tips' query string.
|
||||
*
|
||||
* @example
|
||||
* <caption>This will filter out tips that do not have a matching
|
||||
* page element or don't have the "bar" class.</caption>
|
||||
* http://example.com/foo?tips=bar
|
||||
*
|
||||
* @param {jQuery} $tour
|
||||
* A jQuery element pointing to a `<ol>` containing tour items.
|
||||
* @param {jQuery} $document
|
||||
* A jQuery element pointing to the document within which the elements
|
||||
* should be sought.
|
||||
*
|
||||
* @see Drupal.tour.views.ToggleTourView#_getDocument
|
||||
*/
|
||||
_removeIrrelevantTourItems($tour, $document) {
|
||||
let removals = false;
|
||||
const tips = /tips=([^&]+)/.exec(queryString);
|
||||
$tour
|
||||
.find('li')
|
||||
.each(function () {
|
||||
const $this = $(this);
|
||||
const itemId = $this.attr('data-id');
|
||||
const itemClass = $this.attr('data-class');
|
||||
// If the query parameter 'tips' is set, remove all tips that don't
|
||||
// have the matching class.
|
||||
if (tips && !$(this).hasClass(tips[1])) {
|
||||
removals = true;
|
||||
$this.remove();
|
||||
return;
|
||||
}
|
||||
// Remove tip from the DOM if there is no corresponding page element.
|
||||
if ((!itemId && !itemClass) ||
|
||||
(itemId && $document.find(`#${itemId}`).length) ||
|
||||
(itemClass && $document.find(`.${itemClass}`).length)) {
|
||||
return;
|
||||
}
|
||||
removals = true;
|
||||
$this.remove();
|
||||
});
|
||||
|
||||
// If there were removals, we'll have to do some clean-up.
|
||||
if (removals) {
|
||||
const total = $tour.find('li').length;
|
||||
if (!total) {
|
||||
this.model.set({ tour: [] });
|
||||
}
|
||||
|
||||
$tour
|
||||
.find('li')
|
||||
// Rebuild the progress data.
|
||||
.each(function (index) {
|
||||
const progress = Drupal.t('!tour_item of !total', { '!tour_item': index + 1, '!total': total });
|
||||
$(this).find('.tour-progress').text(progress);
|
||||
})
|
||||
// Update the last item to have "End tour" as the button.
|
||||
.eq(-1)
|
||||
.attr('data-text', Drupal.t('End tour'));
|
||||
}
|
||||
},
|
||||
|
||||
});
|
||||
}(jQuery, Backbone, Drupal, document));
|
||||
+50
-190
@@ -1,33 +1,15 @@
|
||||
/**
|
||||
* @file
|
||||
* Attaches behaviors for the Tour module's toolbar tab.
|
||||
*/
|
||||
* DO NOT EDIT THIS FILE.
|
||||
* See the following change record for more information,
|
||||
* https://www.drupal.org/node/2815083
|
||||
* @preserve
|
||||
**/
|
||||
|
||||
(function ($, Backbone, Drupal, document) {
|
||||
|
||||
'use strict';
|
||||
|
||||
var queryString = decodeURI(window.location.search);
|
||||
|
||||
/**
|
||||
* Attaches the tour's toolbar tab behavior.
|
||||
*
|
||||
* It uses the query string for:
|
||||
* - tour: When ?tour=1 is present, the tour will start automatically after
|
||||
* the page has loaded.
|
||||
* - tips: Pass ?tips=class in the url to filter the available tips to the
|
||||
* subset which match the given class.
|
||||
*
|
||||
* @example
|
||||
* http://example.com/foo?tour=1&tips=bar
|
||||
*
|
||||
* @type {Drupal~behavior}
|
||||
*
|
||||
* @prop {Drupal~behaviorAttach} attach
|
||||
* Attach tour functionality on `tour` events.
|
||||
*/
|
||||
Drupal.behaviors.tour = {
|
||||
attach: function (context) {
|
||||
attach: function attach(context) {
|
||||
$('body').once('tour').each(function () {
|
||||
var model = new Drupal.tour.models.StateModel();
|
||||
new Drupal.tour.views.ToggleTourView({
|
||||
@@ -35,16 +17,10 @@
|
||||
model: model
|
||||
});
|
||||
|
||||
model
|
||||
// Allow other scripts to respond to tour events.
|
||||
.on('change:isActive', function (model, isActive) {
|
||||
$(document).trigger((isActive) ? 'drupalTourStarted' : 'drupalTourStopped');
|
||||
})
|
||||
// Initialization: check whether a tour is available on the current
|
||||
// page.
|
||||
.set('tour', $(context).find('ol#tour'));
|
||||
model.on('change:isActive', function (model, isActive) {
|
||||
$(document).trigger(isActive ? 'drupalTourStarted' : 'drupalTourStopped');
|
||||
}).set('tour', $(context).find('ol#tour'));
|
||||
|
||||
// Start the tour immediately if toggled via query string.
|
||||
if (/tour=?/i.test(queryString)) {
|
||||
model.set('isActive', true);
|
||||
}
|
||||
@@ -52,99 +28,37 @@
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* @namespace
|
||||
*/
|
||||
Drupal.tour = Drupal.tour || {
|
||||
|
||||
/**
|
||||
* @namespace Drupal.tour.models
|
||||
*/
|
||||
models: {},
|
||||
|
||||
/**
|
||||
* @namespace Drupal.tour.views
|
||||
*/
|
||||
views: {}
|
||||
};
|
||||
|
||||
/**
|
||||
* Backbone Model for tours.
|
||||
*
|
||||
* @constructor
|
||||
*
|
||||
* @augments Backbone.Model
|
||||
*/
|
||||
Drupal.tour.models.StateModel = Backbone.Model.extend(/** @lends Drupal.tour.models.StateModel# */{
|
||||
|
||||
/**
|
||||
* @type {object}
|
||||
*/
|
||||
defaults: /** @lends Drupal.tour.models.StateModel# */{
|
||||
|
||||
/**
|
||||
* Indicates whether the Drupal root window has a tour.
|
||||
*
|
||||
* @type {Array}
|
||||
*/
|
||||
Drupal.tour.models.StateModel = Backbone.Model.extend({
|
||||
defaults: {
|
||||
tour: [],
|
||||
|
||||
/**
|
||||
* Indicates whether the tour is currently running.
|
||||
*
|
||||
* @type {bool}
|
||||
*/
|
||||
isActive: false,
|
||||
|
||||
/**
|
||||
* Indicates which tour is the active one (necessary to cleanly stop).
|
||||
*
|
||||
* @type {Array}
|
||||
*/
|
||||
activeTour: []
|
||||
}
|
||||
});
|
||||
|
||||
Drupal.tour.views.ToggleTourView = Backbone.View.extend(/** @lends Drupal.tour.views.ToggleTourView# */{
|
||||
Drupal.tour.views.ToggleTourView = Backbone.View.extend({
|
||||
events: { click: 'onClick' },
|
||||
|
||||
/**
|
||||
* @type {object}
|
||||
*/
|
||||
events: {click: 'onClick'},
|
||||
|
||||
/**
|
||||
* Handles edit mode toggle interactions.
|
||||
*
|
||||
* @constructs
|
||||
*
|
||||
* @augments Backbone.View
|
||||
*/
|
||||
initialize: function () {
|
||||
initialize: function initialize() {
|
||||
this.listenTo(this.model, 'change:tour change:isActive', this.render);
|
||||
this.listenTo(this.model, 'change:isActive', this.toggleTour);
|
||||
},
|
||||
|
||||
/**
|
||||
* @inheritdoc
|
||||
*
|
||||
* @return {Drupal.tour.views.ToggleTourView}
|
||||
* The `ToggleTourView` view.
|
||||
*/
|
||||
render: function () {
|
||||
// Render the visibility.
|
||||
render: function render() {
|
||||
this.$el.toggleClass('hidden', this._getTour().length === 0);
|
||||
// Render the state.
|
||||
|
||||
var isActive = this.model.get('isActive');
|
||||
this.$el.find('button')
|
||||
.toggleClass('is-active', isActive)
|
||||
.prop('aria-pressed', isActive);
|
||||
this.$el.find('button').toggleClass('is-active', isActive).prop('aria-pressed', isActive);
|
||||
return this;
|
||||
},
|
||||
|
||||
/**
|
||||
* Model change handler; starts or stops the tour.
|
||||
*/
|
||||
toggleTour: function () {
|
||||
toggleTour: function toggleTour() {
|
||||
if (this.model.get('isActive')) {
|
||||
var $tour = this._getTour();
|
||||
this._removeIrrelevantTourItems($tour, this._getDocument());
|
||||
@@ -152,119 +66,65 @@
|
||||
if ($tour.find('li').length) {
|
||||
$tour.joyride({
|
||||
autoStart: true,
|
||||
postRideCallback: function () { that.model.set('isActive', false); },
|
||||
// HTML segments for tip layout.
|
||||
postRideCallback: function postRideCallback() {
|
||||
that.model.set('isActive', false);
|
||||
},
|
||||
|
||||
template: {
|
||||
link: '<a href=\"#close\" class=\"joyride-close-tip\">×</a>',
|
||||
button: '<a href=\"#\" class=\"button button--primary joyride-next-tip\"></a>'
|
||||
}
|
||||
});
|
||||
this.model.set({isActive: true, activeTour: $tour});
|
||||
this.model.set({ isActive: true, activeTour: $tour });
|
||||
}
|
||||
}
|
||||
else {
|
||||
} else {
|
||||
this.model.get('activeTour').joyride('destroy');
|
||||
this.model.set({isActive: false, activeTour: []});
|
||||
this.model.set({ isActive: false, activeTour: [] });
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* Toolbar tab click event handler; toggles isActive.
|
||||
*
|
||||
* @param {jQuery.Event} event
|
||||
* The click event.
|
||||
*/
|
||||
onClick: function (event) {
|
||||
onClick: function onClick(event) {
|
||||
this.model.set('isActive', !this.model.get('isActive'));
|
||||
event.preventDefault();
|
||||
event.stopPropagation();
|
||||
},
|
||||
|
||||
/**
|
||||
* Gets the tour.
|
||||
*
|
||||
* @return {jQuery}
|
||||
* A jQuery element pointing to a `<ol>` containing tour items.
|
||||
*/
|
||||
_getTour: function () {
|
||||
_getTour: function _getTour() {
|
||||
return this.model.get('tour');
|
||||
},
|
||||
|
||||
/**
|
||||
* Gets the relevant document as a jQuery element.
|
||||
*
|
||||
* @return {jQuery}
|
||||
* A jQuery element pointing to the document within which a tour would be
|
||||
* started given the current state.
|
||||
*/
|
||||
_getDocument: function () {
|
||||
_getDocument: function _getDocument() {
|
||||
return $(document);
|
||||
},
|
||||
|
||||
/**
|
||||
* Removes tour items for elements that don't have matching page elements.
|
||||
*
|
||||
* Or that are explicitly filtered out via the 'tips' query string.
|
||||
*
|
||||
* @example
|
||||
* <caption>This will filter out tips that do not have a matching
|
||||
* page element or don't have the "bar" class.</caption>
|
||||
* http://example.com/foo?tips=bar
|
||||
*
|
||||
* @param {jQuery} $tour
|
||||
* A jQuery element pointing to a `<ol>` containing tour items.
|
||||
* @param {jQuery} $document
|
||||
* A jQuery element pointing to the document within which the elements
|
||||
* should be sought.
|
||||
*
|
||||
* @see Drupal.tour.views.ToggleTourView#_getDocument
|
||||
*/
|
||||
_removeIrrelevantTourItems: function ($tour, $document) {
|
||||
_removeIrrelevantTourItems: function _removeIrrelevantTourItems($tour, $document) {
|
||||
var removals = false;
|
||||
var tips = /tips=([^&]+)/.exec(queryString);
|
||||
$tour
|
||||
.find('li')
|
||||
.each(function () {
|
||||
var $this = $(this);
|
||||
var itemId = $this.attr('data-id');
|
||||
var itemClass = $this.attr('data-class');
|
||||
// If the query parameter 'tips' is set, remove all tips that don't
|
||||
// have the matching class.
|
||||
if (tips && !$(this).hasClass(tips[1])) {
|
||||
removals = true;
|
||||
$this.remove();
|
||||
return;
|
||||
}
|
||||
// Remove tip from the DOM if there is no corresponding page element.
|
||||
if ((!itemId && !itemClass) ||
|
||||
(itemId && $document.find('#' + itemId).length) ||
|
||||
(itemClass && $document.find('.' + itemClass).length)) {
|
||||
return;
|
||||
}
|
||||
$tour.find('li').each(function () {
|
||||
var $this = $(this);
|
||||
var itemId = $this.attr('data-id');
|
||||
var itemClass = $this.attr('data-class');
|
||||
|
||||
if (tips && !$(this).hasClass(tips[1])) {
|
||||
removals = true;
|
||||
$this.remove();
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
if (!itemId && !itemClass || itemId && $document.find('#' + itemId).length || itemClass && $document.find('.' + itemClass).length) {
|
||||
return;
|
||||
}
|
||||
removals = true;
|
||||
$this.remove();
|
||||
});
|
||||
|
||||
// If there were removals, we'll have to do some clean-up.
|
||||
if (removals) {
|
||||
var total = $tour.find('li').length;
|
||||
if (!total) {
|
||||
this.model.set({tour: []});
|
||||
this.model.set({ tour: [] });
|
||||
}
|
||||
|
||||
$tour
|
||||
.find('li')
|
||||
// Rebuild the progress data.
|
||||
.each(function (index) {
|
||||
var progress = Drupal.t('!tour_item of !total', {'!tour_item': index + 1, '!total': total});
|
||||
$(this).find('.tour-progress').text(progress);
|
||||
})
|
||||
// Update the last item to have "End tour" as the button.
|
||||
.eq(-1)
|
||||
.attr('data-text', Drupal.t('End tour'));
|
||||
$tour.find('li').each(function (index) {
|
||||
var progress = Drupal.t('!tour_item of !total', { '!tour_item': index + 1, '!total': total });
|
||||
$(this).find('.tour-progress').text(progress);
|
||||
}).eq(-1).attr('data-text', Drupal.t('End tour'));
|
||||
}
|
||||
}
|
||||
|
||||
});
|
||||
|
||||
})(jQuery, Backbone, Drupal, document);
|
||||
})(jQuery, Backbone, Drupal, document);
|
||||
@@ -13,8 +13,10 @@ use Drupal\tour\TourInterface;
|
||||
* id = "tour",
|
||||
* label = @Translation("Tour"),
|
||||
* handlers = {
|
||||
* "view_builder" = "Drupal\tour\TourViewBuilder"
|
||||
* "view_builder" = "Drupal\tour\TourViewBuilder",
|
||||
* "access" = "Drupal\tour\TourAccessControlHandler",
|
||||
* },
|
||||
* admin_permission = "administer site configuration",
|
||||
* entity_keys = {
|
||||
* "id" = "id",
|
||||
* "label" = "label"
|
||||
|
||||
@@ -4,8 +4,13 @@ namespace Drupal\tour\Tests;
|
||||
|
||||
use Drupal\simpletest\WebTestBase;
|
||||
|
||||
@trigger_error('\Drupal\tour\Tests\TourTestBase is deprecated in 8.4.0 and will be removed before Drupal 9.0.0. Instead, use \Drupal\Tests\tour\Functional\TourTestBase.', E_USER_DEPRECATED);
|
||||
|
||||
/**
|
||||
* Base class for testing Tour functionality.
|
||||
*
|
||||
* @deprecated in Drupal 8.4.0 and will be removed before Drupal 9.0.0.
|
||||
* Use \Drupal\Tests\tour\Functional\TourTestBase instead.
|
||||
*/
|
||||
abstract class TourTestBase extends WebTestBase {
|
||||
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
<?php
|
||||
|
||||
namespace Drupal\tour;
|
||||
|
||||
use Drupal\Core\Access\AccessResult;
|
||||
use Drupal\Core\Entity\EntityAccessControlHandler;
|
||||
use Drupal\Core\Entity\EntityInterface;
|
||||
use Drupal\Core\Session\AccountInterface;
|
||||
|
||||
/**
|
||||
* Defines the access control handler for the tour entity type.
|
||||
*
|
||||
* @see \Drupal\tour\Entity\Tour
|
||||
*/
|
||||
class TourAccessControlHandler extends EntityAccessControlHandler {
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
|
||||
if ($operation === 'view') {
|
||||
return AccessResult::allowedIfHasPermissions($account, ['access tour', 'administer site configuration'], 'OR');
|
||||
}
|
||||
|
||||
return parent::checkAccess($entity, $operation, $account);
|
||||
}
|
||||
|
||||
}
|
||||
@@ -3,7 +3,7 @@
|
||||
namespace Drupal\Tests\tour\Functional;
|
||||
|
||||
use Drupal\Core\Url;
|
||||
use Drupal\system\Tests\Cache\PageCacheTagsTestBase;
|
||||
use Drupal\Tests\system\Functional\Cache\PageCacheTagsTestBase;
|
||||
use Drupal\tour\Entity\Tour;
|
||||
use Drupal\user\Entity\Role;
|
||||
use Drupal\user\RoleInterface;
|
||||
|
||||
@@ -0,0 +1,141 @@
|
||||
<?php
|
||||
|
||||
namespace Drupal\Tests\tour\Functional;
|
||||
|
||||
use Drupal\Tests\BrowserTestBase;
|
||||
|
||||
/**
|
||||
* Verifies help page display of tours.
|
||||
*
|
||||
* @group help
|
||||
*/
|
||||
class TourHelpPageTest extends BrowserTestBase {
|
||||
|
||||
/**
|
||||
* Modules to enable, including some providing tours.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public static $modules = ['help', 'tour', 'locale', 'language'];
|
||||
|
||||
/**
|
||||
* User that can access tours and help.
|
||||
*
|
||||
* @var \Drupal\user\UserInterface
|
||||
*/
|
||||
protected $tourUser;
|
||||
|
||||
/**
|
||||
* A user who can access help but not tours.
|
||||
*
|
||||
* @var \Drupal\user\UserInterface
|
||||
*/
|
||||
protected $noTourUser;
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function setUp() {
|
||||
parent::setUp();
|
||||
|
||||
// Create users. For the Tour user, include permissions for the language
|
||||
// tours' parent pages, but not the translation tour's parent page. See
|
||||
// self:getTourList().
|
||||
$this->tourUser = $this->drupalCreateUser(['access administration pages', 'access tour', 'administer languages']);
|
||||
$this->noTourUser = $this->drupalCreateUser(['access administration pages']);
|
||||
}
|
||||
|
||||
/**
|
||||
* Logs in users, tests help pages.
|
||||
*/
|
||||
public function testHelp() {
|
||||
$this->drupalLogin($this->tourUser);
|
||||
$this->verifyHelp();
|
||||
|
||||
$this->drupalLogin($this->noTourUser);
|
||||
$this->verifyHelp(FALSE);
|
||||
}
|
||||
|
||||
/**
|
||||
* Verifies the logged in user has access to the help properly.
|
||||
*
|
||||
* @param bool $tours_ok
|
||||
* (optional) TRUE (default) if the user should see tours, FALSE if not.
|
||||
*/
|
||||
protected function verifyHelp($tours_ok = TRUE) {
|
||||
$this->drupalGet('admin/help');
|
||||
|
||||
// All users should be able to see the module section.
|
||||
$this->assertText('Module overviews are provided by modules');
|
||||
foreach ($this->getModuleList() as $name) {
|
||||
$this->assertLink($name);
|
||||
}
|
||||
|
||||
// Some users should be able to see the tour section.
|
||||
if ($tours_ok) {
|
||||
$this->assertText('Tours guide you through workflows');
|
||||
}
|
||||
else {
|
||||
$this->assertNoText('Tours guide you through workflows');
|
||||
}
|
||||
|
||||
$titles = $this->getTourList();
|
||||
|
||||
// Test the titles that should be links.
|
||||
foreach ($titles[0] as $title) {
|
||||
if ($tours_ok) {
|
||||
$this->assertLink($title);
|
||||
}
|
||||
else {
|
||||
$this->assertNoLink($title);
|
||||
// Just test the first item in the list of links that should not
|
||||
// be there, because the second matches the name of a module that is
|
||||
// in the Module overviews section, so the link will be there and
|
||||
// this test will fail. Testing one should be sufficient to verify
|
||||
// the page is working correctly.
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// Test the titles that should not be links.
|
||||
foreach ($titles[1] as $title) {
|
||||
if ($tours_ok) {
|
||||
$this->assertText($title);
|
||||
$this->assertSession()->linkNotExistsExact($title);
|
||||
}
|
||||
else {
|
||||
$this->assertNoText($title);
|
||||
// Just test the first item in the list of text that should not
|
||||
// be there, because the second matches part of the name of a module
|
||||
// that is in the Module overviews section, so the text will be there
|
||||
// and this test will fail. Testing one should be sufficient to verify
|
||||
// the page is working correctly.
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a list of modules to test for hook_help() pages.
|
||||
*
|
||||
* @return array
|
||||
* A list of module names to test.
|
||||
*/
|
||||
protected function getModuleList() {
|
||||
return ['Help', 'Tour'];
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a list of tours to test.
|
||||
*
|
||||
* @return array
|
||||
* A list of tour titles to test. The first array element is a list of tours
|
||||
* with links, and the second is a list of tours without links. Assumes
|
||||
* that the user being tested has 'administer languages' permission but
|
||||
* not 'translate interface'.
|
||||
*/
|
||||
protected function getTourList() {
|
||||
return [['Adding languages', 'Language'], ['Editing languages', 'Translation']];
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,188 @@
|
||||
<?php
|
||||
|
||||
namespace Drupal\Tests\tour\Functional;
|
||||
|
||||
use Drupal\language\Entity\ConfigurableLanguage;
|
||||
use Drupal\tour\Entity\Tour;
|
||||
|
||||
/**
|
||||
* Tests the functionality of tour tips.
|
||||
*
|
||||
* @group tour
|
||||
*/
|
||||
class TourTest extends TourTestBasic {
|
||||
|
||||
/**
|
||||
* Modules to enable.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public static $modules = ['block', 'tour', 'locale', 'language', 'tour_test'];
|
||||
|
||||
/**
|
||||
* The permissions required for a logged in user to test tour tips.
|
||||
*
|
||||
* @var array
|
||||
* A list of permissions.
|
||||
*/
|
||||
protected $permissions = ['access tour', 'administer languages'];
|
||||
|
||||
/**
|
||||
* Tour tip attributes to be tested. Keyed by the path.
|
||||
*
|
||||
* @var array
|
||||
* An array of tip attributes, keyed by path.
|
||||
*/
|
||||
protected $tips = [
|
||||
'tour-test-1' => [],
|
||||
];
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function setUp() {
|
||||
parent::setUp();
|
||||
|
||||
$this->drupalPlaceBlock('local_actions_block', [
|
||||
'theme' => 'seven',
|
||||
'region' => 'content'
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Test tour functionality.
|
||||
*/
|
||||
public function testTourFunctionality() {
|
||||
// Navigate to tour-test-1 and verify the tour_test_1 tip is found with appropriate classes.
|
||||
$this->drupalGet('tour-test-1');
|
||||
|
||||
// Test the TourTestBase class assertTourTips() method.
|
||||
$tips = [];
|
||||
$tips[] = ['data-id' => 'tour-test-1'];
|
||||
$tips[] = ['data-class' => 'tour-test-5'];
|
||||
$this->assertTourTips($tips);
|
||||
$this->assertTourTips();
|
||||
|
||||
$elements = $this->xpath('//li[@data-id=:data_id and @class=:classes and ./p//a[@href=:href and contains(., :text)]]', [
|
||||
':classes' => 'tip-module-tour-test tip-type-text tip-tour-test-1',
|
||||
':data_id' => 'tour-test-1',
|
||||
':href' => \Drupal::url('<front>', [], ['absolute' => TRUE]),
|
||||
':text' => 'Drupal',
|
||||
]);
|
||||
$this->assertEqual(count($elements), 1, 'Found Token replacement.');
|
||||
|
||||
$elements = $this->cssSelect("li[data-id=tour-test-1] h2:contains('The first tip')");
|
||||
$this->assertEqual(count($elements), 1, 'Found English variant of tip 1.');
|
||||
|
||||
$elements = $this->cssSelect("li[data-id=tour-test-2] h2:contains('The quick brown fox')");
|
||||
$this->assertNotEqual(count($elements), 1, 'Did not find English variant of tip 2.');
|
||||
|
||||
$elements = $this->cssSelect("li[data-id=tour-test-1] h2:contains('La pioggia cade in spagna')");
|
||||
$this->assertNotEqual(count($elements), 1, 'Did not find Italian variant of tip 1.');
|
||||
|
||||
// Ensure that plugins work.
|
||||
$elements = $this->xpath('//img[@src="http://local/image.png"]');
|
||||
$this->assertEqual(count($elements), 1, 'Image plugin tip found.');
|
||||
|
||||
// Navigate to tour-test-2/subpath and verify the tour_test_2 tip is found.
|
||||
$this->drupalGet('tour-test-2/subpath');
|
||||
$elements = $this->cssSelect("li[data-id=tour-test-2] h2:contains('The quick brown fox')");
|
||||
$this->assertEqual(count($elements), 1, 'Found English variant of tip 2.');
|
||||
|
||||
$elements = $this->cssSelect("li[data-id=tour-test-1] h2:contains('The first tip')");
|
||||
$this->assertNotEqual(count($elements), 1, 'Did not find English variant of tip 1.');
|
||||
|
||||
// Enable Italian language and navigate to it/tour-test1 and verify italian
|
||||
// version of tip is found.
|
||||
ConfigurableLanguage::createFromLangcode('it')->save();
|
||||
$this->drupalGet('it/tour-test-1');
|
||||
|
||||
$elements = $this->cssSelect("li[data-id=tour-test-1] h2:contains('La pioggia cade in spagna')");
|
||||
$this->assertEqual(count($elements), 1, 'Found Italian variant of tip 1.');
|
||||
|
||||
$elements = $this->cssSelect("li[data-id=tour-test-2] h2:contains('The quick brown fox')");
|
||||
$this->assertNotEqual(count($elements), 1, 'Did not find English variant of tip 1.');
|
||||
|
||||
// Programmatically create a tour for use through the remainder of the test.
|
||||
$tour = Tour::create([
|
||||
'id' => 'tour-entity-create-test-en',
|
||||
'label' => 'Tour test english',
|
||||
'langcode' => 'en',
|
||||
'module' => 'system',
|
||||
'routes' => [
|
||||
['route_name' => 'tour_test.1'],
|
||||
],
|
||||
'tips' => [
|
||||
'tour-test-1' => [
|
||||
'id' => 'tour-code-test-1',
|
||||
'plugin' => 'text',
|
||||
'label' => 'The rain in spain',
|
||||
'body' => 'Falls mostly on the plain.',
|
||||
'weight' => '100',
|
||||
'attributes' => [
|
||||
'data-id' => 'tour-code-test-1',
|
||||
],
|
||||
],
|
||||
'tour-code-test-2' => [
|
||||
'id' => 'tour-code-test-2',
|
||||
'plugin' => 'image',
|
||||
'label' => 'The awesome image',
|
||||
'url' => 'http://local/image.png',
|
||||
'weight' => 1,
|
||||
'attributes' => [
|
||||
'data-id' => 'tour-code-test-2'
|
||||
],
|
||||
],
|
||||
],
|
||||
]);
|
||||
$tour->save();
|
||||
|
||||
// Ensure that a tour entity has the expected dependencies based on plugin
|
||||
// providers and the module named in the configuration entity.
|
||||
$dependencies = $tour->calculateDependencies()->getDependencies();
|
||||
$this->assertEqual($dependencies['module'], ['system', 'tour_test']);
|
||||
|
||||
$this->drupalGet('tour-test-1');
|
||||
|
||||
// Load it back from the database and verify storage worked.
|
||||
$entity_save_tip = Tour::load('tour-entity-create-test-en');
|
||||
// Verify that hook_ENTITY_TYPE_load() integration worked.
|
||||
$this->assertEqual($entity_save_tip->loaded, 'Load hooks work');
|
||||
// Verify that hook_ENTITY_TYPE_presave() integration worked.
|
||||
$this->assertEqual($entity_save_tip->label(), 'Tour test english alter');
|
||||
|
||||
// Navigate to tour-test-1 and verify the new tip is found.
|
||||
$this->drupalGet('tour-test-1');
|
||||
$elements = $this->cssSelect("li[data-id=tour-code-test-1] h2:contains('The rain in spain')");
|
||||
$this->assertEqual(count($elements), 1, 'Found the required tip markup for tip 4');
|
||||
|
||||
// Verify that the weight sorting works by ensuring the lower weight item
|
||||
// (tip 4) has the 'End tour' button.
|
||||
$elements = $this->cssSelect("li[data-id=tour-code-test-1][data-text='End tour']");
|
||||
$this->assertEqual(count($elements), 1, 'Found code tip was weighted last and had "End tour".');
|
||||
|
||||
// Test hook_tour_alter().
|
||||
$this->assertText('Altered by hook_tour_tips_alter');
|
||||
|
||||
// Navigate to tour-test-3 and verify the tour_test_1 tip is found with
|
||||
// appropriate classes.
|
||||
$this->drupalGet('tour-test-3/foo');
|
||||
$elements = $this->xpath('//li[@data-id=:data_id and @class=:classes and ./h2[contains(., :text)]]', [
|
||||
':classes' => 'tip-module-tour-test tip-type-text tip-tour-test-1',
|
||||
':data_id' => 'tour-test-1',
|
||||
':text' => 'The first tip',
|
||||
]);
|
||||
$this->assertEqual(count($elements), 1, 'Found English variant of tip 1.');
|
||||
|
||||
// Navigate to tour-test-3 and verify the tour_test_1 tip is not found with
|
||||
// appropriate classes.
|
||||
$this->drupalGet('tour-test-3/bar');
|
||||
$elements = $this->xpath('//li[@data-id=:data_id and @class=:classes and ./h2[contains(., :text)]]', [
|
||||
':classes' => 'tip-module-tour-test tip-type-text tip-tour-test-1',
|
||||
':data_id' => 'tour-test-1',
|
||||
':text' => 'The first tip',
|
||||
]);
|
||||
$this->assertEqual(count($elements), 0, 'Did not find English variant of tip 1.');
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,73 @@
|
||||
<?php
|
||||
|
||||
namespace Drupal\Tests\tour\Functional;
|
||||
|
||||
use Drupal\Tests\BrowserTestBase;
|
||||
|
||||
/**
|
||||
* Base class for testing Tour functionality.
|
||||
*/
|
||||
abstract class TourTestBase extends BrowserTestBase {
|
||||
|
||||
/**
|
||||
* Assert function to determine if tips rendered to the page
|
||||
* have a corresponding page element.
|
||||
*
|
||||
* @param array $tips
|
||||
* A list of tips which provide either a "data-id" or "data-class".
|
||||
*
|
||||
* @code
|
||||
* // Basic example.
|
||||
* $this->assertTourTips();
|
||||
*
|
||||
* // Advanced example. The following would be used for multipage or
|
||||
* // targeting a specific subset of tips.
|
||||
* $tips = array();
|
||||
* $tips[] = array('data-id' => 'foo');
|
||||
* $tips[] = array('data-id' => 'bar');
|
||||
* $tips[] = array('data-class' => 'baz');
|
||||
* $this->assertTourTips($tips);
|
||||
* @endcode
|
||||
*/
|
||||
public function assertTourTips($tips = []) {
|
||||
// Get the rendered tips and their data-id and data-class attributes.
|
||||
if (empty($tips)) {
|
||||
// Tips are rendered as <li> elements inside <ol id="tour">.
|
||||
$rendered_tips = $this->xpath('//ol[@id = "tour"]//li[starts-with(@class, "tip")]');
|
||||
foreach ($rendered_tips as $rendered_tip) {
|
||||
$tips[] = [
|
||||
'data-id' => $rendered_tip->getAttribute('data-id'),
|
||||
'data-class' => $rendered_tip->getAttribute('data-class'),
|
||||
];
|
||||
}
|
||||
}
|
||||
|
||||
// If the tips are still empty we need to fail.
|
||||
if (empty($tips)) {
|
||||
$this->fail('Could not find tour tips on the current page.');
|
||||
}
|
||||
else {
|
||||
// Check for corresponding page elements.
|
||||
$total = 0;
|
||||
$modals = 0;
|
||||
$raw_content = $this->getSession()->getPage()->getContent();
|
||||
foreach ($tips as $tip) {
|
||||
if (!empty($tip['data-id'])) {
|
||||
$elements = \PHPUnit_Util_XML::cssSelect('#' . $tip['data-id'], TRUE, $raw_content, TRUE);
|
||||
$this->assertTrue(!empty($elements) && count($elements) === 1, format_string('Found corresponding page element for tour tip with id #%data-id', ['%data-id' => $tip['data-id']]));
|
||||
}
|
||||
elseif (!empty($tip['data-class'])) {
|
||||
$elements = \PHPUnit_Util_XML::cssSelect('.' . $tip['data-class'], TRUE, $raw_content, TRUE);
|
||||
$this->assertFalse(empty($elements), format_string('Found corresponding page element for tour tip with class .%data-class', ['%data-class' => $tip['data-class']]));
|
||||
}
|
||||
else {
|
||||
// It's a modal.
|
||||
$modals++;
|
||||
}
|
||||
$total++;
|
||||
}
|
||||
$this->pass(format_string('Total %total Tips tested of which %modals modal(s).', ['%total' => $total, '%modals' => $modals]));
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@@ -0,0 +1,70 @@
|
||||
<?php
|
||||
|
||||
namespace Drupal\Tests\tour\Functional;
|
||||
|
||||
/**
|
||||
* Simple tour tips test base.
|
||||
*/
|
||||
abstract class TourTestBasic extends TourTestBase {
|
||||
|
||||
/**
|
||||
* Tour tip attributes to be tested. Keyed by the path.
|
||||
*
|
||||
* @var array
|
||||
* An array of tip attributes, keyed by path.
|
||||
*
|
||||
* @code
|
||||
* protected $tips = array(
|
||||
* '/foo/bar' => array(
|
||||
* array('data-id' => 'foo'),
|
||||
* array('data-class' => 'bar'),
|
||||
* ),
|
||||
* );
|
||||
* @endcode
|
||||
*/
|
||||
protected $tips = [];
|
||||
|
||||
/**
|
||||
* An admin user with administrative permissions for tour.
|
||||
*
|
||||
* @var \Drupal\user\UserInterface
|
||||
*/
|
||||
protected $adminUser;
|
||||
|
||||
/**
|
||||
* The permissions required for a logged in user to test tour tips.
|
||||
*
|
||||
* @var array
|
||||
* A list of permissions.
|
||||
*/
|
||||
protected $permissions = ['access tour'];
|
||||
|
||||
protected function setUp() {
|
||||
parent::setUp();
|
||||
|
||||
// Make sure we are using distinct default and administrative themes for
|
||||
// the duration of these tests.
|
||||
$this->container->get('theme_handler')->install(['bartik', 'seven']);
|
||||
$this->config('system.theme')
|
||||
->set('default', 'bartik')
|
||||
->set('admin', 'seven')
|
||||
->save();
|
||||
|
||||
$this->permissions[] = 'view the administration theme';
|
||||
|
||||
// Create an admin user to view tour tips.
|
||||
$this->adminUser = $this->drupalCreateUser($this->permissions);
|
||||
$this->drupalLogin($this->adminUser);
|
||||
}
|
||||
|
||||
/**
|
||||
* A simple tip test.
|
||||
*/
|
||||
public function testTips() {
|
||||
foreach ($this->tips as $path => $attributes) {
|
||||
$this->drupalGet($path);
|
||||
$this->assertTourTips($attributes);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@@ -7,8 +7,8 @@ package: Testing
|
||||
dependencies:
|
||||
- tour
|
||||
|
||||
# Information added by Drupal.org packaging script on 2017-08-16
|
||||
version: '8.3.7'
|
||||
# Information added by Drupal.org packaging script on 2017-11-03
|
||||
version: '8.4.2'
|
||||
core: '8.x'
|
||||
project: 'drupal'
|
||||
datestamp: 1502903957
|
||||
datestamp: 1509719929
|
||||
|
||||
@@ -5,8 +5,8 @@ package: Core
|
||||
# version: VERSION
|
||||
# core: 8.x
|
||||
|
||||
# Information added by Drupal.org packaging script on 2017-08-16
|
||||
version: '8.3.7'
|
||||
# Information added by Drupal.org packaging script on 2017-11-03
|
||||
version: '8.4.2'
|
||||
core: '8.x'
|
||||
project: 'drupal'
|
||||
datestamp: 1502903957
|
||||
datestamp: 1509719929
|
||||
|
||||
@@ -54,6 +54,7 @@ function tour_toolbar() {
|
||||
'#attributes' => [
|
||||
'class' => ['toolbar-icon', 'toolbar-icon-help'],
|
||||
'aria-pressed' => 'false',
|
||||
'type' => 'button',
|
||||
],
|
||||
],
|
||||
'#wrapper_attributes' => [
|
||||
|
||||
Reference in New Issue
Block a user