From fbbe3d00ffb312938b51650e34eb757a413b1e21 Mon Sep 17 00:00:00 2001
From: Jon Waldstein <jonwaldstein@jwaldstein-mbp.mynetworksettings.com>
Date: Fri, 23 Aug 2024 11:26:06 -0400
Subject: [PATCH] feature: add abstract class and make permissions more dynamic
 based on cap and role

---
 .../Contracts/UserPermissionsInterface.php    | 19 ++++++
 .../Permissions/DonationFormPermissions.php   | 16 +++++
 .../Permissions/DonationFormsPermissions.php  | 26 --------
 .../Permissions/DonationPermissions.php       | 17 +++++
 .../Permissions/DonorPermissions.php          | 17 +++++
 .../Permissions/Facades/UserPermissions.php   |  8 ++-
 .../Facades/UserPermissionsFacade.php         | 24 ++++++-
 src/Framework/Permissions/UserPermission.php  | 66 +++++++++++++++++++
 .../Facades/TestUserPermissions.php           |  4 +-
 9 files changed, 164 insertions(+), 33 deletions(-)
 create mode 100644 src/Framework/Permissions/Contracts/UserPermissionsInterface.php
 create mode 100644 src/Framework/Permissions/DonationFormPermissions.php
 delete mode 100644 src/Framework/Permissions/DonationFormsPermissions.php
 create mode 100644 src/Framework/Permissions/DonationPermissions.php
 create mode 100644 src/Framework/Permissions/DonorPermissions.php
 create mode 100644 src/Framework/Permissions/UserPermission.php

diff --git a/src/Framework/Permissions/Contracts/UserPermissionsInterface.php b/src/Framework/Permissions/Contracts/UserPermissionsInterface.php
new file mode 100644
index 0000000000..d4449f6db6
--- /dev/null
+++ b/src/Framework/Permissions/Contracts/UserPermissionsInterface.php
@@ -0,0 +1,19 @@
+<?php
+
+namespace Give\Framework\Permissions\Contracts;
+
+/**
+ * @unreleased
+ */
+interface UserPermissionsInterface
+{
+     /**
+     * @return string
+     */
+    public static function getType(): string;
+
+    /**
+     * @unreleased
+     */
+    public function can(string $capability): bool;
+}
diff --git a/src/Framework/Permissions/DonationFormPermissions.php b/src/Framework/Permissions/DonationFormPermissions.php
new file mode 100644
index 0000000000..c318329e31
--- /dev/null
+++ b/src/Framework/Permissions/DonationFormPermissions.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace Give\Framework\Permissions;
+/**
+ * @unreleased
+ */
+class DonationFormPermissions extends UserPermission
+{
+    /**
+     * @unreleased
+     */
+    public static function getType(): string
+    {
+        return 'give_form';
+    }
+}
diff --git a/src/Framework/Permissions/DonationFormsPermissions.php b/src/Framework/Permissions/DonationFormsPermissions.php
deleted file mode 100644
index c6d9ee3c73..0000000000
--- a/src/Framework/Permissions/DonationFormsPermissions.php
+++ /dev/null
@@ -1,26 +0,0 @@
-<?php
-
-namespace Give\Framework\Permissions;
-
-class DonationFormsPermissions
-{
-    /**
-     * @unreleased
-     */
-    public function can(string $capability): bool
-    {
-        switch ($capability) {
-            case 'delete':
-                $capability = 'delete_give_forms';
-                break;
-            case 'create':
-            case 'update':
-            case 'read':
-            case 'edit':
-                $capability = 'edit_give_forms';
-                break;
-        }
-
-        return current_user_can($capability);
-    }
-}
diff --git a/src/Framework/Permissions/DonationPermissions.php b/src/Framework/Permissions/DonationPermissions.php
new file mode 100644
index 0000000000..c3cb306aa5
--- /dev/null
+++ b/src/Framework/Permissions/DonationPermissions.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace Give\Framework\Permissions;
+
+/**
+ * @unreleased
+ */
+class DonationPermissions extends UserPermission
+{
+    /**
+     * @unreleased
+     */
+    public static function getType(): string
+    {
+        return 'give_payment';
+    }
+}
diff --git a/src/Framework/Permissions/DonorPermissions.php b/src/Framework/Permissions/DonorPermissions.php
new file mode 100644
index 0000000000..0e7899e83a
--- /dev/null
+++ b/src/Framework/Permissions/DonorPermissions.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace Give\Framework\Permissions;
+
+/**
+ * @unreleased
+ */
+class DonorPermissions extends UserPermission
+{
+    /**
+     * @unreleased
+     */
+    public static function getType(): string
+    {
+        return 'give_payment';
+    }
+}
diff --git a/src/Framework/Permissions/Facades/UserPermissions.php b/src/Framework/Permissions/Facades/UserPermissions.php
index 99f951f736..c42b748364 100644
--- a/src/Framework/Permissions/Facades/UserPermissions.php
+++ b/src/Framework/Permissions/Facades/UserPermissions.php
@@ -2,13 +2,17 @@
 
 namespace Give\Framework\Permissions\Facades;
 
-use Give\Framework\Permissions\DonationFormsPermissions;
+use Give\Framework\Permissions\DonationFormPermissions;
+use Give\Framework\Permissions\DonationPermissions;
+use Give\Framework\Permissions\DonorPermissions;
 use Give\Framework\Support\Facades\Facade;
 
 /**
  * @unreleased
  *
- * @method static DonationFormsPermissions donationForms()
+ * @method static DonationFormPermissions donationForms()
+ * @method static DonationPermissions donations()
+ * @method static DonorPermissions donors()
  */
 class UserPermissions extends Facade
 {
diff --git a/src/Framework/Permissions/Facades/UserPermissionsFacade.php b/src/Framework/Permissions/Facades/UserPermissionsFacade.php
index 1872cf5afc..701a36a603 100644
--- a/src/Framework/Permissions/Facades/UserPermissionsFacade.php
+++ b/src/Framework/Permissions/Facades/UserPermissionsFacade.php
@@ -2,7 +2,9 @@
 
 namespace Give\Framework\Permissions\Facades;
 
-use Give\Framework\Permissions\DonationFormsPermissions;
+use Give\Framework\Permissions\DonationFormPermissions;
+use Give\Framework\Permissions\DonationPermissions;
+use Give\Framework\Permissions\DonorPermissions;
 
 /**
  * This is a facade for interacting with WP and GiveWP permissions.
@@ -16,8 +18,24 @@ class UserPermissionsFacade
     /**
      * @unreleased
      */
-    public function donationForms(): DonationFormsPermissions
+    public function donationForms(): DonationFormPermissions
     {
-        return new DonationFormsPermissions();
+        return new DonationFormPermissions();
+    }
+
+    /**
+     * @unreleased
+     */
+    public function donations(): DonationPermissions
+    {
+        return new DonationPermissions();
+    }
+
+    /**
+     * @unreleased
+     */
+    public function donors(): DonorPermissions
+    {
+        return new DonorPermissions();
     }
 }
diff --git a/src/Framework/Permissions/UserPermission.php b/src/Framework/Permissions/UserPermission.php
new file mode 100644
index 0000000000..fc367afdac
--- /dev/null
+++ b/src/Framework/Permissions/UserPermission.php
@@ -0,0 +1,66 @@
+<?php
+namespace Give\Framework\Permissions;
+
+abstract class UserPermission implements Contracts\UserPermissionsInterface
+{
+    /**
+     * @unreleased
+     */
+    public function can(string $capability): bool
+    {
+        switch ($capability) {
+            case 'delete':
+                $capability = $this->getCapability('delete');
+                break;
+            case 'read':
+            case 'view':
+            case 'create':
+            case 'update':
+            case 'edit':
+                $capability = $this->getCapability('edit');
+                break;
+        }
+
+        return current_user_can($capability);
+    }
+
+    /**
+     * @unreleased
+     */
+    protected function getCapability( string $cap): string
+    {
+        $caps = $this->getCapabilities($this::getType());
+
+        return $caps[$cap];
+    }
+
+    /**
+     * @unreleased
+     */
+    protected function getCapabilities(string $type): array
+    {
+        return [
+            // Post type.
+            "edit" => "edit_{$type}s",
+            "edit_others" => "edit_others_{$type}s",
+            "publish" => "publish_{$type}s",
+            "read_private" => "read_private_{$type}s",
+            "delete" => "delete_{$type}s",
+            "delete_private" => "delete_private_{$type}s",
+            "delete_published" => "delete_published_{$type}s",
+            "delete_others" => "delete_others_{$type}s",
+            "edit_private" => "edit_private_{$type}s",
+            "edit_published" => "edit_published_{$type}s",
+
+            // Terms / taxonomies.
+            "manage_terms" => "manage_{$type}_terms",
+            "edit_terms" => "edit_{$type}_terms",
+            "delete_terms" => "delete_{$type}_terms",
+            "assign_terms" => "assign_{$type}_terms",
+
+            // Custom capabilities.
+            "view_stats" => "view_{$type}_stats",
+            "import" => "import_{$type}s"
+        ];
+    }
+}
diff --git a/tests/Unit/Framework/Permissions/Facades/TestUserPermissions.php b/tests/Unit/Framework/Permissions/Facades/TestUserPermissions.php
index 7c35def0f0..0e4ab19938 100644
--- a/tests/Unit/Framework/Permissions/Facades/TestUserPermissions.php
+++ b/tests/Unit/Framework/Permissions/Facades/TestUserPermissions.php
@@ -2,7 +2,7 @@
 
 namespace Give\Tests\Unit\Framework\Permissions\Facades;
 
-use Give\Framework\Permissions\DonationFormsPermissions;
+use Give\Framework\Permissions\DonationFormPermissions;
 use Give\Framework\Permissions\Facades\UserPermissions;
 use Give\Tests\TestCase;
 use Give\Tests\TestTraits\RefreshDatabase;
@@ -20,7 +20,7 @@ final class TestUserPermissions extends TestCase
     public function testDonationForms(): void
     {
         $this->assertInstanceOf(
-            DonationFormsPermissions::class,
+            DonationFormPermissions::class,
             UserPermissions::donationForms()
         );
     }