GH-19 (#20)

GH-19

.github/workflows/ci.yml

@@ -101,7 +101,7 @@ jobs:
       with:
         version: "10.5"
         php_version: "8.2"
-        php_extensions: xdebug
+        php_extensions: intl xdebug
         coverage_clover: clover.xml
         coverage_text: true
     - name: Make code coverage badge

README.md

@@ -16,38 +16,44 @@ You can install the package via composer:
 composer require --dev gammamatrix/playground-test
 ```
 
+## Configuration
+
 You can publish the config file with:
 ```bash
 php artisan vendor:publish --provider="Playground\Test\ServiceProvider" --tag="playground-config"
 ```
 
 See the contents of the published config file: [config/playground-test.php](config/playground-test.php)
 
+### Environment Variables
 
-## Configuration
+Information on [environment variables is available on the wiki for this package](https://github.com/gammamatrix/playground-test/wiki/Environment-Variables)
 
-All options are disabled by default.
+## PHPStan
 
-Enable all options:
+Tests at level 9 on:
+- `config/`
+- `database/`
+- `resources/`
+- `src/`
+- `tests/Feature/`
+- `tests/Unit/`
 
+```sh
+composer analyse
 ```
-#
-# @var bool Allow publishing of the configuration.
-#
-PLAYGROUND_TEST_PUBLISH_CONFIG=true
-#
-# @var string A password for testing the application.
-#
-PLAYGROUND_TEST_PASSWORD=some-password
-#
-# @var bool The password in PLAYGROUND_TEST_PASSWORD is already encrypted
-#
-PLAYGROUND_TEST_PASSWORD_ENCRYPTED=false
+
+## Coding Standards
+
+```sh
+composer format
 ```
 
-## Testing
+## Tests
 
-The components of this package are meant to assist in testing playground packages under a Laravel installation with PHPUnit.
+```sh
+composer test
+```
 
 ## Changelog
 

phpstan.neon.dist

@@ -9,9 +9,9 @@ parameters:
     paths:
         - config
         - database
+        - resources
         - src
         - tests
-        - resources
 
     excludePaths:
         - 'output/*'

src/Feature/Models/ModelCase.php

@@ -519,7 +519,7 @@ public function verifyRelationshipHasMany(Model $model, string $accessor): void
     /**
      * Test the model relationships.
      */
-    public function testVerifyRelationships(): void
+    public function test_verify_model_relationships(): void
     {
         $modelClass = $this->getModelClass();
 
@@ -534,4 +534,19 @@ public function testVerifyRelationships(): void
         //     // '$this' => $this,
         // ]);
     }
+
+    public function test_factory_create(): void
+    {
+        $instance = null;
+
+        $modelClass = $this->getModelClass();
+        $this->assertNotEmpty($modelClass);
+
+        if (is_callable([$modelClass, 'factory'])) {
+            $instance = $modelClass::factory()->create();
+        }
+
+        $this->assertNotNull($instance);
+        $this->assertInstanceOf($modelClass, $instance);
+    }
 }

src/Models/PlaygroundUser.php

@@ -4,14 +4,21 @@
  */
 namespace Playground\Test\Models;
 
+use Playground\Models\Interfaces\WithCreatorInterface;
+use Playground\Models\Interfaces\WithModifierInterface;
+use Playground\Models\Traits\WithCreator;
+use Playground\Models\Traits\WithModifier;
 use Playground\Models\User as BaseUser;
 
 /**
  * \Playground\Test\Models\PlaygroundUser
  *
  * This model includes RBAC and DOES NOT support Sanctum.
  */
-class PlaygroundUser extends BaseUser
+class PlaygroundUser extends BaseUser implements WithCreatorInterface, WithModifierInterface
 {
+    use WithCreator;
+    use WithModifier;
+
     protected $table = 'users';
 }

src/Unit/Models/ModelCase.php

@@ -273,4 +273,19 @@ public function test_verify_model_relationships(): void
         //     // '$this' => $this,
         // ]);
     }
+
+    public function test_model_factory_make(): void
+    {
+        $instance = null;
+
+        $modelClass = $this->getModelClass();
+        $this->assertNotEmpty($modelClass);
+
+        if (is_callable([$modelClass, 'factory'])) {
+            $instance = $modelClass::factory()->make();
+        }
+
+        $this->assertNotNull($instance);
+        $this->assertInstanceOf($modelClass, $instance);
+    }
 }