Added assertions for equal fixture directories and updated tests.

.github/workflows/test-php.yml

@@ -59,6 +59,7 @@ jobs:
         with:
           name: ${{github.job}}-code-coverage-report-${{ matrix.composer-channel }}-${{ matrix.php-versions }}
           path: ./.coverage-html
+          include-hidden-files: true
           if-no-files-found: error
 
       - name: Upload coverage report to Codecov

CustomizeCommand.php

@@ -38,7 +38,7 @@
  * Please keep this link in your project to help others find this tool.
  * Thank you!
  *
- * @see https://github.com/alexSkrypnyk/customizer
+ * @see https://github.com/AlexSkrypnyk/customizer
  *
  * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
  * @SuppressWarnings(PHPMD.TooManyPublicMethods)
@@ -71,7 +71,7 @@ class CustomizeCommand extends BaseCommand {
   public string $composerjson;
 
   /**
-   * Composer config data.
+   * Composer config data loaded before customization.
    *
    * @var array<string,mixed>
    */
@@ -113,6 +113,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
     if (empty($answers)) {
       $this->io->success($this->message('result_no_questions'));
 
+      $this->cleanupSelf();
+
       return 0;
     }
 
@@ -235,7 +237,7 @@ protected function cleanupSelf(): void {
       $should_proceed = $this->configClass::cleanup($this);
 
       if ($should_proceed === FALSE) {
-        $this->debug("Customizer's was cleanup skipped by the config class.");
+        $this->debug("Customizer's cleanup was skipped by the config class.");
 
         return;
       }
@@ -261,6 +263,13 @@ protected function cleanupSelf(): void {
     static::arrayUnsetDeep($json, ['autoload-dev', 'psr-4', 'AlexSkrypnyk\\Customizer\\Tests\\']);
     static::arrayUnsetDeep($json, ['config', 'allow-plugins', 'alexskrypnyk/customizer']);
 
+    // Remove the Customizer from the list of repositories if it was added as a
+    // local or overridden dependency.
+    // @todo Update to only remove if the package `url` path matches the current
+    // working directory.
+    static::arrayUnsetDeep($json, ['repositories']);
+    static::arrayUnsetDeep($json, ['minimum-stability']);
+
     // If the package data has changed, update the composer.json file.
     if (strcmp(serialize($this->composerjsonData), serialize($json)) !== 0) {
       $this->writeComposerJson($this->cwd . '/composer.json', $json);
@@ -309,10 +318,12 @@ protected function cleanupSelf(): void {
    *   Message.
    */
   protected function message(string $name, array $tokens = []): string {
+    // Default messages from this class.
     $messages = static::messages($this);
 
-    if (!empty($this->configClass)) {
-      if (method_exists($this->configClass, 'messages') && !is_callable([$this->configClass, 'messages'])) {
+    // Messages from the config class if 'messages' method exists.
+    if (!empty($this->configClass) && method_exists($this->configClass, 'messages')) {
+      if (!is_callable([$this->configClass, 'messages'])) {
         throw new \RuntimeException(sprintf('Optional method `messages()` exists in the config class %s but is not callable', $this->configClass));
       }
       $messages = array_replace_recursive($messages, $this->configClass::messages($this));
@@ -673,7 +684,7 @@ public static function arrayUnsetDeep(array &$array, array $path, ?string $value
    */
   public static function messages(CustomizeCommand $c): array {
     return [
-      'title' => 'Welcome to {{ package.name }} project customizer',
+      'title' => 'Welcome to the "{{ package.name }}" project customizer',
       'header' => [
         'Please answer the following questions to customize your project.',
         'You will be able to review your answers before proceeding.',

customize.php

@@ -59,8 +59,7 @@ public static function questions(CustomizeCommand $c): array {
         // The discover callback function is used to discover the value from the
         // environment. In this case, we use the current directory name
         // and the GITHUB_ORG environment variable to generate the package name.
-        // @phpstan-ignore-next-line
-        'discover' => static function (CustomizeCommand $c): ?string {
+        'discover' => static function (CustomizeCommand $c): string {
           $name = basename((string) getcwd());
           $org = getenv('GITHUB_ORG') ?: 'acme';
 

phpcs.xml

@@ -31,4 +31,9 @@
         <exclude-pattern>*.TestCase\.php</exclude-pattern>
         <exclude-pattern>*.test</exclude-pattern>
     </rule>
+
+    <!-- Allow missing class description names in test fixtures. -->
+    <rule ref="Drupal.Commenting.ClassComment.Short">
+        <exclude-pattern>tests/phpunit/Fixtures</exclude-pattern>
+    </rule>
 </ruleset>

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir1/.ignorecontent

@@ -0,0 +1,37 @@
+# Syntax of this file is similar to .gitignore with addition of content changes
+# ignoring using ^ prefix:
+# Comments start with #.
+# file - ignore file
+# dir/ - ignore directory and all subdirectories
+# dir/* - ignore all files in directory, but not subdirectories
+# ^file - ignore content changes in file, but not the file itself
+# ^dir/ - ignore content changes in all files and subdirectories, but check that the directory itself exists
+# ^dir/* - ignore content changes in all files, but not subdirectories and check that the directory itself exists
+# !file - do not ignore file
+# !dir/ - do not ignore directory, including all subdirectories
+# !dir/* - do not ignore all files in directory, but not subdirectories
+# !^file - do not ignore content changes in file
+# !^dir/ - do not ignore content changes in all files and subdirectories
+# !^dir/* - do not ignore content changes in all files, but not subdirectories
+
+# Ignore all files by extension.
+*.log
+
+# Ignore file in root and all directories.
+f3-new-file-ignore-everywhere.txt
+
+# Ignore dir with all files, but not subdirectories.
+dir2_flat/*
+
+# Ignore all files and subdirectories in the directory.
+dir3_subdirs/*
+# But include sub-sub-directory.
+!dir3_subdirs/dir32-unignored/
+
+# Ignore directory and all subdirectories.
+dir4_full_ignore/
+
+# Ignore content in the directory.
+^dir5_content_ignore/
+# But include this file content changes for comparison.
+!^dir5_content_ignore/d5f2-unignored-content.txt

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir1/dir1_flat/d1f1.txt

@@ -0,0 +1 @@
+d1f1l1

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir1/dir1_flat/d1f2.txt

@@ -0,0 +1 @@
+d1f2l1

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir1/dir3_subdirs/d3f1-ignored.txt

@@ -0,0 +1 @@
+d3f1l1

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir1/dir3_subdirs/d3f2-ignored.txt

@@ -0,0 +1,2 @@
+d3f2l1
+

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir1/dir3_subdirs/dir31/d31f1-ignored.txt

@@ -0,0 +1 @@
+d31f1l1

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir1/dir3_subdirs/dir31/d31f2-ignored.txt

@@ -0,0 +1 @@
+d31f2l1

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir1/dir3_subdirs/dir32-unignored/d32f1.txt

@@ -0,0 +1 @@
+d32f1l1

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir1/dir3_subdirs/dir32-unignored/d32f2-only-src.log

@@ -0,0 +1 @@
+d32f2l1.log only src

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir1/dir3_subdirs/dir32-unignored/d32f2.txt

@@ -0,0 +1 @@
+d32f2l1

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir1/dir5_content_ignore/d5f1-ignored-changed-content.txt

@@ -0,0 +1 @@
+d5f1l1

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir1/dir5_content_ignore/d5f2-unignored-content.txt

@@ -0,0 +1 @@
+d5f2l1

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir1/dir5_content_ignore/dir51/d51f1-changed-content.txt

@@ -0,0 +1 @@
+d5f1l1

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir1/f1.txt

@@ -0,0 +1 @@
+f1l1

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir1/f2.txt

@@ -0,0 +1 @@
+f2l1

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir1/f4-ignore-ext.log

@@ -0,0 +1 @@
+f4l1.log

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir2/dir1_flat/d1f1.txt

@@ -0,0 +1 @@
+d1f1l1

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir2/dir1_flat/d1f2.txt

@@ -0,0 +1 @@
+d1f2l1

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir2/dir2_flat/d2f1.txt

@@ -0,0 +1 @@
+d2f1l1

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir2/dir2_flat/d2f2.txt

@@ -0,0 +1 @@
+d2f2l1

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir2/dir3_subdirs/d3f1-ignored.txt

@@ -0,0 +1 @@
+d3f1l1

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir2/dir3_subdirs/d3f2-ignored.txt

@@ -0,0 +1 @@
+d3f2l1-changes

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir2/dir3_subdirs/dir31/d31f1-ignored.txt

@@ -0,0 +1 @@
+d31f1l1

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir2/dir3_subdirs/dir31/d31f2-ignored.txt

@@ -0,0 +1 @@
+d31f2l1

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir2/dir3_subdirs/dir31/f3-new-file-ignore-everywhere.txt

@@ -0,0 +1 @@
+f3l1 - full ignore

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir2/dir3_subdirs/dir32-unignored/d32f1.txt

@@ -0,0 +1 @@
+d32f1l1

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir2/dir3_subdirs/dir32-unignored/d32f2-ignore-ext-only-dst.log

@@ -0,0 +1 @@
+d32f2l1.log only dst

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir2/dir3_subdirs/dir32-unignored/d32f2.txt

@@ -0,0 +1 @@
+d32f2l1

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir2/dir3_subdirs/f3-new-file-ignore-everywhere.txt

@@ -0,0 +1 @@
+f3l1 - full ignore

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir2/dir4_full_ignore/d4f1.txt

@@ -0,0 +1 @@
+d4f1l1-fully ignored

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir2/dir5_content_ignore/d5f1-ignored-changed-content.txt

@@ -0,0 +1 @@
+d5f1l1-changed

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir2/dir5_content_ignore/d5f2-unignored-content.txt

@@ -0,0 +1 @@
+d5f2l1

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir2/dir5_content_ignore/dir51/d51f1-changed-content.txt

@@ -0,0 +1 @@
+d5f1l1-changed

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir2/f1.txt

@@ -0,0 +1 @@
+f1l1

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir2/f2.txt

@@ -0,0 +1 @@
+f2l1

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir2/f3-new-file-ignore-everywhere.txt

@@ -0,0 +1 @@
+f3l1 - full ignore

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir2/f4-ignore-ext.log

@@ -0,0 +1 @@
+f4l1.log

tests/phpunit/Fixtures/assert_fixture_files/files_equal/dir2/f5-new-file-ignore-ext.log

@@ -0,0 +1 @@
+f4l1.log

tests/phpunit/Fixtures/assert_fixture_files/files_not_equal/dir1/.ignorecontent

@@ -0,0 +1,37 @@
+# Syntax of this file is similar to .gitignore with addition of content changes
+# ignoring using ^ prefix:
+# Comments start with #.
+# file - ignore file
+# dir/ - ignore directory and all subdirectories
+# dir/* - ignore all files in directory, but not subdirectories
+# ^file - ignore content changes in file, but not the file itself
+# ^dir/ - ignore content changes in all files and subdirectories, but check that the directory itself exists
+# ^dir/* - ignore content changes in all files, but not subdirectories and check that the directory itself exists
+# !file - do not ignore file
+# !dir/ - do not ignore directory, including all subdirectories
+# !dir/* - do not ignore all files in directory, but not subdirectories
+# !^file - do not ignore content changes in file
+# !^dir/ - do not ignore content changes in all files and subdirectories
+# !^dir/* - do not ignore content changes in all files, but not subdirectories
+
+# Ignore all files by extension.
+*.log
+
+# Ignore file in root and all directories.
+f3-new-file-ignore-everywhere.txt
+
+# Ignore dir with all files, but not subdirectories.
+dir2_flat/*
+
+# Ignore all files and subdirectories in the directory.
+dir3_subdirs/*
+# But include sub-sub-directory.
+!dir3_subdirs/dir32-unignored/
+
+# Ignore directory and all subdirectories.
+dir4_full_ignore/
+
+# Ignore content in the directory.
+^dir5_content_ignore/
+# But include this file content changes for comparison.
+!^dir5_content_ignore/d5f2-unignored-content.txt

tests/phpunit/Fixtures/assert_fixture_files/files_not_equal/dir1/dir1_flat/d1f1.txt

@@ -0,0 +1 @@
+d1f1l1

tests/phpunit/Fixtures/assert_fixture_files/files_not_equal/dir1/dir1_flat/d1f2.txt

@@ -0,0 +1 @@
+d1f2l1

tests/phpunit/Fixtures/assert_fixture_files/files_not_equal/dir1/dir1_flat/d1f3-only-src.txt

@@ -0,0 +1 @@
+d1f3l1

tests/phpunit/Fixtures/assert_fixture_files/files_not_equal/dir1/dir3_subdirs/d3f1-ignored.txt

@@ -0,0 +1 @@
+d3f1l1

tests/phpunit/Fixtures/assert_fixture_files/files_not_equal/dir1/dir3_subdirs/d3f2-ignored.txt

@@ -0,0 +1,2 @@
+d3f2l1
+

tests/phpunit/Fixtures/assert_fixture_files/files_not_equal/dir1/dir3_subdirs/dir31/d31f1-ignored.txt

@@ -0,0 +1 @@
+d31f1l1

tests/phpunit/Fixtures/assert_fixture_files/files_not_equal/dir1/dir3_subdirs/dir31/d31f2-ignored.txt

@@ -0,0 +1 @@
+d31f2l1

tests/phpunit/Fixtures/assert_fixture_files/files_not_equal/dir1/dir3_subdirs/dir32-unignored/d32f1.txt

@@ -0,0 +1 @@
+d32f1l1

tests/phpunit/Fixtures/assert_fixture_files/files_not_equal/dir1/dir3_subdirs/dir32-unignored/d32f2-only-src.log

@@ -0,0 +1 @@
+d32f2l1.log only src

tests/phpunit/Fixtures/assert_fixture_files/files_not_equal/dir1/dir3_subdirs/dir32-unignored/d32f2.txt

@@ -0,0 +1 @@
+d32f2l1

tests/phpunit/Fixtures/assert_fixture_files/files_not_equal/dir1/dir5_content_ignore/d5f1-ignored-changed-content.txt

@@ -0,0 +1 @@
+d5f1l1

tests/phpunit/Fixtures/assert_fixture_files/files_not_equal/dir1/dir5_content_ignore/d5f2-unignored-content.txt

@@ -0,0 +1 @@
+d5f2l1

tests/phpunit/Fixtures/assert_fixture_files/files_not_equal/dir1/dir5_content_ignore/dir51/d51f1-changed-content.txt

@@ -0,0 +1 @@
+d5f1l1

tests/phpunit/Fixtures/assert_fixture_files/files_not_equal/dir1/f1.txt

@@ -0,0 +1 @@
+f1l1

tests/phpunit/Fixtures/assert_fixture_files/files_not_equal/dir1/f2.txt

@@ -0,0 +1 @@
+f2l1

tests/phpunit/Fixtures/assert_fixture_files/files_not_equal/dir1/f4-ignore-ext.log

@@ -0,0 +1 @@
+f4l1.log

tests/phpunit/Fixtures/assert_fixture_files/files_not_equal/dir2/dir1_flat/d1f1.txt

@@ -0,0 +1 @@
+d1f1l1

tests/phpunit/Fixtures/assert_fixture_files/files_not_equal/dir2/dir1_flat/d1f2.txt

@@ -0,0 +1 @@
+d1f2l1

tests/phpunit/Fixtures/assert_fixture_files/files_not_equal/dir2/dir2_flat-present-dst/d2f1.txt

@@ -0,0 +1 @@
+d2f1l1