Added self-update/rollback command, CHANGELOG, documentation

.codeclimate.yml

@@ -0,0 +1,27 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - php
+  phpcodesniffer:
+    enabled: true
+  phpmd:
+    enabled: true
+    checks:
+      CleanCode/ElseExpression:
+        enabled: false
+      Controversial/Superglobals:
+        enabled: false
+    exclude_fingerprints:
+    # High complexity in CiInfo#toArray()
+    - 8f1ff5077ea52a5fee818bde73a0dbb7
+    - efc665f3aa41cbbd0bbd0ec9c945a453
+ratings:
+  paths:
+  - "**.inc"
+  - "**.module"
+  - "**.php"
+exclude_paths:
+- tests/

.gitignore

@@ -1,3 +1,6 @@
+.idea/
+.vagrant/
+Vagrantfile
 build/
 vendor/
 composer.lock

.travis.yml

@@ -1,7 +1,26 @@
 language: php
+
+sudo: false
+
 php:
   - 5.5
-install: composer install --dev
+
+cache:
+  directories:
+    - $HOME/.composer/cache
+
+before_install:
+  - composer self-update
+
+install:
+  - composer install --prefer-dist
+
 before_script:
   - git config --global user.email "[email protected]"
   - git config --global user.name "Travis CI"
+
+script:
+  - vendor/bin/phpunit
+
+after_script:
+  - php composer/bin/test-reporter

CHANGELOG.md

