optimized Enum::detectConstants()

Author: marc-mabe

.travis.yml

@@ -49,9 +49,9 @@ install:
 
 script:
   - if [ "$CODE_COVERAGE" == "1" ]; then
-      php vendor/bin/phpunit --verbose --coverage-text --coverage-clover=coverage.clover;
+      php -d 'zend.assertions=1' vendor/bin/phpunit --verbose --coverage-text --coverage-clover=coverage.clover;
     else
-      php vendor/bin/phpunit --verbose;
+      php -d 'zend.assertions=1' vendor/bin/phpunit --verbose;
     fi
 
 after_script:

bench/bootstrap.php

@@ -0,0 +1,11 @@
+<?php
+
+$zendassertions = ini_get('zend.assertions');
+if ($zendassertions != -1) {
+    die(
+        'Please disable zend.assertions in php.ini (zend.assertions = -1)' . PHP_EOL .
+        "Current ini setting: zend.assertions = {$zendassertions}]"
+    );
+}
+
+require_once __DIR__ . '/../vendor/autoload.php';

phpbench.json

@@ -1,5 +1,5 @@
 {
-  "bootstrap": "vendor/autoload.php",
+  "bootstrap": "bench/bootstrap.php",
   "path": "bench/",
   "retry_threshold": 5
 }

phpunit.xml.dist

@@ -21,4 +21,8 @@
             <directory suffix=".php">./src</directory>
         </whitelist>
     </filter>
+    <php>
+        <ini name="zend.assertions" value="1"/>
+        <ini name="assert.exception" value="1"/>
+    </php>
 </phpunit>

src/Enum.php

@@ -2,6 +2,7 @@
 
 namespace MabeEnum;
 
+use AssertionError;
 use ReflectionClass;
 use InvalidArgumentException;
 use LogicException;
@@ -337,7 +338,7 @@ final public static function has($value)
      *
      * @param string $class
      * @return array
-     * @throws LogicException On ambiguous constant values
+     * @throws AssertionError On ambiguous constant values
      */
     private static function detectConstants($class)
     {
@@ -347,7 +348,7 @@ private static function detectConstants($class)
 
             do {
                 $scopeConstants = [];
-                if (PHP_VERSION_ID >= 70100) {
+                if (\PHP_VERSION_ID >= 70100) {
                     // Since PHP-7.1 visibility modifiers are allowed for class constants
                     // for enumerations we are only interested in public once.
                     foreach ($reflection->getReflectionConstants() as $reflConstant) {
@@ -363,30 +364,34 @@ private static function detectConstants($class)
                 $constants = $scopeConstants + $constants;
             } while (($reflection = $reflection->getParentClass()) && $reflection->name !== __CLASS__);
 
-            // Detect ambiguous values and report names
-            $ambiguous = [];
-            foreach ($constants as $value) {
-                $names = \array_keys($constants, $value, true);
-                if (\count($names) > 1) {
-                    $ambiguous[\var_export($value, true)] = $names;
-                }
-            }
-            if (!empty($ambiguous)) {
-                throw new LogicException(
-                    'All possible values needs to be unique. The following are ambiguous: '
-                    . \implode(', ', \array_map(function ($names) use ($constants) {
-                        return \implode('/', $names) . '=' . \var_export($constants[$names[0]], true);
-                    }, $ambiguous))
-                );
-            }
-
             self::$constants[$class] = $constants;
             self::$names[$class] = \array_keys($constants);
+
+            assert('self::assertNonAmbiguous($class)');
         }
 
         return self::$constants[$class];
     }
 
+    /**
+     * Assert that the given enumeration class doesn't define ambiguous enumerator values
+     * @param string $class
+     * @return bool
+     */
+    private static function assertNonAmbiguous($class)
+    {
+        $constants = self::$constants[$class];
+        $ambiguous = [];
+        foreach ($constants as $value) {
+            $names = \array_keys($constants, $value, true);
+            if (\count($names) > 1) {
+                $ambiguous[\var_export($value, true)] = $names;
+            }
+        }
+
+        return empty($ambiguous);
+    }
+
     /**
      * Get an enumerator instance by the given name.
      *

tests/MabeEnumTest/EnumTest.php

@@ -2,6 +2,8 @@
 
 namespace MabeEnumTest;
 
+use AssertionError;
+use Exception;
 use InvalidArgumentException;
 use LogicException;
 use MabeEnum\Enum;
@@ -274,15 +276,57 @@ public function testInstantiateUsingMagicMethod()
         $this->assertSame(EnumInheritance::ONE, $enum->getValue());
     }
 
-    public function testAmbiguousConstantsThrowsLogicException()
+    public function testEnabledAssertAmbiguousEnumeratorValues()
     {
-        $this->expectException(LogicException::class);
+        assert_options(ASSERT_ACTIVE, 1);
+        assert_options(ASSERT_WARNING, 1);
+        assert_options(ASSERT_BAIL, 0);
+        assert_options(ASSERT_QUIET_EVAL, 0);
+        if (\PHP_VERSION_ID >= 70000) {
+            $this->expectException(AssertionError::class);
+        } elseif (defined('HHVM_VERSION')) {
+            // assertion error thrown on HHVM is buggy
+            $this->expectException(Exception::class);
+        }
+
         EnumAmbiguous::get('unknown');
     }
 
-    public function testExtendedAmbiguousCanstantsThrowsLogicException()
+    public function testDisabledAssertAmbiguousEnumeratorValues()
     {
-        $this->expectException(LogicException::class);
+        assert_options(ASSERT_ACTIVE, 0);
+        assert_options(ASSERT_WARNING, 1);
+        assert_options(ASSERT_BAIL, 0);
+        assert_options(ASSERT_QUIET_EVAL, 0);
+        $this->expectException(InvalidArgumentException::class);
+
+        EnumAmbiguous::get('unknown');
+    }
+
+    public function testExtendedEnabledAssertAmbiguousEnumeratorValues()
+    {
+        assert_options(ASSERT_ACTIVE, 1);
+        assert_options(ASSERT_WARNING, 1);
+        assert_options(ASSERT_BAIL, 0);
+        assert_options(ASSERT_QUIET_EVAL, 0);
+        if (\PHP_VERSION_ID >= 70000) {
+            $this->expectException(AssertionError::class);
+        } elseif (defined('HHVM_VERSION')) {
+            // assertion error thrown on HHVM is buggy
+            $this->expectException(Exception::class);
+        }
+
+        EnumExtendedAmbiguous::get('unknown');
+    }
+
+    public function testExtendedDisabledAssertAmbiguousEnumeratorValues()
+    {
+        assert_options(ASSERT_ACTIVE, 0);
+        assert_options(ASSERT_WARNING, 1);
+        assert_options(ASSERT_BAIL, 0);
+        assert_options(ASSERT_QUIET_EVAL, 0);
+        $this->expectException(InvalidArgumentException::class);
+
         EnumExtendedAmbiguous::get('unknown');
     }
 

tests/bootstrap.php

@@ -1,6 +1,11 @@
 <?php
 
-ini_set('error_reporting', E_ALL);
+// assert(): Calling assert() with a string argument is deprecated
+if (PHP_VERSION_ID >= 70200) {
+    ini_set('error_reporting', E_ALL ^ E_DEPRECATED);
+} else {
+    ini_set('error_reporting', E_ALL);
+}
 
 // installed itself
 if (file_exists(__DIR__ . '/../vendor/autoload.php')) {