Skip to content

Align ninja_env crate with lint policy#118

Merged
leynos merged 1 commit intocodex/add-envlock-and-mockable-env-for-ninja_envfrom
codex/check-unresolved-comments-on-pr-115
Aug 15, 2025
Merged

Align ninja_env crate with lint policy#118
leynos merged 1 commit intocodex/add-envlock-and-mockable-env-for-ninja_envfrom
codex/check-unresolved-comments-on-pr-115

Conversation

@leynos
Copy link
Copy Markdown
Owner

@leynos leynos commented Aug 15, 2025

Summary

  • mark ninja_env crate as internal and apply clippy lint policy
  • use ninja_env::NINJA_ENV constant and OS-agnostic temp paths in tests
  • avoid lossy Unicode in environment guard tests and docs

Testing

  • make fmt
  • make check-fmt
  • make lint
  • make test

https://chatgpt.com/codex/tasks/task_e_689e8fb5ed2c83229b852efb9088dbc8

Summary by Sourcery

Align the ninja_env crate with the internal lint policy and improve its tests and examples

Enhancements:

  • Mark ninja_env as internal (publish = false) and enforce clippy lint rules in its Cargo.toml
  • Replace hardcoded "/tmp/ninja" paths in tests with OS-agnostic std::env::temp_dir() and use the ninja_env::NINJA_ENV constant

Documentation:

  • Revise example snippets to use std::env::temp_dir() and to_string_lossy() to avoid lossy Unicode

Tests:

  • Update environment guard tests to map OsString to &str safely and assert against the temp_dir path

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Aug 15, 2025

Reviewer's Guide

This PR marks the ninja_env crate as internal and enforces a strict Clippy lint policy, and updates tests and documentation to use the crate’s NINJA_ENV constant with OS-agnostic temp paths and lossless Unicode handling.

Class diagram for updated ninja_env constant usage in tests

classDiagram
    class NinjaEnv {
        <<constant>> NINJA_ENV : &str
    }
    class TestSupportEnv {
        +uses NinjaEnv::NINJA_ENV
        +uses OS-agnostic temp paths
        +lossless Unicode handling
    }
    TestSupportEnv --> NinjaEnv : uses
Loading

File-Level Changes

Change Details Files
Internal crate designation and Clippy lint policy configuration
  • Added publish = false to disable publishing
  • Defined pedantic Clippy group and applied deny on hygiene, panic-prone, portability, idiom, and numerical lints
  • Disabled specific lints pending fixture compatibility and investigation
ninja_env/Cargo.toml
Test suite refactored for constant import, OS-agnostic paths, and Unicode safety
  • Replaced external import with use ninja_env::NINJA_ENV
  • Switched from lossy .to_string_lossy() clone to Unicode-safe to_str() mapping
  • Replaced hardcoded /tmp/ninja with std::env::temp_dir().join("ninja")
  • Updated assertions to compare target.to_string_lossy()
tests/ninja_env_tests.rs
Documentation examples updated for temp_dir usage and Unicode
  • Removed unnecessary Path import in code example
  • Constructed path via std::env::temp_dir().join("ninja")
  • Changed example assertion to use to_string_lossy()
test_support/src/env.rs

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Aug 15, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch codex/check-unresolved-comments-on-pr-115

🪧 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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes - here's some feedback:

  • Consider using tempfile::TempDir in your tests instead of std::env::temp_dir() to ensure unique, isolated directories and avoid collisions even with serial execution.
  • The docs example still uses to_string_lossy() for path assertions; consider switching to to_str() (with proper error handling) for consistency with the test code’s lossless Unicode handling.
  • Since this clippy policy is quite extensive and applies to multiple internal crates, you might centralize it in the workspace root to avoid duplication and ease future updates.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider using tempfile::TempDir in your tests instead of std::env::temp_dir() to ensure unique, isolated directories and avoid collisions even with serial execution.
- The docs example still uses to_string_lossy() for path assertions; consider switching to to_str() (with proper error handling) for consistency with the test code’s lossless Unicode handling.
- Since this clippy policy is quite extensive and applies to multiple internal crates, you might centralize it in the workspace root to avoid duplication and ease future updates.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@leynos leynos merged commit d5838ca into codex/add-envlock-and-mockable-env-for-ninja_env Aug 15, 2025
2 checks passed
@leynos leynos deleted the codex/check-unresolved-comments-on-pr-115 branch August 15, 2025 07:51
leynos added a commit that referenced this pull request Aug 15, 2025
* Add guard for NINJA_ENV overrides

* Quote NINJA_ENV in doc comment

* Centralise NINJA_ENV and cover unset restoration

* Remove manual NINJA_ENV cleanup in tests

* Add crate for shared NINJA_ENV constant

* Scope EnvLock in NINJA_ENV tests (#117)

* Apply review suggestions for ninja env crate (#118)

* Document NINJA_ENV and restore via OsString (#120)

* Refine ninja env docs and tests (#121)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant