Home / Rust / Virtualization

mml - A library to generating UML language from Rust’s project into graphiz/dot file

ML -Modeling Language- A library to generating UML language from Rust's project into graphiz/dot file. Usage This repo is provided as a Cargo package
Information
Category: Rust / Virtualization
Watchers: 2
Star: 74
Fork: 13
Last update: Nov 23, 2023
Resource links
https://adjivas.github.io/ml/mml
https://github.com/adjivas/ml

ML -Modeling Language-

Crate travis-badge appveyor-badge dependencyci-badge

A library to generating UML language from Rust's project into graphiz/dot file.

Usage

This repo is provided as a Cargo package and a build script.

  1. adjust your Cargo.toml to include.
build = "build.rs"

[build-dependencies.mml]
version = "0.1"
  1. And your build.rs to generate your uml graph/viz and Structured Vector Graphics at target/dot/$CARGO_PKG_NAME.{dot,svg}.
extern crate mml;

fn main() {
    let dest: String = concat!("target/doc/", env!("CARGO_PKG_NAME")).to_string();

    let _ = mml::src2both("src", dest.replace("-", "_").as_str());
}
  1. (Facultative) From your entry point library file, you can add the generated vectorized graph.
//! ![uml](ml.svg)
  1. (Facultative) With the travis-cargo's instructions, you can prepare your graphviz's dependency like with this example.
addons:
  apt:
    packages:
      - graphviz
before_script:
  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew update           ; fi
  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install graphviz ; fi
...
script:
  - |
      travis-cargo build &&
...

Features

Consider this list of fonctionalities like unstandard-uml.

  • implem -- add a column to show the functions from a implementation.
  • fn-emilgardis -- the function fields are preceded by fn keyword (Asked by Emilgardis).

Knowledge

This is a reading list of material relevant to Ml. It includes prior research that has - at one time or another - influenced the design of Ml, as well as publications about Ml.

License

ml is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0), with portions covered by various BSD-like licenses.

See LICENSE-APACHE, and LICENSE-MIT for details.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

8 Open More issues
Open

error E0423 in syntex_syntax

When I try using this on a few projects, I get a build error

error[E0423]: expected function, tuple struct or tuple variant, found struct `ast::Name`
   --> /home/jayvdb/.cargo/registry/src/github.com-1ecc6299db9ec823/syntex_syntax-0.58.1/src/symbol.rs:146:27
    |
146 |                       name: ast::Name($index),
    |                             ^^^^^^^^^
...
165 | / declare_keywords! {
166 | |     // Invalid identifier
167 | |     (0,  Invalid,        "")
168 | |
...   |
231 | |     (56, CrateRoot, "{{root}}")
232 | | }
    | |_- in this macro invocation
    |
    = note: this error originates in the macro `declare_keywords` (in Nightly builds, run with -Z macro-backtrace for more info)

e.g. I tried this with https://github.com/swift-nav/esthri/tree/master/crates/esthri also some private projects which otherwise build normally.

opened Aug 24, 2022 by jayvdb 3
Open

Project state

Hello,

This project looks interesting; may I ask about the current state of the project in terms of maintenance and so on? If there is interest in maintaining this as a tool for generating UML from Rust crates and the goals are reasonably close to my own I would be interested in contributing. If on the other hand you know that e.g. some of the dependencies are unmaintained and this would be a huge amount of work then a clean slate approach might be better.

Best wishes, Max

opened Jun 5, 2019 by bitdivine 7
Open

using error_chain

I'm having issues with using error_chain for MML.

Cargo.toml

[package]
build = "build.rs"

[dependencies]
error-chain = "0.11.0"

[build-dependencies.mml]
version = "0.1"
error-chain = "0.11.0"

build.rs:

// UML Generator https://github.com/adjivas/ml

#![allow(unused_imports)]
#![allow(unused_variables)]
#![allow(dead_code)]

extern crate mml;

#[macro_use]
extern crate error_chain;

pub mod errors { error_chain!{} }

use errors::*;

fn make_uml_diagram() {
    // Generate diagram in /diagrams/ml.svg for README.md
    let dest: String = "../diagrams/".to_string();
    let _ = mml::src2both("src", dest.replace("-", "_").as_str());

    // Generate diagram in /target/doc/diamond_drops_node/ml.svg
    let dest: String = concat!("../target/doc/", env!("CARGO_PKG_NAME")).to_string();
    let _ = mml::src2both("src", dest.replace("-", "_").as_str());
}

fn main() {
    //make_uml_diagram();
}

