Merge pull request #2 from agdobrynin/development

Feat/server request interface from globals (#1)

Author: agdobrynin

.php-cs-fixer.dist.php

@@ -11,7 +11,6 @@
     ->setRules([
         '@PhpCsFixer' => true,
         'declare_strict_types' => true,
-        'php_unit_test_class_requires_covers' => false,
         'native_function_invocation' => [
             'include' => ['@all'],
             'scope' => 'all',
@@ -20,7 +19,10 @@
             'import_classes' => true,
             'import_constants' => true,
             'import_functions' => true,
-        ]
+        ],
+        'yoda_style' => [
+            'always_move_variable' => true,
+        ],
     ])
     ->setRiskyAllowed(true)
     ->setFinder($finder)

README.md

@@ -1,16 +1,47 @@
-# 🧙🏻‍♂️ Build PSR-7 ServerRequestInterface from global PHP variables.
-
-`kaspi/psr7-globals` help build PSR7 ServerRequestInterface compatible class.
+# 🧙🏻‍♂️ Building ServerRequest class which implement PSR-7 ServerRequestInterface from global PHP variables.
 
 Require PHP 8.1 or newest.
 
+additional links:
 - [PSR-7](https://www.php-fig.org/psr/psr-7)
 - [PSR-17](https://www.php-fig.org/psr/psr-17) 
 
 ## Installation
 
 ```shell
-composer kaspi/psr7-globals
+composer kaspi/psr7-wizard
+```
+
+## Usage
+
+```php
+// Example build ServerRequest class with package kaspi/http-message
+
+$httpFactory = new \Kaspi\HttpMessage\HttpFactory();
+
+$wizard = new \Kaspi\Psr7Wizard\ServerRequestWizard(
+    serverRequestFactory: $httpFactory,
+    streamFactory: $httpFactory,
+    uploadedFileFactory: $httpFactory,
+    uriFactory: $httpFactory,  
+);
+
+/** @var \Psr\Http\Message\ServerRequestInterface $serverRequest */
+$serverRequest = $wizard->fromGlobals();
+
+//👆🏻 Or create by params
+$uploadedFiles = [
+    $httpFactory->createUploadedFile('/tmp/file1');
+];
+
+$wizard->fromParams(
+    serverParams: $serverEnv,
+    queryParams: $queryStringParams,
+    cookieParams: $cookie,
+    files: $uploadedFiles,
+    parsedBody: $parsedBody,
+    body: 'raw content'  
+);
 ```
 
 ## Development environment
@@ -29,7 +60,7 @@ composer test
 ```
 Running tests with checking code coverage by tests with a report in html format
 ```shell
-./vendor/bin/pest --compact
+./vendor/bin/pest
 ```
 Requires installed [PCOV](https://github.com/krakjoe/pcov) driver
 
@@ -78,7 +109,7 @@ Phan (_static analyzer for PHP_)
 docker-compose run --rm php vendor/bin/phan
 ```
 
-You can work in a shell in a docker container:
+You can work in a shell into a docker container:
 ```shell
 docker-compose run --rm php sh
 ```

composer.json

@@ -1,6 +1,6 @@
 {
-    "name": "kaspi/psr7-globals",
-    "description": "Creating PSR-7 ServerRequest from global variables",
+    "name": "kaspi/psr7-wizard",
+    "description": "Make PSR-7 ServerRequest from global variables",
     "keywords": ["http-message", "psr-7", "psr-17"],
     "type": "library",
     "require": {
@@ -11,12 +11,12 @@
     "license": "MIT",
     "autoload": {
         "psr-4": {
-            "Kaspi\\Psr7Globals\\": "src"
+            "Kaspi\\Psr7Wizard\\": "src"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "Tests\\Kaspi\\Psr7Globals\\": "tests/"
+            "Tests\\Kaspi\\Psr7Wizard\\": "tests/"
         }
     },
     "authors": [