Adding test coverage for PHP 8.4

brentscheffler · brentscheffler · commit 4a4fd0b8fc40 · 2025-02-27T12:43:26.000-08:00
Bumping dev dependencies
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -14,7 +14,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-version: [8.2, 8.3]
+        php-version: [8.2, 8.3, 8.4]
 
     runs-on: ubuntu-latest
 
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,5 @@
 vendor/
 build/
+.vscode/
 .phpunit.cache/
-composer.lock
-.phpunit.result.cache
+composer.lock
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 nimbly.io
+Copyright (c) 2025 nimbly.io
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/Makefile b/Makefile
@@ -1,8 +1,8 @@
+analyze:
+	vendor/bin/psalm
+
 test:
-	vendor/bin/phpunit
+	vendor/bin/phpunit --display-deprecations
 
 coverage:
-	php -d xdebug.mode=coverage vendor/bin/phpunit --coverage-clover=build/logs/clover.xml
-
-analyze:
-	vendor/bin/psalm
+	php -d xdebug.mode=coverage vendor/bin/phpunit --display-deprecations --coverage-clover=build/logs/clover.xml
diff --git a/README.md b/README.md
@@ -1,13 +1,19 @@
 # Shuttle
 [![Latest Stable Version](https://img.shields.io/packagist/v/nimbly/Shuttle.svg?style=flat-square)](https://packagist.org/packages/nimbly/Shuttle)
-[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/nimbly/shuttle/php.yml?style=flat-square)](https://github.com/nimbly/Shuttle/actions/workflows/php.yml)
+[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/nimbly/shuttle/coverage.yml?style=flat-square)](https://github.com/nimbly/Shuttle/actions/workflows/coverage.yml)
 [![Codecov branch](https://img.shields.io/codecov/c/github/nimbly/shuttle/master?style=flat-square)](https://app.codecov.io/github/nimbly/Shuttle)
 [![License](https://img.shields.io/github/license/nimbly/Shuttle.svg?style=flat-square)](https://packagist.org/packages/nimbly/Shuttle)
 
 
 A simple PSR-18 HTTP client library.
 
+## Requirements
+
+* PHP 8.2+
+* ext-curl
+
 ## Installation
+
 ```bash
 composer require nimbly/shuttle
 ```
@@ -17,6 +23,7 @@ composer require nimbly/shuttle
 * cURL (default) and Stream Context handlers supported.
 * Middleware support out of the box.
 * Easy body transformations when creating requests with JsonBody and FormBody helper classes.
+* Support for multipart form bodies.
 
 ## Not features
 * Asynchronous calls.
diff --git a/composer.json b/composer.json
@@ -32,9 +32,8 @@
         }
     },
     "require-dev": {
-        "vimeo/psalm": "^5.0",
-        "phpunit/phpunit": "^9.0",
-        "php-coveralls/php-coveralls": "^2.1",
+        "vimeo/psalm": "^6.0",
+        "phpunit/phpunit": "^10.0",
         "symfony/var-dumper": "^5.0",
         "guzzlehttp/psr7": "^2.7"
 	},
diff --git a/phpunit.xml b/phpunit.xml
@@ -1,27 +1,23 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.4/phpunit.xsd"
-         bootstrap="vendor/autoload.php"
-         cacheResultFile=".phpunit.cache/test-results"
-         executionOrder="depends,defects"
-         forceCoversAnnotation="true"
-         beStrictAboutCoversAnnotation="true"
-         beStrictAboutOutputDuringTests="true"
-         beStrictAboutTodoAnnotatedTests="true"
-         failOnRisky="true"
-         failOnWarning="true"
-         verbose="true"
-		 colors="true">
-    <testsuites>
-        <testsuite name="default">
-            <directory suffix="Test.php">tests</directory>
-        </testsuite>
-    </testsuites>
-
-    <coverage cacheDirectory=".phpunit.cache/code-coverage"
-              processUncoveredFiles="true">
-        <include>
-            <directory suffix=".php">src</directory>
-        </include>
-    </coverage>
+	xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
+	bootstrap="vendor/autoload.php"
+	executionOrder="depends,defects"
+	beStrictAboutOutputDuringTests="true"
+	failOnRisky="true"
+	failOnWarning="true"
+	colors="true"
+	cacheDirectory=".phpunit.cache"
+	requireCoverageMetadata="true"
+	beStrictAboutCoverageMetadata="true">
+  <testsuites>
+    <testsuite name="default">
+      <directory suffix="Test.php">tests</directory>
+    </testsuite>
+  </testsuites>
+  <source>
+    <include>
+      <directory suffix=".php">src</directory>
+    </include>
+  </source>
 </phpunit>
diff --git a/psalm.xml b/psalm.xml
@@ -7,6 +7,7 @@
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
 	findUnusedBaselineEntry="false"
 	findUnusedCode="false"
+    ensureOverrideAttribute="false"
 >
     <projectFiles>
         <directory name="src" />
diff --git a/src/Body/BufferBody.php b/src/Body/BufferBody.php
@@ -39,7 +39,10 @@ public function getContentType(): string
 	public function getMultiPart(string $boundary, ?string $name = null): string
 	{
 		return \sprintf(
-			"\r\n--%s\r\nContent-Disposition: form-data; name=\"%s\"\r\nContent-Type: %s\r\n\r\n%s",
+			"\r\n--%s".
+			"\r\nContent-Disposition: form-data; name=\"%s\"".
+			"\r\nContent-Type: %s".
+			"\r\n\r\n%s",
 			$boundary,
 			$name ?? "form",
 			$this->getContentType(),
diff --git a/src/Body/FileUploadBody.php b/src/Body/FileUploadBody.php
@@ -7,7 +7,7 @@
 use Psr\Http\Message\StreamInterface;
 
 /**
- * Useable only within in a MultpartFormBody.
+ * Useable only within a MultpartFormBody instance.
  */
 class FileUploadBody extends BufferBody
 {
@@ -62,7 +62,11 @@ public function getMultiPart(string $boundary, ?string $name = null): string
 		}
 
 		return \sprintf(
-			"\r\n--%s\r\nContent-Disposition: form-data; name=\"%s\"; filename=\"%s\"\r\nContent-Type: %s\r\nContent-Length: %s\r\n\r\n%s",
+			"\r\n--%s".
+			"\r\nContent-Disposition: form-data; name=\"%s\"; filename=\"%s\"".
+			"\r\nContent-Type: %s".
+			"\r\nContent-Length: %s".
+			"\r\n\r\n%s",
 			$boundary,
 			$name ?? "file",
 			$this->file_name,
diff --git a/src/Body/FormBody.php b/src/Body/FormBody.php
@@ -35,9 +35,14 @@ public function getMultiPart(string $boundary, ?string $name = null): string
 		$multiPart = "";
 
 		foreach( $formFields as $name => $value ){
-			$multiPart .= "\r\n--{$boundary}\r\n";
-			$multiPart .= "Content-Disposition: form-data; name=\"" . $name . "\"" . "\r\n\r\n";
-			$multiPart .= $value;
+			$multiPart .= \sprintf(
+				"\r\n--%s" .
+				"\r\nContent-Disposition: form-data; name=\"%s\"" .
+				"\r\n\r\n%s",
+				$boundary,
+				$name,
+				$value
+			);
 		}
 
 		return $multiPart;
diff --git a/src/Body/JsonBody.php b/src/Body/JsonBody.php
@@ -18,7 +18,7 @@ public function __construct(JsonSerializable|array $data, string $content_type =
 	{
 		$buffer = \json_encode($data, JSON_UNESCAPED_SLASHES);
 
-		if( $buffer === false ){
+		if( \json_last_error() !== JSON_ERROR_NONE || $buffer === false ){
 			throw new EncodingException("Failed to encode body as JSON.");
 		}
 
diff --git a/src/Handler/CurlHandler.php b/src/Handler/CurlHandler.php
@@ -103,23 +103,23 @@ protected function buildCurlRequestOptions(RequestInterface $request, ResponseIn
 			/**
 			 * Callback when data is received.
 			 *
-			 * @param resource $handler
+			 * @param CurlHandle $handle
 			 * @param string $data
 			 * @return int
 			 */
-			CURLOPT_WRITEFUNCTION => function(CurlHandle $handler, string $data) use (&$response): int {
+			CURLOPT_WRITEFUNCTION => function(CurlHandle $handle, string $data) use (&$response): int {
 
 				return $response->getBody()->write($data);
 			},
 
 			/**
 			 * Callback when headers are received.
 			 *
-			 * @param resource $handler
+			 * @param CurlHandle $handle
 			 * @param string $header
 			 * @return int
 			 */
-			CURLOPT_HEADERFUNCTION => function(CurlHandle $handler, string $header) use (&$response): int {
+			CURLOPT_HEADERFUNCTION => function(CurlHandle $handle, string $header) use (&$response): int {
 
 				if( \preg_match("/^HTTP\/([\d\.]+) ([\d]{3})(?: ([\w\h]+))?\R?+$/i", \trim($header), $httpResponse) ){
 					$response = $response->withStatus((int) $httpResponse[2], $httpResponse[3] ?? "");
@@ -153,6 +153,7 @@ protected function buildCurlRequestOptions(RequestInterface $request, ResponseIn
 	private function buildRequestHttpProtocolVersion(RequestInterface $request): int
 	{
 		return match($request->getProtocolVersion()) {
+			"3", "3.0" => CURL_HTTP_VERSION_3,
 			"2", "2.0" => CURL_HTTP_VERSION_2,
 			"1", "1.0" => CURL_HTTP_VERSION_1_0,
 			default => CURL_HTTP_VERSION_1_1
diff --git a/tests/MiddlewareTest.php b/tests/MiddlewareTest.php
@@ -2,13 +2,15 @@
 
 namespace Nimbly\Shuttle\Tests;
 
+use ReflectionClass;
 use Nimbly\Capsule\Request;
+use Nimbly\Shuttle\Shuttle;
 use Nimbly\Capsule\Response;
 use PHPUnit\Framework\TestCase;
-use ReflectionClass;
+use Psr\Http\Message\RequestInterface;
 use Nimbly\Shuttle\Handler\MockHandler;
-use Nimbly\Shuttle\Shuttle;
-use Nimbly\Shuttle\Tests\src\RequestMiddleware;
+use Nimbly\Shuttle\MiddlewareInterface;
+use Psr\Http\Message\ResponseInterface;
 
 /**
  * @covers Nimbly\Shuttle\Shuttle
@@ -21,7 +23,14 @@ public function test_middleware_compiles()
 		$shuttle = new Shuttle(
 			handler: new MockHandler([new Response(200, "OK")]),
 			middleware: [
-				new RequestMiddleware
+				new class implements MiddlewareInterface
+				{
+					public function process(RequestInterface $request, callable $next): ResponseInterface
+					{
+						$response = $next($request);
+						return $response->withAddedHeader("X-Middleware", "Foo");
+					}
+				}
 			]
 		);
 
diff --git a/tests/src/RequestMiddleware.php b/tests/src/RequestMiddleware.php

Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`	`xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"`
`8`	`8`	`findUnusedBaselineEntry="false"`
`9`	`9`	`findUnusedCode="false"`
	`10`	`+ ensureOverrideAttribute="false"`
`10`	`11`	`>`
`11`	`12`	`<projectFiles>`
`12`	`13`	`<directory name="src" />`