{"id":24607596,"url":"https://github.com/adrianmarino/ruml","last_synced_at":"2025-03-18T11:24:43.528Z","repository":{"id":89013252,"uuid":"50964566","full_name":"adrianmarino/ruml","owner":"adrianmarino","description":"A ruby to dot transpiler. Useful to generate classes hierarchy diagrams from ruby source","archived":false,"fork":false,"pushed_at":"2016-02-17T02:53:09.000Z","size":3028,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-24T17:38:48.188Z","etag":null,"topics":["antlr4","dot","jruby"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adrianmarino.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-02-03T01:21:37.000Z","updated_at":"2019-01-05T14:22:20.000Z","dependencies_parsed_at":"2023-05-03T05:04:07.380Z","dependency_job_id":null,"html_url":"https://github.com/adrianmarino/ruml","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrianmarino%2Fruml","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrianmarino%2Fruml/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrianmarino%2Fruml/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrianmarino%2Fruml/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adrianmarino","download_url":"https://codeload.github.com/adrianmarino/ruml/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244209188,"owners_count":20416232,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["antlr4","dot","jruby"],"created_at":"2025-01-24T17:38:58.979Z","updated_at":"2025-03-18T11:24:43.501Z","avatar_url":"https://github.com/adrianmarino.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/adrianmarino/ruml.svg?branch=master)](https://travis-ci.org/adrianmarino/ruml)\n[![License](http://img.shields.io/:license-mit-blue.svg)](http://badges.mit-license.org)\n\n\n# Ruml\n\nRuby to dot transpiler.\n\n###  Requisites\n\n* Java 7: i.e. install using jenv:\n```bash\n$ curl -L -s get.jenv.io | bash\njenv install java 1.7.0_75\n```\n\n* JRuby: i.e. install using rvm\n```bash\nrvm install jruby\nrvm use jruby\n```\n\n### Install\n\nDownload repo and install gem:\n\n```bash\ngit clone https://github.com/adrianmarino/ruml.git\ncd ruml\nrake install:local\n```\nOr include in your Gemfile:\n\n```ruby\ngem 'ruml', git: 'https://github.com/adrianmarino/ruml.git', branch: 'master'\n```\n\n### Use\n\n#### Generate dot diagram from irb\n\n```ruby\nrequire 'ruml'; Ruml::Transpiler::Ruby2Dot.from_path('example/input.rb').compile\n```\n\n#### Generate dot diagram with ruby2dot command\n\nNext command read an [input ruby file](example/input.rb) and generate an output in dot language. Then redirect the output to xdot command.\nxdot is a dot viewer.\n```bash\nbin/ruby2dot example/input.rb | xdot\n```\nxdot output:\n\n![alt Models Diagram](https://raw.githubusercontent.com/adrianmarino/ruml/master/example/output.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadrianmarino%2Fruml","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadrianmarino%2Fruml","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadrianmarino%2Fruml/lists"}