Merge pull request #2 from adhocore/develop

Develop

Author: adhocore

readme.md

@@ -39,30 +39,40 @@ $fixer->fix('...');
 
 ## Error
 
-If there's error and fixer cant fix the JSON for some reason, it will throw a `RunttimeException`.
+If there's error and fixer cant fix the JSON for some reason, it will throw a `RuntimeException`.
 You can disable this behavior by passing silent flag (2nd param) to `fix()` in which case original input is returned:
 
 ```php
-(new Fixer)->fix('invalid', true);
+(new Fixer)->silent()->fix('invalid');
 // 'invalid'
+
+(new Fixer)->silent(true)->fix('invalid');
+// 'invalid'
+
+(new Fixer)->silent(false)->fix('invalid');
+// RuntimeException
 ```
 
 ## Missing Value
 
-By default missing values are padded with `null`. You can change it by passing 3rd param to `fix()`:
+By default missing values are padded with `null`. You can change it passing desired value to `missingValue()`:
 
 ```php
 // key b is missing value and is padded with `null`
 $json = (new Fixer)->fix('{"a":1,"b":');
 // {"a":1,"b":null}
 
 // key b is missing value and is padded with `true`
-$json = (new Fixer)->fix('{"a":1,"b":', false, 'true');
+$json = (new Fixer)->missingValue(true)->fix('{"a":1,"b":');
 // {"a":1,"b":true}
 
 // key b is missing value and is padded with `"truncated"`
 // Note that you can actually inject a whole new JSON subset as 3rd param
 // but that should be a valid JSON segment and is not checked by fixer.
-$json = (new Fixer)->fix('{"a":1,"b":', false, '"truncated"');
+$json = (new Fixer)->missingValue('"truncated"')->fix('{"a":1,"b":');
 // {"a":1,"b":"truncated"}
 ```
+
+## Todo
+
+- [ ] Configurable missing value as per context (options)

src/Fixer.php

@@ -20,6 +20,9 @@ class Fixer
     /** @var bool If current char is within a string */
     protected $inStr = false;
 
+    /** @var bool Whether to throw Exception on failure */
+    protected $silent = false;
+
     /** @var array The complementary pairs */
     protected $pairs = [
         '{' => '}',
@@ -36,18 +39,50 @@ class Fixer
     /** @var string Missing value. (Options: true, false, null) */
     protected $missingValue = 'null';
 
+    /**
+     * Set/unset silent mode.
+     *
+     * @param bool $silent
+     *
+     * @return $this
+     */
+    public function silent($silent = true)
+    {
+        $this->silent = (bool) $silent;
+
+        return $this;
+    }
+
+    /**
+     * Set missing value.
+     *
+     * @param mixed $value
+     *
+     * @return $this
+     */
+    public function missingValue($value)
+    {
+        if ($value === null) {
+            $value = 'null';
+        } elseif (\is_bool($value)) {
+            $value = $value ? 'true' : 'false';
+        }
+
+        $this->missingValue = $value;
+
+        return $this;
+    }
+
     /**
      * Fix the truncated JSON.
      *
-     * @param string $json         The JSON string to fix.
-     * @param bool   $silent       If silent, doesnt throw when fixing fails.
-     * @param string $missingValue Missing value constructor. (Options: true, false, null).
+     * @param string $json The JSON string to fix.
      *
      * @throws \RuntimeExcaption When fixing fails.
      *
      * @return string Fixed JSON. If failed with silent then original JSON.
      */
-    public function fix($json, $silent = false, $missingValue = 'null')
+    public function fix($json)
     {
         list($head, $json, $tail) = $this->trim($json);
 
@@ -59,16 +94,17 @@ public function fix($json, $silent = false, $missingValue = 'null')
             return $tmpJson;
         }
 
-        $this->reset($missingValue);
+        $this->reset();
 
-        return $head . $this->doFix(\rtrim($json), $silent) . $tail;
+        return $head . $this->doFix($json) . $tail;
     }
 
     protected function trim($json)
     {
         \preg_match('/^(\s*)([^\s]+)(\s*)$/', $json, $match);
 
-        $match += ['', '', \trim($json), ''];
+        $match += ['', '', '', ''];
+        $match[2] = \trim($json);
 
         \array_shift($match);
 
@@ -95,6 +131,14 @@ protected function quickFix($json)
         return $this->padString($json);
     }
 
