Merge branch 'prepare-next'

alecrabbit · alecrabbit · commit d05a8606f41b · 2023-12-04T16:50:52.000+02:00
diff --git a/.tools/.report/.build/coverage.txt b/.tools/.report/.build/coverage.txt
@@ -2,6 +2,6 @@
 
 Code Coverage Report Summary: 
   Classes: 100.00% (207/207)  
-  Methods: 100.00% (737/737)  
-  Lines:   100.00% (3718/3718)
+  Methods: 100.00% (736/736)  
+  Lines:   100.00% (3715/3715)
 
diff --git a/.tools/.report/.deptrac/.deptrac.report b/.tools/.report/.deptrac/.deptrac.report
@@ -5,7 +5,7 @@
   Violations           0     
   Skipped violations   0     
   Uncovered            177   
-  Allowed              2543  
+  Allowed              2545  
   Warnings             0     
   Errors               0     
  -------------------- ------ 
diff --git a/.tools/.report/.phploc/.src.phploc.report b/.tools/.report/.phploc/.src.phploc.report
@@ -4,11 +4,11 @@ Directories                                         77
 Files                                              419
 
 Size
-  Lines of Code (LOC)                            13578
-  Comment Lines of Code (CLOC)                     739 (5.44%)
-  Non-Comment Lines of Code (NCLOC)              12839 (94.56%)
-  Logical Lines of Code (LLOC)                    1419 (10.45%)
-    Classes                                       1318 (92.88%)
+  Lines of Code (LOC)                            13573
+  Comment Lines of Code (CLOC)                     737 (5.43%)
+  Non-Comment Lines of Code (NCLOC)              12836 (94.57%)
+  Logical Lines of Code (LLOC)                    1418 (10.45%)
+    Classes                                       1317 (92.88%)
       Average Class Length                           3
         Minimum Class Length                         0
         Maximum Class Length                        27
@@ -36,12 +36,12 @@ Dependencies
     Global Constants                                 0 (0.00%)
     Global Variables                                 0 (0.00%)
     Super-Global Variables                           0 (0.00%)
-  Attribute Accesses                               604
-    Non-Static                                     588 (97.35%)
+  Attribute Accesses                               603
+    Non-Static                                     587 (97.35%)
     Static                                          16 (2.65%)
-  Method Calls                                     758
-    Non-Static                                     681 (89.84%)
-    Static                                          77 (10.16%)
+  Method Calls                                     755
+    Non-Static                                     678 (89.80%)
+    Static                                          77 (10.20%)
 
 Structure
   Namespaces                                        77
@@ -52,14 +52,14 @@ Structure
     Concrete Classes                               191 (93.17%)
       Final Classes                                 70 (36.65%)
       Non-Final Classes                            121 (63.35%)
-  Methods                                          968
+  Methods                                          969
     Scope
-      Non-Static Methods                           903 (93.29%)
+      Non-Static Methods                           904 (93.29%)
       Static Methods                                65 (6.71%)
     Visibility
-      Public Methods                               763 (78.82%)
-      Protected Methods                             64 (6.61%)
-      Private Methods                              141 (14.57%)
+      Public Methods                               764 (78.84%)
+      Protected Methods                             64 (6.60%)
+      Private Methods                              141 (14.55%)
   Functions                                         37
     Named Functions                                  7 (18.92%)
     Anonymous Functions                             30 (81.08%)
diff --git a/.tools/.report/.phploc/.test.phploc.report b/.tools/.report/.phploc/.test.phploc.report
@@ -4,11 +4,11 @@ Directories                                         74
 Files                                              273
 
 Size
-  Lines of Code (LOC)                            30544
+  Lines of Code (LOC)                            30609
   Comment Lines of Code (CLOC)                     458 (1.50%)
-  Non-Comment Lines of Code (NCLOC)              30086 (98.50%)
-  Logical Lines of Code (LLOC)                    6687 (21.89%)
-    Classes                                       6679 (99.88%)
+  Non-Comment Lines of Code (NCLOC)              30151 (98.50%)
+  Logical Lines of Code (LLOC)                    6711 (21.92%)
+    Classes                                       6703 (99.88%)
       Average Class Length                          24
         Minimum Class Length                         0
         Maximum Class Length                       871
