Look for composer.json in parent of registered module directory for sample data suggestions

This allows modules to follow the pds/skeleton standard and have their source code in a 'src' subdirectory of the repository

Author: schmengler

app/code/Magento/SampleData/Model/Dependency.php

@@ -48,13 +48,15 @@ class Dependency
      * @param Filesystem $filesystem
      * @param PackageFactory $packageFactory
      * @param ComponentRegistrarInterface $componentRegistrar
+     * @param Filesystem\Directory\ReadInterfaceFactory $directoryReadFactory
+     * @throws \RuntimeException
      */
     public function __construct(
         ComposerInformation $composerInformation,
         Filesystem $filesystem,
         PackageFactory $packageFactory,
         ComponentRegistrarInterface $componentRegistrar,
-        \Magento\Framework\Filesystem\Directory\ReadInterfaceFactory $directoryReadFactory = null
+        Filesystem\Directory\ReadInterfaceFactory $directoryReadFactory = null
     ) {
         $this->composerInformation = $composerInformation;
         $this->packageFactory = $packageFactory;
@@ -69,6 +71,7 @@ public function __construct(
      * Retrieve list of sample data packages from suggests
      *
      * @return array
+     * @throws \Magento\Framework\Exception\FileSystemException
      */
     public function getSampleDataPackages()
     {
@@ -87,20 +90,13 @@ public function getSampleDataPackages()
      * Retrieve suggested sample data packages from modules composer.json
      *
      * @return array
+     * @throws \Magento\Framework\Exception\FileSystemException
      */
     protected function getSuggestsFromModules()
     {
         $suggests = [];
         foreach ($this->componentRegistrar->getPaths(ComponentRegistrar::MODULE) as $moduleDir) {
-            /** @var Filesystem\Directory\ReadInterface $directory */
-            $directory = $this->directoryReadFactory->create(['path' => $moduleDir]);
-            echo "path=$moduleDir\n";
-            if (!$directory->isExist('composer.json') || !$directory->isReadable('composer.json')) {
-                continue;
-            }
-
-            /** @var Package $package */
-            $package = $this->getModuleComposerPackage($directory);
+            $package = $this->getModuleComposerPackage($moduleDir);
             $suggest = json_decode(json_encode($package->get('suggest')), true);
             if (!empty($suggest)) {
                 $suggests += $suggest;
@@ -112,12 +108,26 @@ protected function getSuggestsFromModules()
     /**
      * Load package
      *
-     * @param Filesystem\Directory\ReadInterface $directory
+     * @param string $moduleDir
      * @return Package
      * @throws \Magento\Framework\Exception\FileSystemException
      */
-    protected function getModuleComposerPackage(Filesystem\Directory\ReadInterface $directory)
+    private function getModuleComposerPackage($moduleDir): Package
     {
-        return $this->packageFactory->create(['json' => json_decode($directory->readFile('composer.json'))]);
+        /*
+         * Also look in parent directory of registered module directory to allow modules to follow the pds/skeleton
+         * standard and have their source code in a "src" subdirectory of the repository
+         *
+         * see: https://github.com/php-pds/skeleton
+         */
+        foreach ([$moduleDir, $moduleDir . DIRECTORY_SEPARATOR . '..'] as $dir) {
+            /** @var Filesystem\Directory\ReadInterface $directory */
+            $directory = $this->directoryReadFactory->create(['path' => $dir]);
+            if ($directory->isExist('composer.json') && $directory->isReadable('composer.json')) {
+                /** @var Package $package */
+                return $this->packageFactory->create(['json' => json_decode($directory->readFile('composer.json'))]);
+            }
+        }
+        return $this->packageFactory->create(['json' => new \stdClass]);
     }
 }

app/code/Magento/SampleData/Test/Unit/Model/DependencyTest.php

@@ -79,6 +79,7 @@ public static function dataPackagesFromComposerSuggest()
                     'app/code/LocalModule',
                     'app/code/LocalModuleWithoutComposerJson',
                     'vendor/company/module',
+                    'vendor/company2/module/src'
                 ],
                 'composerJsonGenerator' => function(DependencyTest $test) {
                     return [
@@ -98,6 +99,28 @@ public static function dataPackagesFromComposerSuggest()
                                 ['name' => 'company/module', 'suggest' => ['company/module-sample-data' => Dependency::SAMPLE_DATA_SUGGEST . '1.0.0-beta']]
                             )
                         ],
+                        [
+                            ['path' => 'vendor/company2/module/src/..'],
+                            $test->stubComposerJsonReader(
+                                ['name' => 'company2/module', 'suggest' => ['company2/module-sample-data' => Dependency::SAMPLE_DATA_SUGGEST . '1.10']]
+                            )
+                        ],
+                        [
+                            ['path' => 'vendor/company2/module/src'],
+                            $test->stubFileNotFoundReader()
+                        ],
+                        [
+                            ['path' => 'vendor/company/module/..'],
+                            $test->stubFileNotFoundReader()
+                        ],
+                        [
+                            ['path' => 'app/code/LocalModuleWithoutComposerJson/..'],
+                            $test->stubFileNotFoundReader()
+                        ],
+                        [
+                            ['path' => 'app/code/LocalModule/..'],
+                            $test->stubFileNotFoundReader()
+                        ],
                     ];
                 },
                 'suggestions' => [
@@ -110,6 +133,7 @@ public static function dataPackagesFromComposerSuggest()
                     'thirdparty/bar-sample-data' => '1.2.3',
                     'local/module-sample-data' => '0.1.0',
                     'company/module-sample-data' => '1.0.0-beta',
+                    'company2/module-sample-data' => '1.10',
                 ]
             ]
         ];