From 57ee1b9bf0c4281169afbf8afdee0d9103965b36 Mon Sep 17 00:00:00 2001
From: Kunal Sachdev <57170-kunal.sachdev@users.noreply.drupalcode.org>
Date: Tue, 18 Apr 2023 14:05:52 +0000
Subject: [PATCH] Issue #3346659 by kunal.sachdev, phenaproxima, Wim Leers:
Change 'ignore'/'ignored' to 'exclude'/'excluded' for consistent naming in
public API: CollectIgnoredPathsEvent vs getExcludedPaths()
---
package_manager/package_manager.api.php | 4 +--
...ent.php => CollectPathsToExcludeEvent.php} | 10 +++----
package_manager/src/Event/PreApplyEvent.php | 8 ++---
package_manager/src/Event/PreCreateEvent.php | 8 ++---
.../src/Event/StatusCheckEvent.php | 12 ++++----
.../src/PathExcluder/GitExcluder.php | 8 ++---
.../src/PathExcluder/NodeModulesExcluder.php | 8 ++---
.../src/PathExcluder/PathExclusionsTrait.php | 10 +++----
.../SiteConfigurationExcluder.php | 10 +++----
.../src/PathExcluder/SiteFilesExcluder.php | 10 +++----
.../PathExcluder/SqliteDatabaseExcluder.php | 10 +++----
.../src/PathExcluder/TestSiteExcluder.php | 10 +++----
.../src/PathExcluder/UnknownPathExcluder.php | 8 ++---
.../PathExcluder/VendorHardeningExcluder.php | 10 +++----
package_manager/src/StageBase.php | 22 +++++++-------
package_manager/src/StatusCheckTrait.php | 16 +++++-----
.../src/Validator/SymlinkValidator.php | 10 +++----
.../node_modules/{ignore.txt => exclude.txt} | 0
.../node_modules/{ignore.txt => exclude.txt} | 0
.../private/{ignore.txt => exclude.txt} | 0
.../files/{ignore.txt => exclude.txt} | 0
...ckage_manager_test_validation.services.yml | 4 +--
...=> CollectPathsToExcludeFailValidator.php} | 10 +++----
.../Kernel/PathExcluder/GitExcluderTest.php | 2 +-
.../PathExcluder/NodeModulesExcluderTest.php | 12 ++++----
.../SiteConfigurationExcluderTest.php | 10 +++----
.../PathExcluder/SiteFilesExcluderTest.php | 12 ++++----
.../SqliteDatabaseExcluderTest.php | 12 ++++----
.../PathExcluder/TestSiteExcluderTest.php | 8 ++---
.../PathExcluder/UnknownPathExcluderTest.php | 2 +-
.../VendorHardeningExcluderTest.php | 8 ++---
.../tests/src/Kernel/StageBaseTest.php | 30 +++++++++----------
.../tests/src/Kernel/StatusCheckTraitTest.php | 16 +++++-----
.../tests/src/Kernel/SymlinkValidatorTest.php | 4 +--
.../tests/src/Unit/StatusCheckEventTest.php | 2 +-
35 files changed, 153 insertions(+), 153 deletions(-)
rename package_manager/src/Event/{CollectIgnoredPathsEvent.php => CollectPathsToExcludeEvent.php} (71%)
rename package_manager/tests/fixtures/fake_site/core/node_modules/{ignore.txt => exclude.txt} (100%)
rename package_manager/tests/fixtures/fake_site/modules/example/node_modules/{ignore.txt => exclude.txt} (100%)
rename package_manager/tests/fixtures/fake_site/private/{ignore.txt => exclude.txt} (100%)
rename package_manager/tests/fixtures/fake_site/sites/example.com/files/{ignore.txt => exclude.txt} (100%)
rename package_manager/tests/modules/package_manager_test_validation/src/{CollectIgnoredPathsFailValidator.php => CollectPathsToExcludeFailValidator.php} (73%)
diff --git a/package_manager/package_manager.api.php b/package_manager/package_manager.api.php
index 55e38a1b32..d288666b8a 100644
--- a/package_manager/package_manager.api.php
+++ b/package_manager/package_manager.api.php
@@ -233,11 +233,11 @@
* irrelevant to Composer or Package Manager. Examples include settings.php
* and related files, public and private files, SQLite databases, and git
* repositories. Custom code can subscribe to
- * Drupal\package_manager\Event\CollectIgnoredPathsEvent to flag paths which
+ * Drupal\package_manager\Event\CollectPathsToExcludeEvent to flag paths which
* should never be copied into the stage directory from the active directory or
* vice versa.
*
- * @see \Drupal\package_manager\Event\CollectIgnoredPathsEvent
+ * @see \Drupal\package_manager\Event\CollectPathsToExcludeEvent
*
* @section sec_services Useful services
* The following services are especially useful to validators:
diff --git a/package_manager/src/Event/CollectIgnoredPathsEvent.php b/package_manager/src/Event/CollectPathsToExcludeEvent.php
similarity index 71%
rename from package_manager/src/Event/CollectIgnoredPathsEvent.php
rename to package_manager/src/Event/CollectPathsToExcludeEvent.php
index 3a1f5cdb75..fce262b015 100644
--- a/package_manager/src/Event/CollectIgnoredPathsEvent.php
+++ b/package_manager/src/Event/CollectPathsToExcludeEvent.php
@@ -9,15 +9,15 @@ use PhpTuf\ComposerStager\Domain\Value\PathList\PathListInterface;
use PhpTuf\ComposerStager\Infrastructure\Value\PathList\PathList;
/**
- * Defines an event that collects ignored paths.
+ * Defines an event that collects paths to exclude.
*
- * Ignored paths are completely ignored by Composer Stager. They are never
- * copied into the stage directory from the active directory, or vice-versa.
+ * These paths are excluded by Composer Stager and are never copied into the
+ * stage directory from the active directory, or vice-versa.
*/
-class CollectIgnoredPathsEvent extends StageEvent implements PathListInterface {
+class CollectPathsToExcludeEvent extends StageEvent implements PathListInterface {
/**
- * The list of ignored paths.
+ * The list of paths to exclude.
*
* @var \PhpTuf\ComposerStager\Domain\Value\PathList\PathListInterface
*/
diff --git a/package_manager/src/Event/PreApplyEvent.php b/package_manager/src/Event/PreApplyEvent.php
index 4642b46bb3..87fbb05848 100644
--- a/package_manager/src/Event/PreApplyEvent.php
+++ b/package_manager/src/Event/PreApplyEvent.php
@@ -18,15 +18,15 @@ class PreApplyEvent extends PreOperationStageEvent {
*
* @param \Drupal\package_manager\StageBase $stage
* The stage which fired this event.
- * @param string[] $ignored_paths
- * The list of ignored paths. These will not be copied from the stage
+ * @param string[] $paths_to_exclude
+ * The list of paths to exclude. These will not be copied from the stage
* directory to the active directory, nor be deleted from the active
* directory if they exist, when the stage directory is copied back into
* the active directory.
*/
- public function __construct(StageBase $stage, array $ignored_paths) {
+ public function __construct(StageBase $stage, array $paths_to_exclude) {
parent::__construct($stage);
- $this->excludedPaths = $ignored_paths;
+ $this->excludedPaths = $paths_to_exclude;
}
}
diff --git a/package_manager/src/Event/PreCreateEvent.php b/package_manager/src/Event/PreCreateEvent.php
index 93d6fa5b8a..2a369c62ce 100644
--- a/package_manager/src/Event/PreCreateEvent.php
+++ b/package_manager/src/Event/PreCreateEvent.php
@@ -18,13 +18,13 @@ class PreCreateEvent extends PreOperationStageEvent {
*
* @param \Drupal\package_manager\StageBase $stage
* The stage which fired this event.
- * @param string[] $ignored_paths
- * The list of ignored paths. These will not be copied into the stage
+ * @param string[] $paths_to_exclude
+ * The list of paths to exclude. These will not be copied into the stage
* directory when it is created.
*/
- public function __construct(StageBase $stage, array $ignored_paths) {
+ public function __construct(StageBase $stage, array $paths_to_exclude) {
parent::__construct($stage);
- $this->excludedPaths = $ignored_paths;
+ $this->excludedPaths = $paths_to_exclude;
}
}
diff --git a/package_manager/src/Event/StatusCheckEvent.php b/package_manager/src/Event/StatusCheckEvent.php
index 12a9fa2945..443e2a8856 100644
--- a/package_manager/src/Event/StatusCheckEvent.php
+++ b/package_manager/src/Event/StatusCheckEvent.php
@@ -28,12 +28,12 @@ class StatusCheckEvent extends PreOperationStageEvent {
* this event.
*/
public function getExcludedPaths(): ?array {
- if (isset($this->excludedPaths)) {
- return array_unique($this->excludedPaths);
+ if (isset($this->pathsToExclude)) {
+ return array_unique($this->pathsToExclude);
}
if (empty($this->getResults(SystemManager::REQUIREMENT_ERROR))) {
- throw new \LogicException('$ignored_paths should only be NULL if the error that caused the paths to not be collected was added to the status check event.');
+ throw new \LogicException('$paths_to_exclude should only be NULL if the error that caused the paths to not be collected was added to the status check event.');
}
return NULL;
}
@@ -43,10 +43,10 @@ class StatusCheckEvent extends PreOperationStageEvent {
*
* @param \Drupal\package_manager\StageBase $stage
* The stage which fired this event.
- * @param string[]|null $excludedPaths
- * The list of ignored paths, or NULL if they could not be collected.
+ * @param string[]|null $pathsToExclude
+ * The list of paths to exclude, or NULL if they could not be collected.
*/
- public function __construct(StageBase $stage, private ?array $excludedPaths) {
+ public function __construct(StageBase $stage, private ?array $pathsToExclude) {
parent::__construct($stage);
}
diff --git a/package_manager/src/PathExcluder/GitExcluder.php b/package_manager/src/PathExcluder/GitExcluder.php
index a7f4c6eb62..c7efb7fa52 100644
--- a/package_manager/src/PathExcluder/GitExcluder.php
+++ b/package_manager/src/PathExcluder/GitExcluder.php
@@ -5,7 +5,7 @@ declare(strict_types = 1);
namespace Drupal\package_manager\PathExcluder;
use Drupal\package_manager\ComposerInspector;
-use Drupal\package_manager\Event\CollectIgnoredPathsEvent;
+use Drupal\package_manager\Event\CollectPathsToExcludeEvent;
use Drupal\package_manager\PathLocator;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
@@ -38,20 +38,20 @@ final class GitExcluder implements EventSubscriberInterface {
*/
public static function getSubscribedEvents(): array {
return [
- CollectIgnoredPathsEvent::class => 'excludeGitDirectories',
+ CollectPathsToExcludeEvent::class => 'excludeGitDirectories',
];
}
/**
* Excludes .git directories from stage operations.
*
- * @param \Drupal\package_manager\Event\CollectIgnoredPathsEvent $event
+ * @param \Drupal\package_manager\Event\CollectPathsToExcludeEvent $event
* The event object.
*
* @throws \Exception
* See \Drupal\package_manager\ComposerInspector::validate().
*/
- public function excludeGitDirectories(CollectIgnoredPathsEvent $event): void {
+ public function excludeGitDirectories(CollectPathsToExcludeEvent $event): void {
$project_root = $this->pathLocator->getProjectRoot();
// To determine which .git directories to exclude, the installed packages
diff --git a/package_manager/src/PathExcluder/NodeModulesExcluder.php b/package_manager/src/PathExcluder/NodeModulesExcluder.php
index 182207cef7..21c1278024 100644
--- a/package_manager/src/PathExcluder/NodeModulesExcluder.php
+++ b/package_manager/src/PathExcluder/NodeModulesExcluder.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\package_manager\PathExcluder;
-use Drupal\package_manager\Event\CollectIgnoredPathsEvent;
+use Drupal\package_manager\Event\CollectPathsToExcludeEvent;
use Drupal\package_manager\PathLocator;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
@@ -33,10 +33,10 @@ class NodeModulesExcluder implements EventSubscriberInterface {
/**
* Excludes node_modules directories from stage operations.
*
- * @param \Drupal\package_manager\Event\CollectIgnoredPathsEvent $event
+ * @param \Drupal\package_manager\Event\CollectPathsToExcludeEvent $event
* The event object.
*/
- public function excludeNodeModulesFiles(CollectIgnoredPathsEvent $event): void {
+ public function excludeNodeModulesFiles(CollectPathsToExcludeEvent $event): void {
$paths = $this->scanForDirectoriesByName('node_modules');
$this->excludeInProjectRoot($event, $paths);
}
@@ -46,7 +46,7 @@ class NodeModulesExcluder implements EventSubscriberInterface {
*/
public static function getSubscribedEvents(): array {
return [
- CollectIgnoredPathsEvent::class => 'excludeNodeModulesFiles',
+ CollectPathsToExcludeEvent::class => 'excludeNodeModulesFiles',
];
}
diff --git a/package_manager/src/PathExcluder/PathExclusionsTrait.php b/package_manager/src/PathExcluder/PathExclusionsTrait.php
index a97a77d10a..9f417a78f3 100644
--- a/package_manager/src/PathExcluder/PathExclusionsTrait.php
+++ b/package_manager/src/PathExcluder/PathExclusionsTrait.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\package_manager\PathExcluder;
-use Drupal\package_manager\Event\CollectIgnoredPathsEvent;
+use Drupal\package_manager\Event\CollectPathsToExcludeEvent;
/**
* Contains methods for excluding paths from stage operations.
@@ -24,13 +24,13 @@ trait PathExclusionsTrait {
* This should only be used for paths that, if they exist at all, are
* *guaranteed* to exist within the web root.
*
- * @param \Drupal\package_manager\Event\CollectIgnoredPathsEvent|\Drupal\package_manager\Event\StageEvent $event
+ * @param \Drupal\package_manager\Event\CollectPathsToExcludeEvent|\Drupal\package_manager\Event\StageEvent $event
* The event object.
* @param string[] $paths
* The paths to exclude. These should be relative to the web root, and will
* be made relative to the project root.
*/
- protected function excludeInWebRoot(CollectIgnoredPathsEvent $event, array $paths): void {
+ protected function excludeInWebRoot(CollectPathsToExcludeEvent $event, array $paths): void {
$web_root = $this->pathLocator->getWebRoot();
if ($web_root) {
$web_root .= '/';
@@ -45,14 +45,14 @@ trait PathExclusionsTrait {
/**
* Flags paths to be excluded, relative to the project root.
*
- * @param \Drupal\package_manager\Event\CollectIgnoredPathsEvent|\Drupal\package_manager\Event\StageEvent $event
+ * @param \Drupal\package_manager\Event\CollectPathsToExcludeEvent|\Drupal\package_manager\Event\StageEvent $event
* The event object.
* @param string[] $paths
* The paths to exclude. Absolute paths will be made relative to the project
* root; relative paths will be assumed to already be relative to the
* project root, and excluded as given.
*/
- protected function excludeInProjectRoot(CollectIgnoredPathsEvent $event, array $paths): void {
+ protected function excludeInProjectRoot(CollectPathsToExcludeEvent $event, array $paths): void {
$project_root = $this->pathLocator->getProjectRoot();
foreach ($paths as $path) {
diff --git a/package_manager/src/PathExcluder/SiteConfigurationExcluder.php b/package_manager/src/PathExcluder/SiteConfigurationExcluder.php
index cae826d567..b692110cfa 100644
--- a/package_manager/src/PathExcluder/SiteConfigurationExcluder.php
+++ b/package_manager/src/PathExcluder/SiteConfigurationExcluder.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\package_manager\PathExcluder;
-use Drupal\package_manager\Event\CollectIgnoredPathsEvent;
+use Drupal\package_manager\Event\CollectPathsToExcludeEvent;
use Drupal\package_manager\PathLocator;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
@@ -35,14 +35,14 @@ class SiteConfigurationExcluder implements EventSubscriberInterface {
/**
* Excludes site configuration files from stage operations.
*
- * @param \Drupal\package_manager\Event\CollectIgnoredPathsEvent $event
+ * @param \Drupal\package_manager\Event\CollectPathsToExcludeEvent $event
* The event object.
*/
- public function excludeSiteConfiguration(CollectIgnoredPathsEvent $event): void {
+ public function excludeSiteConfiguration(CollectPathsToExcludeEvent $event): void {
// Site configuration files are always excluded relative to the web root.
$paths = [];
- // Ignore site-specific settings files, which are always in the web root.
+ // Exclude site-specific settings files, which are always in the web root.
// By default, Drupal core will always try to write-protect these files.
$settings_files = [
'settings.php',
@@ -61,7 +61,7 @@ class SiteConfigurationExcluder implements EventSubscriberInterface {
*/
public static function getSubscribedEvents(): array {
return [
- CollectIgnoredPathsEvent::class => 'excludeSiteConfiguration',
+ CollectPathsToExcludeEvent::class => 'excludeSiteConfiguration',
];
}
diff --git a/package_manager/src/PathExcluder/SiteFilesExcluder.php b/package_manager/src/PathExcluder/SiteFilesExcluder.php
index dea85eed53..4967e44265 100644
--- a/package_manager/src/PathExcluder/SiteFilesExcluder.php
+++ b/package_manager/src/PathExcluder/SiteFilesExcluder.php
@@ -6,7 +6,7 @@ namespace Drupal\package_manager\PathExcluder;
use Drupal\Core\StreamWrapper\LocalStream;
use Drupal\Core\StreamWrapper\StreamWrapperManagerInterface;
-use Drupal\package_manager\Event\CollectIgnoredPathsEvent;
+use Drupal\package_manager\Event\CollectPathsToExcludeEvent;
use Drupal\package_manager\PathLocator;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\Filesystem\Filesystem;
@@ -42,18 +42,18 @@ final class SiteFilesExcluder implements EventSubscriberInterface {
*/
public static function getSubscribedEvents(): array {
return [
- CollectIgnoredPathsEvent::class => 'excludeSiteFiles',
+ CollectPathsToExcludeEvent::class => 'excludeSiteFiles',
];
}
/**
* Excludes public and private files from stage operations.
*
- * @param \Drupal\package_manager\Event\CollectIgnoredPathsEvent $event
+ * @param \Drupal\package_manager\Event\CollectPathsToExcludeEvent $event
* The event object.
*/
- public function excludeSiteFiles(CollectIgnoredPathsEvent $event): void {
- // Ignore public and private files. These paths could be either absolute or
+ public function excludeSiteFiles(CollectPathsToExcludeEvent $event): void {
+ // Exclude public and private files. These paths could be either absolute or
// relative, depending on site settings. If they are absolute, treat them
// as relative to the project root. Otherwise, treat them as relative to
// the web root.
diff --git a/package_manager/src/PathExcluder/SqliteDatabaseExcluder.php b/package_manager/src/PathExcluder/SqliteDatabaseExcluder.php
index 9afa102fa3..260b28ae1b 100644
--- a/package_manager/src/PathExcluder/SqliteDatabaseExcluder.php
+++ b/package_manager/src/PathExcluder/SqliteDatabaseExcluder.php
@@ -5,7 +5,7 @@ declare(strict_types = 1);
namespace Drupal\package_manager\PathExcluder;
use Drupal\Core\Database\Connection;
-use Drupal\package_manager\Event\CollectIgnoredPathsEvent;
+use Drupal\package_manager\Event\CollectPathsToExcludeEvent;
use Drupal\package_manager\PathLocator;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
@@ -38,19 +38,19 @@ class SqliteDatabaseExcluder implements EventSubscriberInterface {
*/
public static function getSubscribedEvents(): array {
return [
- CollectIgnoredPathsEvent::class => 'excludeDatabaseFiles',
+ CollectPathsToExcludeEvent::class => 'excludeDatabaseFiles',
];
}
/**
* Excludes SQLite database files from stage operations.
*
- * @param \Drupal\package_manager\Event\CollectIgnoredPathsEvent $event
+ * @param \Drupal\package_manager\Event\CollectPathsToExcludeEvent $event
* The event object.
*/
- public function excludeDatabaseFiles(CollectIgnoredPathsEvent $event): void {
+ public function excludeDatabaseFiles(CollectPathsToExcludeEvent $event): void {
// If the database is SQLite, it might be located in the active directory
- // and we should ignore it. Always treat it as relative to the project root.
+ // and we should exclude it. Always treat it as relative to the project root.
if ($this->database->driver() === 'sqlite') {
$options = $this->database->getConnectionOptions();
// Nothing to exclude if the database lives outside the project root.
diff --git a/package_manager/src/PathExcluder/TestSiteExcluder.php b/package_manager/src/PathExcluder/TestSiteExcluder.php
index 8c2b82fd9b..7548d82ef6 100644
--- a/package_manager/src/PathExcluder/TestSiteExcluder.php
+++ b/package_manager/src/PathExcluder/TestSiteExcluder.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\package_manager\PathExcluder;
-use Drupal\package_manager\Event\CollectIgnoredPathsEvent;
+use Drupal\package_manager\Event\CollectPathsToExcludeEvent;
use Drupal\package_manager\PathLocator;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
@@ -35,18 +35,18 @@ final class TestSiteExcluder implements EventSubscriberInterface {
*/
public static function getSubscribedEvents(): array {
return [
- CollectIgnoredPathsEvent::class => 'excludeTestSites',
+ CollectPathsToExcludeEvent::class => 'excludeTestSites',
];
}
/**
* Excludes sites/simpletest from stage operations.
*
- * @param \Drupal\package_manager\Event\CollectIgnoredPathsEvent $event
+ * @param \Drupal\package_manager\Event\CollectPathsToExcludeEvent $event
* The event object.
*/
- public function excludeTestSites(CollectIgnoredPathsEvent $event): void {
- // Always ignore automated test directories. If they exist, they will be in
+ public function excludeTestSites(CollectPathsToExcludeEvent $event): void {
+ // Always exclude automated test directories. If they exist, they will be in
// the web root.
$this->excludeInWebRoot($event, ['sites/simpletest']);
}
diff --git a/package_manager/src/PathExcluder/UnknownPathExcluder.php b/package_manager/src/PathExcluder/UnknownPathExcluder.php
index 85eeb3a999..8c31a600ce 100644
--- a/package_manager/src/PathExcluder/UnknownPathExcluder.php
+++ b/package_manager/src/PathExcluder/UnknownPathExcluder.php
@@ -6,7 +6,7 @@ namespace Drupal\package_manager\PathExcluder;
use Drupal\Component\Serialization\Json;
use Drupal\package_manager\ComposerInspector;
-use Drupal\package_manager\Event\CollectIgnoredPathsEvent;
+use Drupal\package_manager\Event\CollectPathsToExcludeEvent;
use Drupal\package_manager\PathLocator;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
@@ -49,20 +49,20 @@ final class UnknownPathExcluder implements EventSubscriberInterface {
*/
public static function getSubscribedEvents(): array {
return [
- CollectIgnoredPathsEvent::class => 'excludeUnknownPaths',
+ CollectPathsToExcludeEvent::class => 'excludeUnknownPaths',
];
}
/**
* Excludes unknown paths from stage operations.
*
- * @param \Drupal\package_manager\Event\CollectIgnoredPathsEvent $event
+ * @param \Drupal\package_manager\Event\CollectPathsToExcludeEvent $event
* The event object.
*
* @throws \Exception
* See \Drupal\package_manager\ComposerInspector::validate().
*/
- public function excludeUnknownPaths(CollectIgnoredPathsEvent $event): void {
+ public function excludeUnknownPaths(CollectPathsToExcludeEvent $event): void {
$project_root = $this->pathLocator->getProjectRoot();
$web_root = $project_root . DIRECTORY_SEPARATOR . $this->pathLocator->getWebRoot();
if (realpath($web_root) === $project_root) {
diff --git a/package_manager/src/PathExcluder/VendorHardeningExcluder.php b/package_manager/src/PathExcluder/VendorHardeningExcluder.php
index 3172251fe8..a7bf69d7c9 100644
--- a/package_manager/src/PathExcluder/VendorHardeningExcluder.php
+++ b/package_manager/src/PathExcluder/VendorHardeningExcluder.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\package_manager\PathExcluder;
-use Drupal\package_manager\Event\CollectIgnoredPathsEvent;
+use Drupal\package_manager\Event\CollectPathsToExcludeEvent;
use Drupal\package_manager\PathLocator;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
@@ -35,20 +35,20 @@ final class VendorHardeningExcluder implements EventSubscriberInterface {
*/
public static function getSubscribedEvents(): array {
return [
- CollectIgnoredPathsEvent::class => 'excludeVendorHardeningFiles',
+ CollectPathsToExcludeEvent::class => 'excludeVendorHardeningFiles',
];
}
/**
* Excludes vendor hardening files from stage operations.
*
- * @param \Drupal\package_manager\Event\CollectIgnoredPathsEvent $event
+ * @param \Drupal\package_manager\Event\CollectPathsToExcludeEvent $event
* The event object.
*/
- public function excludeVendorHardeningFiles(CollectIgnoredPathsEvent $event): void {
+ public function excludeVendorHardeningFiles(CollectPathsToExcludeEvent $event): void {
// If the core-vendor-hardening plugin (used in the legacy-project template)
// is present, it may have written security hardening files in the vendor
- // directory. They should always be ignored.
+ // directory. They should always be excluded.
$vendor_dir = $this->pathLocator->getVendorDirectory();
$this->excludeInProjectRoot($event, [
$vendor_dir . '/web.config',
diff --git a/package_manager/src/StageBase.php b/package_manager/src/StageBase.php
index 848f656d81..44ac4bb846 100644
--- a/package_manager/src/StageBase.php
+++ b/package_manager/src/StageBase.php
@@ -13,7 +13,7 @@ use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\Core\TempStore\SharedTempStore;
use Drupal\Core\TempStore\SharedTempStoreFactory;
-use Drupal\package_manager\Event\CollectIgnoredPathsEvent;
+use Drupal\package_manager\Event\CollectPathsToExcludeEvent;
use Drupal\package_manager\Event\PostApplyEvent;
use Drupal\package_manager\Event\PostCreateEvent;
use Drupal\package_manager\Event\PostDestroyEvent;
@@ -250,20 +250,20 @@ abstract class StageBase implements LoggerAwareInterface {
}
/**
- * Collects paths that Composer Stager should ignore.
+ * Collects paths that Composer Stager should exclude.
*
* @return string[]
- * A list of paths that Composer Stager should ignore when creating the
+ * A list of paths that Composer Stager should exclude when creating the
* stage directory and applying staged changes to the active directory.
*
* @throws \Drupal\package_manager\Exception\StageException
- * Thrown if an exception occurs while collecting ignored paths.
+ * Thrown if an exception occurs while collecting paths to exclude.
*
* @see ::create()
* @see ::apply()
*/
- protected function getIgnoredPaths(): array {
- $event = new CollectIgnoredPathsEvent($this);
+ protected function getPathsToExclude(): array {
+ $event = new CollectPathsToExcludeEvent($this);
try {
$this->eventDispatcher->dispatch($event);
}
@@ -322,7 +322,7 @@ abstract class StageBase implements LoggerAwareInterface {
$active_dir = $this->pathFactory->create($this->pathLocator->getProjectRoot());
$stage_dir = $this->pathFactory->create($this->getStageDirectory());
- $event = new PreCreateEvent($this, $this->getIgnoredPaths());
+ $event = new PreCreateEvent($this, $this->getPathsToExclude());
// If an error occurs and we won't be able to create the stage, mark it as
// available.
$this->dispatch($event, [$this, 'markAsAvailable']);
@@ -443,20 +443,20 @@ abstract class StageBase implements LoggerAwareInterface {
// If an error occurs while dispatching the events, ensure that ::destroy()
// doesn't think we're in the middle of applying the staged changes to the
// active directory.
- $event = new PreApplyEvent($this, $this->getIgnoredPaths());
+ $event = new PreApplyEvent($this, $this->getPathsToExclude());
$this->tempStore->set(self::TEMPSTORE_APPLY_TIME_KEY, $this->time->getRequestTime());
$this->dispatch($event, $this->setNotApplying());
// Create a marker file so that we can tell later on if the commit failed.
$this->failureMarker->write($this, $this->getFailureMarkerMessage());
// Exclude the failure file from the commit operation.
- $ignored_paths = new PathList($event->getExcludedPaths());
- $ignored_paths->add([
+ $paths_to_exclude = new PathList($event->getExcludedPaths());
+ $paths_to_exclude->add([
$this->failureMarker->getPath(),
]);
try {
- $this->committer->commit($stage_dir, $active_dir, $ignored_paths, NULL, $timeout);
+ $this->committer->commit($stage_dir, $active_dir, $paths_to_exclude, NULL, $timeout);
}
catch (InvalidArgumentException | PreconditionException $e) {
// The commit operation has not started yet, so we can clear the failure
diff --git a/package_manager/src/StatusCheckTrait.php b/package_manager/src/StatusCheckTrait.php
index ae72f5db72..3de0a1b6b2 100644
--- a/package_manager/src/StatusCheckTrait.php
+++ b/package_manager/src/StatusCheckTrait.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\package_manager;
-use Drupal\package_manager\Event\CollectIgnoredPathsEvent;
+use Drupal\package_manager\Event\CollectPathsToExcludeEvent;
use Drupal\package_manager\Event\StatusCheckEvent;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
@@ -33,20 +33,20 @@ trait StatusCheckTrait {
protected function runStatusCheck(StageBase $stage, EventDispatcherInterface $event_dispatcher = NULL): array {
$event_dispatcher ??= \Drupal::service('event_dispatcher');
try {
- $ignored_paths_event = new CollectIgnoredPathsEvent($stage);
- $event_dispatcher->dispatch($ignored_paths_event);
- $event = new StatusCheckEvent($stage, $ignored_paths_event->getAll());
+ $paths_to_exclude_event = new CollectPathsToExcludeEvent($stage);
+ $event_dispatcher->dispatch($paths_to_exclude_event);
+ $event = new StatusCheckEvent($stage, $paths_to_exclude_event->getAll());
}
catch (\Throwable $throwable) {
- // We can dispatch the status check event without the ignored paths, but
- // it must be set explicitly to NULL, to allow those status checks to run
- // that do not need the ignored paths.
+ // We can dispatch the status check event without the paths to exclude,
+ // but it must be set explicitly to NULL, to allow those status checks to
+ // run that do not need the paths to exclude.
$event = new StatusCheckEvent($stage, NULL);
// Add the error that was encountered so that regardless of any other
// validation errors BaseRequirementsFulfilledValidator will stop the
// event propagation after the base requirement validators have run.
// @see \Drupal\package_manager\Validator\BaseRequirementsFulfilledValidator
- $event->addErrorFromThrowable($throwable, t('Unable to collect the ignored paths.'));
+ $event->addErrorFromThrowable($throwable, t('Unable to collect the paths to exclude.'));
}
$event_dispatcher->dispatch($event);
diff --git a/package_manager/src/Validator/SymlinkValidator.php b/package_manager/src/Validator/SymlinkValidator.php
index 84e14fc3b1..0eb93e911d 100644
--- a/package_manager/src/Validator/SymlinkValidator.php
+++ b/package_manager/src/Validator/SymlinkValidator.php
@@ -61,17 +61,17 @@ class SymlinkValidator implements EventSubscriberInterface {
}
$stage_dir = $this->pathFactory->create($stage_dir);
- $ignored_paths = $event->getExcludedPaths();
- // Return early if no ignored paths were collected because this validator
- // is dependent on knowing which paths to ignore when searching for
+ $excluded_paths = $event->getExcludedPaths();
+ // Return early if no excluded paths were collected because this validator
+ // is dependent on knowing which paths to exclude when searching for
// symlinks.
// @see \Drupal\package_manager\StatusCheckTrait::runStatusCheck()
- if ($ignored_paths === NULL) {
+ if ($excluded_paths === NULL) {
return;
}
try {
- $this->precondition->assertIsFulfilled($active_dir, $stage_dir, new PathList($ignored_paths));
+ $this->precondition->assertIsFulfilled($active_dir, $stage_dir, new PathList($excluded_paths));
}
catch (PreconditionException $e) {
$event->addErrorFromThrowable($e);
diff --git a/package_manager/tests/fixtures/fake_site/core/node_modules/ignore.txt b/package_manager/tests/fixtures/fake_site/core/node_modules/exclude.txt
similarity index 100%
rename from package_manager/tests/fixtures/fake_site/core/node_modules/ignore.txt
rename to package_manager/tests/fixtures/fake_site/core/node_modules/exclude.txt
diff --git a/package_manager/tests/fixtures/fake_site/modules/example/node_modules/ignore.txt b/package_manager/tests/fixtures/fake_site/modules/example/node_modules/exclude.txt
similarity index 100%
rename from package_manager/tests/fixtures/fake_site/modules/example/node_modules/ignore.txt
rename to package_manager/tests/fixtures/fake_site/modules/example/node_modules/exclude.txt
diff --git a/package_manager/tests/fixtures/fake_site/private/ignore.txt b/package_manager/tests/fixtures/fake_site/private/exclude.txt
similarity index 100%
rename from package_manager/tests/fixtures/fake_site/private/ignore.txt
rename to package_manager/tests/fixtures/fake_site/private/exclude.txt
diff --git a/package_manager/tests/fixtures/fake_site/sites/example.com/files/ignore.txt b/package_manager/tests/fixtures/fake_site/sites/example.com/files/exclude.txt
similarity index 100%
rename from package_manager/tests/fixtures/fake_site/sites/example.com/files/ignore.txt
rename to package_manager/tests/fixtures/fake_site/sites/example.com/files/exclude.txt
diff --git a/package_manager/tests/modules/package_manager_test_validation/package_manager_test_validation.services.yml b/package_manager/tests/modules/package_manager_test_validation/package_manager_test_validation.services.yml
index 20ac1d0eff..bd41327d31 100644
--- a/package_manager/tests/modules/package_manager_test_validation/package_manager_test_validation.services.yml
+++ b/package_manager/tests/modules/package_manager_test_validation/package_manager_test_validation.services.yml
@@ -5,8 +5,8 @@ services:
- '@state'
tags:
- { name: event_subscriber }
- package_manager.validator.collect_ignored_paths_fail:
- class: Drupal\package_manager_test_validation\CollectIgnoredPathsFailValidator
+ package_manager.validator.collect_paths_to_exclude_fail:
+ class: Drupal\package_manager_test_validation\CollectPathsToExcludeFailValidator
autowire: true
tags:
- { name: event_subscriber }
diff --git a/package_manager/tests/modules/package_manager_test_validation/src/CollectIgnoredPathsFailValidator.php b/package_manager/tests/modules/package_manager_test_validation/src/CollectPathsToExcludeFailValidator.php
similarity index 73%
rename from package_manager/tests/modules/package_manager_test_validation/src/CollectIgnoredPathsFailValidator.php
rename to package_manager/tests/modules/package_manager_test_validation/src/CollectPathsToExcludeFailValidator.php
index 29b0a783cc..bb06aab231 100644
--- a/package_manager/tests/modules/package_manager_test_validation/src/CollectIgnoredPathsFailValidator.php
+++ b/package_manager/tests/modules/package_manager_test_validation/src/CollectPathsToExcludeFailValidator.php
@@ -5,17 +5,17 @@ declare(strict_types = 1);
namespace Drupal\package_manager_test_validation;
use Drupal\package_manager\ComposerInspector;
-use Drupal\package_manager\Event\CollectIgnoredPathsEvent;
+use Drupal\package_manager\Event\CollectPathsToExcludeEvent;
use Drupal\package_manager\PathLocator;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
/**
- * Allows to test an excluder which fails on CollectIgnoredPathsEvent.
+ * Allows to test an excluder which fails on CollectPathsToExcludeEvent.
*/
-class CollectIgnoredPathsFailValidator implements EventSubscriberInterface {
+class CollectPathsToExcludeFailValidator implements EventSubscriberInterface {
/**
- * Constructs a CollectIgnoredPathsFailValidator object.
+ * Constructs a CollectPathsToExcludeFailValidator object.
*
* @param \Drupal\package_manager\ComposerInspector $composerInspector
* The Composer inspector service.
@@ -30,7 +30,7 @@ class CollectIgnoredPathsFailValidator implements EventSubscriberInterface {
*/
public static function getSubscribedEvents(): array {
return [
- CollectIgnoredPathsEvent::class => 'callToComposer',
+ CollectPathsToExcludeEvent::class => 'callToComposer',
];
}
diff --git a/package_manager/tests/src/Kernel/PathExcluder/GitExcluderTest.php b/package_manager/tests/src/Kernel/PathExcluder/GitExcluderTest.php
index fc15ef2155..9cc07c5e45 100644
--- a/package_manager/tests/src/Kernel/PathExcluder/GitExcluderTest.php
+++ b/package_manager/tests/src/Kernel/PathExcluder/GitExcluderTest.php
@@ -114,7 +114,7 @@ class GitExcluderTest extends PackageManagerKernelTestBase {
'core_version_requirement' => '^9.7 || ^10',
])
);
- file_put_contents("$path/.git/ignored.txt", 'Phoenix!');
+ file_put_contents("$path/.git/excluded.txt", 'Phoenix!');
$stage->apply();
/** @var \Drupal\package_manager_bypass\BypassedStagerServiceBase $committer */
diff --git a/package_manager/tests/src/Kernel/PathExcluder/NodeModulesExcluderTest.php b/package_manager/tests/src/Kernel/PathExcluder/NodeModulesExcluderTest.php
index db5eada539..88c6dcd438 100644
--- a/package_manager/tests/src/Kernel/PathExcluder/NodeModulesExcluderTest.php
+++ b/package_manager/tests/src/Kernel/PathExcluder/NodeModulesExcluderTest.php
@@ -32,18 +32,18 @@ class NodeModulesExcluderTest extends PackageManagerKernelTestBase {
$stage->require(['ext-json:*']);
$stage_dir = $stage->getStageDirectory();
- $ignored = [
- "core/node_modules/ignore.txt",
- 'modules/example/node_modules/ignore.txt',
+ $excluded = [
+ "core/node_modules/exclude.txt",
+ 'modules/example/node_modules/exclude.txt',
];
- foreach ($ignored as $path) {
+ foreach ($excluded as $path) {
$this->assertFileExists("$active_dir/$path");
$this->assertFileDoesNotExist("$stage_dir/$path");
}
$stage->apply();
- // The ignored files should still be in the active directory.
- foreach ($ignored as $path) {
+ // The excluded files should still be in the active directory.
+ foreach ($excluded as $path) {
$this->assertFileExists("$active_dir/$path");
}
}
diff --git a/package_manager/tests/src/Kernel/PathExcluder/SiteConfigurationExcluderTest.php b/package_manager/tests/src/Kernel/PathExcluder/SiteConfigurationExcluderTest.php
index ae8838e783..0d72207fdf 100644
--- a/package_manager/tests/src/Kernel/PathExcluder/SiteConfigurationExcluderTest.php
+++ b/package_manager/tests/src/Kernel/PathExcluder/SiteConfigurationExcluderTest.php
@@ -49,16 +49,16 @@ class SiteConfigurationExcluderTest extends PackageManagerKernelTestBase {
$stage->require(['ext-json:*']);
$stage_dir = $stage->getStageDirectory();
- $ignore = [
+ $excluded = [
"$site_path/settings.php",
"$site_path/settings.local.php",
"$site_path/services.yml",
- // Default site-specific settings files should be ignored.
+ // Default site-specific settings files should be excluded.
'sites/default/settings.php',
'sites/default/settings.local.php',
'sites/default/services.yml',
];
- foreach ($ignore as $path) {
+ foreach ($excluded as $path) {
$this->assertFileExists("$active_dir/$path");
$this->assertFileDoesNotExist("$stage_dir/$path");
}
@@ -74,8 +74,8 @@ class SiteConfigurationExcluderTest extends PackageManagerKernelTestBase {
$stage->apply();
$this->assertFileExists("$active_dir/sites/default/new.txt");
- // The ignored files should still be in the active directory.
- foreach ($ignore as $path) {
+ // The excluded files should still be in the active directory.
+ foreach ($excluded as $path) {
$this->assertFileExists("$active_dir/$path");
}
}
diff --git a/package_manager/tests/src/Kernel/PathExcluder/SiteFilesExcluderTest.php b/package_manager/tests/src/Kernel/PathExcluder/SiteFilesExcluderTest.php
index bc8d7002a3..74c0a47ee2 100644
--- a/package_manager/tests/src/Kernel/PathExcluder/SiteFilesExcluderTest.php
+++ b/package_manager/tests/src/Kernel/PathExcluder/SiteFilesExcluderTest.php
@@ -39,18 +39,18 @@ class SiteFilesExcluderTest extends PackageManagerKernelTestBase {
$stage->require(['ext-json:*']);
$stage_dir = $stage->getStageDirectory();
- $ignored = [
- "sites/example.com/files/ignore.txt",
- 'private/ignore.txt',
+ $excluded = [
+ "sites/example.com/files/exclude.txt",
+ 'private/exclude.txt',
];
- foreach ($ignored as $path) {
+ foreach ($excluded as $path) {
$this->assertFileExists("$active_dir/$path");
$this->assertFileDoesNotExist("$stage_dir/$path");
}
$stage->apply();
- // The ignored files should still be in the active directory.
- foreach ($ignored as $path) {
+ // The excluded files should still be in the active directory.
+ foreach ($excluded as $path) {
$this->assertFileExists("$active_dir/$path");
}
}
diff --git a/package_manager/tests/src/Kernel/PathExcluder/SqliteDatabaseExcluderTest.php b/package_manager/tests/src/Kernel/PathExcluder/SqliteDatabaseExcluderTest.php
index c4d291be61..7d75dbb659 100644
--- a/package_manager/tests/src/Kernel/PathExcluder/SqliteDatabaseExcluderTest.php
+++ b/package_manager/tests/src/Kernel/PathExcluder/SqliteDatabaseExcluderTest.php
@@ -6,7 +6,7 @@ namespace Drupal\Tests\package_manager\Kernel\PathExcluder;
use Drupal\Core\Database\Connection;
use Drupal\Core\DependencyInjection\ContainerBuilder;
-use Drupal\package_manager\Event\CollectIgnoredPathsEvent;
+use Drupal\package_manager\Event\CollectPathsToExcludeEvent;
use Drupal\package_manager\PathExcluder\SqliteDatabaseExcluder;
use Drupal\package_manager\PathLocator;
use Drupal\Tests\package_manager\Kernel\PackageManagerKernelTestBase;
@@ -67,19 +67,19 @@ class SqliteDatabaseExcluderTest extends PackageManagerKernelTestBase {
$stage->require(['ext-json:*']);
$stage_dir = $stage->getStageDirectory();
- $ignored = [
+ $excluded = [
"sites/example.com/db.sqlite",
"sites/example.com/db.sqlite-shm",
"sites/example.com/db.sqlite-wal",
];
- foreach ($ignored as $path) {
+ foreach ($excluded as $path) {
$this->assertFileExists("$active_dir/$path");
$this->assertFileDoesNotExist("$stage_dir/$path");
}
$stage->apply();
- // The ignored files should still be in the active directory.
- foreach ($ignored as $path) {
+ // The excluded files should still be in the active directory.
+ foreach ($excluded as $path) {
$this->assertFileExists("$active_dir/$path");
}
}
@@ -153,7 +153,7 @@ class SqliteDatabaseExcluderTest extends PackageManagerKernelTestBase {
'database' => $database_path,
]);
- $event = new CollectIgnoredPathsEvent($this->createStage());
+ $event = new CollectPathsToExcludeEvent($this->createStage());
// Invoke the event subscriber directly, so we can check that the database
// was correctly excluded.
$this->container->get(SqliteDatabaseExcluder::class)
diff --git a/package_manager/tests/src/Kernel/PathExcluder/TestSiteExcluderTest.php b/package_manager/tests/src/Kernel/PathExcluder/TestSiteExcluderTest.php
index 7f25d573f2..6b33623ffb 100644
--- a/package_manager/tests/src/Kernel/PathExcluder/TestSiteExcluderTest.php
+++ b/package_manager/tests/src/Kernel/PathExcluder/TestSiteExcluderTest.php
@@ -31,17 +31,17 @@ class TestSiteExcluderTest extends PackageManagerKernelTestBase {
$stage->require(['ext-json:*']);
$stage_dir = $stage->getStageDirectory();
- $ignored = [
+ $excluded = [
'sites/simpletest',
];
- foreach ($ignored as $path) {
+ foreach ($excluded as $path) {
$this->assertFileExists("$active_dir/$path");
$this->assertFileDoesNotExist("$stage_dir/$path");
}
$stage->apply();
- // The ignored files should still be in the active directory.
- foreach ($ignored as $path) {
+ // The excluded files should still be in the active directory.
+ foreach ($excluded as $path) {
$this->assertFileExists("$active_dir/$path");
}
}
diff --git a/package_manager/tests/src/Kernel/PathExcluder/UnknownPathExcluderTest.php b/package_manager/tests/src/Kernel/PathExcluder/UnknownPathExcluderTest.php
index d4bf8fb18d..4eea0a8540 100644
--- a/package_manager/tests/src/Kernel/PathExcluder/UnknownPathExcluderTest.php
+++ b/package_manager/tests/src/Kernel/PathExcluder/UnknownPathExcluderTest.php
@@ -172,7 +172,7 @@ class UnknownPathExcluderTest extends PackageManagerKernelTestBase {
}
$stage->apply();
- // The ignored files should still be in the active directory.
+ // The excluded files should still be in the active directory.
foreach ($unknown_files as $path) {
$this->assertFileExists("$active_dir/$path");
}
diff --git a/package_manager/tests/src/Kernel/PathExcluder/VendorHardeningExcluderTest.php b/package_manager/tests/src/Kernel/PathExcluder/VendorHardeningExcluderTest.php
index ce17e0dae8..97be633cd4 100644
--- a/package_manager/tests/src/Kernel/PathExcluder/VendorHardeningExcluderTest.php
+++ b/package_manager/tests/src/Kernel/PathExcluder/VendorHardeningExcluderTest.php
@@ -31,18 +31,18 @@ class VendorHardeningExcluderTest extends PackageManagerKernelTestBase {
$stage->require(['ext-json:*']);
$stage_dir = $stage->getStageDirectory();
- $ignored = [
+ $excluded = [
'vendor/.htaccess',
'vendor/web.config',
];
- foreach ($ignored as $path) {
+ foreach ($excluded as $path) {
$this->assertFileExists("$active_dir/$path");
$this->assertFileDoesNotExist("$stage_dir/$path");
}
$stage->apply();
- // The ignored files should still be in the active directory.
- foreach ($ignored as $path) {
+ // The excluded files should still be in the active directory.
+ foreach ($excluded as $path) {
$this->assertFileExists("$active_dir/$path");
}
}
diff --git a/package_manager/tests/src/Kernel/StageBaseTest.php b/package_manager/tests/src/Kernel/StageBaseTest.php
index df45c0ea68..67a80a5bef 100644
--- a/package_manager/tests/src/Kernel/StageBaseTest.php
+++ b/package_manager/tests/src/Kernel/StageBaseTest.php
@@ -8,7 +8,7 @@ use Drupal\Component\Datetime\Time;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Core\Extension\ModuleUninstallValidatorException;
use Drupal\Core\StringTranslation\TranslatableMarkup;
-use Drupal\package_manager\Event\CollectIgnoredPathsEvent;
+use Drupal\package_manager\Event\CollectPathsToExcludeEvent;
use Drupal\package_manager\Event\PostApplyEvent;
use Drupal\package_manager\Event\PreApplyEvent;
use Drupal\package_manager\Event\PreCreateEvent;
@@ -600,23 +600,23 @@ class StageBaseTest extends PackageManagerKernelTestBase {
}
/**
- * Tests that ignored paths are collected before create and apply.
+ * Tests that paths to exclude are collected before create and apply.
*/
- public function testCollectIgnoredPaths(): void {
- $this->addEventTestListener(function (CollectIgnoredPathsEvent $event): void {
- $event->add(['ignore/me']);
- }, CollectIgnoredPathsEvent::class);
+ public function testCollectPathsToExclude(): void {
+ $this->addEventTestListener(function (CollectPathsToExcludeEvent $event): void {
+ $event->add(['exclude/me']);
+ }, CollectPathsToExcludeEvent::class);
- // On pre-create and pre-apply, ensure that the ignored path is known to
+ // On pre-create and pre-apply, ensure that the excluded path is known to
// the event.
$asserted = FALSE;
- $assert_ignored = function (object $event) use (&$asserted): void {
- $this->assertContains('ignore/me', $event->getExcludedPaths());
+ $assert_excluded = function (object $event) use (&$asserted): void {
+ $this->assertContains('exclude/me', $event->getExcludedPaths());
// Use this to confirm that this listener was actually called.
$asserted = TRUE;
};
- $this->addEventTestListener($assert_ignored, PreCreateEvent::class);
- $this->addEventTestListener($assert_ignored);
+ $this->addEventTestListener($assert_excluded, PreCreateEvent::class);
+ $this->addEventTestListener($assert_excluded);
$stage = $this->createStage();
$stage->create();
@@ -628,9 +628,9 @@ class StageBaseTest extends PackageManagerKernelTestBase {
}
/**
- * Tests that if a stage fails to get ignored paths, throws a stage exception.
+ * Tests that if a stage fails to get paths to exclude, throws a stage exception.
*/
- public function testFailureCollectIgnoredPaths(): void {
+ public function testFailureCollectPathsToExclude(): void {
$project_root = $this->container->get(PathLocator::class)->getProjectRoot();
unlink($project_root . '/composer.json');
$this->expectException(StageException::class);
@@ -639,9 +639,9 @@ class StageBaseTest extends PackageManagerKernelTestBase {
}
/**
- * Tests that if apply fails to get ignored paths, throws a stage exception.
+ * Tests that if apply fails to get paths to exclude, throws a stage exception.
*/
- public function testFailureCollectIgnoredPathsOnApply(): void {
+ public function testFailureCollectPathsToExcludeOnApply(): void {
$stage = $this->createStage();
$stage->create();
$stage->require(['drupal/random']);
diff --git a/package_manager/tests/src/Kernel/StatusCheckTraitTest.php b/package_manager/tests/src/Kernel/StatusCheckTraitTest.php
index 8825f3b5c0..fb9ceaa5ab 100644
--- a/package_manager/tests/src/Kernel/StatusCheckTraitTest.php
+++ b/package_manager/tests/src/Kernel/StatusCheckTraitTest.php
@@ -4,7 +4,7 @@ declare(strict_types = 1);
namespace Drupal\Tests\package_manager\Kernel;
-use Drupal\package_manager\Event\CollectIgnoredPathsEvent;
+use Drupal\package_manager\Event\CollectPathsToExcludeEvent;
use Drupal\package_manager\Event\StatusCheckEvent;
use Drupal\package_manager\StatusCheckTrait;
use Drupal\package_manager\ValidationResult;
@@ -19,12 +19,12 @@ class StatusCheckTraitTest extends PackageManagerKernelTestBase {
use StatusCheckTrait;
/**
- * Tests that StatusCheckTrait will collect ignored paths.
+ * Tests that StatusCheckTrait will collect paths to exclude.
*/
- public function testIgnoredPathsCollected(): void {
- $this->addEventTestListener(function (CollectIgnoredPathsEvent $event): void {
+ public function testPathsToExcludeCollected(): void {
+ $this->addEventTestListener(function (CollectPathsToExcludeEvent $event): void {
$event->add(['/junk/drawer']);
- }, CollectIgnoredPathsEvent::class);
+ }, CollectPathsToExcludeEvent::class);
$status_check_called = FALSE;
$this->addEventTestListener(function (StatusCheckEvent $event) use (&$status_check_called): void {
@@ -38,13 +38,13 @@ class StatusCheckTraitTest extends PackageManagerKernelTestBase {
/**
* Tests that any error will be added to the status check event.
*/
- public function testNoErrorIfIgnoredPathsCannotBeCollected(): void {
+ public function testNoErrorIfPathsToExcludeCannotBeCollected(): void {
$this->addEventTestListener(function (): void {
throw new \Exception('Not a chance, friend.');
- }, CollectIgnoredPathsEvent::class);
+ }, CollectPathsToExcludeEvent::class);
$result = ValidationResult::createError(
[t('Not a chance, friend.')],
- t('Unable to collect the ignored paths.'),
+ t('Unable to collect the paths to exclude.'),
);
$this->assertStatusCheckResults([$result]);
}
diff --git a/package_manager/tests/src/Kernel/SymlinkValidatorTest.php b/package_manager/tests/src/Kernel/SymlinkValidatorTest.php
index 730ea66319..fa284bb462 100644
--- a/package_manager/tests/src/Kernel/SymlinkValidatorTest.php
+++ b/package_manager/tests/src/Kernel/SymlinkValidatorTest.php
@@ -198,14 +198,14 @@ class SymlinkValidatorTest extends PackageManagerKernelTestBase {
}
/**
- * Tests that unsupported links are ignored if they're beneath excluded paths.
+ * Tests that unsupported links are excluded if they're under excluded paths.
*
* @depends testAbsoluteSymlinks
*
* @covers \Drupal\package_manager\PathExcluder\GitExcluder
* @covers \Drupal\package_manager\PathExcluder\NodeModulesExcluder
*/
- public function testUnsupportedLinkBeneathExcludedPath(): void {
+ public function testUnsupportedLinkUnderExcludedPath(): void {
$project_root = $this->container->get(PathLocator::class)
->getProjectRoot();
diff --git a/package_manager/tests/src/Unit/StatusCheckEventTest.php b/package_manager/tests/src/Unit/StatusCheckEventTest.php
index 86ed38f0fa..fd5777f464 100644
--- a/package_manager/tests/src/Unit/StatusCheckEventTest.php
+++ b/package_manager/tests/src/Unit/StatusCheckEventTest.php
@@ -23,7 +23,7 @@ class StatusCheckEventTest extends UnitTestCase {
NULL
);
$this->expectException(\LogicException::class);
- $this->expectExceptionMessage('$ignored_paths should only be NULL if the error that caused the paths to not be collected was added to the status check event.');
+ $this->expectExceptionMessage('$paths_to_exclude should only be NULL if the error that caused the paths to not be collected was added to the status check event.');
$event->getExcludedPaths();
}
--
GitLab