Redesign class

Author: VincentLanglet

doc/fields/ChoiceField.rst

@@ -90,13 +90,14 @@ pages (``index`` and ``detail``)::
 
 The built-in badge styles are the same as Bootstrap: ``'success'``,
 ``'warning'``, ``'danger'``, ``'info'``, ``'primary'``, ``'secondary'``,
-``'light'``, ``'dark'``, but you can also pass a custom full 6-digit hexadecimal background color::
+``'light'``, ``'dark'``, but you can also pass a custom
+ ``EasyCorp\Bundle\EasyAdminBundle\Field\Style\BadgeStyle`` instance::
 
     yield ChoiceField::new('...')->renderAsBadges([
         // $value => $badgeStyleName
-        'paid' => BadgeStyle::fromBgColor('#00FF00'),
-        'pending' => BadgeStyle::fromBgColor('#FFFF00'),
-        'refunded' => BadgeStyle::fromBgColor('#FF0000'),
+        'paid' => BadgeStyle::new()->withBgColor('#00FF00'),
+        'pending' => BadgeStyle::new()->withBgColor('#FFFF00'),
+        'refunded' => BadgeStyle::new()->withBgColor('#FF0000'),
     ]);
 
 renderAsNativeWidget

src/Field/Style/BadgeStyle.php

@@ -8,28 +8,38 @@ final class BadgeStyle
      * @param array<string>         $classes
      * @param array<string, string> $style
      */
-    private function __construct(private readonly array $classes, private readonly array $style)
+    private function __construct(private array $classes, private array $style)
     {
     }
 
-    public static function fromBgColor(string $backgroundColor, ?string $textColor = null): self
+    public static function new(): self
+    {
+        return new self([], []);
+    }
+
+    public function withBgColor(string $backgroundColor, bool $autoTextContrast = true): self
     {
         if (!self::isSupportedColor($backgroundColor)) {
             throw new \InvalidArgumentException(sprintf('The background color must be a full 6-digit hexadecimal color ("%s" given).', $backgroundColor));
         }
 
-        $classes = [];
-        $styleProperties = ['background-color' => $backgroundColor];
+        $this->style['background-color'] = $backgroundColor;
+        if ($autoTextContrast) {
+            $this->classes[] = self::generateTextClassFromBackgroundColor($backgroundColor);
+        }
+
+        return $this;
+    }
 
-        if (null === $textColor) {
-            $classes[] = self::computeTextClass($backgroundColor);
-        } elseif (self::isSupportedColor($textColor)) {
-            $styleProperties['color'] = $textColor;
-        } else {
+    public function withTextColor(string $textColor): self
+    {
+        if (!self::isSupportedColor($textColor)) {
             throw new \InvalidArgumentException(sprintf('The text color must be a full 6-digit hexadecimal color ("%s" given).', $textColor));
         }
 
-        return new self($classes, $styleProperties);
+        $this->style['color'] = $textColor;
+
+        return $this;
     }
 
     public function getClasses(): string
@@ -60,7 +70,7 @@ private static function isSupportedColor(string $color): bool
         return 1 === preg_match('/^#[0-9a-f]{6}$/iD', $color);
     }
 
-    private static function computeTextClass(string $backgroundColor): string
+    private static function generateTextClassFromBackgroundColor(string $backgroundColor): string
     {
         [$r, $g, $b] = [
             hexdec(substr($backgroundColor, 1, 2)),

tests/Field/ChoiceFieldTest.php

@@ -173,16 +173,16 @@ public function testBadges()
         $field->setValue([1, 3])->renderAsBadges(function ($value) { return $value > 1 ? 'success' : 'primary'; });
         self::assertSame('<span class="badge badge-primary">a</span><span class="badge badge-success">c</span>', (string) $this->configure($field)->getFormattedValue());
 
-        $field->setValue(1)->renderAsBadges([1 => BadgeStyle::fromBgColor('#123456'), '3' => BadgeStyle::fromBgColor('#AAAAAA')]);
+        $field->setValue(1)->renderAsBadges([1 => BadgeStyle::new()->withBgColor('#123456'), '3' => BadgeStyle::new()->withBgColor('#AAAAAA')]);
         self::assertSame('<span class="badge text-light" style="background-color:#123456;">a</span>', (string) $this->configure($field)->getFormattedValue());
 
-        $field->setValue([1, 3])->renderAsBadges([1 => BadgeStyle::fromBgColor('#123456'), '3' => BadgeStyle::fromBgColor('#AAAAAA')]);
+        $field->setValue([1, 3])->renderAsBadges([1 => BadgeStyle::new()->withBgColor('#123456'), '3' => BadgeStyle::new()->withBgColor('#AAAAAA')]);
         self::assertSame('<span class="badge text-light" style="background-color:#123456;">a</span><span class="badge text-dark" style="background-color:#AAAAAA;">c</span>', (string) $this->configure($field)->getFormattedValue());
 
-        $field->setValue(1)->renderAsBadges(function ($value) { return $value > 1 ? BadgeStyle::fromBgColor('#AAAAAA') : BadgeStyle::fromBgColor('#123456'); });
+        $field->setValue(1)->renderAsBadges(function ($value) { return $value > 1 ? BadgeStyle::new()->withBgColor('#AAAAAA') : BadgeStyle::new()->withBgColor('#123456'); });
         self::assertSame('<span class="badge text-light" style="background-color:#123456;">a</span>', (string) $this->configure($field)->getFormattedValue());
 
-        $field->setValue([1, 3])->renderAsBadges(function ($value) { return $value > 1 ? BadgeStyle::fromBgColor('#AAAAAA') : BadgeStyle::fromBgColor('#123456'); });
+        $field->setValue([1, 3])->renderAsBadges(function ($value) { return $value > 1 ? BadgeStyle::new()->withBgColor('#AAAAAA') : BadgeStyle::new()->withBgColor('#123456'); });
         self::assertSame('<span class="badge text-light" style="background-color:#123456;">a</span><span class="badge text-dark" style="background-color:#AAAAAA;">c</span>', (string) $this->configure($field)->getFormattedValue());
     }
 }