auto updated documentation

DavertMik · DavertMik · commit e3376fdd8607 · 2016-03-12T03:29:08.000+02:00
diff --git a/changelog.markdown b/changelog.markdown
@@ -7,6 +7,25 @@ title: Codeception Changelog
 
 # Changelog
 
+#### 2.1.7
+
+* **PHPUnit 5.x support**
+* Global Bootstrap, Suite Bootstrap, Module Initialization happens before test loading. Fixes issues of autoloading TestCase classes introduced in 2.1.5, see <a href="https://github.com/Codeception/Codeception/issues/2872">#2872</a>
+* Added option to skip PHP files validation in `codeception.yml` - `settings: lint: false`
+* <strong>[Facebook]</strong> Updated to  facebook/php-sdk-v4 version 5 by <strong><a href="https://github.com/orhan">@orhan</a></strong>-swe and <strong><a href="https://github.com/tigerseo">@tigerseo</a></strong> <a href="https://github.com/Codeception/Codeception/issues/2828">#2828</a> <a href="https://github.com/Codeception/Codeception/issues/2415">#2415</a>
+* <strong>[WebDriver]</strong> Added `scrollTo` action by <strong><a href="https://github.com/javigomez">@javigomez</a></strong> and <strong><a href="https://github.com/davertmik">@davertmik</a></strong> <a href="https://github.com/Codeception/Codeception/issues/2844">#2844</a>
+* Fix encoding problems in PHP prior to 5.6 by <strong><a href="https://github.com/pejaycz">@pejaycz</a></strong>. See <a href="https://github.com/Codeception/Codeception/issues/2831">#2831</a>
+* <strong>[Queue]</strong> Fixed `clearQueue` for AmazonSQS by <strong><a href="https://github.com/mikitu">@mikitu</a></strong> <a href="https://github.com/Codeception/Codeception/issues/2805">#2805</a>
+* <strong>[Db]</strong> Fixed loading files in Sqlite <strong><a href="https://github.com/mcustiel">@mcustiel</a></strong> See <a href="https://github.com/Codeception/Codeception/issues/2812">#2812</a>
+* <strong>[PhpBrowser]</strong> `amHttpAuthenticated` allows null, null as parameters to unset authentication. <a href="https://github.com/Codeception/Codeception/issues/2896">#2896</a>
+* `Util\Locator` added `contains` method to easily locate any element containing a text.
+* <strong>[Laravel5]</strong> Added `guard` parameters to `seeAuthentication` and `dontSeeAuthentication` methods. By <strong><a href="https://github.com/janhenkgerritsen">@janhenkgerritsen</a></strong>. See <a href="https://github.com/Codeception/Codeception/issues/2876">#2876</a>
+* <strong>[Laravel5]</strong> Added functionality to disable/enable Laravel's exception handling. By <strong><a href="https://github.com/janhenkgerritsen">@janhenkgerritsen</a></strong>. See <a href="https://github.com/Codeception/Codeception/issues/2763">#2763</a>
+* <strong>[Laravel5]</strong> Authentication now persists between requests when calling `amLoggedAs` with an instance of `Authenticable`. See <a href="https://github.com/Codeception/Codeception/issues/2795">#2795</a>
+* <strong>[REST]</strong> Fixed dontSeeXmlResponseMatchesXpath method <a href="https://github.com/Codeception/Codeception/issues/2825">#2825</a> by <strong><a href="https://github.com/mangust404">@mangust404</a></strong>
+* <strong>[ZF2]</strong> Fixed POST parameters <a href="https://github.com/Codeception/Codeception/issues/2814">#2814</a> by <strong><a href="https://github.com/Naktibalda">@Naktibalda</a></strong>
+* <strong>[ZF1]</strong> Call Zend_Registry::_unsetInstance in _after <a href="https://github.com/Codeception/Codeception/issues/2863">#2863</a> by <strong><a href="https://github.com/Naktibalda">@Naktibalda</a></strong>
+
 #### 2.1.6
 
 * Starting from 2.1.6 you can **download PHP 5.4 compatible phar build** at http://codeception.com/php54/codecept.phar by <strong><a href="https://github.com/Naktibalda">@Naktibalda</a></strong>. See [installation guide](http://codeception.com/install).
