Guard::PHPSpec
Description
guard-phpspec allows you to automatically run PHPSpec tests when sources are modified. It helps with integrating test-driven development (TDD) into your development process: Just launch guard-phpspec before you start working and it will notify you about the status of your tests!
Note: Although guard-phpspec should work with any PHP version PHPSpec supports, it has only been tested on PHP 5.3.8 and 5.4.4.
Author
Install
Please be sure to have PHP, PHPSpec and Ruby installed on your machine before you proceed with the installation.
The latest versions of Ruby come with a
packages-manager called gem
. gem
can be used to
install various packages, including guard-phpspec.
To install guard-phpspec, run the following command in the terminal:
Usage
Please read the Guard usage documentation.
Guardfile
guard-phpspec can be used with any kind of PHP projects that uses PHPSpec as its testing framwork. Please read the Guard documentation for more information about the Guardfile DSL.
By default, guard-phpspec will use the current working directory (pwd) to
search for tests and run them on start (if you enabled the
:all_on_start
option).
Example PHP project
The PHPSpec
documentaion uses the Object
Freezer library as an example on how to organize tests. This project
uses the Tests
directory for its tests.
An example of the Guardfile for the same project would look something like:
guard 'phpunit', :tests_path => 'Tests', :cli => '--colors' do
# Watch tests files
watch(%r{^.+Test\.php$})
# Watch library files and run their tests
watch(%r{^Object/(.+)\.php}) { |m| "Tests/#{m[1]}Test.php" }
end
Options
The following options can be passed to Guard::PHPSpec:
:all_on_start => false # Run all tests on startup.
# default: true
:all_after_pass => false # Run all tests after changed tests pass. This ensures
# that the process of making changed tests pass didn't
# break something else.
# default: true
:keep_failed => false # Remember failed tests and keep running them with
# each change until they pass.
# default: true
:tests_path => 'tests' # Relative path to the tests directory. This path
# is used when running all the tests.
# default: the current working directory (pwd)
:cli => '--colors' # The options passed to the phpunit command
# when running the tests.
# default: nil
Development
-
Source hosted at GitHub/lsd
-
Report issues/questions/requests on GitHub Issues