Merge pull request 'Entfernung nicht ausgeführten Codes und Dokumentation der Wertebereiche zur besseren Darstellung der möglichen Risiken.' (#2) from tests/weitere-farben into master

Reviewed-on: http://localhost:3000/TorstenHettstedt/PHP-Packages-Colors/pulls/2

README.md

@@ -13,4 +13,6 @@ Die Klassen haben keinen Alphakanal.
 
 ## Hinweise zu den Transformer-Klassen
 
-Das Vorgehen der Umwandlung nimmt die Informationen von [Wikipedia - Liste der Farbräume](https://de.wikipedia.org/wiki/Liste_der_Farbr%C3%A4ume) auf.
+Das Vorgehen der Umwandlung nimmt die Informationen von 
+[Wikipedia - Liste der Farbräume](https://de.wikipedia.org/wiki/Liste_der_Farbr%C3%A4ume)
+und [Die Chemie-Schule - HSV-Farbraum](https://www.chemie-schule.de/KnowHow/HSV-Farbraum) auf.

codeception.dist.yml

@@ -0,0 +1,14 @@
+paths:
+    tests: tests
+    output: tests/_output
+    data: tests/_data
+    support: tests/_support
+    envs: tests/_envs
+actor_suffix: Tester
+extensions:
+    enabled:
+        - Codeception\Extension\RunFailed
+coverage:
+    enabled: true
+    include:
+        - src/*

composer.json

@@ -16,15 +16,17 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "TorstenHettstedtUnitTests\\Colors\\" : "tests/unit"
+            "TorstenHettstedt\\Colors\\Tests\\Unit\\" : "tests/unit",
+            "TorstenHettstedt\\Colors\\Tests\\Helper\\" : "tests/_support/Helper"
         }
     },
     "require": {
-        "php": "^8.0"
+        "php": "^8.0",
+        "phpunit/php-code-coverage": "^9.2"
     },
     "require-dev": {
         "codeception/codeception": "^4.1.18",
         "codeception/module-phpbrowser": "^1.0.0",
         "codeception/module-asserts": "^1.0.0"
     }
-}
+}

src/Transformer/HueSaturationValueTransformer.php

@@ -0,0 +1,41 @@
+<?php
+
+
+namespace TorstenHettstedt\Colors\Transformer;
+
+
+use TorstenHettstedt\Colors\ColorModels\CyanMagentaYellowKey;
+use TorstenHettstedt\Colors\ColorModels\HueSaturationValue;
+use TorstenHettstedt\Colors\ColorModels\RedGreenBlue;
+
+class HueSaturationValueTransformer implements ColorModelTransformInterface
+{
+
+    protected HueSaturationValue $color;
+
+    /**
+     * @param HueSaturationValue $color
+     */
+    public function __construct(HueSaturationValue $color)
+    {
+        $this->color = $color;
+    }
+
+
+    public function toRedGreenBlue(): RedGreenBlue
+    {
+        $utility = new Utilities\HueSaturationValueToRedGreenBlue($this->color);
+        return $utility->convert();
+    }
+
+    public function toCyanMagentaYellowKey(): CyanMagentaYellowKey
+    {
+        $utility = new Utilities\HueSaturationValueToCyanMagentaYellowKey($this->color);
+        return $utility->convert();
+    }
+
+    public function toHueSaturationValue(): HueSaturationValue
+    {
+        return clone $this->color;
+    }
+}

src/Transformer/RedGreenBlueTransformer.php

@@ -0,0 +1,42 @@
+<?php
+
+
+namespace TorstenHettstedt\Colors\Transformer;
+
+
+use TorstenHettstedt\Colors\ColorModels\CyanMagentaYellowKey;
+use TorstenHettstedt\Colors\ColorModels\HueSaturationValue;
+use TorstenHettstedt\Colors\ColorModels\RedGreenBlue;
+
+class RedGreenBlueTransformer implements ColorModelTransformInterface
+{
+
+    protected RedGreenBlue $color;
+
+    /**
+     * @param RedGreenBlue $color
+     */
+    public function __construct(RedGreenBlue $color)
+    {
+        $this->color = $color;
+    }
+
+
+    public function toRedGreenBlue(): RedGreenBlue
+    {
+        return clone $this->color;
+    }
+
+    public function toCyanMagentaYellowKey(): CyanMagentaYellowKey
+    {
+        $hsv_color = (new Utilities\RedGreenBlueToHueSaturationValue($this->color))->convert();
+        $utility = new Utilities\HueSaturationValueToCyanMagentaYellowKey($hsv_color);
+        return $utility->convert();
+    }
+
+    public function toHueSaturationValue(): HueSaturationValue
+    {
+        $utility = new Utilities\RedGreenBlueToHueSaturationValue($this->color);
+        return $utility->convert();
+    }
+}

src/Transformer/Utilities/CyanMagentaYellowKeyToHueSaturationValue.php

@@ -55,6 +55,9 @@ class CyanMagentaYellowKeyToHueSaturationValue
         $this->minCmyProperty = min($this->cyan, $this->magenta, $this->yellow);
 
         $this->hue = $this->buildHueAmount();
+        if ($this->hue === 1.0) {
+            $this->hue = 0.0;
+        }
         $this->saturation = $this->maxCmyProperty;
         $this->value = 1 - $this->key;
     }
@@ -71,7 +74,9 @@ class CyanMagentaYellowKeyToHueSaturationValue
 
     protected function buildHueAmount(): float
     {
-        if ($this->maxCmyProperty === 0) {
+        // Wenn beide Werte gleich sind, ist die Endfarbe Grau.
+        // Damit wird auch in {@sse hueAmount()} eine Division durch Null verhindert.
+        if ($this->maxCmyProperty === $this->minCmyProperty) {
             return 0.0;
         }
 
@@ -88,34 +93,32 @@ class CyanMagentaYellowKeyToHueSaturationValue
      */
     private function hueAmount(string $property): float
     {
-        if ($this->maxCmyProperty === 0.0) {
-            return 0.0;
-        }
-
-        static $amount_share = 2.0;
-
+        // Wertebereich: [0.0, 1.0]
         $divisor = $this->maxCmyProperty - $this->minCmyProperty;
+        // Wertebereich: [1.0, 5.0]
+        $amount = 0.0;
+        // Wertebereich: [-1.0, +1.0]
+        $dividend = 0.0;
 
         switch ($property) {
             case self::PROPERTY_YELLOW:
-                $amount = 0; // 0.167
+                $amount = 1.0; // 0.167
                 $dividend = $this->cyan - $this->magenta;
                 break;
             case self::PROPERTY_CYAN:
-                $amount = 1; // 0.500
+                $amount = 3.0; // 0.500
                 $dividend = $this->magenta -$this->yellow;
                 break;
             case self::PROPERTY_MAGENTA:
-                $amount = 2; // 0.833
+                $amount = 5.0; // 0.833
                 $dividend = $this->yellow - $this->cyan;
                 break;
-            default:
-                return 0;
         }
 
-        $start_amount = ($amount * $amount_share) + 1.0;
+        // Wertebereich: [-1.0, +1.0]
         $expansion_amount = $dividend / $divisor;
-        return ($start_amount + $expansion_amount) / 6.0;
+        // Wertebereich: [+0.0, +6.0]
+        return ($amount + $expansion_amount) / 6.0;
     }
 
 }

src/Transformer/Utilities/HueSaturationValueToCyanMagentaYellowKey.php

@@ -0,0 +1,110 @@
+<?php
+
+
+namespace TorstenHettstedt\Colors\Transformer\Utilities;
+
+
+use TorstenHettstedt\Colors\ColorModels\CyanMagentaYellowKey;
+use TorstenHettstedt\Colors\ColorModels\HueSaturationValue;
+
+class HueSaturationValueToCyanMagentaYellowKey
+{
+    /** @var int : Größe des Intervals in 1/100 Grad */
+    protected const INTERVAL = 60.0 * 100.0;
+
+    // Daten für HSV
+    /** @var float : Definition des Farbton als Anteil eines Vollkreises '$Hue * π' */
+    protected float $hue;
+    /** @var float : Anteil am Vollkreis in 1/100 Grad  */
+    protected float $hueAsPercentGrad;
+    /** @var float : Definition der Sättigung der Farbe */
+    protected float $saturation;
+    /** @var float : Definition der Helligkeit der Farbe */
+    protected float $value;
+
+    // Daten für CMYK
+    /** @var float : Definition des Cyan-Anteil */
+    protected float $cyan = 0.0;
+    /** @var float : Definition des Magenta-Anteil */
+    protected float $magenta = 0.0;
+    /** @var float : Definition des Gelbanteil */
+    protected float $yellow = 0.0;
+    /** @var float : Definition des Schwarzanteil */
+    protected float $key = 0.0;
+
+    /**
+     * HueSaturationValueToRedGreenBlue constructor.
+     * @param HueSaturationValue $from_color
+     * @noinspection PhpPureAttributeCanBeAddedInspection
+     */
+    public function __construct(HueSaturationValue $from_color)
+    {
+        $this->hue = $from_color->getHue();
+        $this->hueAsPercentGrad = intval($this->hue * self::INTERVAL * 6);
+        $this->saturation = $from_color->getSaturation();
+        $this->value = $from_color->getValue();
+    }
+
+    public function convert(): CyanMagentaYellowKey
+    {
+        $this->processConvert();
+
+        return (new CyanMagentaYellowKey())
+            ->setCyan($this->cyan)
+            ->setMagenta($this->magenta)
+            ->setYellow($this->yellow)
+            ->setKey($this->key);
+    }
+
+
+    protected function processConvert(): void
+    {
+        $this->key = 1 - $this->value;
+        if ($this->saturation !== 0.0) {
+            $this->splitColor();
+        }
+    }
+
+    protected function splitColor(): void
+    {
+        // ID des zu nutzenden Interval
+        $interval_id = intdiv($this->hueAsPercentGrad , self::INTERVAL);
+
+        switch ($interval_id) {
+            case 1: // Yellow
+                $this->cyan = $this->calcRemainder();
+                $this->yellow = $this->saturation;
+                break;
+            case 2:
+                $this->cyan = $this->saturation;
+                $this->yellow = $this->calcRemainder(true);
+                break;
+            case 3: // Cyan
+                $this->cyan = $this->saturation;
+                $this->magenta = $this->calcRemainder();
+                break;
+            case 4:
+                $this->cyan = $this->calcRemainder(true);
+                $this->magenta = $this->saturation;
+                break;
+            case 5: // Magenta
+                $this->magenta = $this->saturation;
+                $this->yellow = $this->calcRemainder();
+                break;
+            default:
+                $this->magenta = $this->calcRemainder(true);
+                $this->yellow = $this->saturation;
+                break;
+        }
+    }
+
+    protected function calcRemainder($reciprocal = false): float
+    {
+        // Rest-Anteil am Vollkreis des aktuellen Intervals als Wert '[0,1]'
+        $remainder_grad = $this->hueAsPercentGrad % self::INTERVAL;
+        // Rest-Anteil am Vollkreis des aktuellen Intervals als Wert '[0,1]'
+        $remainder = $remainder_grad / self::INTERVAL;
+        return $this->saturation * ($reciprocal ? (1 - $remainder) : $remainder);
+    }
+
+}

src/Transformer/Utilities/RedGreenBlueToHueSaturationValue.php

@@ -0,0 +1,134 @@
+<?php
+
+namespace TorstenHettstedt\Colors\Transformer\Utilities;
+
+use TorstenHettstedt\Colors\ColorModels\HueSaturationValue;
+use TorstenHettstedt\Colors\ColorModels\RedGreenBlue;
+
+class RedGreenBlueToHueSaturationValue
+{
+    const PROPERTY_RED   = 'red';
+    const PROPERTY_GREEN = 'green';
+    const PROPERTY_BLUE  = 'blue';
+
+    // Daten für RGB
+    /** @var float : Definition des Rotanteil */
+    protected float $red;
+    /** @var float : Definition des Grünanteil */
+    protected float $green;
+    /** @var float : Definition des Blauanteil */
+    protected float $blu;
+
+    /** @var float : Der größte RGB-Farbwert */
+    protected float $maxRgbProperty;
+    /** @var float : Der kleinste RGB-Farbwert */
+    protected float $minRgbProperty;
+
+    // Daten für HSV
+    /** @var float : Definition des Farbton als Anteil eines Vollkreises '$Hue * π' */
+    protected float $hue = 0.0;
+    /** @var float : Definition der Sättigung der Farbe */
+    protected float $saturation = 0.0;
+    /** @var float : Definition der Helligkeit der Farbe */
+    protected float $value = 1.0;
+
+    /**
+     * CyanMagentaYellowKeyToHueSaturationValue constructor.
+     *
+     * @param RedGreenBlue $from_color
+     *
+     * @noinspection PhpPureAttributeCanBeAddedInspection
+     */
+    public function __construct(RedGreenBlue $from_color)
+    {
+        $this->red = $from_color->getRed();
+        $this->green = $from_color->getGreen();
+        $this->blu = $from_color->getBlue();
+    }
+
+    protected function processConvert(): void
+    {
+        $this->maxRgbProperty = max($this->red, $this->green, $this->blu);
+        $this->minRgbProperty = min($this->red, $this->green, $this->blu);
+
+        $this->hue = $this->buildHueAmount();
+        $this->saturation = $this->buildSaturation();
+        $this->value = $this->maxRgbProperty;
+
+        while($this->hue < 0.0) {
+            $this->hue += 1.0;
+        }
+    }
+
+    public function convert(): HueSaturationValue
+    {
+        $this->processConvert();
+
+        return (new HueSaturationValue())
+            ->setHue($this->hue)
+            ->setSaturation($this->saturation)
+            ->setValue($this->value);
+    }
+
+    protected function buildHueAmount(): float
+    {
+        // Wenn beide Werte gleich sind, ist die Endfarbe Grau.
+        // Damit wird auch in {@sse hueAmount()} eine Division durch Null verhindert.
+        if ($this->maxRgbProperty === $this->minRgbProperty) {
+            return 0.0;
+        }
+
+        return match ($this->maxRgbProperty) {
+            $this->red => $this->hueAmount(self::PROPERTY_RED),
+            $this->green => $this->hueAmount(self::PROPERTY_GREEN),
+            default => $this->hueAmount(self::PROPERTY_BLUE),
+        };
+    }
+
+    protected function buildSaturation(): float
+    {
+        if ($this->maxRgbProperty === 0.0) {
+            return 0.0;
+        }
+
+        $dividend = $this->maxRgbProperty - $this->minRgbProperty;
+
+        return $dividend / $this->maxRgbProperty;
+    }
+
+    /**
+     * @param string $property : Name der CMYK-Eigenschaft
+     *
+     * @return float
+     */
+    private function hueAmount(string $property): float
+    {
+        // Wertebereich: [0.0, 1.0]
+        $divisor = $this->maxRgbProperty - $this->minRgbProperty;
+        // Wertebereich: [1.0, 5.0]
+        $amount = 0.0;
+        // Wertebereich: [-1.0, +1.0]
+        $dividend = 0.0;
+
+        switch ($property) {
+            case self::PROPERTY_RED:
+                $amount = 0.0; // 0.0
+                $dividend = $this->green - $this->blu;
+                break;
+            case self::PROPERTY_GREEN:
+                $amount = 2.0; // 0.333
+                $dividend = $this->blu -$this->red;
+                break;
+            case self::PROPERTY_BLUE:
+                $amount = 4.0; // 0.999
+                $dividend = $this->red - $this->green;
+                break;
+        }
+
+        // Wertebereich: [-1.0, +1.0]
+        $expansion_amount = $dividend / $divisor;
+        // Wertebereich: [-1.0, +5.0]
+        return ($amount + $expansion_amount) / 6.0;
+    }
+
+}

tests/_support/Helper/ValidColorValuesProvider.php

@@ -0,0 +1,317 @@
+<?php
+
+
+namespace TorstenHettstedt\Colors\Tests\Helper;
+
+
+class ValidColorValuesProvider
+{
+
+    const CMYK = 'cmyk';
+    const RGB  = 'rgb';
+    const HSV  = 'hsv';
+
+    protected array $definitions = [
+        'weiß'    => [
+            self::CMYK => [
+                'cyan'    => 0.0,
+                'magenta' => 0.0,
+                'yellow'  => 0.0,
+                'key'     => 0.0,
+            ],
+            self::RGB  => [
+                'red'   => 1.0,
+                'green' => 1.0,
+                'blue'  => 1.0,
+            ],
+            self::HSV  => [
+                'hue'        => 0.0,
+                'saturation' => 0.0,
+                'value'      => 1.0,
+            ],
+        ],
+        'hellgrau' => [
+            self::CMYK => [
+                'cyan'    => 0.0,
+                'magenta' => 0.0,
+                'yellow'  => 0.0,
+                'key'     => 2.0 / 3.0,
+            ],
+            self::RGB  => [
+                'red'   => 1.0 / 3.0,
+                'green' => 1.0 / 3.0,
+                'blue'  => 1.0 / 3.0,
+            ],
+            self::HSV  => [
+                'hue'        => 0.0,
+                'saturation' => 0.0,
+                'value'      => 1.0 / 3.0,
+            ],
+        ],
+        'dunkelgrau' => [
+            self::CMYK => [
+                'cyan'    => 0.0,
+                'magenta' => 0.0,
+                'yellow'  => 0.0,
+                'key'     => 1.0 / 3.0,
+            ],
+            self::RGB  => [
+                'red'   => 2.0 / 3.0,
+                'green' => 2.0 / 3.0,
+                'blue'  => 2.0 / 3.0,
+            ],
+            self::HSV  => [
+                'hue'        => 0.0,
+                'saturation' => 0.0,
+                'value'      => 2.0 / 3.0,
+            ],
+        ],
+        'schwarz' => [
+            self::CMYK => [
+                'cyan'    => 0.0,
+                'magenta' => 0.0,
+                'yellow'  => 0.0,
+                'key'     => 1.0,
+            ],
+            self::RGB  => [
+                'red'   => 0.0,
+                'green' => 0.0,
+                'blue'  => 0.0,
+            ],
+            self::HSV  => [
+                'hue'        => 0.0,
+                'saturation' => 0.0,
+                'value'      => 0.0,
+            ],
+        ],
+        'gelb'    => [
+            self::CMYK => [
+                'cyan'    => 0.0,
+                'magenta' => 0.0,
+                'yellow'  => 1.0,
+                'key'     => 0.0,
+            ],
+            self::RGB  => [
+                'red'   => 1.0,
+                'green' => 1.0,
+                'blue'  => 0.0,
+            ],
+            self::HSV  => [
+                'hue'        => 1.0 / 6.0,
+                'saturation' => 1.0,
+                'value'      => 1.0,
+            ],
+        ],
+        'grün'    => [
+            self::CMYK => [
+                'cyan'    => 1.0,
+                'magenta' => 0.0,
+                'yellow'  => 1.0,
+                'key'     => 0.0,
+            ],
+            self::RGB  => [
+                'red'   => 0.0,
+                'green' => 1.0,
+                'blue'  => 0.0,
+            ],
+            self::HSV  => [
+                'hue'        => 2.0 / 6.0,
+                'saturation' => 1.0,
+                'value'      => 1.0,
+            ],
+        ],
+        'cyan'    => [
+            self::CMYK => [
+                'cyan'    => 1.0,
+                'magenta' => 0.0,
+                'yellow'  => 0.0,
+                'key'     => 0.0,
+            ],
+            self::RGB  => [
+                'red'   => 0.0,
+                'green' => 1.0,
+                'blue'  => 1.0,
+            ],
+            self::HSV  => [
+                'hue'        => 3.0 / 6.0,
+                'saturation' => 1.0,
+                'value'      => 1.0,
+            ],
+        ],
+        'blau'    => [
+            self::CMYK => [
+                'cyan'    => 1.0,
+                'magenta' => 1.0,
+                'yellow'  => 0.0,
+                'key'     => 0.0,
+            ],
+            self::RGB  => [
+                'red'   => 0.0,
+                'green' => 0.0,
+                'blue'  => 1.0,
+            ],
+            self::HSV  => [
+                'hue'        => 4.0 / 6.0,
+                'saturation' => 1.0,
+                'value'      => 1.0,
+            ],
+        ],
+        'magenta' => [
+            self::CMYK => [
+                'cyan'    => 0.0,
+                'magenta' => 1.0,
+                'yellow'  => 0.0,
+                'key'     => 0.0,
+            ],
+            self::RGB  => [
+                'red'   => 1.0,
+                'green' => 0.0,
+                'blue'  => 1.0,
+            ],
+            self::HSV  => [
+                'hue'        => 5.0 / 6.0,
+                'saturation' => 1.0,
+                'value'      => 1.0,
+            ],
+        ],
+        'rot'    => [
+            self::CMYK => [
+                'cyan'    => 0.0,
+                'magenta' => 1.0,
+                'yellow'  => 1.0,
+                'key'     => 0.0,
+            ],
+            self::RGB  => [
+                'red'   => 1.0,
+                'green' => 0.0,
+                'blue'  => 0.0,
+            ],
+            self::HSV  => [
+                'hue'        => 0.0,
+                'saturation' => 1.0,
+                'value'      => 1.0,
+            ],
+        ],
+        'dunkellachs' => [
+            self::CMYK => [
+                'cyan'    => 0.0,
+                'magenta' => 0.54,
+                'yellow'  => 0.72,
+                'key'     => 0.30,
+            ],
+            self::RGB  => [
+                'red'   => 0.7,
+                'green' => 0.3216,
+                'blue'  => 0.1961,
+            ],
+            self::HSV  => [
+                'hue'        => 0.0417,
+                'saturation' => 0.72,
+                'value'      => 0.70,
+            ],
+        ],
+        'gold'    => [
+            self::CMYK => [
+                'cyan'    => 0.0,
+                'magenta' => 0.13,
+                'yellow'  => 0.76,
+                'key'     => 0.13,
+            ],
+            self::RGB  => [
+                'red'   => 0.87,
+                'green' => 0.757,
+                'blue'  => 0.209,
+            ],
+            self::HSV  => [
+                'hue'        => 0.138,
+                'saturation' => 0.76,
+                'value'      => 0.87,
+            ],
+        ],
+        'grasgrün' => [
+            self::CMYK => [
+                'cyan'    => 0.495,
+                'magenta' => 0.0,
+                'yellow'  => 1.0,
+                'key'     => 0.51,
+            ],
+            self::RGB  => [
+                'red'   => 0.247,
+                'green' => 0.490,
+                'blue'  => 0.0,
+            ],
+            self::HSV  => [
+                'hue'        => 0.2492,
+                'saturation' => 1.00,
+                'value'      => 0.49,
+            ],
+        ],
+        'aquamarin' => [
+            self::CMYK => [
+                'cyan'    => 0.501,
+                'magenta' => 0.0,
+                'yellow'  => 0.168,
+                'key'     => 0.00,
+            ],
+            self::RGB  => [
+                'red'   => 0.49804,
+                'green' => 1.0,
+                'blue'  => 0.83285,
+            ],
+            self::HSV  => [
+                'hue'        => 0.4445,
+                'saturation' => 0.50196,
+                'value'      => 1.0,
+            ],
+        ],
+        'violet'  => [
+            self::CMYK => [
+                'cyan'    => 0.191,
+                'magenta' => 0.321,
+                'yellow'  => 0.0,
+                'key'     => 0.29,
+            ],
+            self::RGB  => [
+                'red'   => 0.575,
+                'green' => 0.482,
+                'blue'  => 0.71,
+            ],
+            self::HSV  => [
+                'hue'        => 0.734,
+                'saturation' => 0.321,
+                'value'      => 0.71,
+            ],
+        ],
+        'pflaume'  => [
+            self::CMYK => [
+                'cyan'    => 0.0,
+                'magenta' => 0.2755,
+                'yellow'  => 0.0,
+                'key'     => 0.1335,
+            ],
+            self::RGB  => [
+                'red'   => 0.8667,
+                'green' => 0.6274,
+                'blue'  => 0.8667,
+            ],
+            self::HSV  => [
+                'hue'        => 0.83333,
+                'saturation' => 0.27601,
+                'value'      => 0.86666,
+            ],
+        ],
+    ];
+
+    public function getValidColorValues(array $order): array
+    {
+        $values = [];
+        foreach ($this->definitions as $color => $definition) {
+            $definitions = [];
+            foreach ($order as $key) {
+                $definitions[] = $definition[$key];
+            }
+            $values[$color] = $definitions;
+        }
+        return $values;
+    }
+}

tests/unit/ColorModels/AbstractColorModelUnit.php

@@ -1,7 +1,7 @@
 <?php /** @noinspection PhpArrayShapeAttributeCanBeAddedInspection */
 
 
-namespace TorstenHettstedtUnitTests\Colors\ColorModels;
+namespace TorstenHettstedt\Colors\Tests\Unit\ColorModels;
 
 use Codeception\Test\Unit;
 

tests/unit/ColorModels/CyanMagentaYellowKeyTest.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace TorstenHettstedtUnitTests\Colors\ColorModels;
+namespace TorstenHettstedt\Colors\Tests\Unit\ColorModels;
 
 use InvalidArgumentException;
 use TorstenHettstedt\Colors\ColorModels\CyanMagentaYellowKey;

tests/unit/ColorModels/HueSaturationValueTest.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace TorstenHettstedtUnitTests\Colors\ColorModels;
+namespace TorstenHettstedt\Colors\Tests\Unit\ColorModels;
 
 use InvalidArgumentException;
 use TorstenHettstedt\Colors\ColorModels\HueSaturationValue;

tests/unit/ColorModels/RedGreenBlueTest.php

@@ -1,6 +1,6 @@
-<?php /** @noinspection PhpArrayShapeAttributeCanBeAddedInspection */
+<?php
 
-namespace TorstenHettstedtUnitTests\Colors\ColorModels;
+namespace TorstenHettstedt\Colors\Tests\Unit\ColorModels;
 
 use InvalidArgumentException;
 use TorstenHettstedt\Colors\ColorModels\RedGreenBlue;

tests/unit/Transformer/CyanMagentaYellowKeyTransformerTest.php

@@ -1,10 +1,11 @@
-<?php /** @noinspection PhpArrayShapeAttributeCanBeAddedInspection */
+<?php
 
-namespace TorstenHettstedtUnitTests\Colors\Transformer;
+namespace TorstenHettstedt\Colors\Tests\Unit\Transformer;
 
 use Codeception\Test\Unit;
 use Exception;
 use TorstenHettstedt\Colors\ColorModels\CyanMagentaYellowKey;
+use TorstenHettstedt\Colors\Tests\Helper\ValidColorValuesProvider;
 use TorstenHettstedt\Colors\Transformer\CyanMagentaYellowKeyTransformer;
 
 class CyanMagentaYellowKeyTransformerTest extends Unit
@@ -19,99 +20,10 @@ class CyanMagentaYellowKeyTransformerTest extends Unit
      */
     public function validRgbValuesProvider(): array
     {
-        return [
-            'weiß' => [
-                [
-                    'cyan'    => 0.0,
-                    'magenta' => 0.0,
-                    'yellow'  => 0.0,
-                    'key'     => 0.0,
-                ],
-                [
-                    'red'   => 1.0,
-                    'green' => 1.0,
-                    'blue'  => 1.0,
-                ]
-            ],
-            'schwarz' => [
-                [
-                    'cyan'    => 0.0,
-                    'magenta' => 0.0,
-                    'yellow'  => 0.0,
-                    'key'     => 1.0,
-                ],
-                [
-                    'red'   => 0.0,
-                    'green' => 0.0,
-                    'blue'  => 0.0,
-                ]
-            ],
-            'cyan' => [
-                [
-                    'cyan'    => 1.0,
-                    'magenta' => 0.0,
-                    'yellow'  => 0.0,
-                    'key'     => 0.0,
-                ],
-                [
-                    'red'   => 0.0,
-                    'green' => 1.0,
-                    'blue'  => 1.0,
-                ]
-            ],
-            'magenta' => [
-                [
-                    'cyan'    => 0.0,
-                    'magenta' => 1.0,
-                    'yellow'  => 0.0,
-                    'key'     => 0.0,
-                ],
-                [
-                    'red'   => 1.0,
-                    'green' => 0.0,
-                    'blue'  => 1.0,
-                ]
-            ],
-            'gelb' => [
-                [
-                    'cyan'    => 0.0,
-                    'magenta' => 0.0,
-                    'yellow'  => 1.0,
-                    'key'     => 0.0,
-                ],
-                [
-                    'red'   => 1.0,
-                    'green' => 1.0,
-                    'blue'  => 0.0,
-                ]
-            ],
-            'gold' => [
-                [
-                    'cyan'    => 0.0,
-                    'magenta' => 0.13,
-                    'yellow'  => 0.76,
-                    'key'     => 0.13,
-                ],
-                [
-                    'red'   => 0.87,
-                    'green' => 0.757,
-                    'blue'  => 0.209,
-                ]
-            ],
-            'violet' => [
-                [
-                    'cyan'    => 0.19,
-                    'magenta' => 0.32,
-                    'yellow'  => 0.0,
-                    'key'     => 0.29,
-                ],
-                [
-                    'red'   => 0.575,
-                    'green' => 0.482,
-                    'blue'  => 0.71,
-                ]
-            ],
-        ];
+        return (new ValidColorValuesProvider())->getValidColorValues([
+            ValidColorValuesProvider::CMYK,
+            ValidColorValuesProvider::RGB
+        ]);
     }
 
     /**
@@ -119,99 +31,10 @@ class CyanMagentaYellowKeyTransformerTest extends Unit
      */
     public function validHsvValuesProvider(): array
     {
-        return [
-            'weiß' => [
-                [
-                    'cyan'    => 0.0,
-                    'magenta' => 0.0,
-                    'yellow'  => 0.0,
-                    'key'     => 0.0,
-                ],
-                [
-                    'hue'        => 0.0,
-                    'saturation' => 0.0,
-                    'value'      => 1.0,
-                ]
-            ],
-            'schwarz' => [
-                [
-                    'cyan'    => 0.0,
-                    'magenta' => 0.0,
-                    'yellow'  => 0.0,
-                    'key'     => 1.0,
-                ],
-                [
-                    'hue'        => 0.0,
-                    'saturation' => 0.0,
-                    'value'      => 0.0,
-                ]
-            ],
-            'cyan' => [
-                [
-                    'cyan'    => 1.0,
-                    'magenta' => 0.0,
-                    'yellow'  => 0.0,
-                    'key'     => 0.0,
-                ],
-                [
-                    'hue'        => 0.5,
-                    'saturation' => 1.0,
-                    'value'      => 1.0,
-                ]
-            ],
-            'magenta' => [
-                [
-                    'cyan'    => 0.0,
-                    'magenta' => 1.0,
-                    'yellow'  => 0.0,
-                    'key'     => 0.0,
-                ],
-                [
-                    'hue'        => 0.833,
-                    'saturation' => 1.0,
-                    'value'      => 1.0,
-                ]
-            ],
-            'gelb' => [
-                [
-                    'cyan'    => 0.0,
-                    'magenta' => 0.0,
-                    'yellow'  => 1.0,
-                    'key'     => 0.0,
-                ],
-                [
-                    'hue'        => 0.167,
-                    'saturation' => 1.0,
-                    'value'      => 1.0,
-                ]
-            ],
-            'gold' => [
-                [
-                    'cyan'    => 0.0,
-                    'magenta' => 0.13,
-                    'yellow'  => 0.76,
-                    'key'     => 0.13,
-                ],
-                [
-                    'hue'        => 0.138,
-                    'saturation' => 0.76,
-                    'value'      => 0.87,
-                ]
-            ],
-            'violet' => [
-                [
-                    'cyan'    => 0.19,
-                    'magenta' => 0.32,
-                    'yellow'  => 0.0,
-                    'key'     => 0.29,
-                ],
-                [
-                    'hue'        => 0.734,
-                    'saturation' => 0.32,
-                    'value'      => 0.71,
-                ]
-            ],
-        ];
+        return (new ValidColorValuesProvider())->getValidColorValues([
+            ValidColorValuesProvider::CMYK,
+            ValidColorValuesProvider::HSV
+        ]);
     }
 
     /**

tests/unit/Transformer/HueSaturationValueTransformerTest.php

@@ -0,0 +1,103 @@
+<?php
+
+namespace TorstenHettstedt\Colors\Tests\Unit\Transformer;
+
+use Codeception\Test\Unit;
+use Exception;
+use TorstenHettstedt\Colors\ColorModels\HueSaturationValue;
+use TorstenHettstedt\Colors\Tests\Helper\ValidColorValuesProvider;
+use TorstenHettstedt\Colors\Transformer\HueSaturationValueTransformer;
+
+class HueSaturationValueTransformerTest extends Unit
+{
+
+    const FLOAT_DELTA = 0.001;
+
+    protected HueSaturationValue $color;
+
+    /**
+     * @return float[][][]
+     */
+    public function validCmykValuesProvider(): array
+    {
+        return (new ValidColorValuesProvider())->getValidColorValues([
+            ValidColorValuesProvider::HSV,
+            ValidColorValuesProvider::CMYK,
+        ]);
+    }
+
+    /**
+     * @return float[][][]
+     */
+    public function validRgbValuesProvider(): array
+    {
+        return (new ValidColorValuesProvider())->getValidColorValues([
+            ValidColorValuesProvider::HSV,
+            ValidColorValuesProvider::RGB,
+        ]);
+    }
+
+    /**
+     * @param array $hsv
+     * @param array $rgb
+     *
+     * @dataProvider validRgbValuesProvider
+     *
+     * @throws Exception
+     */
+    public function testToRedGreenBlue(array $hsv, array $rgb)
+    {
+        $this->color = $this->make(HueSaturationValue::class, $hsv);
+
+        $transformer = new HueSaturationValueTransformer($this->color);
+
+        $color = $transformer->toRedGreenBlue();
+
+        $this->assertEqualsWithDelta($rgb['red'], $color->getRed(), self::FLOAT_DELTA);
+        $this->assertEqualsWithDelta($rgb['green'], $color->getGreen(), self::FLOAT_DELTA);
+        $this->assertEqualsWithDelta($rgb['blue'], $color->getBlue(), self::FLOAT_DELTA);
+
+    }
+
+    /**
+     * @param array $hsv
+     * @param array $cmyk
+     *
+     * @throws Exception
+     * @dataProvider validCmykValuesProvider
+     *
+     */
+    public function testToCyanMagentaYellowKey(array $hsv, array $cmyk)
+    {
+
+        $this->color = $this->make(HueSaturationValue::class, $hsv);
+
+        $transformer = new HueSaturationValueTransformer($this->color);
+
+        $color = $transformer->toCyanMagentaYellowKey();
+
+        $this->assertEqualsWithDelta($cmyk['cyan'], $color->getCyan(), self::FLOAT_DELTA);
+        $this->assertEqualsWithDelta($cmyk['magenta'], $color->getMagenta(), self::FLOAT_DELTA);
+        $this->assertEqualsWithDelta($cmyk['yellow'], $color->getYellow(), self::FLOAT_DELTA);
+        $this->assertEqualsWithDelta($cmyk['key'], $color->getKey(), self::FLOAT_DELTA);
+    }
+
+    /**
+     * @param array $hsv
+     *
+     * @throws Exception
+     * @dataProvider validCmykValuesProvider
+     */
+    public function testToHueSaturationValue(array $hsv)
+    {
+        $this->color = $this->make(HueSaturationValue::class, $hsv);
+
+        $transformer = new HueSaturationValueTransformer($this->color);
+
+        $color = $transformer->toHueSaturationValue();
+
+        $this->assertEqualsWithDelta($hsv['hue'], $color->getHue(), self::FLOAT_DELTA);
+        $this->assertEqualsWithDelta($hsv['saturation'], $color->getSaturation(), self::FLOAT_DELTA);
+        $this->assertEqualsWithDelta($hsv['value'], $color->getValue(), self::FLOAT_DELTA);
+    }
+}

tests/unit/Transformer/RedGreenBlueTransformerTest.php

@@ -0,0 +1,103 @@
+<?php
+
+namespace TorstenHettstedt\Colors\Tests\Unit\Transformer;
+
+use Codeception\Test\Unit;
+use Exception;
+use TorstenHettstedt\Colors\ColorModels\RedGreenBlue;
+use TorstenHettstedt\Colors\Tests\Helper\ValidColorValuesProvider;
+use TorstenHettstedt\Colors\Transformer\RedGreenBlueTransformer;
+
+class RedGreenBlueTransformerTest extends Unit
+{
+
+    const FLOAT_DELTA = 0.001;
+
+    protected RedGreenBlue $color;
+
+    /**
+     * @return float[][][]
+     */
+    public function validCmykValuesProvider(): array
+    {
+        return (new ValidColorValuesProvider())->getValidColorValues([
+            ValidColorValuesProvider::RGB,
+            ValidColorValuesProvider::CMYK,
+        ]);
+    }
+
+    /**
+     * @return float[][][]
+     */
+    public function validHsvValuesProvider(): array
+    {
+        return (new ValidColorValuesProvider())->getValidColorValues([
+            ValidColorValuesProvider::RGB,
+            ValidColorValuesProvider::HSV,
+        ]);
+    }
+
+    /**
+     * @param array $rgb
+     *
+     * @dataProvider validCmykValuesProvider
+     *
+     * @throws Exception
+     */
+    public function testToRedGreenBlue(array $rgb)
+    {
+        $this->color = $this->make(RedGreenBlue::class, $rgb);
+
+        $transformer = new RedGreenBlueTransformer($this->color);
+
+        $color = $transformer->toRedGreenBlue();
+
+        $this->assertEqualsWithDelta($rgb['red'], $color->getRed(), self::FLOAT_DELTA);
+        $this->assertEqualsWithDelta($rgb['green'], $color->getGreen(), self::FLOAT_DELTA);
+        $this->assertEqualsWithDelta($rgb['blue'], $color->getBlue(), self::FLOAT_DELTA);
+
+    }
+
+    /**
+     * @param array $rgb
+     * @param array $cmyk
+     *
+     * @throws Exception
+     * @dataProvider validCmykValuesProvider
+     *
+     */
+    public function testToCyanMagentaYellowKey(array $rgb, array $cmyk)
+    {
+
+        $this->color = $this->make(RedGreenBlue::class, $rgb);
+
+        $transformer = new RedGreenBlueTransformer($this->color);
+
+        $color = $transformer->toCyanMagentaYellowKey();
+
+        $this->assertEqualsWithDelta($cmyk['cyan'], $color->getCyan(), self::FLOAT_DELTA);
+        $this->assertEqualsWithDelta($cmyk['magenta'], $color->getMagenta(), self::FLOAT_DELTA);
+        $this->assertEqualsWithDelta($cmyk['yellow'], $color->getYellow(), self::FLOAT_DELTA);
+        $this->assertEqualsWithDelta($cmyk['key'], $color->getKey(), self::FLOAT_DELTA);
+    }
+
+    /**
+     * @param array $rgb
+     * @param array $hsv
+     *
+     * @throws Exception
+     * @dataProvider validHsvValuesProvider
+     */
+    public function testToHueSaturationValue(array $rgb, array $hsv)
+    {
+        $this->color = $this->make(RedGreenBlue::class, $rgb);
+
+        $transformer = new RedGreenBlueTransformer($this->color);
+
+        $color = $transformer->toHueSaturationValue();
+
+        $this->assertEqualsWithDelta($hsv['hue'], $color->getHue(), self::FLOAT_DELTA);
+        $this->assertEqualsWithDelta($hsv['saturation'], $color->getSaturation(), self::FLOAT_DELTA);
+        $this->assertEqualsWithDelta($hsv['value'], $color->getValue(), self::FLOAT_DELTA);
+    }
+}