Renamed the acceptance and rejection bucket classes to expose their intent, bumped the version to 0.2

gplanchat · gplanchat · commit 7e5801e285f8 · 2021-05-21T08:43:10.000+02:00
diff --git a/composer.json b/composer.json
@@ -25,7 +25,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "0.1.x-dev"
+            "dev-master": "0.2.x-dev"
         }
     },
     "require-dev": {
diff --git a/composer.lock b/composer.lock
diff --git a/spec/AppendableIteratorAcceptanceResultBucketSpec.php b/spec/AppendableIteratorAcceptanceResultBucketSpec.php
@@ -2,16 +2,16 @@
 
 namespace spec\Kiboko\Component\Bucket;
 
-use Kiboko\Component\Bucket\AcceptanceAppendableResultBucket;
+use Kiboko\Component\Bucket\AppendableIteratorAcceptanceResultBucket;
 use Kiboko\Contract\Bucket\AcceptanceResultBucketInterface;
 use PhpSpec\ObjectBehavior;
 use Prophecy\Argument;
 
-class AcceptanceAppendableResultBucketSpec extends ObjectBehavior
+class AppendableIteratorAcceptanceResultBucketSpec extends ObjectBehavior
 {
     function it_is_initializable()
     {
-        $this->shouldHaveType(AcceptanceAppendableResultBucket::class);
+        $this->shouldHaveType(AppendableIteratorAcceptanceResultBucket::class);
         $this->shouldBeAnInstanceOf(AcceptanceResultBucketInterface::class);
     }
 
diff --git a/spec/AppendableIteratorRejectionResultBucketSpec.php b/spec/AppendableIteratorRejectionResultBucketSpec.php
@@ -2,16 +2,16 @@
 
 namespace spec\Kiboko\Component\Bucket;
 
-use Kiboko\Component\Bucket\RejectionAppendableResultBucket;
+use Kiboko\Component\Bucket\AppendableIteratorRejectionResultBucket;
 use Kiboko\Contract\Bucket\RejectionResultBucketInterface;
 use PhpSpec\ObjectBehavior;
 use Prophecy\Argument;
 
-class RejectionAppendableResultBucketSpec extends ObjectBehavior
+class AppendableIteratorRejectionResultBucketSpec extends ObjectBehavior
 {
     function it_is_initializable()
     {
-        $this->shouldHaveType(RejectionAppendableResultBucket::class);
+        $this->shouldHaveType(AppendableIteratorRejectionResultBucket::class);
         $this->shouldBeAnInstanceOf(RejectionResultBucketInterface::class);
     }
 
diff --git a/spec/IteratorAcceptanceResultBucketSpec.php b/spec/IteratorAcceptanceResultBucketSpec.php
@@ -2,18 +2,18 @@
 
 namespace spec\Kiboko\Component\Bucket;
 
-use Kiboko\Component\Bucket\AcceptanceIteratorResultBucket;
+use Kiboko\Component\Bucket\IteratorAcceptanceResultBucket;
 use Kiboko\Contract\Bucket\AcceptanceResultBucketInterface;
 use PhpSpec\ObjectBehavior;
 use Prophecy\Argument;
 
-class AcceptanceIteratorResultBucketSpec extends ObjectBehavior
+class IteratorAcceptanceResultBucketSpec extends ObjectBehavior
 {
     function it_is_initializable()
     {
         $this->beConstructedWith(new \EmptyIterator());
 
-        $this->shouldHaveType(AcceptanceIteratorResultBucket::class);
+        $this->shouldHaveType(IteratorAcceptanceResultBucket::class);
         $this->shouldBeAnInstanceOf(AcceptanceResultBucketInterface::class);
     }
 
diff --git a/spec/IteratorRejectionResultBucketSpec.php b/spec/IteratorRejectionResultBucketSpec.php
@@ -2,18 +2,18 @@
 
 namespace spec\Kiboko\Component\Bucket;
 
-use Kiboko\Component\Bucket\RejectionIteratorResultBucket;
+use Kiboko\Component\Bucket\IteratorRejectionResultBucket;
 use Kiboko\Contract\Bucket\RejectionResultBucketInterface;
 use PhpSpec\ObjectBehavior;
 use Prophecy\Argument;
 
-class RejectionIteratorResultBucketSpec extends ObjectBehavior
+class IteratorRejectionResultBucketSpec extends ObjectBehavior
 {
     function it_is_initializable()
     {
         $this->beConstructedWith(new \EmptyIterator());
 
-        $this->shouldHaveType(RejectionIteratorResultBucket::class);
+        $this->shouldHaveType(IteratorRejectionResultBucket::class);
         $this->shouldBeAnInstanceOf(RejectionResultBucketInterface::class);
     }
 
diff --git a/src/AcceptanceAppendableResultBucket.php b/src/AcceptanceAppendableResultBucket.php
@@ -1,31 +1,12 @@
 <?php
 
-namespace Kiboko\Component\Bucket;
-
-use Kiboko\Contract\Bucket\AcceptanceResultBucketInterface;
+declare(strict_types=1);
 
-final class AcceptanceAppendableResultBucket implements AcceptanceResultBucketInterface
-{
-    /** @var \AppendIterator */
-    private $iterator;
-
-    public function __construct(\Iterator ...$iterators)
-    {
-        $this->iterator = new \AppendIterator();
-        foreach ($iterators as $iterator) {
-            $this->iterator->append($iterator);
-        }
-    }
+namespace Kiboko\Component\Bucket;
 
-    public function append(\Iterator ...$iterators)
-    {
-        foreach ($iterators as $iterator) {
-            $this->iterator->append($iterator);
-        }
-    }
+trigger_deprecation('php-etl/bucket', '0.2', 'The "%s" class is deprecated, use "%s" instead.', 'Kiboko\\Component\\Bucket\\AcceptanceAppendableResultBucket', AppendableIteratorAcceptanceResultBucket::class);
 
-    public function walkAcceptance(): iterable
-    {
-        return $this->iterator;
-    }
-}
+/**
+ * @deprecated since Satellite 0.2, use Kiboko\Component\Bucket\AppendableIteratorAcceptanceResultBucket instead.
+ */
+class_alias(AppendableIteratorAcceptanceResultBucket::class, 'Kiboko\\Component\\Bucket\\AcceptanceAppendableResultBucket');
diff --git a/src/AcceptanceIteratorResultBucket.php b/src/AcceptanceIteratorResultBucket.php
@@ -1,24 +1,12 @@
 <?php
 
-namespace Kiboko\Component\Bucket;
-
-use Kiboko\Contract\Bucket\AcceptanceResultBucketInterface;
+declare(strict_types=1);
 
-final class AcceptanceIteratorResultBucket implements AcceptanceResultBucketInterface
-{
-    /** @var \Iterator */
-    private $iterator;
+namespace Kiboko\Component\Bucket;
 
-    /**
-     * @param \Iterator $iterator
-     */
-    public function __construct(\Iterator $iterator)
-    {
-        $this->iterator = $iterator;
-    }
+trigger_deprecation('php-etl/bucket', '0.2', 'The "%s" class is deprecated, use "%s" instead.', 'Kiboko\\Component\\Bucket\\AcceptanceIteratorResultBucket', IteratorAcceptanceResultBucket::class);
 
-    public function walkAcceptance(): iterable
-    {
-        return $this->iterator;
-    }
-}
+/**
+ * @deprecated since Satellite 0.2, use Kiboko\Component\Bucket\IteratorAcceptanceResultBucket instead.
+ */
+class_alias(IteratorAcceptanceResultBucket::class, 'Kiboko\\Component\\Bucket\\AcceptanceIteratorResultBucket');
diff --git a/src/AcceptanceResultBucket.php b/src/AcceptanceResultBucket.php
@@ -6,17 +6,27 @@
 
 final class AcceptanceResultBucket implements AcceptanceResultBucketInterface
 {
-    /** @var array<int, mixed> */
-    private $values;
+    /** @var array<mixed> */
+    private iterable $values;
 
     /**
-     * @param array<int, mixed> $values
+     * @param array<mixed> $values
      */
     public function __construct(...$values)
     {
         $this->values = $values;
     }
 
+    /**
+     * @param array<mixed> $values
+     */
+    public function accept(...$values): self
+    {
+        array_push($this->values, ...$values);
+
+        return $this;
+    }
+
     public function walkAcceptance(): iterable
     {
         return new \ArrayIterator($this->values);
diff --git a/src/AppendableIteratorAcceptanceResultBucket.php b/src/AppendableIteratorAcceptanceResultBucket.php
@@ -0,0 +1,30 @@
+<?php
+
+namespace Kiboko\Component\Bucket;
+
+use Kiboko\Contract\Bucket\AcceptanceResultBucketInterface;
+
+final class AppendableIteratorAcceptanceResultBucket implements AcceptanceResultBucketInterface
+{
+    private iterable $iterator;
+
+    public function __construct(\Iterator ...$iterators)
+    {
+        $this->iterator = new \AppendIterator();
+        foreach ($iterators as $iterator) {
+            $this->iterator->append($iterator);
+        }
+    }
+
+    public function append(\Iterator ...$iterators)
+    {
+        foreach ($iterators as $iterator) {
+            $this->iterator->append($iterator);
+        }
+    }
+
+    public function walkAcceptance(): iterable
+    {
+        return $this->iterator;
+    }
+}
diff --git a/src/AppendableIteratorRejectionResultBucket.php b/src/AppendableIteratorRejectionResultBucket.php
@@ -0,0 +1,30 @@
+<?php
+
+namespace Kiboko\Component\Bucket;
+
+use Kiboko\Contract\Bucket\RejectionResultBucketInterface;
+
+final class AppendableIteratorRejectionResultBucket implements RejectionResultBucketInterface
+{
+    private iterable $iterator;
+
+    public function __construct(\Iterator ...$iterators)
+    {
+        $this->iterator = new \AppendIterator();
+        foreach ($iterators as $iterator) {
+            $this->iterator->append($iterator);
+        }
+    }
+
+    public function append(\Iterator ...$iterators)
+    {
+        foreach ($iterators as $iterator) {
+            $this->iterator->append($iterator);
+        }
+    }
+
+    public function walkRejection(): iterable
+    {
+        return $this->iterator;
+    }
+}
diff --git a/src/ComplexResultBucket.php b/src/ComplexResultBucket.php
@@ -10,10 +10,10 @@ final class ComplexResultBucket implements
     AcceptanceResultBucketInterface,
     RejectionResultBucketInterface
 {
-    /** @var RejectionResultBucketInterface[] */
-    private $rejections;
     /** @var AcceptanceResultBucketInterface[] */
     private $acceptances;
+    /** @var RejectionResultBucketInterface[] */
+    private $rejections;
 
     public function __construct(ResultBucketInterface... $buckets)
     {
diff --git a/src/IteratorAcceptanceResultBucket.php b/src/IteratorAcceptanceResultBucket.php
@@ -0,0 +1,24 @@
+<?php
+
+namespace Kiboko\Component\Bucket;
+
+use Kiboko\Contract\Bucket\AcceptanceResultBucketInterface;
+
+final class IteratorAcceptanceResultBucket implements AcceptanceResultBucketInterface
+{
+    /** @var \Iterator */
+    private $iterator;
+
+    /**
+     * @param \Iterator $iterator
+     */
+    public function __construct(\Iterator $iterator)
+    {
+        $this->iterator = $iterator;
+    }
+
+    public function walkAcceptance(): iterable
+    {
+        return $this->iterator;
+    }
+}
diff --git a/src/IteratorRejectionResultBucket.php b/src/IteratorRejectionResultBucket.php
@@ -0,0 +1,21 @@
+<?php
+
+namespace Kiboko\Component\Bucket;
+
+use Kiboko\Contract\Bucket\RejectionResultBucketInterface;
+
+final class IteratorRejectionResultBucket implements RejectionResultBucketInterface
+{
+    /** @var \Iterator */
+    private $iterator;
+
+    public function __construct(\Iterator $iterator)
+    {
+        $this->iterator = $iterator;
+    }
+
+    public function walkRejection(): iterable
+    {
+        return $this->iterator;
+    }
+}
diff --git a/src/RejectionAppendableResultBucket.php b/src/RejectionAppendableResultBucket.php
@@ -1,31 +1,12 @@
 <?php
 
-namespace Kiboko\Component\Bucket;
-
-use Kiboko\Contract\Bucket\RejectionResultBucketInterface;
+declare(strict_types=1);
 
-final class RejectionAppendableResultBucket implements RejectionResultBucketInterface
-{
-    /** @var \AppendIterator */
-    private $iterator;
-
-    public function __construct(\Iterator ...$iterators)
-    {
-        $this->iterator = new \AppendIterator();
-        foreach ($iterators as $iterator) {
-            $this->iterator->append($iterator);
-        }
-    }
+namespace Kiboko\Component\Bucket;
 
-    public function append(\Iterator ...$iterators)
-    {
-        foreach ($iterators as $iterator) {
-            $this->iterator->append($iterator);
-        }
-    }
+trigger_deprecation('php-etl/bucket', '0.2', 'The "%s" class is deprecated, use "%s" instead.', 'Kiboko\\Component\\Bucket\\RejectionAppendableResultBucket', AppendableIteratorRejectionResultBucket::class);
 
-    public function walkRejection(): iterable
-    {
-        return $this->iterator;
-    }
-}
+/**
+ * @deprecated since Satellite 0.2, use Kiboko\Component\Bucket\AppendableIteratorRejectionResultBucket instead.
+ */
+class_alias(AppendableIteratorRejectionResultBucket::class, 'Kiboko\\Component\\Bucket\\RejectionAppendableResultBucket');
diff --git a/src/RejectionIteratorResultBucket.php b/src/RejectionIteratorResultBucket.php
@@ -1,21 +1,12 @@
 <?php
 
-namespace Kiboko\Component\Bucket;
-
-use Kiboko\Contract\Bucket\RejectionResultBucketInterface;
+declare(strict_types=1);
 
-final class RejectionIteratorResultBucket implements RejectionResultBucketInterface
-{
-    /** @var \Iterator */
-    private $iterator;
+namespace Kiboko\Component\Bucket;
 
-    public function __construct(\Iterator $iterator)
-    {
-        $this->iterator = $iterator;
-    }
+trigger_deprecation('php-etl/bucket', '0.2', 'The "%s" class is deprecated, use "%s" instead.', 'Kiboko\\Component\\Bucket\\RejectionIteratorResultBucket', IteratorRejectionResultBucket::class);
 
-    public function walkRejection(): iterable
-    {
-        return $this->iterator;
-    }
-}
+/**
+ * @deprecated since Satellite 0.2, use Kiboko\Component\Bucket\IteratorRejectionResultBucket instead.
+ */
+class_alias(IteratorRejectionResultBucket::class, 'Kiboko\\Component\\Bucket\\RejectionIteratorResultBucket');
diff --git a/src/RejectionResultBucket.php b/src/RejectionResultBucket.php

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@`
`25`	`25`	`},`
`26`	`26`	`"extra": {`
`27`	`27`	`"branch-alias": {`
`28`		`- "dev-master": "0.1.x-dev"`
	`28`	`+ "dev-master": "0.2.x-dev"`
`29`	`29`	`}`
`30`	`30`	`},`
`31`	`31`	`"require-dev": {`
Original file line number	Diff line number	Diff line change
`@@ -2,16 +2,16 @@`
`2`	`2`
`3`	`3`	`namespace spec\Kiboko\Component\Bucket;`
`4`	`4`
`5`		`-use Kiboko\Component\Bucket\AcceptanceAppendableResultBucket;`
	`5`	`+use Kiboko\Component\Bucket\AppendableIteratorAcceptanceResultBucket;`
`6`	`6`	`use Kiboko\Contract\Bucket\AcceptanceResultBucketInterface;`
`7`	`7`	`use PhpSpec\ObjectBehavior;`
`8`	`8`	`use Prophecy\Argument;`
`9`	`9`
`10`		`-class AcceptanceAppendableResultBucketSpec extends ObjectBehavior`
	`10`	`+class AppendableIteratorAcceptanceResultBucketSpec extends ObjectBehavior`
`11`	`11`	`{`
`12`	`12`	`function it_is_initializable()`
`13`	`13`	`{`
`14`		`- $this->shouldHaveType(AcceptanceAppendableResultBucket::class);`
	`14`	`+ $this->shouldHaveType(AppendableIteratorAcceptanceResultBucket::class);`
`15`	`15`	`$this->shouldBeAnInstanceOf(AcceptanceResultBucketInterface::class);`
`16`	`16`	`}`
`17`	`17`
Original file line number	Diff line number	Diff line change
`@@ -2,16 +2,16 @@`
`2`	`2`
`3`	`3`	`namespace spec\Kiboko\Component\Bucket;`
`4`	`4`
`5`		`-use Kiboko\Component\Bucket\RejectionAppendableResultBucket;`
	`5`	`+use Kiboko\Component\Bucket\AppendableIteratorRejectionResultBucket;`
`6`	`6`	`use Kiboko\Contract\Bucket\RejectionResultBucketInterface;`
`7`	`7`	`use PhpSpec\ObjectBehavior;`
`8`	`8`	`use Prophecy\Argument;`
`9`	`9`
`10`		`-class RejectionAppendableResultBucketSpec extends ObjectBehavior`
	`10`	`+class AppendableIteratorRejectionResultBucketSpec extends ObjectBehavior`
`11`	`11`	`{`
`12`	`12`	`function it_is_initializable()`
`13`	`13`	`{`
`14`		`- $this->shouldHaveType(RejectionAppendableResultBucket::class);`
	`14`	`+ $this->shouldHaveType(AppendableIteratorRejectionResultBucket::class);`
`15`	`15`	`$this->shouldBeAnInstanceOf(RejectionResultBucketInterface::class);`
`16`	`16`	`}`
`17`	`17`
Original file line number	Diff line number	Diff line change
`@@ -2,18 +2,18 @@`
`2`	`2`
`3`	`3`	`namespace spec\Kiboko\Component\Bucket;`
`4`	`4`
`5`		`-use Kiboko\Component\Bucket\AcceptanceIteratorResultBucket;`
	`5`	`+use Kiboko\Component\Bucket\IteratorAcceptanceResultBucket;`
`6`	`6`	`use Kiboko\Contract\Bucket\AcceptanceResultBucketInterface;`
`7`	`7`	`use PhpSpec\ObjectBehavior;`
`8`	`8`	`use Prophecy\Argument;`
`9`	`9`
`10`		`-class AcceptanceIteratorResultBucketSpec extends ObjectBehavior`
	`10`	`+class IteratorAcceptanceResultBucketSpec extends ObjectBehavior`
`11`	`11`	`{`
`12`	`12`	`function it_is_initializable()`
`13`	`13`	`{`
`14`	`14`	`$this->beConstructedWith(new \EmptyIterator());`
`15`	`15`
`16`		`- $this->shouldHaveType(AcceptanceIteratorResultBucket::class);`
	`16`	`+ $this->shouldHaveType(IteratorAcceptanceResultBucket::class);`
`17`	`17`	`$this->shouldBeAnInstanceOf(AcceptanceResultBucketInterface::class);`
`18`	`18`	`}`
`19`	`19`
Original file line number	Diff line number	Diff line change
`@@ -2,18 +2,18 @@`
`2`	`2`
`3`	`3`	`namespace spec\Kiboko\Component\Bucket;`
`4`	`4`
`5`		`-use Kiboko\Component\Bucket\RejectionIteratorResultBucket;`
	`5`	`+use Kiboko\Component\Bucket\IteratorRejectionResultBucket;`
`6`	`6`	`use Kiboko\Contract\Bucket\RejectionResultBucketInterface;`
`7`	`7`	`use PhpSpec\ObjectBehavior;`
`8`	`8`	`use Prophecy\Argument;`
`9`	`9`
`10`		`-class RejectionIteratorResultBucketSpec extends ObjectBehavior`
	`10`	`+class IteratorRejectionResultBucketSpec extends ObjectBehavior`
`11`	`11`	`{`
`12`	`12`	`function it_is_initializable()`
`13`	`13`	`{`
`14`	`14`	`$this->beConstructedWith(new \EmptyIterator());`
`15`	`15`
`16`		`- $this->shouldHaveType(RejectionIteratorResultBucket::class);`
	`16`	`+ $this->shouldHaveType(IteratorRejectionResultBucket::class);`
`17`	`17`	`$this->shouldBeAnInstanceOf(RejectionResultBucketInterface::class);`
`18`	`18`	`}`
`19`	`19`