search

warden-protocol / wardenprotocol

Monorepo for the Warden Protocol.
https://wardenprotocol.org
Apache License 2.0
1.1k stars 107 forks source link

shield: Add `string` type #309

Closed Pitasi closed 4 months ago

Pitasi commented 4 months ago

Adds a string literal type to the shield language. Adds a contains(item, [...]) builtin to easily check if an array contains a specific value (the only supported value types are ints, bools, strings).

depends on #292

closes #307

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

[!WARNING]

Review Failed

The pull request is closed.

Walkthrough

The changes introduce string literals and comparison operators (<, >, <=, >=, ==, !=) for integers in the Shield project. Enhancements include new parsing, tokenization, and evaluation logic for strings and operators, along with new functions and tests to support these features. These modifications allow the system to handle string objects and perform type-specific comparisons.

Changes

Files/Paths Change Summaries
CHANGELOG.md Added new comparison operators for integers.
proto/shield/ast/ast.proto Reordered and added fields to Expression message; introduced StringLiteral message.
proto/shield/token/token.proto Modified Type enum to include new values for strings and comparison operators.
shield/ast/ast.go Added functions for string literal creation and extraction; removed various literal-related methods.
shield/ast/stringify.go Added support for string literals in the Stringify function.
shield/internal/evaluator/builtins.go Added contains function and type-specific compare function.
shield/internal/evaluator/builtins_test.go Added test cases for the contains function.
shield/internal/evaluator/evaluator.go Added handling for StringLiteral expressions and comparison operators in evaluation functions.
shield/internal/evaluator/evaluator_test.go Added boolean expression tests for comparison operations.
shield/internal/lexer/lexer.go Enhanced NextToken method to handle new operators and string tokens; added readString method.
shield/internal/lexer/lexer_test.go Updated TestNextToken to include new token types and strings.
shield/internal/parser/parser.go Added parsing logic for new token types and string literals.
shield/internal/parser/parser_test.go Added tests for string literals and comparison expressions.
shield/object/object.go Introduced String object type with associated methods.

Assessment against linked issues

Objective (Issue #) Addressed Explanation
Add string object type (307) ✅
Support for array literals that include strings (307) ✅
New built-in contains(item, array) to check if item is an element of the array (307) ✅

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.