UseMuffin · ADmad · Sep 12, 2020 · Aug 8, 2019 · Aug 8, 2019 · Aug 8, 2019
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
 /composer.lock
 /plugins
 /vendor
+.phpunit.result.cache
+.idea
diff --git a/.travis.yml b/.travis.yml
@@ -1,11 +1,7 @@
 language: php

-dist: trusty
-
 php:
-  - 5.6
  - 7.2
-  - 7.3
  - 7.4

 env:
@@ -16,25 +12,32 @@ matrix:
  fast_finish: true

  include:
-    - php: 7.1
+    - php: 7.2
      env: PHPCS=1 DEFAULT=0

-    - php: 5.6
+    - php: 7.2
+      env: STATIC_ANALYSIS=1 DEFAULT=0
+
+    - php: 7.2
      env: PREFER_LOWEST=1

 before_script:
-  - if [[ $TRAVIS_PHP_VERSION != 7.2 ]]; then phpenv config-rm xdebug.ini; fi
+  - if [[ $DEFAULT == 1 && $TRAVIS_PHP_VERSION != 7.2 ]]; then phpenv config-rm xdebug.ini; fi

  - if [[ $PREFER_LOWEST != 1 ]]; then composer install --no-interaction; fi
  - if [[ $PREFER_LOWEST = 1 ]]; then composer update --no-interaction --prefer-lowest --prefer-stable; fi

+  - if [[ $STATIC_ANALYSIS == 1 ]]; then composer require --dev phpstan/phpstan:^0.12; fi
+
 script:
-  - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION != 7.2 ]]; then vendor/bin/phpunit; fi
-  - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION = 7.2 ]]; then vendor/bin/phpunit --coverage-clover=clover.xml; fi
-  - if [[ $PHPCS = 1 ]]; then vendor/bin/phpcs -n -p --extensions=php --standard=vendor/cakephp/cakephp-codesniffer/CakePHP ./src ./tests; fi
+  - if [[ $DEFAULT == 1 && $TRAVIS_PHP_VERSION != 7.2 ]]; then vendor/bin/phpunit; fi
+  - if [[ $DEFAULT == 1 && $TRAVIS_PHP_VERSION == 7.2 ]]; then vendor/bin/phpunit --coverage-clover=clover.xml; fi
+
+  - if [[ $PHPCS == 1 ]]; then vendor/bin/phpcs -n -p --extensions=php --standard=vendor/cakephp/cakephp-codesniffer/CakePHP ./src ./tests; fi
+  - if [[ $STATIC_ANALYSIS == 1 ]]; then vendor/bin/phpstan analyse src; fi

 after_success:
