Rewrite exercise to use league/route and symfony/string (#106)

* Rewrite exercise to use league/route and symfony/string
* Update failure class
* Delete & ignore lock files
* Don't store solution composer.lock files

Author: AydinHassan

.gitignore

@@ -5,4 +5,7 @@ program.php
 program.js
 /solution
 exercises/*/solution/vendor
+exercises/*/solution/composer.lock
+/test/solutions/*/*/vendor
+/test/solutions/*/*/composer.lock
 .phpunit.result.cache

composer.json

@@ -41,11 +41,10 @@
         "unit-tests": "phpunit",
         "cs" : [
             "phpcs src --standard=PSR12",
-            "phpcs test --standard=PSR12"
-        ],
+            "phpcs test --standard=PSR12 --ignore='test/solutions'"        ],
         "cs-fix" : [
             "phpcbf src --standard=PSR12 --encoding=UTF-8",
-            "phpcbf test --standard=PSR12 --encoding=UTF-8"
+            "phpcbf test --standard=PSR12 --encoding=UTF-8 --ignore='test/solutions'"
         ],
         "static": "phpstan --ansi analyse --level max src"
     }

exercises/dependency-heaven/problem/problem.md

@@ -1,4 +1,4 @@
-Write an HTTP **server** that serves JSON data when it receives a POST request to `/reverse`, `/swapcase` and `/titleize`. 
+Write an HTTP **server** that serves JSON data when it receives a POST request to `/reverse`, `/snake` and `/titleize`. 
 
 The POST data will contain a single parameter `data` which you will need to manipulate depending on the endpoint.
 
@@ -12,13 +12,13 @@ A request with `data = "PHP School is awesome!"` should return the response:
 }
 ```
 
-### /swapcase  
+### /snake  
 
 A request with `data = "No, It Really Is..."` should return the response:
 
 ```json
 {
-  "result": "nO, iT rEALLY iS..."
+  "result": "no_it_really_is"
 }
 ```
 
@@ -32,9 +32,61 @@ A request with `data = "you know you love it, don't you?"` should return the res
 }
 ```
 
-You should use the routing library `klein/klein` for this task pulling it in as a dependency through Composer. 
+You should use the routing library `league/route` for this task, pulling it in as a dependency through Composer. `league/route` allows us to define actions which respond to requests based on the request URI and HTTP method.
 
