Verify 2.1

* Added new expect-toBe and expect-notTo BDD Syntax.

Author: TavoNiievez

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 2.1
+
+* Added new expect-toBe and expect-notTo BDD Syntax.
+* Added full documentation about Expectations.
+* Fixed minor bugs.
+* Deleted RoboFile and VERSION file.
+* **BC:** `expect` function now works with expectations instead of verifiers.
+
 ## 2.0
 
 * Support for Chained Verifiers.

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2013-2015 Codeception PHP Testing Framework
+Copyright (c) 2013-2020 Codeception PHP Testing Framework
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

README.md

@@ -83,11 +83,19 @@ Verify::Callable($callback)
 
 ## Alternative Syntax
 
-If you follow TDD/BDD you'd rather use `expect` or `verify_that` instead of `verify`. Which are just an alias function:
+If you follow TDD/BDD you'd rather use `expect` instead of `verify`:
 
 ```php
-expect($user->getNumPosts())->equals(5, 'user have 5 posts');
+expect($user->getNumPosts())
+    ->notToBeNull()
+    ->toBeInt()
+    ->toEqual(5, 'user have 5 posts');
+```
+> :page_facing_up: **See Expectations full list [here.][7]**
+>
+Or `verify_that` which is just an alias function:
 
+```php
 verify_that($user->getRate())->equals(7, 'first user rate is 7');
 ```
 
