Change import format version and add tests

doc/13-remote.md

@@ -13,15 +13,15 @@ To import functions from a GitHub repository, pass a path to the `import()`
 function, formatted like this:
 
 ```
-github://<user>/<repository>/<version>/<path of the php file to import>
+github://<user>/<repository>/<path of the php file to import>@<version>
 ```
 
 Here is an example:
 
 ```php
 use function Castor\import;
 
-import('github://pyrech/castor-setup-php/main/castor.php');
+import('github://pyrech/castor-setup-php/castor.php@main');
 
 #[AsTask()]
 function hello(): void

examples/import.php

@@ -6,7 +6,7 @@
 
 use function Castor\import;
 
-import('github://pyrech/castor-setup-php/main');
+import('github://pyrech/castor-setup-php/castor.php@main');
 
 #[AsTask(description: 'Use a function imported from a remote repository')]
 function hello(): void

src/Remote/Import.php

@@ -16,18 +16,19 @@
 /** @internal */
 class Import
 {
-    public static function importFunctions(string $scheme, string $url): string
+    public static function importFunctions(string $scheme, string $url, bool $dryRun = false): string
     {
         if ('github' === $scheme) {
-            if (!preg_match('#^github://(?<organization>[^/]+)/(?<repository>[^/]+)/(?<version>[^/]+)(?<function_path>.*)$#', $url, $matches)) {
-                throw new InvalidImportUrl('The import path from GitHub repository must be formatted like this: "github://<organization>/<repository>/<version>/<function_path>".');
+            if (!preg_match('#^(?<organization>[^/]+)/(?<repository>[^/]+)(?<function_path>[^@]*)@(?<version>.+)$#', $url, $matches)) {
+                throw new InvalidImportUrl('The import path from GitHub repository must be formatted like this: "github://<organization>/<repository>/<function_path>@<version>".');
             }
 
             $path = self::importFunctionsFromGitRepository(
                 'github.com',
                 sprintf('%s/%s', $matches['organization'], $matches['repository']),
                 $matches['version'],
                 $matches['function_path'] ?? '/castor.php',
+                $dryRun,
             );
 
             log('Using functions from remote resource.', 'info', [
@@ -37,16 +38,16 @@ public static function importFunctions(string $scheme, string $url): string
             return $path;
         }
 
-        throw new InvalidImportUrl(sprintf('The import path scheme "%s" is not supported.', $scheme));
+        throw new InvalidImportUrl(sprintf('The import scheme "%s" is not supported.', $scheme));
     }
 
-    private static function importFunctionsFromGitRepository(string $domain, string $repository, string $version, string $functionPath): string
+    private static function importFunctionsFromGitRepository(string $domain, string $repository, string $version, string $functionPath, bool $dryRun): string
     {
         self::ensureTrustedResource($domain . '/' . $repository);
 
         $dir = GlobalHelper::getHomeDirectory() . '/remote/' . $domain . '/' . $repository . '/' . $version;
 
-        if (!is_dir($dir)) {
+        if (!is_dir($dir) && !$dryRun) {
             log("Importing functions in path {$functionPath} from {$domain}/{$repository} (version {$version})");
 
             fs()->mkdir($dir);

src/functions.php

@@ -453,7 +453,7 @@ function import(string $path): void
 
     if ($scheme) {
         try {
-            $path = Import::importFunctions($scheme, $path);
+            $path = Import::importFunctions($scheme, mb_substr($path, mb_strlen($scheme) + 3));
         } catch (InvalidImportUrl $e) {
             throw fix_exception(new \InvalidArgumentException($e->getMessage(), 0, $e));
         } catch (NotTrusted $e) {

tests/Remote/ImportTest.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace Castor\Tests\Remote;
+
+use Castor\GlobalHelper;
+use Castor\Remote\Exception\InvalidImportUrl as InvalidImportUrlAlias;
+use Castor\Remote\Exception\NotTrusted;
+use Castor\Remote\Import;
+use Monolog\Logger;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Console\Input\ArgvInput;
+use Symfony\Component\Console\Output\NullOutput;
+
+class ImportTest extends TestCase
+{
+    public function testInvalidScheme(): void
+    {
+        $this->expectException(InvalidImportUrlAlias::class);
+        $this->expectExceptionMessage('The import scheme "foobar" is not supported.');
+
+        Import::importFunctions('foobar', 'test-url', dryRun: true);
+    }
+
+    public function testInvalidGithub(): void
+    {
+        $this->expectException(InvalidImportUrlAlias::class);
+        $this->expectExceptionMessage('The import path from GitHub repository must be formatted like this: "github://<organization>/<repository>/<function_path>@<version>".');
+
+        Import::importFunctions('github', 'test-url', dryRun: true);
+    }
+
+    public function testValidGithubNotTrusted(): void
+    {
+        $this->expectException(NotTrusted::class);
+        $this->expectExceptionMessage('The remote resource github.com/pyrech/castor-setup-php is not trusted.');
+
+        GlobalHelper::setInput(new ArgvInput(['castor', '--no-trust']));
+        GlobalHelper::setOutput(new NullOutput());
+        GlobalHelper::setupDefaultCache();
+
+        Import::importFunctions('github', 'pyrech/castor-setup-php/castor.php@main', dryRun: true);
+    }
+
+    public function testValidGithubTrusted(): void
+    {
+        GlobalHelper::setInput(new ArgvInput(['castor', '--trust']));
+        GlobalHelper::setOutput(new NullOutput());
+        GlobalHelper::setupDefaultCache();
+        GlobalHelper::setLogger(new Logger('test'));
+
+        $path = Import::importFunctions('github', 'pyrech/castor-setup-php/castor.php@main', dryRun: true);
+
+        $this->assertStringContainsString('.castor/remote/github.com/pyrech/castor-setup-php/main/castor.php', $path);
+    }
+}