Random Bg color. Fixes #32

Author: LasseRafn

src/InitialAvatar.php

@@ -40,6 +40,7 @@ class InitialAvatar
     protected $fontName = 'OpenSans, sans-serif';
     protected $generated_initials = 'JD';
     protected $preferBold = false;
+    protected $randomBgColor = false;
 
     /**
      * Language eg.en zh-CN.
@@ -202,9 +203,31 @@ public function preferRegular()
     public function background($background)
     {
         $this->bgColor = (string) $background;
+        $this->randomBgColor = false;
 
         return $this;
     }
+    
+    /**
+     * Set background color to be randomly generated for each avatar.
+     * 
+     * @param bool $random
+     * @param int $saturation Saturation value (0-100)
+     * @param int $luminance Luminance value (0-100)
+     * 
+     * @return $this
+     */
+    public function randomBackground($random = true, int $saturation = 85, int $luminance = 60)
+    {
+        $this->randomBgColor = (bool) $random;
+        
+        if ($random) {
+            // Generate an initial random color
+            $this->generateRandomColor($saturation, $luminance);
+        }
+        
+        return $this;
+    }
 
     /**
      * Set the font color.
@@ -437,13 +460,29 @@ public function getInitials()
 
     /**
      * Will return the background color parameter.
+     * If randomBgColor is enabled, generates a new random color each time.
      *
      * @return string
      */
     public function getBackgroundColor()
     {
+        if ($this->randomBgColor) {
+            // Generate a new random color each time this method is called
+            $this->generateRandomColor();
+        }
+        
         return $this->bgColor;
     }
+    
+    /**
+     * Will return whether random background color is enabled.
+     *
+     * @return bool
+     */
+    public function getRandomBackgroundColor()
+    {
+        return $this->randomBgColor;
+    }
 
     /**
      * Will return the set driver.
@@ -921,4 +960,26 @@ protected function getContrastColor($hexColor)
             return '#FFFFFF';
         }
     }
+    
+    /**
+     * Generate a random background color.
+     * 
+     * @param int $saturation Saturation value (0-100)
+     * @param int $luminance Luminance value (0-100)
+     * 
+     * @return string The generated hex color
+     */
+    protected function generateRandomColor(int $saturation = 85, int $luminance = 60)
+    {
+        // Generate a random hue (0-1)
+        $hue = mt_rand(0, 359) / 360;
+        $saturation /= 100;
+        $luminance /= 100;
+        
+        $hexColor = $this->convertHSLtoRGB($hue, $saturation, $luminance);
+        $this->bgColor = $hexColor;
+        $this->fontColor = $this->getContrastColor($hexColor);
+        
+        return $hexColor;
+    }
 }

tests/RandomBackgroundTest.php

@@ -0,0 +1,69 @@
+<?php
+
+use LasseRafn\InitialAvatarGenerator\InitialAvatar;
+use PHPUnit\Framework\TestCase;
+
+class RandomBackgroundTest extends TestCase
+{
+    /** @test */
+    public function it_generates_random_background_colors()
+    {
+        $avatar = new InitialAvatar();
+        $avatar->randomBackground(true);
+        
+        // Verify random background is enabled
+        $this->assertTrue($avatar->getRandomBackgroundColor());
+        
+        // Get first color
+        $firstColor = $avatar->getBackgroundColor();
+        
+        // Get second color - should be different
+        $secondColor = $avatar->getBackgroundColor();
+        
+        // Colors should be different due to random generation
+        $this->assertNotEquals($firstColor, $secondColor);
+        
+        // Disable random background
+        $avatar->randomBackground(false);
+        $this->assertFalse($avatar->getRandomBackgroundColor());
+        
+        // Set fixed background
+        $fixedColor = '#123456';
+        $avatar->background($fixedColor);
+        
+        // Get color multiple times - should be the same
+        $this->assertEquals($fixedColor, $avatar->getBackgroundColor());
+        $this->assertEquals($fixedColor, $avatar->getBackgroundColor());
+    }
+    
+    /** @test */
+    public function it_generates_different_avatars_with_random_background()
+    {
+        $avatar = new InitialAvatar();
+        $avatar->randomBackground(true);
+        
+        // Generate two avatars
+        $firstAvatar = $avatar->generate('Test User');
+        $firstBgColor = $avatar->getBackgroundColor();
+        
+        $secondAvatar = $avatar->generate('Test User');
+        $secondBgColor = $avatar->getBackgroundColor();
+        
+        // Background colors should be different
+        $this->assertNotEquals($firstBgColor, $secondBgColor);
+        
+        // SVG test
+        $avatar = new InitialAvatar();
+        $avatar->randomBackground(true);
+        
+        // Generate two SVG avatars
+        $firstSvg = $avatar->generateSvg('Test User');
+        $firstSvgBgColor = $avatar->getBackgroundColor();
+        
+        $secondSvg = $avatar->generateSvg('Test User');
+        $secondSvgBgColor = $avatar->getBackgroundColor();
+        
+        // Background colors should be different
+        $this->assertNotEquals($firstSvgBgColor, $secondSvgBgColor);
+    }
+}