Factor SiteAlias classes out into consolidation/site-alias project. (#…

…3588)

composer.json

@@ -31,6 +31,7 @@
     "consolidation/annotated-command": "^2.8.1",
     "consolidation/config": "^1.0.9",
     "consolidation/output-formatters": "^3.1.12",
+    "consolidation/site-alias": "^0.1",
     "consolidation/robo": "^1.1.5",
     "grasmash/yaml-expander": "^1.1.1",
     "league/container": "~2",

docs/dependency-injection.md

@@ -49,8 +49,8 @@ For example:
 namespace Drupal\my_module\Commands;
 
 use Drush\Commands\DrushCommands;
-use Drush\SiteAlias\SiteAliasManagerAwareInterface;
-use Drush\SiteAlias\SiteSliasManagerAwareTrait;
+use Consolidation\SiteAlias\SiteAliasManagerAwareInterface;
+use Consolidation\SiteAlias\SiteSliasManagerAwareTrait;
 
 class MyModuleiCommands extends DrushCommands implements SiteAliasManagerAwareInterface
 {

examples/Commands/SiteAliasAlterCommands.php

@@ -2,8 +2,8 @@
 namespace Drush\Commands;
 
 use Consolidation\AnnotatedCommand\AnnotationData;
-use Drush\SiteAlias\SiteAliasManagerAwareInterface;
-use Drush\SiteAlias\SiteAliasManagerAwareTrait;
+use Consolidation\SiteAlias\SiteAliasManagerAwareInterface;
+use Consolidation\SiteAlias\SiteAliasManagerAwareTrait;
 use Symfony\Component\Console\Input\InputInterface;
 
 /**

includes/command.inc

@@ -6,7 +6,7 @@ use Drush\Log\LogLevel;
 use Webmozart\PathUtil\Path;
 use Consolidation\AnnotatedCommand\AnnotationData;
 use Drush\Command\DrushInputAdapter;
-use Drush\SiteAlias\AliasRecord;
+use Consolidation\SiteAlias\AliasRecord;
 use Consolidation\AnnotatedCommand\CommandData;
 use Symfony\Component\Console\Output\ConsoleOutput;
 

includes/exec.inc

@@ -7,7 +7,7 @@
 
 use Drush\Drush;
 use Drush\Log\LogLevel;
-use \Drush\SiteAlias\AliasRecord;
+use \Consolidation\SiteAlias\AliasRecord;
 
 /**
  * @defgroup commandwrappers Functions to execute commands.

includes/sitealias.inc

@@ -12,7 +12,7 @@
 use Drush\Commands\core\StatusCommands;
 use Drush\Drush;
 use Drush\Log\LogLevel;
-use Drush\SiteAlias\AliasRecord;
+use Consolidation\SiteAlias\AliasRecord;
 use Webmozart\PathUtil\Path;
 
 /**

isolation/composer.json

@@ -10,6 +10,7 @@
     "ext-dom": "*",
     "psr/log": "~1.0",
     "consolidation/config": "^1.0.9",
+    "consolidation/site-alias": "dev-master",
     "symfony/var-dumper": "~2.7|^3|^4",
     "symfony/finder": "~2.7|^3",
     "webflo/drupal-finder": "^0",

isolation/tests/LegacyAliasConverterTest.php

@@ -2,6 +2,7 @@
 namespace Drush\SiteAlias;
 
 use PHPUnit\Framework\TestCase;
+use Consolidation\SiteAlias\SiteAliasFileDiscovery;
 
 class LegacyAliasConverterTest extends TestCase
 {

isolation/tests/SiteAliasFileDiscoveryTest.php

@@ -2,6 +2,7 @@
 namespace Drush\SiteAlias;
 
 use PHPUnit\Framework\TestCase;
+use Consolidation\SiteAlias\SiteAliasFileDiscovery;
 
 class SiteAliasFileDiscoveryTest extends TestCase
 {

isolation/tests/SiteAliasFileLoaderTest.php

@@ -3,6 +3,9 @@
 
 use PHPUnit\Framework\TestCase;
 
+use Consolidation\SiteAlias\Util\YamlDataFileLoader;
+use Consolidation\SiteAlias\AliasRecord;
+
 class SiteAliasFileLoaderTest extends TestCase
 {
     use \Drush\FixtureFactory;
@@ -11,16 +14,24 @@ class SiteAliasFileLoaderTest extends TestCase
     function setUp()
     {
         $this->sut = new SiteAliasFileLoader();
+
+        $ymlLoader = new YamlDataFileLoader();
+        $this->sut->addLoader('yml', $ymlLoader);
     }
 
     public function testLoadSingleAliasFile()
     {
-        $this->sut->addSearchLocation($this->fixturesDir() . '/sitealiases/single');
+        $siteAliasFixtures = $this->fixturesDir() . '/sitealiases/single';
+        $this->assertTrue(is_dir($siteAliasFixtures));
+        $this->assertTrue(is_file($siteAliasFixtures . '/simple.site.yml'));
+        $this->assertTrue(is_file($siteAliasFixtures . '/single.site.yml'));
+
+        $this->sut->addSearchLocation($siteAliasFixtures);
 
         // Look for a simple alias with no environments defined
         $name = new SiteAliasName('simple');
         $result = $this->callProtected('loadSingleAliasFile', [$name]);
-        $this->assertTrue($result instanceof AliasRecord);
+        $this->assertEquals(AliasRecord::class, get_class($result));
         $this->assertEquals('/path/to/simple', $result->get('root'));
 
         // Look for a single alias without an environment specified.

src/Application.php

@@ -5,7 +5,7 @@
 use Consolidation\AnnotatedCommand\CommandFileDiscovery;
 use Drush\Boot\BootstrapManager;
 use Drush\Runtime\TildeExpansionHook;
-use Drush\SiteAlias\SiteAliasManager;
+use Consolidation\SiteAlias\SiteAliasManager;
 use Drush\Log\LogLevel;
 use Drush\Command\RemoteCommandProxy;
 use Drush\Runtime\RedispatchHook;

src/Backend/BackendPathEvaluator.php

@@ -1,8 +1,8 @@
 <?php
 namespace Drush\Backend;
 
-use Drush\SiteAlias\AliasRecord;
-use Drush\SiteAlias\HostPath;
+use Consolidation\SiteAlias\AliasRecord;
+use Consolidation\SiteAlias\HostPath;
 
 class BackendPathEvaluator
 {

src/Boot/BaseBoot.php

@@ -141,7 +141,7 @@ protected function inflect($object)
         if ($object instanceof \Robo\Contract\VerbosityThresholdInterface) {
             $object->setOutputAdapter($container->get('outputAdapter'));
         }
-        if ($object instanceof \Drush\SiteAlias\SiteAliasManagerAwareInterface) {
+        if ($object instanceof \Consolidation\SiteAlias\SiteAliasManagerAwareInterface) {
             $object->setOutputAdapter($container->get('site.alias.manager'));
         }
     }

src/Commands/config/ConfigPullCommands.php

@@ -4,9 +4,9 @@
 use Consolidation\AnnotatedCommand\CommandData;
 use Drush\Commands\DrushCommands;
 use Drush\Drush;
-use Drush\SiteAlias\HostPath;
-use Drush\SiteAlias\SiteAliasManagerAwareInterface;
-use Drush\SiteAlias\SiteAliasManagerAwareTrait;
+use Consolidation\SiteAlias\HostPath;
+use Consolidation\SiteAlias\SiteAliasManagerAwareInterface;
+use Consolidation\SiteAlias\SiteAliasManagerAwareTrait;
 
 class ConfigPullCommands extends DrushCommands implements SiteAliasManagerAwareInterface
 {

src/Commands/core/BrowseCommands.php

@@ -5,8 +5,8 @@
 use Drush\Commands\DrushCommands;
 use Drush\Drush;
 use Drush\Exec\ExecTrait;
-use Drush\SiteAlias\SiteAliasManagerAwareInterface;
-use Drush\SiteAlias\SiteAliasManagerAwareTrait;
+use Consolidation\SiteAlias\SiteAliasManagerAwareInterface;
+use Consolidation\SiteAlias\SiteAliasManagerAwareTrait;
 
 class BrowseCommands extends DrushCommands implements SiteAliasManagerAwareInterface
 {

src/Commands/core/CoreCommands.php

@@ -5,8 +5,8 @@
 use Drush\Commands\DrushCommands;
 use Drush\Drush;
 use Consolidation\OutputFormatters\StructuredData\RowsOfFields;
-use Drush\SiteAlias\SiteAliasManagerAwareInterface;
-use Drush\SiteAlias\SiteAliasManagerAwareTrait;
+use Consolidation\SiteAlias\SiteAliasManagerAwareInterface;
+use Consolidation\SiteAlias\SiteAliasManagerAwareTrait;
 
 class CoreCommands extends DrushCommands implements SiteAliasManagerAwareInterface
 {

src/Commands/core/DrupalDirectoryCommands.php

@@ -5,9 +5,9 @@
 use Drush\Commands\DrushCommands;
 use Drush\Drush;
 use Consolidation\OutputFormatters\StructuredData\RowsOfFields;
-use Drush\SiteAlias\HostPath;
-use Drush\SiteAlias\SiteAliasManagerAwareInterface;
-use Drush\SiteAlias\SiteAliasManagerAwareTrait;
+use Consolidation\SiteAlias\HostPath;
+use Consolidation\SiteAlias\SiteAliasManagerAwareInterface;
+use Consolidation\SiteAlias\SiteAliasManagerAwareTrait;
 
 use Drush\Backend\BackendPathEvaluator;
 

src/Commands/core/EditCommands.php

@@ -3,8 +3,8 @@
 
 use Drush\Commands\DrushCommands;
 use Drush\Drush;
-use Drush\SiteAlias\SiteAliasManagerAwareInterface;
-use Drush\SiteAlias\SiteAliasManagerAwareTrait;
+use Consolidation\SiteAlias\SiteAliasManagerAwareInterface;
+use Consolidation\SiteAlias\SiteAliasManagerAwareTrait;
 
 class EditCommands extends DrushCommands implements SiteAliasManagerAwareInterface
 {

src/Commands/core/LoginCommands.php

@@ -5,8 +5,8 @@
 use Drush\Commands\DrushCommands;
 use Drush\Drush;
 use Drush\Exec\ExecTrait;
-use Drush\SiteAlias\SiteAliasManagerAwareInterface;
-use Drush\SiteAlias\SiteAliasManagerAwareTrait;
+use Consolidation\SiteAlias\SiteAliasManagerAwareInterface;
+use Consolidation\SiteAlias\SiteAliasManagerAwareTrait;
 
 class LoginCommands extends DrushCommands implements SiteAliasManagerAwareInterface
 {

src/Commands/core/RsyncCommands.php

@@ -5,9 +5,9 @@
 use Drush\Commands\DrushCommands;
 use Drush\Drush;
 use Drush\Exceptions\UserAbortException;
-use Drush\SiteAlias\HostPath;
-use Drush\SiteAlias\SiteAliasManagerAwareInterface;
-use Drush\SiteAlias\SiteAliasManagerAwareTrait;
+use Consolidation\SiteAlias\HostPath;
+use Consolidation\SiteAlias\SiteAliasManagerAwareInterface;
+use Consolidation\SiteAlias\SiteAliasManagerAwareTrait;
 use Drush\Backend\BackendPathEvaluator;
 use Drush\Config\ConfigLocator;
 use Symfony\Component\Console\Event\ConsoleCommandEvent;

src/Commands/core/SiteCommands.php

@@ -4,9 +4,9 @@
 use Drush\Commands\DrushCommands;
 use Drush\Drush;
 use Drush\SiteAlias\LegacyAliasConverter;
-use Drush\SiteAlias\SiteAliasFileDiscovery;
-use Drush\SiteAlias\SiteAliasManagerAwareInterface;
-use Drush\SiteAlias\SiteAliasManagerAwareTrait;
+use Consolidation\SiteAlias\SiteAliasFileDiscovery;
+use Consolidation\SiteAlias\SiteAliasManagerAwareInterface;
+use Consolidation\SiteAlias\SiteAliasManagerAwareTrait;
 use Consolidation\OutputFormatters\StructuredData\ListDataFromKeys;
 use Drush\Utils\StringUtils;
 use Symfony\Component\Console\Input\Input;

src/Commands/core/SiteInstallCommands.php

@@ -8,9 +8,9 @@
 use Drush\Exceptions\UserAbortException;
 use Drush\Log\LogLevel;
 use Drupal\Core\Config\FileStorage;
-use Drush\SiteAlias\SiteAliasManager;
-use Drush\SiteAlias\SiteAliasManagerAwareInterface;
-use Drush\SiteAlias\SiteAliasManagerAwareTrait;
+use Consolidation\SiteAlias\SiteAliasManager;
+use Consolidation\SiteAlias\SiteAliasManagerAwareInterface;
+use Consolidation\SiteAlias\SiteAliasManagerAwareTrait;
 use Drush\Sql\SqlBase;
 use Drush\Utils\StringUtils;
 use Webmozart\PathUtil\Path;

src/Commands/core/SshCommands.php

@@ -2,8 +2,8 @@
 namespace Drush\Commands\core;
 
 use Drush\Commands\DrushCommands;
-use Drush\SiteAlias\SiteAliasManagerAwareInterface;
-use Drush\SiteAlias\SiteAliasManagerAwareTrait;
+use Consolidation\SiteAlias\SiteAliasManagerAwareInterface;
+use Consolidation\SiteAlias\SiteAliasManagerAwareTrait;
 
 class SshCommands extends DrushCommands implements SiteAliasManagerAwareInterface
 {

src/Commands/core/StatusCommands.php

@@ -10,8 +10,8 @@
 use Drush\Commands\DrushCommands;
 use Drush\Drush;
 use Drush\Sql\SqlBase;
-use Drush\SiteAlias\SiteAliasManagerAwareInterface;
-use Drush\SiteAlias\SiteAliasManagerAwareTrait;
+use Consolidation\SiteAlias\SiteAliasManagerAwareInterface;
+use Consolidation\SiteAlias\SiteAliasManagerAwareTrait;
 use Consolidation\OutputFormatters\Options\FormatterOptions;
 use Consolidation\AnnotatedCommand\CommandData;
 

src/Commands/sql/SqlSyncCommands.php

@@ -5,9 +5,9 @@
 use Drush\Commands\DrushCommands;
 use Drush\Drush;
 use Drush\Exceptions\UserAbortException;
-use Drush\SiteAlias\AliasRecord;
-use Drush\SiteAlias\SiteAliasManagerAwareInterface;
-use Drush\SiteAlias\SiteAliasManagerAwareTrait;
+use Consolidation\SiteAlias\AliasRecord;
+use Consolidation\SiteAlias\SiteAliasManagerAwareInterface;
+use Consolidation\SiteAlias\SiteAliasManagerAwareTrait;
 use Symfony\Component\Config\Definition\Exception\Exception;
 use Webmozart\PathUtil\Path;
 

src/Drush.php

@@ -6,7 +6,7 @@
  */
 namespace Drush;
 
-use Drush\SiteAlias\SiteAliasManager;
+use Consolidation\SiteAlias\SiteAliasManager;
 use League\Container\ContainerInterface;
 use Psr\Log\LoggerInterface;
 use SebastianBergmann\Version;

src/Preflight/ArgsPreprocessor.php

@@ -1,8 +1,8 @@
 <?php
 namespace Drush\Preflight;
 
-use Drush\SiteAlias\SiteAliasName;
-use Drush\SiteAlias\SiteSpecParser;
+use Consolidation\SiteAlias\SiteAliasName;
+use Consolidation\SiteAlias\SiteSpecParser;
 
 /**
  * Preprocess commandline arguments.

src/Preflight/Preflight.php

@@ -4,7 +4,7 @@
 use Drush\Config\Environment;
 use Drush\Config\ConfigLocator;
 use Drush\Config\EnvironmentConfigLoader;
-use Drush\SiteAlias\SiteAliasManager;
+use Consolidation\SiteAlias\SiteAliasManager;
 use DrupalFinder\DrupalFinder;
 
 /**
@@ -255,7 +255,8 @@ public function preflight($argv)
         $paths = $this->configLocator->getSiteAliasPaths($this->preflightArgs->aliasPaths(), $this->environment);
 
         // Configure alias manager.
-        $this->aliasManager = (new SiteAliasManager())->addSearchLocations($paths);
+        $aliasFileLoader = new \Drush\SiteAlias\SiteAliasFileLoader();
+        $this->aliasManager = (new SiteAliasManager($aliasFileLoader))->addSearchLocations($paths);
         $this->aliasManager->setReferenceData($config->export());
         $siteLocator = new PreflightSiteLocator($this->aliasManager);
         $selfAliasRecord = $siteLocator->findSite($this->preflightArgs, $this->environment, $root);

src/Preflight/PreflightSiteLocator.php

@@ -4,10 +4,10 @@
 
 use Drush\Config\Environment;
 use Drush\Preflight\PreflightArgsInterface;
-use Drush\SiteAlias\AliasRecord;
-use Drush\SiteAlias\SiteAliasManager;
-use Drush\SiteAlias\SiteAliasName;
-use Drush\SiteAlias\SiteSpecParser;
+use Consolidation\SiteAlias\AliasRecord;
+use Consolidation\SiteAlias\SiteAliasManager;
+use Consolidation\SiteAlias\SiteAliasName;
+use Consolidation\SiteAlias\SiteSpecParser;
 
 class PreflightSiteLocator
 {
@@ -29,7 +29,7 @@ public function __construct(SiteAliasManager $siteAliasManager)
      * @param \Drush\Config\Environment $environment
      * @param string $root The default Drupal root (from site:set, --root or cwd)
      *
-     * @return \Drush\SiteAlias\AliasRecord
+     * @return \Consolidation\SiteAlias\AliasRecord
      * @throws \Exception
      */
     public function findSite(PreflightArgsInterface $preflightArgs, Environment $environment, $root)
@@ -51,7 +51,7 @@ public function findSite(PreflightArgsInterface $preflightArgs, Environment $env
      * @param \Drush\Config\Environment $environment
      * @param $root
      *
-     * @return \Drush\SiteAlias\AliasRecord
+     * @return \Consolidation\SiteAlias\AliasRecord
      */
     protected function determineSelf(PreflightArgsInterface $preflightArgs, Environment $environment, $root)
     {
@@ -92,7 +92,7 @@ protected function determineSelf(PreflightArgsInterface $preflightArgs, Environm
      * @param \Drush\Preflight\PreflightArgsInterface $preflightArgs
      * @param $root
      *
-     * @return \Drush\SiteAlias\AliasRecord
+     * @return \Consolidation\SiteAlias\AliasRecord
      */
     protected function buildSelf(PreflightArgsInterface $preflightArgs, $root)
     {

src/Runtime/DependencyInjection.php

@@ -11,7 +11,7 @@
 use Consolidation\Config\ConfigInterface;
 use Composer\Autoload\ClassLoader;
 use League\Container\ContainerInterface;
-use Drush\SiteAlias\SiteAliasManager;
+use Consolidation\SiteAlias\SiteAliasManager;
 
 /**
  * Prepare our Dependency Injection Container
@@ -104,7 +104,7 @@ protected static function addDrushServices(ContainerInterface $container, ClassL
         // Add inflectors. @see \Drush\Boot\BaseBoot::inflect
         $container->inflector(\Drush\Boot\AutoloaderAwareInterface::class)
             ->invokeMethod('setAutoloader', ['loader']);
-        $container->inflector(\Drush\SiteAlias\SiteAliasManagerAwareInterface::class)
+        $container->inflector(\Consolidation\SiteAlias\SiteAliasManagerAwareInterface::class)
             ->invokeMethod('setSiteAliasManager', ['site.alias.manager']);
     }