Merge pull request #4 from emonkak/change-to-static-method

Change Collection::union(), concat(), zip() to static method

Author: emonkak

README.md

@@ -28,3 +28,7 @@ Collection::iterate(0, function($n) { return $n + 1; })
 //    6
 //    8
 ```
+
+## Documentation
+
+Please see [Wiki](https://github.com/emonkak/php-collection/wiki). (but wiki pages are Japanese only)

benchmarks/ConcatEvent.php

@@ -23,6 +23,6 @@ public function arrayImpl()
 
     protected function execute($xs)
     {
-        foreach ($xs->concat($this->data) as $x);
+        foreach ($xs->concatWith($this->data) as $x);
     }
 }

benchmarks/MethodChainEvent.php

@@ -35,8 +35,8 @@ protected function execute($xs)
         $result = $xs
             ->filter(function($x) { return $x % 2 === 0; })
             ->map(function($x) { return $x * 2; })
-            ->concat($this->data)
-            ->zip(Collection::range(0, INF))
+            ->concatWith($this->data)
+            ->zipWith(Collection::range(0, INF))
             ->take(100);
         foreach ($result as $x);
     }

src/Collection.php

@@ -5,6 +5,7 @@
 use Emonkak\Collection\Provider\CollectionProviderInterface;
 use Emonkak\Collection\Provider\GeneratorProvider;
 use Emonkak\Collection\Provider\IteratorProvider;
+use Emonkak\Collection\Selector\ValueSelector;
 use Emonkak\Collection\Utils\Iterators;
 
 class Collection implements \IteratorAggregate
@@ -28,7 +29,7 @@ public static function from($source)
         return new Collection($source, self::$defaultProvider);
     }
 
-    public static function combine($sources)
+    public static function concat($sources)
     {
         if (!Iterators::isTraversable($sources)) {
             $type = gettype($sources);
@@ -41,6 +42,14 @@ public static function combine($sources)
         );
     }
 
+    public static function iterate($initial, $f)
+    {
+        return new Collection(
+            self::$defaultProvider->iterate($initial, $f),
+            self::$defaultProvider
+        );
+    }
+
     public static function range($start, $stop = null, $step = 1)
     {
         if ($stop === null) {
@@ -53,18 +62,26 @@ public static function range($start, $stop = null, $step = 1)
         );
     }
 
-    public static function iterate($initial, $f)
+    public static function repeat($value, $n = null)
     {
         return new Collection(
-            self::$defaultProvider->iterate($initial, $f),
+            self::$defaultProvider->repeat($value, $n),
             self::$defaultProvider
         );
     }
 
-    public static function repeat($value, $n = null)
+    public static function union($sources)
     {
         return new Collection(
-            self::$defaultProvider->repeat($value, $n),
+            self::$defaultProvider->uniq(self::$defaultProvider->concat($sources), ValueSelector::getInstance()),
+            self::$defaultProvider
+        );
+    }
+
+    public static function zip($sources)
+    {
+        return new Collection(
+            self::$defaultProvider->zip($sources),
             self::$defaultProvider
         );
     }

src/Enumerable.php

@@ -590,9 +590,9 @@ public function without()
         return $this->difference(func_get_args());
     }
 
-    public function union()
+    public function unionWith()
     {
-        return call_user_func_array([$this, 'concat'], func_get_args())->uniq();
+        return call_user_func_array([$this, 'concatWith'], func_get_args())->uniq();
     }
 
     public function intersection()
@@ -624,7 +624,7 @@ public function uniq($selector = null)
         return $this->newCollection($this->getProvider()->uniq($xs, $selector));
     }
 
-    public function zip()
+    public function zipWith()
     {
         $xss = array_merge([$this->getSource()], func_get_args());
         return $this->newCollection($this->getProvider()->zip($xss));
@@ -660,7 +660,7 @@ public function sort($comparer = null)
         });
     }
 
-    public function concat()
+    public function concatWith()
     {
         $xss = array_merge([$this->getSource()], func_get_args());
         return $this->newCollection($this->getProvider()->concat($xss));

tests/AbstractCollectionTest.php

@@ -39,17 +39,17 @@ public function testFromThrowsInvalidArgumentException()
     }
 
     /**
-     * @dataProvider provideCombine
+     * @dataProvider provideConcat
      */
-    public function testCombine($sources, $expected)
+    public function testConcat($sources, $expected)
     {
-        $collection = Collection::combine($sources);
+        $collection = Collection::concat($sources);
 
         $this->assertSame($expected, $collection->toList());
         $this->assertSame(Collection::getDefaultProvider(), $collection->getProvider());
     }
 
-    public function provideCombine()
+    public function provideConcat()
     {
         return [
             [[], []],
@@ -60,9 +60,9 @@ public function provideCombine()
     /**
      * @expectedException \InvalidArgumentException
      */
-    public function testCombineThrowsInvalidArgumentException()
+    public function testConcatThrowsInvalidArgumentException()
     {
-        Collection::combine(1);
+        Collection::concat(1);
     }
 
     public function testRange()
@@ -110,6 +110,31 @@ public function testRepeat()
         $this->assertEmpty($result);
     }
 
+    public function testUnion()
+    {
+        $result = Collection::union([[1, 2, 3], [2, 30, 1], [1, 40]])->toList();
+        $shouldBe = [1, 2, 3, 30, 40];
+        $this->assertSame($shouldBe, $result, 'takes the union of a list of arrays');
+
+        $result = Collection::union([[1, 2, 3], [2, 30, 1], [1, 40, [1]]])->toList();
+        $shouldBe = [1, 2, 3, 30, 40, [1]];
+        $this->assertSame($shouldBe, $result, 'takes the union of a list of nested arrays');
+    }
+
+    public function testZip()
+    {
+        $names = ['moe', 'larry', 'curly'];
+        $ages = [30, 40, 50];
+        $leaders = [true, false];
+
+        $result = Collection::zip([$names, $ages, $leaders])->toList();
+        $expected = [
+            ['moe', 30, true],
+            ['larry', 40, false]
+        ];
+        $this->assertSame($expected, $result);
+    }
+
     /**
      * @dataProvider provideCollectionFactory
      */
@@ -1203,13 +1228,13 @@ public function testIntersection($factory)
     /**
      * @dataProvider provideCollectionFactory
      */
-    public function testUnion($factory)
+    public function testUnionWith($factory)
     {
-        $result = $factory([1, 2, 3])->union([2, 30, 1], [1, 40])->toList();
+        $result = $factory([1, 2, 3])->unionWith([2, 30, 1], [1, 40])->toList();
         $shouldBe = [1, 2, 3, 30, 40];
         $this->assertSame($shouldBe, $result, 'takes the union of a list of arrays');
 
-        $result = $factory([1, 2, 3])->union([2, 30, 1], [1, 40, [1]])->toList();
+        $result = $factory([1, 2, 3])->unionWith([2, 30, 1], [1, 40, [1]])->toList();
         $shouldBe = [1, 2, 3, 30, 40, [1]];
         $this->assertSame($shouldBe, $result, 'takes the union of a list of nested arrays');
     }
@@ -1231,13 +1256,13 @@ public function testDifference($factory)
     /**
      * @dataProvider provideCollectionFactory
      */
-    public function testZip($factory)
+    public function testZipWith($factory)
     {
         $names = ['moe', 'larry', 'curly'];
         $ages = [30, 40, 50];
         $leaders = [true, false];
 
-        $stooges = $factory($names)->zip($ages, $leaders)->toList();
+        $stooges = $factory($names)->zipWith($ages, $leaders)->toList();
         $shouldBe = [
             ['moe', 30, true],
             ['larry', 40, false]
@@ -1419,6 +1444,20 @@ public function testSort($factory)
         $this->assertEmpty($result);
     }
 
+    /**
+     * @dataProvider provideConcat
+     */
+    public function testConcatWith($sources, $expected)
+    {
+        $result = Collection::from([1, 2])->concatWith([3, 4, 5])->toList();
+        $expected = [1, 2, 3, 4, 5];
+        $this->assertSame($expected, $result);
+
+        $result = Collection::from([])->concatWith([])->toList();
+        $expected = [];
+        $this->assertSame($expected, $result);
+    }
+
     /**
      * @dataProvider provideCollectionFactory
      */