From 5ae2d256d3836dea02f0907f622bdc8c05e6fcb7 Mon Sep 17 00:00:00 2001
From: Dustin Wilson <dustin@dustinwilson.com>
Date: Tue, 29 Jun 2021 13:54:54 -0500
Subject: [PATCH] Cleaning up a bit

---
 lib/Data.php                         |  2 +-
 lib/Grammar.php                      | 16 -----------
 lib/Grammar/Registry.php             | 42 ++++++++++++++++++++--------
 lib/Highlighter.php                  |  2 +-
 lib/Scope/Data.php                   |  2 +-
 lib/Scope/Exception.php              |  4 +--
 lib/Scope/Matcher.php                |  2 +-
 lib/Scope/Matchers/AndMatcher.php    |  2 +-
 lib/Scope/Matchers/GroupMatcher.php  |  2 +-
 lib/Scope/Matchers/NegateMatcher.php |  2 +-
 lib/Scope/Matchers/OrMatcher.php     |  2 +-
 lib/Scope/Matchers/PathMatcher.php   |  2 +-
 lib/Scope/Matchers/ScopeMatcher.php  |  2 +-
 lib/Scope/Parser.php                 |  2 +-
 lib/Tokenizer.php                    |  2 +-
 15 files changed, 44 insertions(+), 42 deletions(-)
 delete mode 100644 lib/Grammar.php

diff --git a/lib/Data.php b/lib/Data.php
index 52f81fc..6250bb9 100644
--- a/lib/Data.php
+++ b/lib/Data.php
@@ -1,7 +1,7 @@
 <?php
 /** @license MIT
  * Copyright 2021 Dustin Wilson et al.
- * See LICENSE and AUTHORS files for details */
+ * See LICENSE file for details */
 
 declare(strict_types=1);
 namespace dW\Lit;
diff --git a/lib/Grammar.php b/lib/Grammar.php
deleted file mode 100644
index f45c8ee..0000000
--- a/lib/Grammar.php
+++ /dev/null
@@ -1,16 +0,0 @@
-<?php
-/** @license MIT
- * Copyright 2021 Dustin Wilson et al.
- * See LICENSE and AUTHORS files for details */
-
-declare(strict_types=1);
-namespace dW\Lit;
-
-interface Grammar {
-    public static array $fileTypes;
-    public static string $firstLineMatch;
-    public static string $name;
-    public static GrammarPattern $patterns;
-    public static GrammarRepository $repository;
-    public static string $scopeName;
-}
\ No newline at end of file
diff --git a/lib/Grammar/Registry.php b/lib/Grammar/Registry.php
index 97451af..34cf112 100644
--- a/lib/Grammar/Registry.php
+++ b/lib/Grammar/Registry.php
@@ -1,7 +1,7 @@
 <?php
 /** @license MIT
  * Copyright 2021 Dustin Wilson et al.
- * See LICENSE and AUTHORS files for details */
+ * See LICENSE file for details */
 
 declare(strict_types=1);
 namespace dW\Lit\Grammar;
@@ -34,25 +34,43 @@ class Registry {
         return false;
     }
 
