rudg

Rust UML Diagram Generator

Tools that parsing Rust code into UML diagram (in dot format currently).

Usage

$ rudg.exe --help
rudg 0.1.0

USAGE:
    rudg.exe [file] [OPTIONS]

ARGS:
    <file>    Rust source code file path

OPTIONS:
    -h, --help            Print help information
    -o, --output <DIR>    Sets a custom output directory
    -V, --version         Print version information

Roadmap (TODO list)

comprehensive tests and bug fix
support for modelling the whole crate's source code

Contributing

All sorts of contributing are welcome. Please feel free to open issue and/or PR.
We belive that TDD(Test-Driven Development) approach is helpful not only in development, but also in communication with each other. So adding more tests might be a good way to report a bug or even suggest a new feature.

License

rudg is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE and LICENSE-MIT for details.

Related Project

dot_graph: A library for generating Graphviz DOT language files.

Sample code of Yew (0.18). Something like a PuyoPuyo.

RusRus Requirements Docker Depend on Yew ver 0.18.0 Usase docker build -t rusrus . # start serve docker run -p 8080:8080 --rm -it -v $(pwd):/app -w /

5 Jan 10, 2022

This code generate coinjoin transaction whici has two inputs and two outputs

How to create coinjoin transaction This code generate coinjoin transaction whici has two inputs and two outputs. First, we create two trasactions. The

2 Jun 25, 2022

This repository contains the sample code for Rainer Stropek's talk at Eurorust 2022.

Building Web APIs with Rust - State of the Union Introduction This repository contains the sample code for Rainer Stropek's talk at Eurorust 2022. The

24 Feb 9, 2023

Code template for a production Web Application using Axum: The AwesomeApp Blueprint for Professional Web Development.

AwesomeApp rust-web-app More info at: https://awesomeapp.dev/rust-web-app/ rust-web-app YouTube episodes: Episode 01 - Rust Web App - Course to Produc

45 Sep 6, 2023

Rust I18n is use Rust codegen for load YAML file storage translations on compile time, and give you a t! macro for simply get translation texts.

Rust I18n Rust I18n is use Rust codegen for load YAML file storage translations on compile time, and give you a t! macro for simply get translation te

73 Dec 27, 2022

Comments

Test failures due to quotes

These look like minor failures to do with quoting of labels.

> rpm -q graphviz
graphviz-2.49.3-2.4.x86_64

> cargo test
   Compiling rudg v0.2.0-dev (/home/jayvdb/rust/rudg)
    Finished test [unoptimized + debuginfo] target(s) in 0.74s
     Running unittests src/lib.rs (target/debug/deps/rudg-a1cdaa90caa6ae09)

running 17 tests
test graph_exporter::to_dot::tests::test_uml_class_composition ... FAILED
test file_reader::tests::test_visit_dirs ... ok
test graph_exporter::to_dot::tests::test_mods ... FAILED
test graph_exporter::to_dot::tests::test_uml_class_aggregation ... FAILED
test graph_exporter::to_dot::tests::test_uml_class_dependency ... FAILED
test graph_exporter::to_dot::tests::test_uml_class_association ... FAILED
test graph_exporter::to_dot::tests::test_uml_classes_fns_to_dot ... FAILED
test graph_exporter::to_dot::tests::test_uml_fn_relations ... FAILED
test graph_exporter::to_dot::tests::test_uml_class_realization ... FAILED
test parser::ast_parser::tests::test_parse_fn ... ok
test parser::ast_parser::tests::test_parse_struct ... ok
test parser::ast_parser::tests::test_aggregation ... ok
test parser::ast_parser::tests::test_composition ... ok
test parser::ast_parser::tests::test_fn_dependency ... ok
test parser::ast_parser::tests::test_class_dependency ... ok
test parser::ast_parser::tests::test_association ... ok
test parser::ast_parser::tests::test_realization ... ok

failures:

