Merge pull request #229 from ray-di/types

Add centralized type definitions in Types.php
ray-di · Dec 15, 2024 · b3ebb85 · b3ebb85
2 parents ba45ba8 + d176d21
commit b3ebb85
Show file tree

Hide file tree

Showing 13 changed files with 106 additions and 173 deletions.
diff --git a/.github/workflows/continuous-integration-pecl.yml b/.github/workflows/continuous-integration-pecl.yml
diff --git a/src/AbstractMatcher.php b/src/AbstractMatcher.php
@@ -12,8 +12,8 @@
 /**
  * Abstract matcher base class
  *
- * @psalm-type MatcherArguments = array<array-key, mixed>
- * @psalm-type Arguments = array<array-key, mixed>
+ * @psalm-import-type MatcherArguments from Types
+ * @psalm-import-type Arguments from Types
  */
 abstract class AbstractMatcher
 {

diff --git a/src/Aspect.php b/src/Aspect.php
@@ -16,16 +16,13 @@
 /**
  * Aspect class manages aspect weaving and method interception
  *
- * @psalm-type MethodInterceptors = array<array-key, MethodInterceptor>
- * @psalm-type MethodBindings = array<string, MethodInterceptors>
- * @psalm-type ClassBindings = array<class-string, MethodBindings>
- * @psalm-type MatcherConfig = array{
- *   classMatcher: AbstractMatcher,
- *   methodMatcher: AbstractMatcher,
- *   interceptors: MethodInterceptors
- * }
- * @psalm-type MatcherConfigList = array<array-key, MatcherConfig>
- * @psalm-type Arguments = array<array-key, mixed>
+ * @psalm-import-type MethodInterceptors from Types
+ * @psalm-import-type MethodBindings from Types
+ * @psalm-import-type ClassBindings from Types
+ * @psalm-import-type MatcherConfig from Types
+ * @psalm-import-type MatcherConfigList from Types
+ * @psalm-import-type Arguments from Types
+ * @psalm-import-type MethodName from Types
  */
 final class Aspect
 {
@@ -135,7 +132,9 @@ private function createBind(string $className): Bind
                     continue; // @codeCoverageIgnore
                 }
 
-                $bind->bindInterceptors($method->getName(), $matcher['interceptors']);
+                /** @var MethodName $methodName */
+                $methodName = $method->getName();
+                $bind->bindInterceptors($methodName, $matcher['interceptors']);
             }
         }
 

diff --git a/src/AspectPecl.php b/src/AspectPecl.php
@@ -17,10 +17,10 @@
 use function method_intercept;
 
 /**
- * @psalm-type MethodBoundInterceptors = array<non-empty-string, MethodInterceptors>
- * @psalm-type ClassBoundInterceptors = array<class-string, MethodBoundInterceptors>
- * @psalm-import-type MatcherConfigList from Aspect
- * @psalm-import-type MethodInterceptors from Aspect
+ * @psalm-import-type MethodBoundInterceptors from Types
+ * @psalm-import-type ClassBoundInterceptors from Types
+ * @psalm-import-type MatcherConfigList from Types
+ * @psalm-import-type MethodInterceptors from Types
  * @codeCoverageIgnore
  */
 final class AspectPecl

