dba 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff91c96a26c84120b2294eaceafbc9cd97d50ae7b8138ed08657efe355fe905b
-  data.tar.gz: 1e25615aea3aab8f5820f790d038363ea2854488e950d3925e48953d1055006c
+  metadata.gz: da758f6bcc3df6dac6998bebc89cbe8d9de6e50a318bb1a0b471336df4a219e3
+  data.tar.gz: 0a20d9f33e0930b9dde939ac3edea265e74a95a92a5c9dbdaa68165c963158f8
 SHA512:
-  metadata.gz: b77b8fe626319fe20ac77cb31bb5bd2ed349438ea76ef6472b7367e22a804d1027a99744bde3ad2e32e7104f88a52b125a49f32c40223095281f648f150c8f64
-  data.tar.gz: 21d2f2a661aacc27375c7e9031c1057471ca627f0fb1bcb2c47dc051096e9d15d507d186854bb2fbac2b9851ba63ef2c807d7f91814ecd9490c564c6e073bdf1
+  metadata.gz: c8b210d99644562b7d1df35058e04c3e79542058ce4d46d5eddf5575b5164c8d533c8507fd33ff2e58b1ecfad15d935f471144b047924d26cf26464ea41e01cf
+  data.tar.gz: d95737e82ce807531b6263bdb0219937ac942ed1d886bea6f1c13e12d9679dd14de12dbb675add906280f96ae5bb455e0f8e92eaf76b902dfd2f495a30ea48a0

data/CHANGES.md

@@ -1,3 +1,10 @@
+# 2.3.0
+
+* Added diagram command for generating diagrams with Graphviz, DBML, or PlantUML
+
+* Usage is now printed to STDOUT instead of STDERR
+
+
 # 2.2.0
 
 * Fixed compatibility with psych 4+

data/dba.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'dba'
-  s.version = '2.2.0'
+  s.version = '2.3.0'
   s.license = 'GPL-3.0'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']