---- graph_exporter::to_dot::tests::test_uml_class_composition stdout ----
thread 'graph_exporter::to_dot::tests::test_uml_class_composition' panicked at 'assertion failed: `(left == right)`
  left: `"digraph ast {\n    \"Mock\"[label=\"{Mock|c: C}\"][shape=\"record\"];\n    \"C\"[label=\"C\"][shape=\"record\"];\n    \"Mock\" -> \"C\"[label=\"\"][arrowhead=\"diamond\"];\n}\n"`,
 right: `"digraph ast {\n    Mock[label=\"{Mock|c: C}\"][shape=\"record\"];\n    C[label=\"C\"][shape=\"record\"];\n    Mock -> C[label=\"\"][arrowhead=\"diamond\"];\n}\n"`', src/graph_exporter/to_dot.rs:282:9
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

---- graph_exporter::to_dot::tests::test_mods stdout ----
thread 'graph_exporter::to_dot::tests::test_mods' panicked at 'The name of the subgraph should start with "cluster_"', /home/jayvdb/.cargo/registry/src/github.com-1ecc6299db9ec823/dot_graph-0.2.3/src/subgraph.rs:144:9

---- graph_exporter::to_dot::tests::test_uml_class_aggregation stdout ----
thread 'graph_exporter::to_dot::tests::test_uml_class_aggregation' panicked at 'assertion failed: `(left == right)`
  left: `"digraph ast {\n    \"Mock\"[label=\"{Mock|b: *mut B}\"][shape=\"record\"];\n    \"B\"[label=\"B\"][shape=\"record\"];\n    \"Mock\" -> \"B\"[label=\"\"][arrowtail=\"odiamond\"];\n}\n"`,
 right: `"digraph ast {\n    Mock[label=\"{Mock|b: *mut B}\"][shape=\"record\"];\n    B[label=\"B\"][shape=\"record\"];\n    Mock -> B[label=\"\"][arrowtail=\"odiamond\"];\n}\n"`', src/graph_exporter/to_dot.rs:264:9

---- graph_exporter::to_dot::tests::test_uml_class_dependency stdout ----
thread 'graph_exporter::to_dot::tests::test_uml_class_dependency' panicked at 'assertion failed: `(left == right)`
  left: `"digraph ast {\n    \"Mock\"[label=\"{Mock|mock_fn()}\"][shape=\"record\"];\n    \"f1\"[label=\"f1\"];\n    \"f2\"[label=\"f2\"];\n    \"f1\" -> \"Mock\"[label=\"\"][style=\"dashed\"][arrowhead=\"vee\"];\n    \"f2\" -> \"Mock\"[label=\"\"][style=\"dashed\"][arrowhead=\"vee\"];\n}\n"`,
 right: `"digraph ast {\n    Mock[label=\"{Mock|mock_fn()}\"][shape=\"record\"];\n    f1[label=\"f1\"];\n    f2[label=\"f2\"];\n    f1 -> Mock[label=\"\"][style=\"dashed\"][arrowhead=\"vee\"];\n    f2 -> Mock[label=\"\"][style=\"dashed\"][arrowhead=\"vee\"];\n}\n"`', src/graph_exporter/to_dot.rs:246:9

---- graph_exporter::to_dot::tests::test_uml_class_association stdout ----
thread 'graph_exporter::to_dot::tests::test_uml_class_association' panicked at 'assertion failed: `(left == right)`
  left: `"digraph ast {\n    \"Mock\"[label=\"{Mock|e2() -> E2}\"][shape=\"record\"];\n    \"E1\"[label=\"{E1|b() -> Mock}\"][shape=\"record\"];\n    \"E2\"[label=\"{E2|a() -> Mock}\"][shape=\"record\"];\n    \"E1\" -> \"Mock\"[label=\"\"][arrowhead=\"vee\"];\n    \"E2\" -> \"Mock\"[label=\"\"][arrowhead=\"none\"];\n}\n"`,
 right: `"digraph ast {\n    Mock[label=\"{Mock|e2() -> E2}\"][shape=\"record\"];\n    E1[label=\"{E1|b() -> Mock}\"][shape=\"record\"];\n    E2[label=\"{E2|a() -> Mock}\"][shape=\"record\"];\n    E1 -> Mock[label=\"\"][arrowhead=\"vee\"];\n    E2 -> Mock[label=\"\"][arrowhead=\"none\"];\n}\n"`', src/graph_exporter/to_dot.rs:322:9

