Upgrade codebase

Author: SerafimArts

composer.json

@@ -4,15 +4,13 @@
     "description": "Design by Contract framework for PHP",
     "license": "MIT",
     "require": {
-        "php": ">=7.1.3",
-        "symfony/polyfill-php80": "^1.20",
-        "nikic/php-parser": "^4.10"
+        "php": "^8.1",
+        "nikic/php-parser": "^4.13"
     },
     "require-dev": {
-        "vimeo/psalm": "^4.1",
+        "vimeo/psalm": "^4.22",
         "beberlei/assert": "^3.3",
-        "symfony/var-dumper": "^5.1",
-        "doctrine/annotations": "^1.11",
+        "symfony/var-dumper": "^5.4|^6.0",
         "roave/security-advisories": "dev-master@dev"
     },
     "autoload": {
@@ -37,12 +35,11 @@
         ]
     },
     "suggest": {
-        "doctrine/annotations": "^1.10 PHP 7.4 annotations support",
         "beberlei/assert": "^3.0 Thin assertion library for input validation in business models"
     },
     "config": {
         "sort-packages": true
     },
     "minimum-stability": "dev",
     "prefer-stable": true
-}
+}

demo/Account.php

@@ -19,9 +19,9 @@
 class Account
 {
     /**
-     * @var int
+     * @var positive-int|0
      */
-    protected $balance = 0;
+    protected int $balance = 0;
 
     /**
      * Deposits fixed amount of money to the account.
@@ -38,11 +38,10 @@ public function deposit(int $amount): void
     /**
      * Withdraw amount of money from account.
      *
-     * @param int $amount
+     * @param positive-int $amount
      */
     #[Verify('$amount <= $this->balance')]
     #[Verify('$amount > 0')]
-    #[Verify('$amount <= 50')]
     #[Ensure('$this->balance === $old->balance - $amount')]
     public function withdraw(int $amount): void
     {
@@ -52,11 +51,11 @@ public function withdraw(int $amount): void
     /**
      * Returns current balance.
      *
-     * @return positive-int
+     * @return positive-int|0
      */
     #[Ensure('$result === $this->balance')]
     public function getBalance(): int
     {
         return $this->balance;
     }
-}
+}

demo/demo.php

@@ -18,4 +18,4 @@
 Runtime::listen('Serafim\Contracts\Demo');
 
 $account = new Account();
-$account->deposit(-42);
+$account->withdraw(42);

psalm.xml

@@ -1,17 +1,10 @@
 <?xml version="1.0"?>
 <psalm
+    errorLevel="1"
+    resolveFromConfigFile="true"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
-
-    errorLevel="8"
-    hoistConstants="true"
-    resolveFromConfigFile="true"
-    allowPhpStormGenerics="true"
-    findUnusedPsalmSuppress="true"
-    findUnusedVariablesAndParams="true"
-    ensureArrayStringOffsetsExist="true"
-    addParamDefaultToDocblockType="true"
 >
     <projectFiles>
         <directory name="src" />

src/Attribute/Ensure.php

@@ -23,12 +23,9 @@
  * exit, when the method exits normally, of the and throw a
  * {@see PostconditionException} when they are violated. Postconditions are not
  * checked when the method exits by throwing an exception.
- *
- * @Annotation
- * @Target({ "METHOD" })
  */
 #[\Attribute(\Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
-class Ensure extends Contract
+final class Ensure extends Contract
 {
     /**
      * The postcondition that must be met by the annotated method. The
@@ -37,28 +34,23 @@ class Ensure extends Contract
      * may need to refer to the old value of an expression and the value
      * returned by the annotated method, the following extensions are allowed:
      *
-     * The keyword "$result" refers to the value returned from the method, if
-     * any. It is an error to have a method parameter named "$result".
+     * The keyword {@see $result} refers to the value returned from the method,
+     * if any. It is an error to have a method parameter named {@see $result}.
      *
-     * @var string
-     */
-    public $value;
-
-    /**
-     * @param string $value
+     * @psalm-taint-sink eval $expr
+     * @param non-empty-string $expr
      */
     public function __construct(
         #[Language('PHP')]
-        string $value
+        public readonly string $expr
     ) {
-        $this->value = $value;
     }
 
     /**
      * {@inheritDoc}
      */
     public function __toString(): string
     {
-        return $this->value;
+        return $this->expr;
     }
-}
+}

src/Attribute/Invariant.php

@@ -21,9 +21,6 @@
  * When checking of contracts is enabled, class invariant are checked on entry
  * and exit of methods, and throw a {@see InvariantException} when they are
  * violated.
- *
- * @Annotation
- * @Target({ "CLASS" })
  */
 #[\Attribute(\Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
 final class Invariant extends Contract
@@ -33,25 +30,20 @@ final class Invariant extends Contract
      * expression must be valid PHP code and can reference all things visible
      * to the class, including private members.
      *
-     * @var string
-     */
-    public $value;
-
-    /**
-     * @param string $value
+     * @psalm-taint-sink eval $expr
+     * @param non-empty-string $expr
      */
     public function __construct(
         #[Language('PHP')]
-        string $value
+        public readonly string $expr
     ) {
-        $this->value = $value;
     }
 
     /**
      * {@inheritDoc}
      */
     public function __toString(): string
     {
-        return $this->value;
+        return $this->expr;
     }
-}
+}

src/Attribute/Verify.php

