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

introduce metapath expression evaluator subcommand WIP #96

Conversation

wandmagic
Copy link
Contributor

Committer Notes

Attempting to add a metapath evaluator command

All Submissions:

By submitting a pull request, you are agreeing to provide this contribution under the CC0 1.0 Universal public domain dedication.

Changes to Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you included examples of how to use your new feature(s)?
  • Have you updated all website and readme documentation affected by the changes you made?

Copy link

coderabbitai bot commented Aug 27, 2024

Walkthrough

Walkthrough

The MetapathCommand class has been updated to include a new command handler for the TestPathSubCommand, enhancing its capability to process additional user commands related to testing paths. A new class, TestPathSubCommand, has been introduced to execute MetaPath expressions against specified documents, validating inputs and handling errors efficiently within a command-line interface context.

Changes

File Change Summary
metaschema-cli/src/main/java/gov/nist/secauto/metaschema/cli/commands/metapath/... Added a new command handler for TestPathSubCommand in MetapathCommand.
metaschema-cli/src/main/java/gov/nist/secauto/metaschema/cli/commands/metapath/... Introduced TestPathSubCommand class with methods for command execution, validation, and error handling.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant MetapathCommand
    participant TestPathSubCommand

    User->>MetapathCommand: Invoke test-path command
    MetapathCommand->>TestPathSubCommand: Handle command
    TestPathSubCommand->>User: Validate input arguments
    TestPathSubCommand->>TestPathSubCommand: Compile MetaPath expression
    TestPathSubCommand->>User: Execute command and return results
Loading

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
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.
    • @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 Configuration 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 76fe3c9 and 5472808.

Files selected for processing (2)
  • metaschema-cli/src/main/java/gov/nist/secauto/metaschema/cli/commands/metapath/MetapathCommand.java (1 hunks)
  • metaschema-cli/src/main/java/gov/nist/secauto/metaschema/cli/commands/metapath/TestPathSubCommand.java (1 hunks)
Additional comments not posted (7)
metaschema-cli/src/main/java/gov/nist/secauto/metaschema/cli/commands/metapath/MetapathCommand.java (1)

17-17: LGTM!

The new command handler TestPathSubCommand is correctly added.

The code changes are approved.

metaschema-cli/src/main/java/gov/nist/secauto/metaschema/cli/commands/metapath/TestPathSubCommand.java (6)

1-26: LGTM!

The class declaration and imports are correctly implemented.

The code changes are approved.


27-48: LGTM!

The static final fields and static block are correctly implemented.

The code changes are approved.


50-69: LGTM!

The overridden methods getName, getDescription, gatherOptions, and getExtraArguments are correctly implemented.

The code changes are approved.


71-77: LGTM!

The overridden method validateOptions is correctly implemented.

The code changes are approved.


79-82: LGTM!

The overridden method newExecutor is correctly implemented.

The code changes are approved.


84-118: LGTM!

The executeCommand method is correctly implemented. It performs the necessary checks and executes the metapath expression.

The code changes are approved.

david-waltermire added a commit to david-waltermire/metaschema-java that referenced this pull request Sep 6, 2024
… improper handling of JSON keys. Added basic support for arbitrary Metapath command execution. Resolves usnistgov/metaschema-java#241. Builds on metaschema-framework#96.
david-waltermire added a commit to david-waltermire/metaschema-java that referenced this pull request Sep 7, 2024
… improper handling of JSON keys. Added basic support for arbitrary Metapath command execution. Resolves usnistgov/metaschema-java#241. Builds on metaschema-framework#96.
@david-waltermire
Copy link
Contributor

This work is continued in #102.

david-waltermire added a commit to david-waltermire/metaschema-java that referenced this pull request Sep 7, 2024
… improper handling of JSON keys.

Added basic support for arbitrary Metapath command execution, building on metaschema-framework#96. Metapath execution allows for evaluating expressions without a module or instance.
Resolves usnistgov/metaschema-java#241.
david-waltermire added a commit to david-waltermire/metaschema-java that referenced this pull request Sep 7, 2024
… improper handling of JSON keys.

Added basic support for arbitrary Metapath command execution, building on metaschema-framework#96. Metapath execution allows for evaluating expressions without a module or instance.
Resolves usnistgov/metaschema-java#241.
david-waltermire added a commit to david-waltermire/metaschema-java that referenced this pull request Sep 7, 2024
… improper handling of JSON keys.

Added basic support for arbitrary Metapath command execution, building on metaschema-framework#96. Metapath execution allows for evaluating expressions without a module or instance.
Resolves usnistgov/metaschema-java#241.
david-waltermire added a commit to david-waltermire/metaschema-java that referenced this pull request Sep 7, 2024
… improper handling of JSON keys.

Added basic support for arbitrary Metapath command execution, building on metaschema-framework#96. Metapath execution allows for evaluating expressions without a module or instance.
Resolves usnistgov/metaschema-java#241.
david-waltermire added a commit to david-waltermire/metaschema-java that referenced this pull request Sep 7, 2024
… improper handling of JSON keys.

Added basic support for arbitrary Metapath command execution, building on metaschema-framework#96. Metapath execution allows for evaluating expressions without a module or instance.
Resolves usnistgov/metaschema-java#241.
david-waltermire added a commit to david-waltermire/metaschema-java that referenced this pull request Sep 7, 2024
… improper handling of JSON keys.

Added basic support for arbitrary Metapath command execution, building on metaschema-framework#96. Metapath execution allows for evaluating expressions without a module or instance.
Resolves usnistgov/metaschema-java#241.
david-waltermire added a commit to david-waltermire/metaschema-java that referenced this pull request Sep 7, 2024
… improper handling of JSON keys.

Added basic support for arbitrary Metapath command execution, building on metaschema-framework#96. Metapath execution allows for evaluating expressions without a module or instance.
Resolves usnistgov/metaschema-java#241.
david-waltermire added a commit to david-waltermire/metaschema-java that referenced this pull request Sep 8, 2024
… improper handling of JSON keys.

Added basic support for arbitrary Metapath command execution, building on metaschema-framework#96. Metapath execution allows for evaluating expressions without a module or instance.
Resolves usnistgov/metaschema-java#241.
david-waltermire added a commit to david-waltermire/metaschema-java that referenced this pull request Sep 9, 2024
… improper handling of JSON keys.

Added basic support for arbitrary Metapath command execution, building on metaschema-framework#96. Metapath execution allows for evaluating expressions without a module or instance.
Resolves usnistgov/metaschema-java#241.
david-waltermire added a commit to david-waltermire/metaschema-java that referenced this pull request Sep 10, 2024
… improper handling of JSON keys.

Added basic support for arbitrary Metapath command execution, building on metaschema-framework#96. Metapath execution allows for evaluating expressions without a module or instance.
Resolves usnistgov/metaschema-java#241.
david-waltermire added a commit that referenced this pull request Sep 10, 2024
* introduce metapath expression evaluator subcommand

* Fixed a schema generation bug causing an existing test to fail due to improper handling of JSON keys.
Added basic support for arbitrary Metapath command execution, building on #96. Metapath execution allows for evaluating expressions without a module or instance.
Resolves usnistgov/metaschema-java#241.

---------

Co-authored-by: wandmagic <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants