add configuration files

Author: MayMeow

.github/workflliws/ci.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on:
+  push:
+    branches: [ master, development/* ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  cs-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Composer run action PHPC_CS
+        uses: MayMeowHQ/composer-run-action@v3
+        with:
+          composer_script: 'cs-check'
+
+  stan:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Composer run action PHPStan
+        uses: MayMeowHQ/composer-run-action@v3
+        with:
+          composer_script: 'stan'
+          memory_limit: '1024M'

composer.json

@@ -8,7 +8,9 @@
         "cakephp/cakephp": "~4.1.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^8.0"
+        "cakephp/cakephp-codesniffer": "^4.5",
+        "phpstan/phpstan": "^0.12.99",
+        "phpunit/phpunit": "^9.5"
     },
     "autoload": {
         "psr-4": {
@@ -18,7 +20,14 @@
     "autoload-dev": {
         "psr-4": {
             "FileUpload\\Test\\": "tests/",
-            "Cake\\Test\\": "vendor/cakephp/cakephp/tests/"
+            "Cake\\Test\\": "vendor/cakephp/cakephp/tests/",
+            "App\\": "tests/test_app/src/"
         }
+    },
+
+    "scripts": {
+        "cs-check": "phpcs --colors -p  src/ tests/",
+        "cs-fix": "phpcbf --colors -p src/ tests/",
+        "stan": "phpstan analyse"
     }
 }

docker-compose-dev.yml

@@ -0,0 +1,13 @@
+version: "3"
+
+services:
+  app:
+    build:
+      args:
+        user: vscode
+        uid: 1000
+      context: ./
+      dockerfile: docker/devcontainer/Dockerfile
+    working_dir: /app
+    volumes: 
+      - "./:/app"

docker/devcontainer/Dockerfile

@@ -0,0 +1,12 @@
+FROM ghcr.io/maymeow/php-ci-cd/php-ci-cd:7.4.16-cs-1
+
+# arguments in docker-compose file
+ARG user=vscode
+ARG uid=1000
+
+# Create system user to run Composer and Artisan Commands
+RUN useradd -G www-data,root -u $uid -d /home/$user $user
+RUN mkdir -p /home/$user/.composer && \
+    chown -R $user:$user /home/$user
+
+USER $user

phpcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0"?>
+<ruleset name="App">
+    <config name="installed_paths" value="../../cakephp/cakephp-codesniffer"/>
+
+    <rule ref="CakePHP"/>
+</ruleset>

phpstan.neon

@@ -0,0 +1,9 @@
+parameters:
+    level: 7
+    checkMissingIterableValueType: false
+    treatPhpDocTypesAsCertain: false
+    paths:
+        - src
+    bootstrapFiles:
+        - tests/bootstrap.php
+        

src/Controller/Component/UploadComponent.php

@@ -4,7 +4,6 @@
 namespace FileUpload\Controller\Component;
 
 use Cake\Controller\Component;
-use Cake\Controller\ComponentRegistry;
 use Cake\Http\Exception\HttpException;
 use Cake\Http\ServerRequest;
 use Psr\Http\Message\UploadedFileInterface;
@@ -22,15 +21,15 @@ class UploadComponent extends Component
     protected $_defaultConfig = [
         'fieldName' => 'uploaded_file',
         'storagePath' => ROOT . DS . 'storage' . DS,
-        'allowedFileTypes' => '*'
+        'allowedFileTypes' => '*',
     ];
 
     /**
      * Move uploaded file to storage
      */
-    public function getFile(ServerRequest $serverRequest) : UploadedFileInterface
+    public function getFile(ServerRequest $serverRequest): UploadedFileInterface
     {
-        /** @var UploadedFileInterface */
+        /** @var \Psr\Http\Message\UploadedFileInterface */
         $fileObject = $serverRequest->getData($this->getConfig('fieldName'));
 
         if ($this->_isAllowedFileType($fileObject->getClientMediaType())) {
@@ -45,9 +44,11 @@ public function getFile(ServerRequest $serverRequest) : UploadedFileInterface
     /**
      * Check if file type is allowd
      */
-    private function _isAllowedFileType(string $fileType) : bool
+    private function _isAllowedFileType(string $fileType): bool
     {
-        if ($this->getConfig('allowedFileTypes') == "*") return true;
+        if ($this->getConfig('allowedFileTypes') == '*') {
+            return true;
+        }
 
         if (is_array($this->getConfig('allowedFileTypes'))) {
             if (in_array($fileType, $this->getConfig('allowedFileTypes'))) {

src/Plugin.php

@@ -52,7 +52,7 @@ function (RouteBuilder $builder) {
     /**
      * Add middleware for the plugin.
      *
-     * @param \Cake\Http\MiddlewareQueue $middleware The middleware queue to update.
+     * @param \Cake\Http\MiddlewareQueue $middlewareQueue The middleware queue to update.
      * @return \Cake\Http\MiddlewareQueue
      */
     public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue

tests/bootstrap.php

@@ -17,7 +17,7 @@
         }
     } while ($root !== $lastRoot);
 
-    throw new Exception("Cannot find the root of the application, unable to run tests");
+    throw new Exception('Cannot find the root of the application, unable to run tests');
 };
 $root = $findRoot(__FILE__);
 unset($findRoot);