[2.x] Adds strict types using Phpstan

.github/workflows/cs.yml

@@ -12,11 +12,8 @@ jobs:
     steps:
     - uses: actions/checkout@v2
 
-    - name: Install CS fixer
-      run: composer global require friendsofphp/php-cs-fixer
-
     - name: Run CS fixer
-      run: ~/.composer/vendor/bin/php-cs-fixer fix
+      run: composer lint
 
     - name: Commit changes
       uses: EndBug/add-and-commit@v7

.github/workflows/tests.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php: ['7.4', '8.0']
+        php: ['8.0']
 
     name: PHP ${{ matrix.php }}
 
@@ -32,5 +32,5 @@ jobs:
       - name: Install dependencies
         run: composer install --prefer-dist --no-progress --no-suggest
 
-      - name: Run Pest
-        run: php vendor/bin/pest
+      - name: Run tests
+        run: composer test:ci

.gitignore

@@ -1,4 +1,4 @@
 vendor/
 composer.lock
 .php-cs-fixer.cache
-.phpunit.result.cache
+.phpunit.result.cache

.php-cs-fixer.dist.php

@@ -1,23 +1,40 @@
 <?php
 
+declare(strict_types=1);
+
 $finder = PhpCsFixer\Finder::create()
-    ->in(__DIR__ . DIRECTORY_SEPARATOR . 'tests')
-    ->in(__DIR__ . DIRECTORY_SEPARATOR . 'src')
+    ->in('src')
+    ->in('tests')
     ->append(['.php-cs-fixer.dist.php']);
 
 $rules = [
     '@Symfony' => true,
+    'declare_strict_types' => true,
     'phpdoc_no_empty_return' => false,
     'array_syntax' => ['syntax' => 'short'],
     'yoda_style' => false,
     'concat_space' => ['spacing' => 'one'],
     'not_operator_with_space' => false,
-    'php_unit_method_casing' => ['case' => 'snake_case'],
+    'increment_style' => ['style' => 'post'],
+    'phpdoc_no_alias_tag' => false,
+    'phpdoc_align' => [
+        'align' => 'vertical',
+        'tags' => [
+            'param',
+            'property',
+            'property-read',
+            'property-write',
+            'return',
+            'throws',
+            'type',
+            'var',
+            'method',
+        ],
+    ],
+    'final_class' => true,
+    'global_namespace_import' => [
+        'import_classes' => true,
+    ],
 ];
 
-$rules['increment_style'] = ['style' => 'post'];
-
-return (new PhpCsFixer\Config())
-    ->setUsingCache(true)
-    ->setRules($rules)
-    ->setFinder($finder);
+return (new PhpCsFixer\Config())->setFinder($finder)->setRules($rules);

README.md

@@ -329,7 +329,7 @@ specific, so you can pass the `fake` method an array of endpoints as keys
 and response objects as values:
 
 ```php
-Soap::fake(['http://endpoint.com' => Response(['foo' => 'bar'])]);
+Soap::fake(['http://endpoint.com' => Soap::response(['foo' => 'bar'])]);
 ```
 
 In the above example, any SOAP request made to `http://endpoint.com` will
@@ -339,13 +339,13 @@ be returned instead.
 What if you want to specify the SOAP action too? Easy! Just add `:{ActionName}` after your endpoint, like so:
 
 ```php
-Soap::fake(['http://endpoint.com:Details' => Response(['foo' => 'bar'])]);
+Soap::fake(['http://endpoint.com:Details' => Soap::response(['foo' => 'bar'])]);
 ```
 Now, only SOAP requests to the `Details` actions will be mocked.
 
 You can also specify multiple actions with the `|` operator:
 ```php
-Soap::fake(['http://endpoint.com:Details|Information|Overview' => Response(['foo' => 'bar'])]);
+Soap::fake(['http://endpoint.com:Details|Information|Overview' => Soap::response(['foo' => 'bar'])]);
 ```
 Now, only SOAP requests to the `Details`, `Information` and `Overview` actions will be mocked.
 

composer.json

@@ -14,15 +14,17 @@
         }
     },
     "require": {
-        "php": "^7.4|^8.0",
+        "php": "^8.0",
         "illuminate/support": "^8.16"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.4",
         "orchestra/testbench": "^6.5",
         "spatie/ray": "^1.17",
         "ext-soap": "*",
-        "pestphp/pest": "^1.0"
+        "pestphp/pest": "^1.0",
+        "phpstan/phpstan": "^0.12.99",
+        "friendsofphp/php-cs-fixer": "^3.2"
     },
     "prefer-stable": true,
     "authors": [
@@ -35,10 +37,28 @@
             "email": "[email protected]"
         }
     ],
