erde 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0f08552b8e901a15a813a002681a23439db87dd
-  data.tar.gz: f762128988f70ce8201f52067bd009b866183947
+  metadata.gz: ceaf6b839dab986b6926445fe3881ab0eb969549
+  data.tar.gz: 1b2b7ca815801782137c01d55ad4752fbb26a4da
 SHA512:
-  metadata.gz: 76c8a68e084673f3cd1b9212512da452026ec8a50ee3ead782bea423904706b6a0d2995fc25c5e4ef8ffd30d49256d499d0fe700a8db59deb5e92cd6dfbaa297
-  data.tar.gz: 632e7c19fcd74b2d03373e958be99b4cd7f37a0f8314413dbe493ebc720c41dc0b929828dee8895eed9ebf7f580ee7b38e0cf1c7ab944706010230bfa51b0043
+  metadata.gz: 648f7365ef3d165e51f5ad20f835aa6f8d2003e3a600077b10f72c4de45b14dc18531884abeb65c6133e451214ba997866c2152d7faabf6ca40ccfdb13785097
+  data.tar.gz: b6a5b10fb2191b9ceea5be765fbbbf751e15de56a7af315a137102feeca4683b159aa00cd20f12c47cecf3360116d8388482cfbc8e9b55943fe70bdbd8717d92

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.2.0
+- Support text schemas.
+- Output the diagram as PNG.

data/README.md

@@ -1,41 +1,25 @@
-# Erde
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/erde`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'erde'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install erde
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/erde.
-
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
+# 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).
+
+## Install
+Make sure you have [Graphviz](http://graphviz.org/) installed and available in your `$PATH`.  Install the gem with `gem install erde` or add it to your `Gemfile`.
+
+## CLI Usage
+~~~txt
+bin/erde file docs/schema.txt docs/schema.png
+~~~
+
+## Text Schema Format
+~~~txt
+[identities]
+id
+password
+email
+
+[players]
+id
+name
+identity_id
+
+players:identity_id -- identities:id
+~~~

data/bin/erde

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

data/erde.gemspec

@@ -15,8 +15,7 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables   = "erde"
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.12"

data/lib/erde/cli.rb

@@ -0,0 +1,83 @@
+require "erde"
+require "pathname"
+require "open3"
+
+class Erde::CLI
+  def self.start(*args)
+    command = args.shift.strip
+
+    if command == "file"
+      file = Pathname(args.shift.strip)
+      input = file.read
+      text_transformer = Erde::TextTransformer.new(input)
+      hash_schema = text_transformer.to_hash
+    end
+
+    hash_transformer = Erde::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 Erde::HashTransformer
+  def initialize(hash)
+    @hash = hash
+  end
+
+  def to_dot
+    schema_string = ""
+    schema_string << "digraph tables {"
+    schema_string << "node [shape=Mrecord rankdir=LR];"
+
+    @hash.each_pair do |table_name, table_schema|
+      schema_string << "#{table_name} [label=\"{#{table_name}|#{table_schema['columns'].map {|c| "<#{c}>#{c}" }.join("|")}}\"];"
+
+      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 Erde::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/erde/version.rb

@@ -1,3 +1,3 @@
 module Erde
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erde
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - David Strauß
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2016-06-13 00:00:00.000000000 Z
+date: 2016-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,20 +56,24 @@ description: Generate good looking Entity-Relationship-Diagrams from text files
   a PostgreSQL database.
 email:
 - david@strauss.io
-executables: []
+executables:
+- erde
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
+- bin/erde
 - bin/setup
 - erde.gemspec
 - lib/erde.rb
+- lib/erde/cli.rb
 - lib/erde/version.rb
 homepage: https://github.com/edgycircle/erde
 licenses: