Merge pull request #3 from mesour/php8

Support for PHP 8

Author: mesour

.travis.yml

@@ -1,21 +1,13 @@
 language: php
 
 php:
-    - 7.1
-    - 7.2
-    - 7.3
-    - 7.4
     - 8.0
-
-matrix:
-    allow_failures:
-        - php: 8.0
+    - 8.1
 
 install:
     - composer install --no-interaction --prefer-source
 
 script:
     - vendor/bin/parallel-lint src tests
-    - vendor/bin/phpcs --standard=ruleset.xml --extensions=php,phpt --encoding=utf-8 --tab-width=4 -sp src tests
     - vendor/bin/phpstan analyse -l 7 -c phpstan.neon src tests
     - vendor/bin/tester -p php tests/ -s -c tests/php.ini

README.md

@@ -38,8 +38,31 @@ IpAddressNormalizer::compressIpV6('2001:0db8:0800:0000:0000:ff00:0042:8329');
 // result is: 2001:db8:800::ff00:42:8329
 ```
 
-# Tests
+### Usage: `Mesour\IpAddresses\IpAddress`
 
-- Run tests: `bin/check-tests`
-- PHP Stan: `bin/check-stan`
-- Code style: `bin/check-cs`
+Normalize IPv4:
+```php
+$ipAddress = IpAddress::create('127.0.0.1');
+
+$ipAddress->isIpV4(); // result is: true
+$ipAddress->isIpV6(); // result is: false
+$ipAddress->getValue(); // result is: 127.0.0.1
+```
+
+Normalize IPv6:
+
+- Result of `getValue` is compressed IPv6 value
+
+```php
+$ipAddress = IpAddress::create('2001:0db8:0800:0000:0000:ff00:0042:8329');
+
+$ipAddress->isIpV4(); // result is: false
+$ipAddress->isIpV6(); // result is: true
+$ipAddress->getValue(); // result is: 2001:db8:800::ff00:42:8329
+```
+
+# Development
+
+- Syntax check: `vendor/bin/parallel-lint src tests`
+- PHP Stan: `vendor/bin/phpstan analyse -l 7 -c phpstan.neon src tests`
+- Run tests: `vendor/bin/tester -p php tests/ -s -c tests/php.ini`

composer.json

@@ -8,16 +8,14 @@
       "homepage": "http://mesour.com"
   }],
   "require": {
-      "php": ">=7.1"
+      "php": ">=8.0"
   },
   "require-dev": {
       "tracy/tracy": "~2.3.0",
-      "slevomat/coding-standard": "^6.4",
-      "consistence/coding-standard": "^3.10",
-      "phpstan/phpstan": "^0.12.42",
+      "phpstan/phpstan": "^1.8.5",
       "nette/robot-loader": "^2.4",
       "nette/tester": "^2.3",
-      "jakub-onderka/php-parallel-lint": "^1.0"
+      "php-parallel-lint/php-parallel-lint": "^1.3"
   },
   "autoload": {
       "classmap": ["src/"]

phpstan.neon

@@ -1,14 +1,8 @@
 parameters:
-	autoload_directories:
-		- %rootDir%/../../../src
-		- %rootDir%/../../../tests
 
-	excludes_analyse:
+	excludePaths:
 		- %rootDir%/../../../tests/bootstrap.php
 		- %rootDir%/../../../tests/environment.php
 
 	ignoreErrors:
-		- '#Parameter \#1 \$var of function count expects array\|Countable, array<int, string>\|string given\.#'
-		- '#Parameter \#2 \$str of function explode expects string, array<int, string>\|string given\.#'
-		- '#Parameter \#1 \$arr1 of function array_merge expects array, array<int, string>\|string given\.#'
-		- '#Parameter \#2 \.\.\.\$args of function array_merge expects array, array<int, string>\|string given\.#'
+		- '*Parameter #2 $string of function explode expects string, array<int, string>\|string given.*'

src/Mesour/IpAddresses/IpAddress.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Mesour\IpAddresses;
+
+/** @author Matouš Němec <mesour.com> */
+final class IpAddress
+{
+
+	private string $ipAddress;
+
+	private bool $ipV4;
+
+	private function __construct(string $ipAddress, bool $ipV4)
+	{
+		$this->ipAddress = $ipAddress;
+		$this->ipV4 = $ipV4;
+	}
+
+	public static function create(string $ipAddress): self
+	{
+		if (IpAddressValidator::isIpV4($ipAddress)) {
+			return new self($ipAddress, true);
+		} elseif (IpAddressValidator::isIpV6($ipAddress)) {
+			return new self(IpAddressNormalizer::compressIpV6($ipAddress), false);
+		} else {
+			throw new IpAddressIsInvalidException();
+		}
+	}
+
+	public function isIpV4(): bool
+	{
+		return $this->ipV4;
+	}
+
+	public function isIpV6(): bool
+	{
+		return !$this->isIpV4();
+	}
+
+	public function getValue(): string
+	{
+		return $this->ipAddress;
+	}
+
+}

src/Mesour/IpAddresses/IpAddressIsInvalidException.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Mesour\IpAddresses;
+
+/** @author Matouš Němec <mesour.com> */
+final class IpAddressIsInvalidException extends \RuntimeException
+{
+
+}

src/Mesour/IpAddresses/IpAddressNormalizer.php

@@ -10,14 +10,14 @@ abstract class IpAddressNormalizer
 
 	final public static function normalizeIpV6(string $address): string
 	{
-		if (\strpos($address, '::') !== false) {
+		if (\str_contains($address, '::')) {
 			$part = \explode('::', $address);
 			$part[0] = \explode(':', $part[0]);
 			$part[1] = \explode(':', $part[1]);
 			$missing = [];
 
 			for ($i = 0; $i < 8 - (\count($part[0]) + \count($part[1])); $i++) {
-				\array_push($missing, '0000');
+				$missing[] = '0000';
 			}
 
 			$missing = \array_merge($part[0], $missing);
@@ -45,15 +45,15 @@ final public static function normalizeIpV6(string $address): string
 
 	final public static function compressIpV6(string $ip): string
 	{
-		if (\substr($ip, 0, 4) === '0000') {
+		if (\str_starts_with($ip, '0000')) {
 			$ip = \substr_replace($ip, ':0', 0, 4);
 		}
 
 		$ip = \str_replace(':0000', ':0', $ip);
 		$ip = \preg_replace('/:0{1,3}(?=\w)/', ':', $ip);
 		$z = ':0:0:0:0:0:0:0:';
 
-		while (\strpos($ip, '::') === false && \strlen($z) >= 5) {
+		while (!\str_contains($ip, '::') && \strlen($z) >= 5) {
 			$pos = \strpos($ip, $z);
 
 			if ($pos !== false) {

tests/Mesour/IpAddressesTests/IpAddressNormalizerTest.phpt

@@ -10,7 +10,10 @@ use Tester\Assert;
 require_once __DIR__ . '/../../bootstrap.php';
 require_once __DIR__ . '/BaseTestCase.php';
 
-class IpAddressNormalizerTest extends BaseTestCase
+/**
+ * @testCase
+ */
+final class IpAddressNormalizerTest extends BaseTestCase
 {
 
 	public function testCompress(): void

tests/Mesour/IpAddressesTests/IpAddressTest.phpt

@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Mesour\IpAddressesTests;
+
+use Mesour\IpAddresses\IpAddress;
+use Mesour\IpAddresses\IpAddressIsInvalidException;
+use Tester\Assert;
+
+require_once __DIR__ . '/../../bootstrap.php';
+require_once __DIR__ . '/BaseTestCase.php';
+
+/**
+ * @testCase
+ */
+final class IpAddressTest extends BaseTestCase
+{
+
+	public function testIpCheckAndValue(): void
+	{
+		$ipAddress = IpAddress::create('0000:0db8:0800:0000:0000:ff00:0042:8329');
+		Assert::false($ipAddress->isIpV4());
+		Assert::true($ipAddress->isIpV6());
+		Assert::same('0:db8:800::ff00:42:8329', $ipAddress->getValue());
+
+		$ipAddress = IpAddress::create('0:db8:800::ff00:42:8329');
+		Assert::false($ipAddress->isIpV4());
+		Assert::true($ipAddress->isIpV6());
+		Assert::same('0:db8:800::ff00:42:8329', $ipAddress->getValue());
+
+		$ipAddress = IpAddress::create('127.0.0.1');
+		Assert::true($ipAddress->isIpV4());
+		Assert::false($ipAddress->isIpV6());
+		Assert::same('127.0.0.1', $ipAddress->getValue());
+	}
+
+	public function testInvalidIp(): void
+	{
+		Assert::exception(function (): void {
+			IpAddress::create('123');
+		}, IpAddressIsInvalidException::class);
+	}
+
+}
+
+$test = new IpAddressTest();
+$test->run();