Merge pull request #21 from tattersoftware/tools

PHP 8 + Toolkit

Author: MGatner

.github/workflows/analyze.yml

@@ -9,6 +9,7 @@ on:
     paths:
       - 'src/**'
       - 'tests/**'
+      - 'composer.**'
       - 'phpstan*'
       - '.github/workflows/analyze.yml'
   push:
@@ -17,32 +18,41 @@ on:
     paths:
       - 'src/**'
       - 'tests/**'
+      - 'composer.**'
       - 'phpstan*'
       - '.github/workflows/analyze.yml'
 
 jobs:
   build:
-    name: Analyze code
+    name: PHP ${{ matrix.php-versions }} Static Analysis
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        php-versions: ['7.3', '7.4', '8.0']
     steps:
       - name: Checkout
         uses: actions/checkout@v2
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '7.4'
-          extensions: intl
+          php-version: ${{ matrix.php-versions }}
+          tools: composer, pecl, phpunit
+          extensions: intl, json, mbstring, mysqlnd, xdebug, xml, sqlite3
 
       - name: Get composer cache directory
         id: composer-cache
         run: echo "::set-output name=dir::$(composer config cache-files-dir)"
 
+      - name: Create composer cache directory
+        run: mkdir -p ${{ steps.composer-cache.outputs.dir }}
+
       - name: Cache composer dependencies
         uses: actions/cache@v2
         with:
           path: ${{ steps.composer-cache.outputs.dir }}
-          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
           restore-keys: ${{ runner.os }}-composer-
 
       - name: Create PHPStan cache directory
@@ -56,7 +66,7 @@ jobs:
           restore-keys: ${{ runner.os }}-phpstan-
 
       - name: Install dependencies
-        run: composer install --no-progress --no-suggest --no-interaction --prefer-dist --optimize-autoloader
+        run: composer update --no-progress --no-interaction --prefer-dist --optimize-autoloader
         env:
           COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
 

.github/workflows/test.yml

@@ -2,16 +2,19 @@ name: PHPUnit
 
 on:
   pull_request:
-    branches: 
+    branches:
+      - develop
+  push:
+    branches:
       - develop
 
 jobs:
   main:
-    name: Build and test
+    name: PHP ${{ matrix.php-versions }} Unit Tests
 
     strategy:
       matrix:
-        php-versions: ['7.2', '7.3', '7.4']
+        php-versions: ['7.3', '7.4', '8.0']
 
     runs-on: ubuntu-latest
 
@@ -41,9 +44,29 @@ jobs:
           restore-keys: ${{ runner.os }}-composer-
 
       - name: Install dependencies
-        run: composer install --no-progress --no-suggest --no-interaction --prefer-dist --optimize-autoloader
+        run: composer update --no-progress --no-interaction --prefer-dist --optimize-autoloader
         env:
           COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
 
-      - name: Test with phpunit
+      - name: Test with PHPUnit
         run: vendor/bin/phpunit --verbose --coverage-text
+
+      - if: matrix.php-versions == '7.4'
+        name: Run Coveralls
+        run: |
+          composer global require php-coveralls/php-coveralls:^2.4
+          php-coveralls --coverage_clover=build/logs/clover.xml -v
+        env:
+          COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COVERALLS_PARALLEL: true
+          COVERALLS_FLAG_NAME: PHP ${{ matrix.php-versions }} - ${{ matrix.db-platforms }}
+
+  coveralls:
+    needs: [main]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Coveralls Finished
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          parallel-finished: true

composer.json

@@ -1,5 +1,6 @@
 {
 	"name": "tatter/assets",
+	"type": "library",
 	"description": "Asset publishing and loading for CodeIgniter 4",
 	"keywords": [
 		"codeigniter",
@@ -19,42 +20,37 @@
 			"role": "Developer"
 		}
 	],
-	"repositories": [
-		{
-			"type": "vcs",
-			"url": "https://github.com/codeigniter4/CodeIgniter4"
-		}
-	],
-	"minimum-stability": "dev",
-	"prefer-stable": true,
 	"require": {
-		"php" : ">=7.2"
+		"php": "^7.3||^8.0"
 	},
 	"require-dev": {
 		"codeigniter4/codeigniter4": "dev-develop",
-		"fzaninotto/faker": "^1.9@dev",
-		"mikey179/vfsstream": "^1.6",
-		"phpunit/phpunit": "^8.5",
-		"phpstan/phpstan": "^0.12",
-		"squizlabs/php_codesniffer": "^3.5",
-		"codeigniter4/codeigniter4-standard": "^1.0"
+		"tatter/tools": "^1.4"
 	},
 	"autoload": {
 		"psr-4": {
 			"Tatter\\Assets\\": "src"
-		}
+		},
+		"exclude-from-classmap": [
+			"**/Database/Migrations/**"
+		]
 	},
 	"autoload-dev": {
 		"psr-4": {
 			"Tests\\Support\\": "tests/_support"
 		}
 	},
+	"repositories": [
+		{
+			"type": "vcs",
+			"url": "https://github.com/codeigniter4/CodeIgniter4"
+		}
+	],
+	"minimum-stability": "dev",
+	"prefer-stable": true,
 	"scripts": {
 		"analyze": "phpstan analyze",
-		"style": "phpcbf --standard=./vendor/codeigniter4/codeigniter4-standard/CodeIgniter4 src/ tests/",
-		"test": "phpunit",
-		"post-update-cmd": [
-			"composer dump-autoload"
-		]
+		"style": "phpcbf --standard=./vendor/codeigniter4/codeigniter4-standard/CodeIgniter4 tests/ src/",
+		"test": "phpunit"
 	}
 }

src/Libraries/Assets.php

