1fff4ab788
Added available currencies and updated the constructor and setCode to the currency class Added phpmd to project Updated documentation to some some conventions, updated docs to show the new usage of the currency class, also updated the testing documentation to show how to use phpmd Small bug fix and made the configuration file have 100% code coverage Code cleanup, removed unused variables Updated dev dependencies to patch level Removed the sin_key option since it will be going away soon Removed Robo in composer.json since we do not use and updated travis config to allow failures in php 5.3 since we require 5.4 or greater Deleted robo file Large update with documentation updates, extra code functionality, and bug fixes.
75 lines
1.8 KiB
ReStructuredText
75 lines
1.8 KiB
ReStructuredText
=======
|
|
Testing
|
|
=======
|
|
|
|
Current Build Status:
|
|
|
|
.. image:: https://travis-ci.org/bitpay/php-bitpay-client.svg?branch=master
|
|
:target: https://travis-ci.org/bitpay/php-bitpay-client
|
|
|
|
Testing ensures that code is stable and that the code quality is high by holding
|
|
every person to the same standards. Before you start, please make sure you have
|
|
install the required development dependencies.
|
|
|
|
.. code-block:: bash
|
|
|
|
composer.phar install
|
|
|
|
.. note::
|
|
|
|
By default Composer will install the development packages. You should
|
|
not need to run ``install`` or ``update``.
|
|
|
|
PHPUnit
|
|
=======
|
|
|
|
To run phpunit, use the command:
|
|
|
|
.. code-block:: bash
|
|
|
|
php bin/phpunit -c build/
|
|
|
|
This will run the tests and will also generate the code coverage reports which
|
|
you can view by opening the HTML files generated in the ``build/docs/code-coverage``.
|
|
|
|
You can also run phpunit on just one file, for example:
|
|
|
|
.. code-block:: bash
|
|
|
|
php bin/phpunit -c build/ tests/Bitpay/PrivateKeyTest.php
|
|
|
|
Running tests on just one file can be helpful since you are not running the
|
|
entire test suite.
|
|
|
|
PHP_CodeSniffer
|
|
===============
|
|
|
|
Please make sure your code is PSR1 and PSR2 compliant. To do this, ``phpcs``
|
|
has been include in the require-dev section of composer and also is part of
|
|
the build process on Travis CI.
|
|
|
|
To make sure your code is compliant, please run the command:
|
|
|
|
.. code-block:: bash
|
|
|
|
php bin/phpcs -n --standard=PSR1,PSR2 --report=full src/
|
|
|
|
Please fix any violations that are found.
|
|
|
|
Tools
|
|
-----
|
|
|
|
Some helpful tools that you can use include
|
|
|
|
* `php-cs-fixer <https://github.com/fabpot/PHP-CS-Fixer>`_
|
|
|
|
PHP Mess Detector
|
|
=================
|
|
|
|
To make sure that code conforms to standards and does not become too jacked up,
|
|
please try to use phpmd. You can see the rules in ``build/rulesets/phpmd.xml``.
|
|
|
|
.. code-block:: bash
|
|
|
|
php bin/phpmd src/ text build/rulesets/phpmd.xml
|