peekdb 0.2.0

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+pkg
+doc
+*.gem
+*.dot
+*.pdf

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create ruby-1.9.2-p290@peekdb

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gem 'pg'
+gem 'ruby-graphviz'
+gem 'rspec'
+gem 'shoulda'

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    pg (0.13.2)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+    ruby-graphviz (1.0.5)
+    shoulda (3.0.1)
+      shoulda-context (~> 1.0.0)
+      shoulda-matchers (~> 1.0.0)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pg
+  rspec
+  ruby-graphviz
+  shoulda

data/README.md

@@ -0,0 +1,23 @@
+# PeekDB - Database Quick View
+
+A command line utility that builds a simple force-directed ER diagram for a database. The output can be .png or .dot formats saved in the current directory. Dot files are great for reuse within Omnigraffle.
+
+
+Installation
+-------
+    gem install peek
+
+Usage
+-------
+    peekdb -n [database-name] -t [psql | mysql | sqlite ] -f [png | dot]
+
+Todo
+-------
+* Add support for SQLite and MySQL
+* Add support for extraction of views
+* Add support for extraction of column names
+
+License
+-------
+
+MIT License. Copyright 2012 Ennova.

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/bin/peekdb

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+require_relative '../lib/peekdb'
+
+begin
+  PeekDB.new(ARGV).run
+rescue
+  exit(1)
+else
+  exit(0)
+end

data/lib/peekdb/database.rb

@@ -0,0 +1,36 @@
+class Database
+
+  attr_reader :name, :connection, :tables, :relations
+
+  def initialize(name)
+    @name = name
+
+    begin
+      open_connection(@name)
+      puts "... Inspecting database #{@name}"
+
+      find_tables
+      puts "... Found #{@tables.size} tables"
+
+      find_relations
+      puts "... Found #{@relations.size} relations"
+    rescue Exception => e
+      puts "... Error #{e}"
+      exit(1)
+    end
+  end
+
+  private
+
+  def open_connection(database_name)
+    raise NotImplementedError
+  end
+
+  def find_tables
+    raise NotImplementedError
+  end
+
+  def find_relations
+    raise NotImplementedError
+  end
+end

data/lib/peekdb/database_mysql.rb

@@ -0,0 +1,2 @@
+class DatabaseMySQL < Database
+end

data/lib/peekdb/database_psql.rb

@@ -0,0 +1,57 @@
+class DatabasePSQL < Database
+
+  attr_reader :name, :connection, :tables, :relations
+
+  private
+
+  def open_connection(database_name)
+    @connection = PGconn.open(:dbname => @name)
+  end
+
+  # Reference from PostgreSQL:
+  # \d information_schema.tables
+  # Column                       |               Type                | Modifiers
+  # -----------------------------+-----------------------------------+-----------
+  # table_catalog                | information_schema.sql_identifier |
+  # table_schema                 | information_schema.sql_identifier |
+  # table_name                   | information_schema.sql_identifier |
+  # table_type                   | information_schema.character_data |
+  # self_referencing_column_name | information_schema.sql_identifier |
+  # reference_generation         | information_schema.character_data |
+  # user_defined_type_catalog    | information_schema.sql_identifier |
+  # user_defined_type_schema     | information_schema.sql_identifier |
+  # user_defined_type_name       | information_schema.sql_identifier |
+  # is_insertable_into           | information_schema.yes_or_no      |
+  # is_typed                     | information_schema.yes_or_no      |
+  # commit_action                | information_schema.character_data |
+  def find_tables
+    sql = <<-eos
+    SELECT table_name
+    FROM information_schema.tables
+    WHERE table_type = 'BASE TABLE'
+    AND table_schema = 'public'
+    eos
+    @tables = @connection.exec(sql).values.flatten
+  end
+
+  # Reference from PostgreSQL:
+  # [0] constraint_name
+  # [1] table_name
+  # [2] column_name
+  # [3] foreign_table_name
+  # [4] foreign_column_name
+  def find_relations
+    sql = <<-eos
+    SELECT
+    tc.constraint_name, tc.table_name, kcu.column_name,
+    ccu.table_name AS foreign_table_name,
+    ccu.column_name AS foreign_column_name
+    FROM
+    information_schema.table_constraints AS tc
+    JOIN information_schema.key_column_usage AS kcu ON tc.constraint_name = kcu.constraint_name
+    JOIN information_schema.constraint_column_usage AS ccu ON ccu.constraint_name = tc.constraint_name
+    WHERE constraint_type = 'FOREIGN KEY'
+    eos
+    @relations = @connection.exec(sql).values
+  end
+end

