Source for file Assert.php

<?php
//
// +------------------------------------------------------------------------+
// | PEAR :: PHPUnit                                                        |
// +------------------------------------------------------------------------+
// | Copyright (c) 2002-2003 Sebastian Bergmann <sb@sebastian-bergmann.de>. |
// +------------------------------------------------------------------------+
// | This source file is subject to version 3.00 of the PHP License,        |
// | that is available at http://www.php.net/license/3_0.txt.               |
// | If you did not receive a copy of the PHP license and are unable to     |
// | obtain it through the world-wide-web, please send a note to            |
// | license@php.net so we can mail you a copy immediately.                 |
// +------------------------------------------------------------------------+
//
// $Id: Assert.php,v 1.22 2004/12/21 18:25:14 sebastian Exp $
//
 
/**
 * A set of assert methods.
 *
 * @author      Sebastian Bergmann <sb@sebastian-bergmann.de>
 * @copyright   Copyright &copy; 2002-2004 Sebastian Bergmann <sb@sebastian-bergmann.de>
 * @license     http://www.php.net/license/3_0.txt The PHP License, Version 3.0
 * @category    Testing
 * @package     PHPUnit
 */
class PHPUnit_Assert {
    /**
    * @var    boolean 
    * @access private
    */
    var $_looselyTyped = FALSE;
 
    /**
    * Asserts that a haystack contains a needle.
    *
    * @param  mixed 
    * @param  mixed 
    * @param  string 
    * @access public
    * @since  1.1.0
    */
    function assertContains($needle, $haystack, $message = '') {
        if (is_string($needle) && is_string($haystack)) {
            $this->assertTrue(strpos($haystack, $needle) !== FALSE ? TRUE : FALSE);
        }
 
        else if (is_array($haystack) && !is_object($needle)) {
            $this->assertTrue(in_array($needle, $haystack), $message);
        }
 
        else {
            $this->fail('Unsupported parameter passed to assertContains().');
        }
    }
 
    /**
    * Asserts that a haystack does not contain a needle.
    *
    * @param  mixed 
    * @param  mixed 
    * @param  string 
    * @access public
    * @since  1.1.0
    */
    function assertNotContains($needle, $haystack, $message = '') {
        if (is_string($needle) && is_string($haystack)) {
            $this->assertFalse(strpos($haystack, $needle) !== FALSE ? TRUE : FALSE);
        }
 
        else if (is_array($haystack) && !is_object($needle)) {
            $this->assertFalse(in_array($needle, $haystack), $message);
        }
 
        else {
            $this->fail('Unsupported parameter passed to assertNotContains().');
        }
    }
 
    /**
    * Asserts that two variables are equal.
    *
    * @param  mixed 
    * @param  mixed 
    * @param  string 
    * @param  mixed 
    * @access public
    */
    function assertEquals($expected, $actual, $message = '', $delta = 0) {
        if ((is_array($actual)  && is_array($expected)) ||
            (is_object($actual) && is_object($expected))) {
            if (is_array($actual) && is_array($expected)) {
                ksort($actual);
                ksort($expected);
            }
 
            if ($this->_looselyTyped) {
                $actual   = $this->_convertToString($actual);
                $expected = $this->_convertToString($expected);
            }
 
            $actual   = serialize($actual);
            $expected = serialize($expected);
 
            $message = sprintf(
              '%sexpected %s, actual %s',
 
              !empty($message) ? $message . ' ' : '',
              $expected,
              $actual
            );
 
            if ($actual !== $expected) {
                return $this->fail($message);
            }
        }
 
        elseif (is_numeric($actual) && is_numeric($expected)) {
            $message = sprintf(
              '%sexpected %s%s, actual %s',
 
              !empty($message) ? $message . ' ' : '',
              $expected,
              ($delta != 0) ? ('+/- ' . $delta) : '',
              $actual
            );
 
            if (!($actual >= ($expected - $delta) && $actual <= ($expected + $delta))) {
                return $this->fail($message);
            }
        }
 
        else {
            $message = sprintf(
              '%sexpected %s, actual %s',
 
              !empty($message) ? $message . ' ' : '',
              $expected,
              $actual
            );
 
            if ($actual !== $expected) {
                return $this->fail($message);
            }
        }
    }
 
    /**
    * Asserts that two variables reference the same object.
    * This requires the Zend Engine 2 to work.
    *
    * @param  object 
    * @param  object 
    * @param  string 
    * @access public
    * @deprecated
    */
    function assertSame($expected, $actual, $message = '') {
        if (!version_compare(phpversion(), '5.0.0', '>=')) {
            $this->fail('assertSame() only works with PHP >= 5.0.0.');
        }
 
        if ((is_object($expected) || is_null($expected)) &&
            (is_object($actual)   || is_null($actual))) {
            $message = sprintf(
              '%sexpected two variables to reference the same object',
 
              !empty($message) ? $message . ' ' : ''
            );
 
            if ($expected !== $actual) {
                return $this->fail($message);
            }
        } else {
            $this->fail('Unsupported parameter passed to assertSame().');
        }
    }
 
