behat.yml.dist cleanup + README options fixes #11

Author: ek9

.gitignore

@@ -1,6 +1,7 @@
 bin/
 nbproject/
 vendor/
+build/
 composer.phar
 **/*.dbf
 /composer.lock

CHANGELOG.md

@@ -10,6 +10,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 - `phpunit/php-code-coverage` dependency version requirement has been updated
   from `~4.0|~5.0` to `~5.0` as we do not support version `4.0` anymore.
+- Cleaned up defaults for whitelisting files
+- Updated README to list all configuration options
+- Updated `behat.yml.dist` so that it can be used as a proper example
+- `remote` driver is no longer activated by default
 
 
 ## [3.2.0] - 2017-10-17 - Guzzle 6.0 support release

README.md

@@ -117,23 +117,35 @@ default:
 ### Configuration Options
 
 * `auth` - HTTP authentication options (optional).
-- `create` (`method` / `path`) - *TBA*.
-- `read` (`method` / `path`) - *TBA*.
-- `delete` (`method` / `path`) - *TBA*.
+- `create` (`method` / `path`) - override options for create method:
+    - `method` - specify a method (default: `POST`)
+    - `path` - specify path (default: `/`)
+- `read` (`method` / `path`) - override options (method and path) for read
+  method.
+    - `method` - specify a method (default: `GET`)
+    - `path` - specify path (default: `/`)
+- `delete` (`method` / `path`) - override options (method and path) for delete
+  method.
+    - `method` - specify a method (default: `DELETE`)
+    - `path` - specify path (default: `/`)
 - `drivers` - a list of drivers for gathering code coverage data:
-    - `remote` - remote Xdebug driver.
-    - `local` - local Xdebug driver. 
+    - `local` - local Xdebug driver (default).
+    - `remote` - remote Xdebug driver (disabled by default).
 - `filter` - various filter options:
-    - `forceCoversAnnotation` - *TBA*
-    - `mapTestClassNameToCoveredClassName` - *TBA*
+    - `forceCoversAnnotation` - (default: `false`)
+    - `mapTestClassNameToCoveredClassName` - (default: `false`)
     - `whiltelist` - whitelist specific options:
-        - `addUncoveredFilesFromWhiltelist` - *TBA*
-        - `processUncoveredFilesFromWhitelist` - *TBA*
+        - `addUncoveredFilesFromWhiltelist` - (default: `true`)
+        - `processUncoveredFilesFromWhitelist` - (default: `false`)
         - `include` - a list of files or directories to include in whitelist:
             - `directories` - key containing whitelisted directories to include.
-            - `files` - key containing whitelisted files to include.
+                - `suffix` - suffix for files to be included (default: `.php`)
+                - `prefix` - prefix of files to be included (optional)
+            - `files` - a list containing whitelisted files to include.
         - `exclude` - a list of files or directories to exclude from whitelist:
             - `directories` - key containing whitelisted directories to exclude.
+                - `suffix` - suffix for files to be included (default: `.php`)
+                - `prefix` - prefix of files to be included (optional)
             - `files` - key containing whitelisted files to exclude.
 - `report` - reporter options:
     - `format` - specify report format (`html`, `clover`, `php`, `text`)

behat.yml.dist

@@ -2,53 +2,25 @@ default:
   extensions:
     LeanPHP\Behat\CodeCoverage\Extension:
 # optional authentication
-      auth:        ~
-#     auth:
-#       user:      user
-#       password:  password
-      create:
-        method:    POST
-        path:      /
-      read:
-        method:    GET
-        path:      /
-      delete:
-        method:    DELETE
-        path:      /
       drivers:
-        - remote
         - local
-      filter:      ~
-#     filter:
-#       forceCoversAnnotation:                false
-#       mapTestClassNameToCoveredClassName:   false
-#       whitelist:
-#         addUncoveredFilesFromWhitelist:     true
-#         processUncoveredFilesFromWhitelist: false
-#         include:
-#           directories:
-#             'some_path':
-#               suffix: 'some_suffix'
-#               prefix: 'some_prefix'
-#           files:
-#             - 'some_file'
-#         exclude:
-#           directories:
-#             ...
-#           files:
-#             ...
-#       blacklist:
-#         include:
-#           directories:
-#             ...
+      filter:
+        forceCoversAnnotation:                false
+        mapTestClassNameToCoveredClassName:   false
+        whitelist:
+          addUncoveredFilesFromWhitelist:     true
+          processUncoveredFilesFromWhitelist: false
+          include:
+            directories:
+              'src': ~
 #           files:
-#             ...
+#             - 'script.php'
 #         exclude:
 #           directories:
-#             ...
+#             'vendor': ~
 #           files:
-#             ...
+#             - src/script.php
       report:
         format:    html
         options:
-          target:: /tmp/report
+          target: build/coverage-behat