Merge pull request #64 from marc-mabe/enumset_isequal_issubset_issuperset

EnumSet: added isEqual(), isSubset() and isSuperset()

Author: marc-mabe

src/EnumSet.php

@@ -199,6 +199,47 @@ public function count()
         return $cnt;
     }
 
+    /**
+     * Check if this EnumSet is the same as other
+     * @param EnumSet $other
+     * @return bool
+     */
+    public function isEqual(EnumSet $other)
+    {
+        return $this->getEnumeration() === $other->getEnumeration()
+            && $this->getBinaryBitsetLe() === $other->getBinaryBitsetLe();
+    }
+
+    /**
+     * Check if this EnumSet is a subset of other
+     * @param EnumSet $other
+     * @return bool
+     */
+    public function isSubset(EnumSet $other)
+    {
+        if ($this->getEnumeration() !== $other->getEnumeration()) {
+            return false;
+        }
+
+        $thisBitset = $this->getBinaryBitsetLe();
+        return ($thisBitset & $other->getBinaryBitsetLe()) === $thisBitset;
+    }
+
+    /**
+     * Check if this EnumSet is a superset of other
+     * @param EnumSet $other
+     * @return bool
+     */
+    public function isSuperset(EnumSet $other)
+    {
+        if ($this->getEnumeration() !== $other->getEnumeration()) {
+            return false;
+        }
+
+        $thisBitset = $this->getBinaryBitsetLe();
+        return ($thisBitset | $other->getBinaryBitsetLe()) === $thisBitset;
+    }
+
     /**
      * Get binary bitset in little-endian order
      * 

tests/MabeEnumTest/EnumSetTest.php

@@ -430,4 +430,140 @@ public function testCountingEmptyEnumEmptySet()
         $set = new EnumSet('MabeEnumTest\TestAsset\EmptyEnum');
         $this->assertSame(0, $set->count());
     }
+
+    public function testIsEqual()
+    {
+        $set1 = new EnumSet('MabeEnumTest\TestAsset\EnumBasic');
+        $set2 = new EnumSet('MabeEnumTest\TestAsset\EnumBasic');
+        $this->assertTrue($set1->isEqual($set2));
+
+        foreach (EnumBasic::getEnumerators() as $enumerator) {
+            $set1->attach($enumerator);
+            $this->assertFalse($set1->isEqual($set2));
+
+            $set2->attach($enumerator);
+            $this->assertTrue($set1->isEqual($set2));
+        }
+    }
+
+    public function testIsEqualWrongInstance()
+    {
+        $set1 = new EnumSet('MabeEnumTest\TestAsset\EnumBasic');
+        $set2 = new EnumSet('MabeEnumTest\TestAsset\EnumInheritance');
+        $this->assertFalse($set1->isEqual($set2));
+
+        foreach (EnumBasic::getEnumerators() as $enumerator) {
+            $set1->attach($enumerator);
+            $this->assertFalse($set1->isEqual($set2));
+
+            $set2->attach($enumerator->getValue());
+            $this->assertFalse($set1->isEqual($set2));
+        }
+    }
+
+    /**
+     * if $A->isEqual($B) is true then $A->isSubsetOf($B) is also true
+     */
+    public function testIsSubsetEqual()
+    {
+        $set1 = new EnumSet('MabeEnumTest\TestAsset\Enum32');
+        $set2 = new EnumSet('MabeEnumTest\TestAsset\Enum32');
+        $this->assertTrue($set1->isSubset($set2));
+
+        foreach (Enum32::getEnumerators() as $enumerator) {
+            $set1->attach($enumerator);
+            $set2->attach($enumerator);
+            $this->assertTrue($set1->isSubset($set2));
+        }
+    }
+
+    public function testIsSubsetFull()
+    {
+        $set1 = new EnumSet('MabeEnumTest\TestAsset\Enum32');
+        $set2 = new EnumSet('MabeEnumTest\TestAsset\Enum32');
+
+        foreach (Enum32::getEnumerators() as $enumerator) {
+            $set2->attach($enumerator);
+            $this->assertTrue($set1->isSubset($set2));
+        }
+    }
+
+    public function testIsSubsetFalse()
+    {
+        $set1 = new EnumSet('MabeEnumTest\TestAsset\Enum32');
+        $set2 = new EnumSet('MabeEnumTest\TestAsset\Enum32');
+
+        foreach (Enum32::getEnumerators() as $enumerator) {
+            $set1->attach($enumerator);
+            $this->assertFalse($set1->isSubset($set2));
+        }
+    }
+
+    public function testIsSubsetWrongInstance()
+    {
+        $set1 = new EnumSet('MabeEnumTest\TestAsset\EnumBasic');
+        $set2 = new EnumSet('MabeEnumTest\TestAsset\EnumInheritance');
+        $this->assertFalse($set1->isSubset($set2));
+
+        foreach (EnumBasic::getEnumerators() as $enumerator) {
+            $set1->attach($enumerator);
+            $this->assertFalse($set1->isSubset($set2));
+
+            $set2->attach($enumerator->getValue());
+            $this->assertFalse($set1->isSubset($set2));
+        }
+    }
+
+    /**
+     * if $A->isEqual($B) is true then $A->isSuperset($B) is also true
+     */
+    public function testIsSsetEqual()
+    {
+        $set1 = new EnumSet('MabeEnumTest\TestAsset\Enum32');
+        $set2 = new EnumSet('MabeEnumTest\TestAsset\Enum32');
+        $this->assertTrue($set1->isSuperset($set2));
+
+        foreach (Enum32::getEnumerators() as $enumerator) {
+            $set1->attach($enumerator);
+            $set2->attach($enumerator);
+            $this->assertTrue($set1->isSuperset($set2));
+        }
+    }
+
+    public function testIsSupersetFull()
+    {
+        $set1 = new EnumSet('MabeEnumTest\TestAsset\Enum32');
+        $set2 = new EnumSet('MabeEnumTest\TestAsset\Enum32');
+
+        foreach (Enum32::getEnumerators() as $enumerator) {
+            $set1->attach($enumerator);
+            $this->assertTrue($set1->isSuperset($set2));
+        }
+    }
+
+    public function testIsSupersetFalse()
+    {
+        $set1 = new EnumSet('MabeEnumTest\TestAsset\Enum32');
+        $set2 = new EnumSet('MabeEnumTest\TestAsset\Enum32');
+
+        foreach (Enum32::getEnumerators() as $enumerator) {
+            $set2->attach($enumerator);
+            $this->assertFalse($set1->isSuperset($set2));
+        }
+    }
+
+    public function testIsSupersetWrongInstance()
+    {
+        $set1 = new EnumSet('MabeEnumTest\TestAsset\EnumBasic');
+        $set2 = new EnumSet('MabeEnumTest\TestAsset\EnumInheritance');
+        $this->assertFalse($set1->isSuperset($set2));
+
+        foreach (EnumBasic::getEnumerators() as $enumerator) {
+            $set1->attach($enumerator);
+            $this->assertFalse($set1->isSuperset($set2));
+
+            $set2->attach($enumerator->getValue());
+            $this->assertFalse($set1->isSuperset($set2));
+        }
+    }
 }