refactor: move aliases and array conversion, protect __construct()

Author: adhocore

src/Underscore.php

@@ -4,6 +4,28 @@
 
 final class Underscore extends UnderscoreFunction
 {
+    /**
+     * Constructor.
+     *
+     * @param array|mixed $data
+     */
+    public function __construct($data = [])
+    {
+        parent::__construct($data);
+    }
+
+    /**
+     * A static shortcut to constructor.
+     *
+     * @param array|mixed $data Array or array like or array convertible.
+     *
+     * @return self
+     */
+    public static function _($data = null)
+    {
+        return new static($data);
+    }
+
     /**
      * Generates a function that always returns a constant value.
      *

src/UnderscoreArray.php

@@ -9,73 +9,25 @@ class UnderscoreArray extends UnderscoreCollection
      *
      * @param int $n
      *
-     * @return array
+     * @return array|mixed With n = 1 (default), it gives one item, which may not be array.
      */
     public function first($n = 1)
     {
         return $this->slice($n, true);
     }
 
-    /**
-     * Alias of first().
-     *
-     * @param int $n
-     *
-     * @return array
-     */
-    public function head($n = 1)
-    {
-        return $this->first($n);
-    }
-
-    /**
-     * Alias of first().
-     *
-     * @param int $n
-     *
-     * @return array
-     */
-    public function take($n = 1)
-    {
-        return $this->first($n);
-    }
-
     /**
      * Get the last n items.
      *
      * @param int $n
      *
-     * @return array
+     * @return array|mixed With n = 1 (default), it gives one item, which may not be array.
      */
     public function last($n = 1)
     {
         return $this->slice($n, false);
     }
 
-    /**
-     * Alias of last().
-     *
-     * @param int $n
-     *
-     * @return array
-     */
-    public function tail($n = 1)
-    {
-        return $this->last($n);
-    }
-
-    /**
-     * Alias of last().
-     *
-     * @param int $n
-     *
-     * @return array
-     */
-    public function drop($n = 1)
-    {
-        return $this->last($n);
-    }
-
     /**
      * Extracts n items from first or last.
      *
@@ -84,7 +36,7 @@ public function drop($n = 1)
      * @param int  $n
      * @param bool $isFirst From first if true, else last.
      *
-     * @return array
+     * @return array|mixed With n = 1 (default), it gives one item, which may not be array.
      */
     protected function slice($n, $isFirst = true)
     {
@@ -140,18 +92,6 @@ public function unique($fn = null)
         });
     }
 
-    /**
-     * Alias of unique().
-     *
-     * @param callable|string $fn The callback. String is resolved to value of that index.
-     *
-     * @return self
-     */
-    public function uniq($fn = null)
-    {
-        return $this->unique($fn);
-    }
-
     /**
      * Get the items whose value is not in given data.
      *
@@ -168,18 +108,6 @@ public function difference($data)
         });
     }
 
-    /**
-     * Alias of difference().
-     *
-     * @param array|mixed $data Array or array like or array convertible.
-     *
-     * @return self
-     */
-    public function without($data)
-    {
-        return $this->difference($data);
-    }
-
     /**
      * Get the union/merger of items with given data.
      *
@@ -265,7 +193,7 @@ public function findLastIndex($fn = null)
     /**
      * Find the first index of given value if available null otherwise.
      *
-     * @param callable $fn The truth test callback.
+     * @param mixed $value The lookup value.
      *
      * @return string|int|null
      */
@@ -277,7 +205,7 @@ public function indexOf($value)
     /**
      * Find the last index of given value if available null otherwise.
      *
-     * @param callable $fn The truth test callback.
+     * @param mixed $value The lookup value.
      *
      * @return string|int|null
      */
@@ -291,8 +219,8 @@ public function lastIndexOf($value)
      *
      * Note that the initial stack must be sorted already.
      *
-     * @param $object             The new object which needs to be adjusted in stack.
-     * @param callable|string $fn The comparator callback.
+     * @param mixed           $object The new object which needs to be adjusted in stack.
+     * @param callable|string $fn     The comparator callback.
      *
      * @return string|int|null
      */

src/UnderscoreBase.php

@@ -4,6 +4,9 @@
 
 class UnderscoreBase implements \ArrayAccess, \Countable, \IteratorAggregate, \JsonSerializable
 {
+    use Arrayizes;
+    use UnderscoreAliases;
+
     const VERSION = '0.0.2';
 
     /** @var array The array manipulated by this Underscore instance */
@@ -13,11 +16,11 @@ class UnderscoreBase implements \ArrayAccess, \Countable, \IteratorAggregate, \J
     protected static $mixins = [];
 
     /**
-     * Constructor.
+     * Constructor. Only allow `Ahc\Underscore\Underscore` to be instantiated in userland.
      *
      * @param array|mixed $data Array or array like or array convertible.
      */
-    public function __construct($data = [])
+    protected function __construct($data = [])
     {
         $this->data = \is_array($data) ? $data : $this->asArray($data);
     }
@@ -39,54 +42,13 @@ public function get($index = null)
     }
 
     /**
-     * Get data as array.
-     *
-     * @param mixed $data Arbitrary data.
-     * @param bool  $cast Force casting to array!
-     *
-     * @return array
-     */
-    public function asArray($data, $cast = true)
-    {
-        if (\is_array($data)) {
-            return $data;
-        }
-
-        if ($data instanceof static) {
-            return $data->get();
-        }
-
-        // @codeCoverageIgnoreStart
-        if ($data instanceof \Traversable) {
-            return \iterator_to_array($data);
-        }
-        // @codeCoverageIgnoreEnd
-
-        if ($data instanceof \JsonSerializable) {
-            return $data->jsonSerialize();
-        }
-
-        if (\method_exists($data, 'toArray')) {
-            return $data->toArray();
-        }
-
-        return  $cast ? (array) $data : $data;
-    }
-
-    /**
-     * Convert the data items to array.
+     * Get data.
      *
      * @return array
      */
-    public function toArray()
+    public function getData()
     {
-        return \array_map(function ($value) {
-            if (\is_scalar($value)) {
-                return $value;
-            }
-
-            return $this->asArray($value, false);
-        }, $this->data);
+        return $this->data;
     }
 
     /**
@@ -206,16 +168,6 @@ public function count()
         return \count($this->data);
     }
 
-    /**
-     * Alias of count().
-     *
-     * @return int
-     */
-    public function size()
-    {
-        return $this->count();
-    }
-
     /**
      * Gets the iterator for looping.
      *
@@ -398,16 +350,4 @@ public function valueOf()
     {
         return (string) $this;
     }
-
-    /**
-     * A static shortcut to constructor.
-     *
-     * @param array|mixed $data Array or array like or array convertible.
-     *
-     * @return self
-     */
-    public static function _($data = null)
-    {
-        return new static($data);
-    }
 }