Support Statamic 6 (#25)

Author: ryanmitchell

.github/workflows/tests.yml

@@ -12,9 +12,9 @@ jobs:
 
     strategy:
       matrix:
-        php: [8.3, 8.2]
-        laravel: [11.*]
-        statamic: [^5.0]
+        php: [8.4, 8.3]
+        laravel: [12.*]
+        statamic: [^6.0]
         os: [ubuntu-latest]
 
     name: ${{ matrix.php }} - ${{ matrix.statamic }} - ${{ matrix.laravel }}

README.md

@@ -85,3 +85,4 @@ To invalidate all pages containing your tracked data call:
 Tracker::flush();
 ```
 
+Alternatively you can use the Cache Tracker Utility in the CP to enter a list of URLs you want to clear.

composer.json

@@ -11,17 +11,17 @@
         }
     },
     "require": {
-        "php": "^8.1",
+        "php": "^8.2",
         "pixelfear/composer-dist-plugin": "^0.1.5",
-        "statamic/cms": "^4.55 || ^5.0"
+        "statamic/cms": "^6.0"
     },
     "require-dev": {
         "laravel/pint": "^1.13",
         "mockery/mockery": "^1.3.1",
         "nunomaduro/collision": "^8.0",
-        "orchestra/testbench": "^9.0",
-        "pestphp/pest": "^2.24",
-        "phpunit/phpunit": "^10.0"
+        "orchestra/testbench": "^10.0",
+        "pestphp/pest": "^4.0",
+        "phpunit/phpunit": "^12.0"
     },
     "extra": {
         "statamic": {
@@ -39,5 +39,6 @@
             "pestphp/pest-plugin": true,
             "pixelfear/composer-dist-plugin": true
         }
-    }
+    },
+    "minimum-stability": "alpha"
 }

package.json

@@ -0,0 +1,15 @@
+{
+    "dependencies": {
+        "@statamic/cms": "file:./vendor/statamic/cms/resources/dist-package",
+        "axios": "^1.12.2"
+    },
+    "scripts": {
+        "dev": "vite",
+        "build": "vite build",
+        "production": "vite build"
+    },
+    "devDependencies": {
+        "laravel-vite-plugin": "^1.2.0",
+        "vite": "^6.3.4"
+    }
+}

resources/js/components/CacheTrackerModal.vue

@@ -0,0 +1,92 @@
+<script setup>
+import axios from 'axios';
+import { ref } from 'vue';
+
+const props = defineProps({
+    action: { type: Object, required: true },
+});
+
+const getColor = (tag) => {
+    if (tag.indexOf('collection:') === 0) {
+        return 'yellow';
+    }
+
+    if (tag.indexOf('term:') === 0) {
+        return 'rose';
+    }
+
+    if (tag.indexOf('global:') === 0) {
+        return 'violet';
+    }
+
+    if (tag.indexOf('partial:') === 0) {
+        return 'blue';
+    }
+
+    return 'green';
+}
+
+const setShowWhat = (what) => {
+    show.value = what;
+}
+
+const item = props.action?.item_title ?? '';
+const url = props.action?.item_url ?? '';
+const show = ref('tags');
+const tags = ref([]);
+const urls = ref([]);
+
+axios
+    .post(cp_url(`/cache-tracker/tags`), { url: url })
+    .then(response => {
+        tags.value = response.data;
+    })
+    .catch((e) => { });
+
+axios
+    .post(cp_url(`/cache-tracker/urls`), { url: url })
+    .then(response => {
+        urls.value = response.data;
+    })
+    .catch((e) => { });
+</script>
+
+<template>
+    <div>
+        <ui-button-group class="mb-4">
+            <ui-button :variant="show == 'tags' ? 'primary' : 'default'" size="sm" @click="setShowWhat('tags')">Tags on this URL</ui-button>
+            <ui-button :variant="show == 'urls' ? 'primary' : 'default'"  size="sm" @click="setShowWhat('urls')">URLs with this item</ui-button>
+        </ui-button-group>
+
+        <div v-if="show == 'tags'">
+
+            <ui-description v-text="__('There are no tags tracked on :url.', { url: url })" v-if="tags.length < 1"></ui-description>
+
+            <ui-description v-text="__('The following tags are being tracked on :url:', { url: url })" v-if="tags.length"></ui-description>
+
+            <div class="flex gap-2 mt-4" v-if="tags.length">
+
+                <template v-for="tag in tags">
+                    <ui-badge pill :color="getColor(tag)" v-text="tag"></ui-badge>
+                </template>
+
+            </div>
+
+        </div>
+
+        <div v-if="show == 'urls'">
+            <ui-description v-text="__('There are no urls tracked containing :item.', { item: item })" v-if="urls.length < 1"></ui-description>
+
+            <ui-description v-text="__('The following URLs contain :item:', { item: 'ryan' })" v-if="urls.length"></ui-description>
+
+            <div class="flex gap-2 mt-4" v-if="urls.length">
+
+                <template v-for="url in urls">
+                    <a :href="url" v-text="url"></a><br />
+                </template>
+
+            </div>
+
+        </div>
+    </div>
+</template>

resources/js/cp.js

@@ -0,0 +1,8 @@
+import CacheTrackerModal from './components/CacheTrackerModal.vue';
+import ClearUtility from "./pages/ClearUtility.vue";
+
+Statamic.booting(() => {
+    Statamic.$components.register('cache-tracker-modal', CacheTrackerModal);
+
+    Statamic.$components.register('Pages/CacheTracker/ClearUtility', ClearUtility);
+});

resources/js/pages/ClearUtility.vue

@@ -0,0 +1,38 @@
+<script setup>
+import axios from 'axios';
+import { ref } from 'vue';
+
+const urls = ref('');
+
+const clearCache = async () => {
+    let response = await axios.post(cp_url('utilities/static-cache-tracker/clear'), { urls: urls.value });
+
+    Statamic.$toast.success(response.data.message);
+}
+
+</script>
+
+<template>
+    <ui-header :title="__('Cache Tracker')" icon="taxonomies">
+        <ui-button class="btn-primary" v-text="__('Clear everything')" @click="urls = '*'; clearCache();" />
+    </ui-header>
+
+    <ui-panel class="h-full flex flex-col">
+        <ui-panel-header class="flex items-center justify-between min-h-10">
+            <ui-heading>{{ __('Enter URLs to clear, with each on a new line. You can use * as a wildcard at the end of your URL.') }}</ui-heading>
+        </ui-panel-header>
+
+        <ui-card class="flex-1">
+
+            <ui-field>
+                <ui-textarea label="Enter URLs" v-model="urls" />
+            </ui-field>
+
+            <ui-field class="mt-4 flex justify-end">
+                <ui-button variant="primary" v-text="__('Clear')" @click="clearCache" />
+            </ui-field>
+
+        </ui-card>
+    </ui-panel>
+
+</template>

routes/cp.php

@@ -0,0 +1,9 @@
+<?php
+
+use Illuminate\Support\Facades\Route;
+use Thoughtco\StatamicCacheTracker\Http\Controllers;
+
+Route::name('cache-tracker.')->prefix('cache-tracker')->group(function () {
+    Route::post('tags', [Controllers\GetTagsController::class, '__invoke'])->name('tags');
+    Route::post('urls', [Controllers\GetUrlsController::class, '__invoke'])->name('url');
+});

src/Actions/ClearCache.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace Thoughtco\StatamicCacheTracker\Actions;
+
+use Statamic\Actions\Action;
+use Statamic\Contracts\Entries\Entry;
+use Statamic\Contracts\Taxonomies\Term;
+use Statamic\Facades\Blink;
+use Thoughtco\StatamicCacheTracker\Facades\Tracker;
+
+class ClearCache extends Action
+{
+    public function run($items, $values)
+    {
+        $items->filter(fn ($item) => $item->absoluteUrl())
+            ->each(fn ($item) => Tracker::remove($item->absoluteUrl()));
+
+        return __('Cache cleared');
+    }
+
+    public function icon(): string
+    {
+        return 'rewind';
+    }
+
+    public static function title()
+    {
+        return __('Clear cache');
+    }
+
+    public function confirmationText()
+    {
+        return __('Are you sure you want to clear the static cache for the url: :url ?', ['url' => $this->items->first()->absoluteUrl()]);
+    }
+
+    public function visibleTo($item)
+    {
+        if (! auth()->user()->can('clear cache tracker tags')) {
+            return false;
+        }
+
+        if (! ($item instanceof Entry || $item instanceof Term)) {
+            return false;
+        }
+
+        return ! Blink::once(
+            'cache-action::'.$item->collectionHandle.'::'.$item->locale(),
+            fn () => is_null($item->collection()->route($item->locale()))
+        );
+    }
+}

src/Actions/ViewCacheTags.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace Thoughtco\StatamicCacheTracker\Actions;
+
+use Statamic\Actions\Action;
+use Statamic\Contracts\Entries\Entry;
+use Statamic\Facades\Blink;
+
+class ViewCacheTags extends Action
+{
+    protected $component = 'cache-tracker-modal';
+
+    protected $runnable = false;
+
+    public function run($items, $values)
+    {
+        // no running in the corridor
+    }
+
+    public function icon(): string
+    {
+        return 'taxonomies';
+    }
+
+    public static function title()
+    {
+        return __('View cache tags');
+    }
+
+    public function visibleTo($item)
+    {
+        if (! auth()->user()->can('view cache tracker tags')) {
+            return false;
+        }
+
+        if (! $item instanceof Entry) {
+            return false;
+        }
+
+        return ! Blink::once(
+            'cache-action::'.$item->collectionHandle.'::'.$item->locale(),
+            fn () => is_null($item->collection()->route($item->locale()))
+        );
+    }
+
+    public function visibleToBulk($items)
+    {
+        return false;
+    }
+
+    public function buttonText()
+    {
+        /** @translation */
+        return __('Clear cache');
+    }
+
+    public function toArray()
+    {
+        return [
+            ...parent::toArray(),
+            'item_title' => $this->items->first()?->title,
+            'item_url' => $this->items->first()?->absoluteUrl(),
+        ];
+    }
+}