Skip to content

Cleanups #32

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

Merged
merged 2 commits into from
Feb 18, 2025
Merged

Cleanups #32

merged 2 commits into from
Feb 18, 2025

Conversation

kimkulling
Copy link
Owner

@kimkulling kimkulling commented Feb 18, 2025

  • Remove TSharePointer + tests
  • Use constexpr
  • Update of copyrights

Summary by CodeRabbit

  • Chores

    • Removed an obsolete shared memory management feature and its tests.
    • Updated copyright information.
  • Refactor

    • Enhanced random number generation routines with robust error checking and clearer return values.
    • Improved platform-specific compatibility checks for system operations.

Copy link
Contributor

coderabbitai bot commented Feb 18, 2025

Walkthrough

This pull request removes the TSharedPtr component from the build process by deleting its implementation and associated unit tests. It also enhances the RandomGenerator module by updating functions to return booleans and adding null-pointer checks with assertions. Minor changes include updating preprocessor macros in the FileSystem module for Windows compatibility and revising the copyright year in the Hash module.

Changes

File(s) Change Summary
CMakeLists.txt, include/cppcore/Common/TSharedPtr.h, test/common/TSharedPtrTest.cpp Removed references and files related to the TSharedPtr component from the build and testing configurations.
code/Random/RandomGenerator.cpp Enhanced error handling: updated mersenne_twister_vector_init and mersenne_twister_vector_update to return bool, added null-pointer checks, and assertions.
include/cppcore/Common/Hash.h Updated the copyright year from 2024 to 2025.
include/cppcore/IO/FileSystem.h Replaced WIN32 with _WIN32 in preprocessor directives and adjusted include formatting for platform-specific code.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as "Caller"
    participant RG as "RandomGenerator"
    
    Caller->>RG: Call mersenne_twister(seed, len)
    RG->>RG: Call mersenne_twister_vector_init(seedPoints, len)
    alt seedPoints is null
        RG-->>Caller: Return false (initialization failed)
    else
        RG-->>Caller: Return true (initialization succeeded)
    end
    RG->>RG: Call mersenne_twister_vector_update(p)
    alt p is null
        RG-->>Caller: Return false (update failed)
    else
        RG-->>Caller: Return true (update succeeded)
    end
    RG->>Caller: Assert overall success (ok)
Loading

Poem

I'm a coding rabbit with whiskers so keen,
Hop-scotching through code, keeping it clean,
Gone with TSharedPtr, no more to confine,
Error checks in RandomGenerator make the process divine,
With macros aligned and a license so bright,
I nibble on carrots and debug through the night! 🥕🐰


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 573bdf0 and ae3adf8.

📒 Files selected for processing (1)
  • code/Random/RandomGenerator.cpp (5 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • code/Random/RandomGenerator.cpp

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.

Copy link
Contributor

@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: 1

🧹 Nitpick comments (2)
code/Random/RandomGenerator.cpp (2)

4-4: Update copyright year to reflect current date.

The copyright year extends to 2025, which is beyond the current date (February 2025). Consider updating it to 2024.

-Copyright (c) 2014-2025 Kim Kulling
+Copyright (c) 2014-2024 Kim Kulling

95-95: Consider using a more secure seeding mechanism.

Using time(nullptr) for seeding the random number generator is predictable and not suitable for security-critical applications. Consider using a more secure source of entropy like /dev/urandom on Unix systems or CryptGenRandom on Windows.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 65cf762 and 573bdf0.

📒 Files selected for processing (6)
  • CMakeLists.txt (0 hunks)
  • code/Random/RandomGenerator.cpp (5 hunks)
  • include/cppcore/Common/Hash.h (1 hunks)
  • include/cppcore/Common/TSharedPtr.h (0 hunks)
  • include/cppcore/IO/FileSystem.h (2 hunks)
  • test/common/TSharedPtrTest.cpp (0 hunks)
💤 Files with no reviewable changes (3)
  • include/cppcore/Common/TSharedPtr.h
  • CMakeLists.txt
  • test/common/TSharedPtrTest.cpp
✅ Files skipped from review due to trivial changes (2)
  • include/cppcore/Common/Hash.h
  • include/cppcore/IO/FileSystem.h
🔇 Additional comments (3)
code/Random/RandomGenerator.cpp (3)

31-32: Great use of constexpr!

Using constexpr for these constants is a good improvement as it enables compile-time evaluation and better optimization opportunities.


34-47: Good error handling improvement!

The changes improve robustness by:

  • Adding nullptr check for input pointer
  • Returning a boolean status to indicate success/failure

49-65: Good error handling improvement!

The changes improve robustness by:

  • Adding nullptr check for input pointer
  • Returning a boolean status to indicate success/failure

@kimkulling kimkulling merged commit d13d7be into master Feb 18, 2025
1 check passed
@kimkulling kimkulling deleted the refactoring/cleanups branch February 18, 2025 08:52
Copy link

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