Added width to StyleInterface

README.md

@@ -4,7 +4,26 @@ Spinners for the console.
 
 ## Install
 
-Install using composer.
+Recommended is to install using composer. Add the repository to your global 
+`~/.config/composer/config.json` file:
+
+```
+{
+  "repositories": [
+    {
+      "type": "composer",
+      "url": "https://dev.noccylabs.info/api/packages/noccy/composer"
+    }
+  ]
+}
+```
+
+Then add the package as a dependency:
+
+```
+$ composer require noccylabs/spinner
+```
+
 
 ## Usage
 
@@ -32,3 +51,11 @@ while(true) {
     usleep(10000);
 }
 ```
+
+### Included styles
+
+Style | Width | Notes
+---|---|---
+`BrailleDotStyle` | 1 | A snake chasing its tail, new "docker compose" style
+`RollingBallStyle` | 1 | A rolling ball, "symfony new" style
+`SpinnerStyle` | 2 | four-part spinner, 2 characters wide

examples/example.php

@@ -19,10 +19,19 @@ $spinner7 = new Spinner(fps:5);
 $spinner8 = new Spinner(fps:10);
 $spinner9 = new Spinner(fps:20);
 
+$spinner10 = new Spinner(fps:10, style:NoccyLabs\Spinner\Style\SpinningBarStyle::class);
+
+$spinner11 = new Spinner(fps:10, style:NoccyLabs\Spinner\Style\BrailleBounceStyle::class);
+
+$spinner12 = new Spinner(fps:10, style:NoccyLabs\Spinner\Style\BrailleTallDotsStyle::class);
+
+$spinner13 = new Spinner(fps:10, style:NoccyLabs\Spinner\Style\BrailleWideDotsStyle::class);
+
+$spinner14 = new Spinner(fps:20, style:NoccyLabs\Spinner\Style\BrailleWideSpinnerStyle::class);
 
 // And blast them out every 10ms!
 while(true) {
-    echo "\r $spinner1 $spinner2 $spinner3 $spinner4 $spinner5 $spinner6 $spinner7 $spinner8 $spinner9 ";
+    echo "\r $spinner1 $spinner2 $spinner3 $spinner4 $spinner5 $spinner6 $spinner7 $spinner8 $spinner9 $spinner10 $spinner11 $spinner12 $spinner13 $spinner14";
     usleep(10000);
 }
 

src/Style/BrailleBounceStyle.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace NoccyLabs\Spinner\Style;
+
+class BrailleBounceStyle implements StyleInterface
+{
+    public function getFrames(): array
+    {
+        return [
+            mb_chr(0x2809),
+            mb_chr(0x2812),
+            mb_chr(0x2824),
+            mb_chr(0x28c0),
+            mb_chr(0x2824),
+            mb_chr(0x2812),
+        ];
+    }
+
+    public function getWidth(): int
+    {
+        return 1;
+    }
+}

src/Style/BrailleDotsStyle.php

@@ -15,4 +15,9 @@ class BrailleDotsStyle implements StyleInterface
             mb_chr(0x281b),
         ];
     }
+
+    public function getWidth(): int
+    {
+        return 1;
+    }
 }

src/Style/BrailleTallDotsStyle.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace NoccyLabs\Spinner\Style;
+
+class BrailleTallDotsStyle implements StyleInterface
+{
+    public function getFrames(): array
+    {
+        return [
+            mb_chr(0x2839),
+            mb_chr(0x28b0),
+            mb_chr(0x28f0),
+            mb_chr(0x28e4),
+            mb_chr(0x28c6),
+            mb_chr(0x2847),
+            mb_chr(0x280f),
+            mb_chr(0x281b),
+        ];
+    }
+
+    public function getWidth(): int
+    {
+        return 1;
+    }
+}
+
+/*
+         | xxx0 xxx1 xxx2 xxx3 xxx4 xxx5 xxx6 xxx7 xxx8 xxx9 xxxA xxxB xxxC xxxD xxxE xxxF
+    280x |  ⠀    ⠁    ⠂    ⠃    ⠄    ⠅    ⠆    ⠇    ⠈    ⠉    ⠊    ⠋    ⠌    ⠍    ⠎    ⠏   
+    281x |  ⠐    ⠑    ⠒    ⠓    ⠔    ⠕    ⠖    ⠗    ⠘    ⠙    ⠚    ⠛    ⠜    ⠝    ⠞    ⠟   
+    282x |  ⠠    ⠡    ⠢    ⠣    ⠤    ⠥    ⠦    ⠧    ⠨    ⠩    ⠪    ⠫    ⠬    ⠭    ⠮    ⠯   
+    283x |  ⠰    ⠱    ⠲    ⠳    ⠴    ⠵    ⠶    ⠷    ⠸    ⠹    ⠺    ⠻    ⠼    ⠽    ⠾    ⠿   
+    284x |  ⡀    ⡁    ⡂    ⡃    ⡄    ⡅    ⡆    ⡇    ⡈    ⡉    ⡊    ⡋    ⡌    ⡍    ⡎    ⡏   
+    285x |  ⡐    ⡑    ⡒    ⡓    ⡔    ⡕    ⡖    ⡗    ⡘    ⡙    ⡚    ⡛    ⡜    ⡝    ⡞    ⡟   
+    286x |  ⡠    ⡡    ⡢    ⡣    ⡤    ⡥    ⡦    ⡧    ⡨    ⡩    ⡪    ⡫    ⡬    ⡭    ⡮    ⡯   
+    287x |  ⡰    ⡱    ⡲    ⡳    ⡴    ⡵    ⡶    ⡷    ⡸    ⡹    ⡺    ⡻    ⡼    ⡽    ⡾    ⡿   
+    288x |  ⢀    ⢁    ⢂    ⢃    ⢄    ⢅    ⢆    ⢇    ⢈    ⢉    ⢊    ⢋    ⢌    ⢍    ⢎    ⢏   
+    289x |  ⢐    ⢑    ⢒    ⢓    ⢔    ⢕    ⢖    ⢗    ⢘    ⢙    ⢚    ⢛    ⢜    ⢝    ⢞    ⢟   
+    28Ax |  ⢠    ⢡    ⢢    ⢣    ⢤    ⢥    ⢦    ⢧    ⢨    ⢩    ⢪    ⢫    ⢬    ⢭    ⢮    ⢯   
+    28Bx |  ⢰    ⢱    ⢲    ⢳    ⢴    ⢵    ⢶    ⢷    ⢸    ⢹    ⢺    ⢻    ⢼    ⢽    ⢾    ⢿   
+    28Cx |  ⣀    ⣁    ⣂    ⣃    ⣄    ⣅    ⣆    ⣇    ⣈    ⣉    ⣊    ⣋    ⣌    ⣍    ⣎    ⣏   
+    28Dx |  ⣐    ⣑    ⣒    ⣓    ⣔    ⣕    ⣖    ⣗    ⣘    ⣙    ⣚    ⣛    ⣜    ⣝    ⣞    ⣟   
+    28Ex |  ⣠    ⣡    ⣢    ⣣    ⣤    ⣥    ⣦    ⣧    ⣨    ⣩    ⣪    ⣫    ⣬    ⣭    ⣮    ⣯   
+    28Fx |  ⣰    ⣱    ⣲    ⣳    ⣴    ⣵    ⣶    ⣷    ⣸    ⣹    ⣺    ⣻    ⣼    ⣽    ⣾    ⣿   
+
+
+*/

src/Style/BrailleWideDotsStyle.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace NoccyLabs\Spinner\Style;
+
+class BrailleWideDotsStyle implements StyleInterface
+{
+    public function getFrames(): array
+    {
+        return [
+            " ⠹",
+            " ⢸",
+            " ⣰",
+            "⢀⣠",
+            "⣀⣀",
+            "⣄ ",
+            "⣆⡀",
+            "⡇ ",
+            "⠏ ",
+            "⠋⠁",
+            "⠉⠉",
+            "⠈⠙",
+        ];
+    }
+
+    public function getWidth(): int
+    {
+        return 2;
+    }
+}
+
+/*
+         | xxx0 xxx1 xxx2 xxx3 xxx4 xxx5 xxx6 xxx7 xxx8 xxx9 xxxA xxxB xxxC xxxD xxxE xxxF
+    280x |  ⠀    ⠁    ⠂    ⠃    ⠄    ⠅    ⠆    ⠇    ⠈    ⠉    ⠊    ⠋    ⠌    ⠍    ⠎    ⠏   
+    281x |  ⠐    ⠑    ⠒    ⠓    ⠔    ⠕    ⠖    ⠗    ⠘    ⠙    ⠚    ⠛    ⠜    ⠝    ⠞    ⠟   
+    282x |  ⠠    ⠡    ⠢    ⠣    ⠤    ⠥    ⠦    ⠧    ⠨    ⠩    ⠪    ⠫    ⠬    ⠭    ⠮    ⠯   
+    283x |  ⠰    ⠱    ⠲    ⠳    ⠴    ⠵    ⠶    ⠷    ⠸    ⠹    ⠺    ⠻    ⠼    ⠽    ⠾    ⠿   
+    284x |  ⡀    ⡁    ⡂    ⡃    ⡄    ⡅    ⡆    ⡇    ⡈    ⡉    ⡊    ⡋    ⡌    ⡍    ⡎    ⡏   
+    285x |  ⡐    ⡑    ⡒    ⡓    ⡔    ⡕    ⡖    ⡗    ⡘    ⡙    ⡚    ⡛    ⡜    ⡝    ⡞    ⡟   
+    286x |  ⡠    ⡡    ⡢    ⡣    ⡤    ⡥    ⡦    ⡧    ⡨    ⡩    ⡪    ⡫    ⡬    ⡭    ⡮    ⡯   
+    287x |  ⡰    ⡱    ⡲    ⡳    ⡴    ⡵    ⡶    ⡷    ⡸    ⡹    ⡺    ⡻    ⡼    ⡽    ⡾    ⡿   
+    288x |  ⢀    ⢁    ⢂    ⢃    ⢄    ⢅    ⢆    ⢇    ⢈    ⢉    ⢊    ⢋    ⢌    ⢍    ⢎    ⢏   
+    289x |  ⢐    ⢑    ⢒    ⢓    ⢔    ⢕    ⢖    ⢗    ⢘    ⢙    ⢚    ⢛    ⢜    ⢝    ⢞    ⢟   
+    28Ax |  ⢠    ⢡    ⢢    ⢣    ⢤    ⢥    ⢦    ⢧    ⢨    ⢩    ⢪    ⢫    ⢬    ⢭    ⢮    ⢯   
+    28Bx |  ⢰    ⢱    ⢲    ⢳    ⢴    ⢵    ⢶    ⢷    ⢸    ⢹    ⢺    ⢻    ⢼    ⢽    ⢾    ⢿   
+    28Cx |  ⣀    ⣁    ⣂    ⣃    ⣄    ⣅    ⣆    ⣇    ⣈    ⣉    ⣊    ⣋    ⣌    ⣍    ⣎    ⣏   
+    28Dx |  ⣐    ⣑    ⣒    ⣓    ⣔    ⣕    ⣖    ⣗    ⣘    ⣙    ⣚    ⣛    ⣜    ⣝    ⣞    ⣟   
+    28Ex |  ⣠    ⣡    ⣢    ⣣    ⣤    ⣥    ⣦    ⣧    ⣨    ⣩    ⣪    ⣫    ⣬    ⣭    ⣮    ⣯   
+    28Fx |  ⣰    ⣱    ⣲    ⣳    ⣴    ⣵    ⣶    ⣷    ⣸    ⣹    ⣺    ⣻    ⣼    ⣽    ⣾    ⣿   
+
+
+*/

src/Style/BrailleWideSpinnerStyle.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace NoccyLabs\Spinner\Style;
+
+class BrailleWideSpinnerStyle implements StyleInterface
+{
+    public function getFrames(): array
+    {
+        return [
+            " ⠒",
+            " ⠤",
+            " ⢄",
+            " ⡄",
+            "⢠ ",
+            "⡠ ",
+            "⠤ ",
+            "⠒ ",
+            "⠑ ",
+            "⠘ ",
+            " ⠃",
+            " ⠊",
+        ];
+    }
+
+    public function getWidth(): int
+    {
+        return 2;
+    }
+}
+
+/*
+         | xxx0 xxx1 xxx2 xxx3 xxx4 xxx5 xxx6 xxx7 xxx8 xxx9 xxxA xxxB xxxC xxxD xxxE xxxF
+    280x |  ⠀    ⠁    ⠂    ⠃    ⠄    ⠅    ⠆    ⠇    ⠈    ⠉    ⠊    ⠋    ⠌    ⠍    ⠎    ⠏   
+    281x |  ⠐    ⠑    ⠒    ⠓    ⠔    ⠕    ⠖    ⠗    ⠘    ⠙    ⠚    ⠛    ⠜    ⠝    ⠞    ⠟   
+    282x |  ⠠    ⠡    ⠢    ⠣    ⠤    ⠥    ⠦    ⠧    ⠨    ⠩    ⠪    ⠫    ⠬    ⠭    ⠮    ⠯   
+    283x |  ⠰    ⠱    ⠲    ⠳    ⠴    ⠵    ⠶    ⠷    ⠸    ⠹    ⠺    ⠻    ⠼    ⠽    ⠾    ⠿   
+    284x |  ⡀    ⡁    ⡂    ⡃    ⡄    ⡅    ⡆    ⡇    ⡈    ⡉    ⡊    ⡋    ⡌    ⡍    ⡎    ⡏   
+    285x |  ⡐    ⡑    ⡒    ⡓    ⡔    ⡕    ⡖    ⡗    ⡘    ⡙    ⡚    ⡛    ⡜    ⡝    ⡞    ⡟   
+    286x |  ⡠    ⡡    ⡢    ⡣    ⡤    ⡥    ⡦    ⡧    ⡨    ⡩    ⡪    ⡫    ⡬    ⡭    ⡮    ⡯   
+    287x |  ⡰    ⡱    ⡲    ⡳    ⡴    ⡵    ⡶    ⡷    ⡸    ⡹    ⡺    ⡻    ⡼    ⡽    ⡾    ⡿   
+    288x |  ⢀    ⢁    ⢂    ⢃    ⢄    ⢅    ⢆    ⢇    ⢈    ⢉    ⢊    ⢋    ⢌    ⢍    ⢎    ⢏   
+    289x |  ⢐    ⢑    ⢒    ⢓    ⢔    ⢕    ⢖    ⢗    ⢘    ⢙    ⢚    ⢛    ⢜    ⢝    ⢞    ⢟   
+    28Ax |  ⢠    ⢡    ⢢    ⢣    ⢤    ⢥    ⢦    ⢧    ⢨    ⢩    ⢪    ⢫    ⢬    ⢭    ⢮    ⢯   
+    28Bx |  ⢰    ⢱    ⢲    ⢳    ⢴    ⢵    ⢶    ⢷    ⢸    ⢹    ⢺    ⢻    ⢼    ⢽    ⢾    ⢿   
+    28Cx |  ⣀    ⣁    ⣂    ⣃    ⣄    ⣅    ⣆    ⣇    ⣈    ⣉    ⣊    ⣋    ⣌    ⣍    ⣎    ⣏   
+    28Dx |  ⣐    ⣑    ⣒    ⣓    ⣔    ⣕    ⣖    ⣗    ⣘    ⣙    ⣚    ⣛    ⣜    ⣝    ⣞    ⣟   
+    28Ex |  ⣠    ⣡    ⣢    ⣣    ⣤    ⣥    ⣦    ⣧    ⣨    ⣩    ⣪    ⣫    ⣬    ⣭    ⣮    ⣯   
+    28Fx |  ⣰    ⣱    ⣲    ⣳    ⣴    ⣵    ⣶    ⣷    ⣸    ⣹    ⣺    ⣻    ⣼    ⣽    ⣾    ⣿   
+
+
+*/

src/Style/RollingBallStyle.php

@@ -13,4 +13,9 @@ class RollingBallStyle implements StyleInterface
             mb_chr(0x25d2),
         ];
     }
+
+    public function getWidth(): int
+    {
+        return 1;
+    }
 }

src/Style/SpinnerStyle.php

@@ -13,4 +13,9 @@ class SpinnerStyle implements StyleInterface
             mb_chr(0x25df).' ',
         ];
     }
+
+    public function getWidth(): int
+    {
+        return 2;
+    }
 }

src/Style/SpinningBarStyle.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace NoccyLabs\Spinner\Style;
+
+class SpinningBarStyle implements StyleInterface
+{
+    public function getFrames(): array
+    {
+        return [
+            "/",
+            "-",
+            "\\",
+            "|",
+        ];
+    }
+
+    public function getWidth(): int
+    {
+        return 1;
+    }
+}

src/Style/StyleInterface.php

@@ -4,5 +4,13 @@ namespace NoccyLabs\Spinner\Style;
 
 interface StyleInterface
 {
+    /**
+     * Returns an array of frames used to render the spinner
+     */
     public function getFrames(): array;
+
+    /**
+     * Get the width of this spinner in characters
+     */
+    public function getWidth(): int;
 }