diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml index eaf11b9..b7612d9 100644 --- a/.github/workflows/static.yml +++ b/.github/workflows/static.yml @@ -46,5 +46,5 @@ jobs: - name: Install dependencies with composer run: composer update --prefer-dist --no-interaction --no-progress --optimize-autoloader - - name: Static analysis with phan - run: vendor/bin/phan --no-progress-bar --output-mode checkstyle | cs2pr --graceful-warnings --colorize + - name: Static analysis with psalm + run: vendor/bin/psalm --shepherd --stats --output-format=checkstyle | cs2pr --graceful-warnings --colorize diff --git a/.phan/config.php b/.phan/config.php deleted file mode 100644 index 4433509..0000000 --- a/.phan/config.php +++ /dev/null @@ -1,374 +0,0 @@ -=7.1.0" - 'target_php_version' => '7.4', - - // If enabled, missing properties will be created when - // they are first seen. If false, we'll report an - // error message if there is an attempt to write - // to a class property that wasn't explicitly - // defined. - 'allow_missing_properties' => false, - - // If enabled, null can be cast to any type and any - // type can be cast to null. Setting this to true - // will cut down on false positives. - 'null_casts_as_any_type' => false, - - // If enabled, allow null to be cast as any array-like type. - // - // This is an incremental step in migrating away from `null_casts_as_any_type`. - // If `null_casts_as_any_type` is true, this has no effect. - 'null_casts_as_array' => false, - - // If enabled, allow any array-like type to be cast to null. - // This is an incremental step in migrating away from `null_casts_as_any_type`. - // If `null_casts_as_any_type` is true, this has no effect. - 'array_casts_as_null' => false, - - // If enabled, scalars (int, float, bool, string, null) - // are treated as if they can cast to each other. - // This does not affect checks of array keys. See `scalar_array_key_cast`. - 'scalar_implicit_cast' => false, - - // If enabled, any scalar array keys (int, string) - // are treated as if they can cast to each other. - // E.g. `array` can cast to `array` and vice versa. - // Normally, a scalar type such as int could only cast to/from int and mixed. - 'scalar_array_key_cast' => false, - - // If this has entries, scalars (int, float, bool, string, null) - // are allowed to perform the casts listed. - // - // E.g. `['int' => ['float', 'string'], 'float' => ['int'], 'string' => ['int'], 'null' => ['string']]` - // allows casting null to a string, but not vice versa. - // (subset of `scalar_implicit_cast`) - 'scalar_implicit_partial' => [], - - // If enabled, Phan will warn if **any** type in a method invocation's object - // is definitely not an object, - // or if **any** type in an invoked expression is not a callable. - // Setting this to true will introduce numerous false positives - // (and reveal some bugs). - 'strict_method_checking' => true, - - // If enabled, Phan will warn if **any** type of the object expression for a property access - // does not contain that property. - 'strict_object_checking' => true, - - // If enabled, Phan will warn if **any** type in the argument's union type - // cannot be cast to a type in the parameter's expected union type. - // Setting this to true will introduce numerous false positives - // (and reveal some bugs). - 'strict_param_checking' => true, - - // If enabled, Phan will warn if **any** type in a property assignment's union type - // cannot be cast to a type in the property's declared union type. - // Setting this to true will introduce numerous false positives - // (and reveal some bugs). - 'strict_property_checking' => true, - - // If enabled, Phan will warn if **any** type in a returned value's union type - // cannot be cast to the declared return type. - // Setting this to true will introduce numerous false positives - // (and reveal some bugs). - 'strict_return_checking' => true, - - // If true, seemingly undeclared variables in the global - // scope will be ignored. - // - // This is useful for projects with complicated cross-file - // globals that you have no hope of fixing. - 'ignore_undeclared_variables_in_global_scope' => false, - - // Set this to false to emit `PhanUndeclaredFunction` issues for internal functions that Phan has signatures for, - // but aren't available in the codebase, or the internal functions used to run Phan - // (may lead to false positives if an extension isn't loaded) - // - // If this is true(default), then Phan will not warn. - 'ignore_undeclared_functions_with_known_signatures' => false, - - // Backwards Compatibility Checking. This is slow - // and expensive, but you should consider running - // it before upgrading your version of PHP to a - // new version that has backward compatibility - // breaks. - // - // If you are migrating from PHP 5 to PHP 7, - // you should also look into using - // [php7cc (no longer maintained)](https://github.com/sstalle/php7cc) - // and [php7mar](https://github.com/Alexia/php7mar), - // which have different backwards compatibility checks. - 'backward_compatibility_checks' => false, - - // If true, check to make sure the return type declared - // in the doc-block (if any) matches the return type - // declared in the method signature. - 'check_docblock_signature_return_type_match' => true, - - // If true, make narrowed types from phpdoc params override - // the real types from the signature, when real types exist. - // (E.g. allows specifying desired lists of subclasses, - // or to indicate a preference for non-nullable types over nullable types) - // - // Affects analysis of the body of the method and the param types passed in by callers. - // - // (*Requires `check_docblock_signature_param_type_match` to be true*) - 'prefer_narrowed_phpdoc_param_type' => true, - - // (*Requires `check_docblock_signature_return_type_match` to be true*) - // - // If true, make narrowed types from phpdoc returns override - // the real types from the signature, when real types exist. - // - // (E.g. allows specifying desired lists of subclasses, - // or to indicate a preference for non-nullable types over nullable types) - // - // This setting affects the analysis of return statements in the body of the method and the return types passed in by callers. - 'prefer_narrowed_phpdoc_return_type' => true, - - // If enabled, check all methods that override a - // parent method to make sure its signature is - // compatible with the parent's. - // - // This check can add quite a bit of time to the analysis. - // - // This will also check if final methods are overridden, etc. - 'analyze_signature_compatibility' => true, - - // This setting maps case-insensitive strings to union types. - // - // This is useful if a project uses phpdoc that differs from the phpdoc2 standard. - // - // If the corresponding value is the empty string, - // then Phan will ignore that union type (E.g. can ignore 'the' in `@return the value`) - // - // If the corresponding value is not empty, - // then Phan will act as though it saw the corresponding UnionTypes(s) - // when the keys show up in a UnionType of `@param`, `@return`, `@var`, `@property`, etc. - // - // This matches the **entire string**, not parts of the string. - // (E.g. `@return the|null` will still look for a class with the name `the`, but `@return the` will be ignored with the below setting) - // - // (These are not aliases, this setting is ignored outside of doc comments). - // (Phan does not check if classes with these names exist) - // - // Example setting: `['unknown' => '', 'number' => 'int|float', 'char' => 'string', 'long' => 'int', 'the' => '']` - 'phpdoc_type_mapping' => [], - - // Set to true in order to attempt to detect dead - // (unreferenced) code. Keep in mind that the - // results will only be a guess given that classes, - // properties, constants and methods can be referenced - // as variables (like `$class->$property` or - // `$class->$method()`) in ways that we're unable - // to make sense of. - 'dead_code_detection' => false, - - // Set to true in order to attempt to detect unused variables. - // `dead_code_detection` will also enable unused variable detection. - // - // This has a few known false positives, e.g. for loops or branches. - 'unused_variable_detection' => true, - - // Set to true in order to attempt to detect redundant and impossible conditions. - // - // This has some false positives involving loops, - // variables set in branches of loops, and global variables. - 'redundant_condition_detection' => true, - - // If enabled, Phan will act as though it's certain of real return types of a subset of internal functions, - // even if those return types aren't available in reflection (real types were taken from php 7.3 or 8.0-dev, depending on target_php_version). - // - // Note that with php 7 and earlier, php would return null or false for many internal functions if the argument types or counts were incorrect. - // As a result, enabling this setting with target_php_version 8.0 may result in false positives for `--redundant-condition-detection` when codebases also support php 7.x. - 'assume_real_types_for_internal_functions' => true, - - // If true, this runs a quick version of checks that takes less - // time at the cost of not running as thorough - // of an analysis. You should consider setting this - // to true only when you wish you had more **undiagnosed** issues - // to fix in your code base. - // - // In quick-mode the scanner doesn't rescan a function - // or a method's code block every time a call is seen. - // This means that the problem here won't be detected: - // - // ```php - // false, - - // Enable or disable support for generic templated - // class types. - 'generic_types_enabled' => true, - - // Override to hardcode existence and types of (non-builtin) globals in the global scope. - // Class names should be prefixed with `\`. - // - // (E.g. `['_FOO' => '\FooClass', 'page' => '\PageClass', 'userId' => 'int']`) - 'globals_type_map' => [], - - // The minimum severity level to report on. This can be - // set to `Issue::SEVERITY_LOW`, `Issue::SEVERITY_NORMAL` or - // `Issue::SEVERITY_CRITICAL`. Setting it to only - // critical issues is a good place to start on a big - // sloppy mature code base. - 'minimum_severity' => Issue::SEVERITY_LOW, - - // Add any issue types (such as `'PhanUndeclaredMethod'`) - // to this black-list to inhibit them from being reported. - 'suppress_issue_types' => [], - - // A regular expression to match files to be excluded - // from parsing and analysis and will not be read at all. - // - // This is useful for excluding groups of test or example - // directories/files, unanalyzable files, or files that - // can't be removed for whatever reason. - // (e.g. `'@Test\.php$@'`, or `'@vendor/.*/(tests|Tests)/@'`) - 'exclude_file_regex' => '@^vendor/.*/(tests?|Tests?|vendor)/@', - - // A file list that defines files that will be excluded - // from parsing and analysis and will not be read at all. - // - // This is useful for excluding hopelessly unanalyzable - // files that can't be removed for whatever reason. - 'exclude_file_list' => [], - - // A directory list that defines files that will be excluded - // from static analysis, but whose class and method - // information should be included. - // - // Generally, you'll want to include the directories for - // third-party code (such as "vendor/") in this list. - // - // n.b.: If you'd like to parse but not analyze 3rd - // party code, directories containing that code - // should be added to the `directory_list` as well as - // to `exclude_analysis_directory_list`. - 'exclude_analysis_directory_list' => [ - 'vendor/', - ], - - // Enable this to enable checks of require/include statements referring to valid paths. - 'enable_include_path_checks' => true, - - // The number of processes to fork off during the analysis - // phase. - 'processes' => 1, - - // List of case-insensitive file extensions supported by Phan. - // (e.g. `['php', 'html', 'htm']`) - 'analyzed_file_extensions' => [ - 'php', - ], - - // You can put paths to stubs of internal extensions in this config option. - // If the corresponding extension is **not** loaded, then Phan will use the stubs instead. - // Phan will continue using its detailed type annotations, - // but load the constants, classes, functions, and classes (and their Reflection types) - // from these stub files (doubling as valid php files). - // Use a different extension from php to avoid accidentally loading these. - // The `tools/make_stubs` script can be used to generate your own stubs (compatible with php 7.0+ right now) - // - // (e.g. `['xdebug' => '.phan/internal_stubs/xdebug.phan_php']`) - 'autoload_internal_extension_signatures' => [], - - // A list of plugin files to execute. - // - // Plugins which are bundled with Phan can be added here by providing their name (e.g. `'AlwaysReturnPlugin'`) - // - // Documentation about available bundled plugins can be found [here](https://github.com/phan/phan/tree/master/.phan/plugins). - // - // Alternately, you can pass in the full path to a PHP file with the plugin's implementation (e.g. `'vendor/phan/phan/.phan/plugins/AlwaysReturnPlugin.php'`) - 'plugins' => [ - 'AlwaysReturnPlugin', - 'DollarDollarPlugin', - 'DuplicateArrayKeyPlugin', - 'DuplicateExpressionPlugin', - 'PregRegexCheckerPlugin', - 'PrintfCheckerPlugin', - 'SleepCheckerPlugin', - 'UnreachableCodePlugin', - 'UseReturnValuePlugin', - 'EmptyStatementListPlugin', - 'StrictComparisonPlugin', - 'LoopVariableReusePlugin', - ], - - // A list of directories that should be parsed for class and - // method information. After excluding the directories - // defined in `exclude_analysis_directory_list`, the remaining - // files will be statically analyzed for errors. - // - // Thus, both first-party and third-party code being used by - // your application should be included in this list. - 'directory_list' => [ - 'src', - 'vendor' - ], - - // A list of individual files to include in analysis - // with a path relative to the root directory of the - // project. - 'file_list' => [], -]; diff --git a/composer.json b/composer.json index 8b281e0..5f45a79 100644 --- a/composer.json +++ b/composer.json @@ -19,15 +19,16 @@ "prefer-stable": true, "require": { "php": "^7.4|^8.0", + "psr/container": "^1.0", "yiisoft/di": "^3.0@dev", + "yiisoft/event-dispatcher": "^3.0@dev", "yiisoft/friendly-exception": "^1.0", - "yiisoft/injector": "^1.0", - "yiisoft/event-dispatcher": "^3.0@dev" + "yiisoft/injector": "^1.0" }, "require-dev": { - "infection/infection": "^0.16.3", - "phan/phan": "^3.0", - "phpunit/phpunit": "^9.3" + "infection/infection": "^0.18.0", + "phpunit/phpunit": "^9.4", + "vimeo/psalm": "^4.0" }, "autoload": { "psr-4": { diff --git a/psalm.xml b/psalm.xml new file mode 100644 index 0000000..f8edfd3 --- /dev/null +++ b/psalm.xml @@ -0,0 +1,15 @@ + + + + + + + + + diff --git a/src/EventDispatcherProvider.php b/src/EventDispatcherProvider.php index 03654fd..25fb9ff 100644 --- a/src/EventDispatcherProvider.php +++ b/src/EventDispatcherProvider.php @@ -26,9 +26,6 @@ public function __construct(array $eventListeners) $this->eventListeners = $eventListeners; } - /** - * @suppress PhanAccessMethodProtected - */ public function register(Container $container): void { $listenerCollection = new ListenerCollection(); @@ -51,12 +48,13 @@ public function register(Container $container): void } foreach ($listeners as $callable) { + /** @psalm-suppress InvalidCatch */ try { if (!$this->isCallable($callable, $container)) { - $type = gettype($listeners); + $type = gettype($callable); throw new InvalidListenerConfigurationException( - "Listener must be a callable. $type given." + "Listener must be a callable, $type given." ); } } catch (ContainerExceptionInterface $exception) { @@ -80,7 +78,10 @@ public function register(Container $container): void $provider = new Provider($listenerCollection); + /** @psalm-suppress InaccessibleMethod */ $container->set(ListenerProviderInterface::class, $provider); + + /** @psalm-suppress InaccessibleMethod */ $container->set(EventDispatcherInterface::class, Dispatcher::class); } diff --git a/tests/EventConfiguratorTest.php b/tests/EventConfiguratorTest.php index ba1e234..7110269 100644 --- a/tests/EventConfiguratorTest.php +++ b/tests/EventConfiguratorTest.php @@ -7,7 +7,6 @@ use PHPUnit\Framework\TestCase; use Psr\EventDispatcher\ListenerProviderInterface; use Yiisoft\Di\Container; -use Yiisoft\EventDispatcher\Provider\Provider; use Yiisoft\Yii\Event\EventDispatcherProvider; use Yiisoft\Yii\Event\InvalidEventConfigurationFormatException; use Yiisoft\Yii\Event\InvalidListenerConfigurationException; @@ -67,7 +66,7 @@ public function testInvalidEventConfigurationFormatExceptionWhenConfigurationKey $serviceProvider->register(new Container()); } - public function testInvalidEventConfigurationFormatExceptionWhenConfigurationValueIsBad():void + public function testInvalidEventConfigurationFormatExceptionWhenConfigurationValueIsBad(): void { $serviceProvider = new EventDispatcherProvider([ 'test' => new \stdClass(), @@ -79,6 +78,20 @@ public function testInvalidEventConfigurationFormatExceptionWhenConfigurationVal $serviceProvider->register(new Container()); } + public function testInvalidEventConfigurationFormatExceptionWhenListenerIsBad(): void + { + $serviceProvider = new EventDispatcherProvider([ + 'test' => [ + new \stdClass(), + ], + ]); + + $this->expectException(InvalidListenerConfigurationException::class); + $this->expectExceptionMessage('Listener must be a callable, object given.'); + + $serviceProvider->register(new Container()); + } + private function getEventsConfig(): array { return [