refactor rfc9535, moved one test to todo since it caused the panic (a…

.gitignore

@@ -1,4 +1,5 @@
 /target
+**/target
 .idea
 Cargo.lock
 .DS_Store

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "rfc9535/test_suite/jsonpath-compliance-test-suite"]
+	path = rfc9535/test_suite/jsonpath-compliance-test-suite
+	url = https://github.com/jsonpath-standard/jsonpath-compliance-test-suite.git

CHANGELOG.md

@@ -59,4 +59,7 @@
 - **`0.7.3`**
     - make some methods public
 - **`0.7.5`**
-    - add reference and reference_mut methods
+    - add reference and reference_mut methods
+- **`1.0.1`**
+    - introduced breaking changes to the API to make it compliant with the RFC9535 
+

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "jsonpath-rust"
 description = "The library provides the basic functionality to find the set of the data according to the filtering query."
-version = "0.7.5"
+version = "1.0.0"
 authors = ["BorisZhguchev <[email protected]>"]
 edition = "2021"
 license = "MIT"
@@ -14,14 +14,14 @@ categories = ["development-tools", "parsing", "text-processing"]
 [dependencies]
 serde_json = "1.0"
 regex = "1"
-pest = "2.0"
-pest_derive = "2.0"
+pest = "2.7.15"
+pest_derive = "2.7.15"
 thiserror = "2.0.9"
 
 [dev-dependencies]
 serde = { version = "1.0", features = ["derive"] }
 criterion = "0.5.1"
-colored = "2"
+
 
 [[bench]]
 name = "regex"

benches/equal.rs

@@ -1,33 +1,36 @@
 use criterion::{criterion_group, criterion_main, Criterion};
-use jsonpath_rust::{JsonPath, JsonPathQuery};
-use serde_json::json;
-use std::str::FromStr;
+
+use jsonpath_rust::parser::model::JpQuery;
+use jsonpath_rust::parser::parse_json_path;
+use jsonpath_rust::query::state::State;
+use jsonpath_rust::query::Query;
+use jsonpath_rust::JsonPath;
+use serde_json::{json, Value};
 
 struct SearchData {
-    json: serde_json::Value,
-    path: JsonPath,
+    json: Value,
+    path: JpQuery,
 }
 
-const PATH: &str = "$.[?(@.author == 'abcd(Rees)')]";
+const PATH: &str = "$[?@.author == 'abcd(Rees)']";
 
 fn equal_perf_test_with_reuse(cfg: &SearchData) {
-    let _v = cfg.path.find(&cfg.json);
+    let _v = cfg.path.process(State::root(&cfg.json)).data;
 }
