Tests: rename AssertAttributeSame trait to AssertPropertySame

The name was originally based on the name of the assertion available in PHPUnit, however, what with the introduction of the language construct named attributes in PHP 8.0, the name is now not very helpful/clear. What this trait really does, is check the value of an object property, so let's make that more obvious in the naming. Note: as this is an internal test-only file, this rename is not a breaking change.
PHPCSStandards · Apr 29, 2024 · b7a1bdb · b7a1bdb
1 parent a37e010
commit b7a1bdb
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 39 deletions.
diff --git a/Tests/AbstractSniffs/AbstractArrayDeclaration/AbstractArrayDeclarationSniffTest.php b/Tests/AbstractSniffs/AbstractArrayDeclaration/AbstractArrayDeclarationSniffTest.php
@@ -159,11 +159,11 @@ public function testSingleLineShortArrayNoKeysNoTrailingComma()
         $mockObj->process(self::$phpcsFile, $target);
 
         // Verify that the properties have been correctly set.
-        $this->assertAttributeValueSame($target, 'stackPtr', $mockObj);
-        $this->assertAttributeValueSame($target, 'arrayOpener', $mockObj);
-        $this->assertAttributeValueSame(($target + 5), 'arrayCloser', $mockObj);
-        $this->assertAttributeValueSame(2, 'itemCount', $mockObj);
-        $this->assertAttributeValueSame(true, 'singleLine', $mockObj);
+        $this->assertPropertySame($target, 'stackPtr', $mockObj);
+        $this->assertPropertySame($target, 'arrayOpener', $mockObj);
+        $this->assertPropertySame(($target + 5), 'arrayCloser', $mockObj);
+        $this->assertPropertySame(2, 'itemCount', $mockObj);
+        $this->assertPropertySame(true, 'singleLine', $mockObj);
     }
 
     /**
@@ -235,11 +235,11 @@ public function testMultiLineLongArrayKeysTrailingComma()
         $mockObj->process(self::$phpcsFile, $target);
 
         // Verify that the properties have been correctly set.
-        $this->assertAttributeValueSame($target, 'stackPtr', $mockObj);
-        $this->assertAttributeValueSame(($target + 1), 'arrayOpener', $mockObj);
-        $this->assertAttributeValueSame(($target + 35), 'arrayCloser', $mockObj);
-        $this->assertAttributeValueSame(4, 'itemCount', $mockObj);
-        $this->assertAttributeValueSame(false, 'singleLine', $mockObj);
+        $this->assertPropertySame($target, 'stackPtr', $mockObj);
+        $this->assertPropertySame(($target + 1), 'arrayOpener', $mockObj);
+        $this->assertPropertySame(($target + 35), 'arrayCloser', $mockObj);
+        $this->assertPropertySame(4, 'itemCount', $mockObj);
+        $this->assertPropertySame(false, 'singleLine', $mockObj);
     }
 
     /**
@@ -318,11 +318,11 @@ public function testMultiLineShortArrayMixedKeysNoKeys()
         $mockObj->process(self::$phpcsFile, $target);
 
         // Verify that the properties have been correctly set.
-        $this->assertAttributeValueSame($target, 'stackPtr', $mockObj);
-        $this->assertAttributeValueSame($target, 'arrayOpener', $mockObj);
-        $this->assertAttributeValueSame(($target + 22), 'arrayCloser', $mockObj);
-        $this->assertAttributeValueSame(3, 'itemCount', $mockObj);
-        $this->assertAttributeValueSame(false, 'singleLine', $mockObj);
+        $this->assertPropertySame($target, 'stackPtr', $mockObj);
+        $this->assertPropertySame($target, 'arrayOpener', $mockObj);
+        $this->assertPropertySame(($target + 22), 'arrayCloser', $mockObj);
+        $this->assertPropertySame(3, 'itemCount', $mockObj);
+        $this->assertPropertySame(false, 'singleLine', $mockObj);
     }
 
     /**

diff --git a/Tests/AssertAttributeSame.php → Tests/AssertPropertySame.php b/Tests/AssertAttributeSame.php → Tests/AssertPropertySame.php
@@ -18,35 +18,35 @@
  * PHPUnit cross-version compatibility helper.
  *
  * Backfills the PHPUnit native `assertAttributeSame()` method in PHPUnit 9.x and above in which
- * the method was removed. Use `assertAttributeValueSame()` instead of `assertAttributeSame()`
+ * the method was removed. Use `assertPropertySame()` instead of `assertAttributeSame()`
  * for cross-version compatibility.
  *
  * @since 1.0.0
  */
-trait AssertAttributeSame
+trait AssertPropertySame
 {
 
     /**
      * PHPUnit cross-version helper method to test the value of class properties.
      *
-     * @param mixed  $expected      Expected property value.
-     * @param string $attributeName The name of the property to check.
-     * @param object $actualObject  The object on which to check the property value.
-     * @param string $message       Optional. Custom error message.
+     * @param mixed  $expected     Expected property value.
+     * @param string $propertyName The name of the property to check.
+     * @param object $actualObject The object on which to check the property value.
+     * @param string $message      Optional. Custom error message.
      *
      * @return void
      */
-    public function assertAttributeValueSame($expected, $attributeName, $actualObject, $message = '')
+    public function assertPropertySame($expected, $propertyName, $actualObject, $message = '')
     {
         // Will throw a warning on PHPUnit 8, but will still work.
         if (\method_exists($this, 'assertAttributeSame')) {
-            $this->assertAttributeSame($expected, $attributeName, $actualObject, $message);
+            $this->assertAttributeSame($expected, $propertyName, $actualObject, $message);
             return;
         }
 
         // PHPUnit 9.0+.
         try {
-            $actual = $this->getObjectAttributeValue($actualObject, $attributeName);
+            $actual = $this->getObjectPropertyValue($actualObject, $propertyName);
         } catch (Exception $e) {
             $this->fail($e->getMessage());
         }
@@ -55,31 +55,32 @@ public function assertAttributeValueSame($expected, $attributeName, $actualObjec
     }
 
     /**
-     * Retrieve the value of an object's attribute.
-     * This also works for attributes that are declared protected or private.
+     * Retrieve the value of an object property.
+     *
+     * This also works for properties that are declared protected or private.
      *
      * @param object|string $objectUnderTest The object or class on which to check the property value.
-     * @param string        $attributeName   The name of the property to check.
+     * @param string        $propertyName    The name of the property to check.
      *
      * @return mixed Property value.
      *
      * @throws \Exception
      */
-    public static function getObjectAttributeValue($objectUnderTest, $attributeName)
+    public static function getObjectPropertyValue($objectUnderTest, $propertyName)
     {
         $reflector = new ReflectionObject($objectUnderTest);
 
         do {
             try {
-                $attribute = $reflector->getProperty($attributeName);
+                $property = $reflector->getProperty($propertyName);
 
-                if (!$attribute || $attribute->isPublic()) {
-                    return $objectUnderTest->$attributeName;
+                if (!$property || $property->isPublic()) {
+                    return $objectUnderTest->$propertyName;
                 }
 
-                $attribute->setAccessible(true);
-                $value = $attribute->getValue($objectUnderTest);
-                $attribute->setAccessible(false);
+                $property->setAccessible(true);
+                $value = $property->getValue($objectUnderTest);
+                $property->setAccessible(false);
 
                 return $value;
             } catch (ReflectionException $e) {
@@ -88,8 +89,8 @@ public static function getObjectAttributeValue($objectUnderTest, $attributeName)
 
         throw new Exception(
             \sprintf(
-                'Attribute "%s" not found in object.',
-                $attributeName
+                'Property "%s" not found in object.',
+                $propertyName
             )
         );
     }

diff --git a/Tests/PolyfilledTestCase.php b/Tests/PolyfilledTestCase.php
@@ -13,7 +13,7 @@
 
 namespace PHPCSUtils\Tests;
 
-use PHPCSUtils\Tests\AssertAttributeSame;
+use PHPCSUtils\Tests\AssertPropertySame;
 use PHPCSUtils\Tests\ExpectWithConsecutiveArgs;
 use PHPCSUtils\TestUtils\UtilityMethodTestCase;
 use Yoast\PHPUnitPolyfills\Autoload;
@@ -54,7 +54,7 @@
     abstract class PolyfilledTestCase extends UtilityMethodTestCase
     {
         // PHPCSUtils native helpers.
-        use AssertAttributeSame;
+        use AssertPropertySame;
         use ExpectWithConsecutiveArgs;
 
         // PHPUnit Polyfills.
@@ -91,7 +91,7 @@ abstract class PolyfilledTestCase extends UtilityMethodTestCase
     abstract class PolyfilledTestCase extends UtilityMethodTestCase
     {
         // PHPCSUtils native helper.
-        use AssertAttributeSame;
+        use AssertPropertySame;
         use ExpectWithConsecutiveArgs;
 
         // PHPUnit Polyfills.