@@ -24,7 +24,7 @@ Size
 
 Cyclomatic Complexity
   Average Complexity per LLOC                     0.07
-  Average Complexity per Class                    2.60
+  Average Complexity per Class                    2.59
     Minimum Class Complexity                      1.00
     Maximum Class Complexity                     16.00
   Average Complexity per Method                   1.26
@@ -39,9 +39,9 @@ Dependencies
   Attribute Accesses                                28
     Non-Static                                      23 (82.14%)
     Static                                           5 (17.86%)
-  Method Calls                                    9132
-    Non-Static                                    5989 (65.58%)
-    Static                                        3143 (34.42%)
+  Method Calls                                    9164
+    Non-Static                                    6009 (65.57%)
+    Static                                        3155 (34.43%)
 
 Structure
   Namespaces                                        74
@@ -52,14 +52,14 @@ Structure
     Concrete Classes                               266 (98.52%)
       Final Classes                                248 (93.23%)
       Non-Final Classes                             18 (6.77%)
-  Methods                                         1724
+  Methods                                         1726
     Scope
-      Non-Static Methods                          1616 (93.74%)
+      Non-Static Methods                          1618 (93.74%)
       Static Methods                               108 (6.26%)
     Visibility
-      Public Methods                              1036 (60.09%)
-      Protected Methods                            313 (18.16%)
-      Private Methods                              375 (21.75%)
+      Public Methods                              1038 (60.14%)
+      Protected Methods                            313 (18.13%)
+      Private Methods                              375 (21.73%)
   Functions                                         90
     Named Functions                                  2 (2.22%)
     Anonymous Functions                             88 (97.78%)
diff --git a/doc/usage.md b/doc/usage.md
@@ -24,7 +24,7 @@ $driver = \AlecRabbit\Spinner\Facade::getDriver();
 
 while (true) {
     $driver->render();
-    usleep(100000);
+    // do some work 
 }
 ```
 
@@ -49,13 +49,7 @@ class Dots extends ACharPalette {
     protected function sequence(): Traversable
     {
         // note the width of each element
-        $a = ['   ', '.  ', '.. ', '...', ' ..', '  .', '   ']; 
-
-        if ($this->options->getReversed()) {
-            $a = array_reverse($a);
-        }
-
-        yield from $a;
+        yield from ['   ', '.  ', '.. ', '...', ' ..', '  .', '   ']; 
     }
 }
 ```
@@ -67,7 +61,7 @@ class Greeny extends AStylePalette {
     protected function ansi4StyleFrames(): Traversable
     {
         yield from [
-            $this->createFrame("\e[92m%s\e[39m"),
+            $this->createFrame("\e[92m%s\e[39m"), // note the ANSI codes
         ];
     }
 
diff --git a/example/async/bootstrap.async.php b/example/async/bootstrap.async.php
@@ -29,10 +29,7 @@ static function (IContainer $container): IDriverLinker {
         },
         IServiceDefinition::SINGLETON,
     ),
-);
-
-// Register driver linker with output factory
-$registry->bind(
+    // Register driver linker decorator factory
     new ServiceDefinition(IDriverLinkerDecoratorFactory::class, DriverLinkerDecoratorFactory::class),
 );
 
diff --git a/example/benchmark/container.php b/example/benchmark/container.php
@@ -45,32 +45,28 @@
 
 $registry = DefinitionRegistry::getInstance();
 
