Merge pull request #51 from webimpress/fix/docs

Docs fixes + Code coverage

Author: weierophinney

.coveralls.yml

@@ -0,0 +1,2 @@
+coverage_clover: clover.xml
+json_path: coveralls-upload.json

.gitattributes

@@ -0,0 +1,7 @@
+/test export-ignore
+.coveralls.yml export-ignore
+.gitattributes export-ignore
+.gitignore export-ignore
+.travis.yml export-ignore
+phpcs.xml export-ignore
+phpunit.xml.dist export-ignore

.gitignore

@@ -1 +1,4 @@
 vendor/
+phpunit.xml
+clover.xml
+coveralls-upload.json

.travis.yml

@@ -10,16 +10,17 @@ cache:
 env:
   global:
     - COMPOSER_ARGS="--no-interaction --ignore-platform-reqs"
+    - COVERAGE_DEPS="satooshi/php-coveralls"
 
 matrix:
-  fast_finish: true
   include:
     - php: 5.6
       env:
         - DEPS=lowest
     - php: 5.6
       env:
         - DEPS=locked
+        - TEST_COVERAGE=true
     - php: 5.6
       env:
         - DEPS=latest
@@ -33,18 +34,27 @@ matrix:
     - php: 7
       env:
         - DEPS=latest
-    - php: hhvm 
+    - php: 7.1
       env:
         - DEPS=lowest
-    - php: hhvm 
+    - php: 7.1
       env:
         - DEPS=locked
-    - php: hhvm 
+    - php: 7.1
+      env:
+        - DEPS=latest
+    - php: hhvm
+      env:
+        - DEPS=lowest
+    - php: hhvm
+      env:
+        - DEPS=locked
+    - php: hhvm
       env:
         - DEPS=latest
   allow_failures:
     - php: hhvm
-  
+
 notifications:
   irc: "irc.freenode.org#apigility-dev"
   email: false
@@ -54,11 +64,15 @@ before_install:
   - travis_retry composer self-update
 
 install:
+  - if [[ $TEST_COVERAGE == 'true' ]]; then travis_retry composer require --dev $COMPOSER_ARGS $COVERAGE_DEPS ; fi
   - if [[ $DEPS == 'latest' ]]; then travis_retry composer update $COMPOSER_ARGS ; fi
   - if [[ $DEPS == 'lowest' ]]; then travis_retry composer update --prefer-lowest --prefer-stable $COMPOSER_ARGS ; fi
   - travis_retry composer install $COMPOSER_ARGS
   - composer show
 
 script:
-  - composer test
+  - if [[ $TEST_COVERAGE == 'true' ]]; then composer test-coverage ; else composer test ; fi
   - if [[ $CS_CHECK == 'true' ]]; then composer cs-check ; fi
+
+after_script:
+  - if [[ $TEST_COVERAGE == 'true' ]]; then composer upload-coverage ; fi

CONDUCT.md

