Merge pull request #9 from tattersoftware/devtools

Update 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/workflows/analyze.yml

@@ -0,0 +1,68 @@
+# 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: latest
+          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.json') }}
+          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-interaction --prefer-dist --optimize-autoloader
+        env:
+          COMPOSER_AUTH: ${{ secrets.COMPOSER_AUTH }}
+
+      - name: Run static analysis
+        run: vendor/bin/phpstan analyze

composer.json

@@ -1,5 +1,6 @@
 {
 	"name": "tatter/patches",
+	"type": "library",
 	"description": "Module for updating CodeIgniter 4 projects",
 	"keywords": [
 		"codeigniter",
@@ -19,23 +20,14 @@
 			"role": "Developer"
 		}
 	],
-	"repositories": [
-		{
-			"type": "vcs",
-			"url": "https://github.com/codeigniter4/CodeIgniter4"
-		}
-	],
-	"minimum-stability": "dev",
-	"prefer-stable": true,
 	"require": {
-		"php" : ">=7.2",
+		"php": ">=7.2",
 		"composer/composer": "^2.0",
 		"sebastian/diff": "^3.0"
 	},
 	"require-dev": {
-		"phpunit/phpunit": "8.5.*",
-		"mikey179/vfsstream": "^1.6",
-		"codeigniter4/codeigniter4": "dev-develop"
+		"codeigniter4/codeigniter4": "dev-develop",
+		"tatter/tools": "^1.0"
 	},
 	"autoload": {
 		"psr-4": {
@@ -47,10 +39,17 @@
 			"Tests\\Support\\": "tests/_support"
 		}
 	},
+	"repositories": [
+		{
+			"type": "vcs",
+			"url": "https://github.com/codeigniter4/CodeIgniter4"
+		}
+	],
+	"minimum-stability": "dev",
+	"prefer-stable": true,
 	"scripts": {
-		"test": "phpunit",
-		"post-update-cmd": [
-			"composer dump-autoload"
-		]
+		"analyze": "phpstan analyze",
+		"style": "phpcs --standard=./vendor/codeigniter4/codeigniter4-standard/CodeIgniter4 tests/ src/",
+		"test": "phpunit"
 	}
 }

phpstan.neon.dist

@@ -0,0 +1,22 @@
+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:
+	universalObjectCratesClasses:
+		- CodeIgniter\Entity
+		- Faker\Generator
+		- Tatter\Patches\Codex
+	scanDirectories:
+		- vendor/codeigniter4/codeigniter4/system/Helpers
+	dynamicConstantNames:
+		- APP_NAMESPACE
+		- CI_DEBUG
+		- ENVIRONMENT

phpunit.xml.dist

@@ -51,13 +51,13 @@
 		<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"/> -->
-<!--	<env name="database.tests.password" value=""/>		     -->
-<!--	<env name="database.tests.DBDriver" value="MySQLi"/>	 -->
-<!--	<env name="database.tests.DBPrefix" value="tests_"/>	 -->
-		<env name="database.tests.database" value=":memory:"/>
-		<env name="database.tests.DBDriver" value="SQLite3"/>
+		<!-- Uncomment to provide your own database for testing
+		<env name="database.tests.hostname" value="localhost"/>
+		<env name="database.tests.database" value="tests"/>
+		<env name="database.tests.username" value="tests_user"/>
+		<env name="database.tests.password" value=""/>
+		<env name="database.tests.DBDriver" value="MySQLi"/>
+		<env name="database.tests.DBPrefix" value="tests_"/>
+		-->
 	</php>
 </phpunit>

src/Codex.php

@@ -2,6 +2,7 @@
 
 use CodeIgniter\Config\BaseConfig;
 use JsonSerializable;
+use Tatter\Patches\Config\Patches;
 
 /**
  * Class Codex
@@ -13,7 +14,7 @@ class Codex implements JsonSerializable
 	/**
 	 * Config file to use.
 	 *
-	 * @var Tatter\Patches\Config\Patches
+	 * @var Patches
 	 */
 	public $config;
 
