Merge pull request #945 from hydephp/update-vendor-path-helper-to-specify-which-package-to-use

emmadesilva · web-flow · commit b84819c85f56 · 2023-02-09T13:25:32.000+01:00
Update Hyde::vendorPath() helper to allow a Hyde package to be specified
diff --git a/packages/framework/src/Foundation/Concerns/ForwardsFilesystem.php b/packages/framework/src/Foundation/Concerns/ForwardsFilesystem.php
@@ -23,9 +23,9 @@ public function path(string $path = ''): string
         return $this->filesystem->path($path);
     }
 
-    public function vendorPath(string $path = ''): string
+    public function vendorPath(string $path = '', string $package = 'framework'): string
     {
-        return $this->filesystem->vendorPath($path);
+        return $this->filesystem->vendorPath($path, $package);
     }
 
     public function copy(string $from, string $to): bool
diff --git a/packages/framework/src/Foundation/Filesystem.php b/packages/framework/src/Foundation/Filesystem.php
@@ -134,9 +134,9 @@ public function siteMediaPath(string $path = ''): string
     /**
      * Works similarly to the path() function, but returns a file in the Framework package.
      */
-    public function vendorPath(string $path = ''): string
+    public function vendorPath(string $path = '', string $package = 'framework'): string
     {
-        return $this->path('vendor/hyde/framework/'.unslash($path));
+        return $this->path("vendor/hyde/$package/".unslash($path));
     }
 
     /**
diff --git a/packages/framework/src/Hyde.php b/packages/framework/src/Hyde.php
@@ -25,7 +25,7 @@
  * @license MIT License
  *
  * @method static string path(string $path = '') $basePath
- * @method static string vendorPath(string $path = '')
+ * @method static string vendorPath(string $path = '', string $package = 'framework')
  * @method static string pathToAbsolute(string $path)
  * @method static string pathToRelative(string $path)
  * @method static string getModelSourcePath(string $model, string $path = '')
diff --git a/packages/framework/tests/Feature/Foundation/FilesystemTest.php b/packages/framework/tests/Feature/Foundation/FilesystemTest.php
@@ -111,6 +111,12 @@ public function test_vendor_path_method_returns_expected_value_regardless_of_tra
         $this->assertEquals('/foo/vendor/hyde/framework/file.php', $this->filesystem->vendorPath('\\//file.php/'));
     }
 
+    public function test_vendor_path_can_specify_which_hyde_package_to_use()
+    {
+        $this->assertDirectoryExists(Hyde::vendorPath(package: 'realtime-compiler'));
+        $this->assertFileExists(Hyde::vendorPath('composer.json', 'realtime-compiler'));
+    }
+
     public function test_copy_method()
     {
         touch(Hyde::path('foo'));
diff --git a/packages/framework/tests/Unit/HydeVendorPathHelperTest.php b/packages/framework/tests/Unit/HydeVendorPathHelperTest.php
@@ -31,4 +31,11 @@ public function test_method_returns_path_to_the_vendor_directory()
         $this->assertFileExists(Hyde::vendorPath().'/composer.json');
         $this->assertStringContainsString('"name": "hyde/framework",', file_get_contents(Hyde::vendorPath().'/composer.json'));
     }
+
+    public function test_can_specify_which_hyde_package_to_use()
+    {
+        $this->assertDirectoryExists(Hyde::vendorPath(package: 'realtime-compiler'));
+        $this->assertFileExists(Hyde::vendorPath('composer.json', 'realtime-compiler'));
+        $this->assertStringContainsString('"name": "hyde/realtime-compiler",', file_get_contents(Hyde::vendorPath('composer.json', 'realtime-compiler')));
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -23,9 +23,9 @@ public function path(string $path = ''): string`
`23`	`23`	`return $this->filesystem->path($path);`
`24`	`24`	`}`
`25`	`25`
`26`		`- public function vendorPath(string $path = ''): string`
	`26`	`+ public function vendorPath(string $path = '', string $package = 'framework'): string`
`27`	`27`	`{`
`28`		`- return $this->filesystem->vendorPath($path);`
	`28`	`+ return $this->filesystem->vendorPath($path, $package);`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`public function copy(string $from, string $to): bool`
Original file line number	Diff line number	Diff line change
`@@ -134,9 +134,9 @@ public function siteMediaPath(string $path = ''): string`
`134`	`134`	`/**`
`135`	`135`	`* Works similarly to the path() function, but returns a file in the Framework package.`
`136`	`136`	`*/`
`137`		`- public function vendorPath(string $path = ''): string`
	`137`	`+ public function vendorPath(string $path = '', string $package = 'framework'): string`
`138`	`138`	`{`
`139`		`- return $this->path('vendor/hyde/framework/'.unslash($path));`
	`139`	`+ return $this->path("vendor/hyde/$package/".unslash($path));`
`140`	`140`	`}`
`141`	`141`
`142`	`142`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@`
`25`	`25`	`* @license MIT License`
`26`	`26`	`*`
`27`	`27`	`* @method static string path(string $path = '') $basePath`
`28`		`- * @method static string vendorPath(string $path = '')`
	`28`	`+ * @method static string vendorPath(string $path = '', string $package = 'framework')`
`29`	`29`	`* @method static string pathToAbsolute(string $path)`
`30`	`30`	`* @method static string pathToRelative(string $path)`
`31`	`31`	`* @method static string getModelSourcePath(string $model, string $path = '')`
Original file line number	Diff line number	Diff line change
`@@ -111,6 +111,12 @@ public function test_vendor_path_method_returns_expected_value_regardless_of_tra`
`111`	`111`	`$this->assertEquals('/foo/vendor/hyde/framework/file.php', $this->filesystem->vendorPath('\\//file.php/'));`
`112`	`112`	`}`
`113`	`113`
	`114`	`+ public function test_vendor_path_can_specify_which_hyde_package_to_use()`
	`115`	`+ {`
	`116`	`+ $this->assertDirectoryExists(Hyde::vendorPath(package: 'realtime-compiler'));`
	`117`	`+ $this->assertFileExists(Hyde::vendorPath('composer.json', 'realtime-compiler'));`
	`118`	`+ }`
	`119`	`+`
`114`	`120`	`public function test_copy_method()`
`115`	`121`	`{`
`116`	`122`	`touch(Hyde::path('foo'));`
Original file line number	Diff line number	Diff line change
`@@ -31,4 +31,11 @@ public function test_method_returns_path_to_the_vendor_directory()`
`31`	`31`	`$this->assertFileExists(Hyde::vendorPath().'/composer.json');`
`32`	`32`	`$this->assertStringContainsString('"name": "hyde/framework",', file_get_contents(Hyde::vendorPath().'/composer.json'));`
`33`	`33`	`}`
	`34`	`+`
	`35`	`+ public function test_can_specify_which_hyde_package_to_use()`
	`36`	`+ {`
	`37`	`+ $this->assertDirectoryExists(Hyde::vendorPath(package: 'realtime-compiler'));`
	`38`	`+ $this->assertFileExists(Hyde::vendorPath('composer.json', 'realtime-compiler'));`
	`39`	`+ $this->assertStringContainsString('"name": "hyde/realtime-compiler",', file_get_contents(Hyde::vendorPath('composer.json', 'realtime-compiler')));`
	`40`	`+ }`
`34`	`41`	`}`