@@ -0,0 +1,43 @@
+# Contributor Code of Conduct
+
+The Zend Framework project adheres to [The Code Manifesto](http://codemanifesto.com)
+as its guidelines for contributor interactions.
+
+## The Code Manifesto
+
+We want to work in an ecosystem that empowers developers to reach their
+potential — one that encourages growth and effective collaboration. A space that
+is safe for all.
+
+A space such as this benefits everyone that participates in it. It encourages
+new developers to enter our field. It is through discussion and collaboration
+that we grow, and through growth that we improve.
+
+In the effort to create such a place, we hold to these values:
+
+1. **Discrimination limits us.** This includes discrimination on the basis of
+   race, gender, sexual orientation, gender identity, age, nationality, technology
+   and any other arbitrary exclusion of a group of people.
+2. **Boundaries honor us.** Your comfort levels are not everyone’s comfort
+   levels. Remember that, and if brought to your attention, heed it.
+3. **We are our biggest assets.** None of us were born masters of our trade.
+   Each of us has been helped along the way. Return that favor, when and where
+   you can.
+4. **We are resources for the future.** As an extension of #3, share what you
+   know. Make yourself a resource to help those that come after you.
+5. **Respect defines us.** Treat others as you wish to be treated. Make your
+   discussions, criticisms and debates from a position of respectfulness. Ask
+   yourself, is it true? Is it necessary? Is it constructive? Anything less is
+   unacceptable.
+6. **Reactions require grace.** Angry responses are valid, but abusive language
+   and vindictive actions are toxic. When something happens that offends you,
+   handle it assertively, but be respectful. Escalate reasonably, and try to
+   allow the offender an opportunity to explain themselves, and possibly correct
+   the issue.
+7. **Opinions are just that: opinions.** Each and every one of us, due to our
+   background and upbringing, have varying opinions. The fact of the matter, is
+   that is perfectly acceptable. Remember this: if you respect your own
+   opinions, you should respect the opinions of others.
+8. **To err is human.** You might not intend it, but mistakes do happen and
+   contribute to build experience. Tolerate honest mistakes, and don't hesitate
+   to apologize if you make one yourself.

CONTRIBUTING.md

@@ -53,22 +53,28 @@ $ composer install
 To run tests, use the PHPUnit executable installed by Composer:
 
 ```console
-$ ./vendor/bin/phpunit
+$ composer test
 ```
 
 ## CODING STANDARDS
 
 While Apigility uses Zend Framework 2 coding standards, in practice, we check
-standards using [php-cs-fixer](https://github.com/fabpot/PHP-CS-Fixer) (which is
-installed via Composer with other dependencies). To check for CS issues:
+standards against PSR-1/2. To check for CS issues:
 
 ```console
-$ ./vendor/bin/php-cs-fixer fix . --dry-run
+$ composer cs-check
 ```
 
-This will report CS issues. Alternately, you can have the tool fix them for you
-by omitting the `--dry-run` switch:
+This will report CS issues. You can also attempt to fix many reported errors
+automatically:
 
 ```console
-$ ./vendor/bin/php-cs-fixer fix .
+$ composer cs-fix
 ```
+
+If you use `cs-fix` to fix issues, make certain you add and commit any files
+changed!
+
+## Conduct
+
+Please see our [CONDUCT.md](CONDUCT.md) to understand expected behavior when interacting with others in the project.

LICENSE.txt LICENSE.mdLICENSE.txt renamed to LICENSE.md

@@ -1,19 +1,20 @@
-Copyright (c) 2014, Zend Technologies USA, Inc.
+Copyright (c) 2014-2016, Zend Technologies USA, Inc.
+
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,
 are permitted provided that the following conditions are met:
 
-    * Redistributions of source code must retain the above copyright notice,
-      this list of conditions and the following disclaimer.
+- Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
 
-    * Redistributions in binary form must reproduce the above copyright notice,
-      this list of conditions and the following disclaimer in the documentation
-      and/or other materials provided with the distribution.
+- Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
 
-    * Neither the name of Zend Technologies USA, Inc. nor the names of its
-      contributors may be used to endorse or promote products derived from this
-      software without specific prior written permission.
+- Neither the name of Zend Technologies USA, Inc. nor the names of its
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

README.md

@@ -1,7 +1,8 @@
 ZF Api Problem
 ==============
 
-[![Build Status](https://travis-ci.org/zfcampus/zf-api-problem.png)](https://travis-ci.org/zfcampus/zf-api-problem)
+[![Build Status](https://travis-ci.org/zfcampus/zf-api-problem.svg?branch=master)](https://travis-ci.org/zfcampus/zf-api-problem)
+[![Coverage Status](https://coveralls.io/repos/github/zfcampus/zf-api-problem/badge.svg?branch=master)](https://coveralls.io/github/zfcampus/zf-api-problem?branch=master)
 
 Introduction
 ------------
@@ -22,14 +23,14 @@ Installation
 Run the following `composer` command:
 
 ```console
-$ composer require "zfcampus/zf-api-problem:~1.0-dev"
+$ composer require zfcampus/zf-api-problem
 ```
 
 Alternately, manually add the following to your `composer.json`, in the `require` section:
 
 ```javascript
 "require": {
-    "zfcampus/zf-api-problem": "~1.0-dev"
+    "zfcampus/zf-api-problem": "^1.2"
 }
 ```
 
@@ -39,18 +40,23 @@ Finally, add the module name to your project's `config/application.config.php` u
 key:
 
 ```php
-return array(
+return [
     /* ... */
-    'modules' => array(
+    'modules' => [
         /* ... */
         'ZF\ApiProblem',
-    ),
+    ],
     /* ... */
-);
+];
 ```
 
+> ### zf-component-installer
+>
+> If you use [zf-component-installer](https://github.com/zendframework/zf-component-installer),
+> that plugin will install zf-api-problem as a module for you.
+
 Configuration
--------------
+=============
 
 ### User Configuration
 
@@ -74,26 +80,26 @@ The following configuration is provided in `config/module.config.php` to enable
 function:
 
 ```php
-'service_manager' => array(
-    'aliases'   => array(
+'service_manager' => [
+    'aliases'   => [
         'ZF\ApiProblem\ApiProblemListener'  => 'ZF\ApiProblem\Listener\ApiProblemListener',
         'ZF\ApiProblem\RenderErrorListener' => 'ZF\ApiProblem\Listener\RenderErrorListener',
         'ZF\ApiProblem\ApiProblemRenderer'  => 'ZF\ApiProblem\View\ApiProblemRenderer',
         'ZF\ApiProblem\ApiProblemStrategy'  => 'ZF\ApiProblem\View\ApiProblemStrategy',
-    ),
-    'factories' => array(
+    ],
+    'factories' => [
         'ZF\ApiProblem\Listener\ApiProblemListener'             => 'ZF\ApiProblem\Factory\ApiProblemListenerFactory',
         'ZF\ApiProblem\Listener\RenderErrorListener'            => 'ZF\ApiProblem\Factory\RenderErrorListenerFactory',
         'ZF\ApiProblem\Listener\SendApiProblemResponseListener' => 'ZF\ApiProblem\Factory\SendApiProblemResponseListenerFactory',
         'ZF\ApiProblem\View\ApiProblemRenderer'                 => 'ZF\ApiProblem\Factory\ApiProblemRendererFactory',
         'ZF\ApiProblem\View\ApiProblemStrategy'                 => 'ZF\ApiProblem\Factory\ApiProblemStrategyFactory',
-    ),
-),
-'view_manager' => array(
+    ],
+],
+'view_manager' => [
     // Enable this in your application configuration in order to get full
     // exception stack traces in your API-Problem responses.
     'display_exceptions' => false,
-),
+],
 ```
 
 ZF2 Events
@@ -175,13 +181,14 @@ encountered.  An instance of `ApiProblem` is typically wrapped in an
 constructor:
 
 ```php
-class ApiProblem {
+class ApiProblem
+{
     public function __construct(
         $status,
         $detail,
         $type = null,
         $title = null,
-        array $additional = array()
+        array $additional = []
     ) {
         /* ... */
     }

composer.json

@@ -37,7 +37,7 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^4.8",
-        "squizlabs/php_codesniffer": "^2.7"
+        "zendframework/zend-coding-standard": "~1.0.0"
     },
     "autoload": {
         "psr-4": {
@@ -54,8 +54,10 @@
             "@cs-check",
             "@test"
         ],
+        "upload-coverage": "coveralls -v",
         "cs-check": "phpcs",
         "cs-fix": "phpcbf",
-        "test": "phpunit"
+        "test": "phpunit",
+        "test-coverage": "phpunit --coverage-clover clover.xml"
     }
 }