+    protected function reset()
+    {
+        $this->stack     = [];
+        $this->inStr     = false;
+        $this->objectPos = -1;
+        $this->arrayPos  = -1;
+    }
+
     protected function maybeLiteral($json)
     {
         if (!\in_array($json[0], ['t', 'f', 'n'])) {
@@ -112,18 +156,7 @@ protected function maybeLiteral($json)
         // @codeCoverageIgnoreEnd
     }
 
-    protected function reset($missingValue = 'null')
-    {
-        $this->stack = [];
-        $this->inStr = false;
-
-        $this->objectPos = -1;
-        $this->arrayPos  = -1;
-
-        $this->missingValue = $missingValue;
-    }
-
-    protected function doFix($json, $silent = false)
+    protected function doFix($json)
     {
         list($index, $char) = [-1, ''];
 
@@ -137,7 +170,7 @@ protected function doFix($json, $silent = false)
             }
         }
 
-        return $this->fixOrFail($json, $silent);
+        return $this->fixOrFail($json);
     }
 
     protected function stack($prev, $char, $index, $next)
@@ -208,7 +241,7 @@ protected function updatePos($char, $index)
         }
     }
 
-    protected function fixOrFail($json, $silent)
+    protected function fixOrFail($json)
     {
         $length  = \strlen($json);
         $tmpJson = $this->pad($json);
@@ -217,7 +250,7 @@ protected function fixOrFail($json, $silent)
             return $tmpJson;
         }
 
-        if ($silent) {
+        if ($this->silent) {
             return $json;
         }
 

tests/FixerTest.php

@@ -6,41 +6,45 @@
 
 class FixerTest extends \PHPUnit\Framework\TestCase
 {
-    protected static $fixer;
+    protected $fixer;
 
-    public static function setUpBeforeClass()
+    public function setUp()
     {
-        static::$fixer = new Fixer;
+        $this->fixer = new Fixer;
     }
 
     /** @dataProvider theTests */
     public function test($json, $expect, $msg = null)
     {
-        $this->assertSame($expect, static::$fixer->fix($json), $msg);
+        $this->assertSame($expect, $this->fixer->fix($json), $msg);
     }
 
     public function test_invalid_literal()
     {
-        $this->assertSame('{"a" : invalid', static::$fixer->fix('{"a" : invalid', true));
-        $this->assertSame(' hmm ', static::$fixer->fix(' hmm ', true));
+        $this->fixer->silent(true);
+
+        $this->assertSame('{"a" : invalid', $this->fixer->fix('{"a" : invalid'));
+        $this->assertSame(' hmm ', $this->fixer->fix(' hmm '));
     }
 
     public function test_ws()
     {
-        $this->assertSame('{ "a"  :null}', static::$fixer->fix('{ "a"  :'));
-        $this->assertSame("\n [{}]", static::$fixer->fix("\n [{,"));
+        $this->assertSame('{ "a"  :null}', $this->fixer->missingValue(null)->fix('{ "a"  :'));
+        $this->assertSame("\n [{}]", $this->fixer->fix("\n [{,"));
     }
 
     public function test_custom_missing()
     {
-        $this->assertSame('{"a":false}', static::$fixer->fix('{"a', false, 'false'));
-        $this->assertSame('{"a":true}', static::$fixer->fix('{"a":', false, 'true'));
-        $this->assertSame('{"a":1,"b":"missing"}', static::$fixer->fix('{"a":1,"b"', false, '"missing"'));
+        $this->assertSame('{"a":false}', $this->fixer->missingValue(false)->fix('{"a'));
+        $this->assertSame('{"a":true}', $this->fixer->missingValue('true')->fix('{"a":'));
+        $this->assertSame('{"a":1,"b":"missing"}', $this->fixer->missingValue('"missing"')->fix('{"a":1,"b"'));
     }
 
     public function test_fail_silent()
     {
-        $this->assertSame('{"a"}', static::$fixer->fix('{"a"}', true));
+        $this->fixer->silent(true);
+
+        $this->assertSame('{"a"}', $this->fixer->fix('{"a"}'));
     }
 
     /**
@@ -49,7 +53,9 @@ public function test_fail_silent()
      */
     public function test_fail_throws()
     {
-        static::$fixer->fix('{,"a');
+        $this->fixer->silent(false);
+
+        $this->fixer->fix('{,"a');
     }
 
     public function theTests()