cel 0.2.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da576b6bec07758040135b557e1e135952bee1e4e6bb4bc19768233b817bbe8f
-  data.tar.gz: bce3a0b0b7cd41113898fc7ebfaa1a5e3adcd94fc84b5791ef2bd9a6e33b4a60
+  metadata.gz: 82fcb37e45c0553a7c073b58e4c6b7203cc50bd186419724d72f5f1b0217e3f5
+  data.tar.gz: 44170fc7001634abc19860db8dcbc8c05ae8974716ad80dd28c4316dc0cec7f3
 SHA512:
-  metadata.gz: 88ad2004603260595e7995be27fd3f77d0e0de8a0c90e16569ce67c3018608530b1d0e2455e6a8a65949254818bdc698d3be8fea2c45866589eb153ddb3a7d4d
-  data.tar.gz: '028149b8a3f5b06c0ae5ebb02f3d09144ec42af89506971c3677f8671e8ccace55ee8b575fb1282f32a041872edee4e44f1fd9a8cb14e6889ba343794e60ae0e'
+  metadata.gz: 593ec20b7001fe593d6df79928ca8411327251fff2405491eb33642299cf6bc09d255d0088fdb6a1deda77eabccf8bcce229ad5038f68ee932f9c10ef162cdc0
+  data.tar.gz: 55eb21528a3ff994f5fc013ca49ded2b7cb0aaf9d5d434c671fc0cd534ed0119269c1e2bf8b5fe9e44ba1f1e05f51d30f5fd84abd1f44d740898dd971b341ece

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 ## [Unreleased]
 
+## [0.3.1] - 2025-08-01
+
+### Improvements
+
+* Support for depth protection, using the defaults from the spec (ex: recursion depth of 32, nesting depth of 32), and supporting API to override them (ex: `Cel::Environment.new(max_recursion_depth: 42))`).
+* lazy-evaluating bindings to avoid upfront costly transformations of ruby objects into cel objects which are ultimately not used in expressions.
+
+### Bugfixes
+
+* `has()` macro correctly works for mapsl
+
+## [0.3.0] - 2025-06-12
+
+### Features
+
+* Integration with `google-protobuf` (optional dependency) by evaluating messages to protobuf stubs, and making them an integral part of the CEL type set. Some examples:
+  * auto-conversion of protobuf wrapper types.
+  * enums support
+
+### Improvements
+
+* More correct parsing, checking and evaluation of CEL expressions, thanks to the issues identified by conformance tests.
+
+### Chore
+
+* Incorporation of the oficial cel-spec conformance tests into the test suite, to ensure feature correctness.
+* `bigdecimal` added as explicit dependency.
+
 ## [0.2.3] - 2023-09-19
 
 ### Bugfixes

data/README.md

@@ -32,7 +32,7 @@ The usage pattern follows the pattern defined by [cel-go](https://github.com/goo
 require "cel"
 
 # set the environment
-env = Cel::Environment.new(name: :string, group: :string)
+env = Cel::Environment.new(declarations: { name: :string, group: :string })
 
 # 1.1 parse
 begin
@@ -67,20 +67,52 @@ end
 puts return_value #=> true
 ```
 
-### types
+### Environment
 
-`cel-ruby` supports declaring the types of variables in the environment, which allows for expression checking:
+`Cel::Environment` is the entrypoint for parsing, checking and evaluating CEL expressions, as well as customizing/constraining any of these functions. For that matter, it can be initialized with the following keyword arguments:
+
+* `:declarations`: a hash of the expected variables names-to-cel-types, which are used to validate the expression and data bindings. When variables aren't declared, they assume the `any` type.
+* `:container`: used to declare the package of protobuf messages only declared by name used in the expression (i.e. `cel.expr.conformance.proto3`).
+* `:disable_check`: (defaults to `false`) enables/disables expression check phase (except when `env.check(expr)` is explicitly called).
+* `max_recursion_depth`: (defaults to `32`) max number of parsable recursive/repeating rules, as per what the spec states.
+* `max_nesting_depth`: (defaults to `12`) max number of parsable nested rules, as per what the spec states.
+
+#### declarations
+
+`cel-ruby` supports declaring the types of variables in the environment, which enhances expression type checking:
 
 ```ruby
+# without declarations
+env = Cel::Environment.new
+env.check("[first_name] + middle_names + [last_name]") #=> any
+
+# with declarations
 env = Cel::Environment.new(
-  first_name: :string, # shortcut for Cel::Types[:string]
-  middle_names: Cel::Types[:list, :string], # list of strings
-  last_name: :string
+  declarations: {
+    first_name: :string, # shortcut for Cel::Types[:string]
+    middle_names: Cel::TYPES[:list, :string], # list of strings
+    last_name: :string
+  }
 )
+env.check("[first_name] + middle_names + [last_name]") #=> list(string)
+
+# you can use Cel::TYPES to access any type of primitive type, i.e. Cel::TYPES[:bytes]
+```
+
+#### :container
 
-# you can use Cel::Types to access any type of primitive type, i.e. Cel::Types[:bytes]
+This can be used to simplify writing CEL expressions with long protobuf package declarations:
+
+```ruby
+env = Cel::Environment.new
+env.evaluate("my.company.private.protobufs.Account{id: 2}.id)")
+# or
+env = Cel::Environment.new(container: "my.company.private.protobufs.")
+env.evaluate("Account{id: 2}.id)")
 ```
 
+**Note**: the `google.protobuf` packaged is already supported OOTB.
+
 ### protobuf
 
 If `google/protobuf` is available in the environment, `cel-ruby` will also be able to integrate with protobuf declarations in CEL expressions.
@@ -107,9 +139,23 @@ env2 = environment(foo: -> (a, b) { a + b})
 env2.evaluate("foo(2, 2)") #=> 4
 ```
 
+## Spec Coverage
+
+`cel` is tested against the conformance suite from the [cel-spec repository](https://github.com/google/cel-spec/tree/master/conformance), and supports all features from the language except:
+
+* math extensions
+* string extensions
+* bindings extensions
+* block extensions
+* encoders extensions
+* comprehensions V2 API
+* optionals
+
+If this is something you're interested in (helping out), add a mention in the corresponding issue (or create one when non is available already).
+
 ## Supported Rubies
 
-All Rubies greater or equal to 2.5, and always latest JRuby and Truffleruby.
+All Rubies greater or equal to 2.7, and always latest JRuby and Truffleruby.
 
 ## Development
 
@@ -118,8 +164,16 @@ Clone the repo in your local machine, where you have `ruby` installed. Then you
 ```bash
 # install dev dependencies
 > bundle install
+# create protobuf stubs for tests
+> git clone --depth 1 https://github.com/google/cel-spec.git
+> git clone --depth 1 https://github.com/googleapis/googleapis.git
+> bundle exec rake build_test_protos
 # run tests
 > bundle exec rake test
+# build protobuf stubs for conformance tests
+> bundle exec rake build_conformance_protos
+# run conformance tests
+> bundle exec rake conformance
 ```
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).