[5.x] Allow configuring the Stache's Cache Store#10303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jasonvarga merged 7 commits into from
Jun 24, 2024
Merged

[5.x] Allow configuring the Stache's Cache Store #10303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
37563fb
Allow configuring the Stache's Cache Store
riasvdv Jun 14, 2024
7f266c9
Add a custom store test
riasvdv Jun 14, 2024
61db105
Run Pint
riasvdv Jun 14, 2024
78c4b85
Fix missed tests
riasvdv Jun 14, 2024
7817448
Update Stache.php
riasvdv Jun 15, 2024
8f891d3
Merge branch '5.x' into stache-cache-store
riasvdv Jun 24, 2024
4f0c4b4
fix the config location
jasonvarga Jun 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions config/stache.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,17 @@

'watcher' => env('STATAMIC_STACHE_WATCHER', 'auto'),

/*
|--------------------------------------------------------------------------
| Cache Store
|--------------------------------------------------------------------------
|
| Here you may configure which Cache Store the Stache uses.
|
*/

'cache_store' => null,

/*
|--------------------------------------------------------------------------
| Stores
Expand Down
1 change: 1 addition & 0 deletions src/Facades/Stache.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
* @method static self registerStores($stores)
* @method static mixed stores()
* @method static mixed store($key)
* @method static \Illuminate\Contracts\Cache\Store cacheStore()
* @method static string generateId()
* @method static self clear()
* @method static void refresh()
Expand Down
7 changes: 3 additions & 4 deletions src/Stache/Duplicates.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache;

use Illuminate\Support\Facades\Cache;
use Statamic\Stache\Stores\AggregateStore;
use Statamic\Stache\Stores\Store;

Expand DownExpand Up@@ -49,19 +48,19 @@ public function cache()
return;
}

Cache::forever('stache::duplicates', $this->items);
$this->stache->cacheStore()->forever('stache::duplicates', $this->items);
}

public function load()
{
$this->items = Cache::get('stache::duplicates', []);
$this->items = $this->stache->cacheStore()->get('stache::duplicates', []);

return $this;
}

public function clear()
{
Cache::forget('stache::duplicates');
$this->stache->cacheStore()->forget('stache::duplicates');

return $this;
}
Expand Down
9 changes: 4 additions & 5 deletions src/Stache/Indexes/Index.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache\Indexes;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\Stache;
use Statamic\Statamic;

Expand DownExpand Up@@ -76,7 +75,7 @@ public function load()

debugbar()->addMessage("Loading index: {$this->store->key()}/{$this->name}", 'stache');

$this->items = Cache::get($this->cacheKey());
$this->items = Stache::cacheStore()->get($this->cacheKey());

if ($this->items === null) {
$this->update();
Expand DownExpand Up@@ -106,12 +105,12 @@ public function update()

public function isCached()
{
return Cache::has($this->cacheKey());
return Stache::cacheStore()->has($this->cacheKey());
}

public function cache()
{
Cache::forever($this->cacheKey(), $this->items);
Stache::cacheStore()->forever($this->cacheKey(), $this->items);
}

public function updateItem($item)
Expand DownExpand Up@@ -153,7 +152,7 @@ public function clear()
$this->loaded = false;
$this->items = null;

Cache::forget($this->cacheKey());
Stache::cacheStore()->forget($this->cacheKey());
}

public static function currentlyLoading()
Expand Down
13 changes: 9 additions & 4 deletions src/Stache/Stache.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,11 @@ public function stores()
return $this->stores;
}

public function cacheStore()
{
return Cache::store(config('statamic.stache.cache_store'));
}

public function store($key)
{
if (Str::contains($key, '::')) {
Expand All@@ -85,7 +90,7 @@ public function clear()

$this->duplicates()->clear();

Cache::forget('stache::timing');
$this->cacheStore()->forget('stache::timing');

return $this;
}
Expand DownExpand Up@@ -146,7 +151,7 @@ public function stopTimer()
return $this;
}

Cache::forever('stache::timing', [
$this->cacheStore()->forever('stache::timing', [
'time' => floor((microtime(true) - $this->startTime) * 1000),
'date' => Carbon::now()->timestamp,
]);
Expand All@@ -156,12 +161,12 @@ public function stopTimer()

public function buildTime()
{
return Cache::get('stache::timing')['time'] ?? null;
return $this->cacheStore()->get('stache::timing')['time'] ?? null;
}

public function buildDate()
{
if (! $cache = Cache::get('stache::timing')) {
if (! $cache = $this->cacheStore()->get('stache::timing')) {
return null;
}

Expand Down
8 changes: 4 additions & 4 deletions src/Stache/Stores/BasicStore.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,8 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\File;
use Statamic\Facades\Stache;
use Symfony\Component\Finder\SplFileInfo;

abstract class BasicStore extends Store
Expand DownExpand Up@@ -77,7 +77,7 @@ protected function getCachedItem($key)
{
$cacheKey = $this->getItemCacheKey($key);

return Cache::get($cacheKey);
return Stache::cacheStore()->get($cacheKey);
}

protected function cacheItem($item)
Expand All@@ -86,12 +86,12 @@ protected function cacheItem($item)

$cacheKey = $this->getItemCacheKey($key);

Cache::forever($cacheKey, $item);
Stache::cacheStore()->forever($cacheKey, $item);
}

public function forgetItem($key)
{
Cache::forget($this->getItemCacheKey($key));
Stache::cacheStore()->forget($this->getItemCacheKey($key));
}

protected function getItemCacheKey($key)
Expand Down
4 changes: 2 additions & 2 deletions src/Stache/Stores/CollectionEntriesStore.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Entries\GetDateFromPath;
use Statamic\Entries\GetSlugFromPath;
use Statamic\Entries\GetSuffixFromPath;
Expand All@@ -13,6 +12,7 @@
use Statamic\Facades\File;
use Statamic\Facades\Path;
use Statamic\Facades\Site;
use Statamic\Facades\Stache;
use Statamic\Facades\YAML;
use Statamic\Stache\Indexes;
use Statamic\Stache\Indexes\Index;
Expand DownExpand Up@@ -230,7 +230,7 @@ protected function getCachedItem($key)
{
$cacheKey = $this->getItemCacheKey($key);

if (! $entry = Cache::get($cacheKey)) {
if (! $entry = Stache::cacheStore()->get($cacheKey)) {
return null;
}

Expand Down
3 changes: 1 addition & 2 deletions src/Stache/Stores/ContainerAssetsStore.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\AssetContainer;
use Statamic\Facades\Stache;
use Statamic\Statamic;
Expand DownExpand Up@@ -59,7 +58,7 @@ public function paths()
return $this->paths;
}

if ($paths = Cache::get($this->pathsCacheKey())) {
if ($paths = Stache::cacheStore()->get($this->pathsCacheKey())) {
return $this->paths = collect($paths);
}

Expand Down
8 changes: 4 additions & 4 deletions src/Stache/Stores/Keys.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\Stache;
use Statamic\Stache\Exceptions\DuplicateKeyException;

class Keys
Expand All@@ -17,19 +17,19 @@ public function __construct(Store $store)

public function load()
{
$this->keys = Cache::get($this->cacheKey(), []);
$this->keys = Stache::cacheStore()->get($this->cacheKey(), []);

return $this;
}

public function cache()
{
Cache::forever($this->cacheKey(), $this->keys);
Stache::cacheStore()->forever($this->cacheKey(), $this->keys);
}

public function clear()
{
Cache::forget($this->cacheKey());
Stache::cacheStore()->forget($this->cacheKey());
}

private function cacheKey()
Expand Down
18 changes: 9 additions & 9 deletions src/Stache/Stores/Store.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -97,7 +97,7 @@ public function indexUsage()
{
$key = $this->indexUsageCacheKey();

return $this->usedIndexes = $this->usedIndexes ?? collect(Cache::get($key, []));
return $this->usedIndexes = $this->usedIndexes ?? collect(Stache::cacheStore()->get($key, []));
}

public function cacheIndexUsage($index)
Expand All@@ -116,7 +116,7 @@ public function cacheIndexUsage($index)

$this->usedIndexes = $indexes;

Cache::put($this->indexUsageCacheKey(), $indexes->all());
Stache::cacheStore()->put($this->indexUsageCacheKey(), $indexes->all());
}

protected function indexUsageCacheKey()
Expand DownExpand Up@@ -180,14 +180,14 @@ public function handleFileChanges()

// Get the existing files and timestamps from the cache.
$cacheKey = "stache::timestamps::{$this->key()}";
$existing = collect(Cache::get($cacheKey, []));
$existing = collect(Stache::cacheStore()->get($cacheKey, []));

// Get the files and timestamps from the filesystem right now.
$files = Traverser::filter([$this, 'getItemFilter'])->traverse($this);

// Cache the files and timestamps, ready for comparisons on the next request.
// We'll do it now since there are multiple early returns coming up.
Cache::forever($cacheKey, $files->all());
Stache::cacheStore()->forever($cacheKey, $files->all());

// If there are no existing file timestamps in the cache, there's nothing to update.
if ($existing->isEmpty()) {
Expand DownExpand Up@@ -291,7 +291,7 @@ public function paths()
return $this->paths;
}

if ($paths = Cache::get($this->pathsCacheKey())) {
if ($paths = Stache::cacheStore()->get($this->pathsCacheKey())) {
return $this->paths = collect($paths);
}

Expand DownExpand Up@@ -351,7 +351,7 @@ protected function setPath($key, $path)

protected function cachePaths($paths)
{
Cache::forever($this->pathsCacheKey(), $paths->all());
Stache::cacheStore()->forever($this->pathsCacheKey(), $paths->all());

$this->paths = $paths;

Expand All@@ -361,7 +361,7 @@ protected function cachePaths($paths)
public function clearCachedPaths()
{
$this->paths = null;
Cache::forget($this->pathsCacheKey());
Stache::cacheStore()->forget($this->pathsCacheKey());
}

protected function pathsCacheKey()
Expand All@@ -381,13 +381,13 @@ public function clear()
});

$this->usedIndexes = collect();
Cache::forget($this->indexUsageCacheKey());
Stache::cacheStore()->forget($this->indexUsageCacheKey());

$this->clearCachedPaths();

$this->keys()->clear();

Cache::forget("stache::timestamps::{$this->key()}");
Stache::cacheStore()->forget("stache::timestamps::{$this->key()}");
}

public function warm()
Expand Down
3 changes: 1 addition & 2 deletions src/Stache/Stores/TaxonomyTermsStore.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,6 @@
namespace Statamic\Stache\Stores;

use Facades\Statamic\Stache\Traverser;
use Illuminate\Support\Facades\Cache;
use Statamic\Entries\GetSlugFromPath;
use Statamic\Facades\File;
use Statamic\Facades\Stache;
Expand DownExpand Up@@ -151,7 +150,7 @@ public function paths()
return $this->paths;
}

if ($paths = Cache::get($this->pathsCacheKey())) {
if ($paths = Stache::cacheStore()->get($this->pathsCacheKey())) {
return $this->paths = collect($paths);
}

Expand Down
9 changes: 7 additions & 2 deletions tests/Stache/DuplicatesTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,7 @@ public function it_saves_to_the_cache()

$stache = $this->mock(Stache::class);
$stache->shouldReceive('store')->with('test-store')->andReturn($store);
$stache->shouldReceive('cacheStore')->andReturn(Cache::store());

$duplicates = new Duplicates($stache);

Expand DownExpand Up@@ -146,7 +147,9 @@ public function it_loads_from_cache()
{
Cache::forever('stache::duplicates', ['foo' => 'bar']);

$duplicates = new Duplicates($this->mock(Stache::class));
$stache = $this->mock(Stache::class);
$stache->shouldReceive('cacheStore')->andReturn(Cache::store());
$duplicates = new Duplicates($stache);

$return = $duplicates->load();

Expand All@@ -159,7 +162,9 @@ public function it_clears_the_cache()
{
Cache::forever('stache::duplicates', ['foo' => 'bar']);

$duplicates = new Duplicates($this->mock(Stache::class));
$stache = $this->mock(Stache::class);
$stache->shouldReceive('cacheStore')->andReturn(Cache::store());
$duplicates = new Duplicates($stache);

$this->assertNotNull(Cache::get('stache::duplicates'));

Expand Down
2 changes: 2 additions & 0 deletions tests/Stache/Stores/AssetContainersStoreTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use Facades\Statamic\Stache\Traverser;
use Illuminate\Filesystem\Filesystem;
use Illuminate\Support\Facades\Cache;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Assets\Asset;
use Statamic\Contracts\Assets\AssetContainer;
Expand DownExpand Up@@ -115,6 +116,7 @@ public function it_saves_to_disk()
Facades\Stache::shouldReceive('duplicates')->andReturn(optional());
Facades\Stache::shouldReceive('store')->with('users')->andReturn((new UsersStore((new Stache)->sites(['en']), app('files')))->directory($this->tempDir));
Facades\Stache::shouldReceive('isWatcherEnabled')->andReturnTrue();
Facades\Stache::shouldReceive('cacheStore')->andReturn(Cache::store());

$container = Facades\AssetContainer::make('new')
->title('New Container');
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
[5.x] Allow configuring the Stache's Cache Store#10303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jasonvarga
merged 7 commits into

from

Jun 24, 2024
 Merged


[5.x] Allow configuring the Stache's Cache Store
#10303
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
37563fb

Allow configuring the Stache's Cache Store


riasvdv Jun 14, 2024
7f266c9

Add a custom store test


riasvdv Jun 14, 2024
61db105

Run Pint


riasvdv Jun 14, 2024
78c4b85

Fix missed tests


riasvdv Jun 14, 2024
7817448

Update Stache.php


riasvdv Jun 15, 2024
8f891d3

Merge branch '5.x' into stache-cache-store


riasvdv Jun 24, 2024
4f0c4b4

fix the config location


jasonvarga Jun 24, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 11 additions & 0 deletions
config/stache.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,17 @@

 'watcher' => env('STATAMIC_STACHE_WATCHER', 'auto'),

 /*
 |--------------------------------------------------------------------------
 | Cache Store
 |--------------------------------------------------------------------------
 |
 | Here you may configure which Cache Store the Stache uses.
 |
 */

 'cache_store' => null,

 /*
 |--------------------------------------------------------------------------
 | Stores
Expand Down

1 change: 1 addition & 0 deletions
src/Facades/Stache.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
 * @method static self registerStores($stores)
 * @method static mixed stores()
 * @method static mixed store($key)
 * @method static \Illuminate\Contracts\Cache\Store cacheStore()
 * @method static string generateId()
 * @method static self clear()
 * @method static void refresh()
Expand Down

7 changes: 3 additions & 4 deletions
src/Stache/Duplicates.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache;

use Illuminate\Support\Facades\Cache;
use Statamic\Stache\Stores\AggregateStore;
use Statamic\Stache\Stores\Store;

Expand DownExpand Up@@ -49,19 +48,19 @@ public function cache()
 return;
 }

Cache::forever('stache::duplicates', $this->items);
$this->stache->cacheStore()->forever('stache::duplicates', $this->items);
 }

 public function load()
 {
 $this->items = Cache::get('stache::duplicates', []);
 $this->items = $this->stache->cacheStore()->get('stache::duplicates', []);

 return $this;
 }

 public function clear()
 {
Cache::forget('stache::duplicates');
$this->stache->cacheStore()->forget('stache::duplicates');

 return $this;
 }
Expand Down

9 changes: 4 additions & 5 deletions
src/Stache/Indexes/Index.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache\Indexes;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\Stache;
use Statamic\Statamic;

Expand DownExpand Up@@ -76,7 +75,7 @@ public function load()

 debugbar()->addMessage("Loading index: {$this->store->key()}/{$this->name}", 'stache');

 $this->items = Cache::get($this->cacheKey());
 $this->items = Stache::cacheStore()->get($this->cacheKey());

 if ($this->items === null) {
 $this->update();
Expand DownExpand Up@@ -106,12 +105,12 @@ public function update()

 public function isCached()
 {
 return Cache::has($this->cacheKey());
 return Stache::cacheStore()->has($this->cacheKey());
 }

 public function cache()
 {
Cache::forever($this->cacheKey(), $this->items);
Stache::cacheStore()->forever($this->cacheKey(), $this->items);
 }

 public function updateItem($item)
Expand DownExpand Up@@ -153,7 +152,7 @@ public function clear()
 $this->loaded = false;
 $this->items = null;

Cache::forget($this->cacheKey());
Stache::cacheStore()->forget($this->cacheKey());
 }

 public static function currentlyLoading()
Expand Down

13 changes: 9 additions & 4 deletions
src/Stache/Stache.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,11 @@ public function stores()
 return $this->stores;
 }

 public function cacheStore()
 {
 return Cache::store(config('statamic.stache.cache_store'));
 }

 public function store($key)
 {
 if (Str::contains($key, '::')) {
Expand All@@ -85,7 +90,7 @@ public function clear()

 $this->duplicates()->clear();

Cache::forget('stache::timing');
$this->cacheStore()->forget('stache::timing');

 return $this;
 }
Expand DownExpand Up@@ -146,7 +151,7 @@ public function stopTimer()
 return $this;
 }

Cache::forever('stache::timing', [
$this->cacheStore()->forever('stache::timing', [
 'time' => floor((microtime(true) - $this->startTime) * 1000),
 'date' => Carbon::now()->timestamp,
 ]);
Expand All@@ -156,12 +161,12 @@ public function stopTimer()

 public function buildTime()
 {
 return Cache::get('stache::timing')['time'] ?? null;
 return $this->cacheStore()->get('stache::timing')['time'] ?? null;
 }

 public function buildDate()
 {
 if (! $cache = Cache::get('stache::timing')) {
 if (! $cache = $this->cacheStore()->get('stache::timing')) {
 return null;
 }

Expand Down

8 changes: 4 additions & 4 deletions
src/Stache/Stores/BasicStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,8 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\File;
use Statamic\Facades\Stache;
use Symfony\Component\Finder\SplFileInfo;

abstract class BasicStore extends Store
Expand DownExpand Up@@ -77,7 +77,7 @@ protected function getCachedItem($key)
 {
 $cacheKey = $this->getItemCacheKey($key);

 return Cache::get($cacheKey);
 return Stache::cacheStore()->get($cacheKey);
 }

 protected function cacheItem($item)
Expand All@@ -86,12 +86,12 @@ protected function cacheItem($item)

 $cacheKey = $this->getItemCacheKey($key);

Cache::forever($cacheKey, $item);
Stache::cacheStore()->forever($cacheKey, $item);
 }

 public function forgetItem($key)
 {
Cache::forget($this->getItemCacheKey($key));
Stache::cacheStore()->forget($this->getItemCacheKey($key));
 }

 protected function getItemCacheKey($key)
Expand Down

4 changes: 2 additions & 2 deletions
src/Stache/Stores/CollectionEntriesStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Entries\GetDateFromPath;
use Statamic\Entries\GetSlugFromPath;
use Statamic\Entries\GetSuffixFromPath;
Expand All@@ -13,6 +12,7 @@
use Statamic\Facades\File;
use Statamic\Facades\Path;
use Statamic\Facades\Site;
use Statamic\Facades\Stache;
use Statamic\Facades\YAML;
use Statamic\Stache\Indexes;
use Statamic\Stache\Indexes\Index;
Expand DownExpand Up@@ -230,7 +230,7 @@ protected function getCachedItem($key)
 {
 $cacheKey = $this->getItemCacheKey($key);

 if (! $entry = Cache::get($cacheKey)) {
 if (! $entry = Stache::cacheStore()->get($cacheKey)) {
 return null;
 }

Expand Down

3 changes: 1 addition & 2 deletions
src/Stache/Stores/ContainerAssetsStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\AssetContainer;
use Statamic\Facades\Stache;
use Statamic\Statamic;
Expand DownExpand Up@@ -59,7 +58,7 @@ public function paths()
 return $this->paths;
 }

 if ($paths = Cache::get($this->pathsCacheKey())) {
 if ($paths = Stache::cacheStore()->get($this->pathsCacheKey())) {
 return $this->paths = collect($paths);
 }

Expand Down

8 changes: 4 additions & 4 deletions
src/Stache/Stores/Keys.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\Stache;
use Statamic\Stache\Exceptions\DuplicateKeyException;

class Keys
Expand All@@ -17,19 +17,19 @@ public function __construct(Store $store)

 public function load()
 {
 $this->keys = Cache::get($this->cacheKey(), []);
 $this->keys = Stache::cacheStore()->get($this->cacheKey(), []);

 return $this;
 }

 public function cache()
 {
Cache::forever($this->cacheKey(), $this->keys);
Stache::cacheStore()->forever($this->cacheKey(), $this->keys);
 }

 public function clear()
 {
Cache::forget($this->cacheKey());
Stache::cacheStore()->forget($this->cacheKey());
 }

 private function cacheKey()
Expand Down

18 changes: 9 additions & 9 deletions
src/Stache/Stores/Store.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -97,7 +97,7 @@ public function indexUsage()
 {
 $key = $this->indexUsageCacheKey();

 return $this->usedIndexes = $this->usedIndexes ?? collect(Cache::get($key, []));
 return $this->usedIndexes = $this->usedIndexes ?? collect(Stache::cacheStore()->get($key, []));
 }

 public function cacheIndexUsage($index)
Expand All@@ -116,7 +116,7 @@ public function cacheIndexUsage($index)

 $this->usedIndexes = $indexes;

Cache::put($this->indexUsageCacheKey(), $indexes->all());
Stache::cacheStore()->put($this->indexUsageCacheKey(), $indexes->all());
 }

 protected function indexUsageCacheKey()
Expand DownExpand Up@@ -180,14 +180,14 @@ public function handleFileChanges()

 // Get the existing files and timestamps from the cache.
 $cacheKey = "stache::timestamps::{$this->key()}";
 $existing = collect(Cache::get($cacheKey, []));
 $existing = collect(Stache::cacheStore()->get($cacheKey, []));

 // Get the files and timestamps from the filesystem right now.
 $files = Traverser::filter([$this, 'getItemFilter'])->traverse($this);

 // Cache the files and timestamps, ready for comparisons on the next request.
 // We'll do it now since there are multiple early returns coming up.
Cache::forever($cacheKey, $files->all());
Stache::cacheStore()->forever($cacheKey, $files->all());

 // If there are no existing file timestamps in the cache, there's nothing to update.
 if ($existing->isEmpty()) {
Expand DownExpand Up@@ -291,7 +291,7 @@ public function paths()
 return $this->paths;
 }

 if ($paths = Cache::get($this->pathsCacheKey())) {
 if ($paths = Stache::cacheStore()->get($this->pathsCacheKey())) {
 return $this->paths = collect($paths);
 }

Expand DownExpand Up@@ -351,7 +351,7 @@ protected function setPath($key, $path)

 protected function cachePaths($paths)
 {
Cache::forever($this->pathsCacheKey(), $paths->all());
Stache::cacheStore()->forever($this->pathsCacheKey(), $paths->all());

 $this->paths = $paths;

Expand All@@ -361,7 +361,7 @@ protected function cachePaths($paths)
 public function clearCachedPaths()
 {
 $this->paths = null;
Cache::forget($this->pathsCacheKey());
Stache::cacheStore()->forget($this->pathsCacheKey());
 }

 protected function pathsCacheKey()
Expand All@@ -381,13 +381,13 @@ public function clear()
 });

 $this->usedIndexes = collect();
Cache::forget($this->indexUsageCacheKey());
Stache::cacheStore()->forget($this->indexUsageCacheKey());

 $this->clearCachedPaths();

 $this->keys()->clear();

Cache::forget("stache::timestamps::{$this->key()}");
Stache::cacheStore()->forget("stache::timestamps::{$this->key()}");
 }

 public function warm()
Expand Down

3 changes: 1 addition & 2 deletions
src/Stache/Stores/TaxonomyTermsStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,6 @@
namespace Statamic\Stache\Stores;

use Facades\Statamic\Stache\Traverser;
use Illuminate\Support\Facades\Cache;
use Statamic\Entries\GetSlugFromPath;
use Statamic\Facades\File;
use Statamic\Facades\Stache;
Expand DownExpand Up@@ -151,7 +150,7 @@ public function paths()
 return $this->paths;
 }

 if ($paths = Cache::get($this->pathsCacheKey())) {
 if ($paths = Stache::cacheStore()->get($this->pathsCacheKey())) {
 return $this->paths = collect($paths);
 }

Expand Down

9 changes: 7 additions & 2 deletions
tests/Stache/DuplicatesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,7 @@ public function it_saves_to_the_cache()

 $stache = $this->mock(Stache::class);
 $stache->shouldReceive('store')->with('test-store')->andReturn($store);
 $stache->shouldReceive('cacheStore')->andReturn(Cache::store());

 $duplicates = new Duplicates($stache);

Expand DownExpand Up@@ -146,7 +147,9 @@ public function it_loads_from_cache()
 {
 Cache::forever('stache::duplicates', ['foo' => 'bar']);

 $duplicates = new Duplicates($this->mock(Stache::class));
 $stache = $this->mock(Stache::class);
 $stache->shouldReceive('cacheStore')->andReturn(Cache::store());
 $duplicates = new Duplicates($stache);

 $return = $duplicates->load();

Expand All@@ -159,7 +162,9 @@ public function it_clears_the_cache()
 {
 Cache::forever('stache::duplicates', ['foo' => 'bar']);

 $duplicates = new Duplicates($this->mock(Stache::class));
 $stache = $this->mock(Stache::class);
 $stache->shouldReceive('cacheStore')->andReturn(Cache::store());
 $duplicates = new Duplicates($stache);

 $this->assertNotNull(Cache::get('stache::duplicates'));

Expand Down

2 changes: 2 additions & 0 deletions
tests/Stache/Stores/AssetContainersStoreTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use Facades\Statamic\Stache\Traverser;
use Illuminate\Filesystem\Filesystem;
use Illuminate\Support\Facades\Cache;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Assets\Asset;
use Statamic\Contracts\Assets\AssetContainer;
Expand DownExpand Up@@ -115,6 +116,7 @@ public function it_saves_to_disk()
 Facades\Stache::shouldReceive('duplicates')->andReturn(optional());
 Facades\Stache::shouldReceive('store')->with('users')->andReturn((new UsersStore((new Stache)->sites(['en']), app('files')))->directory($this->tempDir));
 Facades\Stache::shouldReceive('isWatcherEnabled')->andReturnTrue();
 Facades\Stache::shouldReceive('cacheStore')->andReturn(Cache::store());

 $container = Facades\AssetContainer::make('new')
 ->title('New Container');
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[5.x] Allow configuring the Stache's Cache Store#10303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jasonvarga
merged 7 commits into

from

Jun 24, 2024
 Merged


[5.x] Allow configuring the Stache's Cache Store
#10303
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
37563fb

Allow configuring the Stache's Cache Store


riasvdv Jun 14, 2024
7f266c9

Add a custom store test


riasvdv Jun 14, 2024
61db105

Run Pint


riasvdv Jun 14, 2024
78c4b85

Fix missed tests


riasvdv Jun 14, 2024
7817448

Update Stache.php


riasvdv Jun 15, 2024
8f891d3

Merge branch '5.x' into stache-cache-store


riasvdv Jun 24, 2024
4f0c4b4

fix the config location


jasonvarga Jun 24, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 11 additions & 0 deletions
config/stache.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,17 @@

 'watcher' => env('STATAMIC_STACHE_WATCHER', 'auto'),

 /*
 |--------------------------------------------------------------------------
 | Cache Store
 |--------------------------------------------------------------------------
 |
 | Here you may configure which Cache Store the Stache uses.
 |
 */

 'cache_store' => null,

 /*
 |--------------------------------------------------------------------------
 | Stores
Expand Down

1 change: 1 addition & 0 deletions
src/Facades/Stache.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
 * @method static self registerStores($stores)
 * @method static mixed stores()
 * @method static mixed store($key)
 * @method static \Illuminate\Contracts\Cache\Store cacheStore()
 * @method static string generateId()
 * @method static self clear()
 * @method static void refresh()
Expand Down

7 changes: 3 additions & 4 deletions
src/Stache/Duplicates.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache;

use Illuminate\Support\Facades\Cache;
use Statamic\Stache\Stores\AggregateStore;
use Statamic\Stache\Stores\Store;

Expand DownExpand Up@@ -49,19 +48,19 @@ public function cache()
 return;
 }

Cache::forever('stache::duplicates', $this->items);
$this->stache->cacheStore()->forever('stache::duplicates', $this->items);
 }

 public function load()
 {
 $this->items = Cache::get('stache::duplicates', []);
 $this->items = $this->stache->cacheStore()->get('stache::duplicates', []);

 return $this;
 }

 public function clear()
 {
Cache::forget('stache::duplicates');
$this->stache->cacheStore()->forget('stache::duplicates');

 return $this;
 }
Expand Down

9 changes: 4 additions & 5 deletions
src/Stache/Indexes/Index.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache\Indexes;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\Stache;
use Statamic\Statamic;

Expand DownExpand Up@@ -76,7 +75,7 @@ public function load()

 debugbar()->addMessage("Loading index: {$this->store->key()}/{$this->name}", 'stache');

 $this->items = Cache::get($this->cacheKey());
 $this->items = Stache::cacheStore()->get($this->cacheKey());

 if ($this->items === null) {
 $this->update();
Expand DownExpand Up@@ -106,12 +105,12 @@ public function update()

 public function isCached()
 {
 return Cache::has($this->cacheKey());
 return Stache::cacheStore()->has($this->cacheKey());
 }

 public function cache()
 {
Cache::forever($this->cacheKey(), $this->items);
Stache::cacheStore()->forever($this->cacheKey(), $this->items);
 }

 public function updateItem($item)
Expand DownExpand Up@@ -153,7 +152,7 @@ public function clear()
 $this->loaded = false;
 $this->items = null;

Cache::forget($this->cacheKey());
Stache::cacheStore()->forget($this->cacheKey());
 }

 public static function currentlyLoading()
Expand Down

13 changes: 9 additions & 4 deletions
src/Stache/Stache.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,11 @@ public function stores()
 return $this->stores;
 }

 public function cacheStore()
 {
 return Cache::store(config('statamic.stache.cache_store'));
 }

 public function store($key)
 {
 if (Str::contains($key, '::')) {
Expand All@@ -85,7 +90,7 @@ public function clear()

 $this->duplicates()->clear();

Cache::forget('stache::timing');
$this->cacheStore()->forget('stache::timing');

 return $this;
 }
Expand DownExpand Up@@ -146,7 +151,7 @@ public function stopTimer()
 return $this;
 }

Cache::forever('stache::timing', [
$this->cacheStore()->forever('stache::timing', [
 'time' => floor((microtime(true) - $this->startTime) * 1000),
 'date' => Carbon::now()->timestamp,
 ]);
Expand All@@ -156,12 +161,12 @@ public function stopTimer()

 public function buildTime()
 {
 return Cache::get('stache::timing')['time'] ?? null;
 return $this->cacheStore()->get('stache::timing')['time'] ?? null;
 }

 public function buildDate()
 {
 if (! $cache = Cache::get('stache::timing')) {
 if (! $cache = $this->cacheStore()->get('stache::timing')) {
 return null;
 }

Expand Down

8 changes: 4 additions & 4 deletions
src/Stache/Stores/BasicStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,8 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\File;
use Statamic\Facades\Stache;
use Symfony\Component\Finder\SplFileInfo;

abstract class BasicStore extends Store
Expand DownExpand Up@@ -77,7 +77,7 @@ protected function getCachedItem($key)
 {
 $cacheKey = $this->getItemCacheKey($key);

 return Cache::get($cacheKey);
 return Stache::cacheStore()->get($cacheKey);
 }

 protected function cacheItem($item)
Expand All@@ -86,12 +86,12 @@ protected function cacheItem($item)

 $cacheKey = $this->getItemCacheKey($key);

Cache::forever($cacheKey, $item);
Stache::cacheStore()->forever($cacheKey, $item);
 }

 public function forgetItem($key)
 {
Cache::forget($this->getItemCacheKey($key));
Stache::cacheStore()->forget($this->getItemCacheKey($key));
 }

 protected function getItemCacheKey($key)
Expand Down

4 changes: 2 additions & 2 deletions
src/Stache/Stores/CollectionEntriesStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Entries\GetDateFromPath;
use Statamic\Entries\GetSlugFromPath;
use Statamic\Entries\GetSuffixFromPath;
Expand All@@ -13,6 +12,7 @@
use Statamic\Facades\File;
use Statamic\Facades\Path;
use Statamic\Facades\Site;
use Statamic\Facades\Stache;
use Statamic\Facades\YAML;
use Statamic\Stache\Indexes;
use Statamic\Stache\Indexes\Index;
Expand DownExpand Up@@ -230,7 +230,7 @@ protected function getCachedItem($key)
 {
 $cacheKey = $this->getItemCacheKey($key);

 if (! $entry = Cache::get($cacheKey)) {
 if (! $entry = Stache::cacheStore()->get($cacheKey)) {
 return null;
 }

Expand Down

3 changes: 1 addition & 2 deletions
src/Stache/Stores/ContainerAssetsStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\AssetContainer;
use Statamic\Facades\Stache;
use Statamic\Statamic;
Expand DownExpand Up@@ -59,7 +58,7 @@ public function paths()
 return $this->paths;
 }

 if ($paths = Cache::get($this->pathsCacheKey())) {
 if ($paths = Stache::cacheStore()->get($this->pathsCacheKey())) {
 return $this->paths = collect($paths);
 }

Expand Down

8 changes: 4 additions & 4 deletions
src/Stache/Stores/Keys.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\Stache;
use Statamic\Stache\Exceptions\DuplicateKeyException;

class Keys
Expand All@@ -17,19 +17,19 @@ public function __construct(Store $store)

 public function load()
 {
 $this->keys = Cache::get($this->cacheKey(), []);
 $this->keys = Stache::cacheStore()->get($this->cacheKey(), []);

 return $this;
 }

 public function cache()
 {
Cache::forever($this->cacheKey(), $this->keys);
Stache::cacheStore()->forever($this->cacheKey(), $this->keys);
 }

 public function clear()
 {
Cache::forget($this->cacheKey());
Stache::cacheStore()->forget($this->cacheKey());
 }

 private function cacheKey()
Expand Down

18 changes: 9 additions & 9 deletions
src/Stache/Stores/Store.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -97,7 +97,7 @@ public function indexUsage()
 {
 $key = $this->indexUsageCacheKey();

 return $this->usedIndexes = $this->usedIndexes ?? collect(Cache::get($key, []));
 return $this->usedIndexes = $this->usedIndexes ?? collect(Stache::cacheStore()->get($key, []));
 }

 public function cacheIndexUsage($index)
Expand All@@ -116,7 +116,7 @@ public function cacheIndexUsage($index)

 $this->usedIndexes = $indexes;

Cache::put($this->indexUsageCacheKey(), $indexes->all());
Stache::cacheStore()->put($this->indexUsageCacheKey(), $indexes->all());
 }

 protected function indexUsageCacheKey()
Expand DownExpand Up@@ -180,14 +180,14 @@ public function handleFileChanges()

 // Get the existing files and timestamps from the cache.
 $cacheKey = "stache::timestamps::{$this->key()}";
 $existing = collect(Cache::get($cacheKey, []));
 $existing = collect(Stache::cacheStore()->get($cacheKey, []));

 // Get the files and timestamps from the filesystem right now.
 $files = Traverser::filter([$this, 'getItemFilter'])->traverse($this);

 // Cache the files and timestamps, ready for comparisons on the next request.
 // We'll do it now since there are multiple early returns coming up.
Cache::forever($cacheKey, $files->all());
Stache::cacheStore()->forever($cacheKey, $files->all());

 // If there are no existing file timestamps in the cache, there's nothing to update.
 if ($existing->isEmpty()) {
Expand DownExpand Up@@ -291,7 +291,7 @@ public function paths()
 return $this->paths;
 }

 if ($paths = Cache::get($this->pathsCacheKey())) {
 if ($paths = Stache::cacheStore()->get($this->pathsCacheKey())) {
 return $this->paths = collect($paths);
 }

Expand DownExpand Up@@ -351,7 +351,7 @@ protected function setPath($key, $path)

 protected function cachePaths($paths)
 {
Cache::forever($this->pathsCacheKey(), $paths->all());
Stache::cacheStore()->forever($this->pathsCacheKey(), $paths->all());

 $this->paths = $paths;

Expand All@@ -361,7 +361,7 @@ protected function cachePaths($paths)
 public function clearCachedPaths()
 {
 $this->paths = null;
Cache::forget($this->pathsCacheKey());
Stache::cacheStore()->forget($this->pathsCacheKey());
 }

 protected function pathsCacheKey()
Expand All@@ -381,13 +381,13 @@ public function clear()
 });

 $this->usedIndexes = collect();
Cache::forget($this->indexUsageCacheKey());
Stache::cacheStore()->forget($this->indexUsageCacheKey());

 $this->clearCachedPaths();

 $this->keys()->clear();

Cache::forget("stache::timestamps::{$this->key()}");
Stache::cacheStore()->forget("stache::timestamps::{$this->key()}");
 }

 public function warm()
Expand Down

3 changes: 1 addition & 2 deletions
src/Stache/Stores/TaxonomyTermsStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,6 @@
namespace Statamic\Stache\Stores;

use Facades\Statamic\Stache\Traverser;
use Illuminate\Support\Facades\Cache;
use Statamic\Entries\GetSlugFromPath;
use Statamic\Facades\File;
use Statamic\Facades\Stache;
Expand DownExpand Up@@ -151,7 +150,7 @@ public function paths()
 return $this->paths;
 }

 if ($paths = Cache::get($this->pathsCacheKey())) {
 if ($paths = Stache::cacheStore()->get($this->pathsCacheKey())) {
 return $this->paths = collect($paths);
 }

Expand Down

9 changes: 7 additions & 2 deletions
tests/Stache/DuplicatesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,7 @@ public function it_saves_to_the_cache()

 $stache = $this->mock(Stache::class);
 $stache->shouldReceive('store')->with('test-store')->andReturn($store);
 $stache->shouldReceive('cacheStore')->andReturn(Cache::store());

 $duplicates = new Duplicates($stache);

Expand DownExpand Up@@ -146,7 +147,9 @@ public function it_loads_from_cache()
 {
 Cache::forever('stache::duplicates', ['foo' => 'bar']);

 $duplicates = new Duplicates($this->mock(Stache::class));
 $stache = $this->mock(Stache::class);
 $stache->shouldReceive('cacheStore')->andReturn(Cache::store());
 $duplicates = new Duplicates($stache);

 $return = $duplicates->load();

Expand All@@ -159,7 +162,9 @@ public function it_clears_the_cache()
 {
 Cache::forever('stache::duplicates', ['foo' => 'bar']);

 $duplicates = new Duplicates($this->mock(Stache::class));
 $stache = $this->mock(Stache::class);
 $stache->shouldReceive('cacheStore')->andReturn(Cache::store());
 $duplicates = new Duplicates($stache);

 $this->assertNotNull(Cache::get('stache::duplicates'));

Expand Down

2 changes: 2 additions & 0 deletions
tests/Stache/Stores/AssetContainersStoreTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use Facades\Statamic\Stache\Traverser;
use Illuminate\Filesystem\Filesystem;
use Illuminate\Support\Facades\Cache;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Assets\Asset;
use Statamic\Contracts\Assets\AssetContainer;
Expand DownExpand Up@@ -115,6 +116,7 @@ public function it_saves_to_disk()
 Facades\Stache::shouldReceive('duplicates')->andReturn(optional());
 Facades\Stache::shouldReceive('store')->with('users')->andReturn((new UsersStore((new Stache)->sites(['en']), app('files')))->directory($this->tempDir));
 Facades\Stache::shouldReceive('isWatcherEnabled')->andReturnTrue();
 Facades\Stache::shouldReceive('cacheStore')->andReturn(Cache::store());

 $container = Facades\AssetContainer::make('new')
 ->title('New Container');
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[5.x] Allow configuring the Stache's Cache Store#10303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jasonvarga
merged 7 commits into

from

Jun 24, 2024
 Merged


[5.x] Allow configuring the Stache's Cache Store
#10303
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
37563fb

Allow configuring the Stache's Cache Store


riasvdv Jun 14, 2024
7f266c9

Add a custom store test


riasvdv Jun 14, 2024
61db105

Run Pint


riasvdv Jun 14, 2024
78c4b85

Fix missed tests


riasvdv Jun 14, 2024
7817448

Update Stache.php


riasvdv Jun 15, 2024
8f891d3

Merge branch '5.x' into stache-cache-store


riasvdv Jun 24, 2024
4f0c4b4

fix the config location


jasonvarga Jun 24, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 11 additions & 0 deletions
config/stache.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,17 @@

 'watcher' => env('STATAMIC_STACHE_WATCHER', 'auto'),

 /*
 |--------------------------------------------------------------------------
 | Cache Store
 |--------------------------------------------------------------------------
 |
 | Here you may configure which Cache Store the Stache uses.
 |
 */

 'cache_store' => null,

 /*
 |--------------------------------------------------------------------------
 | Stores
Expand Down

1 change: 1 addition & 0 deletions
src/Facades/Stache.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
 * @method static self registerStores($stores)
 * @method static mixed stores()
 * @method static mixed store($key)
 * @method static \Illuminate\Contracts\Cache\Store cacheStore()
 * @method static string generateId()
 * @method static self clear()
 * @method static void refresh()
Expand Down

7 changes: 3 additions & 4 deletions
src/Stache/Duplicates.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache;

use Illuminate\Support\Facades\Cache;
use Statamic\Stache\Stores\AggregateStore;
use Statamic\Stache\Stores\Store;

Expand DownExpand Up@@ -49,19 +48,19 @@ public function cache()
 return;
 }

Cache::forever('stache::duplicates', $this->items);
$this->stache->cacheStore()->forever('stache::duplicates', $this->items);
 }

 public function load()
 {
 $this->items = Cache::get('stache::duplicates', []);
 $this->items = $this->stache->cacheStore()->get('stache::duplicates', []);

 return $this;
 }

 public function clear()
 {
Cache::forget('stache::duplicates');
$this->stache->cacheStore()->forget('stache::duplicates');

 return $this;
 }
Expand Down

9 changes: 4 additions & 5 deletions
src/Stache/Indexes/Index.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache\Indexes;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\Stache;
use Statamic\Statamic;

Expand DownExpand Up@@ -76,7 +75,7 @@ public function load()

 debugbar()->addMessage("Loading index: {$this->store->key()}/{$this->name}", 'stache');

 $this->items = Cache::get($this->cacheKey());
 $this->items = Stache::cacheStore()->get($this->cacheKey());

 if ($this->items === null) {
 $this->update();
Expand DownExpand Up@@ -106,12 +105,12 @@ public function update()

 public function isCached()
 {
 return Cache::has($this->cacheKey());
 return Stache::cacheStore()->has($this->cacheKey());
 }

 public function cache()
 {
Cache::forever($this->cacheKey(), $this->items);
Stache::cacheStore()->forever($this->cacheKey(), $this->items);
 }

 public function updateItem($item)
Expand DownExpand Up@@ -153,7 +152,7 @@ public function clear()
 $this->loaded = false;
 $this->items = null;

Cache::forget($this->cacheKey());
Stache::cacheStore()->forget($this->cacheKey());
 }

 public static function currentlyLoading()
Expand Down

13 changes: 9 additions & 4 deletions
src/Stache/Stache.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,11 @@ public function stores()
 return $this->stores;
 }

 public function cacheStore()
 {
 return Cache::store(config('statamic.stache.cache_store'));
 }

 public function store($key)
 {
 if (Str::contains($key, '::')) {
Expand All@@ -85,7 +90,7 @@ public function clear()

 $this->duplicates()->clear();

Cache::forget('stache::timing');
$this->cacheStore()->forget('stache::timing');

 return $this;
 }
Expand DownExpand Up@@ -146,7 +151,7 @@ public function stopTimer()
 return $this;
 }

Cache::forever('stache::timing', [
$this->cacheStore()->forever('stache::timing', [
 'time' => floor((microtime(true) - $this->startTime) * 1000),
 'date' => Carbon::now()->timestamp,
 ]);
Expand All@@ -156,12 +161,12 @@ public function stopTimer()

 public function buildTime()
 {
 return Cache::get('stache::timing')['time'] ?? null;
 return $this->cacheStore()->get('stache::timing')['time'] ?? null;
 }

 public function buildDate()
 {
 if (! $cache = Cache::get('stache::timing')) {
 if (! $cache = $this->cacheStore()->get('stache::timing')) {
 return null;
 }

Expand Down

8 changes: 4 additions & 4 deletions
src/Stache/Stores/BasicStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,8 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\File;
use Statamic\Facades\Stache;
use Symfony\Component\Finder\SplFileInfo;

abstract class BasicStore extends Store
Expand DownExpand Up@@ -77,7 +77,7 @@ protected function getCachedItem($key)
 {
 $cacheKey = $this->getItemCacheKey($key);

 return Cache::get($cacheKey);
 return Stache::cacheStore()->get($cacheKey);
 }

 protected function cacheItem($item)
Expand All@@ -86,12 +86,12 @@ protected function cacheItem($item)

 $cacheKey = $this->getItemCacheKey($key);

Cache::forever($cacheKey, $item);
Stache::cacheStore()->forever($cacheKey, $item);
 }

 public function forgetItem($key)
 {
Cache::forget($this->getItemCacheKey($key));
Stache::cacheStore()->forget($this->getItemCacheKey($key));
 }

 protected function getItemCacheKey($key)
Expand Down

4 changes: 2 additions & 2 deletions
src/Stache/Stores/CollectionEntriesStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Entries\GetDateFromPath;
use Statamic\Entries\GetSlugFromPath;
use Statamic\Entries\GetSuffixFromPath;
Expand All@@ -13,6 +12,7 @@
use Statamic\Facades\File;
use Statamic\Facades\Path;
use Statamic\Facades\Site;
use Statamic\Facades\Stache;
use Statamic\Facades\YAML;
use Statamic\Stache\Indexes;
use Statamic\Stache\Indexes\Index;
Expand DownExpand Up@@ -230,7 +230,7 @@ protected function getCachedItem($key)
 {
 $cacheKey = $this->getItemCacheKey($key);

 if (! $entry = Cache::get($cacheKey)) {
 if (! $entry = Stache::cacheStore()->get($cacheKey)) {
 return null;
 }

Expand Down

3 changes: 1 addition & 2 deletions
src/Stache/Stores/ContainerAssetsStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\AssetContainer;
use Statamic\Facades\Stache;
use Statamic\Statamic;
Expand DownExpand Up@@ -59,7 +58,7 @@ public function paths()
 return $this->paths;
 }

 if ($paths = Cache::get($this->pathsCacheKey())) {
 if ($paths = Stache::cacheStore()->get($this->pathsCacheKey())) {
 return $this->paths = collect($paths);
 }

Expand Down

8 changes: 4 additions & 4 deletions
src/Stache/Stores/Keys.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\Stache;
use Statamic\Stache\Exceptions\DuplicateKeyException;

class Keys
Expand All@@ -17,19 +17,19 @@ public function __construct(Store $store)

 public function load()
 {
 $this->keys = Cache::get($this->cacheKey(), []);
 $this->keys = Stache::cacheStore()->get($this->cacheKey(), []);

 return $this;
 }

 public function cache()
 {
Cache::forever($this->cacheKey(), $this->keys);
Stache::cacheStore()->forever($this->cacheKey(), $this->keys);
 }

 public function clear()
 {
Cache::forget($this->cacheKey());
Stache::cacheStore()->forget($this->cacheKey());
 }

 private function cacheKey()
Expand Down

18 changes: 9 additions & 9 deletions
src/Stache/Stores/Store.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -97,7 +97,7 @@ public function indexUsage()
 {
 $key = $this->indexUsageCacheKey();

 return $this->usedIndexes = $this->usedIndexes ?? collect(Cache::get($key, []));
 return $this->usedIndexes = $this->usedIndexes ?? collect(Stache::cacheStore()->get($key, []));
 }

 public function cacheIndexUsage($index)
Expand All@@ -116,7 +116,7 @@ public function cacheIndexUsage($index)

 $this->usedIndexes = $indexes;

Cache::put($this->indexUsageCacheKey(), $indexes->all());
Stache::cacheStore()->put($this->indexUsageCacheKey(), $indexes->all());
 }

 protected function indexUsageCacheKey()
Expand DownExpand Up@@ -180,14 +180,14 @@ public function handleFileChanges()

 // Get the existing files and timestamps from the cache.
 $cacheKey = "stache::timestamps::{$this->key()}";
 $existing = collect(Cache::get($cacheKey, []));
 $existing = collect(Stache::cacheStore()->get($cacheKey, []));

 // Get the files and timestamps from the filesystem right now.
 $files = Traverser::filter([$this, 'getItemFilter'])->traverse($this);

 // Cache the files and timestamps, ready for comparisons on the next request.
 // We'll do it now since there are multiple early returns coming up.
Cache::forever($cacheKey, $files->all());
Stache::cacheStore()->forever($cacheKey, $files->all());

 // If there are no existing file timestamps in the cache, there's nothing to update.
 if ($existing->isEmpty()) {
Expand DownExpand Up@@ -291,7 +291,7 @@ public function paths()
 return $this->paths;
 }

 if ($paths = Cache::get($this->pathsCacheKey())) {
 if ($paths = Stache::cacheStore()->get($this->pathsCacheKey())) {
 return $this->paths = collect($paths);
 }

Expand DownExpand Up@@ -351,7 +351,7 @@ protected function setPath($key, $path)

 protected function cachePaths($paths)
 {
Cache::forever($this->pathsCacheKey(), $paths->all());
Stache::cacheStore()->forever($this->pathsCacheKey(), $paths->all());

 $this->paths = $paths;

Expand All@@ -361,7 +361,7 @@ protected function cachePaths($paths)
 public function clearCachedPaths()
 {
 $this->paths = null;
Cache::forget($this->pathsCacheKey());
Stache::cacheStore()->forget($this->pathsCacheKey());
 }

 protected function pathsCacheKey()
Expand All@@ -381,13 +381,13 @@ public function clear()
 });

 $this->usedIndexes = collect();
Cache::forget($this->indexUsageCacheKey());
Stache::cacheStore()->forget($this->indexUsageCacheKey());

 $this->clearCachedPaths();

 $this->keys()->clear();

Cache::forget("stache::timestamps::{$this->key()}");
Stache::cacheStore()->forget("stache::timestamps::{$this->key()}");
 }

 public function warm()
Expand Down

3 changes: 1 addition & 2 deletions
src/Stache/Stores/TaxonomyTermsStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,6 @@
namespace Statamic\Stache\Stores;

use Facades\Statamic\Stache\Traverser;
use Illuminate\Support\Facades\Cache;
use Statamic\Entries\GetSlugFromPath;
use Statamic\Facades\File;
use Statamic\Facades\Stache;
Expand DownExpand Up@@ -151,7 +150,7 @@ public function paths()
 return $this->paths;
 }

 if ($paths = Cache::get($this->pathsCacheKey())) {
 if ($paths = Stache::cacheStore()->get($this->pathsCacheKey())) {
 return $this->paths = collect($paths);
 }

Expand Down

9 changes: 7 additions & 2 deletions
tests/Stache/DuplicatesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,7 @@ public function it_saves_to_the_cache()

 $stache = $this->mock(Stache::class);
 $stache->shouldReceive('store')->with('test-store')->andReturn($store);
 $stache->shouldReceive('cacheStore')->andReturn(Cache::store());

 $duplicates = new Duplicates($stache);

Expand DownExpand Up@@ -146,7 +147,9 @@ public function it_loads_from_cache()
 {
 Cache::forever('stache::duplicates', ['foo' => 'bar']);

 $duplicates = new Duplicates($this->mock(Stache::class));
 $stache = $this->mock(Stache::class);
 $stache->shouldReceive('cacheStore')->andReturn(Cache::store());
 $duplicates = new Duplicates($stache);

 $return = $duplicates->load();

Expand All@@ -159,7 +162,9 @@ public function it_clears_the_cache()
 {
 Cache::forever('stache::duplicates', ['foo' => 'bar']);

 $duplicates = new Duplicates($this->mock(Stache::class));
 $stache = $this->mock(Stache::class);
 $stache->shouldReceive('cacheStore')->andReturn(Cache::store());
 $duplicates = new Duplicates($stache);

 $this->assertNotNull(Cache::get('stache::duplicates'));

Expand Down

2 changes: 2 additions & 0 deletions
tests/Stache/Stores/AssetContainersStoreTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use Facades\Statamic\Stache\Traverser;
use Illuminate\Filesystem\Filesystem;
use Illuminate\Support\Facades\Cache;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Assets\Asset;
use Statamic\Contracts\Assets\AssetContainer;
Expand DownExpand Up@@ -115,6 +116,7 @@ public function it_saves_to_disk()
 Facades\Stache::shouldReceive('duplicates')->andReturn(optional());
 Facades\Stache::shouldReceive('store')->with('users')->andReturn((new UsersStore((new Stache)->sites(['en']), app('files')))->directory($this->tempDir));
 Facades\Stache::shouldReceive('isWatcherEnabled')->andReturnTrue();
 Facades\Stache::shouldReceive('cacheStore')->andReturn(Cache::store());

 $container = Facades\AssetContainer::make('new')
 ->title('New Container');
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
[5.x] Allow configuring the Stache's Cache Store#10303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jasonvarga
merged 7 commits into

from

Jun 24, 2024
 Merged


[5.x] Allow configuring the Stache's Cache Store
#10303
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
37563fb

Allow configuring the Stache's Cache Store


riasvdv Jun 14, 2024
7f266c9

Add a custom store test


riasvdv Jun 14, 2024
61db105

Run Pint


riasvdv Jun 14, 2024
78c4b85

Fix missed tests


riasvdv Jun 14, 2024
7817448

Update Stache.php


riasvdv Jun 15, 2024
8f891d3

Merge branch '5.x' into stache-cache-store


riasvdv Jun 24, 2024
4f0c4b4

fix the config location


jasonvarga Jun 24, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 11 additions & 0 deletions
config/stache.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,17 @@

 'watcher' => env('STATAMIC_STACHE_WATCHER', 'auto'),

 /*
 |--------------------------------------------------------------------------
 | Cache Store
 |--------------------------------------------------------------------------
 |
 | Here you may configure which Cache Store the Stache uses.
 |
 */

 'cache_store' => null,

 /*
 |--------------------------------------------------------------------------
 | Stores
Expand Down

1 change: 1 addition & 0 deletions
src/Facades/Stache.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
 * @method static self registerStores($stores)
 * @method static mixed stores()
 * @method static mixed store($key)
 * @method static \Illuminate\Contracts\Cache\Store cacheStore()
 * @method static string generateId()
 * @method static self clear()
 * @method static void refresh()
Expand Down

7 changes: 3 additions & 4 deletions
src/Stache/Duplicates.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache;

use Illuminate\Support\Facades\Cache;
use Statamic\Stache\Stores\AggregateStore;
use Statamic\Stache\Stores\Store;

Expand DownExpand Up@@ -49,19 +48,19 @@ public function cache()
 return;
 }

Cache::forever('stache::duplicates', $this->items);
$this->stache->cacheStore()->forever('stache::duplicates', $this->items);
 }

 public function load()
 {
 $this->items = Cache::get('stache::duplicates', []);
 $this->items = $this->stache->cacheStore()->get('stache::duplicates', []);

 return $this;
 }

 public function clear()
 {
Cache::forget('stache::duplicates');
$this->stache->cacheStore()->forget('stache::duplicates');

 return $this;
 }
Expand Down

9 changes: 4 additions & 5 deletions
src/Stache/Indexes/Index.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache\Indexes;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\Stache;
use Statamic\Statamic;

Expand DownExpand Up@@ -76,7 +75,7 @@ public function load()

 debugbar()->addMessage("Loading index: {$this->store->key()}/{$this->name}", 'stache');

 $this->items = Cache::get($this->cacheKey());
 $this->items = Stache::cacheStore()->get($this->cacheKey());

 if ($this->items === null) {
 $this->update();
Expand DownExpand Up@@ -106,12 +105,12 @@ public function update()

 public function isCached()
 {
 return Cache::has($this->cacheKey());
 return Stache::cacheStore()->has($this->cacheKey());
 }

 public function cache()
 {
Cache::forever($this->cacheKey(), $this->items);
Stache::cacheStore()->forever($this->cacheKey(), $this->items);
 }

 public function updateItem($item)
Expand DownExpand Up@@ -153,7 +152,7 @@ public function clear()
 $this->loaded = false;
 $this->items = null;

Cache::forget($this->cacheKey());
Stache::cacheStore()->forget($this->cacheKey());
 }

 public static function currentlyLoading()
Expand Down

13 changes: 9 additions & 4 deletions
src/Stache/Stache.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,11 @@ public function stores()
 return $this->stores;
 }

 public function cacheStore()
 {
 return Cache::store(config('statamic.stache.cache_store'));
 }

 public function store($key)
 {
 if (Str::contains($key, '::')) {
Expand All@@ -85,7 +90,7 @@ public function clear()

 $this->duplicates()->clear();

Cache::forget('stache::timing');
$this->cacheStore()->forget('stache::timing');

 return $this;
 }
Expand DownExpand Up@@ -146,7 +151,7 @@ public function stopTimer()
 return $this;
 }

Cache::forever('stache::timing', [
$this->cacheStore()->forever('stache::timing', [
 'time' => floor((microtime(true) - $this->startTime) * 1000),
 'date' => Carbon::now()->timestamp,
 ]);
Expand All@@ -156,12 +161,12 @@ public function stopTimer()

 public function buildTime()
 {
 return Cache::get('stache::timing')['time'] ?? null;
 return $this->cacheStore()->get('stache::timing')['time'] ?? null;
 }

 public function buildDate()
 {
 if (! $cache = Cache::get('stache::timing')) {
 if (! $cache = $this->cacheStore()->get('stache::timing')) {
 return null;
 }

Expand Down

8 changes: 4 additions & 4 deletions
src/Stache/Stores/BasicStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,8 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\File;
use Statamic\Facades\Stache;
use Symfony\Component\Finder\SplFileInfo;

abstract class BasicStore extends Store
Expand DownExpand Up@@ -77,7 +77,7 @@ protected function getCachedItem($key)
 {
 $cacheKey = $this->getItemCacheKey($key);

 return Cache::get($cacheKey);
 return Stache::cacheStore()->get($cacheKey);
 }

 protected function cacheItem($item)
Expand All@@ -86,12 +86,12 @@ protected function cacheItem($item)

 $cacheKey = $this->getItemCacheKey($key);

Cache::forever($cacheKey, $item);
Stache::cacheStore()->forever($cacheKey, $item);
 }

 public function forgetItem($key)
 {
Cache::forget($this->getItemCacheKey($key));
Stache::cacheStore()->forget($this->getItemCacheKey($key));
 }

 protected function getItemCacheKey($key)
Expand Down

4 changes: 2 additions & 2 deletions
src/Stache/Stores/CollectionEntriesStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Entries\GetDateFromPath;
use Statamic\Entries\GetSlugFromPath;
use Statamic\Entries\GetSuffixFromPath;
Expand All@@ -13,6 +12,7 @@
use Statamic\Facades\File;
use Statamic\Facades\Path;
use Statamic\Facades\Site;
use Statamic\Facades\Stache;
use Statamic\Facades\YAML;
use Statamic\Stache\Indexes;
use Statamic\Stache\Indexes\Index;
Expand DownExpand Up@@ -230,7 +230,7 @@ protected function getCachedItem($key)
 {
 $cacheKey = $this->getItemCacheKey($key);

 if (! $entry = Cache::get($cacheKey)) {
 if (! $entry = Stache::cacheStore()->get($cacheKey)) {
 return null;
 }

Expand Down

3 changes: 1 addition & 2 deletions
src/Stache/Stores/ContainerAssetsStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\AssetContainer;
use Statamic\Facades\Stache;
use Statamic\Statamic;
Expand DownExpand Up@@ -59,7 +58,7 @@ public function paths()
 return $this->paths;
 }

 if ($paths = Cache::get($this->pathsCacheKey())) {
 if ($paths = Stache::cacheStore()->get($this->pathsCacheKey())) {
 return $this->paths = collect($paths);
 }

Expand Down

8 changes: 4 additions & 4 deletions
src/Stache/Stores/Keys.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\Stache;
use Statamic\Stache\Exceptions\DuplicateKeyException;

class Keys
Expand All@@ -17,19 +17,19 @@ public function __construct(Store $store)

 public function load()
 {
 $this->keys = Cache::get($this->cacheKey(), []);
 $this->keys = Stache::cacheStore()->get($this->cacheKey(), []);

 return $this;
 }

 public function cache()
 {
Cache::forever($this->cacheKey(), $this->keys);
Stache::cacheStore()->forever($this->cacheKey(), $this->keys);
 }

 public function clear()
 {
Cache::forget($this->cacheKey());
Stache::cacheStore()->forget($this->cacheKey());
 }

 private function cacheKey()
Expand Down

18 changes: 9 additions & 9 deletions
src/Stache/Stores/Store.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -97,7 +97,7 @@ public function indexUsage()
 {
 $key = $this->indexUsageCacheKey();

 return $this->usedIndexes = $this->usedIndexes ?? collect(Cache::get($key, []));
 return $this->usedIndexes = $this->usedIndexes ?? collect(Stache::cacheStore()->get($key, []));
 }

 public function cacheIndexUsage($index)
Expand All@@ -116,7 +116,7 @@ public function cacheIndexUsage($index)

 $this->usedIndexes = $indexes;

Cache::put($this->indexUsageCacheKey(), $indexes->all());
Stache::cacheStore()->put($this->indexUsageCacheKey(), $indexes->all());
 }

 protected function indexUsageCacheKey()
Expand DownExpand Up@@ -180,14 +180,14 @@ public function handleFileChanges()

 // Get the existing files and timestamps from the cache.
 $cacheKey = "stache::timestamps::{$this->key()}";
 $existing = collect(Cache::get($cacheKey, []));
 $existing = collect(Stache::cacheStore()->get($cacheKey, []));

 // Get the files and timestamps from the filesystem right now.
 $files = Traverser::filter([$this, 'getItemFilter'])->traverse($this);

 // Cache the files and timestamps, ready for comparisons on the next request.
 // We'll do it now since there are multiple early returns coming up.
Cache::forever($cacheKey, $files->all());
Stache::cacheStore()->forever($cacheKey, $files->all());

 // If there are no existing file timestamps in the cache, there's nothing to update.
 if ($existing->isEmpty()) {
Expand DownExpand Up@@ -291,7 +291,7 @@ public function paths()
 return $this->paths;
 }

 if ($paths = Cache::get($this->pathsCacheKey())) {
 if ($paths = Stache::cacheStore()->get($this->pathsCacheKey())) {
 return $this->paths = collect($paths);
 }

Expand DownExpand Up@@ -351,7 +351,7 @@ protected function setPath($key, $path)

 protected function cachePaths($paths)
 {
Cache::forever($this->pathsCacheKey(), $paths->all());
Stache::cacheStore()->forever($this->pathsCacheKey(), $paths->all());

 $this->paths = $paths;

Expand All@@ -361,7 +361,7 @@ protected function cachePaths($paths)
 public function clearCachedPaths()
 {
 $this->paths = null;
Cache::forget($this->pathsCacheKey());
Stache::cacheStore()->forget($this->pathsCacheKey());
 }

 protected function pathsCacheKey()
Expand All@@ -381,13 +381,13 @@ public function clear()
 });

 $this->usedIndexes = collect();
Cache::forget($this->indexUsageCacheKey());
Stache::cacheStore()->forget($this->indexUsageCacheKey());

 $this->clearCachedPaths();

 $this->keys()->clear();

Cache::forget("stache::timestamps::{$this->key()}");
Stache::cacheStore()->forget("stache::timestamps::{$this->key()}");
 }

 public function warm()
Expand Down

3 changes: 1 addition & 2 deletions
src/Stache/Stores/TaxonomyTermsStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,6 @@
namespace Statamic\Stache\Stores;

use Facades\Statamic\Stache\Traverser;
use Illuminate\Support\Facades\Cache;
use Statamic\Entries\GetSlugFromPath;
use Statamic\Facades\File;
use Statamic\Facades\Stache;
Expand DownExpand Up@@ -151,7 +150,7 @@ public function paths()
 return $this->paths;
 }

 if ($paths = Cache::get($this->pathsCacheKey())) {
 if ($paths = Stache::cacheStore()->get($this->pathsCacheKey())) {
 return $this->paths = collect($paths);
 }

Expand Down

9 changes: 7 additions & 2 deletions
tests/Stache/DuplicatesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,7 @@ public function it_saves_to_the_cache()

 $stache = $this->mock(Stache::class);
 $stache->shouldReceive('store')->with('test-store')->andReturn($store);
 $stache->shouldReceive('cacheStore')->andReturn(Cache::store());

 $duplicates = new Duplicates($stache);

Expand DownExpand Up@@ -146,7 +147,9 @@ public function it_loads_from_cache()
 {
 Cache::forever('stache::duplicates', ['foo' => 'bar']);

 $duplicates = new Duplicates($this->mock(Stache::class));
 $stache = $this->mock(Stache::class);
 $stache->shouldReceive('cacheStore')->andReturn(Cache::store());
 $duplicates = new Duplicates($stache);

 $return = $duplicates->load();

Expand All@@ -159,7 +162,9 @@ public function it_clears_the_cache()
 {
 Cache::forever('stache::duplicates', ['foo' => 'bar']);

 $duplicates = new Duplicates($this->mock(Stache::class));
 $stache = $this->mock(Stache::class);
 $stache->shouldReceive('cacheStore')->andReturn(Cache::store());
 $duplicates = new Duplicates($stache);

 $this->assertNotNull(Cache::get('stache::duplicates'));

Expand Down

2 changes: 2 additions & 0 deletions
tests/Stache/Stores/AssetContainersStoreTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use Facades\Statamic\Stache\Traverser;
use Illuminate\Filesystem\Filesystem;
use Illuminate\Support\Facades\Cache;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Assets\Asset;
use Statamic\Contracts\Assets\AssetContainer;
Expand DownExpand Up@@ -115,6 +116,7 @@ public function it_saves_to_disk()
 Facades\Stache::shouldReceive('duplicates')->andReturn(optional());
 Facades\Stache::shouldReceive('store')->with('users')->andReturn((new UsersStore((new Stache)->sites(['en']), app('files')))->directory($this->tempDir));
 Facades\Stache::shouldReceive('isWatcherEnabled')->andReturnTrue();
 Facades\Stache::shouldReceive('cacheStore')->andReturn(Cache::store());

 $container = Facades\AssetContainer::make('new')
 ->title('New Container');
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[5.x] Allow configuring the Stache's Cache Store#10303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jasonvarga
merged 7 commits into

from

Jun 24, 2024
 Merged


[5.x] Allow configuring the Stache's Cache Store
#10303
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
37563fb

Allow configuring the Stache's Cache Store


riasvdv Jun 14, 2024
7f266c9

Add a custom store test


riasvdv Jun 14, 2024
61db105

Run Pint


riasvdv Jun 14, 2024
78c4b85

Fix missed tests


riasvdv Jun 14, 2024
7817448

Update Stache.php


riasvdv Jun 15, 2024
8f891d3

Merge branch '5.x' into stache-cache-store


riasvdv Jun 24, 2024
4f0c4b4

fix the config location


jasonvarga Jun 24, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 11 additions & 0 deletions
config/stache.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,17 @@

 'watcher' => env('STATAMIC_STACHE_WATCHER', 'auto'),

 /*
 |--------------------------------------------------------------------------
 | Cache Store
 |--------------------------------------------------------------------------
 |
 | Here you may configure which Cache Store the Stache uses.
 |
 */

 'cache_store' => null,

 /*
 |--------------------------------------------------------------------------
 | Stores
Expand Down

1 change: 1 addition & 0 deletions
src/Facades/Stache.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
 * @method static self registerStores($stores)
 * @method static mixed stores()
 * @method static mixed store($key)
 * @method static \Illuminate\Contracts\Cache\Store cacheStore()
 * @method static string generateId()
 * @method static self clear()
 * @method static void refresh()
Expand Down

7 changes: 3 additions & 4 deletions
src/Stache/Duplicates.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache;

use Illuminate\Support\Facades\Cache;
use Statamic\Stache\Stores\AggregateStore;
use Statamic\Stache\Stores\Store;

Expand DownExpand Up@@ -49,19 +48,19 @@ public function cache()
 return;
 }

Cache::forever('stache::duplicates', $this->items);
$this->stache->cacheStore()->forever('stache::duplicates', $this->items);
 }

 public function load()
 {
 $this->items = Cache::get('stache::duplicates', []);
 $this->items = $this->stache->cacheStore()->get('stache::duplicates', []);

 return $this;
 }

 public function clear()
 {
Cache::forget('stache::duplicates');
$this->stache->cacheStore()->forget('stache::duplicates');

 return $this;
 }
Expand Down

9 changes: 4 additions & 5 deletions
src/Stache/Indexes/Index.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache\Indexes;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\Stache;
use Statamic\Statamic;

Expand DownExpand Up@@ -76,7 +75,7 @@ public function load()

 debugbar()->addMessage("Loading index: {$this->store->key()}/{$this->name}", 'stache');

 $this->items = Cache::get($this->cacheKey());
 $this->items = Stache::cacheStore()->get($this->cacheKey());

 if ($this->items === null) {
 $this->update();
Expand DownExpand Up@@ -106,12 +105,12 @@ public function update()

 public function isCached()
 {
 return Cache::has($this->cacheKey());
 return Stache::cacheStore()->has($this->cacheKey());
 }

 public function cache()
 {
Cache::forever($this->cacheKey(), $this->items);
Stache::cacheStore()->forever($this->cacheKey(), $this->items);
 }

 public function updateItem($item)
Expand DownExpand Up@@ -153,7 +152,7 @@ public function clear()
 $this->loaded = false;
 $this->items = null;

Cache::forget($this->cacheKey());
Stache::cacheStore()->forget($this->cacheKey());
 }

 public static function currentlyLoading()
Expand Down

13 changes: 9 additions & 4 deletions
src/Stache/Stache.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,11 @@ public function stores()
 return $this->stores;
 }

 public function cacheStore()
 {
 return Cache::store(config('statamic.stache.cache_store'));
 }

 public function store($key)
 {
 if (Str::contains($key, '::')) {
Expand All@@ -85,7 +90,7 @@ public function clear()

 $this->duplicates()->clear();

Cache::forget('stache::timing');
$this->cacheStore()->forget('stache::timing');

 return $this;
 }
Expand DownExpand Up@@ -146,7 +151,7 @@ public function stopTimer()
 return $this;
 }

Cache::forever('stache::timing', [
$this->cacheStore()->forever('stache::timing', [
 'time' => floor((microtime(true) - $this->startTime) * 1000),
 'date' => Carbon::now()->timestamp,
 ]);
Expand All@@ -156,12 +161,12 @@ public function stopTimer()

 public function buildTime()
 {
 return Cache::get('stache::timing')['time'] ?? null;
 return $this->cacheStore()->get('stache::timing')['time'] ?? null;
 }

 public function buildDate()
 {
 if (! $cache = Cache::get('stache::timing')) {
 if (! $cache = $this->cacheStore()->get('stache::timing')) {
 return null;
 }

Expand Down

8 changes: 4 additions & 4 deletions
src/Stache/Stores/BasicStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,8 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\File;
use Statamic\Facades\Stache;
use Symfony\Component\Finder\SplFileInfo;

abstract class BasicStore extends Store
Expand DownExpand Up@@ -77,7 +77,7 @@ protected function getCachedItem($key)
 {
 $cacheKey = $this->getItemCacheKey($key);

 return Cache::get($cacheKey);
 return Stache::cacheStore()->get($cacheKey);
 }

 protected function cacheItem($item)
Expand All@@ -86,12 +86,12 @@ protected function cacheItem($item)

 $cacheKey = $this->getItemCacheKey($key);

Cache::forever($cacheKey, $item);
Stache::cacheStore()->forever($cacheKey, $item);
 }

 public function forgetItem($key)
 {
Cache::forget($this->getItemCacheKey($key));
Stache::cacheStore()->forget($this->getItemCacheKey($key));
 }

 protected function getItemCacheKey($key)
Expand Down

4 changes: 2 additions & 2 deletions
src/Stache/Stores/CollectionEntriesStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Entries\GetDateFromPath;
use Statamic\Entries\GetSlugFromPath;
use Statamic\Entries\GetSuffixFromPath;
Expand All@@ -13,6 +12,7 @@
use Statamic\Facades\File;
use Statamic\Facades\Path;
use Statamic\Facades\Site;
use Statamic\Facades\Stache;
use Statamic\Facades\YAML;
use Statamic\Stache\Indexes;
use Statamic\Stache\Indexes\Index;
Expand DownExpand Up@@ -230,7 +230,7 @@ protected function getCachedItem($key)
 {
 $cacheKey = $this->getItemCacheKey($key);

 if (! $entry = Cache::get($cacheKey)) {
 if (! $entry = Stache::cacheStore()->get($cacheKey)) {
 return null;
 }

Expand Down

3 changes: 1 addition & 2 deletions
src/Stache/Stores/ContainerAssetsStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\AssetContainer;
use Statamic\Facades\Stache;
use Statamic\Statamic;
Expand DownExpand Up@@ -59,7 +58,7 @@ public function paths()
 return $this->paths;
 }

 if ($paths = Cache::get($this->pathsCacheKey())) {
 if ($paths = Stache::cacheStore()->get($this->pathsCacheKey())) {
 return $this->paths = collect($paths);
 }

Expand Down

8 changes: 4 additions & 4 deletions
src/Stache/Stores/Keys.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\Stache;
use Statamic\Stache\Exceptions\DuplicateKeyException;

class Keys
Expand All@@ -17,19 +17,19 @@ public function __construct(Store $store)

 public function load()
 {
 $this->keys = Cache::get($this->cacheKey(), []);
 $this->keys = Stache::cacheStore()->get($this->cacheKey(), []);

 return $this;
 }

 public function cache()
 {
Cache::forever($this->cacheKey(), $this->keys);
Stache::cacheStore()->forever($this->cacheKey(), $this->keys);
 }

 public function clear()
 {
Cache::forget($this->cacheKey());
Stache::cacheStore()->forget($this->cacheKey());
 }

 private function cacheKey()
Expand Down

18 changes: 9 additions & 9 deletions
src/Stache/Stores/Store.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -97,7 +97,7 @@ public function indexUsage()
 {
 $key = $this->indexUsageCacheKey();

 return $this->usedIndexes = $this->usedIndexes ?? collect(Cache::get($key, []));
 return $this->usedIndexes = $this->usedIndexes ?? collect(Stache::cacheStore()->get($key, []));
 }

 public function cacheIndexUsage($index)
Expand All@@ -116,7 +116,7 @@ public function cacheIndexUsage($index)

 $this->usedIndexes = $indexes;

Cache::put($this->indexUsageCacheKey(), $indexes->all());
Stache::cacheStore()->put($this->indexUsageCacheKey(), $indexes->all());
 }

 protected function indexUsageCacheKey()
Expand DownExpand Up@@ -180,14 +180,14 @@ public function handleFileChanges()

 // Get the existing files and timestamps from the cache.
 $cacheKey = "stache::timestamps::{$this->key()}";
 $existing = collect(Cache::get($cacheKey, []));
 $existing = collect(Stache::cacheStore()->get($cacheKey, []));

 // Get the files and timestamps from the filesystem right now.
 $files = Traverser::filter([$this, 'getItemFilter'])->traverse($this);

 // Cache the files and timestamps, ready for comparisons on the next request.
 // We'll do it now since there are multiple early returns coming up.
Cache::forever($cacheKey, $files->all());
Stache::cacheStore()->forever($cacheKey, $files->all());

 // If there are no existing file timestamps in the cache, there's nothing to update.
 if ($existing->isEmpty()) {
Expand DownExpand Up@@ -291,7 +291,7 @@ public function paths()
 return $this->paths;
 }

 if ($paths = Cache::get($this->pathsCacheKey())) {
 if ($paths = Stache::cacheStore()->get($this->pathsCacheKey())) {
 return $this->paths = collect($paths);
 }

Expand DownExpand Up@@ -351,7 +351,7 @@ protected function setPath($key, $path)

 protected function cachePaths($paths)
 {
Cache::forever($this->pathsCacheKey(), $paths->all());
Stache::cacheStore()->forever($this->pathsCacheKey(), $paths->all());

 $this->paths = $paths;

Expand All@@ -361,7 +361,7 @@ protected function cachePaths($paths)
 public function clearCachedPaths()
 {
 $this->paths = null;
Cache::forget($this->pathsCacheKey());
Stache::cacheStore()->forget($this->pathsCacheKey());
 }

 protected function pathsCacheKey()
Expand All@@ -381,13 +381,13 @@ public function clear()
 });

 $this->usedIndexes = collect();
Cache::forget($this->indexUsageCacheKey());
Stache::cacheStore()->forget($this->indexUsageCacheKey());

 $this->clearCachedPaths();

 $this->keys()->clear();

Cache::forget("stache::timestamps::{$this->key()}");
Stache::cacheStore()->forget("stache::timestamps::{$this->key()}");
 }

 public function warm()
Expand Down

3 changes: 1 addition & 2 deletions
src/Stache/Stores/TaxonomyTermsStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,6 @@
namespace Statamic\Stache\Stores;

use Facades\Statamic\Stache\Traverser;
use Illuminate\Support\Facades\Cache;
use Statamic\Entries\GetSlugFromPath;
use Statamic\Facades\File;
use Statamic\Facades\Stache;
Expand DownExpand Up@@ -151,7 +150,7 @@ public function paths()
 return $this->paths;
 }

 if ($paths = Cache::get($this->pathsCacheKey())) {
 if ($paths = Stache::cacheStore()->get($this->pathsCacheKey())) {
 return $this->paths = collect($paths);
 }

Expand Down

9 changes: 7 additions & 2 deletions
tests/Stache/DuplicatesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,7 @@ public function it_saves_to_the_cache()

 $stache = $this->mock(Stache::class);
 $stache->shouldReceive('store')->with('test-store')->andReturn($store);
 $stache->shouldReceive('cacheStore')->andReturn(Cache::store());

 $duplicates = new Duplicates($stache);

Expand DownExpand Up@@ -146,7 +147,9 @@ public function it_loads_from_cache()
 {
 Cache::forever('stache::duplicates', ['foo' => 'bar']);

 $duplicates = new Duplicates($this->mock(Stache::class));
 $stache = $this->mock(Stache::class);
 $stache->shouldReceive('cacheStore')->andReturn(Cache::store());
 $duplicates = new Duplicates($stache);

 $return = $duplicates->load();

Expand All@@ -159,7 +162,9 @@ public function it_clears_the_cache()
 {
 Cache::forever('stache::duplicates', ['foo' => 'bar']);

 $duplicates = new Duplicates($this->mock(Stache::class));
 $stache = $this->mock(Stache::class);
 $stache->shouldReceive('cacheStore')->andReturn(Cache::store());
 $duplicates = new Duplicates($stache);

 $this->assertNotNull(Cache::get('stache::duplicates'));

Expand Down

2 changes: 2 additions & 0 deletions
tests/Stache/Stores/AssetContainersStoreTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use Facades\Statamic\Stache\Traverser;
use Illuminate\Filesystem\Filesystem;
use Illuminate\Support\Facades\Cache;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Assets\Asset;
use Statamic\Contracts\Assets\AssetContainer;
Expand DownExpand Up@@ -115,6 +116,7 @@ public function it_saves_to_disk()
 Facades\Stache::shouldReceive('duplicates')->andReturn(optional());
 Facades\Stache::shouldReceive('store')->with('users')->andReturn((new UsersStore((new Stache)->sites(['en']), app('files')))->directory($this->tempDir));
 Facades\Stache::shouldReceive('isWatcherEnabled')->andReturnTrue();
 Facades\Stache::shouldReceive('cacheStore')->andReturn(Cache::store());

 $container = Facades\AssetContainer::make('new')
 ->title('New Container');
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[5.x] Allow configuring the Stache's Cache Store#10303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jasonvarga
merged 7 commits into

from

Jun 24, 2024
 Merged


[5.x] Allow configuring the Stache's Cache Store
#10303
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
37563fb

Allow configuring the Stache's Cache Store


riasvdv Jun 14, 2024
7f266c9

Add a custom store test


riasvdv Jun 14, 2024
61db105

Run Pint


riasvdv Jun 14, 2024
78c4b85

Fix missed tests


riasvdv Jun 14, 2024
7817448

Update Stache.php


riasvdv Jun 15, 2024
8f891d3

Merge branch '5.x' into stache-cache-store


riasvdv Jun 24, 2024
4f0c4b4

fix the config location


jasonvarga Jun 24, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 11 additions & 0 deletions
config/stache.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,17 @@

 'watcher' => env('STATAMIC_STACHE_WATCHER', 'auto'),

 /*
 |--------------------------------------------------------------------------
 | Cache Store
 |--------------------------------------------------------------------------
 |
 | Here you may configure which Cache Store the Stache uses.
 |
 */

 'cache_store' => null,

 /*
 |--------------------------------------------------------------------------
 | Stores
Expand Down

1 change: 1 addition & 0 deletions
src/Facades/Stache.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
 * @method static self registerStores($stores)
 * @method static mixed stores()
 * @method static mixed store($key)
 * @method static \Illuminate\Contracts\Cache\Store cacheStore()
 * @method static string generateId()
 * @method static self clear()
 * @method static void refresh()
Expand Down

7 changes: 3 additions & 4 deletions
src/Stache/Duplicates.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache;

use Illuminate\Support\Facades\Cache;
use Statamic\Stache\Stores\AggregateStore;
use Statamic\Stache\Stores\Store;

Expand DownExpand Up@@ -49,19 +48,19 @@ public function cache()
 return;
 }

Cache::forever('stache::duplicates', $this->items);
$this->stache->cacheStore()->forever('stache::duplicates', $this->items);
 }

 public function load()
 {
 $this->items = Cache::get('stache::duplicates', []);
 $this->items = $this->stache->cacheStore()->get('stache::duplicates', []);

 return $this;
 }

 public function clear()
 {
Cache::forget('stache::duplicates');
$this->stache->cacheStore()->forget('stache::duplicates');

 return $this;
 }
Expand Down

9 changes: 4 additions & 5 deletions
src/Stache/Indexes/Index.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache\Indexes;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\Stache;
use Statamic\Statamic;

Expand DownExpand Up@@ -76,7 +75,7 @@ public function load()

 debugbar()->addMessage("Loading index: {$this->store->key()}/{$this->name}", 'stache');

 $this->items = Cache::get($this->cacheKey());
 $this->items = Stache::cacheStore()->get($this->cacheKey());

 if ($this->items === null) {
 $this->update();
Expand DownExpand Up@@ -106,12 +105,12 @@ public function update()

 public function isCached()
 {
 return Cache::has($this->cacheKey());
 return Stache::cacheStore()->has($this->cacheKey());
 }

 public function cache()
 {
Cache::forever($this->cacheKey(), $this->items);
Stache::cacheStore()->forever($this->cacheKey(), $this->items);
 }

 public function updateItem($item)
Expand DownExpand Up@@ -153,7 +152,7 @@ public function clear()
 $this->loaded = false;
 $this->items = null;

Cache::forget($this->cacheKey());
Stache::cacheStore()->forget($this->cacheKey());
 }

 public static function currentlyLoading()
Expand Down

13 changes: 9 additions & 4 deletions
src/Stache/Stache.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,11 @@ public function stores()
 return $this->stores;
 }

 public function cacheStore()
 {
 return Cache::store(config('statamic.stache.cache_store'));
 }

 public function store($key)
 {
 if (Str::contains($key, '::')) {
Expand All@@ -85,7 +90,7 @@ public function clear()

 $this->duplicates()->clear();

Cache::forget('stache::timing');
$this->cacheStore()->forget('stache::timing');

 return $this;
 }
Expand DownExpand Up@@ -146,7 +151,7 @@ public function stopTimer()
 return $this;
 }

Cache::forever('stache::timing', [
$this->cacheStore()->forever('stache::timing', [
 'time' => floor((microtime(true) - $this->startTime) * 1000),
 'date' => Carbon::now()->timestamp,
 ]);
Expand All@@ -156,12 +161,12 @@ public function stopTimer()

 public function buildTime()
 {
 return Cache::get('stache::timing')['time'] ?? null;
 return $this->cacheStore()->get('stache::timing')['time'] ?? null;
 }

 public function buildDate()
 {
 if (! $cache = Cache::get('stache::timing')) {
 if (! $cache = $this->cacheStore()->get('stache::timing')) {
 return null;
 }

Expand Down

8 changes: 4 additions & 4 deletions
src/Stache/Stores/BasicStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,8 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\File;
use Statamic\Facades\Stache;
use Symfony\Component\Finder\SplFileInfo;

abstract class BasicStore extends Store
Expand DownExpand Up@@ -77,7 +77,7 @@ protected function getCachedItem($key)
 {
 $cacheKey = $this->getItemCacheKey($key);

 return Cache::get($cacheKey);
 return Stache::cacheStore()->get($cacheKey);
 }

 protected function cacheItem($item)
Expand All@@ -86,12 +86,12 @@ protected function cacheItem($item)

 $cacheKey = $this->getItemCacheKey($key);

Cache::forever($cacheKey, $item);
Stache::cacheStore()->forever($cacheKey, $item);
 }

 public function forgetItem($key)
 {
Cache::forget($this->getItemCacheKey($key));
Stache::cacheStore()->forget($this->getItemCacheKey($key));
 }

 protected function getItemCacheKey($key)
Expand Down

4 changes: 2 additions & 2 deletions
src/Stache/Stores/CollectionEntriesStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Entries\GetDateFromPath;
use Statamic\Entries\GetSlugFromPath;
use Statamic\Entries\GetSuffixFromPath;
Expand All@@ -13,6 +12,7 @@
use Statamic\Facades\File;
use Statamic\Facades\Path;
use Statamic\Facades\Site;
use Statamic\Facades\Stache;
use Statamic\Facades\YAML;
use Statamic\Stache\Indexes;
use Statamic\Stache\Indexes\Index;
Expand DownExpand Up@@ -230,7 +230,7 @@ protected function getCachedItem($key)
 {
 $cacheKey = $this->getItemCacheKey($key);

 if (! $entry = Cache::get($cacheKey)) {
 if (! $entry = Stache::cacheStore()->get($cacheKey)) {
 return null;
 }

Expand Down

3 changes: 1 addition & 2 deletions
src/Stache/Stores/ContainerAssetsStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\AssetContainer;
use Statamic\Facades\Stache;
use Statamic\Statamic;
Expand DownExpand Up@@ -59,7 +58,7 @@ public function paths()
 return $this->paths;
 }

 if ($paths = Cache::get($this->pathsCacheKey())) {
 if ($paths = Stache::cacheStore()->get($this->pathsCacheKey())) {
 return $this->paths = collect($paths);
 }

Expand Down

8 changes: 4 additions & 4 deletions
src/Stache/Stores/Keys.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\Stache;
use Statamic\Stache\Exceptions\DuplicateKeyException;

class Keys
Expand All@@ -17,19 +17,19 @@ public function __construct(Store $store)

 public function load()
 {
 $this->keys = Cache::get($this->cacheKey(), []);
 $this->keys = Stache::cacheStore()->get($this->cacheKey(), []);

 return $this;
 }

 public function cache()
 {
Cache::forever($this->cacheKey(), $this->keys);
Stache::cacheStore()->forever($this->cacheKey(), $this->keys);
 }

 public function clear()
 {
Cache::forget($this->cacheKey());
Stache::cacheStore()->forget($this->cacheKey());
 }

 private function cacheKey()
Expand Down

18 changes: 9 additions & 9 deletions
src/Stache/Stores/Store.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -97,7 +97,7 @@ public function indexUsage()
 {
 $key = $this->indexUsageCacheKey();

 return $this->usedIndexes = $this->usedIndexes ?? collect(Cache::get($key, []));
 return $this->usedIndexes = $this->usedIndexes ?? collect(Stache::cacheStore()->get($key, []));
 }

 public function cacheIndexUsage($index)
Expand All@@ -116,7 +116,7 @@ public function cacheIndexUsage($index)

 $this->usedIndexes = $indexes;

Cache::put($this->indexUsageCacheKey(), $indexes->all());
Stache::cacheStore()->put($this->indexUsageCacheKey(), $indexes->all());
 }

 protected function indexUsageCacheKey()
Expand DownExpand Up@@ -180,14 +180,14 @@ public function handleFileChanges()

 // Get the existing files and timestamps from the cache.
 $cacheKey = "stache::timestamps::{$this->key()}";
 $existing = collect(Cache::get($cacheKey, []));
 $existing = collect(Stache::cacheStore()->get($cacheKey, []));

 // Get the files and timestamps from the filesystem right now.
 $files = Traverser::filter([$this, 'getItemFilter'])->traverse($this);

 // Cache the files and timestamps, ready for comparisons on the next request.
 // We'll do it now since there are multiple early returns coming up.
Cache::forever($cacheKey, $files->all());
Stache::cacheStore()->forever($cacheKey, $files->all());

 // If there are no existing file timestamps in the cache, there's nothing to update.
 if ($existing->isEmpty()) {
Expand DownExpand Up@@ -291,7 +291,7 @@ public function paths()
 return $this->paths;
 }

 if ($paths = Cache::get($this->pathsCacheKey())) {
 if ($paths = Stache::cacheStore()->get($this->pathsCacheKey())) {
 return $this->paths = collect($paths);
 }

Expand DownExpand Up@@ -351,7 +351,7 @@ protected function setPath($key, $path)

 protected function cachePaths($paths)
 {
Cache::forever($this->pathsCacheKey(), $paths->all());
Stache::cacheStore()->forever($this->pathsCacheKey(), $paths->all());

 $this->paths = $paths;

Expand All@@ -361,7 +361,7 @@ protected function cachePaths($paths)
 public function clearCachedPaths()
 {
 $this->paths = null;
Cache::forget($this->pathsCacheKey());
Stache::cacheStore()->forget($this->pathsCacheKey());
 }

 protected function pathsCacheKey()
Expand All@@ -381,13 +381,13 @@ public function clear()
 });

 $this->usedIndexes = collect();
Cache::forget($this->indexUsageCacheKey());
Stache::cacheStore()->forget($this->indexUsageCacheKey());

 $this->clearCachedPaths();

 $this->keys()->clear();

Cache::forget("stache::timestamps::{$this->key()}");
Stache::cacheStore()->forget("stache::timestamps::{$this->key()}");
 }

 public function warm()
Expand Down

3 changes: 1 addition & 2 deletions
src/Stache/Stores/TaxonomyTermsStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,6 @@
namespace Statamic\Stache\Stores;

use Facades\Statamic\Stache\Traverser;
use Illuminate\Support\Facades\Cache;
use Statamic\Entries\GetSlugFromPath;
use Statamic\Facades\File;
use Statamic\Facades\Stache;
Expand DownExpand Up@@ -151,7 +150,7 @@ public function paths()
 return $this->paths;
 }

 if ($paths = Cache::get($this->pathsCacheKey())) {
 if ($paths = Stache::cacheStore()->get($this->pathsCacheKey())) {
 return $this->paths = collect($paths);
 }

Expand Down

9 changes: 7 additions & 2 deletions
tests/Stache/DuplicatesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,7 @@ public function it_saves_to_the_cache()

 $stache = $this->mock(Stache::class);
 $stache->shouldReceive('store')->with('test-store')->andReturn($store);
 $stache->shouldReceive('cacheStore')->andReturn(Cache::store());

 $duplicates = new Duplicates($stache);

Expand DownExpand Up@@ -146,7 +147,9 @@ public function it_loads_from_cache()
 {
 Cache::forever('stache::duplicates', ['foo' => 'bar']);

 $duplicates = new Duplicates($this->mock(Stache::class));
 $stache = $this->mock(Stache::class);
 $stache->shouldReceive('cacheStore')->andReturn(Cache::store());
 $duplicates = new Duplicates($stache);

 $return = $duplicates->load();

Expand All@@ -159,7 +162,9 @@ public function it_clears_the_cache()
 {
 Cache::forever('stache::duplicates', ['foo' => 'bar']);

 $duplicates = new Duplicates($this->mock(Stache::class));
 $stache = $this->mock(Stache::class);
 $stache->shouldReceive('cacheStore')->andReturn(Cache::store());
 $duplicates = new Duplicates($stache);

 $this->assertNotNull(Cache::get('stache::duplicates'));

Expand Down

2 changes: 2 additions & 0 deletions
tests/Stache/Stores/AssetContainersStoreTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use Facades\Statamic\Stache\Traverser;
use Illuminate\Filesystem\Filesystem;
use Illuminate\Support\Facades\Cache;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Assets\Asset;
use Statamic\Contracts\Assets\AssetContainer;
Expand DownExpand Up@@ -115,6 +116,7 @@ public function it_saves_to_disk()
 Facades\Stache::shouldReceive('duplicates')->andReturn(optional());
 Facades\Stache::shouldReceive('store')->with('users')->andReturn((new UsersStore((new Stache)->sites(['en']), app('files')))->directory($this->tempDir));
 Facades\Stache::shouldReceive('isWatcherEnabled')->andReturnTrue();
 Facades\Stache::shouldReceive('cacheStore')->andReturn(Cache::store());

 $container = Facades\AssetContainer::make('new')
 ->title('New Container');
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
[5.x] Allow configuring the Stache's Cache Store#10303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jasonvarga
merged 7 commits into

from

Jun 24, 2024
 Merged


[5.x] Allow configuring the Stache's Cache Store
#10303
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


7 commits


Select commit
Hold shift + click to select a range
37563fb

Allow configuring the Stache's Cache Store


riasvdv Jun 14, 2024
7f266c9

Add a custom store test


riasvdv Jun 14, 2024
61db105

Run Pint


riasvdv Jun 14, 2024
78c4b85

Fix missed tests


riasvdv Jun 14, 2024
7817448

Update Stache.php


riasvdv Jun 15, 2024
8f891d3

Merge branch '5.x' into stache-cache-store


riasvdv Jun 24, 2024
4f0c4b4

fix the config location


jasonvarga Jun 24, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


11 changes: 11 additions & 0 deletions
config/stache.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,17 @@

 'watcher' => env('STATAMIC_STACHE_WATCHER', 'auto'),

 /*
 |--------------------------------------------------------------------------
 | Cache Store
 |--------------------------------------------------------------------------
 |
 | Here you may configure which Cache Store the Stache uses.
 |
 */

 'cache_store' => null,

 /*
 |--------------------------------------------------------------------------
 | Stores
Expand Down

1 change: 1 addition & 0 deletions
src/Facades/Stache.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
 * @method static self registerStores($stores)
 * @method static mixed stores()
 * @method static mixed store($key)
 * @method static \Illuminate\Contracts\Cache\Store cacheStore()
 * @method static string generateId()
 * @method static self clear()
 * @method static void refresh()
Expand Down

7 changes: 3 additions & 4 deletions
src/Stache/Duplicates.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache;

use Illuminate\Support\Facades\Cache;
use Statamic\Stache\Stores\AggregateStore;
use Statamic\Stache\Stores\Store;

Expand DownExpand Up@@ -49,19 +48,19 @@ public function cache()
 return;
 }

Cache::forever('stache::duplicates', $this->items);
$this->stache->cacheStore()->forever('stache::duplicates', $this->items);
 }

 public function load()
 {
 $this->items = Cache::get('stache::duplicates', []);
 $this->items = $this->stache->cacheStore()->get('stache::duplicates', []);

 return $this;
 }

 public function clear()
 {
Cache::forget('stache::duplicates');
$this->stache->cacheStore()->forget('stache::duplicates');

 return $this;
 }
Expand Down

9 changes: 4 additions & 5 deletions
src/Stache/Indexes/Index.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache\Indexes;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\Stache;
use Statamic\Statamic;

Expand DownExpand Up@@ -76,7 +75,7 @@ public function load()

 debugbar()->addMessage("Loading index: {$this->store->key()}/{$this->name}", 'stache');

 $this->items = Cache::get($this->cacheKey());
 $this->items = Stache::cacheStore()->get($this->cacheKey());

 if ($this->items === null) {
 $this->update();
Expand DownExpand Up@@ -106,12 +105,12 @@ public function update()

 public function isCached()
 {
 return Cache::has($this->cacheKey());
 return Stache::cacheStore()->has($this->cacheKey());
 }

 public function cache()
 {
Cache::forever($this->cacheKey(), $this->items);
Stache::cacheStore()->forever($this->cacheKey(), $this->items);
 }

 public function updateItem($item)
Expand DownExpand Up@@ -153,7 +152,7 @@ public function clear()
 $this->loaded = false;
 $this->items = null;

Cache::forget($this->cacheKey());
Stache::cacheStore()->forget($this->cacheKey());
 }

 public static function currentlyLoading()
Expand Down

13 changes: 9 additions & 4 deletions
src/Stache/Stache.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,11 @@ public function stores()
 return $this->stores;
 }

 public function cacheStore()
 {
 return Cache::store(config('statamic.stache.cache_store'));
 }

 public function store($key)
 {
 if (Str::contains($key, '::')) {
Expand All@@ -85,7 +90,7 @@ public function clear()

 $this->duplicates()->clear();

Cache::forget('stache::timing');
$this->cacheStore()->forget('stache::timing');

 return $this;
 }
Expand DownExpand Up@@ -146,7 +151,7 @@ public function stopTimer()
 return $this;
 }

Cache::forever('stache::timing', [
$this->cacheStore()->forever('stache::timing', [
 'time' => floor((microtime(true) - $this->startTime) * 1000),
 'date' => Carbon::now()->timestamp,
 ]);
Expand All@@ -156,12 +161,12 @@ public function stopTimer()

 public function buildTime()
 {
 return Cache::get('stache::timing')['time'] ?? null;
 return $this->cacheStore()->get('stache::timing')['time'] ?? null;
 }

 public function buildDate()
 {
 if (! $cache = Cache::get('stache::timing')) {
 if (! $cache = $this->cacheStore()->get('stache::timing')) {
 return null;
 }

Expand Down

8 changes: 4 additions & 4 deletions
src/Stache/Stores/BasicStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,8 +2,8 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\File;
use Statamic\Facades\Stache;
use Symfony\Component\Finder\SplFileInfo;

abstract class BasicStore extends Store
Expand DownExpand Up@@ -77,7 +77,7 @@ protected function getCachedItem($key)
 {
 $cacheKey = $this->getItemCacheKey($key);

 return Cache::get($cacheKey);
 return Stache::cacheStore()->get($cacheKey);
 }

 protected function cacheItem($item)
Expand All@@ -86,12 +86,12 @@ protected function cacheItem($item)

 $cacheKey = $this->getItemCacheKey($key);

Cache::forever($cacheKey, $item);
Stache::cacheStore()->forever($cacheKey, $item);
 }

 public function forgetItem($key)
 {
Cache::forget($this->getItemCacheKey($key));
Stache::cacheStore()->forget($this->getItemCacheKey($key));
 }

 protected function getItemCacheKey($key)
Expand Down

4 changes: 2 additions & 2 deletions
src/Stache/Stores/CollectionEntriesStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Entries\GetDateFromPath;
use Statamic\Entries\GetSlugFromPath;
use Statamic\Entries\GetSuffixFromPath;
Expand All@@ -13,6 +12,7 @@
use Statamic\Facades\File;
use Statamic\Facades\Path;
use Statamic\Facades\Site;
use Statamic\Facades\Stache;
use Statamic\Facades\YAML;
use Statamic\Stache\Indexes;
use Statamic\Stache\Indexes\Index;
Expand DownExpand Up@@ -230,7 +230,7 @@ protected function getCachedItem($key)
 {
 $cacheKey = $this->getItemCacheKey($key);

 if (! $entry = Cache::get($cacheKey)) {
 if (! $entry = Stache::cacheStore()->get($cacheKey)) {
 return null;
 }

Expand Down

3 changes: 1 addition & 2 deletions
src/Stache/Stores/ContainerAssetsStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\AssetContainer;
use Statamic\Facades\Stache;
use Statamic\Statamic;
Expand DownExpand Up@@ -59,7 +58,7 @@ public function paths()
 return $this->paths;
 }

 if ($paths = Cache::get($this->pathsCacheKey())) {
 if ($paths = Stache::cacheStore()->get($this->pathsCacheKey())) {
 return $this->paths = collect($paths);
 }

Expand Down

8 changes: 4 additions & 4 deletions
src/Stache/Stores/Keys.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@

namespace Statamic\Stache\Stores;

use Illuminate\Support\Facades\Cache;
use Statamic\Facades\Stache;
use Statamic\Stache\Exceptions\DuplicateKeyException;

class Keys
Expand All@@ -17,19 +17,19 @@ public function __construct(Store $store)

 public function load()
 {
 $this->keys = Cache::get($this->cacheKey(), []);
 $this->keys = Stache::cacheStore()->get($this->cacheKey(), []);

 return $this;
 }

 public function cache()
 {
Cache::forever($this->cacheKey(), $this->keys);
Stache::cacheStore()->forever($this->cacheKey(), $this->keys);
 }

 public function clear()
 {
Cache::forget($this->cacheKey());
Stache::cacheStore()->forget($this->cacheKey());
 }

 private function cacheKey()
Expand Down

18 changes: 9 additions & 9 deletions
src/Stache/Stores/Store.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -97,7 +97,7 @@ public function indexUsage()
 {
 $key = $this->indexUsageCacheKey();

 return $this->usedIndexes = $this->usedIndexes ?? collect(Cache::get($key, []));
 return $this->usedIndexes = $this->usedIndexes ?? collect(Stache::cacheStore()->get($key, []));
 }

 public function cacheIndexUsage($index)
Expand All@@ -116,7 +116,7 @@ public function cacheIndexUsage($index)

 $this->usedIndexes = $indexes;

Cache::put($this->indexUsageCacheKey(), $indexes->all());
Stache::cacheStore()->put($this->indexUsageCacheKey(), $indexes->all());
 }

 protected function indexUsageCacheKey()
Expand DownExpand Up@@ -180,14 +180,14 @@ public function handleFileChanges()

 // Get the existing files and timestamps from the cache.
 $cacheKey = "stache::timestamps::{$this->key()}";
 $existing = collect(Cache::get($cacheKey, []));
 $existing = collect(Stache::cacheStore()->get($cacheKey, []));

 // Get the files and timestamps from the filesystem right now.
 $files = Traverser::filter([$this, 'getItemFilter'])->traverse($this);

 // Cache the files and timestamps, ready for comparisons on the next request.
 // We'll do it now since there are multiple early returns coming up.
Cache::forever($cacheKey, $files->all());
Stache::cacheStore()->forever($cacheKey, $files->all());

 // If there are no existing file timestamps in the cache, there's nothing to update.
 if ($existing->isEmpty()) {
Expand DownExpand Up@@ -291,7 +291,7 @@ public function paths()
 return $this->paths;
 }

 if ($paths = Cache::get($this->pathsCacheKey())) {
 if ($paths = Stache::cacheStore()->get($this->pathsCacheKey())) {
 return $this->paths = collect($paths);
 }

Expand DownExpand Up@@ -351,7 +351,7 @@ protected function setPath($key, $path)

 protected function cachePaths($paths)
 {
Cache::forever($this->pathsCacheKey(), $paths->all());
Stache::cacheStore()->forever($this->pathsCacheKey(), $paths->all());

 $this->paths = $paths;

Expand All@@ -361,7 +361,7 @@ protected function cachePaths($paths)
 public function clearCachedPaths()
 {
 $this->paths = null;
Cache::forget($this->pathsCacheKey());
Stache::cacheStore()->forget($this->pathsCacheKey());
 }

 protected function pathsCacheKey()
Expand All@@ -381,13 +381,13 @@ public function clear()
 });

 $this->usedIndexes = collect();
Cache::forget($this->indexUsageCacheKey());
Stache::cacheStore()->forget($this->indexUsageCacheKey());

 $this->clearCachedPaths();

 $this->keys()->clear();

Cache::forget("stache::timestamps::{$this->key()}");
Stache::cacheStore()->forget("stache::timestamps::{$this->key()}");
 }

 public function warm()
Expand Down

3 changes: 1 addition & 2 deletions
src/Stache/Stores/TaxonomyTermsStore.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,6 @@
namespace Statamic\Stache\Stores;

use Facades\Statamic\Stache\Traverser;
use Illuminate\Support\Facades\Cache;
use Statamic\Entries\GetSlugFromPath;
use Statamic\Facades\File;
use Statamic\Facades\Stache;
Expand DownExpand Up@@ -151,7 +150,7 @@ public function paths()
 return $this->paths;
 }

 if ($paths = Cache::get($this->pathsCacheKey())) {
 if ($paths = Stache::cacheStore()->get($this->pathsCacheKey())) {
 return $this->paths = collect($paths);
 }

Expand Down

9 changes: 7 additions & 2 deletions
tests/Stache/DuplicatesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -111,6 +111,7 @@ public function it_saves_to_the_cache()

 $stache = $this->mock(Stache::class);
 $stache->shouldReceive('store')->with('test-store')->andReturn($store);
 $stache->shouldReceive('cacheStore')->andReturn(Cache::store());

 $duplicates = new Duplicates($stache);

Expand DownExpand Up@@ -146,7 +147,9 @@ public function it_loads_from_cache()
 {
 Cache::forever('stache::duplicates', ['foo' => 'bar']);

 $duplicates = new Duplicates($this->mock(Stache::class));
 $stache = $this->mock(Stache::class);
 $stache->shouldReceive('cacheStore')->andReturn(Cache::store());
 $duplicates = new Duplicates($stache);

 $return = $duplicates->load();

Expand All@@ -159,7 +162,9 @@ public function it_clears_the_cache()
 {
 Cache::forever('stache::duplicates', ['foo' => 'bar']);

 $duplicates = new Duplicates($this->mock(Stache::class));
 $stache = $this->mock(Stache::class);
 $stache->shouldReceive('cacheStore')->andReturn(Cache::store());
 $duplicates = new Duplicates($stache);

 $this->assertNotNull(Cache::get('stache::duplicates'));

Expand Down

2 changes: 2 additions & 0 deletions
tests/Stache/Stores/AssetContainersStoreTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use Facades\Statamic\Stache\Traverser;
use Illuminate\Filesystem\Filesystem;
use Illuminate\Support\Facades\Cache;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Assets\Asset;
use Statamic\Contracts\Assets\AssetContainer;
Expand DownExpand Up@@ -115,6 +116,7 @@ public function it_saves_to_disk()
 Facades\Stache::shouldReceive('duplicates')->andReturn(optional());
 Facades\Stache::shouldReceive('store')->with('users')->andReturn((new UsersStore((new Stache)->sites(['en']), app('files')))->directory($this->tempDir));
 Facades\Stache::shouldReceive('isWatcherEnabled')->andReturnTrue();
 Facades\Stache::shouldReceive('cacheStore')->andReturn(Cache::store());

 $container = Facades\AssetContainer::make('new')
 ->title('New Container');
Expand Down
Loading