Add support for .valetrc (#1347)

* Add .valetrc support

* Apply fixes from StyleCI

* wip

Co-authored-by: StyleCI Bot <[email protected]>

Author: mattstauffer

cli/Valet/Drivers/Specific/Magento2ValetDriver.php

@@ -13,7 +13,7 @@ class Magento2ValetDriver extends ValetDriver
      *
      * @param string|null
      */
-    /*?string*/ private $mageMode = null;
+    private $mageMode = null;
 
     /**
      * Determine if the driver serves the request.

cli/Valet/Site.php

@@ -1021,16 +1021,42 @@ public function replaceSockFile(string $siteConf, string $phpVersion): string
     }
 
     /**
-     * Get PHP version from .valetphprc for a site.
+     * Get configuration items defined in .valetrc for a site.
      */
-    public function phpRcVersion(string $site): ?string
+    public function valetRc(string $siteName): array
     {
-        if ($site = $this->parked()->merge($this->links())->where('site', $site)->first()) {
-            $path = data_get($site, 'path').'/.valetphprc';
+        if ($site = $this->parked()->merge($this->links())->where('site', $siteName)->first()) {
+            $path = data_get($site, 'path').'/.valetrc';
 
             if ($this->files->exists($path)) {
-                return PhpFpm::normalizePhpVersion(trim($this->files->get($path)));
+                return collect(explode(PHP_EOL, trim($this->files->get($path))))->filter(function ($line) {
+                    return str_contains($line, '=');
+                })->mapWithKeys(function ($item, $index) {
+                    [$key, $value] = explode('=', $item);
+
+                    return [strtolower($key) => $value];
+                })->all();
+            }
+        }
+
+        return [];
+    }
+
+    /**
+     * Get PHP version from .valetrc or .valetphprc for a site.
+     */
+    public function phpRcVersion(string $siteName): ?string
+    {
+        if ($site = $this->parked()->merge($this->links())->where('site', $siteName)->first()) {
+            $oldPath = data_get($site, 'path').'/.valetphprc';
+
+            if ($this->files->exists($oldPath)) {
+                return PhpFpm::normalizePhpVersion(trim($this->files->get($oldPath)));
             }
+
+            $valetRc = $this->valetRc($siteName);
+
+            return PhpFpm::normalizePhpVersion(data_get($valetRc, 'php'));
         }
 
         return null;

cli/app.php

@@ -572,7 +572,7 @@ function (ConsoleCommandEvent $event) {
             $linkedVersion = Brew::linkedPhp();
 
             if ($phpVersion = Site::phpRcVersion($site)) {
-                info("Found '{$site}/.valetphprc' specifying version: {$phpVersion}");
+                info("Found '{$site}/.valetrc' or '{$site}/.valetphprc' specifying version: {$phpVersion}");
             } else {
                 $domain = $site.'.'.data_get(Configuration::read(), 'tld');
                 if ($phpVersion = PhpFpm::normalizePhpVersion(Site::customPhpVersion($domain))) {
@@ -604,7 +604,7 @@ function (ConsoleCommandEvent $event) {
 
         if (is_null($phpVersion)) {
             if ($phpVersion = Site::phpRcVersion($site)) {
-                info("Found '{$site}/.valetphprc' specifying version: {$phpVersion}");
+                info("Found '{$site}/.valetrc' or '{$site}/.valetphprc' specifying version: {$phpVersion}");
             } else {
                 info(PHP_EOL.'Please provide a version number. E.g.:');
                 info('valet isolate [email protected]');

composer.json

@@ -35,7 +35,7 @@
         ]
     },
     "require": {
-        "php": "^8.0",
+        "php": "^7.1|^8.0",
         "illuminate/collections": "^8.0|^9.0|^10.0",
         "illuminate/container": "~5.1|^6.0|^7.0|^8.0|^9.0|^10.0",
         "mnapoli/silly": "^1.0",

tests/SiteTest.php

@@ -900,54 +900,39 @@ public function test_it_returns_secured_sites()
         $this->assertSame(['helloworld.tld'], $sites);
     }
 
-    public function test_it_can_read_php_rc_version()
+    public function test_it_can_read_valet_rc_files()
     {
-        $config = Mockery::mock(Configuration::class);
-        $files = Mockery::mock(Filesystem::class);
-
-        swap(Configuration::class, $config);
-        swap(Filesystem::class, $files);
-
-        $siteMock = Mockery::mock(Site::class, [
-            resolve(Brew::class),
-            resolve(Configuration::class),
-            resolve(CommandLine::class),
-            resolve(Filesystem::class),
-        ])->makePartial();
-
-        swap(Site::class, $siteMock);
-
-        $config->shouldReceive('read')
-            ->andReturn(['tld' => 'test', 'loopback' => VALET_LOOPBACK, 'paths' => []]);
+        resolve(Configuration::class)->addPath(__DIR__.'/fixtures/Parked/Sites');
+        $site = resolve(Site::class);
 
-        $siteMock->shouldReceive('parked')
-            ->andReturn(collect([
-                'site1' => [
-                    'site' => 'site1',
-                    'secured' => '',
-                    'url' => 'http://site1.test',
-                    'path' => '/Users/name/code/site1',
-                ],
-            ]));
+        $this->assertEquals([
+            'item' => 'value',
+            'php' => '[email protected]',
+            'other_item' => 'othervalue',
+        ], $site->valetRc('site-w-valetrc-1'));
 
-        $siteMock->shouldReceive('links')->andReturn(collect([
-            'site2' => [
-                'site' => 'site2',
-                'secured' => 'X',
-                'url' => 'http://site2.test',
-                'path' => '/Users/name/some-other-directory/site2',
-            ],
-        ]));
+        $this->assertEquals([
+            'php' => '[email protected]',
+        ], $site->valetRc('site-w-valetrc-2'));
 
-        $files->shouldReceive('exists')->with('/Users/name/code/site1/.valetphprc')->andReturn(true);
-        $files->shouldReceive('get')->with('/Users/name/code/site1/.valetphprc')->andReturn('[email protected]');
+        $this->assertEquals([
+            'item' => 'value',
+            'php' => '[email protected]',
+        ], $site->valetRc('site-w-valetrc-3'));
+    }
 
-        $files->shouldReceive('exists')->with('/Users/name/some-other-directory/site2/.valetphprc')->andReturn(true);
-        $files->shouldReceive('get')->with('/Users/name/some-other-directory/site2/.valetphprc')->andReturn('[email protected]');
+    public function test_it_can_read_php_rc_version()
+    {
+        resolve(Configuration::class)->addPath(__DIR__.'/fixtures/Parked/Sites');
+        $site = resolve(Site::class);
 
-        $this->assertEquals('[email protected]', $siteMock->phpRcVersion('site1'));
-        $this->assertEquals('[email protected]', $siteMock->phpRcVersion('site2'));
-        $this->assertEquals(null, $siteMock->phpRcVersion('site3')); // Site doesn't exists
+        $this->assertEquals('[email protected]', $site->phpRcVersion('site-w-valetphprc-1'));
+        $this->assertEquals('[email protected]', $site->phpRcVersion('site-w-valetphprc-2'));
+        $this->assertEquals(null, $site->phpRcVersion('my-best-site'));
+        $this->assertEquals(null, $site->phpRcVersion('non-existent-site'));
+        $this->assertEquals('[email protected]', $site->phpRcVersion('site-w-valetrc-1'));
+        $this->assertEquals('[email protected]', $site->phpRcVersion('site-w-valetrc-2'));
+        $this->assertEquals('[email protected]', $site->phpRcVersion('site-w-valetrc-3'));
     }
 }
 

tests/fixtures/Parked/Sites/site-w-valetphprc-1/.valetphprc

@@ -0,0 +1 @@
+[email protected]

tests/fixtures/Parked/Sites/site-w-valetphprc-2/.valetphprc

@@ -0,0 +1 @@
+[email protected]

tests/fixtures/Parked/Sites/site-w-valetrc-1/.valetrc

@@ -0,0 +1,4 @@
+ITEM=value
+[email protected]
+# comment line
+OTHER_ITEM=othervalue

tests/fixtures/Parked/Sites/site-w-valetrc-2/.valetrc

@@ -0,0 +1 @@
+[email protected]

tests/fixtures/Parked/Sites/site-w-valetrc-3/.valetrc

@@ -0,0 +1,2 @@
+ITEM=value
+[email protected]