Update config to ignorelist. Add test coverage. Closes #19

silverstripe-terraformers · Oct 19, 2021 · 3cad253 · 3cad253
1 parent ae18ecd
commit 3cad253
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 4 deletions.
diff --git a/_config/blacklist.yml → _config/ignorelist.yml b/_config/blacklist.yml → _config/ignorelist.yml
@@ -1,8 +1,8 @@
 ---
-Name: kfc-blacklist
+Name: kfc-ignorelist
 ---
 Terraformers\KeysForCache\Models\CacheKey:
-  blacklist:
+  ignorelist:
     CacheKey: Terraformers\KeysForCache\Models\CacheKey
     ChangeSet: SilverStripe\Versioned\ChangeSet
     ChangeSetItem: SilverStripe\Versioned\ChangeSetItem

diff --git a/src/Extensions/CacheKeyExtension.php b/src/Extensions/CacheKeyExtension.php
@@ -91,9 +91,9 @@ public function onAfterUnpublish(): void
 
     protected function triggerEvent(bool $publishUpdates = false): void
     {
-        $blacklist = Config::forClass(CacheKey::class)->get('blacklist');
+        $ignoreList = Config::forClass(CacheKey::class)->get('ignorelist');
 
-        if (in_array($this->owner->ClassName, $blacklist)) {
+        if (in_array($this->owner->ClassName, $ignoreList)) {
             return;
         }
 

diff --git a/tests/Extensions/CacheKeyExtensionTest.php b/tests/Extensions/CacheKeyExtensionTest.php
@@ -262,4 +262,25 @@ public function testUpdateCMSFieldsNoKeyConfig(): void
         $this->assertNull($fields->dataFieldByName('CacheKeys'));
     }
 
+    public function testIgnoreList(): void
+    {
+        // Add our CachePage to the ignorelist
+        $ignoreList = CacheKey::config()->get('ignorelist');
+        $ignoreList['CachePage'] = CachePage::class;
+        CacheKey::config()->set('ignorelist', $ignoreList);
+
+        // Create the Page
+        $page = CachePage::create();
+        $page->write();
+
+        // No CacheKey should have been generated
+        $this->assertCount(
+            0,
+            CacheKey::get()->filter([
+                'RecordClass' => $page->ClassName,
+                'RecordID' => $page->ID,
+            ])
+        );
+    }
+
 }