Update Composer, update everything
This commit is contained in:
Oliver Davies
parent
ea3e94409f
commit
dda5c284b6
19527 changed files with 1135420 additions and 351004 deletions
|
|
@ -12,9 +12,18 @@ use Drupal\tour\TourInterface;
|
|||
* @ConfigEntityType(
|
||||
* id = "tour",
|
||||
* label = @Translation("Tour"),
|
||||
* label_collection = @Translation("Tours"),
|
||||
* label_singular = @Translation("tour"),
|
||||
* label_plural = @Translation("tours"),
|
||||
* label_count = @PluralTranslation(
|
||||
* singular = "@count tour",
|
||||
* plural = "@count tours",
|
||||
* ),
|
||||
* 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"
|
||||
|
|
|
|||
|
|
@ -39,6 +39,13 @@ class TipPluginText extends TipPluginBase implements ContainerFactoryPluginInter
|
|||
*/
|
||||
protected $location;
|
||||
|
||||
/**
|
||||
* Unique aria-id.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $ariaId;
|
||||
|
||||
/**
|
||||
* Constructs a \Drupal\tour\Plugin\tour\tip\TipPluginText object.
|
||||
*
|
||||
|
|
@ -70,11 +77,10 @@ class TipPluginText extends TipPluginBase implements ContainerFactoryPluginInter
|
|||
* A unique id to be used to generate aria attributes.
|
||||
*/
|
||||
public function getAriaId() {
|
||||
static $id;
|
||||
if (!isset($id)) {
|
||||
$id = Html::getUniqueId($this->get('id'));
|
||||
if (!$this->ariaId) {
|
||||
$this->ariaId = Html::getUniqueId($this->get('id'));
|
||||
}
|
||||
return $id;
|
||||
return $this->ariaId;
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -1,141 +0,0 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\tour\Tests;
|
||||
|
||||
use Drupal\simpletest\WebTestBase;
|
||||
|
||||
/**
|
||||
* Verifies help page display of tours.
|
||||
*
|
||||
* @group help
|
||||
*/
|
||||
class TourHelpPageTest extends WebTestBase {
|
||||
|
||||
/**
|
||||
* 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->assertNoLink($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']];
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -1,188 +0,0 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\tour\Tests;
|
||||
|
||||
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.');
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -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 {
|
||||
|
||||
|
|
@ -50,11 +55,11 @@ abstract class TourTestBase extends WebTestBase {
|
|||
$modals = 0;
|
||||
foreach ($tips as $tip) {
|
||||
if (!empty($tip['data-id'])) {
|
||||
$elements = \PHPUnit_Util_XML::cssSelect('#' . $tip['data-id'], TRUE, $this->content, TRUE);
|
||||
$elements = $this->xpath('//*[@id="' . $tip['data-id'] . '"]');
|
||||
$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, $this->content, TRUE);
|
||||
$elements = $this->xpath('//*[contain(@class, "' . $tip['data-id'] . '")]');
|
||||
$this->assertFalse(empty($elements), format_string('Found corresponding page element for tour tip with class .%data-class', ['%data-class' => $tip['data-class']]));
|
||||
}
|
||||
else {
|
||||
|
|
|
|||
|
|
@ -1,70 +0,0 @@
|
|||
<?php
|
||||
|
||||
namespace Drupal\tour\Tests;
|
||||
|
||||
/**
|
||||
* 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);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
28
web/core/modules/tour/src/TourAccessControlHandler.php
Normal file
28
web/core/modules/tour/src/TourAccessControlHandler.php
Normal file
|
|
@ -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);
|
||||
}
|
||||
|
||||
}
|
||||
Reference in a new issue