-$registry->bind(new ServiceDefinition(ITimer::class, new MicrosecondTimer()));
-$registry->bind(new ServiceDefinition(IDriverProviderFactory::class, BenchmarkingDriverProviderFactory::class));
-$registry->bind(new ServiceDefinition(IResultMaker::class, ResultMaker::class));
-$registry->bind(new ServiceDefinition(IBenchmarkResultsFactory::class, BenchmarkResultsFactory::class));
-$registry->bind(new ServiceDefinition(IBenchmarkingDriverFactory::class, BenchmarkingDriverFactory::class));
-$registry->bind(new ServiceDefinition(IBenchmarkingDriverBuilder::class, BenchmarkingDriverBuilder::class));
-$registry->bind(new ServiceDefinition(IBenchmarkFactory::class, BenchmarkFactory::class));
-$registry->bind(new ServiceDefinition(IMeasurementFactory::class, MeasurementFactory::class));
-$registry->bind(new ServiceDefinition(IStopwatchBuilder::class, StopwatchBuilder::class));
-$registry->bind(new ServiceDefinition(IStopwatchFactory::class, StopwatchFactory::class));
-$registry->bind(new ServiceDefinition(IReportPrinterBuilder::class, ReportPrinterBuilder::class));
-$registry->bind(new ServiceDefinition(IReportFormatter::class, ReportFormatter::class));
-$registry->bind(new ServiceDefinition(IDatetimeFormatter::class, DatetimeFormatter::class));
-$registry->bind(new ServiceDefinition(IResultFormatter::class, ResultFormatter::class));
-$registry->bind(new ServiceDefinition(IKeyFormatter::class, KeyFormatter::class));
-
 $registry->bind(
+    new ServiceDefinition(ITimer::class, new MicrosecondTimer()),
+    new ServiceDefinition(IDriverProviderFactory::class, BenchmarkingDriverProviderFactory::class),
+    new ServiceDefinition(IResultMaker::class, ResultMaker::class),
+    new ServiceDefinition(IBenchmarkResultsFactory::class, BenchmarkResultsFactory::class),
+    new ServiceDefinition(IBenchmarkingDriverFactory::class, BenchmarkingDriverFactory::class),
+    new ServiceDefinition(IBenchmarkingDriverBuilder::class, BenchmarkingDriverBuilder::class),
+    new ServiceDefinition(IBenchmarkFactory::class, BenchmarkFactory::class),
+    new ServiceDefinition(IMeasurementFactory::class, MeasurementFactory::class),
+    new ServiceDefinition(IStopwatchBuilder::class, StopwatchBuilder::class),
+    new ServiceDefinition(IStopwatchFactory::class, StopwatchFactory::class),
+    new ServiceDefinition(IReportPrinterBuilder::class, ReportPrinterBuilder::class),
+    new ServiceDefinition(IReportFormatter::class, ReportFormatter::class),
+    new ServiceDefinition(IDatetimeFormatter::class, DatetimeFormatter::class),
+    new ServiceDefinition(IResultFormatter::class, ResultFormatter::class),
+    new ServiceDefinition(IKeyFormatter::class, KeyFormatter::class),
     new ServiceDefinition(
         IReportPrinter::class,
         static function (ContainerInterface $container): IReportPrinter {
             return $container->get(IReportPrinterFactory::class)->create();
         }
     ),
-);
-
-$registry->bind(
     new ServiceDefinition(
         IReportPrinterFactory::class,
         static function (ContainerInterface $container): IReportPrinterFactory {
diff --git a/example/benchmark/container.sync.php b/example/benchmark/container.sync.php
@@ -22,9 +22,6 @@ public function write(Traversable $data): void
             }
         }
     ),
-);
-
-$registry->bind(
     new ServiceDefinition(
         IDeltaTimer::class,
         new class() implements IDeltaTimer {
diff --git a/src/Spinner/Container/Contract/IDefinitionRegistry.php b/src/Spinner/Container/Contract/IDefinitionRegistry.php
@@ -13,5 +13,5 @@ interface IDefinitionRegistry
      */
     public function load(): Traversable;
 
-    public function bind(IServiceDefinition $serviceDefinition): void;
+    public function bind(IServiceDefinition ...$serviceDefinitions): void;
 }
diff --git a/src/Spinner/Container/DefinitionRegistry.php b/src/Spinner/Container/DefinitionRegistry.php
@@ -36,8 +36,10 @@ public function load(): Traversable
         yield from $this->definitions;
     }
 
-    public function bind(IServiceDefinition $serviceDefinition): void
+    public function bind(IServiceDefinition ...$serviceDefinitions): void
     {
-        $this->definitions->offsetSet($serviceDefinition->getId(), $serviceDefinition);
+        foreach ($serviceDefinitions as $serviceDefinition) {
+            $this->definitions->offsetSet($serviceDefinition->getId(), $serviceDefinition);
+        }
     }
 }