-  - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION = 7.2 ]]; then bash <(curl -s https://codecov.io/bash); fi
+  - if [[ $DEFAULT = 1 && $TRAVIS_PHP_VERSION == 7.2 ]]; then bash <(curl -s https://codecov.io/bash); fi

 notifications:
  email: false
diff --git a/README.md b/README.md
@@ -5,96 +5,57 @@
 [![Total Downloads](https://img.shields.io/packagist/dt/muffin/footprint.svg?style=flat-square)](https://packagist.org/packages/muffin/footprint)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)

-This plugin allows you to pass the currently logged in user to the model layer of a CakePHP 3
-application.
+This plugin allows you to pass the currently logged in user info to the model layer
+of a CakePHP application.

-It comes bundled with the `FootprintBehavior` to allow you control over columns such as `user_id`,
-`created_by`, `company_id` just like the core's `TimestampBehavior`.
+It comes bundled with the `FootprintBehavior` to allow you control over columns
+such as `user_id`, `created_by`, `company_id` similar to the core's `TimestampBehavior`.

 ## Install

 Using [Composer][composer]:

 ```
 composer require muffin/footprint
-
 ```

 You then need to load the plugin by running console command:

 ```bash
-bin/cake plugin load Muffin/Footprint 
+bin/cake plugin load Muffin/Footprint
 ```

 ## Usage

 ### Trait

-First, you will need to include the `Muffin\Footprint\Auth\FootprintAwareTrait` to your `AppController`:
+First, you will need to include the `Muffin\Footprint\Auth\FootprintAwareTrait`
+to your `AppController`:

 ```php
 use Muffin\Footprint\Auth\FootprintAwareTrait;

 class AppController extends Controller
 {
    use FootprintAwareTrait;
-}
-```
-
-This will attach the `Muffin\Footprint\Event\FootprintListener` to models
-which will inject the currently logged in user's instance on `Model.beforeSave`
-and `Model.beforeFind` in the `_footprint` key of `$options`.
-
-The user record provided by `AuthComponent` is converted to `User` entity before
-passing to models. If your `AuthComponent` is configured to use a non-default
-users table you must set the `$_userModel` property of the trait to same table:
-
-```php
-public function initialize()
-{
-    parent::initialize();

    // Specify the user model if required. Defaults to "Users".
    $this->_userModel = 'YourPlugin.Members';
-
-    $this->loadComponent('Auth', [
-        'authenticate' => [
-            'Form' => [
-                'userModel' => $this->_userModel, // Use same model for AuthComponent
-            ],
-        ],
-    ]);
 }
 ```

-#### Using Footprint with cakephp/authentication
-
-If you are using the `cakephp/authentication` plugin instead of the `AuthComponent`, you will need to update your controller to tell Footprint where to find the identity. To do so, update the trait declaration and overwride `_setCurrentUser` to get the identity from the request:
-
-```php
-use Muffin\Footprint\Auth\FootprintAwareTrait;
+This will attach the `Muffin\Footprint\Event\FootprintListener` to models
+which will inject the currently logged in user's instance on `Model.beforeSave`
+and `Model.beforeFind` in the `_footprint` key of `$options`.

-class AppController extends Controller
-{
-    use FootprintAwareTrait {
-        _setCurrentUser as _footprintSetCurrentUser;
-    }
-
-    protected function _setCurrentUser($user = null)
-    {
-        if (!$user) {
-            $user = $this->request->getAttribute('identity')->getOriginalData();
-        }
-
-        return $this->_footprintSetCurrentUser($user);
-    }
-}
-```
+Your controller needs to have either `cakephp/authentication` plugin's `AuthenticationComponent`
+or CakePHP core's deprecated `AuthComponent` loaded so that the user identity
+can be fetched.

 ### Behavior

-To use the included behavior to automatically update the `created_by` and `modified_by` fields of a record for example,
-add the following to your table's `initialize()` method:
+To use the included behavior to automatically update the `created_by` and `modified_by`
+fields of a record for example, add the following to your table's `initialize()` method:

 ```php
 $this->addBehavior('Muffin/Footprint.Footprint');
@@ -117,9 +78,10 @@ $this->addBehavior('Muffin/Footprint.Footprint', [
 ]);
 ```

-This will insert the currently logged in user's primary key in `user_id` and `modified_by` fields when creating
-a record, on the `modified_by` field again when updating the record and it will use the associated user record's
-company `id` in the `company_id` field when creating a record.
+This will insert the currently logged in user's primary key in `user_id` and `modified_by`
+fields when creating a record, on the `modified_by` field again when updating
+the record and it will use the associated user record's company `id` in the
+`company_id` field when creating a record.

 ## Warning

@@ -136,18 +98,14 @@ is attached after `Controller::initialize()` is run.
 * Fork
 * Mod, fix
 * Test - this is important, so it's not unintentionally broken
-* Commit - do not mess with license, todo, version, etc. (if you do change any, bump them into commits of
-their own that I can ignore when I pull)
+* Commit - do not mess with license, todo, version, etc. (if you do change any,
+  bump them into commits of their own that I can ignore when I pull)
 * Pull request - bonus point for topic branches

 ## Bugs & Feedback

 http://github.com/usemuffin/footprint/issues

-## Credits
-
-This was originally inspired by [Ceeram/Blame].
-
 ## License

 Copyright (c) 2015-Present, [Use Muffin][muffin] and licensed under [The MIT License][mit].

diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
    "name": "muffin/footprint",
-    "description": "CakePHP 3.0+ plugin to allow passing currently logged in user to model layer",
+    "description": "CakePHP plugin to allow passing currently logged in user to model layer",
    "type": "cakephp-plugin",
    "keywords": [
        "cakephp",
@@ -30,11 +30,15 @@
        "source": "https://github.com/usemuffin/footprint"
    },
    "require": {
-        "cakephp/cakephp": "^3.5"
+        "cakephp/cakephp": "^4.0"
    },
    "require-dev": {
-        "cakephp/cakephp-codesniffer": "^3.0",
-        "phpunit/phpunit": "^5.7.14|^6.0"
+        "cakephp/cakephp-codesniffer": "^4.0",
+        "phpunit/phpunit": "~8.5.0"
+    },
+    "scripts": {
+        "cs-check": "phpcs --colors -p --standard=vendor/cakephp/cakephp-codesniffer/CakePHP src/ tests/",
+        "cs-fix": "phpcbf --colors --standard=vendor/cakephp/cakephp-codesniffer/CakePHP src/ tests/"
    },
    "autoload": {
        "psr-4": {

diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,10 @@
+parameters:
+    level: 6
+    checkGenericClassInNonGenericObjectType: false
+    checkMissingIterableValueType: false
+    treatPhpDocTypesAsCertain: false
+    ignoreErrors:
+        -
+            message: "#^Negated boolean expression is always true\\.$#"
+            count: 1
+            path: src/Model/Behavior/FootprintBehavior.php
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -22,14 +22,9 @@
        </listener>
    </listeners>

-    <!-- Prevent coverage reports from looking in tests and vendors -->
    <filter>
-        <blacklist>
-            <directory suffix=".php">./vendor/</directory>
-            <directory suffix=".ctp">./vendor/</directory>
-
-            <directory suffix=".php">./tests/</directory>
-            <directory suffix=".ctp">./tests/</directory>
-        </blacklist>
+       <whitelist>
+            <directory suffix=".php">./src/</directory>
+        </whitelist>
    </filter>
 </phpunit>