Parser classifier

.styleci.yml

@@ -7,6 +7,8 @@ finder:
   exclude:
     - docs
     - vendor
+  not-name:
+    - wrong_file.php
 
 enabled:
   - alpha_ordered_traits

README.md

@@ -9,11 +9,11 @@
 [![Latest Stable Version](https://poser.pugx.org/yiisoft/classifier/v/stable.png)](https://packagist.org/packages/yiisoft/classifier)
 [![Total Downloads](https://poser.pugx.org/yiisoft/classifier/downloads.png)](https://packagist.org/packages/yiisoft/classifier)
 [![Build status](https://github.com/yiisoft/classifier/workflows/build/badge.svg)](https://github.com/yiisoft/classifier/actions?query=workflow%3Abuild)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/yiisoft/classifier/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/yiisoft/classifier/?branch=master)
-[![Code Coverage](https://scrutinizer-ci.com/g/yiisoft/classifier/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/yiisoft/classifier/?branch=master)
+[![Code Coverage](https://codecov.io/gh/yiisoft/classifier/branch/master/graph/badge.svg)](https://codecov.io/gh/yiisoft/classifier)
 [![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fyiisoft%2Fclassifier%2Fmaster)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/classifier/master)
 [![static analysis](https://github.com/yiisoft/classifier/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/classifier/actions?query=workflow%3A%22static+analysis%22)
 [![type-coverage](https://shepherd.dev/github/yiisoft/classifier/coverage.svg)](https://shepherd.dev/github/yiisoft/classifier)
+[![psalm-level](https://shepherd.dev/github/yiisoft/classifier/level.svg)](https://shepherd.dev/github/yiisoft/classifier)
 
 Classifier traverses file system to find classes by a certain criteria.
 

composer-require-checker.json

@@ -0,0 +1,11 @@
+{
+    "symbol-whitelist": [
+        "PhpParser\\Node",
+        "PhpParser\\NodeTraverser",
+        "PhpParser\\NodeVisitorAbstract",
+        "PhpParser\\NodeVisitor\\NameResolver",
+        "PhpParser\\Node\\Stmt\\Class_",
+        "PhpParser\\Parser",
+        "PhpParser\\ParserFactory"
+    ]
+}

composer.json

@@ -35,6 +35,7 @@
     },
     "require-dev": {
         "maglnet/composer-require-checker": "^4.2",
+        "nikic/php-parser": "^4.17",
         "phpunit/phpunit": "^9.5",
         "rector/rector": "^1.0.0",
         "roave/infection-static-analysis-plugin": "^1.16",
@@ -51,6 +52,9 @@
             "Yiisoft\\Classifier\\Tests\\": "tests"
         }
     },
+    "suggest": {
+        "nikic/php-parser": "Need for ParserClassifier implementation"
+    },
     "config": {
         "sort-packages": true,
         "allow-plugins": {

rector.php

@@ -12,6 +12,10 @@
         __DIR__ . '/tests',
     ]);
 
+    $rectorConfig->skip([
+        __DIR__ . '/tests/Support/wrong_file.php',
+    ]);
+
     // register a single rule
     $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);
 

src/AbstractClassifier.php

@@ -0,0 +1,93 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Classifier;
+
+use Symfony\Component\Finder\Finder;
+
+/**
+ * Base implementation for {@see ClassifierInterface} with common filters.
+ */
+abstract class AbstractClassifier implements ClassifierInterface
+{
+    /**
+     * @var string[]
+     */
+    protected array $interfaces = [];
+    /**
+     * @var string[]
+     */
+    protected array $attributes = [];
+    /**
+     * @psalm-var class-string
+     */
+    protected ?string $parentClass = null;
+    /**
+     * @var string[]
+     */
+    protected array $directories;
+
+    public function __construct(string $directory, string ...$directories)
+    {
+        $this->directories = [$directory, ...array_values($directories)];
+    }
+
+    /**
+     * @psalm-param class-string ...$interfaces
+     */
+    public function withInterface(string ...$interfaces): self
+    {
+        $new = clone $this;
+        array_push($new->interfaces, ...array_values($interfaces));
+
+        return $new;
+    }
+
+    /**
+     * @psalm-param class-string $parentClass
+     */
+    public function withParentClass(string $parentClass): self
+    {
+        $new = clone $this;
+        $new->parentClass = $parentClass;
+        return $new;
+    }
+
+    /**
+     * @psalm-param class-string ...$attributes
+     */
+    public function withAttribute(string ...$attributes): self
+    {
+        $new = clone $this;
+        array_push($new->attributes, ...array_values($attributes));
+
+        return $new;
+    }
+
+    /**
+     * @psalm-return iterable<class-string>
+     */
+    public function find(): iterable
+    {
+        if (empty($this->interfaces) && empty($this->attributes) && $this->parentClass === null) {
+            return [];
+        }
+
+        yield from $this->getAvailableClasses();
+    }
+
+    protected function getFiles(): Finder
+    {
+        return (new Finder())
+            ->in($this->directories)
+            ->name('*.php')
+            ->sortByName()
+            ->files();
+    }
+
+    /**
+     * @return iterable<class-string>
+     */
+    abstract protected function getAvailableClasses(): iterable;
+}

src/ClassifierInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Classifier;
+
+/**
+ * `Classifier` is a class finder that represents the classes found.
+ */
+interface ClassifierInterface
+{
+    /**
+     * Returns all the class names found.
+     *
+     * @return iterable List of class names.
+     * @psalm-return iterable<class-string>
+     */
+    public function find(): iterable;
+}