diff --git a/src/Spinner/Core/Palette/A/ACharPalette.php b/src/Spinner/Core/Palette/A/ACharPalette.php
@@ -18,25 +18,18 @@ abstract class ACharPalette extends APalette implements ICharPalette
      */
     protected function getEntries(?IPaletteMode $mode = null): Traversable
     {
-        /** @var string $element */
-        foreach ($this->getSequence() as $element) {
+        /** @var string|ICharFrame $element */
+        foreach ($this->sequence() as $element) {
+            if ($element instanceof ICharFrame) {
+                yield $element;
+                continue;
+            }
             yield $this->createFrame($element);
         }
     }
 
-    protected function getSequence(): Traversable
-    {
-        $sequence = $this->sequence();
-
-        if ($this->options->getReversed()) {
-            $sequence = array_reverse(iterator_to_array($sequence));
-        }
-
-        yield from $sequence;
-    }
-
     /**
-     * @return Traversable<string>
+     * @return Traversable<string|ICharFrame>
      */
     abstract protected function sequence(): Traversable;
 
diff --git a/src/Spinner/Core/Palette/A/APalette.php b/src/Spinner/Core/Palette/A/APalette.php
@@ -20,6 +20,7 @@ public function __construct(
     ) {
     }
 
+    // FIXME (2023-12-04 16:9) [Alec Rabbit]: extract functionality to PaletteTemplateFactory->create($palette)
     public function getTemplate(?IPaletteMode $mode = null): IPaletteTemplate
     {
         return new PaletteTemplate(
diff --git a/src/Spinner/Core/Palette/A/AStylePalette.php b/src/Spinner/Core/Palette/A/AStylePalette.php
@@ -17,9 +17,11 @@ abstract class AStylePalette extends APalette implements IStylePalette
 {
     protected function getOptions(?IPaletteMode $mode = null): IPaletteOptions
     {
+        $interval = $this->options->getInterval() ?? $this->getInterval($this->extractStylingMode($mode));
+
         $this->options =
             new PaletteOptions(
-                interval: $this->options->getInterval() ?? $this->getInterval($this->extractStylingMode($mode)),
+                interval: $interval,
                 reversed: $this->options->getReversed(),
             );
 
diff --git a/src/Spinner/Core/Palette/PaletteTemplate.php b/src/Spinner/Core/Palette/PaletteTemplate.php
@@ -29,11 +29,29 @@ public function __construct(
      */
     public function getEntries(): Traversable
     {
+        if ($this->options->getReversed()) {
+            return $this->reversed($this->entries);
+        }
         return $this->entries;
     }
 
     public function getOptions(): IPaletteOptions
     {
         return $this->options;
     }
+
+    /**
+     * @param Traversable<IFrame> $entries
+     * @return Traversable<IFrame>
+     */
+    private function reversed(Traversable $entries): Traversable
+    {
+        $sequence = [];
+
+        foreach ($entries as $entry) {
+            $sequence[] = $entry;
+        }
+
+        yield from array_reverse($sequence);
+    }
 }
diff --git a/src/Spinner/Core/Palette/Rainbow.php b/src/Spinner/Core/Palette/Rainbow.php
@@ -28,14 +28,8 @@ protected function ansi4StyleFrames(): Traversable
      */
     protected function ansi8StyleFrames(): Traversable
     {
-        $sequence = $this->ansi8Sequence();
-
-        if ($this->options->getReversed()) {
-            $sequence = $this->reverseSequence($sequence);
-        }
-
         /** @var string $item */
-        foreach ($sequence as $item) {
+        foreach ($this->ansi8Sequence() as $item) {
             $element = sprintf("\e[38;5;%sm%%s\e[39m", $item);
             yield $this->createFrame($element);
         }
@@ -79,35 +73,13 @@ private function ansi8Sequence(): Traversable
         ];
     }
 
-    /**
-     * @param Traversable<string> $sequence
-     *
-     * @return iterable<string>
-     */
-    private function reverseSequence(Traversable $sequence): iterable
-    {
-        /** @var array<string> $s */
-        $s = [];
-        /** @var string $item */
-        foreach ($sequence as $item) {
-            $s[] = $item;
-        }
-        return array_reverse($s);
-    }
-
     /**
      * @return Traversable<IStyleFrame>
      */
     protected function ansi24StyleFrames(): Traversable
     {
-        $sequence = $this->ansi24Sequence();
-
-        if ($this->options->getReversed()) {
-            $sequence = $this->reverseSequence($sequence);
-        }
-
         /** @var string $item */
-        foreach ($sequence as $item) {
+        foreach ($this->ansi24Sequence() as $item) {
             $element = sprintf("\e[38;2;%sm%%s\e[39m", $item);
             yield $this->createFrame($element);
         }
diff --git a/tests/Spinner/Complex/Config/SignalHandlingModeConfigTest.php b/tests/Spinner/Complex/Config/SignalHandlingModeConfigTest.php
diff --git a/tests/Spinner/Unit/Container/DefinitionRegistryTest.php b/tests/Spinner/Unit/Container/DefinitionRegistryTest.php
diff --git a/tests/Spinner/Unit/Core/Palette/A/ACharPaletteTest.php b/tests/Spinner/Unit/Core/Palette/A/ACharPaletteTest.php
diff --git a/tests/Spinner/Unit/Core/Palette/A/Override/ACharPaletteOverride.php b/tests/Spinner/Unit/Core/Palette/A/Override/ACharPaletteOverride.php
diff --git a/tests/TestCase/ContainerModifyingTestCase.php b/tests/TestCase/ContainerModifyingTestCase.php

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ $driver = \AlecRabbit\Spinner\Facade::getDriver();`
`24`	`24`
`25`	`25`	`while (true) {`
`26`	`26`	`$driver->render();`
`27`		`- usleep(100000);`
	`27`	`+ // do some work`
`28`	`28`	`}`
`29`	`29`	```
`30`	`30`
`@@ -49,13 +49,7 @@ class Dots extends ACharPalette {`
`49`	`49`	`protected function sequence(): Traversable`
`50`	`50`	`{`
`51`	`51`	`// note the width of each element`
`52`		`- $a = [' ', '. ', '.. ', '...', ' ..', ' .', ' '];`
`53`		`-`
`54`		`- if ($this->options->getReversed()) {`
`55`		`- $a = array_reverse($a);`
`56`		`- }`
`57`		`-`
`58`		`- yield from $a;`
	`52`	`+ yield from [' ', '. ', '.. ', '...', ' ..', ' .', ' '];`
`59`	`53`	`}`
`60`	`54`	`}`
`61`	`55`	```
`@@ -67,7 +61,7 @@ class Greeny extends AStylePalette {`
`67`	`61`	`protected function ansi4StyleFrames(): Traversable`
`68`	`62`	`{`
`69`	`63`	`yield from [`
`70`		`- $this->createFrame("\e[92m%s\e[39m"),`
	`64`	`+ $this->createFrame("\e[92m%s\e[39m"), // note the ANSI codes`
`71`	`65`	`];`
`72`	`66`	`}`
`73`	`67`
Original file line number	Diff line number	Diff line change
`@@ -22,9 +22,6 @@ public function write(Traversable $data): void`
`22`	`22`	`}`
`23`	`23`	`}`
`24`	`24`	`),`
`25`		`-);`
`26`		`-`
`27`		`-$registry->bind(`
`28`	`25`	`new ServiceDefinition(`
`29`	`26`	`IDeltaTimer::class,`
`30`	`27`	`new class() implements IDeltaTimer {`
Original file line number	Diff line number	Diff line change
`@@ -13,5 +13,5 @@ interface IDefinitionRegistry`
`13`	`13`	`*/`
`14`	`14`	`public function load(): Traversable;`
`15`	`15`
`16`		`- public function bind(IServiceDefinition $serviceDefinition): void;`
	`16`	`+ public function bind(IServiceDefinition ...$serviceDefinitions): void;`
`17`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,8 +36,10 @@ public function load(): Traversable`
`36`	`36`	`yield from $this->definitions;`
`37`	`37`	`}`
`38`	`38`
`39`		`- public function bind(IServiceDefinition $serviceDefinition): void`
	`39`	`+ public function bind(IServiceDefinition ...$serviceDefinitions): void`
`40`	`40`	`{`
`41`		`- $this->definitions->offsetSet($serviceDefinition->getId(), $serviceDefinition);`
	`41`	`+ foreach ($serviceDefinitions as $serviceDefinition) {`
	`42`	`+ $this->definitions->offsetSet($serviceDefinition->getId(), $serviceDefinition);`
	`43`	`+ }`
`42`	`44`	`}`
`43`	`45`	`}`