Major update and cleanup

Author: JeroenVanOort

.gitignore

@@ -1,10 +1,7 @@
-*.idea*
-*.sublime-*
 **/vendor/*
 coverage/*
 notes.md
 tests/fixtures/cassette*
-/.php_cs.cache
 /.php_cs
 composer.lock
 .phpunit.result.cache

.php-cs-fixer.dist.php

@@ -5,11 +5,9 @@
  '@PSR12' => true,
  '@Symfony' => true,
  '@Symfony:risky' => true,
- '@PHP73Migration' => true,
- '@PHP71Migration:risky' => true,
+ '@PHP80Migration' => true,
+ '@PHP80Migration:risky' => true,
  '@PHPUnit84Migration:risky' => true,
- // Causes too much problems for now, fix later
- 'declare_strict_types' => false,
  ])
  ->setFinder(
  PhpCsFixer\Finder::create()

README.md

@@ -97,7 +97,7 @@ $ composer require --dev php-vcr/php-vcr
 
 PHP-VCR depends on:
 
- * PHP 7.2+
+ * PHP 8
  * Curl extension
  * [symfony/event-dispatcher](https://github.com/symfony/event-dispatcher)
  * [symfony/yaml](https://github.com/symfony/yaml)

composer.json

@@ -22,12 +22,11 @@
  "symfony/event-dispatcher": "^5.0"
  },
  "require-dev": {
- "phpunit/phpunit": "^8.4.0",
+ "phpunit/phpunit": "^9.5.0",
  "mikey179/vfsstream": "^1.6.10",
  "phpstan/phpstan": "^0.12.92",
  "phpstan/phpstan-beberlei-assert": "^0.12.0",
  "thecodingmachine/phpstan-strict-rules": "^0.12",
- "sebastian/version": "^1.0.3|^2.0",
  "friendsofphp/php-cs-fixer": "^3.0",
  "phpstan/phpstan-phpunit": "^0.12.22",
  "phpstan/extension-installer": "^1.1"

phpstan-baseline.neon

@@ -0,0 +1,27 @@
+parameters:
+ignoreErrors:
+-
+message: "#^Access to an undefined property object\\:\\:\\$data\\.$#"
+count: 2
+path: src/VCR/CodeTransform/AbstractCodeTransform.php
+
+-
+message: "#^Access to an undefined property object\\:\\:\\$datalen\\.$#"
+count: 1
+path: src/VCR/CodeTransform/AbstractCodeTransform.php
+
+-
+message: "#^Parameter \\#1 \\$string of function substr expects string, string\\|false given\\.$#"
+count: 1
+path: src/VCR/Util/HttpUtil.php
+
+-
+message: "#^Cannot call method record\\(\\) on VCR\\\\Cassette\\|null\\.$#"
+count: 1
+path: src/VCR/Videorecorder.php
+
+-
+message: "#^Parameter \\#3 \\$cassette of class VCR\\\\Event\\\\BeforeRecordEvent constructor expects VCR\\\\Cassette, VCR\\\\Cassette\\|null given\\.$#"
+count: 1
+path: src/VCR/Videorecorder.php
+

phpstan.neon

@@ -1,11 +1,8 @@
+includes:
+- phpstan-baseline.neon
+
 parameters:
- level: 7
+ level: max
  paths:
  - src
  - tests/VCR
- ignoreErrors:
- # This part of PHP is not very well documented, resulting PHPStan's definitions not being accurate
- - "#Access to an undefined property object::\\$data\\.#"
- - "#Access to an undefined property object::\\$datalen\\.#"
- # PHPStan cannot detect that strrpos will succeed (because of Assertion above) in HttpUtil::parseStatus
- - '#Parameter .* \$str(ing)? of function substr expects string, string\|false given.#'

src/VCR/Cassette.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace VCR;
 
 use VCR\Storage\Storage;
@@ -10,61 +12,20 @@
 class Cassette
 {
  /**
- * Casette name.
- *
- * @var string
- */
- protected $name;
-
- /**
- * VCR configuration.
- *
- * @var Configuration
+ * @param Storage<array> $storage
  */
- protected $config;
-
- /**
- * Storage used to store records and request pairs.
- *
- * @var Storage<array>
- */
- protected $storage;
-
- /**
- * Creates a new cassette.
- *
- * @param string $name name of the cassette
- * @param Configuration $config configuration to use for this cassette
- * @param Storage<array> $storage storage to use for requests and responses
- *
- * @throws \VCR\VCRException if cassette name is in an invalid format
- */
- public function __construct(string $name, Configuration $config, Storage $storage)
- {
- $this->name = $name;
- $this->config = $config;
- $this->storage = $storage;
+ public function __construct(
+ protected string $name,
+ protected Configuration $config,
+ protected Storage $storage
+ ) {
  }
 
- /**
- * Returns true if a response was recorded for specified request.
- *
- * @param Request $request request to check if it was recorded
- *
- * @return bool true if a response was recorded for specified request
- */
  public function hasResponse(Request $request): bool
  {
  return null !== $this->playback($request);
  }
 
- /**
- * Returns a response for given request or null if not found.
- *
- * @param Request $request request
- *
- * @return Response|null response for specified request
- */
  public function playback(Request $request): ?Response
  {
  foreach ($this->storage as $recording) {
@@ -77,48 +38,30 @@ public function playback(Request $request): ?Response
  return null;
  }
 
- /**
- * Records a request and response pair.
- *
- * @param Request $request request to record
- * @param Response $response response to record
- */
  public function record(Request $request, Response $response): void
  {
  if ($this->hasResponse($request)) {
  return;
  }
 
- $recording = [
+ $this->storage->storeRecording([
  'request' => $request->toArray(),
  'response' => $response->toArray(),
- ];
-
- $this->storage->storeRecording($recording);
+ ]);
  }
 
- /**
- * Returns the name of the current cassette.
- *
- * @return string current cassette name
- */
  public function getName(): string
  {
  return $this->name;
  }
 
- /**
- * Returns true if the cassette was created recently.
- */
  public function isNew(): bool
  {
  return $this->storage->isNew();
  }
 
  /**
- * Returns a list of callbacks to configured request matchers.
- *
- * @return callable[] list of callbacks to configured request matchers
+ * @return callable[]
  */
  protected function getRequestMatchers(): array
  {

src/VCR/CodeTransform/AbstractCodeTransform.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace VCR\CodeTransform;
 
 use function stream_get_filters;

src/VCR/CodeTransform/CurlCodeTransform.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace VCR\CodeTransform;
 
 use VCR\Util\Assertion;

src/VCR/CodeTransform/SoapCodeTransform.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace VCR\CodeTransform;
 
 use VCR\Util\Assertion;