Merge pull request #33 from tattersoftware/devkit

MGatner · web-flow · commit cb1f2cef539c · 2024-02-03T17:42:53.000-05:00
Update DevKit
diff --git a/.github/workflows/deptrac.yml b/.github/workflows/deptrac.yml
@@ -36,24 +36,23 @@ jobs:
           extensions: intl, json, mbstring, xml
           coverage: none
         env:
-          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Get composer cache directory
-        id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+        run: echo "COMPOSER_CACHE_FILES_DIR=$(composer config cache-files-dir)" >> $GITHUB_ENV
 
       - name: Cache composer dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
-          path: ${{ steps.composer-cache.outputs.dir }}
+          path: ${{ env.COMPOSER_CACHE_FILES_DIR }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ hashFiles('**/composer.lock') }}
           restore-keys: ${{ runner.os }}-composer-
 
       - name: Create Deptrac cache directory
         run: mkdir -p build/
 
       - name: Cache Deptrac results
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: build
           key: ${{ runner.os }}-deptrac-${{ github.sha }}
diff --git a/.github/workflows/infection.yml b/.github/workflows/infection.yml
@@ -9,14 +9,6 @@ on:
       - 'composer.*'
       - 'phpunit*'
       - '.github/workflows/infection.yml'
-  push:
-    branches:
-      - develop
-    paths:
-      - '**.php'
-      - 'composer.*'
-      - 'phpunit*'
-      - '.github/workflows/infection.yml'
 
 jobs:
   main:
@@ -36,7 +28,7 @@ jobs:
           extensions: intl, json, mbstring, gd, xml, sqlite3
           coverage: xdebug
         env:
-          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Set up problem matchers for PHPUnit
         run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
@@ -45,13 +37,12 @@ jobs:
         uses: mheap/phpunit-matcher-action@v1
 
       - name: Get composer cache directory
-        id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+        run: echo "COMPOSER_CACHE_FILES_DIR=$(composer config cache-files-dir)" >> $GITHUB_ENV
 
       - name: Cache composer dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
-          path: ${{ steps.composer-cache.outputs.dir }}
+          path: ${{ env.COMPOSER_CACHE_FILES_DIR }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ hashFiles('**/composer.lock') }}
           restore-keys: ${{ runner.os }}-composer-
 
@@ -63,10 +54,7 @@ jobs:
             composer update --no-progress --no-interaction --prefer-dist --optimize-autoloader
           fi
 
-      - name: Test with PHPUnit
-        run: vendor/bin/phpunit --teamcity
-
-      - name: Mutate with Infection
+      - name: Run Infection for added files only
         run: |
           git fetch --depth=1 origin $GITHUB_BASE_REF
-          infection --threads=2 --skip-initial-tests --coverage=build/phpunit --git-diff-base=origin/$GITHUB_BASE_REF --git-diff-filter=AM --logger-github --ignore-msi-with-no-mutations
+          infection --threads=max --git-diff-lines --git-diff-base=origin/$GITHUB_BASE_REF --ignore-msi-with-no-mutations --only-covered --logger-github
diff --git a/.github/workflows/phpcsfixer.yml b/.github/workflows/phpcsfixer.yml
@@ -31,16 +31,15 @@ jobs:
           extensions: json, tokenizer
           coverage: none
         env:
-          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Get composer cache directory
-        id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+        run: echo "COMPOSER_CACHE_FILES_DIR=$(composer config cache-files-dir)" >> $GITHUB_ENV
 
       - name: Cache composer dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
-          path: ${{ steps.composer-cache.outputs.dir }}
+          path: ${{ env.COMPOSER_CACHE_FILES_DIR }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ hashFiles('**/composer.lock') }}
           restore-keys: ${{ runner.os }}-composer-
 
diff --git a/.github/workflows/phpstan.yml b/.github/workflows/phpstan.yml
@@ -26,7 +26,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-versions: ['7.4', '8.0', '8.1']
+        php-versions: ['7.4', '8.0', '8.1', '8.2']
 
     steps:
       - name: Checkout
@@ -40,24 +40,23 @@ jobs:
           extensions: intl, json, mbstring, xml
           coverage: none
         env:
-          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Get composer cache directory
-        id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+        run: echo "COMPOSER_CACHE_FILES_DIR=$(composer config cache-files-dir)" >> $GITHUB_ENV
 
       - name: Cache composer dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
