Enable validating private properties of parent classes

All validators related to object properties only consider the properties
of the object being validated, not those of its parent object. That's
because PHP reflection only gets the properties visible to the current
class (public or protected). The problem with that is that when there's
a private property in the parent class, we're completely unaware of it.

This commit will modify those rules by retrieving properties from the
parent class, ensuring we capture all properties that require
validation.

Author: henriquemoody

library/Rules/Attributes.php

@@ -11,7 +11,9 @@
 
 use Attribute;
 use ReflectionAttribute;
+use ReflectionClass;
 use ReflectionObject;
+use ReflectionProperty;
 use Respect\Validation\Id;
 use Respect\Validation\Result;
 use Respect\Validation\Rule;
@@ -28,32 +30,65 @@ public function evaluate(mixed $input): Result
             return $objectType->withId($id);
         }
 
-        $rules = [];
         $reflection = new ReflectionObject($input);
-        foreach ($reflection->getAttributes(Rule::class, ReflectionAttribute::IS_INSTANCEOF) as $attribute) {
-            $rules[] = $attribute->newInstance();
+        $rules = [...$this->getClassRules($reflection), ...$this->getPropertyRules($reflection)];
+        if ($rules === []) {
+            return (new AlwaysValid())->evaluate($input)->withId($id);
+        }
+
+        return (new Reducer(...$rules))->evaluate($input)->withId($id);
+    }
+
+    /** @return array<Rule> */
+    private function getClassRules(ReflectionObject $reflection): array
+    {
+        $rules = [];
+        while ($reflection instanceof ReflectionClass) {
+            foreach ($reflection->getAttributes(Rule::class, ReflectionAttribute::IS_INSTANCEOF) as $attribute) {
+                $rules[] = $attribute->newInstance();
+            }
+
+            $reflection = $reflection->getParentClass();
         }
 
-        foreach ($reflection->getProperties() as $property) {
-            $childrenRules = [];
+        return $rules;
+    }
+
+    /** @return array<Rule> */
+    private function getPropertyRules(ReflectionObject $reflection): array
+    {
+        $rules = [];
+        foreach ($this->getProperties($reflection) as $propertyName => $property) {
+            $propertyRules = [];
             foreach ($property->getAttributes(Rule::class, ReflectionAttribute::IS_INSTANCEOF) as $attribute) {
-                $childrenRules[] = $attribute->newInstance();
+                $propertyRules[] = $attribute->newInstance();
             }
 
-            if ($childrenRules === []) {
+            if ($propertyRules === []) {
                 continue;
             }
 
             $allowsNull = $property->getType()?->allowsNull() ?? false;
 
-            $childRule = new Reducer(...$childrenRules);
-            $rules[] = new Property($property->getName(), $allowsNull ? new NullOr($childRule) : $childRule);
+            $childRule = new Reducer(...$propertyRules);
+            $rules[] = new Property($propertyName, $allowsNull ? new NullOr($childRule) : $childRule);
         }
 
-        if ($rules === []) {
-            return (new AlwaysValid())->evaluate($input)->withId($id);
+        return $rules;
+    }
+
+    /** @return array<ReflectionProperty> */
+    private function getProperties(ReflectionObject $reflection): array
+    {
+        $properties = [];
+        while ($reflection instanceof ReflectionClass) {
+            foreach ($reflection->getProperties() as $property) {
+                $properties[$property->name] = $property;
+            }
+
+            $reflection = $reflection->getParentClass();
         }
 
-        return (new Reducer(...$rules))->evaluate($input)->withId($id);
+        return $properties;
     }
 }

library/Rules/Property.php

@@ -10,6 +10,7 @@
 namespace Respect\Validation\Rules;
 
 use Attribute;
+use ReflectionClass;
 use ReflectionObject;
 use Respect\Validation\Path;
 use Respect\Validation\Result;
@@ -34,15 +35,23 @@ public function evaluate(mixed $input): Result
         }
 
         return $this->rule
-            ->evaluate($this->extractPropertyValue($input, $this->propertyName))
+            ->evaluate($this->getPropertyValue($input, $this->propertyName))
             ->withPath(new Path($this->propertyName));
     }
 
-    private function extractPropertyValue(object $input, string $property): mixed
+    private function getPropertyValue(object $object, string $propertyName): mixed
     {
-        $reflectionObject = new ReflectionObject($input);
-        $reflectionProperty = $reflectionObject->getProperty($property);
+        $reflection = new ReflectionObject($object);
+        while ($reflection instanceof ReflectionClass) {
+            if ($reflection->hasProperty($propertyName)) {
+                $property = $reflection->getProperty($propertyName);
 
-        return $reflectionProperty->isInitialized($input) ? $reflectionProperty->getValue($input) : null;
+                return $property->isInitialized($object) ? $property->getValue($object) : null;
+            }
+
+            $reflection = $reflection->getParentClass();
+        }
+
+        return null;
     }
 }

library/Rules/PropertyExists.php

@@ -10,6 +10,7 @@
 namespace Respect\Validation\Rules;
 
 use Attribute;
+use ReflectionClass;
 use ReflectionObject;
 use Respect\Validation\Message\Template;
 use Respect\Validation\Path;
