Merge pull request #4 from sourceboat/feature/2_is_helper

Add `is(EnumValue)` and `is<EnumValue>()` helper to enums

Author: Kevin Buchholz

README.md

@@ -127,6 +127,25 @@ Returns the localized version of the value, default path is `enums.<EnumClass>.<
 UserType::SuperAdministrator()->localized(); // Returns for example 'Super Administrator', but `enums.App\Enums\UserType.3` when not set.
 ```
 
+### is(static): bool
+
+Check if the instance is equal to the given member.
+
+``` php
+UserType::SuperAdministrator()->is(UserType::Moderator()); // -> false
+UserType::SuperAdministrator()->is(UserType::SuperAdministrator()); // -> true
+```
+
+### is<Enum_Value>(): bool
+
+Check if the instance is equal to the member indicated by the method name.
+
+``` php
+UserType::SuperAdministrator()->isModerator(); // -> false
+UserType::SuperAdministrator()->isSuperAdministrator(); // -> true
+UserType::SuperAdministrator()->isStudent(); // -> throws Eloquent\Enumeration\Exception\UndefinedMemberException
+```
+
 ### static randomMember(): static
 
 Returns a random member from the enum. Useful for factories.

composer.json

@@ -50,7 +50,8 @@
         "test": "vendor/bin/phpunit",
         "test-coverage": "vendor/bin/phpunit --coverage-html coverage",
         "lint:phpcs": "vendor/bin/phpcs -s",
-        "lint:phpmd": "vendor/bin/phpmd src,tests text phpmd.xml"
+        "lint:phpmd": "vendor/bin/phpmd src,tests text phpmd.xml",
+        "fix": "vendor/bin/phpcbf"
     },
     "extra": {
         "branch-alias": {

resources/stubs/Enumeration.stub

@@ -5,9 +5,12 @@ namespace DummyNamespace;
 use Sourceboat\Enumeration\Enumeration;
 
 /**
- * @method static \DummyNamespace\DummyClass OptionOne()
- * @method static \DummyNamespace\DummyClass OptionTwo()
- * @method static \DummyNamespace\DummyClass OptionThree()
+ * @method static self OptionOne()
+ * @method static self OptionTwo()
+ * @method static self OptionThree()
+ * @method bool isOptionOne()
+ * @method bool isOptionTwo()
+ * @method bool isOptionThree()
  */
 final class DummyClass extends Enumeration
 {

src/Enumeration.php

@@ -3,6 +3,7 @@
 namespace Sourceboat\Enumeration;
 
 use Eloquent\Enumeration\AbstractEnumeration;
+use Illuminate\Support\Str;
 use Sourceboat\Enumeration\Rules\EnumerationValue;
 
 /**
@@ -39,6 +40,17 @@ public function localized(): string
         return trans(static::getLocalizationPath() . '.' . $this->value());
     }
 
+    /**
+     * Check if this instance equals to a specific member of the enum.
+     *
+     * @param static $value The member to check for
+     * @return bool
+     */
+    public function is($value): bool
+    {
+        return $this === $value;
+    }
+
     /**
      * Get all values in this enumeration.
      *
@@ -168,10 +180,25 @@ public static function defaultMember()
      * Returns a string representation of this member.
      *
      * @return string The string representation.
-     * @phpcsSuppress SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingReturnTypeHint
      */
-    public function __toString()
+    public function __toString(): string
     {
         return (string) $this->value();
     }
+
+    /**
+     * Implements `is<EnumKey>` methods for the enum.
+     *
+     * @param string $method
+     * @param array $arguments
+     * @return mixed
+     * @phpcsSuppress SlevomatCodingStandard.TypeHints.TypeHintDeclaration.MissingParameterTypeHint
+     */
+    public function __call($method, $arguments)
+    {
+        if (Str::startsWith($method, 'is')) {
+            $key = Str::after($method, 'is');
+            return $this->is(static::memberByKey($key, false));
+        }
+    }
 }

tests/FruitType.php

@@ -5,10 +5,14 @@
 use Sourceboat\Enumeration\Enumeration;
 
 /**
- * @method static \Sourceboat\Enumeration\Tests\FruitType BERRY()
- * @method static \Sourceboat\Enumeration\Tests\FruitType NUT()
- * @method static \Sourceboat\Enumeration\Tests\FruitType ACCESSORY_FRUIT()
- * @method static \Sourceboat\Enumeration\Tests\FruitType LEGUME()
+ * @method static self BERRY()
+ * @method static self NUT()
+ * @method static self ACCESSORY_FRUIT()
+ * @method static self LEGUME()
+ * @method bool isBerry()
+ * @method bool isNut()
+ * @method bool isAccessory_Fruit()
+ * @method bool isLegume()
  */
 class FruitType extends Enumeration
 {

tests/UserRole.php

@@ -5,10 +5,14 @@
 use Sourceboat\Enumeration\Enumeration;
 
 /**
- * @method static \Sourceboat\Enumeration\Tests\UserRole MODERATOR()
- * @method static \Sourceboat\Enumeration\Tests\UserRole ADMIN()
- * @method static \Sourceboat\Enumeration\Tests\UserRole SUPER_ADMIN()
- * @method static \Sourceboat\Enumeration\Tests\UserRole USER()
+ * @method static self MODERATOR()
+ * @method static self ADMIN()
+ * @method static self SUPER_ADMIN()
+ * @method static self USER()
+ * @method bool isModerator()
+ * @method bool isAdmin()
+ * @method bool isSuper_Admin()
+ * @method bool isUser()
  */
 class UserRole extends Enumeration
 {

tests/unit/IsEnumKeyTest.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace Sourceboat\Enumeration\Tests;
+
+class IsEnumKeyTest extends TestCase
+{
+    /**
+     * Data provider for the test `testIsEnumKey`.
+     *
+     * @return array
+     */
+    public function dataProvider(): array
+    {
+        return [
+            [ UserRole::USER(), 'isUser', true ],
+            [ UserRole::USER(), 'isUSER', true ],
+            [ UserRole::USER(), 'isuser', true ],
+            [ UserRole::USER(), 'isUSer', true ],
+            [ UserRole::MODERATOR(), 'isUser', false ],
+        ];
+    }
+
+    /**
+     * Test functionality of is<EnumKey> helper.
+     *
+     * @dataProvider dataProvider
+     * @param \Sourceboat\Enumeration\Tests\UserRole $role
+     * @param string $method
+     * @param bool $result
+     * @return void
+     */
+    public function testIsEnumKey(UserRole $role, string $method, bool $result): void
+    {
+        $this->assertEquals($result, $role->{$method}());
+    }
+
+    /**
+     * Test functionality of is<EnumKey> helper.
+     *
+     * @expectedException \Eloquent\Enumeration\Exception\UndefinedMemberException
+     * @return void
+     */
+    public function testIsEnumKeyException(): void
+    {
+        UserRole::USER()->isStudent();
+    }
+}

tests/unit/IsTest.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Sourceboat\Enumeration\Tests;
+
+class IsTest extends TestCase
+{
+    /**
+     * Check that the is helper functions correctly.
+     *
+     * @return void
+     */
+    public function testGetCorrectResults(): void
+    {
+        $this->assertTrue(UserRole::MODERATOR()->is(UserRole::MODERATOR()));
+        $this->assertFalse(UserRole::MODERATOR()->is(UserRole::ADMIN()));
+        $this->assertFalse(UserRole::MODERATOR()->is('moderator'));
+    }
+}