Merge pull request #20 from tattersoftware/tools

Development Tools

Author: MGatner

.gitattributes

@@ -0,0 +1,13 @@
+/.github           export-ignore
+/docs              export-ignore
+/examples          export-ignore
+/tests             export-ignore
+/.editorconfig     export-ignore
+/.gitattributes    export-ignore
+/.gitignore        export-ignore
+/phpunit.xml.dist  export-ignore
+/phpstan.neon.dist export-ignore
+
+# Configure diff output for .php and .phar files.
+*.php diff=php
+*.phar -diff

.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+- package-ecosystem: composer
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+
+- package-ecosystem: "github-actions"
+  directory: "/"
+  schedule:
+    interval: daily

.github/workflows/analyze.yml

@@ -0,0 +1,64 @@
+# When a PR is opened or a push is made, perform
+# a static analysis check on the code using PHPStan.
+name: PHPStan
+
+on:
+  pull_request:
+    branches:
+      - 'develop'
+    paths:
+      - 'src/**'
+      - 'tests/**'
+      - 'phpstan*'
+      - '.github/workflows/analyze.yml'
+  push:
+    branches:
+      - 'develop'
+    paths:
+      - 'src/**'
+      - 'tests/**'
+      - 'phpstan*'
+      - '.github/workflows/analyze.yml'
+
+jobs:
+  build:
+    name: Analyze code
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '7.4'
+          extensions: intl
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - name: Cache composer dependencies
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Create PHPStan cache directory
+        run: mkdir -p build/phpstan
+
+      - name: Cache PHPStan results
+        uses: actions/cache@v2
+        with:
+          path: build/phpstan
+          key: ${{ runner.os }}-phpstan-${{ github.sha }}
+          restore-keys: ${{ runner.os }}-phpstan-
+
+      - name: Install dependencies
+        run: composer install --no-progress --no-suggest --no-interaction --prefer-dist --optimize-autoloader
+        env:
+          COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
+
+      - name: Run static analysis
+        run: vendor/bin/phpstan analyze

.github/workflows/test.yml

@@ -34,7 +34,7 @@ jobs:
         run: echo "::set-output name=dir::$(composer config cache-files-dir)"
 
       - name: Cache composer dependencies
-        uses: actions/cache@v1
+        uses: actions/cache@v2
         with:
           path: ${{ steps.composer-cache.outputs.dir }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
@@ -46,4 +46,4 @@ jobs:
           COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
 
       - name: Test with phpunit
-        run: vendor/bin/phpunit --coverage-text
+        run: vendor/bin/phpunit --verbose --coverage-text

.gitignore

@@ -1,4 +1,4 @@
-/vendor/
+vendor/
 build/
 phpunit*.xml
 phpunit

composer.json

@@ -32,8 +32,12 @@
 	},
 	"require-dev": {
 		"codeigniter4/codeigniter4": "dev-develop",
-		"mikey179/vfsstream": "1.6.*",
-		"phpunit/phpunit" : "^8.5"
+		"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"
 	},
 	"autoload": {
 		"psr-4": {
@@ -46,6 +50,8 @@
 		}
 	},
 	"scripts": {
+		"analyze": "phpstan analyze",
+		"style": "phpcbf --standard=./vendor/codeigniter4/codeigniter4-standard/CodeIgniter4 src/ tests/",
 		"test": "phpunit",
 		"post-update-cmd": [
 			"composer dump-autoload"

phpstan.neon.dist

@@ -0,0 +1,20 @@
+parameters:
+	tmpDir: build/phpstan
+	level: 5
+	paths:
+		- src
+		- tests
+	bootstrapFiles:
+		- vendor/codeigniter4/codeigniter4/system/Test/bootstrap.php
+	excludes_analyse:
+		- src/Config/Routes.php
+		- src/Views/*
+	ignoreErrors:
+		- '#Call to an undefined static method Config\\Services::manifests\(\)#'
+		- '#Unsafe usage of new static\(\)*#'
+	scanDirectories:
+		- vendor/codeigniter4/codeigniter4/system/Helpers
+	dynamicConstantNames:
+		- APP_NAMESPACE
+		- CI_DEBUG
+		- ENVIRONMENT

phpunit.xml.dist

@@ -24,7 +24,7 @@
 			</exclude>
 		</whitelist>
 	</filter>
-
+	
 	<logging>
 		<log type="coverage-html" target="build/logs/html"/>
 		<log type="coverage-clover" target="build/logs/clover.xml"/>
@@ -47,10 +47,6 @@
 		<!-- Directory containing the front controller (index.php) -->
 		<const name="PUBLICPATH" value="./vendor/codeigniter4/codeigniter4/public/"/>
 
-		<!-- https://getcomposer.org/xdebug -->
-		<env name="COMPOSER_DISABLE_XDEBUG_WARN" value="1"/>
-
-		<!-- Database configuration -->
 <!--	<env name="database.tests.hostname" value="localhost"/>  -->
 <!--	<env name="database.tests.database" value="tests"/>	     -->
 <!--	<env name="database.tests.username" value="tests_user"/> -->

src/Config/Services.php

@@ -2,10 +2,13 @@
 
 use CodeIgniter\Config\BaseService;
 use CodeIgniter\View\RendererInterface;
+use Tatter\Assets\Libraries\Assets;
+use Tatter\Assets\Libraries\Manifests;
+use Tatter\Assets\Config\Assets as AssetsConfig;
 
 class Services extends BaseService
 {
-    public static function assets(BaseConfig $config = null, bool $getShared = true)
+    public static function assets(AssetsConfig $config = null, bool $getShared = true)
     {
 		if ($getShared)
 		{
@@ -18,10 +21,10 @@ public static function assets(BaseConfig $config = null, bool $getShared = true)
 		{
 			$config = config('Assets');
 		}
-		return new \Tatter\Assets\Libraries\Assets($config);
+		return new Assets($config);
 	}
 
-    public static function manifests(BaseConfig $config = null, bool $getShared = true)
+    public static function manifests(AssetsConfig $config = null, bool $getShared = true)
     {
 		if ($getShared)
 		{
@@ -34,6 +37,6 @@ public static function manifests(BaseConfig $config = null, bool $getShared = tr
 		{
 			$config = config('Assets');
 		}
-		return new \Tatter\Assets\Libraries\Manifests($config);
+		return new Manifests($config);
 	}
 }

src/Handlers/ConfigHandler.php

@@ -1,23 +1,30 @@
 <?php namespace Tatter\Assets\Handlers;
 
-use CodeIgniter\Config\BaseConfig;
 use Config\Services;
+use Tatter\Assets\Config\Assets as AssetsConfig;
 use Tatter\Assets\Exceptions\AssetsException;
 use Tatter\Assets\Handlers\DirectoryHandler;
 use Tatter\Assets\Interfaces\AssetHandlerInterface;
 
 class ConfigHandler implements AssetHandlerInterface
-{	
+{
+	/**
+	 * Our configuration instance.
+	 *
+	 * @var AssetsConfig
+	 */
+	protected $config;
+
 	/**
 	 * Instance of the directory handler for config routes
 	 * that point to directories instead of files.
 	 *
-	 * @var \Tatter\Assets\Handlers\DirectoryHandler
+	 * @var DirectoryHandler|null
 	 */
 	protected $directoryHandler;
 
 	// Save the config
-	public function __construct(BaseConfig $config = null)
+	public function __construct(AssetsConfig $config = null)
 	{
 		// Save the configuration
 		$this->config = $config ?? config('Assets');