Pointer options refactoring

- OPTION_NON_NUMERIC_INDICES renamed.
- OPTION_WRITE_ANY_INDEX introduced.

Author: remorhaz

src/Pointer.php

@@ -11,7 +11,16 @@ class Pointer
      * have string indices. This option can be used to enable non-numeric
      * array indices addressing.
      */
-    const OPTION_NON_NUMERIC_ARRAY_INDICES = 0x01;
+    const OPTION_NON_NUMERIC_INDICES = 0x01;
+    /**
+     * "Native" JSON arrays have consistent indices, so allowing to create
+     * arbitrary numeric indices will break them. But PHP arrays support
+     * arrays with "gaps" between indices, and this option enables writing
+     * to array at any index.
+     *
+     * @todo Implement this option.
+     */
+    const OPTION_WRITE_ANY_INDEX = 0x02;
 
     /**
      * Bit-packed options.
@@ -134,7 +143,7 @@ public function unsetData()
     public function test()
     {
         return Pointer\Evaluate\Test::factory()
-            ->setNonNumericArrayIndices($this->hasOption(self::OPTION_NON_NUMERIC_ARRAY_INDICES))
+            ->setNonNumericIndices($this->hasOption(self::OPTION_NON_NUMERIC_INDICES))
             ->setLocator($this->getLocator())
             ->setData($this->getData())
             ->perform()
@@ -144,7 +153,7 @@ public function test()
     public function &read()
     {
         return Pointer\Evaluate\Read::factory()
-            ->setNonNumericArrayIndices($this->hasOption(self::OPTION_NON_NUMERIC_ARRAY_INDICES))
+            ->setNonNumericIndices($this->hasOption(self::OPTION_NON_NUMERIC_INDICES))
             ->setLocator($this->getLocator())
             ->setData($this->getData())
             ->perform()
@@ -155,7 +164,7 @@ public function &read()
     public function write($value)
     {
         Pointer\Evaluate\Write::factory()
-            ->setNonNumericArrayIndices($this->hasOption(self::OPTION_NON_NUMERIC_ARRAY_INDICES))
+            ->setNonNumericIndices($this->hasOption(self::OPTION_NON_NUMERIC_INDICES))
             ->setLocator($this->getLocator())
             ->setData($this->getData())
             ->setValue($value)

src/Pointer/Evaluate.php

@@ -55,7 +55,7 @@ abstract class Evaluate
      */
     protected $result;
 
-    protected $nonNumericArrayIndices = false;
+    protected $nonNumericIndices = false;
 
 
     /**
@@ -176,12 +176,12 @@ public function &getResult()
     }
 
 
-    public function setNonNumericArrayIndices($allow = true)
+    public function setNonNumericIndices($allow = true)
     {
         if (!is_bool($allow)) {
             throw new Evaluate\InvalidArgumentException("Non-numeric array indices allowance flag must be boolean");
         }
-        $this->nonNumericArrayIndices = $allow;
+        $this->nonNumericIndices = $allow;
         return $this;
     }
 
@@ -267,7 +267,7 @@ protected function processArrayIndex(Reference $reference)
                 return $this->processNumericArrayIndex($reference);
 
             default:
-                return $this->nonNumericArrayIndices
+                return $this->nonNumericIndices
                     ? $this->processAllowedNonNumericArrayIndex($reference)
                     : $this->processNotAllowedNonNumericArrayIndex($reference);
         }

tests/PointerTest.php

@@ -175,7 +175,7 @@ public function providerReadDataWithInvalidLocator()
     public function testTestDataWithNonNumericArrayIndices($text, $data)
     {
         $result = Pointer::factory()
-            ->setOptions(Pointer::OPTION_NON_NUMERIC_ARRAY_INDICES)
+            ->setOptions(Pointer::OPTION_NON_NUMERIC_INDICES)
             ->setText($text)
             ->setData($data)
             ->test();
@@ -192,7 +192,7 @@ public function testTestDataWithNonNumericArrayIndices($text, $data)
     public function testReadDataWithNonNumericArrayIndices($text, $data, $result)
     {
         $pointer = Pointer::factory()
-            ->setOptions(Pointer::OPTION_NON_NUMERIC_ARRAY_INDICES)
+            ->setOptions(Pointer::OPTION_NON_NUMERIC_INDICES)
             ->setText($text)
             ->setData($data);
         $this->assertEquals($result, $pointer->read(), "Error reading non-numeric array index");