@@ -20,12 +20,9 @@
  *
  * When checking of contracts is enabled, precondition are checked at method
  * entry and throw a {@see PreconditionException} when it is violated.
- *
- * @Annotation
- * @Target({ "METHOD" })
  */
 #[\Attribute(\Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
-class Verify extends Contract
+final class Verify extends Contract
 {
     /**
      * The precondition expression that must be met by the annotated method.
@@ -36,25 +33,20 @@ class Verify extends Contract
      * such as private fields when the method is public, but this is considered
      * bad style.
      *
-     * @var string
-     */
-    public $value;
-
-    /**
-     * @param string $value
+     * @psalm-taint-sink eval $expr
+     * @param non-empty-string $expr
      */
     public function __construct(
         #[Language('PHP')]
-        string $value
+        public readonly string $expr
     ) {
-        $this->value = $value;
     }
 
     /**
      * {@inheritDoc}
      */
     public function __toString(): string
     {
-        return $this->value;
+        return $this->expr;
     }
-}
+}

src/Internal/Interceptor.php src/Boot/Interceptor.phpsrc/Internal/Interceptor.php renamed to src/Boot/Interceptor.php

@@ -9,50 +9,54 @@
 
 declare(strict_types=1);
 
-namespace Serafim\Contracts\Internal;
+namespace Serafim\Contracts\Boot;
 
-use Composer\Autoload\ClassLoader;
-use function Composer\Autoload\includeFile;
+use Serafim\Contracts\Boot\Loader\ComposerLoader;
+use Serafim\Contracts\Boot\Loader\LoaderInterface;
+use Serafim\Contracts\Compiler\Compiler;
+use Serafim\Contracts\Runtime\Exception;
 
-/**
- * @internal Interceptor is an internal library class, please do not use it in your code.
- * @psalm-internal Serafim\Contracts
- */
 final class Interceptor
 {
     /**
-     * @var array<string|class-string>
-     */
-    private $namespaces = [];
-
-    /**
-     * @var ClassLoader
+     * @var list<non-empty-string|class-string>
      */
-    private $loader;
+    private array $namespaces = [];
 
     /**
      * @var Storage
      */
-    private $storage;
+    private Storage $storage;
 
     /**
      * @var Compiler
      */
-    private $compiler;
+    private readonly Compiler $compiler;
 
     /**
-     * @param ClassLoader $loader
-     * @param string|null $storage
+     * @psalm-taint-sink file $storage
+     * @param LoaderInterface $loader
+     * @param non-empty-string|null $storage
      */
-    public function __construct(ClassLoader $loader, string $storage = null)
+    public function __construct(private readonly LoaderInterface $loader, string $storage = null)
     {
-        $this->loader = $loader;
-        $this->storage = new Storage($storage ?? \sys_get_temp_dir());
         $this->compiler = new Compiler();
+        $this->storage = new Storage($storage ?? \sys_get_temp_dir());
+    }
+
+    /**
+     * @psalm-taint-sink file $storage
+     * @param non-empty-string|null $storage
+     * @return static
+     */
+    public static function fromComposer(string $storage = null): self
+    {
+        return new self(ComposerLoader::create(), $storage);
     }
 
     /**
-     * @param string $directory
+     * @psalm-taint-sink file $directory
+     * @param non-empty-string $directory
      * @return $this
      */
     public function cache(string $directory): self
@@ -63,9 +67,10 @@ public function cache(string $directory): self
     }
 
     /**
-     * @param array<string|class-string> $namespaces
+     * @param non-empty-string|class-string ...$namespaces
+     * @return void
      */
-    public function allow(array $namespaces): void
+    public function allow(string ...$namespaces): void
     {
         foreach ($namespaces as $namespace) {
             $this->namespaces[] = \trim($namespace, '\\');
@@ -74,24 +79,22 @@ public function allow(array $namespaces): void
 
     /**
      * @return void
-     * @psalm-suppress ArgumentTypeCoercion
      */
     public function enable(): void
     {
-        \spl_autoload_register([$this, 'loadClass'], true, true);
+        \spl_autoload_register($this->loadClass(...), true, true);
     }
 
     /**
      * @return void
-     * @psalm-suppress UnusedFunctionCall
      */
     public function disable(): void
     {
-        \spl_autoload_unregister([$this, 'loadClass']);
+        \spl_autoload_unregister($this->loadClass(...));
     }
 
     /**
-     * @param string $class
+     * @param class-string $class
      * @return bool
      */
     public function isAllowed(string $class): bool
@@ -119,32 +122,26 @@ public function loadClass(string $class): bool
         try {
             return $this->findAndInclude($class);
         } catch (\Throwable $e) {
-            $class = \get_class($e);
-
-            $instance = new $class($e->getMessage(), $e->getCode(), $e->getPrevious());
-
-            throw Exception::withLocation($instance, $e->getFile(), $e->getLine());
+            throw Exception::decorate($e);
         }
     }
 
     /**
-     * @param string $class
+     * @param class-string $class
      * @return bool
      */
     private function findAndInclude(string $class): bool
     {
-        $file = $this->loader->findFile($class);
+        $file = $this->loader->getPathname($class);
 
         if ($file === false) {
             return false;
         }
 
-        $compiled = $this->storage->cached($class, $file, function () use ($file) {
+        require $this->storage->cached($class, $file, function () use ($file) {
             return $this->compiler->compile($file);
         });
 
-        includeFile($compiled);
-
         return true;
     }
-}
+}