Merge pull request #514 from jolicode/fix-fingerprint

Fix BC layer for `fingerprint()` function

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Not released yet
 
+## 0.18.1 (2024-09-03)
+
+* Fix BC layer for `fingerprint()` function
+
 ## 0.18.0 (2024-08-27)
 
 ### Features
@@ -18,7 +22,7 @@
 
 ### Fixes
 
-* Add an id parameter to fingerprint to avoid bad cache hit
+* Add an id parameter to `fingerprint()` to avoid bad cache hit
 * Fix completion when update is available
 * Fix repack when there is composer dependencies to castor
 * Fix wait_for_docker_container example to avoid checking previous docker logs

examples/args.php

@@ -30,7 +30,7 @@ function args(
 #[AsTask(description: 'Dumps all arguments and options, without configuration')]
 function another_args(
     string $required,
-    int $test2 = 1
+    int $test2 = 1,
 ): void {
     io()->writeln($required . ' ' . $test2);
 }

examples/fingerprint.php

@@ -23,7 +23,7 @@ function task_with_a_fingerprint(): void
             io()->writeln('Cool, no fingerprint! Executing...');
         },
         id: 'my_fingerprint_check',
-        fingerprint: my_fingerprint_check()
+        fingerprint: my_fingerprint_check(),
     );
 
     io()->writeln('Cool! I finished!');
@@ -44,7 +44,7 @@ function task_with_complete_fingerprint_check(): void
 
 #[AsTask(description: 'Check if the fingerprint has changed before executing a callback (with force option)')]
 function task_with_a_fingerprint_and_force(
-    #[AsOption(description: 'Force the callback to run even if the fingerprint has not changed')] bool $force = false
+    #[AsOption(description: 'Force the callback to run even if the fingerprint has not changed')] bool $force = false,
 ): void {
     io()->writeln('Hello Task with Fingerprint!');
 

src/Attribute/AsContext.php

@@ -7,7 +7,7 @@ class AsContext
 {
     public function __construct(
         public string $name = '',
-        public bool $default = false
+        public bool $default = false,
     ) {
     }
 }

src/Console/Application.php

@@ -18,7 +18,7 @@
 class Application extends SymfonyApplication
 {
     public const NAME = 'castor';
-    public const VERSION = 'v0.18.0';
+    public const VERSION = 'v0.18.1';
 
     private Command $command;
 

src/Helper/Notifier.php

@@ -15,7 +15,7 @@ class Notifier
     public function __construct(
         private DefaultNotifier $notifier,
         private LoggerInterface $logger,
-        private ContextRegistry $contextRegistry
+        private ContextRegistry $contextRegistry,
     ) {
     }
 

src/Kernel.php

@@ -80,7 +80,7 @@ private function load(
         array $currentFunctions,
         array $currentClasses,
         InputInterface $input,
-        OutputInterface $output
+        OutputInterface $output,
     ): void {
         if ($mount->allowRemotePackage) {
             $this->composer->install($mount->path);

src/functions.php

@@ -613,13 +613,34 @@ function fingerprint_save(string $id, ?string $fingerprint = null): void
     Container::get()->fingerprintHelper->postProcessFingerprintForHash($id, $fingerprint);
 }
 
-function fingerprint(callable $callback, string $id, ?string $fingerprint = null, bool $force = false): bool
+// function fingerprint(callable $callback, string $fingerprint, bool $force = false): bool
+/**
+ * @param string $id
+ * @param string $fingerprint
+ */
+function fingerprint(callable $callback, /* string */ $id = null, /* string */ $fingerprint = null, bool $force = false): bool
 {
+    // Could only occur due du BC layer
+    if (null === $fingerprint && null === $id) {
+        throw new \LogicException('You must provide "id" and "fingerprint" argument.');
+    }
+    // @phpstan-ignore function.impossibleType
+    if (\is_bool($fingerprint)) {
+        trigger_deprecation('castor/castor', '0.18.0', 'since 0.18 fingerprint functions require an "id" and "fingerprint" argument.');
+
+        $force = $fingerprint;
+        $fingerprint = $id;
+    }
     if (null === $fingerprint) {
-        trigger_deprecation('castor/castor', '0.18.0', 'since 0.18 fingerprint functions require an id argument.');
+        trigger_deprecation('castor/castor', '0.18.0', 'since 0.18 fingerprint functions require an "fingerprint" argument.');
 
         $fingerprint = $id;
     }
+    if (null === $id) {
+        trigger_deprecation('castor/castor', '0.18.0', 'since 0.18 fingerprint functions require a "id" argument.');
+
+        $id = $fingerprint;
+    }
 
     if ($force || !fingerprint_exists($id, $fingerprint)) {
         $callback();

tools/php-cs-fixer/composer.json

@@ -4,7 +4,7 @@
     "type": "project",
     "license": "MIT",
     "require": {
-        "friendsofphp/php-cs-fixer": "^3.62.0"
+        "friendsofphp/php-cs-fixer": "^3.64.0"
     },
     "config": {
         "platform": {