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

chore: readability-redundant-smartptr-get #4064

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

paulgessinger
Copy link
Member

@paulgessinger paulgessinger commented Jan 30, 2025

First without the necessary code changes so I can see if #4062 (which this is based on) works correctly.

--- END COMMIT MESSAGE ---

Any further description goes here, @-mentions are ok here!

  • Use a conventional commits prefix: quick summary
    • We mostly use feat, fix, refactor, docs, chore and build types.
  • A milestone will be assigned by one of the maintainers

Summary by CodeRabbit

  • Chores
    • Updated static analysis settings with an additional check to enhance overall code quality.
  • Refactor
    • Streamlined internal pointer handling across various modules to simplify code and improve readability.
  • Tests
    • Adjusted test code to align with the new internal improvements and ensure consistency.

@paulgessinger paulgessinger added this to the next milestone Jan 30, 2025
Copy link

coderabbitai bot commented Jan 30, 2025

Warning

Rate limit exceeded

@paulgessinger has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 36 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 e5d208b and 4f0f3c9.

📒 Files selected for processing (1)
  • Core/src/Detector/DetectorVolume.cpp (2 hunks)

Walkthrough

Changed, this pull request has. The clang-tidy configuration now be in a multi-line format with a new check—readability-redundant-smartptr-get—added, hmmm. Also, many files, from Core to Tests, Examples, and Plugins, they now use direct smart pointer dereferences instead of calling .get(). Improved readability only, it does, with no alteration to functionality or control flow. Simple code refinements, across various modules, are made.

Changes

File(s) Change Summary
.clang-tidy, CI/clang_tidy/limits.yml Converted clang-tidy configuration from a single-line to a multi-line format; added the new check readability-redundant-smartptr-get and its rule with value 0.
Core/... Replaced explicit .get() calls with direct * dereferences in methods of BoundarySurfaceT, DetectorVolume, Portal, MaterialMapper, and Surface classes.
Tests/UnitTests/... Updated tests to use direct smart pointer dereferences; added header inclusion in FitterTestsCommon.hpp.
Examples/... Modified simulation and writer functions to directly dereference pointers rather than using .get().
Plugins/... Simplified smart pointer accesses by removing .get() calls in surface material attachment, blueprint creation, detector element instantiation, and JSON conversion.

Possibly related PRs

Suggested labels

automerge, Changes Performance

Suggested reviewers

  • andiwand

Poem

In the code’s galaxy, change we see,
Pointers now shine with clarity.
Configurations refined, checks anew,
A simpler force runs strong and true.
Code, like the Force, flows bright—mmm, yes!


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.

@github-actions github-actions bot added the Infrastructure Changes to build tools, continous integration, ... label Jan 30, 2025
Copy link

github-actions bot commented Jan 30, 2025

📊: Physics performance monitoring for 4f0f3c9

Full contents

physmon summary

@github-actions github-actions bot added Component - Core Affects the Core module Component - Plugins Affects one or more Plugins Track Fitting labels Jan 31, 2025
@paulgessinger paulgessinger force-pushed the chore/readability-redundant-smartptr-get branch from 841a44d to b25e8f2 Compare February 11, 2025 12:33
@github-actions github-actions bot added the Component - Examples Affects the Examples module label Feb 11, 2025
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)
Plugins/GeoModel/include/Acts/Plugins/GeoModel/GeoModelBlueprintCreater.hpp (1)

71-77: Wise changes, these are! Simplified smart pointer dereferencing, you have achieved.

Proper null check before dereferencing, maintained you have. Direct dereferencing of unique_ptr, cleaner it is, than using .get(). The Force is strong with this code, hmm.

Remember, young Padawan: When dealing with smart pointers throughout the codebase, direct dereferencing prefer you should. The path to cleaner code, this is.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 841a44d and b25e8f2.

📒 Files selected for processing (25)
  • .clang-tidy (1 hunks)
  • CI/clang_tidy/limits.yml (1 hunks)
  • Core/include/Acts/Geometry/BoundarySurfaceT.hpp (1 hunks)
  • Core/src/Detector/DetectorVolume.cpp (2 hunks)
  • Core/src/Detector/Portal.cpp (1 hunks)
  • Core/src/Material/MaterialMapper.cpp (2 hunks)
  • Core/src/Surfaces/ConeSurface.cpp (1 hunks)
  • Core/src/Surfaces/CylinderSurface.cpp (1 hunks)
  • Core/src/Surfaces/DiscSurface.cpp (1 hunks)
  • Core/src/Surfaces/LineSurface.cpp (1 hunks)
  • Core/src/Surfaces/PlaneSurface.cpp (1 hunks)
  • Examples/Algorithms/Geant4/src/Geant4Simulation.cpp (1 hunks)
  • Examples/Detectors/ContextualDetector/src/ExternalAlignmentDecorator.cpp (1 hunks)
  • Examples/Io/Csv/src/CsvTrackingGeometryWriter.cpp (1 hunks)
  • Examples/Io/Json/src/JsonSurfacesWriter.cpp (1 hunks)
  • Plugins/DD4hep/src/DD4hepDetectorSurfaceFactory.cpp (1 hunks)
  • Plugins/Geant4/src/Geant4Converters.cpp (4 hunks)
  • Plugins/GeoModel/include/Acts/Plugins/GeoModel/GeoModelBlueprintCreater.hpp (1 hunks)
  • Plugins/GeoModel/include/Acts/Plugins/GeoModel/GeoModelDetectorElement.hpp (1 hunks)
  • Plugins/GeoModel/src/GeoModelDetectorElementITk.cpp (1 hunks)
  • Plugins/Json/src/SurfaceJsonConverter.cpp (1 hunks)
  • Tests/UnitTests/Core/Geometry/ProtoLayerTests.cpp (1 hunks)
  • Tests/UnitTests/Core/TrackFitting/FitterTestsCommon.hpp (1 hunks)
  • Tests/UnitTests/Plugins/Geant4/Geant4DetectorElementTests.cpp (1 hunks)
  • Tests/UnitTests/Plugins/TGeo/TGeoParserTests.cpp (2 hunks)
✅ Files skipped from review due to trivial changes (2)
  • Plugins/DD4hep/src/DD4hepDetectorSurfaceFactory.cpp
  • Plugins/GeoModel/include/Acts/Plugins/GeoModel/GeoModelDetectorElement.hpp
🚧 Files skipped from review as they are similar to previous changes (15)
  • Core/src/Surfaces/DiscSurface.cpp
  • Core/src/Surfaces/PlaneSurface.cpp
  • CI/clang_tidy/limits.yml
  • Core/src/Surfaces/CylinderSurface.cpp
  • Tests/UnitTests/Core/Geometry/ProtoLayerTests.cpp
  • Tests/UnitTests/Plugins/TGeo/TGeoParserTests.cpp
  • .clang-tidy
  • Core/src/Detector/Portal.cpp
  • Core/src/Surfaces/LineSurface.cpp
  • Tests/UnitTests/Core/TrackFitting/FitterTestsCommon.hpp
  • Core/src/Material/MaterialMapper.cpp
  • Core/src/Surfaces/ConeSurface.cpp
  • Core/include/Acts/Geometry/BoundarySurfaceT.hpp
  • Tests/UnitTests/Plugins/Geant4/Geant4DetectorElementTests.cpp
  • Core/src/Detector/DetectorVolume.cpp
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: CI Bridge / clang_tidy
  • GitHub Check: merge-sentinel
  • GitHub Check: unused_files
  • GitHub Check: missing_includes
  • GitHub Check: CI Bridge / build_gnn_tensorrt
  • GitHub Check: linux_ubuntu_extra (ubuntu2204, 20, clang++)
  • GitHub Check: macos
  • GitHub Check: linux_ubuntu_extra (ubuntu2204, 20, g++)
  • GitHub Check: build_debug
  • GitHub Check: linux_ubuntu
🔇 Additional comments (7)
Examples/Io/Csv/src/CsvTrackingGeometryWriter.cpp (1)

354-355: Approve this change, I do!

Cleaner and more idiomatic, the direct dereferencing with *confined is, than using .get(). Improved readability without changing behavior, this does. Hmmmm.

Plugins/GeoModel/src/GeoModelDetectorElementITk.cpp (1)

103-103: Approve this change, I do!

Simplified the smart pointer dereferencing has been, hmm. Direct dereferencing of itkEl, cleaner it is than using redundant .get(). The Force flows better through this code now, it does.

Examples/Io/Json/src/JsonSurfacesWriter.cpp (1)

112-113: Approve this change, I do! Hmmmm.

Improved readability, this change has brought. Direct dereferencing of smart pointer confined, cleaner and more idiomatic it is, than using .get(). Safe this transformation remains, as ownership semantics unchanged they are.

Examples/Algorithms/Geant4/src/Geant4Simulation.cpp (1)

95-97: Approve this change, I do!

Simplified the smart pointer dereferencing is. Redundant .get() call removed, yet same functionality maintained. Cleaner and more readable, the code now is, hmm.

Examples/Detectors/ContextualDetector/src/ExternalAlignmentDecorator.cpp (1)

29-29: Wise change, this is! Removed redundant .get(), you have.

Cleaner and more idiomatic C++, the direct dereferencing is. Protected by null check above, it remains. Hmmmm.

Plugins/Json/src/SurfaceJsonConverter.cpp (1)

47-47: Improved smart pointer usage, hmm, yes!

Direct dereferencing of shared pointers, more elegant it is. Unnecessary .get() calls, removed they were.

Also applies to: 53-53

Plugins/Geant4/src/Geant4Converters.cpp (1)

372-372: Consistent improvement in smart pointer usage, I sense!

Direct dereferencing of surface pointer in assignMaterial calls, cleaner code it creates. Removed .get() calls, unnecessary they were.

Also applies to: 389-389, 406-406, 440-440

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Core Affects the Core module Component - Examples Affects the Examples module Component - Plugins Affects one or more Plugins Infrastructure Changes to build tools, continous integration, ... Track Fitting
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant