Merge branch 'develop'

Baptouuuu · Baptouuuu · commit 48f21c65c15e · 2025-07-30T16:56:27.000+02:00
* develop:
  specify next release
  fix readme
  update dependencies
  add workflow to create releases
  reuse CI workflow
  use innmind/static-analysis
  drop php 8.1 support
  replace phpunit by blackbox
  remove unused dependency
  use date range for the license copyright
  fix php 8.4 deprecations
  CS
diff --git a/.gitattributes b/.gitattributes
@@ -1,5 +1,4 @@
 /.gitattributes export-ignore
 /.gitignore export-ignore
-/phpunit.xml.dist export-ignore
 /fixtures export-ignore
 /tests export-ignore
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -3,62 +3,14 @@ name: CI
 on: [push, pull_request]
 
 jobs:
-  phpunit:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest, macOS-latest]
-        php-version: ['8.1', '8.2', '8.3']
-    name: 'PHPUnit'
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-      - name: Setup PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-version }}
-          extensions: mbstring, intl
-          coverage: xdebug
-      - name: Composer
-        uses: "ramsey/composer-install@v2"
-      - name: PHPUnit
-        run: vendor/bin/phpunit --coverage-clover=coverage.clover
-      - uses: codecov/codecov-action@v1
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
+  blackbox:
+    uses: innmind/github-workflows/.github/workflows/black-box-matrix.yml@main
+  coverage:
+    uses: innmind/github-workflows/.github/workflows/coverage-matrix.yml@main
+    secrets: inherit
   psalm:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        php-version: ['8.1', '8.2', '8.3']
-    name: 'Psalm'
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-      - name: Setup PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-version }}
-          extensions: mbstring, intl
-      - name: Composer
-        uses: "ramsey/composer-install@v2"
-      - name: Psalm
-        run: vendor/bin/psalm --shepherd
+    uses: innmind/github-workflows/.github/workflows/psalm-matrix.yml@main
   cs:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        php-version: ['8.1']
-    name: 'CS'
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-      - name: Setup PHP
-        uses: shivammathur/setup-php@v2
-        with:
-          php-version: ${{ matrix.php-version }}
-          extensions: mbstring, intl
-      - name: Composer
-        uses: "ramsey/composer-install@v2"
-      - name: CS
-        run: vendor/bin/php-cs-fixer fix --diff --dry-run
+    uses: innmind/github-workflows/.github/workflows/cs.yml@main
+    with:
+      php-version: '8.2'
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,11 @@
+name: Create release
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  release:
+    uses: innmind/github-workflows/.github/workflows/release.yml@main
+    secrets: inherit
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,2 @@
 /composer.lock
 /vendor
-/.phpunit.result.cache
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,17 @@
 # Changelog
 
+## 3.3.0 - 2025-07-30
+
+### Changed
+
+- Requires PHP `~8.2`
+- Requires `innmind/foundation:~1.3`
+- Requires `innmind/graphviz:~4.0`
+
+### Fixed
+
+- PHP `8.4` deprecations
+
 ## 3.2.0 - 2023-09-17
 
 ### Added
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 
+Copyright (c) 2018-present
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
@@ -41,11 +41,14 @@ Factory::build()
             ->withShortOption('o', 'graph.svg')
             ->withInput($render($objectGraph)),
     )
+    ->unwrap()
     ->wait();
 ```
 
 This will generate a `graph.svg` file representing the object graph of your application.
 
-> **Note** This example uses `innmind/operating-system` to generate the svg file but the package is not a direct dependency, you can use the content returned by `$render()` however you wish.
+> [!NOTE]
+> This example uses `innmind/operating-system` to generate the svg file but the package is not a direct dependency, you can use the content returned by `$render()` however you wish.
 
-> **Note**: You can pass an implementation of [`RewriteLocation`](src/RewriteLocation.php) as the first argument of `Render` so you can rewrite the url to the class file that will be used in the generated graph (useful if you want to generate urls to [open the files directly in your IDE](https://github.com/sanduhrs/phpstorm-url-handler#usage)).
+> [!NOTE]
+> You can pass an implementation of [`RewriteLocation`](src/RewriteLocation.php) as the first argument of `Render` so you can rewrite the url to the class file that will be used in the generated graph (useful if you want to generate urls to [open the files directly in your IDE](https://github.com/sanduhrs/phpstorm-url-handler#usage)).
diff --git a/blackbox.php b/blackbox.php
@@ -0,0 +1,28 @@
+<?php
+declare(strict_types = 1);
+
+require 'vendor/autoload.php';
+
+use Innmind\BlackBox\{
+    Application,
+    PHPUnit\Load,
+    Runner\CodeCoverage,
+};
+
+Application::new($argv)
+    ->disableMemoryLimit()
+    ->when(
+        \getenv('ENABLE_COVERAGE') !== false,
+        static fn(Application $app) => $app
+            ->codeCoverage(
+                CodeCoverage::of(
+                    __DIR__.'/src/',
+                    __DIR__.'/tests/',
+                )
+                    ->dumpTo('coverage.clover')
+                    ->enableWhen(true),
+            )
+            ->scenariiPerProof(1),
+    )
+    ->tryToProve(Load::directory(__DIR__.'/tests/'))
+    ->exit();
diff --git a/composer.json b/composer.json
@@ -16,10 +16,8 @@
     },
     "require": {
         "php": "~8.1",
-        "innmind/immutable": "~4.13|~5.0",
-        "innmind/reflection": "~5.0",
-        "innmind/graphviz": "~3.2",
-        "innmind/url": "~4.1"
+        "innmind/foundation": "~1.3",
+        "innmind/graphviz": "~4.0"
     },
     "autoload": {
         "psr-4": {
@@ -33,9 +31,8 @@
         }
     },
     "require-dev": {
-        "phpunit/phpunit": "~9.0",
-        "vimeo/psalm": "~5.6",
-        "innmind/coding-standard": "~2.0",
-        "symfony/var-dumper": "^6.2"
+        "innmind/black-box": "^6.4.1",
+        "innmind/static-analysis": "^1.2.1",
+        "innmind/coding-standard": "~2.0"
     }
 }
diff --git a/fixtures/Foo.php b/fixtures/Foo.php
@@ -8,7 +8,7 @@ final class Foo
     private $a;
     private $b;
 
-    public function __construct(self $a = null, self $b = null)
+    public function __construct(?self $a = null, ?self $b = null)
     {
         $this->a = $a;
         $this->b = $b;
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
diff --git a/psalm.xml b/psalm.xml
@@ -1,9 +1,9 @@
 <?xml version="1.0"?>
 <psalm
     errorLevel="1"
-    findUnusedBaselineEntry="true"
-    findUnusedCode="false"
     resolveFromConfigFile="true"
+    findUnusedCode="false"
+    findUnusedBaselineEntry="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"
diff --git a/src/Lookup.php b/src/Lookup.php
@@ -13,7 +13,6 @@
 };
 use Innmind\Immutable\{
     Map,
-    Set,
     Sequence,
 };
 
diff --git a/src/Node.php b/src/Node.php
@@ -49,7 +49,7 @@ private function __construct(
      *
      * @param Set<Relation>|null $relations
      */
-    public static function of(object $object, Set $relations = null): self
+    public static function of(object $object, ?Set $relations = null): self
     {
         /** @var Maybe<Url> */
         $location = Maybe::nothing();
diff --git a/src/Render.php b/src/Render.php
@@ -6,10 +6,7 @@
 use Innmind\Filesystem\File\Content;
 use Innmind\Graphviz;
 use Innmind\Colour\RGBA;
-use Innmind\Immutable\{
-    Set,
-    Str,
-};
+use Innmind\Immutable\Str;
 
 /**
  * @psalm-immutable
@@ -51,7 +48,7 @@ public function __invoke(Graph $graph): Content
     /**
      * @psalm-pure
      */
-    public static function of(RewriteLocation $rewriteLocation = null): self
+    public static function of(?RewriteLocation $rewriteLocation = null): self
     {
         return new self(
             $rewriteLocation ?? new RewriteLocation\NoOp,
@@ -66,6 +63,7 @@ public function fromTopToBottom(): self
 
     private function render(Node $node): Graphviz\Node
     {
+        /** @psalm-suppress ArgumentTypeCoercion As a class name can't be empty */
         $render = Graphviz\Node::of(self::name($node->reference()))
             ->displayAs(
                 Str::of($node->class()->toString())
diff --git a/src/RewriteLocation/NoOp.php b/src/RewriteLocation/NoOp.php
@@ -11,6 +11,7 @@
  */
 final class NoOp implements RewriteLocation
 {
+    #[\Override]
     public function __invoke(Url $location): Url
     {
         return $location;
diff --git a/src/RewriteLocation/SublimeHandler.php b/src/RewriteLocation/SublimeHandler.php
@@ -19,6 +19,7 @@
  */
 final class SublimeHandler implements RewriteLocation
 {
+    #[\Override]
     public function __invoke(Url $location): Url
     {
         return $location->withScheme(Scheme::of('sublime'));
diff --git a/tests/GraphTest.php b/tests/GraphTest.php
@@ -11,7 +11,7 @@
     Relation\Property,
 };
 use Innmind\Immutable\Set;
-use PHPUnit\Framework\TestCase;
+use Innmind\BlackBox\PHPUnit\Framework\TestCase;
 
 class GraphTest extends TestCase
 {
diff --git a/tests/LookupTest.php b/tests/LookupTest.php
@@ -5,7 +5,7 @@
 
 use Innmind\ObjectGraph\Lookup;
 use Fixtures\Innmind\ObjectGraph\Foo;
-use PHPUnit\Framework\TestCase;
+use Innmind\BlackBox\PHPUnit\Framework\TestCase;
 
 class LookupTest extends TestCase
 {
diff --git a/tests/Node/ClassNameTest.php b/tests/Node/ClassNameTest.php
@@ -4,7 +4,7 @@
 namespace Tests\Innmind\ObjectGraph\Node;
 
 use Innmind\ObjectGraph\Node\ClassName;
-use PHPUnit\Framework\TestCase;
+use Innmind\BlackBox\PHPUnit\Framework\TestCase;
 
 class ClassNameTest extends TestCase
 {
diff --git a/tests/Node/ReferenceTest.php b/tests/Node/ReferenceTest.php
@@ -4,7 +4,7 @@
 namespace Tests\Innmind\ObjectGraph\Node;
 
 use Innmind\ObjectGraph\Node\Reference;
-use PHPUnit\Framework\TestCase;
+use Innmind\BlackBox\PHPUnit\Framework\TestCase;
 
 class ReferenceTest extends TestCase
 {
diff --git a/tests/NodeTest.php b/tests/NodeTest.php
@@ -10,7 +10,7 @@
     Relation\Property,
 };
 use Innmind\Immutable\Set;
-use PHPUnit\Framework\TestCase;
+use Innmind\BlackBox\PHPUnit\Framework\TestCase;
 
 class NodeTest extends TestCase
 {
diff --git a/tests/Relation/PropertyTest.php b/tests/Relation/PropertyTest.php
@@ -4,7 +4,7 @@
 namespace Tests\Innmind\ObjectGraph\Relation;
 
 use Innmind\ObjectGraph\Relation\Property;
-use PHPUnit\Framework\TestCase;
+use Innmind\BlackBox\PHPUnit\Framework\TestCase;
 
 class PropertyTest extends TestCase
 {
diff --git a/tests/RenderTest.php b/tests/RenderTest.php
@@ -10,7 +10,7 @@
 };
 use Innmind\Filesystem\File\Content;
 use Fixtures\Innmind\ObjectGraph\Foo;
-use PHPUnit\Framework\TestCase;
+use Innmind\BlackBox\PHPUnit\Framework\TestCase;
 
 class RenderTest extends TestCase
 {
@@ -34,7 +34,7 @@ public function testInvokation()
         $dot = Render::of()($graph);
 
         $this->assertInstanceOf(Content::class, $dot);
-        $this->assertNotEmpty($dot->toString());
+        $this->assertNotSame('', $dot->toString());
         $lines = $dot
             ->lines()
             ->map(static fn($line) => $line->str()->trim()->toString())
@@ -81,7 +81,7 @@ public function testRenderRecursiveGraph()
         $dot = Render::of()(Lookup::of()($a));
 
         $this->assertInstanceOf(Content::class, $dot);
-        $this->assertNotEmpty($dot->toString());
+        $this->assertNotSame('', $dot->toString());
         $lines = $dot
             ->lines()
             ->map(static fn($line) => $line->str()->trim()->toString())
@@ -109,7 +109,7 @@ public function testRenderFromTopToBottom()
         $dot = Render::of()->fromTopToBottom()($graph);
 
         $this->assertInstanceOf(Content::class, $dot);
-        $this->assertNotEmpty($dot->toString());
+        $this->assertNotSame('', $dot->toString());
         $lines = $dot
             ->lines()
             ->map(static fn($line) => $line->str()->trim()->toString())
diff --git a/tests/RewriteLocation/SublimeHandlerTest.php b/tests/RewriteLocation/SublimeHandlerTest.php
@@ -8,7 +8,7 @@
     RewriteLocation,
 };
 use Innmind\Url\Url;
-use PHPUnit\Framework\TestCase;
+use Innmind\BlackBox\PHPUnit\Framework\TestCase;
 
 class SublimeHandlerTest extends TestCase
 {

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,2 @@`
`1`	`1`	`/composer.lock`
`2`	`2`	`/vendor`
`3`		`-/.phpunit.result.cache`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ final class Foo`
`8`	`8`	`private $a;`
`9`	`9`	`private $b;`
`10`	`10`
`11`		`- public function __construct(self $a = null, self $b = null)`
	`11`	`+ public function __construct(?self $a = null, ?self $b = null)`
`12`	`12`	`{`
`13`	`13`	`$this->a = $a;`
`14`	`14`	`$this->b = $b;`