-    public static function import(string $jsonPath, bool $force = false): bool {
-        if (!file_exists($jsonPath)) {
-            throw new \Exception("Path \"$jsonPath\" either does not exist or you do not have permission to view the file.");
-        }
+    public static function import(string $jsonPath) {}
 
-        $grammar = json_decode(file_get_contents($jsonPath), true);
+    public static function validate(string $grammar): bool {
         if ($grammar === null) {
-            throw new \Exception("\"$jsonPath\" is not a valid grammar JSON file.");
+            throw new \Exception("\"$jsonPath\" is not a valid grammar JSON file.".\PHP_EOL);
         }
 
-        if (!isset($grammar['scopeName'])) {
-            throw new \Exception("\"$jsonPath\" is missing the required scopeName property.");
+        $requiredProperties = [
+            'name',
+            'patterns',
+            'scopeName'
+        ];
+
+        $missing = [];
+        foreach ($requiredProperties as $r) {
+            if (!array_key_exists($r, $grammar))) {
+                $missing = $r;
+            }
         }
 
-        if (!$force && isset(self::$grammars[$grammar['scopeName']])) {
-            throw new \Exception("Grammar with the \"{$grammar['scopeName']}\" scope already exists.");
+        $missingLen = count($missing);
+        if ($missingLen > 0) {
+            if ($missingLen > 1) {
+                if ($missingLen > 2) {
+                    $last = array_pop($missing);
+                    $missing = implode(', ', $missing);
+                    $missing .= ", and $last";
+                } else {
+                    $missing = implode(' and ', $missing);
+                }
+
+                throw new \Exception("\"$jsonPath\" is missing the required $missing properties.".\PHP_EOL);
+            }
+
+            throw new \Exception("\"$jsonPath\" is missing the required {$missing[0]} property.".\PHP_EOL);
         }
 
-        self::$grammars[$grammar['scopeName']] = $grammar;
         return true;
     }
 }
\ No newline at end of file
diff --git a/lib/Highlighter.php b/lib/Highlighter.php
index 74573ec..e61097d 100644
--- a/lib/Highlighter.php
+++ b/lib/Highlighter.php
@@ -1,7 +1,7 @@
 <?php
 /** @license MIT
  * Copyright 2021 Dustin Wilson et al.
- * See LICENSE and AUTHORS files for details */
+ * See LICENSE file for details */
 
 declare(strict_types=1);
 namespace dW\Lit;
diff --git a/lib/Scope/Data.php b/lib/Scope/Data.php
index a569e08..5a60b28 100644
--- a/lib/Scope/Data.php
+++ b/lib/Scope/Data.php
@@ -1,7 +1,7 @@
 <?php
 /** @license MIT
  * Copyright 2021 Dustin Wilson et al.
- * See LICENSE and AUTHORS files for details */
+ * See LICENSE file for details */
 
 declare(strict_types=1);
 namespace dW\Lit\Scope;
diff --git a/lib/Scope/Exception.php b/lib/Scope/Exception.php
index 477f73d..633ff3b 100644
--- a/lib/Scope/Exception.php
+++ b/lib/Scope/Exception.php
@@ -1,13 +1,13 @@
 <?php
 /** @license MIT
  * Copyright 2021 Dustin Wilson et al.
- * See LICENSE and AUTHORS files for details */
+ * See LICENSE file for details */
 
 declare(strict_types=1);
 namespace dW\Lit\Scope;
 
 class Exception extends \Exception {
-    const MESSAGE = "%s expected; found %s at offset %s\n";
+    const MESSAGE = '%s expected; found %s at offset %s'.\PHP_EOL;
 
     public function __construct(array|string $expected, string|bool $found, int $offset) {
         if (!is_string($expected)) {
diff --git a/lib/Scope/Matcher.php b/lib/Scope/Matcher.php
index b3673f2..bf3acb6 100644
--- a/lib/Scope/Matcher.php
+++ b/lib/Scope/Matcher.php
@@ -1,7 +1,7 @@
 <?php
 /** @license MIT
  * Copyright 2021 Dustin Wilson et al.
- * See LICENSE and AUTHORS files for details */
+ * See LICENSE file for details */
 
 declare(strict_types=1);
 namespace dW\Lit\Scope;
diff --git a/lib/Scope/Matchers/AndMatcher.php b/lib/Scope/Matchers/AndMatcher.php
index 9c6520c..de128ce 100644
--- a/lib/Scope/Matchers/AndMatcher.php
+++ b/lib/Scope/Matchers/AndMatcher.php
@@ -1,7 +1,7 @@
 <?php
 /** @license MIT
  * Copyright 2021 Dustin Wilson et al.
- * See LICENSE and AUTHORS files for details */
+ * See LICENSE file for details */
 
 declare(strict_types=1);
 namespace dW\Lit\Scope;
diff --git a/lib/Scope/Matchers/GroupMatcher.php b/lib/Scope/Matchers/GroupMatcher.php
index 4592647..e16f7b6 100644
--- a/lib/Scope/Matchers/GroupMatcher.php
+++ b/lib/Scope/Matchers/GroupMatcher.php
@@ -1,7 +1,7 @@
 <?php
 /** @license MIT
  * Copyright 2021 Dustin Wilson et al.
- * See LICENSE and AUTHORS files for details */
+ * See LICENSE file for details */
 
 declare(strict_types=1);
 namespace dW\Lit\Scope;
diff --git a/lib/Scope/Matchers/NegateMatcher.php b/lib/Scope/Matchers/NegateMatcher.php
index e459823..250445c 100644
--- a/lib/Scope/Matchers/NegateMatcher.php
+++ b/lib/Scope/Matchers/NegateMatcher.php
@@ -1,7 +1,7 @@
 <?php
 /** @license MIT
  * Copyright 2021 Dustin Wilson et al.
- * See LICENSE and AUTHORS files for details */
+ * See LICENSE file for details */
 
 declare(strict_types=1);
 namespace dW\Lit\Scope;
diff --git a/lib/Scope/Matchers/OrMatcher.php b/lib/Scope/Matchers/OrMatcher.php
index 31b1899..ab9ba42 100644
--- a/lib/Scope/Matchers/OrMatcher.php
+++ b/lib/Scope/Matchers/OrMatcher.php
@@ -1,7 +1,7 @@
 <?php
 /** @license MIT
  * Copyright 2021 Dustin Wilson et al.
- * See LICENSE and AUTHORS files for details */
+ * See LICENSE file for details */
 
 declare(strict_types=1);
 namespace dW\Lit\Scope;
diff --git a/lib/Scope/Matchers/PathMatcher.php b/lib/Scope/Matchers/PathMatcher.php
index 25bc37e..0dfe555 100644
--- a/lib/Scope/Matchers/PathMatcher.php
+++ b/lib/Scope/Matchers/PathMatcher.php
@@ -1,7 +1,7 @@
 <?php
 /** @license MIT
  * Copyright 2021 Dustin Wilson et al.
- * See LICENSE and AUTHORS files for details */
+ * See LICENSE file for details */
 
 declare(strict_types=1);
 namespace dW\Lit\Scope;
diff --git a/lib/Scope/Matchers/ScopeMatcher.php b/lib/Scope/Matchers/ScopeMatcher.php
index 2a190a5..2dbd58a 100644
--- a/lib/Scope/Matchers/ScopeMatcher.php
+++ b/lib/Scope/Matchers/ScopeMatcher.php
@@ -1,7 +1,7 @@
 <?php
 /** @license MIT
  * Copyright 2021 Dustin Wilson et al.
- * See LICENSE and AUTHORS files for details */
+ * See LICENSE file for details */
 
 declare(strict_types=1);
 namespace dW\Lit\Scope;
diff --git a/lib/Scope/Parser.php b/lib/Scope/Parser.php
index 9173d8f..4d3f984 100644
--- a/lib/Scope/Parser.php
+++ b/lib/Scope/Parser.php
@@ -1,7 +1,7 @@
 <?php
 /** @license MIT
  * Copyright 2021 Dustin Wilson et al.
- * See LICENSE and AUTHORS files for details */
+ * See LICENSE file for details */
 
 declare(strict_types=1);
 namespace dW\Lit\Scope;
diff --git a/lib/Tokenizer.php b/lib/Tokenizer.php
index 8ec5e86..b8d01b5 100644
--- a/lib/Tokenizer.php
+++ b/lib/Tokenizer.php
@@ -1,7 +1,7 @@
 <?php
 /** @license MIT
  * Copyright 2021 Dustin Wilson et al.
- * See LICENSE and AUTHORS files for details */
+ * See LICENSE file for details */
 
 declare(strict_types=1);
 namespace dW\Lit;