data/lib/dba/dbml_printer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class DBA::DBMLPrinter < DBA::DiagramPrinter
+  def print_table_start(name)
+    @io.puts "Table #{name} {"
+  end
+
+  def print_table_end(name)
+    @io.puts '}'
+  end
+
+  def print_column(name, type)
+    @io.puts "  #{name} #{type}"
+  end
+
+  def print_foreign_key(table, column, other_table, other_column)
+    @io.puts %{Ref: #{table}.#{column} > #{other_table}.#{other_column}}
+  end
+end

data/lib/dba/diagram.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class DBA::Diagram < DBA::Command
+  PRINTERS = {
+    '.dbml' => :DBMLPrinter,
+    '.dot' => :DOTPrinter,
+    '.gv' => :DOTPrinter,
+    '.pu' => :PlantUMLPrinter,
+    '.puml' => :PlantUMLPrinter,
+  }
+
+  def call(path = nil)
+    if path.nil?
+      printer = DBA::DOTPrinter.new
+      printer.print_diagram(database)
+    else
+      extension = File.extname(path)
+
+      printer = PRINTERS.fetch(extension) { raise DBA::Error, 'unsupported file extension' }
+      printer = DBA.const_get(printer)
+
+      File.open(path, 'w+') do |file|
+        printer = printer.new(file)
+        printer.print_diagram(database)
+      end
+    end
+  end
+end

data/lib/dba/diagram_printer.rb

@@ -0,0 +1,67 @@
+class DBA::DiagramPrinter
+  def initialize(io = STDOUT)
+    @io = io
+  end
+
+  def print_diagram(database)
+    print_start
+
+    @primary_keys = {}
+
+    table_names = database.tables
+
+    table_names.each do |name|
+      schema_hash = database.schema(name)
+
+      print_table(name, schema_hash)
+    end
+
+    table_names.each do |table|
+      database.foreign_key_list(table).each do |hash|
+        column = hash.fetch(:columns).first
+
+        other_table = hash.fetch(:table)
+
+        other_column = @primary_keys.fetch(other_table)
+
+        print_foreign_key(table, column, other_table, other_column)
+      end
+    end
+
+    print_end
+  end
+
+  def print_start
+  end
+
+  def print_end
+  end
+
+  def print_table(name, schema_hash)
+    print_table_start(name)
+
+    schema_hash.each do |column_name, info_hash|
+      column_type = info_hash[:type] || info_hash[:db_type]
+
+      if info_hash[:primary_key]
+        @primary_keys[name] = column_name
+      end
+
+      print_column(column_name, column_type)
+    end
+
+    print_table_end(name)
+  end
+
+  def print_table_start(name)
+  end
+
+  def print_table_end(name)
+  end
+
+  def print_column(name, type)
+  end
+
+  def print_foreign_key(table, column, other_table, other_column)
+  end
+end

data/lib/dba/dot_printer.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+class DBA::DOTPrinter < DBA::DiagramPrinter
+  def print_start
+    @io.puts 'digraph database {'
+    @io.puts '  graph[rankdir="LR",ranksep=1.5,nodesep=0.5];'
+    @io.puts '  node[shape="Mrecord",fontname="Helvetica,Arial,sans-serif"];'
+  end
+
+  def print_end
+    @io.puts '}'
+  end
+
+  def print_table(name, schema_hash)
+    label = [name]
+
+    schema_hash.each do |column_name, info_hash|
+      column_type = info_hash[:type] || info_hash[:db_type]
+
+      if info_hash[:primary_key]
+        @primary_keys[name] = column_name
+
+        label << "{<#{column_name}>#{column_name}|#{column_type}}"
+      else
+        label << "{#{column_name}|<#{column_name}>#{column_type}}"
+      end
+    end
+
+    label = label.join('|')
+
+    @io.puts %{  #{name}[label="#{label}"];}
+  end
+
+  def print_foreign_key(table, column, other_table, other_column)
+    @io.puts %{  #{table}:#{column} -> #{other_table}:#{other_column};}
+  end
+end

data/lib/dba/plant_uml_printer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class DBA::PlantUMLPrinter < DBA::DiagramPrinter
+  def print_start
+    @io.puts '@startuml'
+    @io.puts 'left to right direction'
+  end
+
+  def print_end
+    @io.puts '@enduml'
+  end
+
+  def print_table_start(name)
+    @io.puts "map #{name} {"
+  end
+
+  def print_table_end(name)
+    @io.puts '}'
+  end
+
+  def print_column(name, type)
+    @io.puts "  #{name} => #{type}"
+  end
+
+  def print_foreign_key(table, column, other_table, other_column)
+    @io.puts %{#{table}::#{column} *-> #{other_table}::#{other_column}}
+  end
+end

data/lib/dba/shell.rb

@@ -30,6 +30,7 @@ module DBA::Shell
 
   def commands
     {
+      'diagram' => :Diagram,
       'diff' => :Diff,
       'dump' => :Dump,
       'edit' => :Edit,
@@ -55,7 +56,7 @@ module DBA::Shell
   end
 
   def print_usage
-    printer = DBA::Printer.new(STDERR)
+    printer = DBA::Printer.new
     printer.print_usage(program_name, command_parameters)
 
     Kernel::exit(1)

data/lib/dba.rb

@@ -18,9 +18,12 @@ module DBA
   loader = Zeitwerk::Loader.new
   loader.tag = File.basename(__FILE__, '.rb')
   loader.inflector.inflect({
-    'dba' => 'DBA',
     'csv' => 'CSV',
+    'dba' => 'DBA',
+    'dbml_printer' => 'DBMLPrinter',
+    'dot_printer' => 'DOTPrinter',
     'ldjson' => 'LDJSON',
+    'plant_uml_printer' => 'PlantUMLPrinter',
     'yaml' => 'YAML'
   })
   loader.push_dir(__dir__)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dba
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Tim Craft
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-11 00:00:00.000000000 Z
+date: 2024-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -75,13 +75,18 @@ files:
 - lib/dba/command.rb
 - lib/dba/csv.rb
 - lib/dba/database.rb
+- lib/dba/dbml_printer.rb
+- lib/dba/diagram.rb
+- lib/dba/diagram_printer.rb
 - lib/dba/diff.rb
+- lib/dba/dot_printer.rb
 - lib/dba/dump.rb
 - lib/dba/edit.rb
 - lib/dba/find.rb
 - lib/dba/indexes.rb
 - lib/dba/ldjson.rb
 - lib/dba/load.rb
+- lib/dba/plant_uml_printer.rb
 - lib/dba/printer.rb
 - lib/dba/pull.rb
 - lib/dba/row_command.rb
@@ -114,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: See description