# uto

> PlantUML class diagram to OrientDB import.json converter.

Latest version **0.2.0** (published 2015-05-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install uto
pnpm add uto
yarn add uto
bun add uto
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2015-05-24 |
| First published | 2015-05-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.12.0 |
| Dependencies | 6 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Denis Bondarenko |
| Maintainers | bond007 |
| Keywords | plantuml, orientdb, uml, graphdb, nosql |

## Links

- npm: https://www.npmjs.com/package/uto
- Repository: https://github.com/bondden/uto
- Issues: https://github.com/bondden/uto/issues
- npm.io page: https://npm.io/package/uto

## Dependencies (6)

- [express](https://npm.io/package/express.md) ^4.12.4
- [oriento](https://npm.io/package/oriento.md) ^1.1.3
- [fs-extra](https://npm.io/package/fs-extra.md) ^0.18.2
- [traverse](https://npm.io/package/traverse.md) ^0.6.6
- [json-templater](https://npm.io/package/json-templater.md) ^1.0.1
- [node-json-minify](https://npm.io/package/node-json-minify.md) ^0.1.3-a

## Alternatives

- [d3-force-3d](https://npm.io/package/d3-force-3d.md) — 1.0M weekly downloads
- [ng2-charts](https://npm.io/package/ng2-charts.md) — 486.8K weekly downloads
- [@arcgis/core](https://npm.io/package/@arcgis/core.md) — 257.8K weekly downloads
- [react-sparklines](https://npm.io/package/react-sparklines.md) — 249.3K weekly downloads
- [react-native-gifted-charts](https://npm.io/package/react-native-gifted-charts.md) — 182.3K weekly downloads

## Recent versions

- 0.2.0 (latest) — 2015-05-24
- 0.1.0 — 2015-05-16

## README

# UTO

Node.JS module for [**PlantUML** Class Diagram](http://plantuml.sourceforge.net/classes.html) **to** [**OrientDB** Schema](http://orientdb.com/docs/last/Schema.html) (import.json) conversion.

## Installation

```sh
npm install uto
```

## Technology Basics

- [ ] todo: GraphDB Architecture Description 

1) Create a [domain model](http://www.uml-diagrams.org/class-diagrams-overview.html#domain-model-diagram) with PlantUML class diagram, using either  
	* [your favourite tool](http://plantuml.sourceforge.net/running.html) or
	* [online PlantUML Editor](http://itms.pro/).

2) Save file as *.puml.

3) Convert to import.json for OrientDB with the **u2j**:

```sh
node u2j PATH_TO_PLANTUML_CLASS_DIAGRAM.puml PATH_TO_IMPORT.json
```

4) Import to OrientDB:

```sh
create database plocal:PATH_TO_DB_DIRECTORY/DB_NAME
import PATH_TO_IMPORT.json
```

## Supported PlantUML Features

* Packages
* Package nesting
* Classes
* Class inheritance both with
	* ```extends``` keyword
	* and ```--|>``` arrow variations
* Attributes
* Attribute types
* Comments filtering

The recent edition of the PlantUML reference is [downloadable in PDF-format](http://plantuml.sourceforge.net/PlantUML_Language_Reference_Guide.pdf) from the official [PlantUML site](http://plantuml.sourceforge.net).

## PlantUML Example

<table>
	<thead>
		<tr>
			<th>Code</th>
			<th>Rendered Image</th>
		</tr>
	</thead>
	<tbody>
		<tr>
			<td>
				<pre lang="java">
@startuml

package Core{
	class Basic extends V{
		+dateCreated:datetime
		+dateChanged:datetime
	}
	class	Link extends E{
		+type
	}
}

package Storage{

	package Law{

		abstract class Body extends Basic{
			+langs:string[]
			+contacts:Contact[]
		}

		class Legal extends Body{
			+nameShort
			+nameFull
			+stockLinks
		}
		class Person extends Body{
			+name
			+familyName
			+dateBirth
			+dateDeath
		}
		class Contact extends Basic{
			+contactName
			+reactionInterval
		}

	}

	package Data{
		class DataItem extends Basic
		class DataItemRevision extends DataItem
	}

}

package Service {
	Client -u-|> Legal
}

@enduml
				</pre>
			</td>
			<td> IMAGE </td>
		</tr>
	</tbody>
</table>

## Resulting File

## Road Map
|Version  |Status     |Functionality |
|---      |---        |---           |
|0.1      |released   |Schema validated PlantUML to import.json conversion. Libraries: ```index```, ```compiler``` |
|0.2      |rc         |Automatic DB generator. Libraries: ```importer``` |
|0.3      |           |Interactive front-end. External graphic renderer. Libraries: ```server```, ```assets``` |
|0.4      |           |Internal server-side graphic renderer. Libraries: ```renderer``` |
|0.5      |           |Export to PlantUML. Libraries: ```exporter``` |
|1.0      |           |Style guide, page. Libraries: ```^assets```|
|2.0      |           |ESF requirements diagrams support.|

## License

The MIT License (MIT)

Copyright (c) 2015 [Denis Bondarenko](https://github.com/bondden)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

---
_Source: https://npm.io/package/uto · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._