@@ -87,9 +88,9 @@ class Codex implements JsonSerializable
 	/**
 	 * Initialize the configuration.
 	 *
-	 * @param BaseConfig $config
+	 * @param Patches $config
 	 */
-	public function __construct(BaseConfig $config)
+	public function __construct(Patches $config)
 	{
 		$this->config = $config;
 	}

src/Commands/SelfUpdate.php

@@ -14,7 +14,7 @@ class SelfUpdate extends BaseCommand
 	/**
 	 * The library instance
 	 *
-	 * @var Tatter\Patches\Patches
+	 * @var Patches
 	 */
 	public $patches;
 
@@ -103,11 +103,9 @@ protected function mergeMenu(): bool
     	{
     		case 'p':
     			return true;
-    		break;
 
     		case 'q':
     			return false;
-    		break;
 
     		case 'l':
     			$this->showFiles($codex->changedFiles, 'Changed');
@@ -161,13 +159,9 @@ protected function conflictsMenu(): bool
 
     	switch (CLI::prompt('Selection?', ['l', 'g', 'o', 's', 'q']))
     	{
-    		case 'p':
-    			return true;
-    		break;
-
+    		case 'q':
     		case 's':
     			return false;
-    		break;
 
     		case 'l':
     			$this->showFiles($codex->conflicts['changed'], 'Changed');
@@ -188,7 +182,6 @@ protected function conflictsMenu(): bool
 				}
 
     			return true;
-    		break;
     	}
 
     	// If a non-returning item was select then run the menu again
@@ -198,7 +191,7 @@ protected function conflictsMenu(): bool
 	/**
 	 * Display and process the resolve menu
 	 *
-	 * @param array $files    Array of files to list
+	 * @param string $file    Path to the file
 	 * @param string $status  Changed/Added/Deleted
 	 *
 	 * @return bool  False to quit out of the whole process
@@ -219,16 +212,13 @@ protected function resolveMenu(string $file, string $status): bool
     	{
     		case 's':
     			return true;
-    		break;
 
     		case 'q':
     			return false;
-    		break;
 
     		case 'd':
     			CLI::write($this->patches->diffFile($file));
     			return $this->resolveMenu($file, $status);
-    		break;
 
     		case 'o':
 				$current = $codex->workspace . 'current/' . $file;
@@ -243,9 +233,7 @@ protected function resolveMenu(string $file, string $status): bool
 				{
 					copy_path($current, $project);
 				}
-
-				return true;
-    		break;
+			break;
     	}
 
 		return true;

src/Handlers/Mergers/GitHandler.php

@@ -13,8 +13,6 @@ class ComposerHandler extends BaseHandler implements UpdaterInterface
 	 * Call Composer programmatically to update all vendor files
 	 * https://stackoverflow.com/questions/17219436/run-composer-with-a-php-script-in-browser#25208897
 	 *
-	 * @param Codex $codex
-	 *
 	 * @throws UpdateException
 	 */
 	public function update()

src/Handlers/Updaters/ComposerHandler.php

@@ -76,12 +76,12 @@ function copy_path(string $file1, string $file2): bool
 	 * Copies a directory and all its contents to a destination directory
 	 * https://stackoverflow.com/a/2050909
 	 *
-	 * @param string $file1  Full path to the file
-	 * @param string $file2  Full path to the new file
+	 * @param string $dir1  Full path to the directory
+	 * @param string $dir2  Full path to the new directory
 	 *
 	 * @return bool  Success or failure
 	 */
-	function copy_directory_recursive($dir1, $dir2, $mode = 0755)
+	function copy_directory_recursive(string $dir1, string $dir2, $mode = 0755)
 	{
 		$handle = opendir($dir1);
 
@@ -106,6 +106,8 @@ function copy_directory_recursive($dir1, $dir2, $mode = 0755)
 		}
 
 		closedir($handle);
+
+		return true;
 	}
 }