Merge branch '1BADragon:main' into main

Author: CedarMatt

.github/workflows/rust.yml

@@ -15,21 +15,34 @@ jobs:
 
     steps:
     - uses: actions/checkout@v3
+    
     - name: Build
       run: cargo build --verbose
 
   test_default:
     runs-on: ubuntu-latest
 
     steps:
+    - name: Install Protoc
+      uses: arduino/setup-protoc@v3
+
     - uses: actions/checkout@v3
+
     - name: Run tests
       run: cargo test --verbose
+      env:
+        RSCEL_TEST_PROTO: 1
 
   test_no_default:
     runs-on: ubuntu-latest
 
     steps:
+    - name: Install Protoc
+      uses: arduino/setup-protoc@v3
+
     - uses: actions/checkout@v3
+
     - name: Run tests
       run: cargo test --verbose --no-default-features
+      env:
+        RSCEL_TEST_PROTO: 1

Cargo.toml

@@ -1,13 +1,17 @@
 [package]
 name = "rscel"
-version = "0.8.0"
+version = "0.10.0"
 edition = "2021"
 description = "Cel interpreter in rust"
 license = "MIT"
 
 [lib]
 crate-type = ["cdylib", "rlib"]
 
+[profile.release-with-debug]
+inherits = "release"
+debug = true
+
 [features]
 default = ["type_prop"]
 ast_ser = []
@@ -20,6 +24,9 @@ wasm = [
   "console_error_panic_hook", "chrono/wasmbind"
 ]
 
+[build-dependencies]
+protobuf-codegen = "3.4.0"
+protoc-bin-vendored = "3.0.0"
 
 [dependencies]
 test-case = "3.2.1"
@@ -30,6 +37,7 @@ serde_json = { version = "1.0.108", features = ["raw_value"] }
 chrono = { version = "0.4.31", features = ["serde"] }
 duration-str = "0.7.0"
 num = "0.4.1"
+protobuf = { version = "3.4.0" }
 
 # Dependencies for python bindings
 pyo3 = { version = "0.20.0", optional = true, features = ["extension-module", "chrono"] }

Makefile

@@ -6,10 +6,10 @@ default: build
 build:
 	cargo build $(CARGO_ARGS)
 
-test:
+run-tests:
 	cargo test $(CARGO_ARGS)
 
-test-all: test
+run-all-tests: run-tests
 	cargo test --no-default-features $(CARGO_ARGS)
 
 .env:

README.md

@@ -10,32 +10,58 @@ The design goals of this project were are as follows:
   * Sandbox'ed in such a way that only specific values can be bound
   * Can be used as a wasm depenedency (or other ffi)
 
-While Google's CEL spec was designed around the protobuf message,
-I decided to focus on using the JSON message instead (CEL spec specifies
-how to convert from JSON to CEL types).
-
 The basic example of how to use:
 ```rust
-use rscel::{CelContext, BindContext, serde_json};
+use rscel::{CelContext, BindContext};
 
 let mut ctx = CelContext::new();
 let mut exec_ctx = BindContext::new();
 
 ctx.add_program_str("main", "foo + 3").unwrap();
-exec_ctx.bind_param("foo", 3.into()); // convert to serde_json::Value
+exec_ctx.bind_param("foo", 3.into()); // convert to CelValue
+
+let res = ctx.exec("main", &exec_ctx).unwrap(); // CelValue::Int(6)
+assert_eq!(res, 6.into());
+```
+
+As of 0.10.0 binding protobuf messages from the protobuf crate is now available! Given 
+the following protobuf message:
+```protobuf
+
+message Point {
+  int32 x = 1;
+  int32 y = 2;
+}
+  
+```
+The following code can be used to evaluate a CEL expression on a Point message:
+
+```rust
+use rscel::{CelContext, BindContext};
+
+// currently rscel required protobuf messages to be in a box 
+let p = Box::new(protos::Point::new());
+p.x = 4;
+p.y = 5;
+
+let mut ctx = CelContext::new();
+let mut exec_ctx = BindContext::new();
+
+ctx.add_program_str("main", "p.x + 3").unwrap();
+exec_ctx.bind_protobuf_msg("p", p);
 
-let res = ctx.exec("main", &exec_ctx).unwrap(); // ValueCell::Int(6)
-assert!(TryInto::<i64>::try_into(res).unwrap() == 6);
+assert_eq!(ctx.exec("main", &exec_ctx), 7.into());
+  
 ```
 
 ## Current Benchmark Times
 | Bench Run                | Time           |
 |--------------------------|----------------|
-|Run One No Binding:       |  0.000310S     |
-|Run Many No Binding:      |  0.003657S     |
-|Run One With Binding:     |  0.000033S     |
-|Run Many With Bindings:   |  0.004281S     |
-|Build Many:               |  0.002312S     |
-|Build Many With Bindings: |  0.051369S     |
+|Run One No Binding        | 0.000070054S   |
+|Run Many No Binding       | 0.003451698S   |
+|Run One With Binding      | 0.000015177S   |
+|Run Many With Bindings    | 0.004443471S   |
+|Build Many                | 0.006989954S   |
+|Build Many With Bindings  | 0.084859163S   |
 
 Build status: [![Rust](https://github.com/1BADragon/rscel/actions/workflows/rust.yml/badge.svg)](https://github.com/1BADragon/rscel/actions/workflows/rust.yml)

build.rs

@@ -0,0 +1,15 @@
+use std::env;
+
+fn main() {
+    println!("cargo:rerun-if-env-changed=RSCEL_TEST_PROTO");
+
+    if let Ok(_) = env::var("RSCEL_TEST_PROTO") {
+        println!("cargo:rustc-cfg=test_protos");
+        protobuf_codegen::Codegen::new()
+            .protoc()
+            .include("test/protos")
+            .inputs(["test/protos/test.proto"])
+            .cargo_out_dir("test_protos")
+            .run_from_script();
+    }
+}