Merge pull request #151 from fre5h/feature-refactoring-exceptios

fre5h · web-flow · commit 6191c3e2659b · 2019-09-12T15:42:59.000+03:00
Refactoring exceptions
diff --git a/Exception/Constant/ConstantIsFoundInFewRegisteredEnumTypesException.php b/Exception/Constant/ConstantIsFoundInFewRegisteredEnumTypesException.php
@@ -12,11 +12,13 @@
 
 namespace Fresh\DoctrineEnumBundle\Exception\Constant;
 
+use Fresh\DoctrineEnumBundle\Exception\LogicException;
+
 /**
  * ConstantIsFoundInFewRegisteredEnumTypesException.
  *
  * @author Artem Henvald <genvaldartem@gmail.com>
  */
-class ConstantIsFoundInFewRegisteredEnumTypesException extends \LogicException
+class ConstantIsFoundInFewRegisteredEnumTypesException extends LogicException
 {
 }
diff --git a/Exception/Constant/ConstantIsNotFoundInAnyRegisteredEnumTypeException.php b/Exception/Constant/ConstantIsNotFoundInAnyRegisteredEnumTypeException.php
@@ -12,11 +12,13 @@
 
 namespace Fresh\DoctrineEnumBundle\Exception\Constant;
 
+use Fresh\DoctrineEnumBundle\Exception\LogicException;
+
 /**
  * ConstantIsNotFoundInAnyRegisteredEnumTypeException.
  *
  * @author Artem Henvald <genvaldartem@gmail.com>
  */
-class ConstantIsNotFoundInAnyRegisteredEnumTypeException extends \LogicException
+class ConstantIsNotFoundInAnyRegisteredEnumTypeException extends LogicException
 {
 }
diff --git a/Exception/EnumType/NoRegisteredEnumTypesException.php b/Exception/EnumType/NoRegisteredEnumTypesException.php
@@ -12,11 +12,13 @@
 
 namespace Fresh\DoctrineEnumBundle\Exception\EnumType;
 
+use Fresh\DoctrineEnumBundle\Exception\LogicException;
+
 /**
  * NoRegisteredEnumTypesException.
  *
  * @author Artem Henvald <genvaldartem@gmail.com>
  */
-class NoRegisteredEnumTypesException extends \LogicException
+class NoRegisteredEnumTypesException extends LogicException
 {
 }
diff --git a/Exception/EnumValue/ValueIsFoundInFewRegisteredEnumTypesException.php b/Exception/EnumValue/ValueIsFoundInFewRegisteredEnumTypesException.php
@@ -12,11 +12,13 @@
 
 namespace Fresh\DoctrineEnumBundle\Exception\EnumValue;
 
+use Fresh\DoctrineEnumBundle\Exception\LogicException;
+
 /**
  * ValueIsFoundInFewRegisteredEnumTypesException.
  *
  * @author Artem Henvald <genvaldartem@gmail.com>
  */
-class ValueIsFoundInFewRegisteredEnumTypesException extends \LogicException
+class ValueIsFoundInFewRegisteredEnumTypesException extends LogicException
 {
 }
diff --git a/Exception/EnumValue/ValueIsNotFoundInAnyRegisteredEnumTypeException.php b/Exception/EnumValue/ValueIsNotFoundInAnyRegisteredEnumTypeException.php
@@ -12,11 +12,13 @@
 
 namespace Fresh\DoctrineEnumBundle\Exception\EnumValue;
 
+use Fresh\DoctrineEnumBundle\Exception\LogicException;
+
 /**
  * ValueIsNotFoundInAnyRegisteredEnumTypeException.
  *
  * @author Artem Henvald <genvaldartem@gmail.com>
  */
-class ValueIsNotFoundInAnyRegisteredEnumTypeException extends \LogicException
+class ValueIsNotFoundInAnyRegisteredEnumTypeException extends LogicException
 {
 }
diff --git a/Exception/InvalidArgumentException.php b/Exception/InvalidArgumentException.php
@@ -0,0 +1,22 @@
+<?php
+/*
+ * This file is part of the FreshDoctrineEnumBundle.
+ *
+ * (c) Artem Henvald <genvaldartem@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Fresh\DoctrineEnumBundle\Exception;
+
+/**
+ * InvalidArgumentException.
+ *
+ * @author Artem Henvald <genvaldartem@gmail.com>
+ */
+class InvalidArgumentException extends \InvalidArgumentException
+{
+}
diff --git a/Exception/LogicException.php b/Exception/LogicException.php
@@ -0,0 +1,22 @@
+<?php
+/*
+ * This file is part of the FreshDoctrineEnumBundle.
+ *
+ * (c) Artem Henvald <genvaldartem@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Fresh\DoctrineEnumBundle\Exception;
+
+/**
+ * LogicException.
+ *
+ * @author Artem Henvald <genvaldartem@gmail.com>
+ */
+class LogicException extends \LogicException
+{
+}
diff --git a/Exception/RuntimeException.php b/Exception/RuntimeException.php
@@ -0,0 +1,22 @@
+<?php
+/*
+ * This file is part of the FreshDoctrineEnumBundle.
+ *
+ * (c) Artem Henvald <genvaldartem@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Fresh\DoctrineEnumBundle\Exception;
+
+/**
+ * RuntimeException.
+ *
+ * @author Artem Henvald <genvaldartem@gmail.com>
+ */
+class RuntimeException extends \LogicException
+{
+}
diff --git a/FreshDoctrineEnumBundle.php b/FreshDoctrineEnumBundle.php
@@ -11,6 +11,7 @@
 namespace Fresh\DoctrineEnumBundle;
 
 use Doctrine\Common\Persistence\ConnectionRegistry;
+use Fresh\DoctrineEnumBundle\Exception\InvalidArgumentException;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
@@ -24,7 +25,7 @@ class FreshDoctrineEnumBundle extends Bundle
     /**
      * {@inheritdoc}
      *
-     * @throws \InvalidArgumentException
+     * @throws InvalidArgumentException
      * @throws \Doctrine\DBAL\DBALException
      * @throws \Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException
      * @throws \Symfony\Component\DependencyInjection\Exception\ServiceCircularReferenceException
@@ -35,7 +36,7 @@ public function boot(): void
 
         $doctrine = $this->container->get('doctrine', ContainerInterface::NULL_ON_INVALID_REFERENCE);
         if (!$doctrine instanceof ConnectionRegistry) {
-            throw new \InvalidArgumentException('Service "doctrine" is missed in container');
+            throw new InvalidArgumentException('Service "doctrine" is missed in container');
         }
 
         /** @var \Doctrine\DBAL\Connection $connection */
diff --git a/README.md b/README.md
@@ -21,13 +21,13 @@ Provides support of **ENUM type** for Doctrine in Symfony applications.
 
 ## Installation
 
-```composer req fresh/doctrine-enum-bundle='~6.2'```
+```composer req fresh/doctrine-enum-bundle='~6.5'```
 
 ##### Choose the version you need
 
 | Bundle Version (X.Y.Z) | PHP              | Symfony          | Doctrine DBAL | Comment             |
 |:----------------------:|:----------------:|:----------------:|:-------------:|:--------------------|
-| `6.4.*`                | `>= 7.1.3`       | `>= 4.3        ` | `>= 2.6`      | **Current version** |
+| `6.5.*`                | `>= 7.1.3`       | `>= 4.3        ` | `>= 2.6`      | **Current version** |
 | `6.3.*`                | `>= 7.1.3`       | `>= 4.0, <= 4.2` | `>= 2.6`      | *Bug fix support*   |
 
 #### Check the `config/bundles.php` file
diff --git a/Tests/FreshDoctrineEnumBundleTest.php b/Tests/FreshDoctrineEnumBundleTest.php
@@ -15,6 +15,7 @@
 use Doctrine\Common\Persistence\ManagerRegistry;
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Fresh\DoctrineEnumBundle\Exception\InvalidArgumentException;
 use Fresh\DoctrineEnumBundle\FreshDoctrineEnumBundle;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