@@ -29,8 +48,6 @@ title: Codeception Changelog
 * <strong>[REST]</strong> Added methods to control redirect: `stopFollowingRedirects` and `startFollowingRedirects` by <strong><a href="https://github.com/brutuscat">@brutuscat</a></strong>
 * [Recorder Extension] Added `animate_slides` config to disable left-right sliding animation between screenshots by <strong><a href="https://github.com/vml">@vml</a></strong>-rmott
 
-
-
 #### 2.1.5
 
 * **PHP7 support**
@@ -61,7 +78,6 @@ title: Codeception Changelog
 * <strong>[PhpBrowser]</strong> Set curl options for Guzzle6 correctly. See <a href="https://github.com/Codeception/Codeception/issues/2533">#2533</a>. By <strong><a href="https://github.com/Naktibalda">@Naktibalda</a></strong>
 * Fixed usage of GroupObject by unit tests. GroupObjects can skip tests by <strong><a href="https://github.com/davetmik">@davetmik</a></strong>. See <a href="https://github.com/Codeception/Codeception/issues/2617">#2617</a>
 
-
 #### 2.1.4
 
 * <strong>[PhpBrowser]</strong><strong>[Frameworks]</strong> Added `_getResponseContent` hidden method. By <strong><a href="https://github.com/Naktibalda">@Naktibalda</a></strong>