diff --git a/src/Bind.php b/src/Bind.php
@@ -11,9 +11,10 @@
 /**
  * Bind class manages method interception bindings
  *
- * @psalm-import-type MethodInterceptors from Aspect
- * @psalm-import-type MethodBindings from Aspect
- * @psalm-type Pointcuts = array<Pointcut>
+ * @psalm-import-type MethodInterceptors from Types
+ * @psalm-import-type MethodBindings from Types
+ * @psalm-import-type Pointcuts from Types
+ * @psalm-import-type MethodName from Types
  */
 final class Bind implements BindInterface
 {
@@ -69,7 +70,7 @@ public function bind(string $class, array $pointcuts): BindInterface
     /**
      * Bind interceptors to a method
      *
-     * @param string             $method       Method name
+     * @param MethodName         $method       Method name
      * @param MethodInterceptors $interceptors List of interceptors
      */
     public function bindInterceptors(string $method, array $interceptors): BindInterface

diff --git a/src/BindInterface.php b/src/BindInterface.php
@@ -4,6 +4,7 @@
 
 namespace Ray\Aop;
 
+/** @psalm-import-type MethodName from Types */
 interface BindInterface
 {
     /**
@@ -17,6 +18,7 @@ public function bind(string $class, array $pointcuts): self;
     /**
      * Bind interceptors to method
      *
+     * @param MethodName          $method
      * @param MethodInterceptor[] $interceptors
      */
     public function bindInterceptors(string $method, array $interceptors): self;

diff --git a/src/BuiltinMatcher.php b/src/BuiltinMatcher.php
@@ -13,7 +13,7 @@
 
 /**
  * @psalm-suppress PropertyNotSetInConstructor
- * @psalm-import-type MatcherArguments from AbstractMatcher
+ * @psalm-import-type MatcherArguments from Types
  */
 class BuiltinMatcher extends AbstractMatcher
 {

diff --git a/src/Compiler.php b/src/Compiler.php
@@ -28,7 +28,7 @@
  *  AOP (Aspect-Oriented Programming) classes. Handles the binding of
  *  methods and ensures the classes are writable.
  *
- * @psalm-import-type ConstructorArguments from CompilerInterface
+ * @psalm-import-type ConstructorArguments from Types
  */
 final class Compiler implements CompilerInterface
 {

diff --git a/src/CompilerInterface.php b/src/CompilerInterface.php
@@ -5,11 +5,11 @@
 namespace Ray\Aop;
 
 /**
- * @psalm-import-type MethodInterceptors from Aspect
- * @psalm-import-type MethodBindings from Aspect
- * @psalm-import-type ClassBindings from Aspect
- * @psalm-import-type MatcherConfig from Aspect
- * @psalm-type ConstructorArguments = list<mixed>
+ * @psalm-import-type MethodInterceptors from Types
+ * @psalm-import-type MethodBindings from Types
+ * @psalm-import-type ClassBindings from Types
+ * @psalm-import-type MatcherConfig from Types
+ * @psalm-import-type ConstructorArguments from Types
  */
 interface CompilerInterface
 {

diff --git a/src/Matcher/AnyMatcher.php b/src/Matcher/AnyMatcher.php
@@ -6,15 +6,23 @@
 
 use ArrayObject;
 use Ray\Aop\AbstractMatcher;
+use Ray\Aop\Types;
 use ReflectionClass;
 use ReflectionMethod;
 
 use function in_array;
 use function strpos;
 
+/**
+ * @psalm-import-type Arguments from Types
+ * @psalm-import-type BuiltinMethodsNames from Types
+ */
 final class AnyMatcher extends AbstractMatcher
 {
-    /** @var string[] */
+    /**
+     * @var BuiltinMethodsNames
+     * @readonly
+     */
     private static $builtinMethods = [];
 
     public function __construct()

diff --git a/src/MethodMatch.php b/src/MethodMatch.php
@@ -11,12 +11,12 @@
 use function get_class;
 
 /**
- * @psalm-import-type MethodInterceptors from Aspect
- * @psalm-import-type MethodBindings from Aspect
- * @psalm-import-type ClassBindings from Aspect
- * @psalm-import-type MatcherConfig from Aspect
- * @psalm-import-type Arguments from Aspect
- * @psalm-import-type Pointcuts from Bind
+ * @psalm-import-type MethodInterceptors from Types
+ * @psalm-import-type MethodBindings from Types
+ * @psalm-import-type ClassBindings from Types
+ * @psalm-import-type MatcherConfig from Types
+ * @psalm-import-type Arguments from Types
+ * @psalm-import-type Pointcuts from Types
  */
 final class MethodMatch
 {

diff --git a/src/ReflectiveMethodInvocation.php b/src/ReflectiveMethodInvocation.php
@@ -14,10 +14,10 @@
 use function is_callable;
 
 /**
+ * @psalm-import-type ArgumentList from Types
+ * @psalm-import-type NamedArguments from Types
+ * @psalm-import-type InterceptorList from Types
  * @template T of object
- * @psalm-type ArgumentList = ArrayObject<int, mixed>
- * @psalm-type NamedArguments = ArrayObject<non-empty-string, mixed>
- * @psalm-type InterceptorList = array<MethodInterceptor>
  * @implements MethodInvocation<T>
  */
 final class ReflectiveMethodInvocation implements MethodInvocation

diff --git a/src/Types.php b/src/Types.php
@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Ray\Aop;
+
+use ArrayObject;
+
+/**
+ * Type definitions for Ray.Aop
+ *
+ * @phpcs:disable SlevomatCodingStandard.Commenting.DocCommentSpacing
+ * @template T of object
+ *
+ * Domain Types
+ * @psalm-type ScriptDir = non-empty-string
+ * @psalm-type ClassName = class-string
+ * @psalm-type MethodName = non-empty-string
+ * @psalm-type AspectClassName = non-empty-string
+ * @psalm-type BindingName = non-empty-string
+ * @psalm-type MatcherName = non-empty-string
+ *
+ * Base Types
+ * @psalm-type ArgumentList = ArrayObject<int, mixed>
+ * @psalm-type NamedArguments = ArrayObject<MethodName, mixed>
+ * @psalm-type InterceptorList = array<MethodInterceptor>
+ * @psalm-type ConstructorArguments = list<mixed>
+ * @psalm-type ReflectionClassTemplate = ReflectionClass<T>
+ *
+ * Matcher Types
+ * @psalm-type MatcherArguments = array<array-key, mixed>
+ * @psalm-type MethodInterceptors = array<array-key, MethodInterceptor>
+ * @psalm-type MatcherConfig = array{
+ *   classMatcher: AbstractMatcher,
+ *   methodMatcher: AbstractMatcher,
+ *   interceptors: MethodInterceptors
+ * }
+ * @psalm-type Arguments = array<array-key, mixed>
+ * @psalm-type BuiltinMethodsNames = list<non-empty-string>
+ *
+ * Method and Binding Types
+ * @psalm-type MethodBindings = array<MethodName, MethodInterceptors>
+ * @psalm-type ClassBindings = array<ClassName, MethodBindings>
+ * @psalm-type MatcherConfigList = array<array-key, MatcherConfig>
+ * @psalm-type MethodBoundInterceptors = array<MethodName, MethodInterceptors>
+ * @psalm-type ClassBoundInterceptors = array<ClassName, MethodBoundInterceptors>
+ *
+ * PointCut Types
+ * @psalm-type Pointcuts = array<Pointcut>
+ * @phpcs:enable
+ */
+final class Types
+{
+    /** @codeCoverageIgnore */
+    private function __construct()
+    {
+    }
+}