@@ -0,0 +1,16 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a CHANGELOG](http://keepachangelog.com).
+
+## [Unreleased]
+
+### Added
+
+- Executable .phar file for download
+- `upload` command (PHAR only) - same as calling the tool without a command when installed via composer.
+- `self-update` / `selfupdate` command (PHAR only)
+- `rollback` command (PHAR only)
+- [Installation / Usage](./README.md) / [Distribution instructions](./DEVELOPING.md) for the PHAR tool
+
+[Unreleased]: https://github.com/codeclimate/php-test-reporter/compare/v0.3.2...HEAD

DEVELOPING.md

@@ -1,18 +1,44 @@
 # Developing
 
-- Get the source
+## Get the source
 
     $ git clone https://github.com/codeclimate/php-test-reporter
 
-- Install dependencies
+## Install dependencies
 
     $ curl -sS https://getcomposer.org/installer | php
-    $ php composer.phar install --dev
+    $ php composer.phar update -o -v
 
-- Run the tests
+## Run the tests
 
     $ ./vendor/bin/phpunit
+
+### With HTML coverage output:
 
-- Submit PRs to https://github.com/codeclimate/php-test-reporter
+	$ ./vendor/bin/phpunit --coverage-html=build/logs/coverage
 
-*Note*: all changes and fixes must have appropriate test coverage.
+## Build the PHAR tool
+
+	# Create a new git tag (optional)
+	$ git tag v1.x.x -m 'Version 1.x.x'
+	# Build the PHAR using box project
+	$ ./vendor/bin/box build
+
+## Distribute the PHAR tool
+
+### With verification and compatibility for phar.io / PhiVE
+
+* [Create a GPG key](https://phar.io/howto/generate-gpg-key.html) (Should be the repositoy's maintainer one)
+* [Create a signature and upload to Github](https://phar.io/howto/sign-and-upload-to-github.html)
+
+### Without verification
+
+* Go to the [releases section on Github](https://github.com/codeclimate/php-test-reporter/releases)
+* Click "Edit" on the latest tag/release
+* Add the `codeclimate-test-reporter.phar` in the "Attach binaries..." section
+* Click "Update release"
+
+## Contribute 
+
+* Submit PRs to: https://github.com/codeclimate/php-test-reporter
+* *Note*: all changes and fixes must have appropriate test coverage.

README.md

@@ -1,48 +1,79 @@
-[![Code Climate](https://codeclimate.com/github/codeclimate/php-test-reporter.png)](https://codeclimate.com/github/codeclimate/php-test-reporter) [![Build Status](https://travis-ci.org/codeclimate/php-test-reporter.svg?branch=master)](https://travis-ci.org/codeclimate/php-test-reporter)
+[![Code Climate](https://codeclimate.com/github/codeclimate/php-test-reporter.svg)](https://codeclimate.com/github/codeclimate/php-test-reporter)
+[![Build Status](https://travis-ci.org/codeclimate/php-test-reporter.svg?branch=master)](https://travis-ci.org/codeclimate/php-test-reporter)
 
 # codeclimate-test-reporter
 
-Collects test coverage data from your PHP test suite and sends it to 
+Collects test coverage data from your PHP test suite and sends it to
 Code Climate's hosted, automated code review service.
 
 Code Climate - https://codeclimate.com
 
+**Important:** If you encounter an error involving SSL certificates, see the **Known Issue: SSL Certificate Error** section below.
+
+# Important FYIs
+
+Across the many different testing frameworks, setups, and environments, there are lots of variables at play. Before setting up test coverage, it's important to understand what we do and do not currently support:
+
+* **Default branch only:** We only support test coverage for your [default branch](https://docs.codeclimate.com/docs/code-climate-glossary#default-branch). Be sure to check out this branch before running your tests.
+* **Single payload:** We currently only support a single test coverage payload per commit. If you run your tests in multiple steps, or via parallel tests, Code Climate will only process the first payload that we receive. If you are using a CI, be sure to check if you are running your tests in a parallel mode.
+
+  **Note:** There is one exception to this rule. We've specifically built an integration with [Solano Labs](https://www.solanolabs.com/) to support parallel tests.
+
+  **Note:** If you've configured Code Climate to analyze multiple languages in the same repository (e.g., Ruby and JavaScript), we can nonetheless only process test coverage information for one of these languages. We'll process the first payload that we receive.
+* **Invalid File Paths:** By default, our test reporters expect your application to exist at the root of your repository. If this is not the case, the file paths in your test coverage payload will not match the file paths that Code Climate expects.
+
+## Requirements
+
+There are several requirements you'll need in order to use the PHP test reporter on your system:
+
+- [PHPUnit](http://phpunit.de)
+- [Xdebug](http://xdebug.org)
+- [Composer](http://getcomposer.org)
+
+The test reporter uses the [PHPUnit](http://phpunit.de) testing tool to generate [code coverage](http://en.wikipedia.org/wiki/Code_coverage) information. These results show how much of your application's code is being executed by your unit tests. PHPUnit can't generate this information on its own though - it needs another tool, [Xdebug](http://xdebug.org). This is *not* included as a part of the PHPUnit (or PHP) install by default so you'll need to install it yourself.
+
+Xdebug is installed as an extension to PHP, not a library. You can find more information about installing the tool via PECL [on the project website](http://xdebug.org/docs/install).
+
+If you execute your PHPUnit tests with the `--coverage-clover` option and receive the message "The Xdebug extension is not loaded. No code coverage will be generated." you will need to visit the Xdebug website and install the extension. If you do not, you'll most likely get an error something like this:
+
+```
+PHP Warning:  simplexml_load_file(): I/O warning : failed to load external entity "[...]/build/logs/clover.xml" in [...]/vendor/satooshi/php-coveralls/src/Contrib/Bundle/CoverallsV1Bundle/Api/Jobs.php on line 52
+```
+
 ## Installation
 
-This package requires a user, but not necessarily a paid account, on 
-Code Climate, so if you don't have one the first step is to signup at: 
+This package requires a user, but not necessarily a paid account, on
+Code Climate, so if you don't have one the first step is to signup at:
 https://codeclimate.com.
 
-To install php-test-reporter with Composer first add the following to 
-your composer.json file:
+### Via composer
 
-**composer.json**
+To install php-test-reporter with Composer run the following command.
 
-```javascript
-{
-  "require-dev": {
-    "codeclimate/php-test-reporter": "dev-master"
-  }
-}
+```shell
+$ composer require codeclimate/php-test-reporter --dev
 ```
 
-Then, run:
+This will get you the latest version of the reporter and install it. If you do want the master, untagged, version you may use the command below:
 
-```
-$ php composer.phar install --dev
+```shell
+$ composer require codeclimate/php-test-reporter:@dev --dev
 ```
 
-If adding the test-reporter to an existing project, run:
+### As PHAR tool
 
-```
-$ php composer.phar update codeclimate/php-test-reporter --dev
+Checkout the [latest release here](https://github.com/codeclimate/php-test-reporter/releases) and replace `X.X.X` with the latest version.
+
+```shell
+$ RELEASE=X.X.X
+$ wget -c "https://github.com/codeclimate/php-test-reporter/releases/download/$RELEASE/codeclimate-test-reporter.phar"
 ```
 
 ## Usage
 
 - Generate coverage data to `build/logs/clover.xml`
 
-Add the following to phpunit.dist.xml:
+Add the following to phpunit.xml.dist:
 
 ```xml
 <?xml version="1.0" encoding="UTF-8"?>
@@ -57,27 +88,54 @@ Add the following to phpunit.dist.xml:
 
 Or invoke `phpunit` as follows:
 
-```
+```shell
 $ phpunit --coverage-clover build/logs/clover.xml
 ```
 
-- Specifying your repo token as an environment variable, invoke the 
+- Specifying your repo token as an environment variable, invoke the
   test-reporter:
 
-```
+```shell
 $ CODECLIMATE_REPO_TOKEN="..." vendor/bin/test-reporter
+
+# ... or via PHAR ...
+
+$ CODECLIMATE_REPO_TOKEN="..." codeclimate-test-reporter.phar upload
 ```
 
-The `CODECLIMATE_REPO_TOKEN` value is provided after you add your repo 
-to your Code Climate account by clicking on "Setup Test Coverage" on the 
+The `CODECLIMATE_REPO_TOKEN` value is provided after you add your repo
+to your Code Climate account by clicking on "Setup Test Coverage" on the
 right hand side of your feed.
 
-Please contact [email protected] if you need any assistance setting 
+Please contact [email protected] if you need any assistance setting
 this up.
 
+## Troubleshooting
+
+If you're having trouble setting up or working with our test coverage feature, [see our detailed help doc](http://docs.codeclimate.com/article/220-help-im-having-trouble-with-test-coverage), which covers the most common issues encountered.
+
+## Known Issue: SSL Certificate Error
+
+If you encounter an error involving SSL certificates when trying to report
+coverage data from your CI server, you can work around it by manually posting
+the data via `curl`:
+
+```yaml
+after_script:
+  - CODECLIMATE_REPO_TOKEN="..." bin/test-reporter --stdout > codeclimate.json
+  - "curl -X POST -d @codeclimate.json -H 'Content-Type: application/json' -H 'User-Agent: Code Climate (PHP Test Reporter v0.1.1)' https://codeclimate.com/test_reports"
+```
+
+**Note:** In the command above, you may need to change `bin/test-reporter` to `vendor/bin/test-reporter`, depending on your project's directory structure.
+
+More details can be found in [this issue][issue].
+
+[issue]: https://github.com/codeclimate/php-test-reporter/issues/3
+
+
 ## Contributions
 
-Patches, bug fixes, feature requests, and pull requests are welcome on 
+Patches, bug fixes, feature requests, and pull requests are welcome on
 the GitHub page for this project:
 
 https://github.com/codeclimate/php-test-reporter
@@ -88,5 +146,6 @@ This package is maintained by Bryan Helmkamp ([email protected]).
 
 See LICENSE.txt
 
-Portions of the implementation were inspired by the php-coveralls 
+Portions of the implementation were inspired by the php-coveralls
 project.
+

box.json

@@ -0,0 +1,39 @@
+{
+    "chmod": "0755",
+    "compression": "GZ",
+    "alias": "codeclimate-test-reporter.phar",
+    "directories": [
+        "src"
+    ],
+    "compactors": [
+        "Herrera\\Box\\Compactor\\Php"
+    ],
+    "extract": false,
+    "intercept": true,
+    "files": [
+        "LICENSE"
+    ],
+    "finder": [
+        {
+            "name": [
+                "*.php",
+                "*.pem"
+            ],
+            "exclude": [
+                "bin",
+                "tests",
+                "phpunit",
+                "tm"
+            ],
+            "in": [
+                "vendor"
+            ]
+        }
+    ],
+    "git-version": "package_version",
+    "main": "phar/bin/main.php",
+    "metadata": "The code climate php test reporter",
+    "output": "build/codeclimate-test-reporter.phar",
+    "shebang": "#!/usr/bin/env php",
+    "stub": true
+}