Skip to content

Fix/general improvements #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 24, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
*.idea*
*.sublime-*
**/vendor/*
coverage/*
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2013 Adrian Philipp, https://github.com/adri <mail@adrian-philipp.com>
Copyright (c) 2013-2016 Adrian Philipp, https://github.com/adri <mail@adrian-philipp.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
5 changes: 4 additions & 1 deletion PHPUnit/Util/Log/VCR.php
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<?php

/**
* A TestListener that integrates with PHP-VCR.
*
Expand All @@ -13,7 +14,7 @@
* @package PHPUnit
* @subpackage Util_Log
* @author Adrian Philipp <mail@adrian-philipp.com>
* @copyright 2011-2012 Adrian Philipp <mail@adrian-philipp.com>
* @copyright 2011-2016 Adrian Philipp <mail@adrian-philipp.com>
* @license http://www.opensource.org/licenses/BSD-3-Clause The BSD 3-Clause License
* @version Release: @package_version@
* @link http://www.phpunit.de/
Expand Down Expand Up @@ -118,6 +119,7 @@ public function addRiskyTest(PHPUnit_Framework_Test $test, Exception $e, $time)
* A test started.
*
* @param PHPUnit_Framework_Test $test
* @return bool|null
*/
public function startTest(PHPUnit_Framework_Test $test)
{
Expand Down Expand Up @@ -171,6 +173,7 @@ private static function parseDocBlock($doc_block, $tag)

return $matches;
}

/**
* A test ended.
*
Expand Down
34 changes: 13 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Use `@vcr cassette_name` on your tests to turn VCR automatically on and off.

## Usage example

``` php
```php
class VCRTest extends \PHPUnit_Framework_TestCase
{
/**
Expand All @@ -26,26 +26,18 @@ class VCRTest extends \PHPUnit_Framework_TestCase

## Installation

1) Add to your `composer.json`:
1) Install using composer:

``` json
"require-dev": {
"php-vcr/phpunit-testlistener-vcr": "*"
}
```

2) Install using composer:

``` bash
```sh
composer require --dev php-vcr/phpunit-testlistener-vcr
```

3) Add listener to your `phpunit.xml`:
2) Add listener to your `phpunit.xml`:

``` bash
<listeners>
<listener class="PHPUnit_Util_Log_VCR" file="vendor/php-vcr/phpunit-testlistener-vcr/PHPUnit/Util/Log/VCR.php" />
</listeners>
```yml
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be xml?

<listeners>
<listener class="PHPUnit_Util_Log_VCR" file="vendor/php-vcr/phpunit-testlistener-vcr/PHPUnit/Util/Log/VCR.php" />
</listeners>
```

## Dependencies
Expand All @@ -59,17 +51,17 @@ PHPUnit-Testlistener-VCR depends on:

In order to run all tests you need to get development dependencies using composer:

``` php
composer install --dev
phpunit ./tests
```php
composer install
./vendor/bin/phpunit
```

## Changelog

* 2013-05-14 1.0.0: First prototype
**The changelog is manage at [PHPUnit testlistener for PHP-VCR releases page](https://github.com/php-vcr/phpunit-testlistener-vcr/releases).**

## Copyright
Copyright (c) 2013 Adrian Philipp. Released under the terms of the MIT license. See LICENSE for details.
Copyright (c) 2013-2016 Adrian Philipp. Released under the terms of the MIT license. See LICENSE for details.

<!--
name of the projects and all sub-modules and libraries (sometimes they are named different and very confusing to new users)
Expand Down
3 changes: 3 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,8 @@

"require": {
"php-vcr/php-vcr": "*"
},
"require-dev": {
"phpunit/phpunit": "^4.8"
}
}
Loading