    /**
    * Asserts that two variables do not reference the same object.
    * This requires the Zend Engine 2 to work.
    *
    * @param  object 
    * @param  object 
    * @param  string 
    * @access public
    * @deprecated
    */
    function assertNotSame($expected, $actual, $message = '') {
        if (!version_compare(phpversion(), '5.0.0', '>=')) {
            $this->fail('assertNotSame() only works with PHP >= 5.0.0.');
        }
 
        if ((is_object($expected) || is_null($expected)) &&
            (is_object($actual)   || is_null($actual))) {
            $message = sprintf(
              '%sexpected two variables to reference different objects',
 
              !empty($message) ? $message . ' ' : ''
            );
 
            if ($expected === $actual) {
                return $this->fail($message);
            }
        } else {
            $this->fail('Unsupported parameter passed to assertNotSame().');
        }
    }
 
    /**
    * Asserts that an object isn't null.
    *
    * @param  object 
    * @param  string 
    * @access public
    */
    function assertNotNull($object, $message = '') {
        if (is_object($object) || is_null($object)) {
            $message = sprintf(
              '%sexpected NOT NULL, actual NULL',
 
              !empty($message) ? $message . ' ' : ''
            );
 
            if (is_null($object)) {
                return $this->fail($message);
            }
        } else {
            $this->fail('Unsupported parameter passed to assertNotNull().');
        }
    }
 
    /**
    * Asserts that an object is null.
    *
    * @param  object 
    * @param  string 
    * @access public
    */
    function assertNull($object, $message = '') {
        if (is_object($object) || is_null($object)) {
            $message = sprintf(
              '%sexpected NULL, actual NOT NULL',
 
              !empty($message) ? $message . ' ' : ''
            );
 
            if (!is_null($object)) {
                return $this->fail($message);
            }
        } else {
            $this->fail('Unsupported parameter passed to assertNotNull().');
        }
    }
 
    /**
    * Asserts that a condition is true.
    *
    * @param  boolean 
    * @param  string 
    * @access public
    */
    function assertTrue($condition, $message = '') {
        $message = sprintf(
          '%sexpected TRUE, actual FALSE',
 
          !empty($message) ? $message . ' ' : ''
        );
 
        if (!$condition) {
            return $this->fail($message);
        }
    }
 
    /**
    * Asserts that a condition is false.
    *
    * @param  boolean 
    * @param  string 
    * @access public
    */
    function assertFalse($condition, $message = '') {
        $message = sprintf(
          '%sexpected FALSE, actual TRUE',
 
          !empty($message) ? $message . ' ' : ''
        );
 
        if ($condition) {
            return $this->fail($message);
        }
    }
 
    /**
    * Asserts that a string matches a given regular expression.
    *
    * @param  string 
    * @param  string 
    * @param  string 
    * @access public
    */
    function assertRegExp($pattern, $string, $message = '') {
        $message = sprintf(
          '%s"%s" does not match pattern "%s"',
 
          !empty($message) ? $message . ' ' : '',
          $string,
          $pattern
        );
 
        if (!preg_match($pattern, $string)) {
            return $this->fail($message);
        }
    }
 
    /**
    * Asserts that a string does not match a given regular expression.
    *
    * @param  string 
    * @param  string 
    * @param  string 
    * @access public
    * @since  1.1.0
    */
    function assertNotRegExp($pattern, $string, $message = '') {
        $message = sprintf(
          '%s"%s" matches pattern "%s"',
 
          !empty($message) ? $message . ' ' : '',
          $string,
          $pattern
        );
 
        if (preg_match($pattern, $string)) {
            return $this->fail($message);
        }
    }
 
    /**
    * Asserts that a variable is of a given type.
    *
    * @param  string          $expected 
    * @param  mixed           $actual 
    * @param  optional string $message
    * @access public
    */
    function assertType($expected, $actual, $message = '') {
        return $this->assertEquals(
          $expected,
          gettype($actual),
          $message
        );
    }
 
    /**
    * Converts a value to a string.
    *
    * @param  mixed   $value 
    * @access private
    */
    function _convertToString($value) {
        foreach ($value as $k => $v) {
            if (is_array($v)) {
                $value[$k] = $this->_convertToString($value[$k]);
            } else {
                settype($value[$k], 'string');
            }
        }
 
        return $value;
    }
 
    /**
    * @param  boolean $looselyTyped 
    * @access public
    */
    function setLooselyTyped($looselyTyped) {
        if (is_bool($looselyTyped)) {
            $this->_looselyTyped = $looselyTyped;
        }
    }
 
    /**
    * Fails a test with the given message.
    *
    * @param  string 
    * @access protected
    * @abstract
    */
    function fail($message = '') { /* abstract */ }
}
?>