data/lib/peekdb/database_sqlite.rb

@@ -0,0 +1,2 @@
+class DatabaseSQLite < Database
+end

data/lib/peekdb/graph.rb

@@ -0,0 +1,73 @@
+class Graph
+
+  attr_reader :dwg
+
+  def initialize
+    @dwg = GraphViz.new(:G, :type => :digraph)
+  end
+
+  def build(name, tables, relations)
+    config_graph(name)
+    config_nodes
+    config_edges
+
+    tables.each do |table|
+      @dwg.add_nodes(table)
+    end
+
+    relations.each do |relation|
+      @dwg.add_edges(relation[3], relation[1])
+    end
+  end
+
+  def output(name, format)
+    case format
+    when :pdf, nil
+      filename = "#{name}.pdf"
+      @dwg.output(:pdf => "#{filename}")
+      puts "... Writing output #{filename}"
+    when :dot
+      filename = "#{name}.dot"
+      @dwg.output(:dot => filename)
+      puts "... Writing output #{filename}"
+    else
+      raise ArgumentError.new("Unknown output format #{format}")
+      exit(1)
+    end
+  end
+
+  private
+
+  def config_graph(name)
+    title = name.split('_').each{|s| s.capitalize!}.join(' ')
+    date = Time.now
+    @dwg.graph[:labelloc]  = "t"
+    @dwg.graph[:label]     = "#{title} Database\nGenerated #{date}"
+    @dwg.graph[:fontname]  = "Helvetica"
+    @dwg.graph[:fontcolor] = "#666666"
+    @dwg.graph[:fontsize]  = "24"
+  end
+
+  def config_nodes
+    @dwg.node[:color]     = "#222222"
+    @dwg.node[:style]     = "filled"
+    @dwg.node[:shape]     = "box"
+    @dwg.node[:penwidth]  = "1"
+    @dwg.node[:fontname]  = "Helvetica"
+    @dwg.node[:fillcolor] = "#eeeeee"
+    @dwg.node[:fontcolor] = "#333333"
+    @dwg.node[:margin]    = "0.05"
+    @dwg.node[:fontsize]  = "12"
+  end
+
+  def config_edges
+    @dwg.edge[:color]      = "#666666"
+    @dwg.edge[:weight]     = "1"
+    @dwg.edge[:fontsize]   = "10"
+    @dwg.edge[:fontcolor]  = "#444444"
+    @dwg.edge[:fontname]   = "Helvetica"
+    @dwg.edge[:dir]        = "forward"
+    @dwg.edge[:arrowsize]  = "0.5"
+    @dwg.edge[:arrowhead]  = "crow"
+  end
+end

data/lib/peekdb.rb

@@ -0,0 +1,97 @@
+require 'pg'
+require 'graphviz'
+require 'optparse'
+require 'ostruct'
+require 'pry'
+
+require_relative 'peekdb/graph'
+require_relative 'peekdb/database'
+require_relative 'peekdb/database_psql'
+require_relative 'peekdb/database_mysql'
+require_relative 'peekdb/database_sqlite'
+
+class PeekDB
+
+  def initialize(argv)
+    puts "PeekDB:"
+    begin
+      parse_options(argv)
+    rescue Exception => e
+      puts "... Error FATAL: #{e}"
+      exit(1)
+    end
+  end
+
+  def parse_options(args)
+    @options = OpenStruct.new
+
+    opts = OptionParser.new do |opts|
+      opts.banner = "Usage: peekdb [options]"
+      opts.program_name = "PeekDB"
+      opts.separator ""
+      opts.separator "Specific options:"
+
+      opts.on("-n", "--name NAME", "Name of database - required") do |name|
+        @options.name = name
+      end
+
+      opts.on("-t", "--type [TYPE]", [:psql, :mysql, :sqlite], "Type of database (psql, mysql, sqlite) - required") do |type|
+        @options.type = type
+      end
+
+      opts.on("-f", "--format [FORMAT]", [:pdf, :dot], "Format of output file (pdf, dot) - default pdf") do |format|
+        @options.format = format
+      end
+    end
+    opts.parse!(args)
+  end
+
+  def run
+    if @options.name && @options.name
+      case @options.type
+      when :psql
+        db = DatabasePSQL.new @options.name
+      when :mysql
+        db = DatabaseMySQL.new @options.name
+      when :sqlite
+        db = DatabaseSQLite.new @options.name
+      else
+        puts "... Error FATAL: Unknown database type #{@options.type}"
+        exit(1)
+      end
+
+      graph = Graph.new
+      graph.build(db.name, db.tables, db.relations)
+      graph.output(db.name, @options.format)
+    else
+      puts '... Error FATAL: missing arguments'
+      exit(1)
+    end
+  end
+
+  def self.usage
+    puts <<-EOT
+    Usage: rails COMMAND [ARGS]
+
+    The most common rails commands are:
+    generate    Generate new code (short-cut alias: "g")
+    console     Start the Rails console (short-cut alias: "c")
+    server      Start the Rails server (short-cut alias: "s")
+    dbconsole   Start a console for the database specified in config/database.yml
+    (short-cut alias: "db")
+    new         Create a new Rails application. "rails new my_app" creates a
+    new application called MyApp in "./my_app"
+
+    In addition to those, there are:
+    application  Generate the Rails application code
+    destroy      Undo code generated with "generate" (short-cut alias: "d")
+    benchmarker  See how fast a piece of code runs
+    profiler     Get profile information from a piece of code
+    plugin new   Generates skeleton for developing a Rails plugin
+    runner       Run a piece of code in the application environment (short-cut alias: "r")
+
+    All commands can be run with -h (or --help) for more information.
+    EOT
+  end
+
+end

data/peekdb.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |gem|
+  gem.name        = "peekdb"
+  gem.version     = "0.2.0"
+  gem.platform    = Gem::Platform::RUBY
+  gem.authors     = ["Adrian Smith"]
+  gem.email       = ["adrian.smith@ennova.com.au"]
+  gem.homepage    = "https://github.com/AdrianSmith/peekdb"
+  gem.summary     = %q{PeekDB generates a quick view of the tables and relationships in a database}
+  gem.description = %q{PeekDB is a command line utility that builds a simple force-directed ER diagram for a database. The output can be .png or .dot formats.}
+  gem.license     = 'MIT'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  gem.add_dependency 'ruby-graphviz'
+  gem.add_dependency 'pg'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+end

data/spec/peekdb/graph_spec.rb

@@ -0,0 +1,18 @@
+require_relative '../spec_helper.rb'
+
+describe Graph do
+  before do
+    @tables = ['book', 'author', 'format']
+    @relations = [
+      ['author-book', 'author', 'id', 'book', 'id'],
+      ['book-format', 'book', 'id',  'format', 'id']
+    ]
+  end
+
+  it "should create a new graph using database table and relation data" do
+    graph = Graph.new
+    graph.build('test', @tables, @relations)
+    graph.dwg.should be_not_nil
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'peekdb'

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: peekdb
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Adrian Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-29 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-graphviz
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: pg
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: PeekDB is a command line utility that builds a simple force-directed ER diagram for a database. The output can be .png or .dot formats.
+email: 
+- adrian.smith@ennova.com.au
+executables: 
+- peekdb
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/peekdb
+- lib/peekdb.rb
+- lib/peekdb/database.rb
+- lib/peekdb/database_mysql.rb
+- lib/peekdb/database_psql.rb
+- lib/peekdb/database_sqlite.rb
+- lib/peekdb/graph.rb
+- peekdb.gemspec
+- spec/peekdb/graph_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/AdrianSmith/peekdb
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: PeekDB generates a quick view of the tables and relationships in a database
+test_files: 
+- spec/peekdb/graph_spec.rb
+- spec/spec_helper.rb