-          path: ${{ steps.composer-cache.outputs.dir }}
+          path: ${{ env.COMPOSER_CACHE_FILES_DIR }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ 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@v3
+        uses: actions/cache@v4
         with:
           path: build/phpstan
           key: ${{ runner.os }}-phpstan-${{ github.sha }}
diff --git a/.github/workflows/phpunit.yml b/.github/workflows/phpunit.yml
@@ -25,7 +25,7 @@ jobs:
     if: "!contains(github.event.head_commit.message, '[ci skip]')"
     strategy:
       matrix:
-        php-versions: ['7.4', '8.0', '8.1']
+        php-versions: ['7.4', '8.0', '8.1', '8.2']
 
     steps:
       - name: Checkout
@@ -39,16 +39,15 @@ jobs:
           extensions: intl, json, mbstring, gd, xdebug, xml, sqlite3
           coverage: xdebug
         env:
-          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Get composer cache directory
-        id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+        run: echo "COMPOSER_CACHE_FILES_DIR=$(composer config cache-files-dir)" >> $GITHUB_ENV
 
       - name: Cache composer dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
-          path: ${{ steps.composer-cache.outputs.dir }}
+          path: ${{ env.COMPOSER_CACHE_FILES_DIR }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ hashFiles('**/composer.lock') }}
           restore-keys: ${{ runner.os }}-composer-
 
@@ -66,7 +65,7 @@ jobs:
           TERM: xterm-256color
           TACHYCARDIA_MONITOR_GA: enabled
 
-      - if: matrix.php-versions == '8.0'
+      - if: matrix.php-versions == '8.1'
         name: Run Coveralls
         continue-on-error: true
         run: |
diff --git a/.github/workflows/psalm.yml b/.github/workflows/psalm.yml
@@ -36,24 +36,23 @@ jobs:
           extensions: intl, json, mbstring, xml
           coverage: none
         env:
-          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Get composer cache directory
-        id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+        run: echo "COMPOSER_CACHE_FILES_DIR=$(composer config cache-files-dir)" >> $GITHUB_ENV
 
       - name: Cache composer dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
-          path: ${{ steps.composer-cache.outputs.dir }}
+          path: ${{ env.COMPOSER_CACHE_FILES_DIR }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ hashFiles('**/composer.lock') }}
           restore-keys: ${{ runner.os }}-composer-
 
       - name: Create Psalm cache directory
         run: mkdir -p build/psalm
 
       - name: Cache Psalm results
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: build/psalm
           key: ${{ runner.os }}-psalm-${{ github.sha }}
diff --git a/.github/workflows/rector.yml b/.github/workflows/rector.yml
@@ -26,7 +26,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-versions: ['7.4', '8.0', '8.1']
+        php-versions: ['7.4', '8.0', '8.1', '8.2']
 
     steps:
       - name: Checkout
@@ -40,16 +40,15 @@ jobs:
           extensions: intl, json, mbstring, xml
           coverage: none
         env:
-          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Get composer cache directory
-        id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+        run: echo "COMPOSER_CACHE_FILES_DIR=$(composer config cache-files-dir)" >> $GITHUB_ENV
 
       - name: Cache composer dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
-          path: ${{ steps.composer-cache.outputs.dir }}
+          path: ${{ env.COMPOSER_CACHE_FILES_DIR }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ hashFiles('**/composer.lock') }}
           restore-keys: ${{ runner.os }}-composer-
 
@@ -62,6 +61,4 @@ jobs:
           fi
 
       - name: Analyze for refactoring
-        run: |
-          composer global require --dev rector/rector:^0.13.8
-          rector process --dry-run --no-progress-bar
+        run: vendor/bin/rector process --dry-run --no-progress-bar
diff --git a/.github/workflows/unused.yml b/.github/workflows/unused.yml
@@ -34,16 +34,15 @@ jobs:
           extensions: intl, json, mbstring, xml
           coverage: none
         env:
-          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Get composer cache directory
-        id: composer-cache
-        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+        run: echo "COMPOSER_CACHE_FILES_DIR=$(composer config cache-files-dir)" >> $GITHUB_ENV
 
       - name: Cache composer dependencies
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
-          path: ${{ steps.composer-cache.outputs.dir }}
+          path: ${{ env.COMPOSER_CACHE_FILES_DIR }}
           key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ hashFiles('**/composer.lock') }}
           restore-keys: ${{ runner.os }}-composer-
 
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -10,10 +10,19 @@
         __DIR__ . '/src/',
         __DIR__ . '/tests/',
     ])
-    ->exclude('build')
-    ->append([__FILE__]);
+    ->exclude([
+        'build',
+        'Views',
+    ])
+    ->append([
+        __FILE__,
+        __DIR__ . '/rector.php',
+    ]);
 
-$overrides = [];
+$overrides = [
+    // 'declare_strict_types' => true,
+    // 'void_return'          => true,
+];
 
 $options = [
     'finder'    => $finder,
diff --git a/composer.json b/composer.json
@@ -25,7 +25,8 @@
     "require-dev": {
         "codeigniter4/framework": "^4.2",
         "tatter/imposter": "^1.0",
-        "tatter/tools": "^2.0"
+        "tatter/tools": "^2.0",
+        "kint-php/kint": "^5.1"
     },
     "suggest": {
         "codeigniter4/authentication-implementation": "Required to track authenticated users."
diff --git a/examples/Visits.php b/examples/Visits.php
@@ -20,51 +20,52 @@
 class Visits extends BaseConfig
 {
     /**
-     * Whether to enable tracking in all controllers using
-     * the post_controller_constructor event.
-     */
-    public bool $trackAllPages = true;
-
-    /**
-     * Metric for tracking a unique visitor
+     * Database field for tracking a unique visitor
      *
      * @var 'ip_address'|'session_id'|'user_id'
      */
-    public $trackingMethod = 'ip_address';
+    public string $trackingMethod = 'ip_address';
 
     /**
-     * Session variable to check for a logged-in user ID
-     *
-     * @deprecated Next version will rely on codeigniter4/authentication-implementation
-     *
-     * @var string
+     * Number of seconds before a visit counts as new
+     * instead of incrementing a previous view count.
+     * Set to zero to record each page view as unique (not recommended).
      */
-    public $userSource = 'logged_in';
+    public int $resetAfter = HOUR;
 
     /**
-     * Number of minutes before a visit counts as new
-     * instead of incrementing a previous view count.
-     * Set to zero to record each page view as unique (not recommended).
+     * Transformers to apply (in order) before
+     * recording the visit data.
      *
-     * @var int
+     * @see VisitModel::applyTransformations()
+     *
+     * @var class-string<Transformer>[]
      */
-    public $resetMinutes = 60;
+    public array $transformers = [];
 
     /**
      * Whether to ignore AJAX requests when recording.
      * See framework User Guide for caveats.
      *
      * @see https://www.codeigniter.com/user_guide/general/ajax.html
-     *
-     * @var bool
      */
-    public $ignoreAjax = true;
+    public bool $ignoreAjax = true;
 
     /**
-     * URIs to exclude from tracking.
-     * Accepts regex values.
-     *
-     * @var string[]
+     * Whether to ignore requests that result in a redirect response.
+     * Note: requires using the "after" filter method.
+     */
+    public bool $ignoreRedirects = true;
+
+    /**
+     * Whether to ignore requests that result in an empty body.
+     * Note: requires using the "after" filter method.
+     */
+    public bool $requireBody = false;
+
+    /**
+     * Whether to ignore requests with Content Types other than HTML.
+     * Note: requires using the "after" filter method.
      */
-    public array $excludeUris = [];
+    public bool $requireHtml = false;
 }
diff --git a/psalm.xml b/psalm.xml
@@ -7,6 +7,8 @@
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
     autoloader="psalm_autoload.php"
     cacheDirectory="build/psalm/"
+    findUnusedBaselineEntry="true"
+    findUnusedCode="false"
 >
     <projectFiles>
         <directory name="src/" />
diff --git a/psalm_autoload.php b/psalm_autoload.php
diff --git a/rector.php b/rector.php
diff --git a/src/Entities/Visit.php b/src/Entities/Visit.php
diff --git a/tests/EntityTest.php b/tests/EntityTest.php
diff --git a/tests/FilterTest.php b/tests/FilterTest.php
diff --git a/tests/ModelTest.php b/tests/ModelTest.php
