Added EnumMap::isEmpty() as associate of EnumSet::isEmpty()

Author: marc-mabe

README.md

@@ -262,7 +262,7 @@ $enumSet->has(UserStatus::INACTIVE); // bool
 $enumSet->count();
 count($enumSet);
 
-// Tests if it has enumerators
+// test for elements
 $enumSet->isEmpty();
 
 // convert to array
@@ -345,6 +345,8 @@ isset($enumMap[UserStatus::DELETED()]); // false
 $enumMap->count();
 count($enumMap);
 
+// test for elements
+$enumSet->isEmpty();
 
 // support for null aware exists check
 $enumMap[UserStatus::NULL] = null;

src/EnumMap.php

@@ -349,4 +349,14 @@ public function count(): int
     {
         return \count($this->map);
     }
+
+    /**
+     * Tests if the map is empty
+     *
+     * @return bool
+     */
+    public function isEmpty(): bool
+    {
+        return empty($this->map);
+    }
 }

src/EnumSet.php

@@ -48,7 +48,7 @@ class EnumSet implements IteratorAggregate, Countable
      * Defines private method names to be called depended of how the bitset type was set too.
      * ... Integer or binary bitset.
      * ... *Int or *Bin method
-     * 
+     *
      * @var string
      */
     private $fnDoGetIterator       = 'doGetIteratorInt';
@@ -901,6 +901,16 @@ public function isSuperset(EnumSet $other): bool
             && ($this->bitset | $other->bitset) === $this->bitset;
     }
 
+    /**
+     * Tests if the set is empty
+     *
+     * @return bool
+     */
+    public function isEmpty(): bool
+    {
+        return $this->bitset === $this->emptyBitset;
+    }
+
     /**
      * Get ordinal numbers of the defined enumerators as array
      * @return int[]
@@ -1008,7 +1018,7 @@ public function getEnumerators(): array
 
     /**
      * Get binary bitset in little-endian order
-     * 
+     *
      * @return string
      * @uses doGetBinaryBitsetLeBin()
      * @uses doGetBinaryBitsetLeInt()
@@ -1049,7 +1059,7 @@ private function doGetBinaryBitsetLeInt()
 
     /**
      * Get binary bitset in big-endian order
-     * 
+     *
      * @return string
      */
     public function getBinaryBitsetBe(): string
@@ -1094,7 +1104,7 @@ private function doGetBitBin($ordinal)
      * Get a bit at the given ordinal number.
      *
      * This is the integer bitset implementation.
-     * 
+     *
      * @param int $ordinal Ordinal number of bit to get
      * @return bool
      * @see getBit()
@@ -1104,14 +1114,4 @@ private function doGetBitInt($ordinal)
     {
         return (bool)($this->bitset & (1 << $ordinal));
     }
-
-    /**
-     * Return true if the set is empty, false otherwise.
-     *
-     * @return bool
-     */
-    public function isEmpty(): bool
-    {
-        return $this->bitset === $this->emptyBitset;
-    }
 }

tests/MabeEnumTest/EnumMapTest.php

@@ -4,6 +4,7 @@
 
 use InvalidArgumentException;
 use MabeEnum\EnumMap;
+use MabeEnumTest\TestAsset\Enum32;
 use MabeEnumTest\TestAsset\EnumBasic;
 use MabeEnumTest\TestAsset\EnumInheritance;
 use PHPUnit\Framework\TestCase;
@@ -472,6 +473,21 @@ public function testSerializable()
         $this->assertFalse($enumMapCopy->offsetExists(EnumBasic::TWO));
     }
 
+    public function testIsEmpty()
+    {
+        $map1 = new EnumMap(Enum32::class, []);
+        $map2 = new EnumMap(Enum32::class, array_combine(Enum32::getValues(), Enum32::getNames()));
+
+        $this->assertTrue($map1->isEmpty());
+        $this->assertFalse($map2->isEmpty());
+
+        $map1->add(Enum32::ONE(), 'first');
+        $map2->removeIterable(Enum32::getEnumerators());
+
+        $this->assertFalse($map1->isEmpty());
+        $this->assertTrue($map2->isEmpty());
+    }
+
     /* deprecated */
 
     public function testContains()

tests/MabeEnumTest/EnumSetTest.php

@@ -347,7 +347,7 @@ public function testSetBitOutOfRange()
     public function testGetBinaryBitsetLe()
     {
         $set = new EnumSet(Enum65::class);
-        
+
         $enum1 = Enum65::ONE;
         $enum2 = Enum65::TWO;
         $enum3 = Enum65::SIXTYFIVE;
@@ -368,20 +368,20 @@ public function testGetBinaryBitsetLe()
         $set = $set->with($enum4);
         $this->assertSame("\x03\x00\x00\x00\x00\x00\x00\x80\x01", $set->getBinaryBitsetLe());
         $this->assertTrue($set->has($enum4));
-        
+
         $this->assertSame(4, $set->count());
 
         $set = $set->without($enum2);
         $this->assertSame("\x01\x00\x00\x00\x00\x00\x00\x80\x01", $set->getBinaryBitsetLe());
         $this->assertFalse($set->has($enum2));
-        
+
         $this->assertSame(3, $set->count());
     }
 
     public function testGetBinaryBitsetBe()
     {
         $set = new EnumSet(Enum65::class);
-        
+
         $enum1 = Enum65::ONE;
         $enum2 = Enum65::TWO;
         $enum3 = Enum65::SIXTYFIVE;
@@ -402,13 +402,13 @@ public function testGetBinaryBitsetBe()
         $set = $set->with($enum4);
         $this->assertSame("\x01\x80\x00\x00\x00\x00\x00\x00\x03", $set->getBinaryBitsetBe());
         $this->assertTrue($set->has($enum4));
-        
+
         $this->assertSame(4, $set->count());
 
         $set = $set->without($enum2);
         $this->assertSame("\x01\x80\x00\x00\x00\x00\x00\x00\x01", $set->getBinaryBitsetBe());
         $this->assertFalse($set->has($enum2));
-        
+
         $this->assertSame(3, $set->count());
     }
 
@@ -720,6 +720,24 @@ public function testIsSupersetWrongInstance()
         }
     }
 
+    /**
+     * @dataProvider getIntegerEnumerations
+     */
+    public function testIsEmpty($enum)
+    {
+        $set1 = new EnumSet($enum, []);
+        $set2 = new EnumSet($enum, $enum::getValues());
+
+        $this->assertTrue($set1->isEmpty());
+        $this->assertFalse($set2->isEmpty());
+
+        $set1->addIterable($enum::getValues());
+        $set2->removeIterable($enum::getValues());
+
+        $this->assertFalse($set1->isEmpty());
+        $this->assertTrue($set2->isEmpty());
+    }
+
     public function testGetOrdinalsInt()
     {
         $set = new EnumSet(EnumBasic::class);
@@ -904,22 +922,6 @@ public function testSetSymDiffThrowsInvalidArgumentException()
         $set1->setSymDiff($set2);
     }
 
-    /**
-     * @dataProvider getIntegerEnumerations
-     */
-    public function testIsEmpty($enum)
-    {
-        $set1 = new EnumSet($enum, []);
-        $set2 = new EnumSet($enum, $enum::getValues());
-
-        $this->assertTrue($set1->isEmpty());
-        $this->assertFalse($set2->isEmpty());
-
-        $set2->removeIterable($enum::getValues());
-
-        $this->assertTrue($set2->isEmpty());
-    }
-
     /* deprecated */
 
     /** @deprecated */