-You will also be required to use `danielstjules/stringy` to manipulate the data as this correctly handles multibyte characters. 
+The library works by accepting a PSR7 request and returns to you a PSR7 response. It is up to you to marshal the request object and output the response to the browser.
+
+There are a few other components we need, in order to use `league/route`:
+
+ * **laminas/laminas-diactoros** - For the PSR7 requests and responses.
+ * **laminas/laminas-httphandlerrunner** - For outputting the PSR7 response to the browser.
+
+`laminas/laminas-diactoros` is a PSR7 implementation. PSR's are standards defined by the PHP-FIG, a committee of PHP projects, attempting to increase interoperability in the PHP ecosystem. PSR7 is a standard for modelling HTTP requests. We can use the `laminas/laminas-diactoros` package to marshal a PSR7 request object from the PHP super globals like so:
+
+```php
+$request = \Laminas\Diactoros\ServerRequestFactory::fromGlobals();
+```
+
+`$request` is now a PSR7 request, that can be used with `league/route`.
+
+`laminas/laminas-httphandlerrunner` provides a simple method to output the PSR7 response to the browser, handling headers, status codes and the content. Use it like so:
+
+```php
+(new \Laminas\HttpHandlerRunner\Emitter\SapiEmitter())->emit($response);
+```
+
+Where `$response` is a PSR7 response.
+
+In between this, you will need to define your routes and execute the dispatching mechanism to receive a response. Refer to the `league\route` [documentation](https://route.thephpleague.com/5.x/usage/).
+
+Each route action will be passed the PSR7 request where you can access the request parameters and body. To access the `data` key from the request body, you would use the following:
+
+```php
+$data = $request->getParsedBody()['data'] ?? '';
+```
+
+In each action, you are expected to return a PSR7 response. `laminas/laminas-diactoros` provides a few ways to accomplish this:
+
+A text response:
+
+```php
+$response = new \Laminas\Diactoros\Response('My Content');
+```
+
+A JSON response:
+
+```php
+$response = (new \Laminas\Diactoros\Response(json_encode(['desert' => 'cookies'])))
+    ->withAddedHeader('Content-Type', 'application/json; charset=utf-8'');
+```
+
+Or you could use the helper class, which takes care of encoding and setting the correct headers:
+
+```php
+$response = (new \Laminas\Diactoros\Response\JsonResponse(['desert' => 'cookies']));
+```
+
+Finally, you will also be required to use `symfony/string` to manipulate the data as this correctly handles multibyte characters. 
 
 ----------------------------------------------------------------------
 ## HINTS
@@ -46,8 +98,10 @@ Use `composer init` to create your `composer.json` file with interactive search.
 For more details look at the docs for...
 
 * **Composer** - [https://getcomposer.org/doc/01-basic-usage.md](https://getcomposer.org/doc/01-basic-usage.md) 
-* **Klein** - [https://github.com/chriso/klein.php](https://github.com/chriso/klein.php)
-* **Stringy** - [https://github.com/danielstjules/Stringy](https://github.com/danielstjules/Stringy)
+* **League Route** - [https://route.thephpleague.com/5.x/usage/](https://route.thephpleague.com/5.x/usage/)
+* **Symfony String** - [https://symfony.com/doc/current/components/string.html](https://symfony.com/doc/current/components/string.html)
+* **PSR** - [https://www.php-fig.org/psr/](https://www.php-fig.org/psr/)
+* **PSR 7** - [https://www.php-fig.org/psr/psr-7/](https://www.php-fig.org/psr/psr-7/)
 
 Oh, and don't forget to use the Composer autoloader with:
 

exercises/dependency-heaven/solution/composer.json

@@ -2,8 +2,10 @@
     "name": "learn-you-php/dependency-heaven",
     "description": "String manipulation with Composer",
     "require": {
-        "danielstjules/stringy": "^2.1",
-        "klein/klein": "^2.1"
+        "symfony/string": "^5.0 | ^6.0",
+        "league/route": "^5.1",
+        "laminas/laminas-diactoros": "^2.4",
+        "laminas/laminas-httphandlerrunner": "^1.2 | ^2.4"
     },
     "authors": [
         {

exercises/dependency-heaven/solution/composer.lock

@@ -1,25 +1,45 @@
 <?php
 
-// Require composer autoloader
 require __DIR__ . '/vendor/autoload.php';
 
-use Klein\Klein;
-use Klein\Request;
-use Klein\Response;
-use Stringy\Stringy as S;
+use Laminas\Diactoros\Response\JsonResponse;
+use Laminas\Diactoros\ServerRequestFactory;
+use Laminas\HttpHandlerRunner\Emitter\SapiEmitter;
+use League\Route\Router;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
 
-$klein = new Klein();
+use function Symfony\Component\String\s;
 
-$klein->respond('POST', '/reverse', function (Request $req, Response $res) {
-    $res->json(['result' => (new S($req->param('data', '')))->reverse()->__toString()]);
+$request = ServerRequestFactory::fromGlobals();
+
+$router = new Router();
+
+$router->post('/reverse', function (ServerRequestInterface $request): ResponseInterface {
+    $str = $request->getParsedBody()['data'] ?? '';
+
+    return new JsonResponse([
+        'result' => s($str)->reverse()->toString()
+    ]);
 });
 
-$klein->respond('POST', '/swapcase', function (Request $req, Response $res) {
-    $res->json(['result' => (new S($req->param('data', '')))->swapCase()->__toString()]);
+$router->post('/snake', function (ServerRequestInterface $request): ResponseInterface {
+    $str = $request->getParsedBody()['data'] ?? '';
+
+    return new JsonResponse([
+        'result' => s($str)->snake()->toString()
+    ]);
 });
 
-$klein->respond('POST', '/titleize', function (Request $req, Response $res) {
-    $res->json(['result' => (new S($req->param('data', '')))->titleize()->__toString()]);
+
+$router->post('/titleize', function (ServerRequestInterface $request): ResponseInterface {
+    $str = $request->getParsedBody()['data'] ?? '';
+
+    return new JsonResponse([
+        'result' => s($str)->title(true)->toString()
+    ]);
 });
 
-$klein->dispatch();
+$response = $router->dispatch($request);
+
+(new SapiEmitter())->emit($response);