Merge pull request #26 from sirbrillig/add/readable-special-matchers

Add readable special matchers

src/Spies/AnyValue.php

@@ -3,4 +3,8 @@
 
 class AnyValue {
 	public $value = 'ANYTHING';
+
+	public function __toString() {
+		return 'AnyValue';
+	}
 }

src/Spies/ArgumentFormatter.php

@@ -16,6 +16,12 @@ public function __toString() {
 	}
 
 	private function get_args_as_array() {
-		return implode( ', ', array_map( 'json_encode', $this->args ) );
+		$stringify_argument = function ( $argument ) {
+			if ( method_exists( $argument, '__toString' ) ) {
+				return $argument->__toString();
+			}
+			return json_encode( $argument );
+		};
+		return implode( ', ', array_map( $stringify_argument, $this->args ) );
 	}
 }

src/Spies/MatchArray.php

@@ -34,5 +34,9 @@ private function is_associative( $arr ) {
 		}
 		return array_keys( $arr ) !== range( 0, count( $arr ) - 1 );
 	}
+
+	public function __toString() {
+		return 'MatchArray(' . json_encode( $this->expected_array ) . ')';
+	}
 }
 

src/Spies/MatchPattern.php

@@ -16,6 +16,8 @@ public function is_match( $actual ) {
 		}
 		return false;
 	}
-}
-
 
+	public function __toString() {
+		return "MatchPattern('{$this->expected_pattern}')";
+	}
+}

tests/ExpectationTest.php

@@ -286,6 +286,13 @@ public function test__with__and__match_pattern__is_not_met_if_the_spy_is_called_
 		$this->assertFalse( $expectation->met_expectations() );
 	}
 
+	public function test__match_pattern__reports_fail_message_on_fail() {
+		$spy = \Spies\make_spy();
+		$expectation = \Spies\expect_spy( $spy )->to_have_been_called->with( 'foo', \Spies\match_pattern( '/Bart/i' ) );
+		$spy( 'foo', 'slartiblargfast' );
+		$this->assertContains( 'Failed asserting that a spy is called with arguments: ( "foo", MatchPattern(\'/Bart/i\') )', $expectation->get_fail_message() );
+	}
+
 	public function test__with__and__match_array__is_met_if_the_spy_is_called_with_matching_key_values() {
 		$spy = \Spies\make_spy();
 		$expectation = \Spies\expect_spy( $spy )->to_have_been_called->with( 'foo', \Spies\match_array( [ 'foo' => 'bar', 'flim' => 'flam' ] ) );
@@ -335,13 +342,27 @@ public function test__with__and__match_array__is_not_met_if_the_spy_is_called_wi
 		$this->assertFalse( $expectation->met_expectations() );
 	}
 
+	public function test__match_array__reports_fail_message_on_fail() {
+		$spy = \Spies\make_spy();
+		$expectation = \Spies\expect_spy( $spy )->to_have_been_called->with( 'foo', \Spies\match_array( [ 'flim' => 'flam' ] ) );
+		$spy( 'foo', [ 'bar' => 'baz', 'foo' => 'bar' ] );
+		$this->assertContains( 'Failed asserting that a spy is called with arguments: ( "foo", MatchArray({"flim":"flam"}) )', $expectation->get_fail_message() );
+	}
+
 	public function test__with__and__any__is_met_if_the_spy_is_called_with_any_arguments() {
 		$spy = \Spies\make_spy();
 		$expectation = \Spies\expect_spy( $spy )->to_have_been_called->with( 'foo', \Spies\any() );
 		$spy( 'foo', 'bar' );
 		$this->assertTrue( $expectation->met_expectations() );
 	}
 
+	public function test__any__reports_fail_message_on_fail() {
+		$spy = \Spies\make_spy();
+		$expectation = \Spies\expect_spy( $spy )->to_have_been_called->with( 'foo', \Spies\any() );
+		$spy( 'bar' );
+		$this->assertContains( 'Failed asserting that a spy is called with arguments: ( "foo", AnyValue )', $expectation->get_fail_message() );
+	}
+
 	public function test__with__is_not_met_if_the_spy_is_called_with_no_arguments() {
 		$spy = \Spies\make_spy();
 		$expectation = \Spies\expect_spy( $spy )->to_have_been_called->with( 'foo', 'bar' );