Merge pull request #34 from DaveLiddament/fix/examples

FIX README and TestTag examples

README.md

@@ -135,7 +135,7 @@ $person = new Person();
 
 ## MustUseResult
 
-Add #[MustUseResult] attribute that can be used on methods. This enforces the result from the method call must be used.
+A `#[MustUseResult]` attribute can be used on methods. This enforces the result from the method call must be used.
 
 E.g. if you have a class like this:
 
@@ -158,7 +158,7 @@ You might misuse the `add` method in this way:
 
 ```php
 $cost = new Money(5);
-$cost->add(6); // ERROR - This statement has no effect. 
+$cost->add(6); // ERROR - The call to the add method has no effect. 
 ```
 
 But this would be OK:

examples/testTag/testTagOnClass.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace TestTagOnConstructor;
+namespace TestTagOnClass;
 
 use DaveLiddament\PhpLanguageExtensions\TestTag;
 
@@ -11,9 +11,16 @@ public function __construct()
     {
     }
 
-    public static function create(): Person // No Error, class can interact with itself
+    public static function create(): Person // OK, class can interact with itself
     {
-        return new Person(); // No Error, class can interact with itself
+        return new Person(); // OK, class can interact with itself
+    }
+
+    public function aMethod(int $number): void
+    {
+        if ($number > 0) {
+            $this->aMethod($number - 1); // OK, class can interact with itself
+        }
     }
 }
 
@@ -28,4 +35,9 @@ public function buildPerson(): Person
     {
         return Person::create(); // ERROR
     }
+
+    public function aMethod(Person $person): void
+    {
+        $person->aMethod(1); // ERROR
+    }
 }

examples/testTag/testTagOnClassIgnoredInTestClass.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace TestTagOnConstructor;
+namespace TestTagOnClassIgnoredInTestClass;
 
 use DaveLiddament\PhpLanguageExtensions\TestTag;
 
@@ -11,21 +11,30 @@ public function __construct()
     {
     }
 
-    public static function create(): Person // No Error, class can interact with itself
+    public static function create(): Person // OK, class can interact with itself
+    {
+        return new Person(); // OK, class can interact with itself
+    }
+
+    public function aMethod(): void
     {
-        return new Person(); // No Error, class can interact with itself
     }
 }
 
 class PersonTest
 {
     public function newInstance(): Person
     {
-        return new Person(); // No Error
+        return new Person(); // OK, call from test class
     }
 
     public function buildPerson(): Person
     {
-        return Person::create(); // No error
+        return Person::create(); // OK, call from test class
+    }
+
+    public function aMethod(Person $person): void
+    {
+        $this->aMethod(); // OK, call from test class
     }
 }