Merge pull request #35 from php-school/fixes

AydinHassan · web-flow · commit 970f1d11f983 · 2021-07-01T20:57:31.000+01:00
Fixes
diff --git a/app/bootstrap.php b/app/bootstrap.php
@@ -25,7 +25,7 @@
 use PhpSchool\PHP8Appreciate\Exercise\CautionWithCatches;
 use PhpSchool\PHP8Appreciate\Exercise\HaveTheLastSay;
 use PhpSchool\PHP8Appreciate\Exercise\InfiniteDivisions;
-use PhpSchool\PHP8Appreciate\Exercise\PhpPromotion;
+use PhpSchool\PHP8Appreciate\Exercise\PhpGetsAPromotion;
 use PhpSchool\PHP8Appreciate\Exercise\LordOfTheStrings;
 use PhpSchool\PHP8Appreciate\Exercise\TheAttributesOfSuccess;
 use PhpSchool\PHP8Appreciate\Exercise\TheReturnOfStatic;
@@ -36,18 +36,18 @@
 
 $app = new Application('', __DIR__ . '/config.php');
 
+$app->addExercise(PhpGetsAPromotion::class);
 $app->addExercise(AMatchMadeInHeaven::class);
-$app->addExercise(HaveTheLastSay::class);
-$app->addExercise(PhpPromotion::class);
+$app->addExercise(ThrowAnExpression::class);
 $app->addExercise(CautionWithCatches::class);
-$app->addExercise(LordOfTheStrings::class);
+$app->addExercise(AllMixedUp::class);
+$app->addExercise(HaveTheLastSay::class);
 $app->addExercise(UniteTheTypes::class);
 $app->addExercise(InfiniteDivisions::class);
 $app->addExercise(ASafeSpaceForNulls::class);
-$app->addExercise(AllMixedUp::class);
-$app->addExercise(TheReturnOfStatic::class);
-$app->addExercise(ThrowAnExpression::class);
 $app->addExercise(StringifyToDemystify::class);
+$app->addExercise(LordOfTheStrings::class);
+$app->addExercise(TheReturnOfStatic::class);
 $app->addExercise(TheAttributesOfSuccess::class);
 
 $art = <<<ART
diff --git a/app/config.php b/app/config.php
@@ -6,7 +6,7 @@
 use PhpSchool\PHP8Appreciate\Exercise\CautionWithCatches;
 use PhpSchool\PHP8Appreciate\Exercise\HaveTheLastSay;
 use PhpSchool\PHP8Appreciate\Exercise\InfiniteDivisions;
-use PhpSchool\PHP8Appreciate\Exercise\PhpPromotion;
+use PhpSchool\PHP8Appreciate\Exercise\PhpGetsAPromotion;
 use PhpSchool\PHP8Appreciate\Exercise\LordOfTheStrings;
 use PhpSchool\PHP8Appreciate\Exercise\TheAttributesOfSuccess;
 use PhpSchool\PHP8Appreciate\Exercise\TheReturnOfStatic;
@@ -28,8 +28,8 @@
     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));
