Fix capacity tests, implement ArrayAccess

Author: rtheunissen

composer.json

@@ -13,10 +13,10 @@
         "ext-json": "*"
     },
     "require-dev": {
-        "php-ds/tests": "^1.3"
+        "php-ds/tests": "dev-master"
     },
     "provide": {
-        "ext-ds": "1.0.0"
+        "ext-ds": "1.3.0"
     },
     "suggest": {
         "ext-ds": "to improve performance and reduce memory usage"

src/Deque.php

@@ -11,11 +11,16 @@
  *
  * @package Ds
  */
-final class Deque implements \IteratorAggregate, \ArrayAccess, Sequence
+final class Deque implements Sequence
 {
     use Traits\GenericCollection;
     use Traits\GenericSequence;
     use Traits\SquaredCapacity;
 
     const MIN_CAPACITY = 8;
+
+    protected function shouldIncreaseCapacity(): bool
+    {
+        return count($this) >= $this->capacity;
+    }
 }

src/Map.php

@@ -12,7 +12,7 @@
  *
  * @package Ds
  */
-final class Map implements \IteratorAggregate, \ArrayAccess, Collection
+final class Map implements Collection, \ArrayAccess
 {
     use Traits\GenericCollection;
     use Traits\SquaredCapacity;
@@ -694,4 +694,17 @@ public function offsetExists($offset)
     {
         return $this->get($offset, null) !== null;
     }
+
+    /**
+     * Returns a representation that can be natively converted to JSON, which is
+     * called when invoking json_encode.
+     *
+     * @return mixed
+     *
+     * @see \JsonSerializable
+     */
+    public function jsonSerialize()
+    {
+        return (object) $this->toArray();
+    }
 }

src/Pair.php

@@ -6,17 +6,20 @@
 /**
  * A pair which represents a key and an associated value.
  *
+ * @property mixed $key
+ * @property mixed $value
+ *
  * @package Ds
  */
 final class Pair implements \JsonSerializable
 {
     /**
-     * @param mixed $key The pair's key
+     * @var mixed The pair's key
      */
     public $key;
 
     /**
-     * @param mixed $value The pair's value
+     * @var mixed The pair's value
      */
     public $value;
 
@@ -32,6 +35,20 @@ public function __construct($key = null, $value = null)
         $this->value = $value;
     }
 
+    /**
+     *
+     * @param mixed $name
+     *
+     * @return mixed|null
+     */
+    public function __isset($name)
+    {
+        if ($name === 'key' || $name === 'value') {
+            return $this->$name !== null;
+        }
+        return false;
+    }
+
     /**
      * This allows unset($pair->key) to not completely remove the property,
      * but be set to null instead.
@@ -46,7 +63,34 @@ public function __unset($name)
             $this->$name = null;
             return;
         }
+        throw new OutOfBoundsException();
+    }
 
+    /**
+     * @param mixed $name
+     *
+     * @return mixed|null
+     */
+    public function &__get($name)
+    {
+        if ($name === 'key' || $name === 'value') {
+            return $this->$name;
+        }
+        throw new OutOfBoundsException();
+    }
+
+    /**
+     * @param mixed $name
+     * @param mixed $value
+     *
+     * @return mixed|null
+     */
+    public function __set($name, $value)
+    {
+        if ($name === 'key' || $name === 'value') {
+            $this->$name = $value;
+            return;
+        }
         throw new OutOfBoundsException();
     }
 
@@ -69,11 +113,14 @@ public function __debugInfo()
     }
 
     /**
-     * @inheritDoc
+     * @return array
      */
     public function toArray(): array
     {
-        return ['key' => $this->key, 'value' => $this->value];
+        return [
+            'key'   => $this->key,
+            'value' => $this->value,
+        ];
     }
 
     /**

src/PriorityQueue.php

@@ -10,7 +10,7 @@
  *
  * @package Ds
  */
-final class PriorityQueue implements \IteratorAggregate, Collection
+final class PriorityQueue implements Collection
 {
     use Traits\GenericCollection;
     use Traits\SquaredCapacity;

src/Queue.php

@@ -10,7 +10,7 @@
  *
  * @package Ds
  */
-final class Queue implements \IteratorAggregate, \ArrayAccess, Collection
+final class Queue implements Collection, \ArrayAccess 
 {
     use Traits\GenericCollection;
 

src/Sequence.php

@@ -11,7 +11,7 @@
  *
  * @package Ds
  */
-interface Sequence extends Collection
+interface Sequence extends Collection, \ArrayAccess 
 {
     /**
      * Ensures that enough memory is allocated for a required capacity.

src/Set.php

@@ -10,7 +10,7 @@
  *
  * @package Ds
  */
-final class Set implements \IteratorAggregate, \ArrayAccess, Collection
+final class Set implements Collection, \ArrayAccess 
 {
     use Traits\GenericCollection;
 

src/Stack.php

@@ -10,7 +10,7 @@
  *
  * @package Ds
  */
-final class Stack implements \IteratorAggregate, \ArrayAccess, Collection
+final class Stack implements Collection, \ArrayAccess
 {
     use Traits\GenericCollection;
 

src/Traits/Capacity.php

@@ -78,38 +78,55 @@ protected function checkCapacity()
     }
 
     /**
-     * Called when capacity should be increased to accommodate new values.
+     * @param int $total
      */
-    protected function increaseCapacity()
+    protected function ensureCapacity(int $total)
     {
-        $this->capacity = max($this->count(), $this->capacity * $this->getGrowthFactor());
+        if ($total > $this->capacity()) {
+            $this->capacity = max($total, $this->nextCapacity());
+        }
     }
 
     /**
-     * Called when capacity should be decrease if it drops below a threshold.
+     * @return bool whether capacity should be increased.
      */
-    protected function decreaseCapacity()
+    protected function shouldIncreaseCapacity(): bool
     {
-        $this->capacity = max(self::MIN_CAPACITY, $this->capacity  * $this->getDecayFactor());
+        return $this->count() >= $this->capacity();
+    }
+
+    protected function nextCapacity(): int
+    {
+        return $this->capacity() * $this->getGrowthFactor();
     }
 
     /**
-     * @return bool whether capacity should be increased.
+     * Called when capacity should be increased to accommodate new values.
      */
-    protected function shouldDecreaseCapacity(): bool
+    protected function increaseCapacity()
     {
-        return count($this) <= $this->capacity * $this->getTruncateThreshold();
+        $this->capacity = max(
+            $this->count(),
+            $this->nextCapacity()
+        );
     }
 
     /**
-     * @return bool whether capacity should be increased.
+     * Called when capacity should be decrease if it drops below a threshold.
      */
-    protected function shouldIncreaseCapacity(): bool
+    protected function decreaseCapacity()
     {
-        if ($this instanceof Deque) {
-            return count($this) > $this->capacity;
-        }
+        $this->capacity = max(
+            self::MIN_CAPACITY,
+            $this->capacity()  * $this->getDecayFactor()
+        );
+    }
 
-        return count($this) >= $this->capacity;
+    /**
+     * @return bool whether capacity should be increased.
+     */
+    protected function shouldDecreaseCapacity(): bool
+    {
+        return count($this) <= $this->capacity() * $this->getTruncateThreshold();
     }
 }