<?php

/**
 * The default snap expectation
 */
abstract class Snap_Expectation {
    protected $data;

    /**
     * Constructor which holds internal data
     * @param mixed $data the incoming data
     */
    public function __construct($data = NULL) {
        $this->data = $data;
    }
    
    /**
     * Perform a match, must be overriden in derrived classes
     *
     * @return boolean
     * @author Jakob Heuser <hide@address.com>
     **/
    abstract public function match($statement);
}


/**
 * An anything expectation, will always match
 */
class Snap_Anything_Expectation extends Snap_Expectation {
    public function match($statement) { return TRUE; }
}

/**
 * Snap Object Expectation. Must Pass an instanceof
 */
class Snap_Object_Expectation extends Snap_Expectation {
    public function match($obj) {
        return ($obj instanceof $this->data) ? TRUE : FALSE;
    }
}


/**
 * Basic Equals Expectation. Must pass a == check
 */
class Snap_Equals_Expectation extends Snap_Expectation {

    /**
     * matches an incoming item against the constructor data
     * @param mixed $in the incoming item to match
     * @return bool TRUE if matched
     */
    public function match($in) {
        return ($in == $this->data) ? TRUE : FALSE;
    }
}

/**
 * Basic Not Equals Expectation. Must pass a == check
 */
class Snap_Not_Equals_Expectation extends Snap_Expectation {

    /**
     * matches an incoming item against the constructor data
     * @param mixed $in the incoming item to match
     * @return bool TRUE if matched
     */
    public function match($in) {
        return ($in != $this->data) ? TRUE : FALSE;
    }
}

/**
 * String insensitivity equality must past a strtolower() == check
 **/
class Snap_EqualsInsensitive_Expectation extends Snap_Expectation {
    /**
     * matches an incoming item against the constructor data
     * @param mixed $in the incoming item to match
     * @return bool TRUE if matched
     */
    public function match($in) {
        return (strtolower($in) != strtolower($this->data)) ? TRUE : FALSE;
    }
}

/**
 * Snap Identical Expectation. Must pass a === check
 */
class Snap_Identical_Expectation extends Snap_Expectation {

    /**
     * matches against a strict equals ===
     */
    public function match($in) {
        return ($in === $this->data) ? TRUE : FALSE;
    }
}

/**
 * Snap Identical Expectation. Must pass a === check
 */
class Snap_Not_Identical_Expectation extends Snap_Expectation {

    /**
     * matches against a strict equals ===
     */
    public function match($in) {
        return ($in !== $this->data) ? TRUE : FALSE;
    }
}


/**
 * A regular expression expectation. Must pass a preg_match
 */
class Snap_Regex_Expectation extends Snap_Expectation {

    /**
     * Matches against the regex
     * @see Snap_Expectation::match()
     */
    public function match($statement) {
        return (preg_match($this->data, $statement)) ? TRUE : FALSE;
    }
}