@@ -33,19 +34,24 @@ public function __construct(
     public function evaluate(mixed $input): Result
     {
         return new Result(
-            $this->hasProperty($input),
+            is_object($input) && $this->hasProperty($input),
             $input,
             $this,
             path: new Path($this->propertyName),
         );
     }
 
-    private function hasProperty(mixed $input): bool
+    private function hasProperty(object $object): bool
     {
-        if (!is_object($input)) {
-            return false;
+        $reflection = new ReflectionObject($object);
+        while ($reflection instanceof ReflectionClass) {
+            if ($reflection->hasProperty($this->propertyName)) {
+                return true;
+            }
+
+            $reflection = $reflection->getParentClass();
         }
 
-        return (new ReflectionObject($input))->hasProperty($this->propertyName);
+        return false;
     }
 }

phpstan.neon.dist

@@ -21,6 +21,8 @@ parameters:
       path: tests/unit/Message/Translator/ArrayTranslatorTest.php
     - message: '/Access to an undefined property PHPUnit\\Framework\\TestCase/'
       path: tests/feature/Rules/SizeTest.php
+    - message: '/Property Respect\\Validation\\Test\\Stubs\\.+::\$[a-zA-Z]+ is never read, only written./'
+      path: tests/library/Stubs
   level: 8
   treatPhpDocTypesAsCertain: false
   paths:

tests/feature/Rules/AttributesTest.php

@@ -46,20 +46,20 @@
     fn(string $message, string $fullMessage, array $messages) => expect()
         ->and($message)->toBe('`.name` must not be empty')
         ->and($fullMessage)->toBe(<<<'FULL_MESSAGE'
-            - `Respect\Validation\Test\Stubs\WithAttributes { +$name="" +$birthdate="not a date" +$email="not an email" +$phone ... }` must pass the rules
+            - `Respect\Validation\Test\Stubs\WithAttributes { +$name="" +$birthdate="not a date" #$phone="not a phone number" + ... }` must pass the rules
               - `.name` must not be empty
               - `.birthdate` must pass all the rules
                 - `.birthdate` must be a valid date in the format "2005-12-30"
                 - For comparison with now, `.birthdate` must be a valid datetime
-              - `.email` must be a valid email address or must be null
               - `.phone` must be a valid telephone number or must be null
+              - `.email` must be a valid email address or must be null
             FULL_MESSAGE)
         ->and($messages)->toBe([
-            '__root__' => '`Respect\Validation\Test\Stubs\WithAttributes { +$name="" +$birthdate="not a date" +$email="not an email" +$phone ... }` must pass the rules',
+            '__root__' => '`Respect\Validation\Test\Stubs\WithAttributes { +$name="" +$birthdate="not a date" #$phone="not a phone number" + ... }` must pass the rules',
             'name' => '`.name` must not be empty',
             'birthdate' => 'For comparison with now, `.birthdate` must be a valid datetime',
-            'email' => '`.email` must be a valid email address or must be null',
             'phone' => '`.phone` must be a valid telephone number or must be null',
+            'email' => '`.email` must be a valid email address or must be null',
         ]),
 ));
 
@@ -68,13 +68,13 @@
     fn(string $message, string $fullMessage, array $messages) => expect()
         ->and($message)->toBe('`.email` must be defined')
         ->and($fullMessage)->toBe(<<<'FULL_MESSAGE'
-        - `Respect\Validation\Test\Stubs\WithAttributes { +$name="John Doe" +$birthdate="2024-06-23" +$email=null +$phone=n ... }` must pass at least one of the rules
+        - `Respect\Validation\Test\Stubs\WithAttributes { +$name="John Doe" +$birthdate="2024-06-23" #$phone=null +$address ... }` must pass at least one of the rules
           - `.email` must be defined
           - `.phone` must be defined
         FULL_MESSAGE)
         ->and($messages)->toBe([
             'anyOf' => [
-                '__root__' => '`Respect\Validation\Test\Stubs\WithAttributes { +$name="John Doe" +$birthdate="2024-06-23" +$email=null +$phone=n ... }` must pass at least one of the rules',
+                '__root__' => '`Respect\Validation\Test\Stubs\WithAttributes { +$name="John Doe" +$birthdate="2024-06-23" #$phone=null +$address ... }` must pass at least one of the rules',
                 'email' => '`.email` must be defined',
                 'phone' => '`.phone` must be defined',
             ],

tests/library/Stubs/ParentWithAttributes.php

@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * Copyright (c) Alexandre Gomes Gaigalas <[email protected]>
+ * SPDX-License-Identifier: MIT
+ */
+
+declare(strict_types=1);
+
+namespace Respect\Validation\Test\Stubs;
+
+use Respect\Validation\Rules as Rule;
+
+abstract class ParentWithAttributes
+{
+    public function __construct(
+        #[Rule\Email]
+        private string|null $email = null,
+        #[Rule\Phone]
+        protected string|null $phone = null,
+        public string|null $address = null,
+    ) {
+    }
+}

tests/library/Stubs/WithAttributes.php

@@ -15,19 +15,18 @@
     new Rule\Property('email', new Rule\NotUndef()),
     new Rule\Property('phone', new Rule\NotUndef()),
 )]
-final class WithAttributes
+final class WithAttributes extends ParentWithAttributes
 {
     public function __construct(
         #[Rule\NotEmpty]
         public string $name,
         #[Rule\Date('Y-m-d')]
         #[Rule\DateTimeDiff('years', new Rule\LessThanOrEqual(25))]
         public string $birthdate,
-        #[Rule\Email]
-        public string|null $email = null,
-        #[Rule\Phone]
-        public string|null $phone = null,
-        public string|null $address = null,
+        string|null $email = null,
+        string|null $phone = null,
+        string|null $address = null,
     ) {
+        parent::__construct($email, $phone, $address);
     }
 }