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

ignore shape in graph object override - fixes #98 #103

Merged
merged 3 commits into from
Nov 6, 2024

Conversation

hbmartin
Copy link
Owner

@hbmartin hbmartin commented Oct 5, 2024

Summary by Sourcery

Fix the handling of attributes in the GraphObj class by adding 'shape' to the list of ignored attributes.

Bug Fixes:

  • Ignore the 'shape' attribute in the GraphObj class to address an issue with attribute handling.

Summary by CodeRabbit

  • New Features

    • Enhanced attribute filtering during the enrichment process by adding "shape" to the list of attributes that are ignored.
  • Bug Fixes

    • Improved logic to ensure that both "fill" and "shape" attributes are correctly skipped during processing.
  • Chores

    • Updated the test script to silence output and provide clearer feedback on command execution success.
  • Style Updates

    • Changed the visual representation of several nodes in the directed graph from default to elliptical style.

Copy link
Contributor

sourcery-ai bot commented Oct 5, 2024

Reviewer's Guide by Sourcery

This pull request modifies the GraphObj.py file to ignore the 'shape' attribute in graph object overrides, addressing issue #98. The change is implemented by adding 'shape' to the _blacklist_attrs list.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added 'shape' to the list of blacklisted attributes
  • Modified the _blacklist_attrs list to include 'shape' alongside 'fill'
graphviz2drawio/mx/GraphObj.py

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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

Copy link
Contributor

coderabbitai bot commented Oct 5, 2024

Walkthrough

The changes involve an update to the _blacklist_attrs variable in the GraphObj class located in GraphObj.py, which now includes an additional entry, "shape", alongside the existing entry, "fill". This modification enhances the filtering process in the enrich_from_graph method to skip setting attributes for both "fill" and "shape". Additionally, the test_specs.sh script has been updated to silence the output of a command and to report its exit status.

Changes

File Path Change Summary
graphviz2drawio/mx/GraphObj.py Updated _blacklist_attrs from ["fill"] to ["fill", "shape"] and modified enrich_from_graph method to include a condition for "shape".
test_specs.sh Modified process_files to silence output and include exit status in echo statement.
specs/directed/subgraph.xml Changed style of nodes with IDs node1 to node7 from default to "ellipse".

Poem

In the garden where attributes play,
A rabbit hops in a joyful way.
With shapes and fills now on the run,
Enriching graphs is twice the fun!
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Reviewing files that changed from the base of the PR and between fbcb7c4 and 25dd97d.

📒 Files selected for processing (1)
  • specs/directed/subgraph.xml (1 hunks)
🔇 Additional comments (2)
specs/directed/subgraph.xml (2)

Line range hint 1-143: Graph structure and relationships are properly preserved.

The service architecture relationships remain intact:

  • DNS to Load Balancer connectivity
  • Load Balancer to Web servers distribution
  • Web servers' connections to Memcached and UserDB
  • All geometric positions and edge styles are maintained

This confirms that the style changes did not affect the graph's structural integrity.


11-43: Style changes look consistent and aligned with PR objectives.

The addition of "ellipse" style to all nodes is consistent and properly preserves other style attributes. This change aligns with the PR objective of fixing shape attribute handling in GraphObj (issue #98).

Let's verify the consistency of these changes across all test specifications:


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 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

@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 @hbmartin - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

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.

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: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between 9f2d07b and fbcb7c4.

📒 Files selected for processing (2)
  • graphviz2drawio/mx/GraphObj.py (1 hunks)
  • test_specs.sh (1 hunks)
🧰 Additional context used

Comment on lines +18 to +19
if k == "shape" and v == "none":
continue
Copy link
Contributor

Choose a reason for hiding this comment

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

🧹 Nitpick (assertive)

Approved: Ignoring 'shape' attribute when value is 'none'

This change successfully addresses the PR objective to ignore the shape in graph object override when its value is 'none'. It's a targeted fix for the reported issue.

However, consider the following optimization:

If all 'shape' attributes should be ignored regardless of their value, it might be more efficient to add 'shape' to _blacklist_attrs. This would eliminate the need for an additional condition in the loop.

If only 'shape' attributes with value 'none' should be ignored (as implemented), the current approach is correct. In this case, you might want to add a comment explaining why this specific check is necessary for clarity.

Consider adding a comment to explain the rationale:

# Ignore 'shape' attribute when set to 'none' to [explain the reason]
if k == "shape" and v == "none":
    continue

Or, if all 'shape' attributes should be ignored:

_blacklist_attrs = ["fill", "shape"]

and remove the specific check for 'shape'.

Comment on lines +28 to +29
python3 -m graphviz2drawio "$file" -o "$output_file" > /dev/null 2>&1
echo "Processed: $file -> $output_file ($?)"
Copy link
Contributor

Choose a reason for hiding this comment

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

🧹 Nitpick (assertive)

Approved changes with a suggestion for improved error handling

The modifications to silence the Python command output and report its exit status are good improvements. They reduce clutter and provide immediate feedback on the success of each file processing.

Consider enhancing the error handling by providing more detailed feedback when a processing failure occurs. Here's a suggested improvement:

- python3 -m graphviz2drawio "$file" -o "$output_file" > /dev/null 2>&1
- echo "Processed: $file -> $output_file ($?)"
+ if ! python3 -m graphviz2drawio "$file" -o "$output_file" > /dev/null 2>&1; then
+     echo "Error processing: $file -> $output_file (Exit code: $?)" >&2
+ else
+     echo "Successfully processed: $file -> $output_file"
+ fi

This change will:

  1. Clearly distinguish between successful and failed processing.
  2. Output error messages to stderr for easier error tracking.
  3. Maintain the benefits of the current changes while providing more informative output.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
python3 -m graphviz2drawio "$file" -o "$output_file" > /dev/null 2>&1
echo "Processed: $file -> $output_file ($?)"
if ! python3 -m graphviz2drawio "$file" -o "$output_file" > /dev/null 2>&1; then
echo "Error processing: $file -> $output_file (Exit code: $?)" >&2
else
echo "Successfully processed: $file -> $output_file"
fi

Copy link

sonarcloud bot commented Nov 6, 2024

@hbmartin hbmartin merged commit 4a40372 into master Nov 6, 2024
11 checks passed
@hbmartin hbmartin deleted the handle-none-shape branch November 6, 2024 23: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.

1 participant