Rename *Collections to *ImmutableCollections

Author: Daniel Gomes

README.md

@@ -57,10 +57,10 @@ This way you have the possibility to use them and extend it's behavior tailored
 ```php
 <?php
 
-use DCSG\ImmutableCollections\Collection;
+use DCSG\ImmutableCollections\ImmutableCollection;
 
-final class MyStringCollection extends Collection {
-    // We have to override the `validateItems` in order to ensure the right Type for the Collection.
+final class MyStringCollection extends ImmutableCollection {
+    ImmutableCollection
     protected function validateItems(array $elements): void
     {
         foreach ($elements as $element) {
@@ -80,10 +80,10 @@ echo $collection->count(); // 2
 ```php
 <?php
 
-use DCSG\ImmutableCollections\SetCollection;
+use DCSG\ImmutableCollections\SetImmutableCollection;
 
-final class MyStringSetCollection extends SetCollection {
-    // We have to override the `validateItems` in order to ensure the right Type for the Collection.
+final class MyStringSetCollection extends SetImmutableCollection {
+    ImmutableCollection
     protected function validateItems(array $elements): void
     {
         foreach ($elements as $element) {

examples/CargoLegs/Legs.php

@@ -3,15 +3,15 @@
 namespace Examples\DCSG\ImmutableCollections\CargoLegs;
 
 use InvalidArgumentException;
-use DCSG\ImmutableCollections\Collection;
+use DCSG\ImmutableCollections\ImmutableCollection;
 
 /**
  * @method Leg first()
  * @method Leg last()
  * @method Leg head()
  * @method Leg[] getIterator(): CollectionIterator
  */
-final class Legs extends Collection
+final class Legs extends ImmutableCollection
 {
     public function from(string $location): Legs
     {

examples/Invoices/InvoiceItems.php

@@ -3,15 +3,15 @@
 namespace Examples\DCSG\ImmutableCollections\Invoices;
 
 use InvalidArgumentException;
-use DCSG\ImmutableCollections\Collection;
+use DCSG\ImmutableCollections\ImmutableCollection;
 
 /**
  * @method InvoiceItem first()
  * @method InvoiceItem last()
  * @method InvoiceItem head()
  * @method InvoiceItem[] getIterator(): CollectionIterator
  */
-final class InvoiceItems extends Collection
+final class InvoiceItems extends ImmutableCollection
 {
     public function totalIncludingVAT(): float
     {

examples/Invoices/Invoices.php

@@ -3,15 +3,15 @@
 namespace Examples\DCSG\ImmutableCollections\Invoices;
 
 use InvalidArgumentException;
-use DCSG\ImmutableCollections\SetCollection;
+use DCSG\ImmutableCollections\SetImmutableCollection;
 
 /**
  * @method Invoice first()
  * @method Invoice last()
  * @method Invoice head()
  * @method Invoice[] getIterator(): CollectionIterator
  */
-final class Invoices extends SetCollection
+final class Invoices extends SetImmutableCollection
 {
     public function totalExcludingVAT()
     {

src/Collection.php src/ImmutableCollection.phpsrc/Collection.php renamed to src/ImmutableCollection.php

@@ -7,7 +7,7 @@
 /**
  * @author Daniel Gomes <danielcesargomes@gmail.com>
  */
-abstract class Collection implements CollectionInterface
+abstract class ImmutableCollection implements CollectionInterface
 {
     /** @var array */
     protected $elements;

src/SetCollection.php src/SetImmutableCollection.phpsrc/SetCollection.php renamed to src/SetImmutableCollection.php

@@ -7,7 +7,7 @@
 /**
  * @author Daniel Gomes <danielcesargomes@gmail.com>
  */
-abstract class SetCollection extends Collection
+abstract class SetImmutableCollection extends ImmutableCollection
 {
     protected function __construct(array $elements)
     {

tests/CollectionTest.php

@@ -3,7 +3,7 @@
 namespace Tests\DCSG\ImmutableCollections;
 
 use InvalidArgumentException;
-use DCSG\ImmutableCollections\Collection;
+use DCSG\ImmutableCollections\ImmutableCollection;
 use DCSG\ImmutableCollections\NotFoundException;
 use PHPUnit\Framework\TestCase;
 
@@ -197,7 +197,7 @@ public function testReduce()
 
 }
 
-final class StringCollection extends Collection
+final class StringCollection extends ImmutableCollection
 {
     protected function validateItems(array $elements): void
     {

tests/SetCollectionTest.php

@@ -3,7 +3,7 @@
 namespace Tests\DCSG\ImmutableCollections;
 
 use InvalidArgumentException;
-use DCSG\ImmutableCollections\SetCollection;
+use DCSG\ImmutableCollections\SetImmutableCollection;
 use PHPUnit\Framework\TestCase;
 
 final class SetCollectionTest extends TestCase
@@ -20,7 +20,7 @@ public function testCreateWithValidElements(): void
     }
 }
 
-final class StringSetCollection extends SetCollection
+final class StringSetCollection extends SetImmutableCollection
 {
     protected function validateItems(array $elements): void
     {