Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Graduate the CQL2 modules to supported #18

Open
aaime opened this issue Nov 14, 2024 · 2 comments
Open

Graduate the CQL2 modules to supported #18

aaime opened this issue Nov 14, 2024 · 2 comments
Assignees

Comments

@aaime
Copy link
Member

aaime commented Nov 14, 2024

It's best if we have OGC API - Features in supported land depending on equally supported foundations.
So, we'll need to graduate the CQL2 modules.

According to procedure, we'll need an e-mail to geotools-devel.
This ticket will track progress, hold a draft of the mail, and track other activities required to achieve supported status.

@aaime
Copy link
Member Author

aaime commented Nov 14, 2024

Email draft:


Hi all,

I would like to propose moving the cql2-text and cql2-json unsupported modules to supported land.

In particular, the modules support the CQL2 filter language in its text incarnation (similar to ECQL) and its JSON incarnation (for the JSON documents that need to express a filter, and general ease of parsing from machinery (yep, it's 2024 and writing a text parser is still hard).
The modules have been used for a while in the GeoServer OGC API modules, and have been recently overhauled to match the current standard.

The CQL2 specification is modular and allows a subset of all possible filters and expression to be implemented. The CQL2 modules currently support the following requirement classes:

The following are not supported, but may be implemented in the future:

In terms of gold stars for graduation:

  • Correct headers: check
  • Releasable no blocking bugs in jira: check
  • Used in anger: sort of, GeoServer OGC API has been using it for a while. Check.
  • Optimised: Parsing is as good as it can be. Check.
  • Supported: In terms of maintainers, it will be me, Andrea Aime, and Pierre Mauduit (to be confirmed). TBD: some docs

That would be 4+ stars, enough for graduation. In addition to that:

  • cql2-text has a test coverage of 74% (when run with -Ponline)
  • cql2-json has a test coverage of 70% (when run with -Ponline)
  • Both modules pass the QA checks

To be done IMHO:

  • Add a online build running the online tests for these two modules
  • Add a small amount of documentation (examples and links to spec)

@aaime
Copy link
Member Author

aaime commented Nov 15, 2024

Documentation available here:
geotools/geotools#4987

The e-mail for graduating the modules has been sent as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

1 participant