-
 fn equal_perf_test_without_reuse() {
     let json = Box::new(json!({
         "author":"abcd(Rees)",
     }));
 
-    let _v = json.path(PATH).expect("the path is correct");
+    let _v = json.query(PATH).expect("the path is correct");
 }
 
 pub fn criterion_benchmark(c: &mut Criterion) {
     let data = SearchData {
         json: json!({
             "author":"abcd(Rees)",
         }),
-        path: JsonPath::from_str(PATH).unwrap(),
+        path: parse_json_path(PATH).unwrap(),
     };
     c.bench_function("equal bench with reuse", |b| {
         b.iter(|| equal_perf_test_with_reuse(&data))

benches/regex.rs

@@ -1,37 +1,40 @@
 use criterion::{criterion_group, criterion_main, Criterion};
-use jsonpath_rust::{JsonPath, JsonPathQuery};
+use jsonpath_rust::parser::model::JpQuery;
+use jsonpath_rust::parser::parse_json_path;
+use jsonpath_rust::query::state::State;
+use jsonpath_rust::query::Query;
+use jsonpath_rust::JsonPath;
 use serde_json::{json, Value};
-use std::str::FromStr;
 
 struct SearchData {
-    json: serde_json::Value,
-    path: JsonPath,
+    json: Value,
+    path: JpQuery,
 }
 
-const PATH: &str = "$.[?(@.author ~= '.*(?i)d\\(Rees\\)')]";
+const PATH: &str = "$[?search(@.author,'.*(?i)d\\\\(Rees\\\\)')]";
 
 fn regex_perf_test_with_reuse(cfg: &SearchData) {
-    let _v = cfg.path.find(&cfg.json);
+    let _v = cfg.path.process(State::root(&cfg.json)).data;
 }
 
 fn regex_perf_test_without_reuse() {
     let json = Box::new(json!({
         "author":"abcd(Rees)",
     }));
 
-    let _v = json.path(PATH).expect("the path is correct");
+    let _v = json.query(PATH).expect("the path is correct");
 }
 
 fn json_path_compiling() {
-    let _v = JsonPath::<Value>::from_str(PATH).unwrap();
+    let _v = parse_json_path(PATH).unwrap();
 }
 
 pub fn criterion_benchmark(c: &mut Criterion) {
     let data = SearchData {
         json: json!({
             "author":"abcd(Rees)",
         }),
-        path: JsonPath::from_str(PATH).unwrap(),
+        path: parse_json_path(PATH).unwrap(),
     };
     c.bench_function("regex bench with reuse", |b| {
         b.iter(|| regex_perf_test_with_reuse(&data))

rfc9535/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "jsonpath-rust-rfc9535"
+description = "The tests to check the compliance with RFC 9535"
+version = "0.0.1"
+edition = "2021"
+license = "MIT"
+readme = "README.md"
+
+
+[dependencies]
+jsonpath-rust = { path = "../" }
+serde_json = "1.0"
+serde = { version = "1.0.217", features = ["derive"] }
+colored = "2.0"
+chrono = "0.4.39"

rfc9535/README.md

@@ -0,0 +1,31 @@
+# Tests for RFC9535
+
+This directory contains tests for the [RFC9535](https://www.rfc-editor.org/info/rfc9535) implementation.
+The tests can be downloaded using `prepare.sh` script.
+
+## Usage
+Run the main.rs.
+It will print the test results in the console with the following format:
+```
+...
+Skipping test case: `<name>` because of reason: `reason`
+...
+Failed tests:
+
+------- <name> -------
+<reason>
+
+...
+
+RFC9535 Compliance tests:
+Total: 671
+Passed: 209
+Failed: 462
+Skipped: 25 where 18 to fix in 5 issues
+
+```
+
+The results will be saved in the `results.csv` file.
+
+The cases can be filtered using `filtered_cases.json` file. 
+The file should contain json array with the test case names that should be filtered out and the reason.

rfc9535/src/console.rs

@@ -0,0 +1,79 @@
+use crate::suite::TestFailure;
+use chrono::Local;
+use colored::Colorize;
+use std::fs::{File, OpenOptions};
+use std::io::Write;
+use std::io::{BufRead, BufReader, Error};
+pub fn process_results(
+    results: Vec<TestResult>,
+    skipped_cases: usize,
+    skipped_to_fix: usize,
+    issues: usize,
+) -> Result<(), Error> {
+    let (passed, failed): (Vec<_>, Vec<_>) = results.into_iter().partition(TestResult::is_ok);
+    let total = passed.len() + failed.len() + skipped_cases;
+    let passed_count = passed.len();
+    let failed_count = failed.len();
+    let date = Local::now().format("%Y-%m-%d %H:%M:%S").to_string();
+
+    if failed_count > 0 {
+        println!("\n{}:", "Failed tests".bold());
+        println!("\n");
+    }
+    for failure in failed.iter() {
+        if let Err(TestFailure(case, reason)) = failure {
+            println!(" ------- {} -------", case.name.bold());
+            println!("{}", reason.bold().red());
+        }
+    }
+
+    let mut file = OpenOptions::new()
+        .create(true)
+        .append(true)
+        .open("test_suite/results.csv")?;
+    writeln!(
+        file,
+        "{}; {}; {}; {}",
+        total, passed_count, failed_count, date
+    )?;
+
+    clean_file(10)?;
+
+    println!(
+        "\n{}:\n{}\n{}\n{}\n{}",
+        format!("RFC9535 Compliance tests").underline().bold(),
+        format!("Total: {}", total).bold(),
+        format!("Passed: {}", passed_count).green().bold(),
+        format!("Failed: {}", failed_count).red().bold(),
+        format!(
+            "Skipped: {} where {} to fix in {} issues",
+            skipped_cases, skipped_to_fix, issues
+        )
+        .bold()
+    );
+    Ok(())
+}
+
+fn clean_file(limit: usize) -> Result<(), Error> {
+    let file_path = "test_suite/results.csv";
+    let file = File::open(file_path)?;
+    let reader = BufReader::new(file);
+    let lines: Vec<String> = reader.lines().collect::<Result<_, _>>()?;
+
+    if lines.len() > limit {
+        let header = &lines[0];
+        let trimmed_lines = [&[header.clone()], &lines[lines.len() - limit..]].concat();
+
+        let mut file = OpenOptions::new()
+            .write(true)
+            .truncate(true)
+            .open(file_path)?;
+        for line in trimmed_lines {
+            writeln!(file, "{}", line)?;
+        }
+    }
+
+    Ok(())
+}
+
+pub type TestResult<'a> = Result<(), TestFailure<'a>>;

rfc9535/src/main.rs

@@ -0,0 +1,23 @@
+
+mod console;
+mod suite;
+use crate::suite::get_suite;
+use colored::Colorize;
+use console::TestResult;
+use std::io::Error;
+use std::io::Write;
+use std::str::FromStr;
+
+fn main() -> Result<(), Error> {
+    let (cases, skipped, skipped_to_fix, issues) = get_suite()?;
+    console::process_results(
+        cases
+            .iter()
+            .map(suite::handle_test_case)
+            .collect::<Vec<TestResult>>(),
+        skipped,
+        skipped_to_fix,
+        issues,
+    )
+}
+