@@ -175,7 +176,7 @@ public function testMissedDoctrine(): void
             ->willReturn(null)
         ;
 
-        $this->expectException(\InvalidArgumentException::class);
+        $this->expectException(InvalidArgumentException::class);
         $this->expectExceptionMessage('Service "doctrine" is missed in container');
 
         $bundle = new FreshDoctrineEnumBundle();
diff --git a/Tests/Twig/Extension/EnumValuesAsArrayExtensionTest.php b/Tests/Twig/Extension/EnumValuesAsArrayExtensionTest.php
@@ -14,6 +14,7 @@
 
 use Fresh\DoctrineEnumBundle\Exception\EnumType\EnumTypeIsNotRegisteredException;
 use Fresh\DoctrineEnumBundle\Exception\EnumType\NoRegisteredEnumTypesException;
+use Fresh\DoctrineEnumBundle\Exception\LogicException;
 use Fresh\DoctrineEnumBundle\Tests\Fixtures\DBAL\Types\BasketballPositionType;
 use Fresh\DoctrineEnumBundle\Twig\Extension\EnumValuesAsArrayTwigExtension;
 use PHPUnit\Framework\TestCase;
@@ -95,7 +96,7 @@ public function testInvalidCallable(): void
         $property->setValue($extension, ['invalid_callable' => 'dummy']);
         $property->setAccessible(false);
 
-        $this->expectException(\LogicException::class);
+        $this->expectException(LogicException::class);
         $this->expectExceptionMessage('dummy::getReadableValues is not a valid exception');
 
         $extension->getReadableEnumValuesAsArray('invalid_callable');
diff --git a/Tests/Validator/EnumValidatorTest.php b/Tests/Validator/EnumValidatorTest.php
@@ -12,6 +12,7 @@
 
 namespace Fresh\DoctrineEnumBundle\Tests\Validator;
 
+use Fresh\DoctrineEnumBundle\Exception\RuntimeException;
 use Fresh\DoctrineEnumBundle\Tests\Fixtures\DBAL\Types\BasketballPositionType;
 use Fresh\DoctrineEnumBundle\Validator\Constraints\Enum;
 use Fresh\DoctrineEnumBundle\Validator\Constraints\EnumValidator;