@@ -28,6 +28,7 @@
 use CodeIgniter\Config\Config;
 use CodeIgniter\Config\Services;
 use CodeIgniter\Router\RouteCollectionInterface;
+use Tatter\Assets\Config\Assets as AssetsConfig;
 use Tatter\Assets\Exceptions\AssetsException;
 
 /*** CLASS ***/
@@ -36,14 +37,14 @@ class Assets
 	/**
 	 * Our configuration instance.
 	 *
-	 * @var \Tatter\Assets\Config\Assets
+	 * @var AssetsConfig
 	 */
 	protected $config;
 
 	/**
 	 * Array of asset paths detected for the current route
 	 *
-	 * @var array
+	 * @var array|null
 	 */
 	protected $paths;
 
@@ -61,7 +62,7 @@ class Assets
 	 * The URI to use for matching routed assets.
 	 * Defaults to uri_string()
 	 *
-	 * @var string
+	 * @var string|null
 	 */
 	protected $route;
 
@@ -76,7 +77,7 @@ class Assets
 	/**
 	 * Route collection used to determine the default route (if needed).
 	 *
-	 * @var CodeIgniter\Router\RouteCollectionInterface
+	 * @var RouteCollectionInterface|null
 	 */
 	protected $collection;
 
@@ -147,7 +148,7 @@ public function getPaths($extension = null): array
 		$tmpPaths = [];
 		foreach ($this->paths as $path)
 		{
-			if (strtolower(pathinfo($path, PATHINFO_EXTENSION) == $extension))
+			if (strtolower(pathinfo($path, PATHINFO_EXTENSION)) == $extension)
 			{
 				$tmpPaths[] = $path;
 			}
@@ -197,16 +198,13 @@ public function tag(string $path)
 		{
 			case 'css':
 				return link_tag($url);
-			break;
 
 			case 'js':
 				return script_tag($url);
-			break;
 
 			case 'img':
 				$alt = ucfirst(pathinfo($path, PATHINFO_FILENAME));
 				return img($url, false, ['alt' => $alt]);
-			break;
 
 			default:
 				if ($this->config->silent)
@@ -281,7 +279,7 @@ protected function sanitizeRoute()
 		if (Config::get('App')->negotiateLocale)
 		{
 			$route = explode('/', $this->route);
-			if (count($route) && $route[0] == Services::request()->getLocale())
+			if (count($route) && $route[0] == Services::request()->getLocale()) // @phpstan-ignore-line
 			{
 				unset($route[0]);
 			}

src/Libraries/Manifests.php

@@ -4,6 +4,7 @@
 use CodeIgniter\Files\Exceptions\FileException;
 use CodeIgniter\Files\Exceptions\FileNotFoundException;
 use Tatter\Assets\Exceptions\ManifestsException;
+use stdClass;
 
 class Manifests
 {
@@ -294,7 +295,14 @@ public function expandPaths(&$resource, &$manifest)
 			trim($resource->destination ?? '', '/') . '/';
 	}
 
-	// Parse a resource and copy it to the determined destination
+	/**
+	 * Parses a resource and copies it to
+	 * the determined destination.
+	 *
+	 * @param stdClass $resource
+	 *
+	 * @return bool
+	 */
 	protected function publishResource($resource): bool
 	{
 		// Validate the source
@@ -327,7 +335,15 @@ protected function publishResource($resource): bool
 		return $this->publishFile($resource->source, $resource->destination);
 	}
 
-	// Scan a directory and apply filters, publishing each file
+
+	/**
+	 * Scans a directory and applies filters,
+	 * publishing each file.
+	 *
+	 * @param stdClass $resource
+	 *
+	 * @return bool
+	 */
 	protected function publishResourceDirectory($resource): bool
 	{
 		$result = true;

tests/_support/ManifestsTestCase.php

@@ -1,21 +1,34 @@
 <?php namespace Tests\Support;
 
 use CodeIgniter\Test\CIUnitTestCase;
+use Tatter\Assets\Config\Assets as AssetsConfig;
 use Tatter\Assets\Libraries\Manifests;
 use org\bovigo\vfs\vfsStream;
+use org\bovigo\vfs\vfsStreamDirectory;
+use stdClass;
 
 class ManifestsTestCase extends CIUnitTestCase
 {
 	/**
-	 * @var \Tatter\Assets\Libraries\Manifests
+	 * @var vfsStreamDirectory|null
+	 */
+	protected $root;
+
+	/**
+	 * @var Manifests
 	 */
 	protected $manifests;
 
 	/**
-	 * @var \Tatter\Assets\Config\Assets
+	 * @var AssetsConfig
 	 */
 	protected $config;
 
+	/**
+	 * @var stdClass
+	 */
+	protected $testManifest;
+
     public function setUp(): void
     {
         parent::setUp();

tests/manifests/PublishTest.php

@@ -34,7 +34,7 @@ public function testExplicitFiles()
 		];
 
 		$visitor = new vfsStreamStructureVisitor();
-		$result  = vfsStream::inspect($visitor, $this->root)->getStructure();
+		$result  = vfsStream::inspect($visitor, $this->root)->getStructure(); // @phpstan-ignore-line
 
 		$this->assertEquals($expected, $result);
 	}
@@ -48,7 +48,7 @@ public function testRecursiveFlatten()
 		$this->assertTrue($result);
 
 		$visitor = new vfsStreamStructureVisitor();
-		$result  = vfsStream::inspect($visitor, $this->root)->getStructure();
+		$result  = vfsStream::inspect($visitor, $this->root)->getStructure(); // @phpstan-ignore-line
 
 		$this->assertTrue($this->root->hasChild('assets/vendor/frontend/frontend.css'));
 		$this->assertTrue($this->root->hasChild('assets/vendor/frontend/frontend.js'));