Initial work on assertSameSize() and assertNotSameSize().

Author: sebastianbergmann

ChangeLog.markdown

@@ -6,7 +6,8 @@ This is the list of changes for the PHPUnit 3.6 release series.
 PHPUnit 3.6.0
 -------------
 
-* Added `assertCount()` and `assertNotCount()` to assert the number of elements in an array as well as `Countable` or `Iterator` objects.
+* Added `assertCount()` and `assertNotCount()` to assert the number of elements in an array (or `Countable` or `Iterator` objects).
+* Added `assertSameSize()` and `assertNotSameSize()` to assert that the size of two arrays (or `Countable` or `Iterator` objects) is the same.
 * Added `returnSelf()` to ease the mocking and stubbing of fluent interfaces.
 * Added an option to disable the check for object identity in `assertContains()` and related methods.
 * Implemented GH-63: Invalid `@covers` annotations should produce a test error instead of aborting PHPUnit.

PHPUnit/Autoload.php

@@ -100,6 +100,7 @@ function phpunit_autoload($class = NULL) {
           'phpunit_framework_constraint_objecthasattribute' => '/Framework/Constraint/ObjectHasAttribute.php',
           'phpunit_framework_constraint_or' => '/Framework/Constraint/Or.php',
           'phpunit_framework_constraint_pcrematch' => '/Framework/Constraint/PCREMatch.php',
+          'phpunit_framework_constraint_samesize' => '/Framework/Constraint/SameSize.php',
           'phpunit_framework_constraint_stringcontains' => '/Framework/Constraint/StringContains.php',
           'phpunit_framework_constraint_stringendswith' => '/Framework/Constraint/StringEndsWith.php',
           'phpunit_framework_constraint_stringmatches' => '/Framework/Constraint/StringMatches.php',

PHPUnit/Framework/Assert.php

@@ -1301,6 +1301,64 @@ public static function assertNotRegExp($pattern, $string, $message = '')
         self::assertThat($string, $constraint, $message);
     }
 
+    /**
+     * Assert that the size of two arrays (or `Countable` or `Iterator` objects)
+     * is the same.
+     *
+     * @param integer $expected
+     * @param mixed   $actual
+     * @param string  $message
+     */
+    public function assertSameSize($expected, $actual, $message = '')
+    {
+        if (!$expected instanceof Countable &&
+            !$expected instanceof Iterator &&
+            !is_array($expected)) {
+            throw PHPUnit_Util_InvalidArgumentHelper::factory(1, 'countable');
+        }
+
+        if (!$actual instanceof Countable &&
+            !$actual instanceof Iterator &&
+            !is_array($actual)) {
+            throw PHPUnit_Util_InvalidArgumentHelper::factory(2, 'countable');
+        }
+
+        self::assertThat(
+          $actual,
+          new PHPUnit_Framework_Constraint_SameSize($expected),
+          $message
+        );
+    }
+
+    /**
+     * Assert that the size of two arrays (or `Countable` or `Iterator` objects)
+     * is not the same.
+     *
+     * @param integer $expected
+     * @param mixed   $actual
+     * @param string  $message
+     */
+    public function assertNotSameSize($expectedCount, $haystack, $message = '')
+    {
+        if (!$expected instanceof Countable &&
+            !$expected instanceof Iterator &&
+            !is_array($expected)) {
+            throw PHPUnit_Util_InvalidArgumentHelper::factory(1, 'countable');
+        }
+
+        if (!$actual instanceof Countable &&
+            !$actual instanceof Iterator &&
+            !is_array($actual)) {
+            throw PHPUnit_Util_InvalidArgumentHelper::factory(2, 'countable');
+        }
+
+        $constraint = new PHPUnit_Framework_Constraint_Not(
+          new PHPUnit_Framework_Constraint_SameSize($expected)
+        );
+
+        self::assertThat($actual, $constraint, $message);
+    }
+
     /**
      * Asserts that a string matches a given format string.
      *

PHPUnit/Framework/Assert/Functions.php

@@ -789,6 +789,19 @@ function assertNotSame($expected, $actual, $message = '')
     return PHPUnit_Framework_Assert::assertNotSame($expected, $actual, $message);
 }
 
+/**
+ * Assert that the size of two arrays (or `Countable` or `Iterator` objects)
+ * is not the same.
+ *
+ * @param integer $expected
+ * @param mixed   $actual
+ * @param string  $message
+ */
+function assertNotSameSize($expectedCount, $haystack, $message = '')
+{
+    return PHPUnit_Framework_Assert::assertNotSameSize($expectedCount, $haystack, $message);
+}
+
 /**
  * This assertion is the exact opposite of assertTag().
  *
@@ -871,6 +884,19 @@ function assertSame($expected, $actual, $message = '')
     return PHPUnit_Framework_Assert::assertSame($expected, $actual, $message);
 }
 
+/**
+ * Assert that the size of two arrays (or `Countable` or `Iterator` objects)
+ * is the same.
+ *
+ * @param integer $expected
+ * @param mixed   $actual
+ * @param string  $message
+ */
+function assertSameSize($expected, $actual, $message = '')
+{
+    return PHPUnit_Framework_Assert::assertSameSize($expected, $actual, $message);
+}
+
 /**
  * Assert the presence, absence, or count of elements in a document matching
  * the CSS $selector, regardless of the contents of those elements.

PHPUnit/Framework/Constraint/Count.php

@@ -106,7 +106,7 @@ protected function getCountOf($other)
     protected function failureDescription($other, $description, $not)
     {
         return sprintf(
-          'Count of %d does not match expected count of %d.',
+          'Actual size %d does not match expected size %d.',
           $this->getCountOf($other),
           $this->expectedCount
         );

PHPUnit/Framework/Constraint/SameSize.php

@@ -0,0 +1,72 @@
+<?php
+/**
+ * PHPUnit
+ *
+ * Copyright (c) 2002-2011, Sebastian Bergmann <[email protected]>.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ *   * Redistributions of source code must retain the above copyright
+ *     notice, this list of conditions and the following disclaimer.
+ *
+ *   * Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in
+ *     the documentation and/or other materials provided with the
+ *     distribution.
+ *
+ *   * Neither the name of Sebastian Bergmann nor the names of his
+ *     contributors may be used to endorse or promote products derived
+ *     from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ * @package    PHPUnit
+ * @subpackage Framework_Constraint
+ * @author     Sebastian Bergmann <[email protected]>
+ * @copyright  2002-2011 Sebastian Bergmann <[email protected]>
+ * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
+ * @link       http://www.phpunit.de/
+ * @since      File available since Release 3.6.0
+ */
+
+/**
+ *
+ *
+ * @package    PHPUnit
+ * @subpackage Framework_Constraint
+ * @author     Sebastian Bergmann <[email protected]>
+ * @copyright  2002-2011 Sebastian Bergmann <[email protected]>
+ * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
+ * @version    Release: @package_version@
+ * @link       http://www.phpunit.de/
+ * @since      Class available since Release 3.6.0
+ */
+class PHPUnit_Framework_Constraint_SameSize extends PHPUnit_Framework_Constraint_Count
+{
+    /**
+     * @var integer
+     */
+    protected $expectedCount;
+
+    /**
+     * @param integer $expected
+     */
+    public function __construct($expected)
+    {
+        $this->expectedCount = $this->getCountOf($expected);
+    }
+}

Tests/Framework/AssertTest.php

@@ -4207,7 +4207,7 @@ public function testAssertCount()
         }
 
         catch (PHPUnit_Framework_AssertionFailedError $e) {
-            $this->assertEquals('Count of 3 does not match expected count of 2.', $e->getMessage());
+            $this->assertEquals('Actual size 3 does not match expected size 2.', $e->getMessage());
 
             return;
         }

Tests/Framework/ConstraintTest.php

@@ -2529,7 +2529,7 @@ public function testConstraintCountFailing()
 
         catch (PHPUnit_Framework_ExpectationFailedException $e) {
             $this->assertEquals(
-              'Count of 2 does not match expected count of 5.',
+              'Actual size 2 does not match expected size 5.',
               $e->getDescription()
             );
 

package.xml

@@ -163,6 +163,9 @@
       <file baseinstalldir="/" name="PCREMatch.php" role="php">
        <tasks:replace from="@package_version@" to="version" type="package-info" />
       </file>
+      <file baseinstalldir="/" name="SameSize.php" role="php">
+       <tasks:replace from="@package_version@" to="version" type="package-info" />
+      </file>
       <file baseinstalldir="/" name="StringContains.php" role="php">
        <tasks:replace from="@package_version@" to="version" type="package-info" />
       </file>