Merge pull request #43 from tattersoftware/static-tests

Rework test properties

Author: MGatner

src/Test/AssetsTestTrait.php

@@ -17,42 +17,42 @@
 trait AssetsTestTrait
 {
     /**
-     * Virtual workspace
+     * The virtual workspace.
      *
      * @var vfsStreamDirectory|null
      */
-    protected $root;
-
-    /**
-     * @var AssetsConfig
-     */
-    protected $config;
+    protected static $root;
 
     /**
      * Whether the publishers have been run.
      *
      * @var bool
      */
-    private $published = false;
+    private static $published = false;
+
+    /**
+     * @var AssetsConfig
+     */
+    protected $assets;
 
     /**
      * Creates the VFS (if necessary) and updates the Assets config.
      */
     protected function setUpAssetsTestTrait(): void
     {
-        if ($this->root === null) {
-            $this->root = vfsStream::setup('root');
+        if (self::$root === null) {
+            self::$root = vfsStream::setup('root');
         }
 
         // Create the config
-        $this->config                = new AssetsConfig();
-        $this->config->directory     = $this->root->url() . DIRECTORY_SEPARATOR;
-        $this->config->useTimestamps = false; // These make testing much harder
+        $this->assets                = new AssetsConfig();
+        $this->assets->directory     = self::$root->url() . DIRECTORY_SEPARATOR;
+        $this->assets->useTimestamps = false; // These make testing much harder
 
-        Asset::useConfig($this->config);
+        Asset::useConfig($this->assets);
 
         // Add VFS as an allowed Publisher directory
-        config('Publisher')->restrictions[$this->config->directory] = '*';
+        config('Publisher')->restrictions[$this->assets->directory] = '*';
     }
 
     /**
@@ -61,8 +61,8 @@ protected function setUpAssetsTestTrait(): void
     protected function tearDownAssetsTestTrait(): void
     {
         if (! empty($this->refreshVfs)) {
-            $this->root      = null;
-            $this->published = false;
+            self::$root      = null;
+            self::$published = false;
         }
 
         Asset::useConfig(null);
@@ -74,14 +74,14 @@ protected function tearDownAssetsTestTrait(): void
      */
     protected function publishAll(): void
     {
-        if ($this->published) {
+        if (self::$published) {
             return;
         }
 
         foreach (Publisher::discover() as $publisher) {
             $publisher->publish();
         }
 
-        $this->published = true;
+        self::$published = true;
     }
 }

tests/AssetTest.php

@@ -3,12 +3,12 @@
 use Tatter\Assets\Asset;
 use Tatter\Assets\Config\Assets as AssetsConfig;
 use Tatter\Assets\Exceptions\AssetsException;
-use Tests\Support\AssetsTestCase;
+use Tests\Support\TestCase;
 
 /**
  * @internal
  */
-final class AssetTest extends AssetsTestCase
+final class AssetTest extends TestCase
 {
     public function testStringable()
     {
@@ -48,9 +48,9 @@ public function testLoadsConfig()
 
     public function testUseTimestamps()
     {
-        $this->config->useTimestamps = true;
+        $this->assets->useTimestamps = true;
 
-        $mtime    = filemtime($this->config->directory . 'apple.css');
+        $mtime    = filemtime($this->assets->directory . 'apple.css');
         $expected = '<link href="http://example.com/assets/apple.css?v=' . $mtime . '" rel="stylesheet" type="text/css" />';
         $asset    = Asset::createFromPath('apple.css');
 

tests/AssetsTestTraitTest.php

@@ -14,7 +14,7 @@ final class AssetsTestTraitTest extends CIUnitTestCase
 
     public function testPublishesOnce()
     {
-        $file = $this->config->directory . $this->config->vendor . 'fruit/third_party.js';
+        $file = $this->assets->directory . $this->assets->vendor . 'fruit/third_party.js';
 
         $this->publishAll();
         $this->assertFileExists($file);
@@ -27,12 +27,10 @@ public function testPublishesOnce()
 
     public function testTearDownRefreshes()
     {
-        $this->assertNotNull($this->root);
+        $this->assertNotNull(self::$root);
 
         $this->refreshVfs = true;
         $this->tearDownAssetsTestTrait();
-        $this->assertNull($this->root);
-
-        $this->refreshVfs = false;
+        $this->assertNull(self::$root);
     }
 }

tests/BundleTest.php

@@ -2,13 +2,13 @@
 
 use Tatter\Assets\Asset;
 use Tatter\Assets\Bundle;
-use Tests\Support\AssetsTestCase;
 use Tests\Support\Bundles\FruitSalad;
+use Tests\Support\TestCase;
 
 /**
  * @internal
  */
-final class BundleTest extends AssetsTestCase
+final class BundleTest extends TestCase
 {
     public function testConstructorPaths()
     {

tests/BundlesTestCaseTest.php

@@ -15,8 +15,8 @@ protected function setUp(): void
     {
         parent::setUp();
 
-        copy(SUPPORTPATH . 'Files/apple.css', $this->config->directory . 'apple.css');
-        copy(SUPPORTPATH . 'Files/banana.js', $this->config->directory . 'banana.js');
+        copy(SUPPORTPATH . 'Files/apple.css', $this->assets->directory . 'apple.css');
+        copy(SUPPORTPATH . 'Files/banana.js', $this->assets->directory . 'banana.js');
     }
 
     public function bundleProvider(): array

tests/FilterTest.php

@@ -11,7 +11,7 @@
 /**
  * @internal
  */
-final class FilterTest extends AssetsTestCase
+final class FilterTest extends TestCase
 {
     use FilterTestTrait;
 
@@ -33,7 +33,7 @@ protected function setUp(): void
     {
         parent::setUp();
 
-        $this->config->routes = [
+        $this->assets->routes = [
             '*' => [
                 'https://pagecdn.io/lib/cleave/1.6.0/cleave.min.js',
                 FruitSalad::class,
@@ -102,7 +102,7 @@ public function testFilterWithArguments()
 
     public function testEmptyTags()
     {
-        $this->config->routes = [];
+        $this->assets->routes = [];
 
         $caller = $this->getFilterCaller(AssetsFilter::class, 'after');
 

tests/RouteBundleTest.php

@@ -2,20 +2,20 @@
 
 use Tatter\Assets\Exceptions\AssetsException;
 use Tatter\Assets\RouteBundle;
-use Tests\Support\AssetsTestCase;
 use Tests\Support\Bundles\FruitSalad;
 use Tests\Support\Bundles\LunchBreak;
+use Tests\Support\TestCase;
 
 /**
  * @internal
  */
-final class RouteBundleTest extends AssetsTestCase
+final class RouteBundleTest extends TestCase
 {
     protected function setUp(): void
     {
         parent::setUp();
 
-        $this->config->routes = [
+        $this->assets->routes = [
             '*' => [
                 'https://pagecdn.io/lib/cleave/1.6.0/cleave.min.js',
                 FruitSalad::class,
@@ -51,7 +51,7 @@ public function testCreateFromRouteUsesCache()
             FruitSalad::class,
         ]));
 
-        $this->config->useCache = true;
+        $this->assets->useCache = true;
         $this->assertEmpty(cache()->getCacheInfo());
 
         // Place a fake bundle in the cache
@@ -64,7 +64,7 @@ public function testCreateFromRouteUsesCache()
 
     public function testCreateFromRouteSavesToCache()
     {
-        $this->config->useCache = true;
+        $this->assets->useCache = true;
         $this->assertEmpty(cache()->getCacheInfo());
 
         $result = RouteBundle::createFromRoute('foo');
@@ -74,7 +74,7 @@ public function testCreateFromRouteSavesToCache()
 
     public function testCreateFromRouteEmpty()
     {
-        $this->config->routes['*'] = [];
+        $this->assets->routes['*'] = [];
 
         $result = RouteBundle::createFromRoute('foo');
 
@@ -85,7 +85,7 @@ public function testCreateFromRouteEmpty()
     public function testCreateFromRouteThrowsNotString()
     {
         // @phpstan-ignore-next-line
-        $this->config->routes['invalid'] = [true];
+        $this->assets->routes['invalid'] = [true];
 
         $this->expectException('InvalidArgumentException');
         $this->expectExceptionMessage('Config $route items must be strings.');
@@ -95,7 +95,7 @@ public function testCreateFromRouteThrowsNotString()
 
     public function testCreateFromRouteThrowsInvalidType()
     {
-        $this->config->routes['invalid'] = ['filthyflarmflam'];
+        $this->assets->routes['invalid'] = ['filthyflarmflam'];
 
         $this->expectException(AssetsException::class);
         $this->expectExceptionMessage(lang('Assets.invalidConfigItem', ['']));

tests/_support/AssetsTestCase.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace Tests\Support;
+
+use CodeIgniter\Test\CIUnitTestCase;
+use Tatter\Assets\Asset;
+use Tatter\Assets\Config\Assets as AssetsConfig;
+
+abstract class TestCase extends CIUnitTestCase
+{
+    /**
+     * @var AssetsConfig
+     */
+    protected $assets;
+
+    /**
+     * Preps the config for the test directory.
+     */
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->assets                = config('Assets');
+        $this->assets->directory     = SUPPORTPATH . 'Files/';
+        $this->assets->vendor        = 'external/';
+        $this->assets->useTimestamps = false; // These make testing much harder
+
+        Asset::useConfig($this->assets);
+    }
+}