---- graph_exporter::to_dot::tests::test_uml_classes_fns_to_dot stdout ----
thread 'graph_exporter::to_dot::tests::test_uml_classes_fns_to_dot' panicked at 'assertion failed: `(left == right)`
  left: `"digraph ast {\n    \"Main\"[label=\"{Main|a: String\\lb: String|main() -> ()\\lmain1()}\"][shape=\"record\"];\n    \"MainTrait\"[label=\"{Interface\\lMainTrait|main() -> ()}\"][shape=\"record\"];\n    \"test\"[label=\"test\"];\n}\n"`,
 right: `"digraph ast {\n    Main[label=\"{Main|a: String\\lb: String|main() -> ()\\lmain1()}\"][shape=\"record\"];\n    MainTrait[label=\"{Interface\\lMainTrait|main() -> ()}\"][shape=\"record\"];\n    test[label=\"test\"];\n}\n"`', src/graph_exporter/to_dot.rs:207:9

---- graph_exporter::to_dot::tests::test_uml_fn_relations stdout ----
thread 'graph_exporter::to_dot::tests::test_uml_fn_relations' panicked at 'assertion failed: `(left == right)`
  left: `"digraph ast {\n    \"main\"[label=\"main\"];\n    \"test\"[label=\"test\"];\n    \"main\" -> \"test\"[label=\"\"][style=\"dashed\"][arrowhead=\"vee\"];\n}\n"`,
 right: `"digraph ast {\n    main[label=\"main\"];\n    test[label=\"test\"];\n    main -> test[label=\"\"][style=\"dashed\"][arrowhead=\"vee\"];\n}\n"`', src/graph_exporter/to_dot.rs:224:9

---- graph_exporter::to_dot::tests::test_uml_class_realization stdout ----
thread 'graph_exporter::to_dot::tests::test_uml_class_realization' panicked at 'assertion failed: `(left == right)`
  left: `"digraph ast {\n    \"Mock\"[label=\"Mock\"][shape=\"record\"];\n    \"D\"[label=\"{Interface\\lD|a(&self) -> Option<T>}\"][shape=\"record\"];\n    \"Mock\" -> \"D\"[label=\"\"][style=\"dashed\"][arrowhead=\"onormal\"];\n}\n"`,
 right: `"digraph ast {\n    Mock[label=\"Mock\"][shape=\"record\"];\n    D[label=\"{Interface\\lD|a(&self) -> Option<T>}\"][shape=\"record\"];\n    Mock -> D[label=\"\"][style=\"dashed\"][arrowhead=\"onormal\"];\n}\n"`', src/graph_exporter/to_dot.rs:300:9


failures:
    graph_exporter::to_dot::tests::test_mods
    graph_exporter::to_dot::tests::test_uml_class_aggregation
    graph_exporter::to_dot::tests::test_uml_class_association
    graph_exporter::to_dot::tests::test_uml_class_composition
    graph_exporter::to_dot::tests::test_uml_class_dependency
    graph_exporter::to_dot::tests::test_uml_class_realization
    graph_exporter::to_dot::tests::test_uml_classes_fns_to_dot
    graph_exporter::to_dot::tests::test_uml_fn_relations

test result: FAILED. 9 passed; 8 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.00s

error: test failed, to rerun pass '--lib'

opened by jayvdb 1

Fix tests quotes

The quote problem #16 is from the update of dot_graph, from v0.2.1 to v0.2.3. So I changed all nodes' names in the tests. Plus, support for parsing multi-file crate is not ready yet, so I remove the test accordingly.

opened by SelamaAshalanore 0
Cargo extension

I was wondering would it be possible to package this as a cargo extension so that it can generate the class diagram for an entire project (in the spirit of cargo-modules)?

opened by giannissc 0
Project support

Currently the rudg tool only supports generating a diagram for a single file.

The README does mention support is coming in next release v0.2.0 but I wanted to open an issue so I can track when this work is complete:

Currently, this tool could only parse single .rs file, and support for parsing whole crate will be released on v0.2.0, which is under development.

opened by Integralist 4