Remove PHP 7 support, will only support PHP 8. Added type hinting and…

… return type declarations. Made BaseColor::back() and BaseColor::getColorModelName() public @rv1971. Use non-locale aware output for the alpha value @Jako. Updated .gitignore, and some code refactoring @kudashevs
ozdemirburak · Feb 8, 2022 · dd1ba40 · dd1ba40
1 parent 4724802
commit dd1ba40
Show file tree

Hide file tree

Showing 16 changed files with 152 additions and 153 deletions.
diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml
@@ -8,7 +8,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: [ 7.3, 7.4, 8.0, 8.1 ]
+        php: [ 8.0, 8.1 ]
         dependency-version: [ prefer-lowest, prefer-stable ]
 
     name: P${{ matrix.php }} - ${{ matrix.dependency-version }}

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,13 @@
 
 All Notable changes to `iris` will be documented in this file.
 
+## 2022-02-08
+- Remove PHP 7 support, will only support PHP 8
+- Added type hinting and return type declarations
+- Made BaseColor::back() and BaseColor::getColorModelName() public @rv1971
+- Use non-locale aware output for the alpha value @Jako
+- Updated .gitignore, and some code refactoring @kudashevs
+
 ## 2021-10-05
 - Added Hexa support.
 

diff --git a/composer.json b/composer.json
@@ -12,7 +12,7 @@
         }
     ],
     "require": {
-        "php": "^7.3|^8.0"
+        "php": "^8.0"
     },
     "require-dev": {
         "phpunit/phpunit" : "~8.0|~9.0",

diff --git a/src/BaseColor.php b/src/BaseColor.php
@@ -9,56 +9,56 @@ abstract class BaseColor
     /**
      * @param string $code
      *
-     * @return mixed
+     * @return bool|string
      */
-    abstract protected function validate($code);
+    abstract protected function validate(string $code): bool|string;
 
     /**
      * @param string $color
      *
-     * @return mixed
+     * @return array
      */
-    abstract protected function initialize($color);
+    abstract protected function initialize(string $color): array;
 
     /**
      * @return array
      */
-    abstract public function values();
+    abstract public function values(): array;
 
     /**
      * @return \OzdemirBurak\Iris\Color\Hex
      */
-    abstract public function toHex();
+    abstract public function toHex(): Color\Hex;
 
     /**
      * @return \OzdemirBurak\Iris\Color\Hsl
      */
-    abstract public function toHsl();
+    abstract public function toHsl(): Color\Hsl;
 
     /**
      * @return \OzdemirBurak\Iris\Color\Hsla
      */
-    abstract public function toHsla();
+    abstract public function toHsla(): Color\Hsla;
 
     /**
      * @return \OzdemirBurak\Iris\Color\Hsv
      */
-    abstract public function toHsv();
+    abstract public function toHsv(): Color\Hsv;
 
     /**
      * @return \OzdemirBurak\Iris\Color\Rgb
      */
-    abstract public function toRgb();
+    abstract public function toRgb(): Color\Rgb;
 
     /**
      * @return \OzdemirBurak\Iris\Color\Rgba
      */
-    abstract public function toRgba();
+    abstract public function toRgba(): Color\Rgba;
 
     /**
      * @return string
      */
-    abstract public function __toString();
+    abstract public function __toString(): string;
 
     /**
      * Color constructor.
@@ -67,7 +67,7 @@ abstract public function __toString();
      *
      * @throws \OzdemirBurak\Iris\Exceptions\InvalidColorException
      */
-    public function __construct($code)
+    public function __construct(string $code)
     {
         if (($color = $this->validate($code)) === false) {
             throw new InvalidColorException($this->getExceptionMessage() . ' => ' . $code);
@@ -80,7 +80,7 @@ public function __construct($code)
      *
      * @return mixed
      */
-    public function saturate($percent)
+    public function saturate(int $percent)
     {
         $color = $this->toHsl();
         $saturation = $this->clamp(($color->saturation() + $percent) / 100);
@@ -92,7 +92,7 @@ public function saturate($percent)
      *
      * @return mixed
      */
-    public function desaturate($percent)
+    public function desaturate(int $percent)
     {
         $color = $this->toHsl();
         $saturation = $this->clamp(($color->saturation() - $percent) / 100);
@@ -112,7 +112,7 @@ public function grayscale()
      *
      * @return mixed
      */
-    public function brighten($percent)
+    public function brighten(int $percent)
     {
         $percent *= -1;
         $color = $this->toRgb();
@@ -127,7 +127,7 @@ public function brighten($percent)
      *
      * @return mixed
      */
-    public function lighten($percent)
+    public function lighten(int $percent)
     {
         $color = $this->toHsl();
         $lightness = $this->clamp(($color->lightness() + $percent) / 100);
@@ -139,7 +139,7 @@ public function lighten($percent)
      *
      * @return mixed
      */
-    public function darken($percent)
+    public function darken(int $percent)
     {
         $color = $this->toHsl();
         $lightness = $this->clamp(($color->lightness() - $percent) / 100);
@@ -170,7 +170,7 @@ public function isDark()
      *
      * @return mixed
      */
-    public function spin($percent)
+    public function spin(int $percent)
     {
         $color = $this->toHsl();
         $hue = ($color->hue() + $percent) % 360;
@@ -183,7 +183,7 @@ public function spin($percent)
      *
      * @return mixed
      */
-    public function mix(BaseColor $color, $percent = 50)
+    public function mix(BaseColor $color, int $percent = 50)
     {
         $first = $this->toRgb();
         $second = $color->toRgb();
@@ -290,7 +290,7 @@ public function back(BaseColor $color)
     /**
      * @return string
      */
-    protected function getExceptionMessage()
+    protected function getExceptionMessage(): string
     {
         return 'Invalid ' . strtoupper(substr(static::class, strrpos(static::class, '\\') + 1)) . ' value';
     }

diff --git a/src/Color/Hex.php b/src/Color/Hex.php
@@ -15,7 +15,7 @@ class Hex extends BaseColor
      *
      * @return string|bool
      */
-    protected function validate($code)
+    protected function validate(string $code): bool|string
     {
         $color = str_replace('#', '', DefinedColor::find($code));
         if (strlen($color) === 3) {
@@ -29,23 +29,23 @@ protected function validate($code)
      *
      * @return array
      */
-    protected function initialize($color)
+    protected function initialize(string $color): array
     {
         return [$this->red, $this->green, $this->blue] = str_split($color, 2);
     }
 
     /**
      * @return \OzdemirBurak\Iris\Color\Hex
      */
-    public function toHex()
+    public function toHex(): Hex
     {
         return $this;
     }
 
     /**
      * @return \OzdemirBurak\Iris\Color\Hexa
      */
-    public function toHexa()
+    public function toHexa(): Hexa
     {
         return new Hexa((string)$this . 'FF');
     }
@@ -54,7 +54,7 @@ public function toHexa()
      * @throws \OzdemirBurak\Iris\Exceptions\InvalidColorException
      * @return \OzdemirBurak\Iris\Color\Hsl
      */
-    public function toHsl()
+    public function toHsl(): Hsl
     {
         return $this->toRgb()->toHsl();
     }
@@ -63,7 +63,7 @@ public function toHsl()
      * @throws \OzdemirBurak\Iris\Exceptions\InvalidColorException
      * @return \OzdemirBurak\Iris\Color\Hsla
      */
-    public function toHsla()
+    public function toHsla(): Hsla
     {
         return $this->toHsl()->toHsla();
     }
@@ -72,7 +72,7 @@ public function toHsla()
      * @throws \OzdemirBurak\Iris\Exceptions\InvalidColorException
      * @return \OzdemirBurak\Iris\Color\Hsv
      */
-    public function toHsv()
+    public function toHsv(): Hsv
     {
         return $this->toRgb()->toHsv();
     }
@@ -81,7 +81,7 @@ public function toHsv()
      * @throws \OzdemirBurak\Iris\Exceptions\InvalidColorException
      * @return \OzdemirBurak\Iris\Color\Rgb
      */
-    public function toRgb()
+    public function toRgb(): Rgb
     {
         $rgb = implode(',', array_map('hexdec', $this->values()));
         return new Rgb($rgb);
@@ -91,15 +91,15 @@ public function toRgb()
      * @throws \OzdemirBurak\Iris\Exceptions\InvalidColorException
      * @return \OzdemirBurak\Iris\Color\Rgba
      */
-    public function toRgba()
+    public function toRgba(): Rgba
     {
         return $this->toRgb()->toRgba();
     }
 
     /**
      * @return string
      */
-    public function __toString()
+    public function __toString(): string
     {
         return '#' . implode('', $this->values());
     }

diff --git a/src/Color/Hexa.php b/src/Color/Hexa.php
@@ -16,7 +16,7 @@ class Hexa extends BaseColor
      *
      * @return string|bool
      */
-    protected function validate($code)
+    protected function validate(string $code): bool|string
     {
         $color = str_replace('#', '', DefinedColor::find($code));
         return preg_match('/^[a-f0-9]{6}([a-f0-9]{2})?$/i', $color) ? $color : false;
@@ -27,7 +27,7 @@ protected function validate($code)
      *
      * @return array
      */
-    protected function initialize($color)
+    protected function initialize(string $color): array
     {
         [$this->red, $this->green, $this->blue, $this->alpha] = array_merge(str_split($color, 2), ['ff']);
         $this->alpha = $this->alphaHexToFloat($this->alpha ?? 'ff');
@@ -37,7 +37,7 @@ protected function initialize($color)
     /**
      * @return array
      */
-    public function values()
+    public function values(): array
     {
         return [
             $this->red(),
@@ -50,15 +50,15 @@ public function values()
     /**
      * @return \OzdemirBurak\Iris\Color\Hex
      */
-    public function toHex()
+    public function toHex(): Hex
     {
         return new Hex(implode([$this->red(), $this->green(), $this->blue()]));
     }
 
     /**
      * @return \OzdemirBurak\Iris\Color\Hexa
      */
-    public function toHexa()
+    public function toHexa(): Hexa
     {
         return $this;
     }
@@ -67,7 +67,7 @@ public function toHexa()
      * @throws \OzdemirBurak\Iris\Exceptions\InvalidColorException
      * @return \OzdemirBurak\Iris\Color\Hsl
      */
-    public function toHsl()
+    public function toHsl(): Hsl
     {
         return $this->toRgb()->toHsl();
     }
@@ -76,7 +76,7 @@ public function toHsl()
      * @throws \OzdemirBurak\Iris\Exceptions\InvalidColorException
      * @return \OzdemirBurak\Iris\Color\Hsla
      */
-    public function toHsla()
+    public function toHsla(): Hsla
     {
         return $this->toHsl()->toHsla()->alpha($this->alpha());
     }
@@ -85,7 +85,7 @@ public function toHsla()
      * @throws \OzdemirBurak\Iris\Exceptions\InvalidColorException
      * @return \OzdemirBurak\Iris\Color\Hsv
      */
-    public function toHsv()
+    public function toHsv(): Hsv
     {
         return $this->toRgb()->toHsv();
     }
@@ -94,7 +94,7 @@ public function toHsv()
      * @throws \OzdemirBurak\Iris\Exceptions\InvalidColorException
      * @return \OzdemirBurak\Iris\Color\Rgb
      */
-    public function toRgb()
+    public function toRgb(): Rgb
     {
         $rgb = implode(',', array_map('hexdec', [$this->red(), $this->green(), $this->blue()]));
         return new Rgb($rgb);
@@ -104,15 +104,15 @@ public function toRgb()
      * @throws \OzdemirBurak\Iris\Exceptions\InvalidColorException
      * @return \OzdemirBurak\Iris\Color\Rgba
      */
-    public function toRgba()
+    public function toRgba(): Rgba
     {
         return $this->toRgb()->toRgba()->alpha($this->alpha());
     }
 
     /**
      * @return string
      */
-    public function __toString()
+    public function __toString(): string
     {
         [$r, $g, $b, $a] = $this->values();
         return '#' . implode('', [$r, $g, $b, $this->alphaFloatToHex($a)]);