+    "scripts": {
+        "lint": "./vendor/bin/php-cs-fixer fix --allow-risky=yes",
+        "test:lint": "./vendor/bin/php-cs-fixer fix -v --dry-run --allow-risky=yes",
+        "test:unit": "./vendor/bin/pest --exclude=integration",
+        "test:integration": "./vendor/bin/pest --group=integration",
+        "test:types": "./vendor/bin/phpstan analyse",
+        "test:ci": [
+            "@test:lint",
+            "@test:unit",
+            "@test:integration",
+            "@test:types"
+        ],
+        "test": [
+            "@lint",
+            "@test:ci"
+        ]
+    },
     "extra": {
         "laravel": {
             "providers": [
-                "RicorocksDigitalAgency\\Soap\\Providers\\SoapServiceProvider"
+                "RicorocksDigitalAgency\\Soap\\Providers\\SoapServiceProvider",
+                "RicorocksDigitalAgency\\Soap\\Providers\\SoapRayServiceProvider"
             ],
             "aliases": [
                 "RicorocksDigitalAgency\\Soap\\Facades\\Soap"

phpstan.neon.dist

@@ -0,0 +1,5 @@
+parameters:
+    paths:
+        - src
+
+    level: max

src/Contracts/Builder.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RicorocksDigitalAgency\Soap\Contracts;
+
+interface Builder
+{
+    /**
+     * @param array<array<mixed>|Soapable>|Soapable $parameters
+     *
+     * @return array<string, mixed>
+     */
+    public function handle(array|Soapable $parameters): array;
+}

src/Contracts/PhpSoap/Client.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RicorocksDigitalAgency\Soap\Contracts\PhpSoap;
+
+use SoapHeader;
+
+interface Client
+{
+    public function setEndpoint(string $endpoint): static;
+
+    /**
+     * @param array<string, mixed> $options
+     */
+    public function setOptions(array $options): static;
+
+    /**
+     * Set the given headers on the request.
+     *
+     * @param array<int, SoapHeader> $headers
+     */
+    public function setHeaders(array $headers): static;
+
+    /**
+     * Make a request and return its response.
+     */
+    public function call(string $method, mixed $body): mixed;
+
+    /**
+     * Get an array of supported SOAP functions.
+     *
+     * @return array<int, string>
+     */
+    public function getFunctions(): array;
+
+    public function __getLastRequest(): ?string;
+
+    public function __getLastResponse(): ?string;
+
+    public function __getLastRequestHeaders(): ?string;
+
+    public function __getLastResponseHeaders(): ?string;
+}

src/Contracts/Request.php

@@ -0,0 +1,79 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RicorocksDigitalAgency\Soap\Contracts;
+
+use RicorocksDigitalAgency\Soap\Response\Response;
+use RicorocksDigitalAgency\Soap\Support\Header;
+
+interface Request
+{
+    public function to(string $endpoint): self;
+
+    /**
+     * @param array<mixed> $parameters
+     *
+     * @return mixed
+     */
+    public function __call(string $name, array $parameters);
+
+    /**
+     * @return array<int, string>
+     */
+    public function functions(): array;
+
+    /**
+     * @param array<string, mixed>|Soapable $body
+     */
+    public function call(string $method, array|Soapable $body = []): Response;
+
+    /**
+     * @param callable(Request): mixed ...$closures
+     */
+    public function beforeRequesting(callable ...$closures): self;
+
+    /**
+     * @param callable(Request, Response): mixed ...$closures
+     */
+    public function afterRequesting(callable ...$closures): self;
+
+    /**
+     * @param callable(Request): Response|Response|null $response
+     */
+    public function fakeUsing(callable|Response|null $response): self;
+
+    public function getEndpoint(): string;
+
+    public function getMethod(): string;
+
+    /**
+     * @return array<string, mixed>|Soapable
+     */
+    public function getBody(): array|Soapable;
+
+    /**
+     * @return array<string, mixed>
+     */
+    public function getOptions(): array;
+
+    public function set(string $key, mixed $value): self;
+
+    public function trace(bool $shouldTrace = true): self;
+
+    /**
+     * @param array<string, mixed> $options
+     */
+    public function withOptions(array $options): self;
+
+    public function withBasicAuth(string $login, string $password): self;
+
+    public function withDigestAuth(string $login, string $password): self;
+
+    public function withHeaders(Header ...$headers): self;
+
+    /**
+     * @return array<int, Header>
+     */
+    public function getHeaders(): array;
+}

src/Contracts/Soapable.php

@@ -1,8 +1,10 @@
 <?php
 
+declare(strict_types=1);
+
 namespace RicorocksDigitalAgency\Soap\Contracts;
 
 interface Soapable
 {
-    public function toSoap();
+    public function toSoap(): mixed;
 }

src/Facades/Soap.php

@@ -1,20 +1,24 @@
 <?php
 
+declare(strict_types=1);
+
 namespace RicorocksDigitalAgency\Soap\Facades;
 
 use Illuminate\Support\Facades\Facade;
-use RicorocksDigitalAgency\Soap\Header;
-use RicorocksDigitalAgency\Soap\HeaderSet;
-use RicorocksDigitalAgency\Soap\Inclusion;
-use RicorocksDigitalAgency\Soap\OptionSet;
+use RicorocksDigitalAgency\Soap\Contracts\Request;
 use RicorocksDigitalAgency\Soap\Parameters\Node;
-use RicorocksDigitalAgency\Soap\Request\Request;
+use RicorocksDigitalAgency\Soap\Response\Response;
+use RicorocksDigitalAgency\Soap\Support\Header;
+use RicorocksDigitalAgency\Soap\Support\Scopes\HeaderSet;
+use RicorocksDigitalAgency\Soap\Support\Scopes\Inclusion;
+use RicorocksDigitalAgency\Soap\Support\Scopes\OptionSet;
+use SoapVar;
 
 /**
  * Class Soap.
  *
  * @method static Request to(string $endpoint)
- * @method static Header header(?string $name = null, ?string $namespace = null, $data = null, bool $mustUnderstand = false, ?string $actor = null)
+ * @method static Header header(string $name = '', string $namespace = '', array|SoapVar $data = null, bool $mustUnderstand = false, string|int $actor = null)
  * @method static HeaderSet headers(Header ...$headers)
  * @method static Node node(array $attributes = [])
  * @method static Inclusion include(array $parameters)
@@ -26,8 +30,9 @@
  * @method static void assertNothingSent()
  * @method static void assertSent(callable $callback)
  * @method static void assertNotSent(callable $callback)
+ * @method static Response response(array|stdClass $response)                                                                                                  Create a new SOAP response to be returned when faking requests.
  */
-class Soap extends Facade
+final class Soap extends Facade
 {
     protected static function getFacadeAccessor()
     {