@@ -117,7 +125,7 @@ class MyVerify extends Verify {
 ```
 
 And use it!
-  
+
 ```php
 $myVerify = new MyVerify;
 

RoboFile.php

@@ -0,0 +1,182 @@
+## Expectations List
+
+`expect()` supports all the expectations listed here! :rocket:
+
+### Array
+```
+notToContain
+notToContainEqual
+notToContainOnly
+notToHaveCount
+notToHaveKey
+notToHaveSameSizeAs
+toContain
+toContainEqual
+toContainOnly
+toContainOnlyInstancesOf
+toHaveCount
+toHaveKey
+toHaveSameSizeAs
+```
+
+### BaseObject
+```
+notToHaveAttribute
+toHaveAttribute
+```
+
+### Callable
+```
+notToThrow
+toThrow
+```
+
+### Class
+```
+notToHaveAttribute
+notToHaveStaticAttribute
+toHaveAttribute
+toHaveStaticAttribute
+```
+
+### Directory
+```
+notToBeReadable
+notToBeWritable
+notToExist
+toBeReadable
+toBeWritable
+toExist
+toExistAndNotToBeReadable
+toExistAndNotToBeWritable
+toExistAndToBeReadable
+toExistAndToBeWritable
+```
+
+### File
+```
+notToBeReadable
+notToBeWritable
+notToExist
+toBeEqual
+toBeEqualCanonicalizing
+toBeEqualIgnoringCase
+toBeReadable
+toBeWritable
+toExist
+toExistAndNotToBeReadable
+toExistAndNotToBeWritable
+toExistAndToBeReadable
+toExistAndToBeWritable
+toNotEqual
+toNotEqualCanonicalizing
+toNotEqualIgnoringCase
+```
+
+### JsonFile
+```
+notToEqualJsonFile
+toEqualJsonFile
+```
+
+### JsonString
+```
+notToEqualJsonFile
+notToEqualJsonString
+toEqualJsonFile
+toEqualJsonString
+```
+
+### Mixed
+```
+notToBe
+notToBeArray
+notToBeBool
+notToBeCallable
+notToBeClosedResource
+notToBeEmpty
+notToBeFalse
+notToBeFloat
+notToBeInstanceOf
+notToBeInt
+notToBeIterable
+notToBeNull
+notToBeNumeric
+notToBeObject
+notToBeResource
+notToBeScalar
+notToBeString
+notToBeTrue
+notToEqual
+notToEqualCanonicalizing
+notToEqualIgnoringCase
+notToEqualWithDelta
+toBe
+toBeArray
+toBeBool
+toBeCallable
+toBeClosedResource
+toBeEmpty
+toBeFalse
+toBeFinite
+toBeFloat
+toBeGreaterThan
+toBeGreaterThanOrEqualTo
+toBeInfinite
+toBeInstanceOf
+toBeInt
+toBeIterable
+toBeLessThan
+toBeLessThanOrEqualTo
+toBeNan
+toBeNull
+toBeNumeric
+toBeObject
+toBeResource
+toBeScalar
+toBeString
+toBeTrue
+toEqual
+toEqualCanonicalizing
+toEqualIgnoringCase
+toEqualWithDelta
+```
+
+### String
+```
+notToContainString
+notToContainStringIgnoringCase
+notToEndWith
+notToEqualFile
+notToEqualFileCanonicalizing
+notToEqualFileIgnoringCase
+notToMatchFormat
+notToMatchFormatFile
+notToMatchRegExp
+notToStartWith
+toBeJson
+toContainString
+toContainStringIgnoringCase
+toEndWith
+toEqualFile
+toEqualFileCanonicalizing
+toEqualFileIgnoringCase
+toMatchFormat
+toMatchFormatFile
+toMatchRegExp
+toStartWith
+```
+
+### XmlFile
+```
+notToEqualXmlFile
+toEqualXmlFile
+```
+
+### XmlString
+```
+notToEqualXmlFile
+notToEqualXmlString
+toEqualXmlFile
+toEqualXmlString
+```

VERSION

@@ -43,6 +43,10 @@ notHasStaticAttribute
 ```
 doesNotExist
 exists
+existsAndIsNotReadable
+existsAndIsNotWritable
+existsAndIsReadable
+existsAndIsWritable
 isNotReadable
 isNotWritable
 isReadable
@@ -56,6 +60,10 @@ equals
 equalsCanonicalizing
 equalsIgnoringCase
 exists
+existsAndIsNotReadable
+existsAndIsNotWritable
+existsAndIsReadable
+existsAndIsWritable
 isNotReadable
 isNotWritable
 isReadable
@@ -131,7 +139,6 @@ notSame
 notTrue
 null
 same
-that
 true
 ```
 

docs/supported_expectations.md

@@ -0,0 +1,75 @@
+<?php declare(strict_types=1);
+
+namespace Codeception\Verify\Asserts;
+
+use Exception;
+use PHPUnit\Framework\Assert;
+use PHPUnit\Framework\ExpectationFailedException;
+use Throwable;
+
+trait AssertThrows
+{
+    public function assertThrows($throws = null, $message = false): self
+    {
+        if ($throws instanceof Exception) {
+            $message = $throws->getMessage();
+            $throws = get_class($throws);
+        }
+
+        try {
+            call_user_func($this->actual);
+        } catch (Throwable $exception) {
+            if (!$throws) {
+                return $this; // it throws
+            }
+
+            $actualThrows = get_class($exception);
+            $actualMessage = $exception->getMessage();
+
+            Assert::assertSame($throws, $actualThrows, sprintf('exception \'%s\' was expected, but \'%s\' was thrown', $throws, $actualThrows));
+
+            if ($message) {
+                Assert::assertSame($message, $actualMessage, sprintf('exception message \'%s\' was expected, but \'%s\' was received', $message, $actualMessage));
+            }
+        }
+
+        if (!isset($exception)) {
+            throw new ExpectationFailedException(sprintf('exception \'%s\' was not thrown as expected', $throws));
+        }
+
+        return $this;
+    }
+
+    public function assertDoesNotThrow($throws = null, $message = false): self
+    {
+        if ($throws instanceof Exception) {
+            $message = $throws->getMessage();
+            $throws = get_class($throws);
+        }
+
+        try {
+            call_user_func($this->actual);
+        } catch (Throwable $exception) {
+            if (!$throws) {
+                throw new ExpectationFailedException('exception was not expected to be thrown');
+            }
+
+            $actualThrows = get_class($exception);
+            $actualMessage = $exception->getMessage();
+
+            if ($throws !== $actualThrows) {
+                return $this;
+            }
+
+            if (!$message) {
+                throw new ExpectationFailedException(sprintf('exception \'%s\' was not expected to be thrown', $throws));
+            }
+
+            if ($message === $actualMessage) {
+                throw new ExpectationFailedException(sprintf('exception \'%s\' with message \'%s\' was not expected to be thrown', $throws, $message));
+            }
+        }
+
+        return $this;
+    }
+}