+    PhpGetsAPromotion::class => function (ContainerInterface $c) {
+        return new PhpGetsAPromotion($c->get(PhpParser\Parser::class));
     },
     CautionWithCatches::class => function (ContainerInterface $c) {
         return new CautionWithCatches($c->get(PhpParser\Parser::class), $c->get(\Faker\Generator::class));
diff --git a/exercises/a-match-made-in-heaven/problem/problem.md b/exercises/a-match-made-in-heaven/problem/problem.md
@@ -1,21 +1,19 @@
 You have been given a piece of code (look for `a-match-made-in-heaven.php` in your working directory) which is full of bugs.
-The code has been implemented badly, using a `switch` statement. Your job is to fix the code, by using the newly introduced 
-`match` expression in PHP 8. 
+The code has been implemented badly, using a `switch` statement. Your job is to fix the code, by using the newly introduced `match` expression in PHP 8. 
 
 The piece of code is supposed to take a string representing a keyboard keypress and convert it to its equivalent ANSI decimal code.
 
 There are only four key presses supported at the minute (enter, up, down & escape). It should stay like that for now.
 
 Focus on converting the switch statement to a match expression.
 
-The key presses will be provided as strings via command line arguments. Only one keypress will be passed on each program invocation
-but it will be randomly picked from the four supported key presses.
+The key presses will be provided as strings via command line arguments. Only one keypress will be passed on each program invocation but it will be randomly picked from the four supported key presses.
 
 ### The advantages of match
 
 * Match uses strict equality, unlike switch which uses weak comparison and can lead to subtle bugs.
 * Each match arm does not fall through without a break statement, unlike switch.
-* Match expressions must be exhaustive, if there is no default arm specified, and no arm matches the given value, an `UnhandledMatchError` is thrown
+* Match expressions must be exhaustive, if there is no default arm specified, and no arm matches the given value, an `UnhandledMatchError` is thrown.
 * Match is an expression and thus returns a value, reducing unnecessary variables and reducing the risk of accessing undefined variables.
 
 
diff --git a/exercises/a-safe-space-for-nulls/problem/problem.md b/exercises/a-safe-space-for-nulls/problem/problem.md
@@ -10,7 +10,7 @@ With the null safe operator it is possible to access variables like so:
 $capitalPopulation = $country?->capital?->population;
 ```
 
-If the `capital` property is null, the variable `$capitalPopulation` will also be null. Previously, without the null safe operator, this would be achieved like so:
+If the `$capital` property is null, the variable `$capitalPopulation` will also be null. Previously, without the null safe operator, this would be achieved like so:
 
 ```php
 $capitalPopulation = null;
@@ -44,25 +44,24 @@ Export the `$user` data to a CSV with the following columns:
 
 `First Name`, `Last Name`, `Age`, `House num`, `Addr 1`, `Addr 2`
 
- * The CSV should be comma delimited
- * The columns should read exactly as above, any mistake will trigger a failure
- * There should be one row for the column headers and one for the data
- * Any properties which are null on the user should be printed as empty fields in the CSV
- * The file should be named `users.csv` and exist next to your submission file (eg in the same directory)
+ * The CSV should be comma delimited.
+ * The columns should read exactly as above, any mistake will trigger a failure.
+ * There should be one row for the column headers and one for the data.
+ * Any properties which are null on the user should be printed as empty fields in the CSV.
+ * The file should be named `users.csv` and exist next to your submission file (eg in the same directory).
  
 And finally, the most important part, all properties which may be `NULL` should be accessed using the null safe operator!
 
 ### Advantages of the null safe operator
 
-* Much less code for simple operations where null is a valid value
+* Much less code for simple operations where null is a valid value.
 * If the operator is part of a chain anything to the right of the null will not be executed, the statements will be short-circuited.
-* Can be used on methods where null coalescing cannot `$user->getCreatedAt()->format() ?? null` where `getCreatedAt()` could return null or a `\DateTime` instance
+* Can be used on methods where null coalescing cannot `$user->getCreatedAt()->format() ?? null` where `getCreatedAt()` could return null or a `\DateTime` instance.
 
 ----------------------------------------------------------------------
 ## HINTS
 
-Remember your program will be passed no arguments. There will be a `User` object populated for you under the variable `$user`.
-It is available at the beginning of your script.
+Remember your program will be passed no arguments. There will be a `User` object populated for you under the variable `$user`. It is available at the beginning of your script.
 
 Documentation on the Null Safe Operator can be found by pointing your browser here:
 [https://www.php.net/manual/en/language.oop5.basic.php#language.oop5.basic.nullsafe]()
diff --git a/exercises/all-mixed-up/problem/problem.md b/exercises/all-mixed-up/problem/problem.md
@@ -1,6 +1,6 @@
-As alluded to earlier in `Unite The Types` PHP's type system has been constantly and consistently growing for a long time.
+PHP's type system has been constantly and consistently growing and evolving for a long time.
 
-PHP8 comes with a new type `mixed` which is essentially a union of `array|bool|callable|int|float|object|resource|string|null`. 
+PHP 8 comes with a new type `mixed` which is essentially a union of `array|bool|callable|int|float|object|resource|string|null`. 
 
 This means that any value which can be produced in PHP will pass the check. Which is exactly the same as no type check.
 
@@ -11,7 +11,7 @@ If anything - it signals intent. Your function really does accept anything. It's
 ----------------------------------------------------------------------
 Create a program which contains one function named `logParameter`. It should have one parameter, and it's type must be `mixed`.
 
-Within your function you should log the type of the parameter that was passed. For this, you can use a new PHP8 function called `get_debug_type`.
+Within your function you should log the type of the parameter that was passed. For this, you can use a new PHP 8 function called `get_debug_type`.
 
 This function will give you a string identifier representing the type of any PHP variable.
 
@@ -51,6 +51,6 @@ Documentation on `get_debug_type` can be found by pointing your browser here:
 
 You might want to delete or empty your log file each time your program starts, otherwise it will grow and grow and the comparison will fail.
 
-Think about the return type of your `adder` function - you could declare it as `void`.
+Think about the return type of your `logParameter` function - you could declare it as `void`.
 
 If you are curious how we compare the output of your program when it includes time, we simply check that it matches the format, rather than comparing exactly. More specifically, we use the regex `/\d{2}:\d{2}:\d{2}/`.
diff --git a/exercises/all-mixed-up/solution/solution.php b/exercises/all-mixed-up/solution/solution.php
@@ -1,5 +1,9 @@
 <?php
 
+if (file_exists('param.log')) {
+    unlink('param.log');
+}
+
 function logParameter(mixed $parameter): void
 {
     file_put_contents(
diff --git a/exercises/caution-with-catches/problem/problem.md b/exercises/caution-with-catches/problem/problem.md
@@ -11,7 +11,7 @@ function verify_password(string $password): bool;
 
 For this exercise this function will always throw an exception but unfortunately the exception message contains the password in plain text!
 
-To pass this exercise you will need to call the `verify_password` function with the password provided, handle the exception and output `"Given password is invalid, please try again`. 
+To pass this exercise you will need to call the `verify_password` function with the password provided, handle the exception and output `"Given password is invalid, please try again"`. 
 
 PHP 8 allows you to handle the exception without capturing the exception itself which will ensure this message is not leaked further.
 
diff --git a/exercises/have-the-last-say/problem/problem.md b/exercises/have-the-last-say/problem/problem.md
@@ -2,33 +2,30 @@ Create a program that reads a CSV file using `fgetcsv` and change the delimiter
 
 The first argument is the file name of the CSV which you should read. 
 
-The CSV file contains two columns separated with `|` (the pipe operator). The first column is `country`
-and the second column is `capital`. You should print each row to the console like the 
-following (with a new line after each row):
+The CSV file contains two columns separated with `|` (the pipe operator). The first column is `country` and the second column is `capital`. 
+
+You should print each row to the console like the following (with a new line after each row):
 
 ```
 Country: Austria, Capital: Vienna
 ```
 
 The list of countries will be picked at random, so the CSV will be different each time your program runs.
 
-When using `fgetcsv` there's a bunch of arguments which change the behaviour of the way the CSV is parsed. In our case we
-want to change the `separator` argument, which defaults to a comma `,`. We need it to be the
-pipe `|` character. 
+When using `fgetcsv` there's a bunch of arguments which change the behaviour of the way the CSV is parsed. In our case we  want to change the `separator` argument, which defaults to a comma `,`. We need it to be the pipe `|` character. 
 
-We don't want to specify the rest of the arguments, so aside from the file pointer which is the first argument,
-we only want to specify the `separator` argument.
+We don't want to specify the rest of the arguments, so aside from the file pointer which is the first argument, we only want to specify the `separator` argument.
 
 Named arguments are a great way to change argument default values without having to specify all the defaults again. 
+
 For example, if you only want to change the value of the last argument to a function,
-you can do so, without specifying all the other arguments. For example:
+you can do so, without specifying all the other arguments:
 
 ```php
-htmlspecialchars($string, ENT_COMPAT | ENT_HTML401, 'UTF-8', false);
+htmlspecialchars($string, ENT_COMPAT | ENT_HTML, 'UTF-8', false);
 ```
 
-We only want to change the last argument (double_encode) of the function to false (the default is true). However,
-we are forced to specify all the other arguments, but they have not changed from the defaults.
+We only want to change the last argument (double_encode) of the function to false (the default is true). However, we are forced to specify all the other arguments, even though they have not changed from the defaults.
 
 Named arguments allows to write the same, but in a more succinct fashion:
 
@@ -40,8 +37,8 @@ Note: only the values changed from the defaults are specified!
 
 ### Advantages of named arguments
 
-* Possible to skip defaults in between the arguments you want to change 
-* The code is better documented since the argument label is specified with the value, very useful for booleans
+* Possible to skip defaults in between the arguments you want to change.
+* The code is better documented since the argument label is specified with the value, very useful for booleans.
 
 ----------------------------------------------------------------------
 ## HINTS
@@ -52,8 +49,7 @@ You will need to open the file for writing before using `fgetcsv` you can do tha
 
 You will most likely need a loop to process all the data in the file.
 
-You will need to keep reading from the file until it has been fully read. `feof` is your friend here to know
-whether there is any data left to read.
+You will need to keep reading from the file until it has been fully read. `feof` is your friend here and will inform you whether there is any data left to read.
 
 Documentation on the `fopen` function can be found by pointing your browser here:
 [https://www.php.net/manual/en/function.fopen.php]()
@@ -67,6 +63,4 @@ Documentation on the `feof` function can be found by pointing your browser here:
 ----------------------------------------------------------------------
 ## EXTRA
 
-Although not entirely necessary for a small script, it is good practise to close
-any open file handles so that other processes can access them, you can use `fclose`
-for that.
+Although not entirely necessary for a small script, it is good practise to close any open file handles so that other processes can access them, you can use `fclose` for that.
diff --git a/exercises/lord-of-the-strings/problem/problem.md b/exercises/lord-of-the-strings/problem/problem.md
@@ -1,5 +1,4 @@
-PHP has a huge standard library with the most extravagant and highly specific string and array functions available. 
-`levenshtein` & `array_change_key_case` anyone??
+PHP has a huge standard library with the most extravagant and highly specific string and array functions available. `levenshtein` & `array_change_key_case` anyone??
 
 On the flip side, historically it has missed some very common string operations. There's always been a way to get the same results, but they are cumbersome and error prone.
 
@@ -19,7 +18,7 @@ Thankfully, PHP 8 has done away with all that nonsense. Please welcome the follo
 
 ----------------------------------------------------------------------
 
-Create a program the accepts two arguments, the first is a word, the second is a sentence (random words).
+Create a program that accepts two arguments, the first is a word, the second is a sentence (random words).
 
 You must print a table which contains the results of each of the above functions with the provided word and sentence.
 
@@ -38,7 +37,7 @@ The result column should be `true` or `false` based on the result of the corresp
 
 * Simpler and more concise.
 * Saner return types.
-* It is harder to get their usage wrong, for example checking for 0 vs false with `strpos`
+* It is harder to get their usage wrong, for example checking for 0 vs false with `strpos`.
 * The functions are faster, being implemented in C.
 * The operations require less function calls, for example no usages of `strlen` are required.
 
diff --git a/exercises/php-gets-a-promotion/initial/php-gets-a-promotion.php b/exercises/php-gets-a-promotion/initial/php-gets-a-promotion.php
@@ -2,11 +2,11 @@
 
 class RowVisitor
 {
-    private $visitor;
+    private \Closure $visitor;
 
-    private $key;
+    private string $key;
 
-    protected $basePath;
+    protected string $basePath;
 
     public function __construct(\Closure $visitor, string $key, array $config = [])
     {
diff --git a/exercises/php-gets-a-promotion/problem/problem.md b/exercises/php-gets-a-promotion/problem/problem.md
@@ -1,16 +1,18 @@
 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.
+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 feature 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 row values, 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
+* 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.
 
 
 ----------------------------------------------------------------------
diff --git a/exercises/stringify-to-demystify/solution/solution.php b/exercises/stringify-to-demystify/solution/solution.php
@@ -8,7 +8,7 @@ public function __construct(private string $status, private string $error)
 
     public function __toString()
     {
-        return "Status: {$this->status} \nError: {$this->error}";
+        return "Status: {$this->status}\nError: {$this->error}\n";
     }
 }
 
diff --git a/exercises/the-attributes-of-success/problem/problem.md b/exercises/the-attributes-of-success/problem/problem.md
@@ -118,10 +118,10 @@ The last task is to dump your object instance out using the PHP function `var_du
 
 ### The advantages of Attributes
 
-* Add Metadata to classes, methods, properties and arguments and so on
-* They can replace PHP doc blocks, each with custom parsers and rules to a unified standard supported by PHP
-* The data can be introspected using PHP's Reflection API's
-* PHP Core and extensions can provide new behaviour and runtime configuration which is opt-in, such as conditionally declaring functions, deprecating features and so on
+* Add Metadata to classes, methods, properties and arguments and so on.
+* They can replace PHP doc blocks, each with custom parsers and rules to a unified standard supported by PHP.
+* The data can be introspected using PHP's Reflection API's.
+* PHP Core and extensions can provide new behaviour and runtime configuration which is opt-in, such as conditionally declaring functions, deprecating features and so on.
 
 ----------------------------------------------------------------------
 ## HINTS
@@ -135,6 +135,7 @@ You must call the `deserialize` function and you must use the `var_dump` functio
 
 If you want to see the `JSON` data - use `var_dump` to dump it out.
 
+For verification purposes, the order the properties defined in your `Review` class is important. Define them in the same order they are described to you.
 
 ## Extra
 
diff --git a/src/Exercise/PhpGetsAPromotion.php b/src/Exercise/PhpGetsAPromotion.php
diff --git a/test/Exercise/PhpGetsAPromotionTest.php b/test/Exercise/PhpGetsAPromotionTest.php
diff --git a/test/solutions/php-gets-a-promotion/solution-type-removed.php b/test/solutions/php-gets-a-promotion/solution-type-removed.php
diff --git a/test/solutions/stringify-to-demystify/solution-no-stringable.php b/test/solutions/stringify-to-demystify/solution-no-stringable.php
diff --git a/test/solutions/stringify-to-demystify/solution.php b/test/solutions/stringify-to-demystify/solution.php

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,9 @@`
`1`	`1`	`<?php`
`2`	`2`
	`3`	`+if (file_exists('param.log')) {`
	`4`	`+ unlink('param.log');`
	`5`	`+}`
	`6`	`+`
`3`	`7`	`function logParameter(mixed $parameter): void`
`4`	`8`	`{`
`5`	`9`	`file_put_contents(`
Original file line number	Diff line number	Diff line change
`@@ -2,11 +2,11 @@`
`2`	`2`
`3`	`3`	`class RowVisitor`
`4`	`4`	`{`
`5`		`- private $visitor;`
	`5`	`+ private \Closure $visitor;`
`6`	`6`
`7`		`- private $key;`
	`7`	`+ private string $key;`
`8`	`8`
`9`		`- protected $basePath;`
	`9`	`+ protected string $basePath;`
`10`	`10`
`11`	`11`	`public function __construct(\Closure $visitor, string $key, array $config = [])`
`12`	`12`	`{`