Merge pull request #110 from ircmaxell/type_cleanups

Clean up types to support 8.1 more natively

Author: ircmaxell

.gitignore

@@ -4,3 +4,4 @@ vendor/
 .idea/
 .phpunit.result.cache
 .php-cs-fixer.cache
+coverage

.php-cs-fixer.php

@@ -11,6 +11,7 @@
     ->name('.php_cs')
     ->exclude('vendor')
     ->exclude('.git')
+    ->exclude('coverage')
     ->in(__DIR__);
 
 return (new PhpCsFixer\Config())
@@ -23,5 +24,11 @@
             'comment_type' => 'PHPDoc',
             'header' => $header,
         ],
+        'fully_qualified_strict_types' => true,
+        'global_namespace_import' => true,
+        'no_unused_imports' => true,
+        'ordered_imports' => true,
+        'single_line_after_imports' => true,
+        'single_import_per_statement' => true,
     ])
     ->setFinder($finder);

Makefile

@@ -1,3 +1,8 @@
+SHELL := /bin/bash
+
+targets=$(shell for file in `find . -name '*Test.php' -type f -printf "%P\n"`; do echo "$$file "; done;)
+
+
 .PHONY: build
 build: cs-fix test
 
@@ -7,6 +12,12 @@ cs-fix:
 
 .PHONY: test
 test:
-	XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-text
+	XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-html ./coverage --display-deprecations
+
+.PHONY: t
+t:
 
+all: $(targets)
 
+%Test.php: t
+	XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-text --display-deprecations $@

README.md

@@ -37,3 +37,11 @@ To dump the graph, simply use the built-in dumper:
 $dumper = new PHPCfg\Printer\Text();
 echo $dumper->printScript($script);
 ```
+
+## CLI
+
+You can leverage the CLI binary to generate debug traces of the CFG for any file, or for printing GraphViz visualizations.
+
+```shell
+bin/php-cfg dot -o output.dot path/to/file.php
+```

bin/php-cfg

@@ -0,0 +1,13 @@
+#!/usr/bin/env php
+<?php
+require_once(__DIR__ . '/../vendor/autoload.php');
+
+// Init App with name and version
+$app = new Ahc\Cli\Application('PHP-CFG', 'v0.0.1');
+
+$app->add(new PHPCfg\Cli\PrintCommand, 'p');
+$app->add(new PHPCfg\Cli\DotCommand, 'd');
+
+$app->add(new PHPCfg\Cli\RunTestCommand);
+
+$app->handle($_SERVER['argv']); // if argv[1] is `i` or `init` it executes InitCommand

composer.json

@@ -11,15 +11,20 @@
     "require": {
         "php": ">=8.1",
         "nikic/php-parser": "^5.0",
-        "phpdocumentor/graphviz": "^1.0.4"
+        "phpdocumentor/graphviz": "^1.0.4",
+        "adhocore/cli": "^v1.0.0"
     },
     "require-dev": {
         "phpunit/phpunit": ">=10.0",
         "friendsofphp/php-cs-fixer": ">=3.86"
     },
     "autoload": {
         "psr-4": {
-            "PHPCfg\\": "lib/PHPCfg/"
+            "PHPCfg\\": "lib/PHPCfg/",
+            "PHPCfg\\Cli\\": "src/Cli"
         }
-    }
+    },
+    "bin": [
+        "bin/php-cfg"
+    ]
 }

demo.php

@@ -18,21 +18,27 @@
  */
 abstract class AbstractVisitor implements Visitor
 {
-    public function enterScript(Script $script) {}
+    public function enterScript(Script $script): void {}
 
-    public function leaveScript(Script $script) {}
+    public function leaveScript(Script $script): void {}
 
-    public function enterFunc(Func $func) {}
+    public function enterFunc(Func $func): void {}
 
-    public function leaveFunc(Func $func) {}
+    public function leaveFunc(Func $func): void {}
 
-    public function enterBlock(Block $block, ?Block $prior = null) {}
+    public function enterBlock(Block $block, ?Block $prior = null): void {}
 
-    public function leaveBlock(Block $block, ?Block $prior = null) {}
+    public function leaveBlock(Block $block, ?Block $prior = null): Block|int|null
+    {
+        return null;
+    }
 
-    public function skipBlock(Block $block, ?Block $prior = null) {}
+    public function skipBlock(Block $block, ?Block $prior = null): void {}
 
-    public function enterOp(Op $op, Block $block) {}
+    public function enterOp(Op $op, Block $block): void {}
 
-    public function leaveOp(Op $op, Block $block) {}
+    public function leaveOp(Op $op, Block $block): Op|int|null
+    {
+        return null;
+    }
 }

lib/PHPCfg/AbstractVisitor.php

@@ -11,6 +11,8 @@
 
 namespace PHPCfg;
 
+use RuntimeException;
+
 class Assertion
 {
     public const MODE_NONE = 0;
@@ -19,41 +21,49 @@ class Assertion
 
     public const MODE_INTERSECTION = 2;
 
-    public $mode = self::MODE_NONE;
+    public readonly int $mode;
 
     /**
      * @var Assertion[]|Operand
      */
-    public $value;
+    public readonly array|Operand $value;
 
-    /**
-     * @param Assertion[]|Operand $value
-     */
-    public function __construct($value, $mode = self::MODE_NONE)
+    public function __construct(array|Operand $value, $mode = self::MODE_NONE)
     {
         if (empty($value)) {
-            throw new \RuntimeException('Empty value supplied for Assertion');
+            throw new RuntimeException('Empty value supplied for Assertion');
         }
         if (is_array($value)) {
             foreach ($value as $v) {
                 if (! $v instanceof self) {
-                    throw new \RuntimeException('Invalid array key supplied for Assertion');
+                    throw new RuntimeException('Invalid array key supplied for Assertion');
                 }
             }
             if ($mode !== self::MODE_UNION && $mode !== self::MODE_INTERSECTION) {
-                throw new \RuntimeException('Invalid mode supplied for Assertion');
+                throw new RuntimeException('Invalid mode supplied for Assertion');
             }
-            $this->mode = $mode;
-        } elseif (! $value instanceof Operand) {
-            throw new \RuntimeException('Invalid value supplied for Assertion: ');
+            $this->setMode($mode);
         } else {
-            $this->mode = self::MODE_NONE;
+            $this->setMode(self::MODE_NONE);
         }
         $this->value = $value;
     }
 
-    public function getKind()
+    public function getKind(): string
     {
         return '';
     }
+
+    protected function setMode(int $mode): void
+    {
+        switch ($mode) {
+            case self::MODE_NONE:
+            case self::MODE_UNION:
+            case self::MODE_INTERSECTION:
+                break;
+            default:
+                throw new RuntimeException("Invalid mode supplied for Assertion");
+        }
+        $this->mode = $mode;
+    }
 }

lib/PHPCfg/Assertion.php

@@ -24,7 +24,7 @@ public function __construct($value)
         parent::__construct($value, self::MODE_INTERSECTION);
     }
 
-    public function getKind()
+    public function getKind(): string
     {
         return 'not';
     }