chore: 🧹 static analysis and redundant <8.1 code

.github/workflows/static-analysis.yaml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       matrix:
         php:
-            - '8.3'
+            - '8.4'
     steps:
       - uses: 'actions/checkout@v2'
       - uses: 'shivammathur/setup-php@v2'

.github/workflows/testing.yaml

@@ -19,6 +19,7 @@ jobs:
           - '8.1'
           - '8.2'
           - '8.3'
+          - '8.4'
     steps:
       - uses: 'actions/checkout@v2'
       - uses: 'shivammathur/setup-php@v2'
@@ -34,6 +35,7 @@ jobs:
           - '8.1'
           - '8.2'
           - '8.3'
+          - '8.4'
     steps:
       - uses: 'actions/checkout@v2'
       - uses: 'shivammathur/setup-php@v2'
@@ -42,4 +44,4 @@ jobs:
       - uses: 'ramsey/composer-install@v2'
         with:
           dependency-versions: 'highest'
-      - run: './vendor/bin/phpunit --bootstrap="tests/bootstrap.php" --test-suffix="Test.php" tests'
+      - run: './vendor/bin/phpunit --bootstrap="vendor/autoload.php" --test-suffix="Test.php" tests'

README.md

@@ -6,14 +6,17 @@ Please refer to the [`darsyn/ip`][ip] project for complete documentation.
 
 ## Compatibility
 
-This library has extensive test coverage using PHPUnit on PHP versions: `8.1`, `8.2`, and `8.3`.
+This library has extensive test coverage using PHPUnit on PHP versions: `8.1`,
+`8.2`, `8.3` and `8.4`.
 
-Static analysis is performed with PHPStan at `max` level on PHP `8.3`, using
+Static analysis is performed with PHPStan at `max` level on PHP `8.4`, using
 core, bleeding edge, and deprecation rules.
 
-The Doctrine features are compatible with Doctrine DBAL `^4`. Types
-are provided for `Ipv4`, `IPv6`, and `Multi` IP types from the parent
+Types are provided for `Ipv4`, `IPv6`, and `Multi` IP types from the parent
 [`darsyn/ip`][ip] project.
+- Versions `5.*.*` are for Doctrine DBAL `^2.3 || ^3.0` compatibility (PHP `5.6`
+  and greater).
+- Versions `6.*.*` are for Doctrine DBAL `^4` (PHP `8.1` and greater).
 
 ## Code of Conduct
 

phpstan.neon

@@ -2,7 +2,6 @@ parameters:
     level: 'max'
     paths: [ 'src', 'tests' ]
     checkFunctionNameCase: true
-    checkGenericClassInNonGenericObjectType: true
     reportUnmatchedIgnoredErrors: true
     treatPhpDocTypesAsCertain: false
     parallel:

src/AbstractType.php

