WIP Implement all necessary predicates

[J0sueTM]

fixes #1

Summary by CodeRabbit

• New Features

  • Added documentation generation capabilities using Marginalia.
  • Introduced enhanced grammar parsing functionalities in Aurelio syntax.

• Documentation

  • Improved syntax documentation for clarity and usability.

• Tests

  • Expanded test coverage for new grammar parsing functionalities.

• Bug Fixes

  • Updated Aurelio syntax to better handle diverse input patterns.

[coderabbitai]

Walkthrough

This update introduces new predicate functions in src/aurelio/grammar.clj and corresponding tests in test/aurelio/grammar_test.clj, enhancing the grammar module's capabilities. Additionally, deps.edn now includes an alias for documentation generation, and docs/01-why.org sees syntax modifications to improve clarity and consistency.

Changes

File Path	Change Summary
deps.edn	Added :doc-gen alias with Marginalia dependencies.
docs/01-why.org	Updated Aurelio syntax for clarity.
src/aurelio/grammar.clj	Added new predicate functions.
test/aurelio/grammar_test.clj	Added tests for new predicate functions.

Assessment against linked issues

Objective	Addressed	Explanation
implement remaining predicates (#1)	✅

Poem

🐇 Hop, skip, a code leap,
Changes vast, deep as the burrow's keep.
From strings that bind, to sequences align,
Each line refined, with care designed.
🌟 Here's to the code, ever so bold,
In its digital meadow, stories told.

---

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
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • 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.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 656b98f and 662ce2d.

Files selected for processing (4)

• deps.edn (1 hunks)
• docs/01-why.org (1 hunks)
• src/aurelio/grammar.clj (4 hunks)
• test/aurelio/grammar_test.clj (3 hunks)

Additional comments not posted (10)

deps.edn (1)

5-10: The addition of the :doc-gen alias with Marginalia setup looks good.

test/aurelio/grammar_test.clj (3)

10-12: The tests for build-str-p correctly verify string comparison functionality.

---

Line range hint 55-66: The tests for build-expr-p adequately cover different expression types and scenarios.

---

72-85: The tests for build-seq-p effectively verify the functionality of sequence parsing predicates.

docs/01-why.org (1)

55-92: The syntax modifications in the Aurelio documentation enhance clarity and consistency.

src/aurelio/grammar.clj (5)

10-15: The implementation of build-str-p correctly handles string comparisons.

---

44-49: The implementation of build-seq+-p correctly ensures that sequences are neither nil nor empty.

---

51-56: The modification to build-opt-p enhances its ability to handle optional expressions effectively.

---

58-73: The implementation of build-useq-p correctly handles unique matching of non-optional expressions.

---

138-148: The modification to build-expr-p correctly builds predicates for various expressions, enhancing flexibility and robustness.