fix: fix parser incorrectly escaping labels

Added reliability proptests for query parsers and updated the docs for the grammar.

Ref: #51

.vscode/settings.json

@@ -39,6 +39,7 @@
         "owo_colors",
         "Peekable",
         "proptest",
+        "proptests",
         "regs",
         "repr",
         "rsonpath",

CHANGELOG.md

@@ -2,6 +2,23 @@
 
 All notable changes to this project will be documented in this file.
 
+## Unreleased
+
+### Bug fixes
+
+- Fix parser incorrectly escaping labels.
+  - Queries like `$['\'']` would cause a parsing error, even though they were valid (match a child with key equal to "`'`").
+  - The `\u` escape sequence is no longer recognized, since without UTF-8 handling they were meaningless.
+    See ([#117](https://github.com/V0ldek/rsonpath/issues/117)).
+
+### Documentation
+
+- The grammar in top-level documentation now matches the implementation.
+
+### Reliability
+
+- Added proptests for query parsing.
+
 ## [0.3.3] - 2023-03-29
 
 ### Bug Fixes

crates/rsonpath-lib/src/lib.rs

@@ -85,11 +85,11 @@
 //! single quoted label = { UNESCAPED | ESCAPED | '"' | "\'" }
 //! double quoted label = { UNESCAPED | ESCAPED | "'" | '\"' }
 //!
-//! ALPHA = ? [A-Z][a-z] ?
-//! ALPHANUMERIC = ? [A-Z][a-z][0-9] ?
-//! NONASCII = ? UTF8 characters outside of U+0000-U+007F ?
-//! UNESCAPED = ? [^'"] ?
-//! ESCAPED = ? [btnfru/\\] ?
+//! ALPHA = ? [A-Za-z] ?
+//! ALPHANUMERIC = ? [A-Za-z0-9] ?
+//! NONASCII = ? [\u0080-\u10FFFF] ?
+//! UNESCAPED = ? [^'"\u0000-\u001F] ?
+//! ESCAPED = ? \\[btnfr/\\] ?
 //! ```
 //!
 //! ## Semantics

crates/rsonpath-lib/src/query/error.rs

@@ -63,7 +63,7 @@ pub enum ParserError {
 }
 
 /// Error report created during the parser's run over a single input string.
-#[derive(Debug)]
+#[derive(Debug, PartialEq, Eq, Clone)]
 pub struct ParseErrorReport {
     errors: Vec<ParseError>,
 }
@@ -81,7 +81,7 @@ impl Display for ParseErrorReport {
 
 /// Single error raised during parsing, defined as the
 /// contiguous sequence of characters that caused the error.
-#[derive(Debug)]
+#[derive(Debug, PartialEq, Eq, Clone, Copy)]
 pub struct ParseError {
     /// The index at which the error occurred.
     pub start_idx: usize,