erdf 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc7111c52d6abd8c597198f420a84749ec783279
+  data.tar.gz: b262ed592a85ec3d0d0a2717f2e3d3e427e083a0
+SHA512:
+  metadata.gz: e171a035da75419e8eaa5ace0013f5add1232ccba456f1b5455dafdd6fea8c4a0d4dc684b47cdebe2687baf6f48391880978d617d8a8c8389bc778ecb7f44f2b
+  data.tar.gz: ee86906232b9f1baf58e0814c26acc37672a269b4c6a8d6cc6bfa7852f0e68ec36807a7f612d5c8a1b53adb8258efe97666a9054161d8b241997228f3853948e

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/docs/
+*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## 0.6.0
+- Help text
+- Track errors just so we could have a make target in our Makefile in the rust api server aran.
+- Format template.dot to different colors.
+
+## 0.3.0
+- Add basic style
+- Support database as schema source.
+
+## 0.2.0
+- Support text schemas.
+- Output the diagram as PNG.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in erde.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 David Strauß
+
+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,46 @@
+# Entity-Relationship-Diagramm-Erzeuger
+A simple tool to generate Entity-Relationship-Diagrams based on text input or directly from a PostgreSQL database. The format of the text schema is inspired and based on ["erd" by Andrew Gallant](https://github.com/BurntSushi/erd).
+
+Fork of [edgycircle/erde](https://github.com/edgycircle/erde) with fixes added to suit our development.
+
+## Motivation : Auto generating ERD from database
+
+There are online tools like [genmymodel](https://genmymodel.com) which allows to build ERD diagrams.
+
+We wanted a way where from a database we could draw a picture. This helps an instant update of schema and not making it stale.
+
+Hence we would create make targets that gets triggered which generates schema, from the *Makefile* in our rust aran api server.
+
+## Install
+Make sure you have [Graphviz](http://graphviz.org/) installed and available in your `$PATH`.  
+
+Install the gem with `gem install erdf`.
+
+## CLI Usage
+
+~~~txt
+erdf version
+~~~
+
+~~~txt
+erdf file docs/schema.txt docs/schema.png
+~~~
+
+~~~txt
+bin/erdf database postgres://user:password@localhost/your_database docs/schema.png
+~~~
+
+## Text Schema Format
+~~~txt
+[identities]
+id
+password
+email
+
+[players]
+id
+name
+identity_id
+
+players:identity_id -- identities:id
+~~~

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "erdf"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/erdf

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "pathname"
+bin_file = Pathname.new(__FILE__).realpath
+$:.unshift File.expand_path("../../lib", bin_file)
+
+require "erdf/cli"
+Erdf::CLI.start(*ARGV)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/erdf.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'erdf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "erdf"
+  spec.version       = Erdf::VERSION
+  spec.authors       = ["David Strauß", "Kishorekumar Neelamegam"]
+  spec.email         = ["david@strauss.io", "nkishore@megam.io"]
+
+  spec.summary       = %q{Entity-Relationship-Diagramm-Erzeuger}
+  spec.description   = %q{Generate good looking Entity-Relationship-Diagrams from text files or a PostgreSQL database.}
+  spec.homepage      = "https://github.com/megamsys/erde"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = "erdf"
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "minitest", "~> 5.10"
+
+  spec.add_dependency "sequel", "~> 4.0"
+end

data/lib/erdf.rb

@@ -0,0 +1,5 @@
+require "erdf/version"
+
+module Erdf
+  # Your code goes here...
+end

data/lib/erdf/cli.rb

@@ -0,0 +1,143 @@
+require "erdf"
+require "pathname"
+require "open3"
+require "sequel"
+require "erb"
+
+class Erdf::CLI
+  def self.start(*args)
+
+    if ARGV.empty?
+      puts 'Error: Args missing'
+      puts ' > Help'
+      puts ' > ----'
+      puts '   erdf file <filename> <output_file.png>'
+      puts '   erdf database erde database postgres://postgres:postgres@localhost/rioosdb?search_path=shard_0,public ./schema.png <output_file.png>'
+    exit
+    end
+
+    command = args.shift.strip
+
+    case command
+    when "version"
+      puts 'erdf 0.6.1'
+      exit
+    when "file"
+      file = Pathname(args.shift.strip)
+      input = file.read
+      text_transformer = Erdf::TextTransformer.new(input)
+      hash_schema = text_transformer.to_hash
+    when "database"
+      url = args.shift.strip
+      database_transformer = Erdf::DatabaseTransformer.new(url)
+      hash_schema = database_transformer.to_hash
+    else
+      printf('Error: "%s"  - command not found', command)
+      puts ''
+      puts ' > Help'
+      puts ' > ----'
+      puts '   erdf file <filename> <output_file.png>'
+      puts '   erdf database erde database postgres://postgres:postgres@localhost/rioosdb?search_path=shard_0,public ./schema.png <output_file.png>'
+      exit
+    end
+
+    hash_transformer = Erdf::HashTransformer.new(hash_schema)
+    dot_schema = hash_transformer.to_dot
+
+    output_file = args.shift.strip
+
+    layouted_graph, dot_log = Open3.capture3("dot -Tpng -o #{output_file}", stdin_data: dot_schema)
+  end
+end
+
+class Erdf::HashTransformer
+  def initialize(hash)
+    @hash = hash
+  end
+
+  def to_dot
+    template = File.read(File.expand_path("../template.dot.erb", __FILE__))
+
+    schema_string = ""
+    schema_string << "digraph tables {"
+    schema_string << "node [shape=plaintext rankdir=LR];"
+
+    @hash.each_pair do |table_name, table_schema|
+      renderer = ERB.new(template)
+      schema_string << renderer.result(binding)
+
+      table_schema['relations'].each_pair do |column, target|
+        schema_string << "#{table_name}:#{column} -> #{target['table']}:#{target['column']};"
+      end
+    end
+
+    schema_string << "}"
+
+    schema_string
+  end
+end
+
+class Erdf::DatabaseTransformer
+  def initialize(url)
+    @url = url
+  end
+
+  def to_hash
+    generated_hash = {}
+
+    Sequel.connect(@url) do |db|
+      db.tables.each do |table|
+        generated_hash[table] = {}
+        generated_hash[table]['columns'] = []
+        generated_hash[table]['relations'] = {}
+
+        generated_hash[table]['columns'] = db.schema(table).map(&:first)
+
+        db.foreign_key_list(table).each do |foreign_key|
+          generated_hash[table]['relations'][foreign_key[:columns].first] = {
+            'table' => foreign_key[:table],
+            'column' => foreign_key[:key].first
+          }
+        end
+      end
+    end
+
+    generated_hash
+  end
+end
+
+class Erdf::TextTransformer
+  def initialize(text)
+    @lines = text.lines
+  end
+
+  def to_hash
+    generated_hash = {}
+    current_table = nil
+
+    @lines.each do |line|
+      cleaned_line = line.strip
+
+      if current_table && cleaned_line.length > 0
+        generated_hash[current_table]['columns'] << cleaned_line
+      end
+
+      if cleaned_line.length == 0
+        current_table = nil
+      end
+
+      if match = cleaned_line.match(/^\[(\w+)\]/)
+        current_table = match[1]
+        generated_hash[current_table] = {}
+        generated_hash[current_table]['columns'] = []
+        generated_hash[current_table]['relations'] = {}
+      end
+
+      if match = cleaned_line.match(/^(\w+):(\w+) -- (\w+):(\w+)/)
+        generated_hash[match[1]]['relations'][match[2]] = { 'table' => match[3], 'column' => match[4] }
+      end
+    end
+
+    generated_hash
+  end
+end

data/lib/erdf/template.dot.erb

@@ -0,0 +1,18 @@
+<%= table_name %> [label=<
+  <TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0" CELLPADDING="4">
+    <TR>
+      <TD BGCOLOR="steelblue"><%= table_name %></TD>
+    </TR>
+    <TR>
+      <TD>
+        <TABLE  BORDER="0" CELLBORDER="0" CELLSPACING="0" CELLPADDING="4">
+        <% for @column in table_schema['columns'] %>
+          <TR BGCOLOR="goldenrod" BORDER="1">
+            <TD PORT="<%= @column %>"><%= @column %></TD>
+          </TR>
+        <% end %>
+        </TABLE>
+      </TD>
+    </TR>
+  </TABLE>
+>];

data/lib/erdf/version.rb

@@ -0,0 +1,3 @@
+module Erdf
+  VERSION = "0.6.0"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: erdf
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+platform: ruby
+authors:
+- David Strauß
+- Kishorekumar Neelamegam
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Generate good looking Entity-Relationship-Diagrams from text files or
+  a PostgreSQL database.
+email:
+- david@strauss.io
+- nkishore@megam.io
+executables:
+- erdf
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/erdf
+- bin/setup
+- erdf.gemspec
+- lib/erdf.rb
+- lib/erdf/cli.rb
+- lib/erdf/template.dot.erb
+- lib/erdf/version.rb
+homepage: https://github.com/megamsys/erde
+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.12
+signing_key: 
+specification_version: 4
+summary: Entity-Relationship-Diagramm-Erzeuger
+test_files: []