@@ -20,21 +20,19 @@
 abstract class AbstractType extends Type
 {
     const NAME = 'ip';
+    /** @var int */
     const IP_LENGTH = 16;
 
     /**
      * @psalm-return class-string
-     * @return string
      */
-    abstract protected function getIpClass();
+    abstract protected function getIpClass(): string;
 
     /**
-     * @param string $ip
      * @throws \Darsyn\IP\Exception\InvalidIpAddressException
      * @throws \Darsyn\IP\Exception\WrongVersionException
-     * @return \Darsyn\IP\IpInterface
      */
-    abstract protected function createIpObject($ip);
+    abstract protected function createIpObject(string $ip): IpInterface;
 
     /**
      * {@inheritdoc}
@@ -50,7 +48,7 @@ public function getSQLDeclaration(array $column, AbstractPlatform $platform): st
      * @throws \Doctrine\DBAL\Types\ConversionException
      * @return \Darsyn\IP\IpInterface|null
      */
-    public function convertToPHPValue($value, AbstractPlatform $platform): mixed
+    public function convertToPHPValue(mixed $value, AbstractPlatform $platform): mixed
     {
         /** @var string|resource|\Darsyn\IP\IpInterface|null $value */
         // PostgreSQL will return the binary data as a resource instead of a string (like MySQL).
@@ -66,14 +64,16 @@ public function convertToPHPValue($value, AbstractPlatform $platform): mixed
         if (empty($value)) {
             return null;
         }
-        if (\is_object($value) && \is_a($value, $this->getIpClass(), false)) {
-            /** @var \Darsyn\IP\IpInterface $value */
+        if (\is_object($value)) {
+            if (!\is_a($value, $this->getIpClass(), false)) {
+                throw ValueNotConvertible::new($value, $this->getIpClass());
+            }
             return $value;
         }
         try {
             return $this->createIpObject($value);
         } catch (IpException $e) {
-            throw ValueNotConvertible::new($value, static::NAME, null, $e);
+            throw ValueNotConvertible::new($value, $this->getIpClass(), null, $e);
         }
     }
 
@@ -82,7 +82,7 @@ public function convertToPHPValue($value, AbstractPlatform $platform): mixed
      * @throws \Doctrine\DBAL\Types\ConversionException
      * @return string|null
      */
-    public function convertToDatabaseValue($value, AbstractPlatform $platform): mixed
+    public function convertToDatabaseValue(mixed $value, AbstractPlatform $platform): mixed
     {
         if (empty($value)) {
             return null;
@@ -124,15 +124,6 @@ public function convertToDatabaseValue($value, AbstractPlatform $platform): mixe
         return $value->getBinary();
     }
 
-    /**
-     * {@inheritdoc}
-     * @return string
-     */
-    public function getName()
-    {
-        return self::NAME;
-    }
-
     /**
      * {@inheritdoc}
      * @return ParameterType
@@ -141,13 +132,4 @@ public function getBindingType(): ParameterType
     {
         return ParameterType::LARGE_OBJECT;
     }
-
-    /**
-     * {@inheritdoc}
-     * @return bool
-     */
-    public function requiresSQLCommentHint(AbstractPlatform $platform)
-    {
-        return true;
-    }
 }

src/IPv4Type.php

@@ -2,6 +2,7 @@
 
 namespace Darsyn\IP\Doctrine;
 
+use Darsyn\IP\IpInterface;
 use Darsyn\IP\Version\IPv4 as IP;
 
 /**
@@ -14,15 +15,15 @@ class IPv4Type extends AbstractType
     /**
      * {@inheritDoc}
      */
-    protected function getIpClass()
+    protected function getIpClass(): string
     {
         return IP::class;
     }
 
     /**
      * {@inheritDoc}
      */
-    protected function createIpObject($ip)
+    protected function createIpObject(string $ip): IpInterface
     {
         return IP::factory($ip);
     }

src/IPv6Type.php

@@ -2,6 +2,7 @@
 
 namespace Darsyn\IP\Doctrine;
 
+use Darsyn\IP\IpInterface;
 use Darsyn\IP\Version\IPv6 as IP;
 
 /**
@@ -12,15 +13,15 @@ class IPv6Type extends AbstractType
     /**
      * {@inheritDoc}
      */
-    protected function getIpClass()
+    protected function getIpClass(): string
     {
         return IP::class;
     }
 
     /**
      * {@inheritDoc}
      */
-    protected function createIpObject($ip)
+    protected function createIpObject(string $ip): IpInterface
     {
         return IP::factory($ip);
     }

src/MultiType.php

@@ -2,6 +2,7 @@
 
 namespace Darsyn\IP\Doctrine;
 
+use Darsyn\IP\IpInterface;
 use Darsyn\IP\Version\Multi as IP;
 
 /**
@@ -12,15 +13,15 @@ class MultiType extends AbstractType
     /**
      * {@inheritDoc}
      */
-    protected function getIpClass()
+    protected function getIpClass(): string
     {
         return IP::class;
     }
 
     /**
      * {@inheritDoc}
      */
-    protected function createIpObject($ip)
+    protected function createIpObject(string $ip): IpInterface
     {
         return IP::factory($ip);
     }