Skip to content

Conversation

dthaler
Copy link
Owner

@dthaler dthaler commented Feb 18, 2025

Fixes #283

Summary by CodeRabbit

  • Documentation

    • Updated instructions now clarify that when using include directives, the main document must reside in the same directory as its skeleton file.
  • Bug Fixes

    • Enhanced error detection to prevent the accidental use of include directives referencing files from outside the allowed directory.
  • Tests

    • Added new checks to ensure proper error notifications are triggered when include directives point to missing or out-of-directory files.

Copy link

coderabbitai bot commented Feb 18, 2025

Warning

Rate limit exceeded

@dthaler has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 10 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between ce9d5d7 and f221341.

📒 Files selected for processing (1)
  • lib/rst2rfcxml.cpp (1 hunks)

Walkthrough

The changes clarify the usage of the include directive by specifying that the main RST file must reside in the same directory as the skeleton file (README.md). Additionally, an error-handling check is introduced in the rst2rfcxml::process_line method to catch include filenames containing path separators, printing an error and returning a non-zero code. Test cases in test/basic_tests.cpp were updated: the function signature now accepts an expected_error parameter, and new tests were added to cover out-of-directory and non-existent include scenarios.

Changes

File Change Summary
README.md Updated description to state that the main RST file must be in the same directory as the skeleton file when using the include directive.
lib/rst2rfcxml.cpp Added an error-check in process_line for filenames with path separators; prints an error to std::cerr and returns a non-zero error code if validation fails.
test/basic_tests.cpp Modified the test function signature to include an expected_error parameter and added new test cases for out-of-directory and non-existent include file scenarios.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Caller
    participant Process as process_line
    participant Console as std::cerr

    Caller->>Process: Call process_line(line with include directive)
    Process->>Process: Check if filename contains '/' or '\\'
    alt Filename contains path separator
        Process->>Console: Print error message
        Process-->>Caller: Return error code (non-zero)
    else Normal filename
        Process-->>Caller: Process include normally and return success code
    end
Loading

Poem

I'm a rabbit on a coding spree,
Hopping through changes, swift and free.
Clarified docs and error-checks in tow,
Tests ensuring the right code flow.
With whiskers twitching in joyful delight,
I celebrate improvements, morning to night!


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

Fixes #283

Signed-off-by: Dave Thaler <dthaler1968@gmail.com>
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

🧹 Nitpick comments (1)
test/basic_tests.cpp (1)

1524-1544: LGTM! Comprehensive test coverage for include directive restrictions.

The test cases effectively validate:

  1. Rejection of includes from parent directories
  2. Rejection of non-existent files

Consider adding these additional test cases for completeness:

  1. Include from a subdirectory
  2. Include from the same directory (positive test case)

Here's a suggested implementation for the additional test cases:

+TEST_CASE("include from subdirectory", "[include]")
+{
+    test_rst2rfcxml(
+        R"(
+.. include:: subdir/sample.rst
+)",
+        "",
+        1);
+}
+
+TEST_CASE("include from same directory", "[include]")
+{
+    test_rst2rfcxml(
+        R"(
+.. include:: sample.rst
+)",
+        "<t>\n Sample content\n</t>\n",
+        0);
+}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5df21c7 and ce9d5d7.

📒 Files selected for processing (3)
  • README.md (1 hunks)
  • lib/rst2rfcxml.cpp (1 hunks)
  • test/basic_tests.cpp (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • README.md
  • lib/rst2rfcxml.cpp
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build_windows (Release)
🔇 Additional comments (1)
test/basic_tests.cpp (1)

32-38: LGTM! Well-structured error handling enhancement.

The function signature update and error code validation are well-implemented. The default value of 0 maintains backward compatibility with existing test cases.

Signed-off-by: Dave Thaler <dthaler1968@gmail.com>
@dthaler dthaler merged commit baa1bfd into main Feb 18, 2025
8 checks passed
@dthaler dthaler deleted the include branch February 18, 2025 18:37
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.

Add option to disable include directive
1 participant