Fun: UserPermissions facade

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;
+}

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';
+    }
+}

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';
+    }
+}

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';
+    }
+}

src/Framework/Permissions/Facades/UserPermissions.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Give\Framework\Permissions\Facades;
+
+use Give\Framework\Permissions\DonationFormPermissions;
+use Give\Framework\Permissions\DonationPermissions;
+use Give\Framework\Permissions\DonorPermissions;
+use Give\Framework\Support\Facades\Facade;
+
+/**
+ * @unreleased
+ *
+ * @method static DonationFormPermissions donationForms()
+ * @method static DonationPermissions donations()
+ * @method static DonorPermissions donors()
+ */
+class UserPermissions extends Facade
+{
+    protected function getFacadeAccessor(): string
+    {
+        return UserPermissionsFacade::class;
+    }
+}

src/Framework/Permissions/Facades/UserPermissionsFacade.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Give\Framework\Permissions\Facades;
+
+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.
+ *
+ * @see https://wordpress.org/documentation/article/roles-and-capabilities/
+ *
+ * @unreleased
+ */
+class UserPermissionsFacade
+{
+    /**
+     * @unreleased
+     */
+    public function donationForms(): DonationFormPermissions
+    {
+        return new DonationFormPermissions();
+    }
+
+    /**
+     * @unreleased
+     */
+    public function donations(): DonationPermissions
+    {
+        return new DonationPermissions();
+    }
+
+    /**
+     * @unreleased
+     */
+    public function donors(): DonorPermissions
+    {
+        return new DonorPermissions();
+    }
+}

src/Framework/Permissions/README.md

@@ -0,0 +1,15 @@
+# Permissions Facade
+
+The Permissions Facade is a class that allows you to check if a user has a specific capability or role. It is a wrapper around the WordPress `current_user_can()` function.
+
+Example:
+
+```php
+use Give\Framework\Permissions\Permissions;
+
+if (!UserPermissions::donationForms()->can('edit')) {
+    throw new Exception('You do not have permission to edit donation forms.');
+}
+```
+};
+```

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"
+        ];
+    }
+}

tests/Unit/Framework/Permissions/Facades/TestUserPermissions.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Give\Tests\Unit\Framework\Permissions\Facades;
+
+use Give\Framework\Permissions\DonationFormPermissions;
+use Give\Framework\Permissions\Facades\UserPermissions;
+use Give\Tests\TestCase;
+use Give\Tests\TestTraits\RefreshDatabase;
+
+/**
+ * @unreleased
+ */
+final class TestUserPermissions extends TestCase
+{
+    use RefreshDatabase;
+
+    /**
+     * @unreleased
+     */
+    public function testDonationForms(): void
+    {
+        $this->assertInstanceOf(
+            DonationFormPermissions::class,
+            UserPermissions::donationForms()
+        );
+    }
+
+}

tests/Unit/Framework/Permissions/TestDonationFormsPermissions.php

@@ -0,0 +1,93 @@
+<?php
+
+namespace Give\Tests\Unit\Framework\Permissions;
+
+use Give\Framework\Permissions\Facades\UserPermissions;
+use Give\Tests\TestCase;
+use Give\Tests\TestTraits\RefreshDatabase;
+
+/**
+ * @unreleased
+ */
+final class TestDonationFormsPermissions extends TestCase
+{
+    use RefreshDatabase;
+
+    /**
+     * @unreleased
+     * @dataProvider canProvider
+     */
+    public function testCan($role, $capability, $shouldPass): void
+    {
+        $user = self::factory()->user->create_and_get();
+        $user->add_role($role);
+
+        wp_set_current_user($user->ID);
+
+        if ($shouldPass) {
+            $this->assertTrue(
+                UserPermissions::donationForms()->can($capability)
+            );
+        } else {
+            $this->assertFalse(
+                UserPermissions::donationForms()->can($capability)
+            );
+        }
+    }
+
+
+       /**
+     * @unreleased
+     *
+     * @return array<int, array<mixed, bool>>
+     */
+    public function canProvider(): array
+    {
+        return [
+            // true
+            ['give_worker', 'create', true],
+            ['give_worker', 'read', true],
+            ['give_worker', 'update', true],
+            ['give_worker', 'edit', true],
+
+            ['give_manager', 'create', true],
+            ['give_manager', 'read', true],
+            ['give_manager', 'update', true],
+            ['give_manager', 'edit', true],
+            ['give_manager', 'delete', true],
+
+            ['give_accountant', 'create', true],
+            ['give_accountant', 'read', true],
+            ['give_accountant', 'update', true],
+            ['give_accountant', 'edit', true],
+            ['give_accountant', 'read_private_give_forms', true],
+
+            ['administrator', 'create', true],
+            ['administrator', 'read', true],
+            ['administrator', 'update', true],
+            ['administrator', 'edit', true],
+            ['administrator', 'delete', true],
+
+            // false
+            ['give_accountant', 'delete', false],
+
+            ['give_donor', 'create', false],
+            ['give_donor', 'read', false],
+            ['give_donor', 'update', false],
+            ['give_donor', 'edit', false],
+            ['give_donor', 'delete', false],
+
+            ['give_subscriber', 'create', false],
+            ['give_subscriber', 'read', false],
+            ['give_subscriber', 'update', false],
+            ['give_subscriber', 'edit', false],
+            ['give_subscriber', 'delete', false],
+
+            ['subscriber', 'create', false],
+            ['subscriber', 'read', false],
+            ['subscriber', 'update', false],
+            ['subscriber', 'edit', false],
+            ['subscriber', 'delete', false],
+        ];
+    }
+}