search

hbmartin / graphviz2drawio

Convert graphviz (dot) files to draw.io / lucid (mxGraph) format. Beautiful and editable graphs in your favorite editor.
https://pypi.org/project/graphviz2drawio/
GNU General Public License v3.0
186 stars 32 forks source link

Fix https://github.com/hbmartin/graphviz2drawio/issues/45 and support Images nodes #49

Closed laurierloi closed 2 months ago

laurierloi commented 2 years ago

I encountered https://github.com/hbmartin/graphviz2drawio/issues/45 converting a graph I built.

Added a commit which solves this issue by doing tree-search instead of direct-child search in SVG.py

Also added support (somewhat) for image nodes, which I also used in my graph. They are parsed as plain rectangles with the same dimensions. The idea is that the user can replace that rectangle with the desired image. Adding the image directly to the XML seems tortuous, since they seem to have a custom encoding and we don't have access to the java library.

Summary by CodeRabbit

sourcery-ai[bot] commented 2 years ago

Sourcery Code Quality Report

✅  Merging this PR will increase code quality in the affected files by 3.47%.

Quality metrics Before After Change
Complexity 8.34 ⭐ 7.65 ⭐ -0.69 👍
Method Length 53.56 ⭐ 53.45 ⭐ -0.11 👍
Working memory 8.29 🙂 7.66 🙂 -0.63 👍
Quality 64.17% 🙂 67.64% 🙂 3.47% 👍
Other metrics Before After Change
Lines 77 99 22
Changed files Quality Before Quality After Quality Change
graphviz2drawio/models/SVG.py 96.71% ⭐ 91.42% ⭐ -5.29% 👎
graphviz2drawio/mx/NodeFactory.py 58.96% 🙂 60.55% 🙂 1.59% 👍

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

File Function Complexity Length Working Memory Quality Recommendation
graphviz2drawio/mx/NodeFactory.py NodeFactory.from_svg 15 🙂 193 😞 11 😞 42.99% 😞 Try splitting into smaller methods. Extract out complex expressions

Legend and Explanation

The emojis denote the absolute quality of the code:

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!

AutomationD commented 1 year ago

Any luck with merging this?

coderabbitai[bot] commented 2 months ago

Walkthrough

The recent updates focus on enhancing SVG handling in the graphviz2drawio module by introducing a new svg_tag function and integrating it with existing tag-related functions. Additionally, NodeFactory.py now includes a method to create Rect objects from SVG image elements. A test graph file has also been added, featuring a directed graph with tooltips.

Changes

Files/Modules Change Summary
graphviz2drawio/models/SVG.py Refactored SVG tag handling with svg_tag function and updated get_first, is_tag, and has methods.
graphviz2drawio/mx/NodeFactory.py Introduced rect_from_image static method in NodeFactory to create Rect objects from SVG images.
test/directed/tooltip.gv.txt Added a new directed graph file with tooltip attributes for nodes and edges.

Sequence Diagram(s)

Creating Rect from SVG Image Element

sequenceDiagram
    participant User
    participant NodeFactory
    participant SVGElement
    participant Rect

    User->>NodeFactory: Call rect_from_image(attrib)
    NodeFactory->>SVGElement: Extract attributes (x, y, width, height)
    NodeFactory->>Rect: Create Rect object with extracted attributes
    NodeFactory-->>User: Return Rect object

Poem

To code we dance, in SVG's light,
Tags and nodes now sparkle bright. 🌟
A rect from images, we now create,
In graphs, our tooltips celebrate. 🌐
With tests to guide us through the night,
Our updates shine so right, alright! 🌜🐇

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
hbmartin commented 2 months ago

Thank you!