$ cargo test
warning: unused manifest key: build-dependencies.mml.error-chain
   Compiling diamond-drops-node v0.1.0-a (file:///home/james/dod/node)
error[E0463]: can't find crate for `error_chain`
  --> build.rs:10:1
   |
10 | extern crate error_chain;
   | ^^^^^^^^^^^^^^^^^^^^^^^^^ can't find crate

error: aborting due to previous error
opened May 16, 2018 by jamesray1 0
Open

Use different generator library?

In order to get past the limits of the dot crate, perhaps it would make sense to use another graph generator, such as Jinja in Rust with a graphviz template similar to ansible-inventory-grapher's template.

opened Oct 24, 2017 by naturallymitchell 0
Open

Example diagrams

We currently have one example diagram. In order to test the project and make it useful, other code bases can be diagrammed and linked here. This list shows what it can do:

opened Oct 17, 2017 by naturallymitchell 2
Open

Infer component groupings based on folder structure

Would it be possible to organize the graph output structure like this visual paradigm - class diagram using the relationships encoded as a source code folder hierarchy? For example, this project's code seems organized well to fit that type of output.

opened Oct 17, 2017 by naturallymitchell 4

Contents

    umlet Free UML Tool for Fast UML Diagrams
    ykshi Text Style Transfer Benchmark
    sindresorhus Get, set, or delete a property from a nested object using a dot path
    takaakit UML diagram list of Python GoF design pattern examples.
    preston Ruby on Rails 3/4/5 model and controller UML class diagram generator. (`brew/port/apt-get install graphviz` before use!)
    Schachte 🧜‍♀️ RESTful rendering pipeline for generating sequence and UML diagrams using Mermaid for Markdown docs (Diagrams as a Service)
    pigfly High Performance Custom Dot Loading Indicator in iOS
    awalterschulze Parses the Graphviz DOT language in golang
    Gabriel439 Dhall support for the DOT language for graphviz
    abulka Reverse engineer Python source code into UML
    takaakit UML diagram list of GoF design pattern examples written in Java.
    lucasepe Converts 'go mod graph' output into Graphviz's DOT language
    skanehira Vim plugin for previewing UML
    andyabih Automagically generate UML diagrams of your Laravel code.
    takaakit UML model and code examples of design patterns for Crystal. The model is created with Astah.
    Hamzaoutdoors A console app that will help you to keep a record of different types of things you won : books, music albums, movies, and games. Everything will be based on the UML class diagram presented in Readme text.
    patniemeyer Generating Memoji from Photos
    twinklebear ispc - A build-time dependency for Cargo build scripts to help with compiling and linking to ISPC code and generating Rust bindings for the resulting library. This crate is a meta-crate for the ispc_compile and ispc_rt crates, which provide the actual functionality for building ISPC code and generating bindgs, and importing those bindings into Rust
    Muzihuzi A Sorrygle Editor Desktop app made with Electron
    egil Genzor is an experimental library ideally suited for generating files spanning multiple folders, using Blazor component model to generating the output.
    jrfonseca Converts profiling output to a dot graph.
    Share this repo

    Related Repos


    Virtualization
    618
    crosvm is a virtual machine monitor (VMM) based on Linux’s KVM hypervisor
    google crosvm is a virtual machine monitor (VMM) based on Linux’s KVM hypervisor
     
    Virtualization
    16
    Virtual machine with associated language written in Rust
    Wafelack Virtual machine with associated language written in Rust
     
    Virtualization
    208
    Virtual KVM switch for Linux machines
    htrefil rkvm rkvm is a tool for sharing keyboard and mouse across multiple Linux computers. It is based on a client/server architecture, where server is the m
     
    Virtualization
    46
    plotters-font-loader - A font loading utility written in and for rust. (Forked from MSleep...
    matprec Font-Loader A font loading utility written in and for Rust. Currently supported platforms: Windows Mac Every platform supporting Fontconfig Unix Linux
     
    Virtualization
    17
    ploteria - Criterion’s plotting library
    ploteria ploteria This crate allows you to easily crate complex plots and graphs. Internally this crate uses gnuplot to perform the actual plotting. This crate
     
    Virtualization
    1k
    voidmap - terminal mind-map + task tracker + tsdb
    void-rs void Tutorial Example Workflow WARNING: this is alpha, and the default keybinds are still weird because I use colemak on top of tmux. You may want to
     
    Virtualization
    24
    plot - A command-line plotting and statistics tool
    milliams Plot A command-line statistics and plotting tool. plot works on input streams and so if you have a file called data.txt which looks like: $ head -n4 d
     
    Virtualization
    74
    mml - A library to generating UML language from Rust’s project into graphiz/dot file
    adjivas ML -Modeling Language- A library to generating UML language from Rust's project into graphiz/dot file. Usage This repo is provided as a Cargo package
     
    Virtualization
    127
    gust - A small charting library for generating d3 and html charts using Rust
    saresend Gust A charting library for rust! Disclaimer This is still very much a work in progress! APIs are very unstable and subject to change. Contributions a
     
    Virtualization
    20
    peach - Sandbox engine for Rust, inspired by Processing
    flmng0 Peach Processing-esque sandboxing library for Rust with wgpu. Example See the examples folder for more code snippets, as well as screen shots. use pea
     
    Virtualization
    72
    rasciigraph - Utility function to plot ascii graphs
    orhanbalci rasciigraph Tiny Rust library to draw pretty line graphs using ascii characters. Usage Add this to your Cargo.toml [dependencies] rasciigraph = "0.1.1
     
    Virtualization
    46
    plotters-font-loader - A font loading utility written in and for rust. (Forked from MSleep...
    matprec Font-Loader A font loading utility written in and for Rust. Currently supported platforms: Windows Mac Every platform supporting Fontconfig Unix Linux
     
    Virtualization
    22
    hexplay - Format u8 slices like an hex editor
    tmoers Implements rust's Display trait to format a u8 slice as many hex editors do. This might be useful for dumping a binary blob for debugging purposes. Do
     
    Virtualization
    33
    solvent - Dependency Resolver library
    mikedilger solvent Solvent is a dependency resolver library written in rust. Documentation is available at https://docs.rs/solvent Solvent helps you to resolve d
     
    Virtualization
    236
    charts - A pure Rust visualization library inspired by D3.js
    askanium charts A pure Rust visualization library inspired by D3.js. See gallery and examples for code and more charts. Install You can add this as a dependenc