Skip to content

Commit 772c4a2

Browse files
adriadri
committed
Cleanup: Renames Filters to CodeTransform to reflect what it actually does.
1 parent 29aa4b9 commit 772c4a2

File tree

14 files changed

+57
-53
lines changed

14 files changed

+57
-53
lines changed

‎src/VCR/Filter/AbstractFilter.php‎ renamed to ‎src/VCR/CodeTransform/AbstractCodeTransform.php‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<?php
22

3-
namespace VCR\Filter;
3+
namespace VCR\CodeTransform;
44

5-
abstract class AbstractFilter extends \PHP_User_Filter
5+
abstract class AbstractCodeTransform extends \PHP_User_Filter
66
{
77
const NAME = 'vcr_abstract_filter';
88

@@ -21,7 +21,6 @@ abstract class AbstractFilter extends \PHP_User_Filter
2121
public function register()
2222
{
2323
if (!$this->isRegistered) {
24-
2524
$this->isRegistered = stream_filter_register(static::NAME, get_called_class());
2625
}
2726

‎src/VCR/Filter/CurlFilter.php‎ renamed to ‎src/VCR/CodeTransform/CurlCodeTransform.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<?php
22

3-
namespace VCR\Filter;
3+
namespace VCR\CodeTransform;
44

5-
class CurlFilter extends AbstractFilter
5+
class CurlCodeTransform extends AbstractCodeTransform
66
{
77
const NAME = 'vcr_curl';
88

‎src/VCR/Filter/SoapFilter.php‎ renamed to ‎src/VCR/CodeTransform/SoapCodeTransform.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<?php
22

3-
namespace VCR\Filter;
3+
namespace VCR\CodeTransform;
44

5-
class SoapFilter extends AbstractFilter
5+
class SoapCodeTransform extends AbstractCodeTransform
66
{
77
const NAME = 'vcr_soap';
88

‎src/VCR/LibraryHooks/CurlHook.php‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
use VCR\Util\Assertion;
66
use VCR\Request;
77
use VCR\Response;
8-
use VCR\Filter\AbstractFilter;
8+
use VCR\CodeTransform\AbstractCodeTransform;
99
use VCR\Util\CurlHelper;
1010
use VCR\Util\StreamProcessor;
1111
use VCR\Util\TextUtil;
@@ -15,7 +15,6 @@
1515
*/
1616
class CurlHook implements LibraryHook
1717
{
18-
1918
/**
2019
* @var \Closure Callback which will be executed when a request is intercepted.
2120
*/
@@ -52,9 +51,9 @@ class CurlHook implements LibraryHook
5251
protected static $multiExecLastCh;
5352

5453
/**
55-
* @var AbstractFilter
54+
* @var AbstractCodeTransform
5655
*/
57-
private $filter;
56+
private $codeTransformer;
5857

5958
/**
6059
* @var StreamProcessor
@@ -64,12 +63,12 @@ class CurlHook implements LibraryHook
6463
/**
6564
* Creates a new cURL hook instance.
6665
*
67-
* @param AbstractFilter $filter
66+
* @param AbstractCodeTransform $codeTransformer
6867
* @param StreamProcessor $processor
6968
*
7069
* @throws \BadMethodCallException in case the cURL extension is not installed.
7170
*/
72-
public function __construct(AbstractFilter $filter, StreamProcessor $processor)
71+
public function __construct(AbstractCodeTransform $codeTransformer, StreamProcessor $processor)
7372
{
7473
if (!function_exists('curl_version')) {
7574
// @codeCoverageIgnoreStart
@@ -79,7 +78,7 @@ public function __construct(AbstractFilter $filter, StreamProcessor $processor)
7978
// @codeCoverageIgnoreEnd
8079
}
8180
$this->processor = $processor;
82-
$this->filter = $filter;
81+
$this->codeTransformer = $codeTransformer;
8382
}
8483

8584
/**
@@ -93,8 +92,8 @@ public function enable(\Closure $requestCallback)
9392
return;
9493
}
9594

96-
$this->filter->register();
97-
$this->processor->appendFilter($this->filter);
95+
$this->codeTransformer->register();
96+
$this->processor->appendCodeTransformer($this->codeTransformer);
9897
$this->processor->intercept();
9998

10099
self::$requestCallback = $requestCallback;

‎src/VCR/LibraryHooks/SoapHook.php‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
use VCR\Util\Assertion;
66
use VCR\VCRException;
77
use VCR\Request;
8-
use VCR\Filter\AbstractFilter;
8+
use VCR\CodeTransform\AbstractCodeTransform;
99
use VCR\Util\StreamProcessor;
1010

1111
/**
@@ -22,9 +22,9 @@ class SoapHook implements LibraryHook
2222
*/
2323
private $status = self::DISABLED;
2424
/**
25-
* @var AbstractFilter
25+
* @var AbstractCodeTransform
2626
*/
27-
private $filter;
27+
private $codeTransformer;
2828
/**
2929
* @var \VCR\Util\StreamProcessor
3030
*/
@@ -33,19 +33,19 @@ class SoapHook implements LibraryHook
3333
/**
3434
* Creates a SOAP hook instance.
3535
*
36-
* @param AbstractFilter $filter
36+
* @param AbstractCodeTransform $codeTransformer
3737
* @param StreamProcessor $processor
3838
*
3939
* @throws \BadMethodCallException in case the Soap extension is not installed.
4040
*/
41-
public function __construct(AbstractFilter $filter, StreamProcessor $processor)
41+
public function __construct(AbstractCodeTransform $codeTransformer, StreamProcessor $processor)
4242
{
4343
if (!class_exists('\SoapClient')) {
4444
throw new \BadMethodCallException('For soap support you need to install the soap extension.');
4545
}
4646

4747
$this->processor = $processor;
48-
$this->filter = $filter;
48+
$this->codeTransformer = $codeTransformer;
4949
}
5050

5151
/**
@@ -83,8 +83,8 @@ public function enable(\Closure $requestCallback)
8383
return;
8484
}
8585

86-
$this->filter->register();
87-
$this->processor->appendFilter($this->filter);
86+
$this->codeTransformer->register();
87+
$this->processor->appendCodeTransformer($this->codeTransformer);
8888
$this->processor->intercept();
8989

9090
$this->status = self::ENABLED;

‎src/VCR/LibraryHooks/StreamWrapperHook.php‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,14 @@
1111
*/
1212
class StreamWrapperHook implements LibraryHook
1313
{
14+
/**
15+
* @var \Closure Callback which will be executed when a request is intercepted.
16+
*/
1417
protected static $requestCallback;
1518

19+
/**
20+
* @var integer Position in the current response body.
21+
*/
1622
protected $position;
1723

1824
/**

‎src/VCR/Util/StreamProcessor.php‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
namespace VCR\Util;
44

55
use VCR\Configuration;
6-
use VCR\Filter\AbstractFilter;
6+
use VCR\CodeTransform\AbstractCodeTransform;
77

88
/**
99
* Implementation adapted from:
@@ -29,9 +29,9 @@ class StreamProcessor
2929
protected static $configuration;
3030

3131
/**
32-
* @var AbstractFilter[] $filters Filers which have been appended to this stream processor.
32+
* @var AbstractCodeTransform[] $codeTransformers Tranformers which have been appended to this stream processor.
3333
*/
34-
protected static $filters = array();
34+
protected static $codeTransformers = array();
3535

3636
/**
3737
* @var resource Resource for the currently opened file.
@@ -395,20 +395,20 @@ public function stream_truncate($new_size)
395395
}
396396

397397
/**
398-
* @param AbstractFilter $filter
398+
* @param AbstractCodeTransform $codeTransformer
399399
*/
400-
public function appendFilter(AbstractFilter $filter)
400+
public function appendCodeTransformer(AbstractCodeTransform $codeTransformer)
401401
{
402-
static::$filters[$filter::NAME] = $filter;
402+
static::$codeTransformers[$codeTransformer::NAME] = $codeTransformer;
403403
}
404404

405405
/**
406-
* @param AbstractFilter $filter
406+
* @param AbstractCodeTransform $codeTransformer
407407
*/
408-
public function detachFilter(AbstractFilter $filter)
408+
public function detachCodeTranformer(AbstractCodeTransform $codeTransformer)
409409
{
410-
if (!empty(static::$filters[$filter::NAME])) {
411-
unset(static::$filters[$filter::NAME]);
410+
if (!empty(static::$codeTransformers[$codeTransformer::NAME])) {
411+
unset(static::$codeTransformers[$codeTransformer::NAME]);
412412
}
413413
}
414414

@@ -419,8 +419,8 @@ public function detachFilter(AbstractFilter $filter)
419419
*/
420420
protected function appendFiltersToStream($stream)
421421
{
422-
foreach (static::$filters as $filter) {
423-
stream_filter_append($stream, $filter::NAME, STREAM_FILTER_READ);
422+
foreach (static::$codeTransformers as $codeTransformer) {
423+
stream_filter_append($stream, $codeTransformer::NAME, STREAM_FILTER_READ);
424424
}
425425
}
426426
}

‎src/VCR/VCRFactory.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,15 @@ protected function createStorage($filePath)
5555
protected function createVCRLibraryHooksSoapHook()
5656
{
5757
return new LibraryHooks\SoapHook(
58-
$this->getOrCreate('VCR\Filter\SoapFilter'),
58+
$this->getOrCreate('VCR\CodeTransform\SoapCodeTransform'),
5959
$this->getOrCreate('VCR\Util\StreamProcessor')
6060
);
6161
}
6262

6363
protected function createVCRLibraryHooksCurlHook()
6464
{
6565
return new LibraryHooks\CurlHook(
66-
$this->getOrCreate('VCR\Filter\CurlFilter'),
66+
$this->getOrCreate('VCR\CodeTransform\CurlCodeTransform'),
6767
$this->getOrCreate('VCR\Util\StreamProcessor')
6868
);
6969
}

‎tests/VCR/Filter/AbstractFilterTest.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<?php
22

3-
namespace VCR\Filter;
3+
namespace VCR\CodeTransform;
44

5-
class AbstractFilterTest extends \PHPUnit_framework_TestCase
5+
class AbstractCodeTransformTest extends \PHPUnit_framework_TestCase
66
{
77

88
protected function getFilter(array $methods = array())
@@ -12,7 +12,7 @@ protected function getFilter(array $methods = array())
1212
$methods
1313
);
1414

15-
$filter = $this->getMockBuilder('\VCR\Filter\AbstractFilter')
15+
$filter = $this->getMockBuilder('\VCR\CodeTransform\AbstractCodeTransform')
1616
->setMethods(array($defaults))
1717
->getMockForAbstractClass();
1818

‎tests/VCR/Filter/CurlFilterTest.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
<?php
22

3-
namespace VCR\Filter;
3+
namespace VCR\CodeTransform;
44

55
use lapistano\ProxyObject\ProxyBuilder;
66

7-
class CurlFilterTest extends \PHPUnit_Framework_TestCase
7+
class CurlCodeTransformTest extends \PHPUnit_Framework_TestCase
88
{
99
/**
1010
* @dataProvider codeSnippetProvider
1111
*/
1212
public function testTransformCode($expected, $code)
1313
{
14-
$proxy = new ProxyBuilder('\VCR\Filter\CurlFilter');
14+
$proxy = new ProxyBuilder('\VCR\CodeTransform\CurlCodeTransform');
1515
$filter = $proxy
1616
->setMethods(array('transformCode'))
1717
->getProxy();

0 commit comments

Comments
 (0)