Merge pull request #34 from worksolutions/dev

Some enchasaments for next minor version

Author: antonLytkin18

composer.json

@@ -3,7 +3,7 @@
   "description": "Collections library for php language",
   "minimum-stability": "dev",
   "license": "MIT",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "authors": [
     {
       "name": "Maxim Sokolovsky",

src/WS/Utils/Collections/DummyStreamDecorator.php

@@ -136,4 +136,23 @@ public function always(): Stream
     {
         return $this->decoratedStream;
     }
+
+    /**
+     * @inheritDoc
+     */
+    public function toArray(): array
+    {
+        return $this
+            ->getCollection()
+            ->toArray()
+        ;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getSet(): Set
+    {
+        return new HashSet($this->toArray());
+    }
 }

src/WS/Utils/Collections/Functions/Predicates.php

@@ -91,10 +91,11 @@ public static function equal($value): Closure
     /**
      * Returns <Fn($el: mixed): bool> passed unique element at once
      */
-    public static function lockDuplicated(): Closure
+    public static function lockDuplicated(?callable $caster = null): Closure
     {
         $set = new HashSet();
-        return static function ($el) use ($set): bool {
+        return static function ($el) use ($set, $caster): bool {
+            $el = isset($caster) ? $caster($el) : $el;
             $res = !$set->contains($el);
             $set->add($el);
             return $res;

src/WS/Utils/Collections/Functions/Reorganizers.php

@@ -112,16 +112,25 @@ public static function chunk(int $size): Closure
 
     /**
      * Returns Closure <Fn($c: Collection): Collection> that collapses a collection of arrays into a single, flat collection
+     * @param int $depth Depth of  collapses. The 0 value is without
      * @return Closure
      */
-    public static function collapse(): Closure
+    public static function collapse(int $depth = 0): Closure
     {
-        return static function (Collection $collection): Collection {
-            $flatIterable = static function (iterable $collection) use (& $flatIterable): array  {
+        if ($depth === 0) {
+            $depth = null;
+        }
+        return static function (Collection $collection) use ($depth): Collection {
+            $flatIterable = static function (iterable $collection, $depth) use (& $flatIterable): array  {
+                $goToDepth = $depth > 0 || $depth === null;
+                if ($depth !== null) {
+                    $depth--;
+                }
+
                 $res = [];
                 foreach ($collection as $item) {
-                    if (is_iterable($item)) {
-                        $toPush = $flatIterable($item);
+                    if (is_iterable($item) && $goToDepth) {
+                        $toPush = $flatIterable($item, $depth);
                         array_unshift($toPush, $res);
                         array_push(...$toPush);
                         $res = array_shift($toPush);
@@ -132,7 +141,7 @@ public static function collapse(): Closure
                 return $res;
             };
 
-            return self::collectionConstructor($flatIterable($collection));
+            return self::collectionConstructor($flatIterable($collection, $depth));
         };
     }
 }

src/WS/Utils/Collections/SerialStream.php

@@ -336,4 +336,23 @@ public function always(): Stream
     {
         return $this;
     }
+
+    /**
+     * @inheritDoc
+     */
+    public function toArray(): array
+    {
+        return $this
+            ->getCollection()
+            ->toArray()
+        ;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getSet(): Set
+    {
+        return new HashSet($this->toArray());
+    }
 }

src/WS/Utils/Collections/Stream.php

@@ -161,4 +161,16 @@ public function getCollection(): Collection;
      * @return Stream
      */
     public function always(): Stream;
+
+    /**
+     * Returns array as collection represent
+     * @return array
+     */
+    public function toArray(): array;
+
+    /**
+     * Creates a set structure
+     * @return Set
+     */
+    public function getSet(): Set;
 }

tests/WS/Utils/Collections/ReorganizersFunctionsTest.php

@@ -48,6 +48,36 @@ public function collapsing(): void
         $this->assertThat($collapsedCollection, CollectionIsEqual::to([1, 2, 3, 4, 5, 6]));
     }
 
+    /**
+     * @test
+     */
+    public function singleDepthCollapsing(): void
+    {
+        $collection = self::toCollection([1, 2], [3, 4], [5, 6, [7, 8]]);
+
+        $collapsedCollection = $collection
+            ->stream()
+            ->reorganize(Reorganizers::collapse(1))
+            ->getCollection()
+        ;
+        $this->assertThat($collapsedCollection, CollectionIsEqual::to([1, 2, 3, 4, 5, 6, [7, 8]]));
+    }
+
+    /**
+     * @test
+     */
+    public function numericDepthCollapsing(): void
+    {
+        $collection = self::toCollection([1, 2], [3, 4], [5, 6, [7, 8, [9, 10]]]);
+
+        $collapsedCollection = $collection
+            ->stream()
+            ->reorganize(Reorganizers::collapse(3))
+            ->getCollection()
+        ;
+        $this->assertThat($collapsedCollection, CollectionIsEqual::to([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]));
+    }
+
     /**
      * @test
      */
@@ -67,4 +97,22 @@ public function filterDistinctElements(): void
 
         self::assertThat($uniqCollection, CollectionIsEqual::to([$o1, $o2, $o3]));
     }
+
+    /**
+     * @test
+     */
+    public function filterDistinctCastedValues(): void
+    {
+        $caster = static function (int $number) {
+            return $number % 2;
+        };
+
+        $result = CollectionFactory::numbers(0, 10)
+            ->stream()
+            ->filter(Predicates::lockDuplicated($caster))
+            ->toArray()
+        ;
+
+        $this->assertCount(2, $result);
+    }
 }

tests/WS/Utils/Collections/SerialStreamTest.php

@@ -627,4 +627,18 @@ public function copyOfCollectionWhenStreaming(): void
 
         $this->assertNotSame($dest, $source);
     }
+
+    /**
+     * @test
+     */
+    public function gettingSetStructure(): void
+    {
+        $source = CollectionFactory::generate(3);
+        $this->assertThat($source, $this->isInstanceOf(ListSequence::class));
+        $set = $source
+            ->stream()
+            ->getSet()
+        ;
+        $this->assertThat($set, $this->isInstanceOf(Set::class));
+    }
 }