simple-erd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8614975c029b989cdb575295e93ff68f8cbf2b69
+  data.tar.gz: c7d877e22ab7a082d0f3c2383cb30b891fdf2f3e
+SHA512:
+  metadata.gz: 50600242c993bc3124cc2009702a9269e1078c69723b1f37cc6c2ca5804f99950efd2f954dbf398dbf36c2e0e03cfd0ad7ef3844ff3b2e931571efe2639d3488
+  data.tar.gz: b561d60e38097db0f514dceec0a51555285f5205eb498e353cf3e37d07ab4112a7e255e19d7911082a43a166270e35a2876f6f6a15f6e29afd0ef32944307292

data/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 IEVGEN PYROGOV
+
+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.

data/README.md

@@ -0,0 +1,90 @@
+# SimpleERD
+
+SimpleERD is a tool to generate beautiful ERD digrams from plain text.
+
+SimpleERD started out as an experiment and is currently at its early stage of development. Consider it a working prototype. SimpleERD is written in Ruby, but this is likely subject for a change.
+
+## Installation
+
+There are two installation options on macOS:
+
+* via [`homebrew`](https://brew.sh):
+
+  ```bash
+  $ brew tap gmile/apps
+  $ brew install simple-erd --HEAD
+  ```
+
+* via [`rubygems`](https://rubygems.org):
+
+  1. make sure to have `graphviz` installed:
+
+      ```bash
+      $ brew install graphviz
+      ```
+
+  2. intall the gem:
+
+      ```bash
+      $ gem install simple-erd
+      ```
+
+## Usage
+
+SimpleERD requires a text file as an input. Input file contains text formatted the following way:
+
+```
+[entity_1]
+attribute | type
+
+[entity_2]
+attribute | type | modifier
+
+[entity_3]
+attribute
+
+(entity_group_1)
+entity_1
+entity_2
+
+(entity_group_2)
+entity_3
+
+entity_1 ?--1 entity_2
+entity_3 *--n entity_2
+```
+
+Here, `[entity_1]` starts a block, indicating an entity. Right below `[entity_1]` come entity attributes. An entity attribute is defined by a `attribute_name`, `type` (optional and `modifier` (optional).
+
+At the bottom of input file – relations between entities. Syntax for relations:
+
+* `?` – 0 or 1
+* `1` – exactly 1
+* `*` – 0 or more
+* `+` – 1 or more
+* `x` – relation is undefined, will render as `???` in the output.
+
+## Examples
+
+```bash
+$ simple-erd -i samples/complex_input.txt -o /tmp/output.pdf
+```
+
+See [/samples](/samples) for more samples.
+
+## Motivation
+
+I was inspired by [`erd`](https://github.com/BurntSushi/erd) from [Andrew Gallant](https://github.com/BurntSushi), but had a couple of issues with it:
+
+* mainly I found it hard, although possible, to install:
+
+  * `erd` requires haskell runtime to be available, which takes around 1Gb when installed.
+  * it is required to install `cabal` and all of `erd`'s dependencies manually.
+
+* the libarary doesn't seem to be actively maintained.
+
+Also, I wanted to work on the custom styling of the diagram.
+
+## Licence
+
+MIT

data/samples/complex_input.txt

@@ -0,0 +1,202 @@
+[legal_entity]
+id | VARCHAR(36) | NOT NULL
+name | TEXT | NOT NULL
+short_name | TEXT | NULL
+type | ENUM('msp', 'mis', 'drug_store') | NOT NULL
+edrpou | TEXT | NOT NULL
+addresses[] | JSON | NULL
+phones[] | JSON | NULL
+emails[] | JSON | NULL
+created_at | DATETIME | NOT NULL
+created_by | TEXT | NOT NULL
+updated_at | DATETIME | NULL
+updated_by | TEXT | NULL
+active | TINYINT | NOT NULL
+public_name | VARCHAR(45) | NULL
+kved | JSON | NOT NULL
+founders[] | JSON | NOT NULL
+status | ENUM('new', 'verified') | NOT NULL
+owner_property_type | ENUM('state', 'private') | NOT NULL
+legal_form | ENUM('ТОВ', 'ФОП') | NOT NULL 
+
+[doctor]
+id | VARCHAR(36) | NOT NULL
+education[] | JSON | NOT NULL
+qualification[] | JSON | NULL 
+speciality[] | ENUM('терапевт', 'педіатр', 'сімейний лікар') | NOT NULL
+professional_level | JSON | NOT NULL 
+science_degree | JSON | NULL 
+academic_degree | JSON | NULL 
+specialization | TEXT | NULL
+
+[party]
+id | VARCHAR(36) | NOT NULL
+last_name | TEXT | NOT NULL
+first_name | TEXT | NOT NULL
+second_name | TEXT | NULL
+birth_date | DATE | NOT NULL
+gender | ENUM('GENDER') | NOT NULL
+tax_id | TEXT | NULL
+national_id | TEXT | NULL
+documents | JSON | NULL
+phones | JSON | NULL
+created_at | DATETIME | NOT NULL
+created_by | TEXT | NOT NULL
+updated_at | DATETIME | NOT NULL
+updated_by | TEXT | NOT NULL
+
+[employee_doctor]
+id | VARCHAR(36) NOT | NULL
+education[] | JSON | NOT NULL
+qualification[] | JSON | NULL
+speciality[] | ENUM('терапевт', 'педіатр', 'сімейний лікар') | NOT NULL
+professional_level | JSON | NOT NULL
+science_degree | JSON | NULL
+academic_degree | JSON | NULL
+specialization | TEXT | NULL
+working_hours | TEXT | NULL
+
+[division]
+id | VARCHAR(36) | NOT NULL
+msp_id | TEXT | NOT NULL
+name | VARCHAR(45) | NOT NULL
+address | JSON | NOT NULL
+external_id | TEXT | NULL
+phones[] | JSON | NULL
+email | JSON | NULL
+
+[employee]
+id | VARCHAR(36) | NOT NULL
+legal_entity_id | TEXT | NOT NULL
+position | TEXT | NOT NULL 
+start_date | DATETIME | NOT NULL
+end_date | DATETIME | NULL
+active | TINYINT | NOT NULL
+created_at | TIMESTAMP | NOT NULL
+updated_at | TIMESTAMP | NOT NULL
+created_by | TEXT | NOT NULL
+updated_by | TEXT | NOT NULL
+status | ENUM('') | NOT NULL
+employee_type | ENUM('doctor', 'hr', 'owner', 'accountant') | NOT NULL
+party_id | TEXT | NOT NULL
+division_id | VARCHAR(45) | NOT NULL
+
+[declaration_signed]
+id | VARCHAR(36) | NOT NULL
+document_type | ENUM('declaration', 'msp_registration') | NOT NULL
+document | TEXT | NOT NULL
+content | TEXT | NOT NULL
+public_key | TEXT | NOT NULL
+
+[msp]
+id | VARCHAR(36) | NOT NULL
+mountain_group | ENUM('') | NOT NULL
+accreditation[] | JSON | NOT NULL
+license[] | JSON | NOT NULL
+
+[capitation_contract]
+id | VARCHAR(36) | NOT NULL
+msp_id | TEXT | NOT NULL
+product_id | TEXT | NOT NULL
+start_date | DATETIME | NOT NULL
+end_date | DATETIME | NULL
+status | ENUM('') | NOT NULL
+signed_at | DATETIME | NULL
+services[] | JSON | NULL
+
+[product]
+id | VARCHAR(36) | NOT NULL
+name | TEXT | NOT NULL
+parameters[] | JSON | NOT NULL
+
+[declaration_request]
+id | VARCHAR(36) | NOT NULL
+f1 | VARCHAR(45) | NULL
+f2 | VARCHAR(45) | NULL
+
+[declaration]
+id | VARCHAR(36) | NOT NULL
+patient_id | TEXT | NOT NULL
+start_date | DATETIME | NOT NULL
+end_date | DATETIME | NOT NULL
+legal_entity_id | TEXT | NOT NULL
+status | ENUM('') | NOT NULL
+signed_at | DATETIME | NULL
+created_at | DATETIME | NOT NULL
+created_by | TEXT | NOT NULL
+updated_at | DATETIME | NOT NULL
+updated_by | TEXT | NOT NULL
+active | TINYINT | NULL
+scope | ENUM('') | NULL
+employee_id | TEXT | NOT NULL
+declaration_signed_id | INT | NOT NULL
+
+[log_changes]
+id | VARCHAR(36) | NOT NULL
+user_id | VARCHAR(45) | NOT NULL
+resource | TEXT | NOT NULL
+what_changed | JSON | NOT NULL
+TS | TIMESTAMP | NOT NULL
+
+[legal_entity_requests]
+id | INT | NOT NULL
+legal_entity_data | VARCHAR(45) | NULL
+
+[registration_requests]
+id | VARCHAR(36) | NOT NULL
+msp_id | VARCHAR(45) | NULL
+creator_id | VARCHAR(45) | NOT NULL
+data | JSON | NOT NULL
+email | TEXT | NOT NULL
+creator_signature | TEXT | NOT NULL
+status | ENUM('') | NOT NULL
+verification_id | VARCHAR(45) | NOT NULL
+
+[users]
+id | VARCHAR(36) | NOT NULL
+email | TEXT | NOT NULL
+user_name | VARCHAR(45) | NOT NULL
+inserted_at | DATETIME | NOT NULL
+inserted_by | TEXT | NOT NULL
+updated_at | DATETIME | NOT NULL
+updated_by | TEXT | NOT NULL
+status | ENUM('') | NOT NULL
+credentials | JSON | NOT NULL
+party_id | VARCHAR(26) | NULL
+scopes[] | TEXT | NOT NULL
+
+(PRM)
+party
+doctor
+division
+msp
+employee
+legal_entity
+capitation_contract
+product
+employee_doctor
+
+(Auth)
+users
+registration_requests
+
+(OPS_DB)
+declaration
+declaration_request
+
+(Media Storage)
+declaration_signed
+
+party 1--? doctor
+party 1--+ employee
+employee *--1 division
+employee *--1 legal_entity
+division +--1 legal_entity
+msp +--1 legal_entity
+product x--1 legal_entity
+capitation_contract *--1 product
+capitation_contract 1--x product
+employee 1--? employee_doctor
+employee 1--* declaration
+declaration ?--1 declaration_signed
+party ?--+ users

data/samples/simple_input.txt

@@ -0,0 +1,13 @@
+[Person]
+*name
+height
+weight
++birth_location_id
+
+[Location]
+*id
+city
+state
+country
+
+Person 1--1 Location

data/simple-erd

@@ -0,0 +1,182 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+required_options = {
+  input: nil,
+  output: nil,
+  output_format: "pdf"
+}
+
+OptionParser.new do |parser|
+  parser.on("-i", "--input PATH", "A path to the input file.") do |v|
+    required_options[:input] = v
+  end
+
+  parser.on("-o", "--output PATH", "A path to the output file.") do |v|
+    required_options[:output] = v
+  end
+
+  parser.on("-f", "--format FORMAT", "Output file format. See a list of available formats here: http://www.graphviz.org/doc/info/output.html") do |v|
+    required_options[:output_format] = v
+  end
+end.parse!
+
+required_options.each do |key, value|
+  if required_options[key].nil?
+    puts "Please, specify '#{key}' parameter."
+    puts ""
+    puts "For further help, run:"
+    puts ""
+    puts "  simple-erd --help"
+
+    exit(1)
+  end
+end
+
+input_filename = required_options[:input]
+output_filename = required_options[:output]
+output_format = required_options[:output_format]
+
+input = IO.read(input_filename)
+
+node_template = %{
+"%{entity_name}" [label=<%{entity_contents}>]
+}
+
+table_template = %(
+<table border="0" cellborder="0" cellspacing="0" bgcolor="#FFFFFF">
+  <tr>
+    <td colspan="3" border="1" bgcolor="#EEEEEE" cellpadding="0"><font face="PT Mono"><b>%{entity_name}</b></font></td>
+  </tr>
+  %{attributes}
+</table>
+)
+
+row_template = %Q(
+<tr>
+  <td border="1" sides="l%{b}" align="left" port="id"><font face="PT Mono">%{column_name}&nbsp;</font></td>
+  <td %{draw_bottom} align="left"><font color="#999999" face="PT Mono">%{column_type}&nbsp;</font></td>
+  <td border="1" sides="r%{b}" align="left"><font color="#CCCCCC" face="PT Mono">%{null_or_not}</font></td>
+</tr>
+)
+
+edge_template = %{%{from} -> %{to} [headlabel="%{to_n}", taillabel="%{from_n}", arrowtail=odot, arrowhead=none, style="%{line_type}", fontname="PT Mono"]}
+
+@cluster_n = 0
+
+contents =
+  input.split("\n\n").map do |group|
+    lines = group.strip.split("\n")
+
+    case
+    when lines[0].start_with?("[")
+      entity_name = lines[0].scan(/\w+/)[0]
+
+      n_of_attributes = lines[1..-1].size
+
+      if entity_name[-1] != "s"
+        puts "Warning: '#{entity_name}' table name must be in plural form"
+      end
+
+      attributes =
+        lines[1..-1].map.with_index do |line, idx|
+          match = line.match /(?<a>.[^\|]*)\s?\|?\s?(?<b>.[^\|]*)?\s?\|?\s?(?<c>.[^\|]*)?/
+
+          draw_bottom = idx == n_of_attributes - 1
+
+          if !(match[:a].strip.match? /^\w+$/)
+            if match[:a].strip.end_with?("[]")
+              puts "Warning: '#{entity_name}'.'#{match[:a]}' ends with '[]'. If it meant to indicate an array, consider making the attribute name plural and appending '[]' to the type, e.g.: #{match[:b].strip}[]"
+            else
+              puts "Warning: '#{entity_name}'.'#{match[:a]}' contains characters, other than A-Za-z_. Please, rename the attribute to only contain only A-Za-z_."
+            end
+          end
+
+          if match[:a].strip.end_with?("_id") && match[:b].strip == "TEXT"
+            puts "Warning: '#{entity_name}'.'#{match[:a].strip}' looks like a secondary key. Should its type be 'integer' or 'UUID'?"
+          end
+
+          if match[:b].strip == "VARCHAR(36)"
+            puts "Warning: '#{entity_name}'.'#{match[:a].strip}' is a UUID? Consider using built-in type, UUID"
+          end
+
+          if match[:c] == "NULL"
+            puts "Warning: '#{entity_name}'.'#{match[:a].strip}' - no need to specify explitit NULL"
+          end
+
+          (row_template % {
+            column_name: match[:a],
+            column_type: match[:b],
+            null_or_not: match[:c] || "&nbsp;",
+            b: draw_bottom ? "b" : "",
+            draw_bottom: draw_bottom ? 'border="1" sides="b"' : ""
+          }).strip
+        end.join("\n")
+
+      table =
+        table_template % {
+          entity_name: entity_name,
+          attributes: attributes
+        }
+
+      node_template % {
+        entity_name: entity_name,
+        entity_contents: table
+      }
+    when lines[0].start_with?("(")
+      cluster_name = lines[0].match(/\((.*)\)/)[1]
+
+      @cluster_n += 1
+
+      %Q{
+        subgraph cluster_#{@cluster_n} {
+          label = "#{cluster_name}";
+          labeljust = "l";
+          style=filled;
+          fontname = "PT Mono";
+          color="#f0f1fe";
+
+          #{lines[1..-1].join(",")};
+        }
+      }
+    else
+      lines.map do |line|
+        from, relation, to = line.split(" ")
+        from_n, to_n = relation.split("--")
+
+        t = ->(string) {
+          case string
+          when "?" then "0..1"
+          when "1" then "1"
+          when "*" then "0..n"
+          when "+" then "1..n"
+          when "x" then "???"
+          end
+        }
+
+        line_type = "dashed"
+
+        edge_template % {
+          line_type: line_type,
+          from: from,
+          from_n: t.(from_n),
+          to: to,
+          to_n: t.(to_n),
+        }
+      end
+    end
+  end.join("\n")
+
+File.open("test.dot", "w+") do |f|
+  f.puts "
+digraph G {
+  node [shape=plaintext]
+
+  #{contents}
+}
+  "
+end
+
+`dot test.dot -T#{output_format} > #{output_filename}`
+`open #{output_filename}`

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: simple-erd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eugene Pirogov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-23 00:00:00.000000000 Z
+dependencies: []
+description: A tool to generate ERD diagrams
+email: iamexile@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENCE
+- README.md
+- samples/complex_input.txt
+- samples/simple_input.txt
+- simple-erd
+homepage: http://rubygems.org/gems/simple-erd
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A tool to generate ERD diagrams
+test_files: []