diff --git a/docs/11-Codecoverage.md b/docs/11-Codecoverage.md
@@ -10,7 +10,7 @@ Just for this case the [CodeCoverage](http://en.wikipedia.org/wiki/Code_coverage
 you will receive statistics of all classes, methods, and lines triggered by these tests.
 The ratio between all lines in script and all touched lines is a main coverage criterion. In the ideal world you should get 100% code coverage, but in reality 80% is really enough. Because even 100% code coverage rate doesn't save you from fatal errors and crashes.
 
-**Codeception has CodeCoverage tools since 1.5. To collect coverage information `xdebug` is required**.
+*To collect coverage information `xdebug` is required**.
 
 ![Code Coverage Example](http://codeception.com/images/coverage.png)
 
@@ -19,7 +19,7 @@ or locally but running through web server. It may look hard to collect code cove
 
 ### Configuration
 
-To enable codecoverge put these lines in the global configuration file `codeception.yml`:
+To enable code coverage put these lines in the global configuration file `codeception.yml`:
 
 {% highlight yaml %}
 
@@ -52,6 +52,9 @@ What are whitelists and blacklists?
 * A **whitelist** is a list of files that should be included in report even they were not touched.
 * A **blacklist** is a list of files that should be excluded from report even they were touched.
 
+<div class="alert alert-info">
+The blacklist functionality has been removed from PHPUnit 5, but it can still be used with PHPUnit 4.8.
+</div>
 Pass an array of files or directory to include/exclude sections. The path ending with '\*' matches the directory.
 Also you can use '\*' mask in a file name, i.e. `app/models/*Model.php` to match all models.
 
diff --git a/docs/modules/AMQP.md b/docs/modules/AMQP.md
@@ -49,7 +49,7 @@ To use this module with Composer you need <em>"videlalvaro/php-amqplib": "*"</em
 
 ### Public Properties
 
-* connection - AMQPConnection - current connection
+* connection - AMQPStreamConnection - current connection
 
 @since 1.1.2
 @author tiger.seo@gmail.com
diff --git a/docs/modules/Facebook.md b/docs/modules/Facebook.md
@@ -14,7 +14,7 @@ Provides testing for projects integrated with Facebook API.
 Relies on Facebook's tool Test User API.
 
 <div class="alert alert-info">
-To use this module with Composer you need <em>"facebook/php-sdk": "3.*"</em> package.
+To use this module with Composer you need <em>"facebook/php-sdk4": "5.*"</em> package.
 </div>
 
 ### Status
@@ -135,6 +135,7 @@ Get facebook test user be created.
 #### haveTestUserLoggedInOnFacebook
  
 Get facebook test user be logged in on facebook.
+This is done by going to facebook.com
 
  * `throws`  ModuleConfigException
 
@@ -153,4 +154,12 @@ Please, note that you must have publish_actions permission to be able to publish
 
  * `param string` $placeId Place identifier to be verified against user published posts
 
+
+#### seePostOnFacebookWithMessage
+ 
+
+Please, note that you must have publish_actions permission to be able to publish to user's feed.
+
+ * `param string` $message published post to be verified against the actual post on facebook
+
 <p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/Codeception/tree/2.1/src/Codeception/Module/Facebook.php">Help us to improve documentation. Edit module reference</a></div>
diff --git a/docs/modules/Laravel5.md b/docs/modules/Laravel5.md
@@ -37,6 +37,7 @@ See the Acceptance tests section below for more details.
 * bootstrap: `string`, default `bootstrap/app.php` - Relative path to app.php config file.
 * root: `string`, default `` - Root path of our application.
 * packages: `string`, default `workbench` - Root path of application packages (if any).
+* disable_exception_handling: `boolean`, default `true` - disable Laravel exception handling
 * disable_middleware: `boolean`, default `false` - disable all middleware.
 * disable_events: `boolean`, default `false` - disable all events.
 * url: `string`, default `` - The application URL.
@@ -376,6 +377,19 @@ $I->disableEvents();
 {% endhighlight %}
 
 
+#### disableExceptionHandling
+ 
+Disable Laravel exception handling.
+
+{% highlight php %}
+
+<?php
+$I->disableExceptionHandling();
+?>
+
+{% endhighlight %}
+
+
 #### disableMiddleware
  
 Disable middleware for the next requests.
@@ -423,7 +437,9 @@ For checking the raw source code, use `seeInSource()`.
 
 #### dontSeeAuthentication
  
-Check that user is not authenticated
+Check that user is not authenticated.
+You can specify the guard that should be use for Laravel >= 5.2.
+ * `param string|null` $guard
 
 
 #### dontSeeCheckboxIsChecked
@@ -698,6 +714,19 @@ $I->dontSeeRecord('users', array('name' => 'davert'));
  * `[Part]` orm
 
 
+#### enableExceptionHandling
+ 
+Enable Laravel exception handling.
+
+{% highlight php %}
+
+<?php
+$I->enableExceptionHandling();
+?>
+
+{% endhighlight %}
+
+
 #### fillField
  
 Fills a text field or textarea with the given string.
@@ -969,7 +998,9 @@ For checking the raw source code, use `seeInSource()`.
 
 #### seeAuthentication
  
-Checks that a user is authenticated
+Checks that a user is authenticated.
+You can specify the guard that should be use for Laravel >= 5.2.
+ * `param string|null` $guard
 
 
 #### seeCheckboxIsChecked
diff --git a/docs/modules/Queue.md b/docs/modules/Queue.md
@@ -51,6 +51,22 @@ service.
 * project - Iron.io project ID.
 * key - AWS access key ID.
 * secret - AWS secret access key.
+     Warning:
+         Hard-coding your credentials can be dangerous, because it is easy to accidentally commit your credentials
+         into an SCM repository, potentially exposing your credentials to more people than intended.
+         It can also make it difficult to rotate credentials in the future.
+* profile - AWS credential profile
+          - it should be located in ~/.aws/credentials file
+          - eg:  [default]
+                 aws_access_key_id = YOUR_AWS_ACCESS_KEY_ID
+                 aws_secret_access_key = YOUR_AWS_SECRET_ACCESS_KEY
+                 [project1]
+                 aws_access_key_id = YOUR_AWS_ACCESS_KEY_ID
+                 aws_secret_access_key = YOUR_AWS_SECRET_ACCESS_KEY
+         - Note: Using IAM roles is the preferred technique for providing credentials
+                 to applications running on Amazon EC2
+                 http://docs.aws.amazon.com/aws-sdk-php/v3/guide/guide/credentials.html?highlight=credentials
+
 * region - A region parameter is also required for AWS, refer to the AWS documentation for possible values list.
 
 #### Example
@@ -87,6 +103,25 @@ service.
              'secret' => 'your-secret-key',
              'region' => 'us-west-2'
 
+##### Example AWS SQS using profile credentials
+
+    modules:
+       enabled: [Queue]
+       config:
+          Queue:
+             'type' => 'aws',
+             'profile' => 'project1', //see documentation
+             'region' => 'us-west-2'
+
+##### Example AWS SQS running on Anazon EC2 instance
+
+    modules:
+       enabled: [Queue]
+       config:
+          Queue:
+             'type' => 'aws',
+             'region' => 'us-west-2'
+
 
 
 #### addMessageToQueue
diff --git a/docs/modules/REST.md b/docs/modules/REST.md
@@ -481,7 +481,7 @@ Basic example:
 
 <?php
 // {'user_id': 1, 'name': 'davert', 'is_active': false}
-$I->seeResponseIsJsonType([
+$I->seeResponseMatchesJsonType([
      'user_id' => 'integer',
      'name' => 'string|null',
      'is_active' => 'boolean'
@@ -509,7 +509,7 @@ You can also use nested data type structures:
 
 <?php
 // {'user_id': 1, 'name': 'davert', 'company': {'name': 'Codegyre'}}
-$I->seeResponseIsJsonType([
+$I->seeResponseMatchesJsonType([
      'user_id' => 'integer|string', // multiple types
      'company' => ['name' => 'string']
 ]);
@@ -534,13 +534,13 @@ This is how filters can be used:
 
 <?php
 // {'user_id': 1, 'email' => 'davert * `codeception.com'}` 
-$I->seeResponseIsJsonType([
+$I->seeResponseMatchesJsonType([
      'user_id' => 'string:>0:<1000', // multiple filters can be used
      'email' => 'string:regex(~\ * `~)'`  // we just check that  * ``  char is included
 ]);
 
 // {'user_id': '1'}
-$I->seeResponseIsJsonType([
+$I->seeResponseMatchesJsonType([
      'user_id' => 'string:>0', // works with strings as well
 }
 ?>
@@ -553,6 +553,7 @@ See [JsonType reference](http://codeception.com/docs/reference/JsonType).
  * `[Part]` json
  * `Available since` 2.1.3
  * `param array` $jsonType
+ * `param string` $jsonPath
 
 
 #### seeXmlResponseEquals
diff --git a/docs/modules/WebDriver.md b/docs/modules/WebDriver.md
@@ -1027,6 +1027,24 @@ $I->resizeWindow(800, 600);
  * `param string` $name
 
 
+#### scrollTo
+ 
+Move to the middle of the given element matched by the given locator.
+Extra shift, calculated from the top-left corner of the element, can be set by passing $offsetX and $offsetY parameters.
+
+{% highlight php %}
+
+<?php
+$I->scrollTo(['css' => '.checkout'], 20, 50);
+?>
+
+{% endhighlight %}
+
+ * `param` $selector
+ * `param int` $offsetX
+ * `param int` $offsetY
+
+
 #### see
  
 Checks that the current page contains the given string (case insensitive).
diff --git a/docs/reference/Locator.md b/docs/reference/Locator.md
@@ -50,6 +50,24 @@ As a result the Locator will produce a mixed XPath value that will be used in fi
 
 [See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Locator.php#L45)
 
+#### *public static* contains($element, $text) 
+
+Locates an element containing a text inside.
+Either CSS or XPath locator can be passed, however they will be converted to XPath.
+
+{% highlight php %}
+
+Locator::contains('label', 'Name'); // label containing name
+Locator::contains('div[ * `contenteditable=true]',`  'hello world');
+
+{% endhighlight %}
+
+ * `param` $element
+ * `param` $text
+ * `return`  string
+
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Locator.php#L198)
+
 #### *public static* find($element, array $attributes) 
 
 Finds element by it's attribute(s)
@@ -85,7 +103,7 @@ $I->see('Log In', Locator::href('/login.php'));
 
 #### *public static* humanReadableString($selector) 
 
-[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Locator.php#L185)
+[See source](https://github.com/Codeception/Codeception/blob/2.1/src/Codeception/Util/Locator.php#L204)
 
 #### *public static* isCSS($selector) 
 
