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

Keep text on edges in resulting draw.io output #59

Merged
merged 3 commits into from
Jul 7, 2024

Conversation

jdputsch
Copy link
Contributor

@jdputsch jdputsch commented Jan 12, 2023

With this simple graph:

digraph "" {
g [label=Group];
g -> u [label=HAS_USER];
u [label=User];
}

graphviz2drawio 0.2.0 does not include the text "HAS_USER" as a label on the edge between Group and User.

This PR keeps texts associated with edges in the resulting draw.io diagram.

Summary by CodeRabbit

  • New Features

    • Introduced support for multiple labels on edges in the graph visualization tool.
  • Chores

    • Updated .gitignore to include Pipfile.lock and fixed formatting issues.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 12, 2023

Sourcery Code Quality Report

❌  Merging this PR will decrease code quality in the affected files by 3.93%.

Quality metrics Before After Change
Complexity 3.10 ⭐ 4.68 ⭐ 1.58 👎
Method Length 58.88 ⭐ 63.17 🙂 4.29 👎
Working memory 8.18 🙂 8.78 🙂 0.60 👎
Quality 72.11% 🙂 68.18% 🙂 -3.93% 👎
Other metrics Before After Change
Lines 148 174 26
Changed files Quality Before Quality After Quality Change
graphviz2drawio/version.py 98.67% ⭐ 98.67% ⭐ 0.00%
graphviz2drawio/mx/Edge.py 82.40% ⭐ 77.73% ⭐ -4.67% 👎
graphviz2drawio/mx/EdgeFactory.py 72.99% 🙂 53.85% 🙂 -19.14% 👎
graphviz2drawio/mx/MxGraph.py 68.71% 🙂 68.62% 🙂 -0.09% 👎

Here are some functions in these files that still need a tune-up:

File Function Complexity Length Working Memory Quality Recommendation
graphviz2drawio/mx/EdgeFactory.py EdgeFactory.from_svg 12 🙂 151 😞 12 😞 47.68% 😞 Try splitting into smaller methods. Extract out complex expressions
graphviz2drawio/mx/MxGraph.py MxGraph.get_edge_style 8 ⭐ 164 😞 13 😞 48.45% 😞 Try splitting into smaller methods. Extract out complex expressions

Legend and Explanation

The emojis denote the absolute quality of the code:

  • ⭐ excellent
  • 🙂 good
  • 😞 poor
  • ⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.


Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Help us improve this quality report!

@hbmartin
Copy link
Owner

hbmartin commented Jul 2, 2024

Thanks very much @jdputsch !
I can resolve conflicts for this after getting 0.3 release out or you can take a go at it.
Also would be great to add a test case :)

@hbmartin hbmartin added this to the 0.4 milestone Jul 2, 2024
@hbmartin hbmartin removed the 0.4 label Jul 2, 2024
Copy link
Contributor

coderabbitai bot commented Jul 7, 2024

Walkthrough

This update mainly involves the enhancement and correction of label handling in the graphviz2drawio project. Changes include the renaming of a parameter, the addition of new methods for label processing, and corrections to the .gitignore file. Specifically, the Edge, EdgeFactory, and MxGraph modules have been adjusted to consistently handle multiple labels, while .gitignore saw minor corrections and additions.

Changes

File(s) Change Summary
.gitignore Removed extra space before .vscode, added Pipfile.lock, and corrected Icon entry by removing \r.
graphviz2drawio/mx/Edge.py Renamed label parameter to labels in __init__, added text_to_mx_value method.
graphviz2drawio/mx/EdgeFactory.py Added _get_labels method to extract text labels and assigned them using this method.
graphviz2drawio/mx/MxGraph.py Modified add_edge method to include "value" key with output of edge.text_to_mx_value().

Poem

In the code where data flows,
New labels dance and show,
Edge now speaks in plurals sweet,
Bound in logic, text, and neat.
With Git ignored, the clean code grows,
The rabbit smiles, the software glows.
🌟✨🐇


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between dc93163 and 1fb11df.

Files selected for processing (4)
  • .gitignore (2 hunks)
  • graphviz2drawio/mx/Edge.py (2 hunks)
  • graphviz2drawio/mx/EdgeFactory.py (2 hunks)
  • graphviz2drawio/mx/MxGraph.py (1 hunks)
Files skipped from review due to trivial changes (1)
  • .gitignore
Additional context used
Ruff
graphviz2drawio/mx/EdgeFactory.py

14-14: First argument of a method should be named self

Rename g to self

(N805)


38-38: Undefined name _get_labels

(F821)

Additional comments not posted (4)
graphviz2drawio/mx/Edge.py (2)

16-16: LGTM!

The __init__ method correctly initializes the labels parameter.

Also applies to: 25-25


32-40: LGTM!

The text_to_mx_value method correctly processes and formats multiple text labels.

graphviz2drawio/mx/EdgeFactory.py (1)

14-28: LGTM!

The _get_labels method correctly extracts and processes text labels from SVG elements.

Tools
Ruff

14-14: First argument of a method should be named self

Rename g to self

(N805)

graphviz2drawio/mx/MxGraph.py (1)

40-40: LGTM!

The add_edge method correctly adds the new key "value" with the formatted text labels.

@@ -18,8 +35,8 @@ def from_svg(self, g) -> Edge:
fr = fr.split(":")[0]
to = to.split(":")[0]
curve = None
label = SVG.get_text(g) or ""
labels = _get_labels(g)
Copy link
Contributor

Choose a reason for hiding this comment

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

Fix the undefined name _get_labels.

The _get_labels method is used but not defined in the current scope.

-        labels = _get_labels(g)
+        labels = self._get_labels(g)
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
labels = _get_labels(g)
labels = self._get_labels(g)
Tools
Ruff

38-38: Undefined name _get_labels

(F821)

@hbmartin hbmartin merged commit 97c64ec into hbmartin:master Jul 7, 2024
1 check failed
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