@@ -47,7 +48,7 @@ protected function tearDown(): void
 
     public function testValidateIncorrectConstraintClass(): void
     {
-        $this->expectException(\RuntimeException::class);
+        $this->expectException(RuntimeException::class);
         $this->expectExceptionMessageRegExp('/^Object of class .* is not instance of .*$/');
 
         $this->enumValidator->validate(BasketballPositionType::POINT_GUARD, new DummyConstraint());
diff --git a/Twig/Extension/EnumValuesAsArrayTwigExtension.php b/Twig/Extension/EnumValuesAsArrayTwigExtension.php
@@ -14,6 +14,7 @@
 
 use Fresh\DoctrineEnumBundle\Exception\EnumType\EnumTypeIsNotRegisteredException;
 use Fresh\DoctrineEnumBundle\Exception\EnumType\NoRegisteredEnumTypesException;
+use Fresh\DoctrineEnumBundle\Exception\LogicException;
 use Twig\TwigFunction;
 
 /**
@@ -64,6 +65,7 @@ public function getReadableEnumValuesAsArray(string $enumType): array
      * @param string $enumType
      * @param string $staticMethodName
      *
+     * @throws LogicException
      * @throws EnumTypeIsNotRegisteredException
      * @throws NoRegisteredEnumTypesException
      *
@@ -77,7 +79,7 @@ private function callEnumTypeStaticMethod(string $enumType, string $staticMethod
             $function = [$this->registeredEnumTypes[$enumType], $staticMethodName];
 
             if (!\is_callable($function)) {
-                throw new \LogicException(\sprintf('%s::%s is not a valid exception', $this->registeredEnumTypes[$enumType], $staticMethodName));
+                throw new LogicException(\sprintf('%s::%s is not a valid exception', $this->registeredEnumTypes[$enumType], $staticMethodName));
             }
 
             return $function();
diff --git a/Validator/Constraints/EnumValidator.php b/Validator/Constraints/EnumValidator.php
@@ -10,6 +10,7 @@
 
 namespace Fresh\DoctrineEnumBundle\Validator\Constraints;
 
+use Fresh\DoctrineEnumBundle\Exception\RuntimeException;
 use Symfony\Component\Validator\Constraint;
 use Symfony\Component\Validator\Constraints\ChoiceValidator;
 use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
@@ -25,13 +26,13 @@ class EnumValidator extends ChoiceValidator
      * @param mixed           $value
      * @param Constraint|Enum $constraint
      *
-     * @throws \RuntimeException
+     * @throws RuntimeException
      * @throws ConstraintDefinitionException
      */
     public function validate($value, Constraint $constraint): void
     {
         if (!$constraint instanceof Enum) {
-            throw new \RuntimeException(\sprintf('Object of class %s is not instance of %s', \get_class($constraint), Enum::class));
+            throw new RuntimeException(\sprintf('Object of class %s is not instance of %s', \get_class($constraint), Enum::class));
         }
 
         if (!$constraint->entity) {

Original file line number	Diff line number	Diff line change
`@@ -12,11 +12,13 @@`
`12`	`12`
`13`	`13`	`namespace Fresh\DoctrineEnumBundle\Exception\Constant;`
`14`	`14`
	`15`	`+use Fresh\DoctrineEnumBundle\Exception\LogicException;`
	`16`	`+`
`15`	`17`	`/**`
`16`	`18`	`* ConstantIsFoundInFewRegisteredEnumTypesException.`
`17`	`19`	`*`
`18`	`20`	`* @author Artem Henvald <genvaldartem@gmail.com>`
`19`	`21`	`*/`
`20`		`-class ConstantIsFoundInFewRegisteredEnumTypesException extends \LogicException`
	`22`	`+class ConstantIsFoundInFewRegisteredEnumTypesException extends LogicException`
`21`	`23`	`{`
`22`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`
`15`	`15`	`use Fresh\DoctrineEnumBundle\Exception\EnumType\EnumTypeIsNotRegisteredException;`
`16`	`16`	`use Fresh\DoctrineEnumBundle\Exception\EnumType\NoRegisteredEnumTypesException;`
	`17`	`+use Fresh\DoctrineEnumBundle\Exception\LogicException;`
`17`	`18`	`use Twig\TwigFunction;`
`18`	`19`
`19`	`20`	`/**`
`@@ -64,6 +65,7 @@ public function getReadableEnumValuesAsArray(string $enumType): array`
`64`	`65`	`* @param string $enumType`
`65`	`66`	`* @param string $staticMethodName`
`66`	`67`	`*`
	`68`	`+ * @throws LogicException`
`67`	`69`	`* @throws EnumTypeIsNotRegisteredException`
`68`	`70`	`* @throws NoRegisteredEnumTypesException`
`69`	`71`	`*`
`@@ -77,7 +79,7 @@ private function callEnumTypeStaticMethod(string $enumType, string $staticMethod`
`77`	`79`	`$function = [$this->registeredEnumTypes[$enumType], $staticMethodName];`
`78`	`80`
`79`	`81`	`if (!\is_callable($function)) {`
`80`		`- throw new \LogicException(\sprintf('%s::%s is not a valid exception', $this->registeredEnumTypes[$enumType], $staticMethodName));`
	`82`	`+ throw new LogicException(\sprintf('%s::%s is not a valid exception', $this->registeredEnumTypes[$enumType], $staticMethodName));`
`81`	`83`	`}`
`82`	`84`
`83`	`85`	`return $function();`