Merge branch 'feature/adapt-to-specification'

Author: Valerii Maslenykov

.github/workflows/main.yml

@@ -26,7 +26,10 @@ jobs:
                 run: composer install --no-interaction
 
             -   name: Lint code
-                run: ./vendor/bin/phpcs --standard=PSR12 ./src ./tests
+                run: composer run lint
+
+            -   name: PHPStan
+                run: composer run phpstan
 
     test:
         runs-on: ${{ matrix.os }}

.php-cs-fixer.php

@@ -1,7 +1,7 @@
 <?php
 
 $finder = PhpCsFixer\Finder::create()
-    ->in([__DIR__ . '/src', __DIR__ . '/tests']);
+    ->in([__DIR__ . '/src', __DIR__ . '/tests', __DIR__ . '/examples']);
 
 $config = new PhpCsFixer\Config();
 return $config->setRules([

CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Source code with the implementation of getContents and getContent
+- Flexible caching with PSR-16
+- Custom HTTP client with PSR-18
+- Examples
+- Documentation (README.md)
+- GitHub Actions pipeline to check code style + Unit Testing at different PHP versions + different platforms
+

composer.json

@@ -37,6 +37,7 @@
     "require-dev": {
         "guzzlehttp/guzzle": "^7.5",
         "phpspec/prophecy": "^1.17",
+        "phpstan/phpstan": "^1.10",
         "phpunit/phpunit": "^8.5",
         "squizlabs/php_codesniffer": "^3.7"
     },
@@ -54,7 +55,9 @@
     "scripts": {
         "test": "vendor/bin/phpunit",
         "test-coverage": "vendor/bin/phpunit --coverage-html coverage",
-        "lint": "./vendor/bin/phpcs --standard=./phpcs.xml ./src ./tests",
+        "lint": "./vendor/bin/phpcs --standard=./phpcs.xml ./src ./tests ./examples",
+        "phpstan": " vendor/bin/phpstan analyse -c ./phpstan-src.neon &&  vendor/bin/phpstan analyse -c ./phpstan-tests.neon",
+        "dev-test": "composer run test-coverage && composer run lint && composer run phpstan",
         "lint-fix": "./tools/php-cs-fixer/vendor/bin/php-cs-fixer fix"
     },
     "config": {

composer.lock

@@ -1,11 +1,14 @@
 <?php
 
+declare(strict_types=1);
+
+namespace JoystickCustomHttpClient;
+
 use Psr\Http\Client\ClientInterface;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 use Symfony\Component\HttpClient\Psr18Client;
 
-
 class PerformanceMeasurementClient implements ClientInterface
 {
     private $httpClient;

examples/custom-http-client/PerformanceMeasurementClient.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 use Symfony\Component\HttpClient\HttpClient;
 use Symfony\Component\HttpClient\Psr18Client;
 

examples/custom-http-client/main.php

@@ -1,5 +1,8 @@
-<?php 
+<?php
 
-function getContentIdsFromEnv() {
+declare(strict_types=1);
+
+function getContentIdsFromEnv()
+{
     return explode(',', getenv('CONTENT_IDS'));
-}
+}

examples/helpers/get-content-ids.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 // Uses library from the parent folder, not from the packagist or repository
 require(__DIR__ . '/../../vendor/autoload.php');
 require(__DIR__ . '/../helpers/get-content-ids.php');

examples/zero-configuration/main.php

@@ -0,0 +1,7 @@
+parameters:
+    ignoreErrors:
+        - '#.+is not subtype of Throwable#'
+    level: 9
+    paths:
+        - src
+