Add lint method and custom exception

Author: Seldaek

bin/jsonlint

@@ -2,7 +2,7 @@
 <?php
 
 /*
- * This file is part of the JsonLint package.
+ * This file is part of the JSON Lint package.
  *
  * (c) Jordi Boggiano <[email protected]>
  *
@@ -30,5 +30,8 @@ if (!is_readable($file)) {
 }
 
 $parser = new JsonParser();
-$parser->parse(file_get_contents($file));
+if ($err = $parser->lint(file_get_contents($file))) {
+    echo $err->getMessage().PHP_EOL;
+    exit(1);
+}
 echo 'Valid JSON'.PHP_EOL;

phpunit.xml.dist

@@ -12,7 +12,7 @@
          bootstrap="tests/bootstrap.php"
 >
     <testsuites>
-        <testsuite name="JsonLint Test Suite">
+        <testsuite name="JSON Lint Test Suite">
             <directory>./tests/</directory>
         </testsuite>
     </testsuites>

src/Seld/JsonLint/JsonParser.php

@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the JsonLint package.
+ * This file is part of the JSON Lint package.
  *
  * (c) Jordi Boggiano <[email protected]>
  *
@@ -19,10 +19,10 @@
  * Example:
  *
  * $parser = new JsonParser();
- * // returns parsed json, like json_decode does, but slower, throws exceptions on failure.
- * $parser->parse($json);
  * // returns null if it's valid json, or an error object
  * $parser->lint($json);
+ * // returns parsed json, like json_decode does, but slower, throws exceptions on failure.
+ * $parser->parse($json);
  *
  * Ported from https://github.com/zaach/jsonlint
  */
@@ -110,6 +110,24 @@ class JsonParser
         16 => array(2, 6)
     );
 
+    /**
+     * @param string $input JSON string
+     * @return null|ParsingException null if no error is found, a ParsingException containing all details otherwise
+     */
+    public function lint($input)
+    {
+        try {
+            $this->parse($input);
+        } catch (ParsingException $e) {
+            return $e;
+        }
+    }
+
+    /**
+     * @param string $input JSON string
+     * @return mixed
+     * @throws ParsingException
+     */
     public function parse($input)
     {
         $this->stack = array(0);
@@ -168,7 +186,7 @@ public function parse($input)
                         }
                     }
 
-                    $errStr = 'Parse error on line ' . ($yylineno+1) . ":\n" . $this->lexer->showPosition() . "\nExpecting " . implode(', ', $expected);
+                    $errStr = 'Parse error on line ' . ($yylineno+1) . ":\n" . $this->lexer->showPosition() . "\nExpected one of: " . implode(', ', $expected);
                     $this->parseError($errStr, array(
                         'text' => $this->lexer->match,
                         'token' => !empty($this->terminals_[$symbol]) ? $this->terminals_[$symbol] : $symbol,
@@ -181,7 +199,7 @@ public function parse($input)
                 // just recovered from another error
                 if ($recovering == 3) {
                     if ($symbol == $EOF) {
-                        throw new \Exception($errStr ?: 'Parsing halted.');
+                        throw new ParsingException($errStr ?: 'Parsing halted.');
                     }
 
                     // discard current lookahead and grab another
@@ -199,7 +217,7 @@ public function parse($input)
                         break;
                     }
                     if ($state == 0) {
-                        throw new \Exception($errStr ?: 'Parsing halted.');
+                        throw new ParsingException($errStr ?: 'Parsing halted.');
                     }
                     $this->popStack(1);
                     $state = $this->stack[count($this->stack)-1];
@@ -214,7 +232,7 @@ public function parse($input)
 
             // this shouldn't happen, unless resolve defaults are off
             if (is_array($action[0]) && count($action) > 1) {
-                throw new \Exception('Parse Error: multiple actions possible at state: ' . $state . ', token: ' . $symbol);
+                throw new ParsingException('Parse Error: multiple actions possible at state: ' . $state . ', token: ' . $symbol);
             }
 
             switch ($action[0]) {
@@ -276,7 +294,7 @@ public function parse($input)
 
     protected function parseError($str, $hash)
     {
-        throw new \Exception($str);
+        throw new ParsingException($str, $hash);
     }
 
     // $$ = $tokens // needs to be passed by ref?

src/Seld/JsonLint/Lexer.php

@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the JsonLint package.
+ * This file is part of the JSON Lint package.
  *
  * (c) Jordi Boggiano <[email protected]>
  *

src/Seld/JsonLint/ParsingException.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the JSON Lint package.
+ *
+ * (c) Jordi Boggiano <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Seld\JsonLint;
+
+class ParsingException extends \Exception
+{
+    protected $details;
+
+    public function __construct($message, $details = array())
+    {
+        $this->details = $details;
+        parent::__construct($message);
+    }
+
+    public function getDetails()
+    {
+        return $this->details;
+    }
+}

src/Seld/JsonLint/Undefined.php

@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the JsonLint package.
+ * This file is part of the JSON Lint package.
  *
  * (c) Jordi Boggiano <[email protected]>
  *

tests/JsonParserTest.php

@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the JsonLint package.
+ * This file is part of the JSON Lint package.
  *
  * (c) Jordi Boggiano <[email protected]>
  *

tests/bootstrap.php

@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of the JsonLint package.
+ * This file is part of the JSON Lint package.
  *
  * (c) Jordi Boggiano <[email protected]>
  *