Merge pull request #16 from php-school/constructor-property-prmomtion

Constructor property prmomtion

Author: AydinHassan

app/bootstrap.php

@@ -21,12 +21,14 @@
 
 use PhpSchool\PHP8Appreciate\Exercise\AMatchMadeInHeaven;
 use PhpSchool\PHP8Appreciate\Exercise\HaveTheLastSay;
+use PhpSchool\PHP8Appreciate\Exercise\PhpPromotion;
 use PhpSchool\PhpWorkshop\Application;
 
 $app = new Application('PHP8 Appreciate', __DIR__ . '/config.php');
 
 $app->addExercise(AMatchMadeInHeaven::class);
 $app->addExercise(HaveTheLastSay::class);
+$app->addExercise(PhpPromotion::class);
 
 $art = <<<ART
         _ __ _

app/config.php

@@ -3,6 +3,7 @@
 use PhpSchool\PHP8Appreciate\AstService;
 use PhpSchool\PHP8Appreciate\Exercise\AMatchMadeInHeaven;
 use PhpSchool\PHP8Appreciate\Exercise\HaveTheLastSay;
+use PhpSchool\PHP8Appreciate\Exercise\PhpPromotion;
 use Psr\Container\ContainerInterface;
 use function DI\create;
 use function DI\factory;
@@ -18,5 +19,7 @@
     HaveTheLastSay::class => function (ContainerInterface $c) {
         return new HaveTheLastSay($c->get(PhpParser\Parser::class));
     },
-
+    PhpPromotion::class => function (ContainerInterface $c) {
+        return new PhpPromotion($c->get(PhpParser\Parser::class));
+    },
 ];

composer.json

@@ -26,7 +26,8 @@
     "require-dev": {
         "phpunit/phpunit": "^9",
         "squizlabs/php_codesniffer": "^3.5",
-        "phpstan/phpstan": "^0.12.52"
+        "phpstan/phpstan": "^0.12.52",
+        "timeweb/phpstan-enum": "^2.2"
     },
     "autoload": {
         "psr-4": {

composer.lock

@@ -0,0 +1,22 @@
+<?php
+
+class RowVisitor
+{
+    private $visitor;
+
+    private $key;
+
+    protected $basePath;
+
+    public function __construct(\Closure $visitor, string $key, array $config = [])
+    {
+        $this->visitor = $visitor;
+        $this->key = $key;
+        $this->basePath = $config['basePath'] ?? '';
+    }
+
+    public function readCsv(string $filePath)
+    {
+        // noop
+    }
+}

exercises/php-gets-a-promotion/initial/php-gets-a-promotion.php

@@ -0,0 +1,27 @@
+You have been given a piece of code (look for `php-gets-a-promotion.php` in your working directory) which provides a class written for PHP 7.
+The code itself works well, assigning constructor arguments to the class properties. Your job is to write the code in a more terse format, by using the newly introduced
+constructor property promotion in PHP 8.
+
+The code is a class that would hypothetically be used to call a provided `\Closure` when reading a row of a CSV, passing in the appropriate cell value, but the implementation logic is not important and thus left out.
+
+Focus on converting the constructor to a terse format using constructor property promotion.
+
+### The advantages of constructor property promotion
+
+* Less boilerplate code is required when writing a class
+* It still provides the required information for static analysis / runtime type parsing
+* Is compatible in conjunction with properties that cannot be promoted
+
+
+----------------------------------------------------------------------
+## HINTS
+
+Documentation on the constructor property promotion feature can be found by pointing your browser here:
+[https://www.php.net/manual/en/language.oop5.decon.php#language.oop5.decon.constructor.promotion]()
+
+Remember to keep the same visibility for the properties
+
+You will be expected to make use of the constructor property promotion feature
+
+You should have less code than the provided initial code
+

exercises/php-gets-a-promotion/problem/problem.md

@@ -0,0 +1,19 @@
+<?php
+
+class RowVisitor
+{
+    protected string $basePath;
+
+    public function __construct(
+        private \Closure $visitor,
+        private string $key,
+        array $config = []
+    ) {
+        $this->basePath = $config['basePath'] ?? '';
+    }
+
+    public function readCsv(string $filePath)
+    {
+        // noop
+    }
+}

exercises/php-gets-a-promotion/solution/solution.php

@@ -7,3 +7,6 @@ parameters:
 
     excludes_analyse:
         - src/TestUtils/WorkshopExerciseTest.php
+
+includes:
+  - vendor/timeweb/phpstan-enum/extension.neon

phpstan.neon

@@ -1,12 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
-<phpunit colors="true">
-    <testsuite name="My PHP Workshop Test Suite">
-        <directory>./test</directory>
-    </testsuite>
-    <filter>
-        <whitelist addUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">./src</directory>
-        </whitelist>
-    </filter>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" colors="true" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+  <coverage includeUncoveredFiles="true">
+    <include>
+      <directory suffix=".php">./src</directory>
+    </include>
+  </coverage>
+  <testsuite name="My PHP Workshop Test Suite">
+    <directory>./test</directory>
+  </testsuite>
 </phpunit>

phpunit.xml

@@ -89,7 +89,7 @@ public function tearDown(): void
 
     public function getType(): ExerciseType
     {
-        return new ExerciseType(ExerciseType::CLI);
+        return ExerciseType::CLI();
     }
 
     public function getRequiredFunctions(): array