pg-doc 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd9bd7f1381b0643750a98867020e11f3426633c
-  data.tar.gz: f538110c20fa04a792c2a537e1c00c3e9d716ea8
+  metadata.gz: 50222b07884abd889b86cc5cc645916e0c2f992a
+  data.tar.gz: b49449f6ff9e3ac829231db3e4c5290e35f209c0
 SHA512:
-  metadata.gz: 41212625fb051f99a0739257a7eeda564e5d55ebad0a6ec48e7a9bd3ce3cd6523a5ada50b55c726852edd7230d267ddcf4e9f086fdd258c4ba23154a95e661d0
-  data.tar.gz: 3e84f0ccd6e9f09f2490ac48c2fbe07ee217c85cf9439ba406cd4833aaf01179f1a0d29959e205f27ab52c9fe14a32c19a5e5cbabee88e930ce89e7e5058b1d4
+  metadata.gz: aa70ad7c57bcff40d6bd6d0080760e354bdf13e3a9171ba7b69ef2278c3719b3f21f89cf7d4dd4d24ecf396c6fd6f78327d3f65f97be5605950b3484ce21df45
+  data.tar.gz: 6775c5074e41bf81874bbf483bbab6bcc3e7f111485f79f26d0bfba45e56ae20170b4b69fd550ece99c88ea405be02a08fc1ca731ccb51590ff53f334d393ebc

data/.gitignore

@@ -5,5 +5,8 @@
 /doc/
 /pkg/
 /spec/reports/
+/test/reports/
 /tmp/
 *.gem
+Gemfile.lock
+gemfiles/*.lock

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+gemfile:
+  - gemfiles/pg_1.x.gemfile
+before_install:
+  - gem update --system
+  - gem update bundler
+services: postgresql

data/Appraisals

@@ -0,0 +1,3 @@
+appraise "pg-1.x" do
+	gem "pg", "~> 1.0"
+end

data/README.md

@@ -1,8 +1,10 @@
 # PG::Doc
 
-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/pg/doc`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/pg-doc.svg)](http://badge.fury.io/rb/pg-doc)
+[![Build Status](https://travis-ci.org/kenaniah/pg-doc.svg?branch=master)](http://travis-ci.org/kenaniah/pg-doc)
+[![Dependency Status](https://gemnasium.com/kenaniah/pg-doc.svg)](https://gemnasium.com/kenaniah/pg-doc)
 
-TODO: Delete this and the text above, and describe your gem
+**This gem is under initial development. 0.1.0 will be the first release.**
 
 ## Installation
 
@@ -20,15 +22,14 @@ Or install it yourself as:
 
     $ gem install pg-doc
 
-## Usage
+## To Do
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. 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).
+ - [ ] Document usage
+ - [ ] Document `mount PG::Doc::Web(url, options)`
+ - [ ] Document `:schema_filter` option
+ - [ ] Create and document caching to disk via marshal
+ - [ ] Create and document the markdown folder structure
+ - [ ] Write UI
 
 ## Contributing
 

data/Rakefile

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

data/bin/rackup

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rackup' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+load(bundle_binstub) if File.file?(bundle_binstub)
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rack", "rackup")

data/bin/rake

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+load(bundle_binstub) if File.file?(bundle_binstub)
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/config.ru

@@ -0,0 +1,5 @@
+require "bundler"
+Bundler.require
+
+require "pg/doc"
+run PG::Doc.new ENV['DATABASE_URL'], path_to_markdowns: ENV['PATH_TO_MARKDOWNS']

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/pg_1.x.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pg", "~> 1.0"
+
+gemspec path: "../"

data/lib/pg/doc.rb

@@ -1,7 +1,12 @@
+require "pg"
 require "pg/doc/version"
+require "pg/doc/engine"
+
+require "base64"
+require "mime-types"
+require "redcarpet"
 
 module PG
   module Doc
-    # Your code goes here...
   end
 end

data/lib/pg/doc/engine.rb

@@ -0,0 +1,281 @@
+require "sinatra/base"
+
+module PG
+  module Doc
+
+    # Returns an instantiated (and configured) rack app
+    def self.new connection, opts = {}
+      PG::Doc::Engine.new do |app|
+        app.setup connection, opts
+      end
+    end
+
+    class Engine < Sinatra::Base
+
+      set :public_folder, Proc.new { File.join(root, "../../../static") }
+      set :views, Proc.new { File.join(root, "../../../views") }
+
+      get '/' do
+        erb :index
+      end
+
+      get '/schemas/:schema(.:ext)?' do
+        object = @cache.dig :schemas, params["schema"]
+        pass unless object
+        erb :"objects/schema", locals: {object: object}
+      end
+
+      get '/schemas/:schema/:object_type/:name(.:ext)?' do
+        object = @cache.dig :schemas, params["schema"], params["object_type"].to_sym, params["name"]
+        pass unless object
+        erb :"objects/#{params["object_type"].sub(/s$/, "")}", locals: {object: object}
+      end
+
+      # Defines helpers
+      helpers do
+        def render_markdown file
+          erb :"includes/markdown", locals: {file: File.join(@path_to_markdowns, file)} if @path_to_markdowns
+        end
+      end
+
+      # Initializes the internal state for this instance
+      def setup connection, opts
+
+        @conn = PG.connect connection
+        @path_to_markdowns = opts.fetch(:path_to_markdowns, nil)
+        @schema_filter = opts.fetch(:schema_filter, nil) || ->(field) {
+          <<~SQL
+            #{field} NOT ILIKE 'pg_%'
+            AND #{field} != 'information_schema'
+          SQL
+        }
+
+        @cache = {schemas: {}}
+
+        # Load schemas
+        _recordset = @conn.exec <<~SQL
+          SELECT
+            schema_name
+          FROM
+            information_schema.schemata
+          WHERE
+            #{@schema_filter.call :schema_name}
+          ORDER BY
+            1
+        SQL
+        _recordset.each_with_object(@cache){ |row, h|
+          h[:schemas][row["schema_name"]] = {
+            tables: {},
+            views: {},
+            functions: {}
+          }
+        }
+
+        # Load tables
+        _recordset = @conn.exec <<~SQL
+          SELECT
+            table_schema,
+            table_name,
+            obj_description((table_schema || '.' || table_name)::regclass::oid, 'pg_class') as comment
+          FROM
+            information_schema.tables
+          WHERE
+            #{@schema_filter.call :table_schema}
+          ORDER BY
+            1, 2
+        SQL
+        _recordset.each_with_object(@cache){ |row, h|
+          h[:schemas][row["table_schema"]][:tables][row["table_name"]] = {
+            columns: [],
+            foreign_keys: {},
+            indexes: {},
+            comment: row["comment"]
+          }
+        }
+
+        # Load views
+        _recordset = @conn.exec <<~SQL
+          SELECT
+            table_schema,
+            table_name,
+            view_definition,
+            obj_description((table_schema || '.' || table_name)::regclass::oid, 'pg_class') as comment
+          FROM
+            information_schema.views
+          WHERE
+            #{@schema_filter.call :table_schema}
+          ORDER BY
+            1, 2
+        SQL
+        _recordset.each_with_object(@cache){ |row, h|
+          h[:schemas][row["table_schema"]][:views][row["table_name"]] = {
+            view_definition: row["view_definition"],
+            columns: [],
+            comment: row["comment"]
+          }
+        }
+
+        # Load columns
+        _recordset = @conn.exec <<~SQL
+          SELECT
+            c.table_schema,
+            c.table_name,
+            c.column_name,
+            c.ordinal_position,
+            c.data_type,
+            c.is_nullable,
+            c.column_default,
+            col_description((c.table_schema || '.' || c.table_name)::regclass::oid, c.ordinal_position) as comment,
+            t.table_type
+          FROM
+            information_schema.columns c
+            JOIN information_schema.tables t USING (table_catalog, table_schema, table_name)
+          WHERE
+            #{@schema_filter.call :table_schema}
+          ORDER BY
+            1, 2, 4
+        SQL
+        _recordset.each_with_object(@cache){ |row, h|
+          type = row.delete("table_type") == "VIEW" ? :views : :tables
+          schema = row.delete "table_schema"
+          name = row.delete "table_name"
+          h[:schemas][schema][type][name][:columns] << row
+        }
+
+        # Load functions (note: this currently does not support overloaded functions)
+        _recordset = @conn.exec <<~SQL
+          SELECT
+            routine_schema,
+            routine_name,
+            routine_definition,
+            external_language,
+            pg_get_function_identity_arguments((routine_schema || '.' || routine_name)::regproc) as arguments,
+            obj_description((routine_schema || '.' || routine_name)::regproc::oid, 'pg_proc') as comment
+          FROM
+            information_schema.routines
+          WHERE
+            #{@schema_filter.call :routine_schema}
+            AND external_name IS NULL
+          ORDER BY
+            1, 2
+        SQL
+        _recordset.each_with_object(@cache){ |row, h|
+          h[:schemas][row["routine_schema"]][:functions][row["routine_name"]] = {
+            external_language: row["external_language"],
+            comment: row["comment"],
+            arguments: row["arguments"].split(",").map{ |arg| parse_function_argument arg }
+          }
+        }
+
+        # Load foreign keys
+        _recordset = @conn.exec <<~SQL
+          SELECT
+            tc.table_schema,
+            tc.table_name,
+            tc.constraint_name,
+            tc.constraint_type,
+            kcu.column_name,
+            tc.is_deferrable,
+            tc.initially_deferred,
+            rc.match_option AS match_type,
+
+            rc.update_rule AS on_update,
+            rc.delete_rule AS on_delete,
+            ccu.table_schema AS references_schema,
+            ccu.table_name AS references_table,
+            ccu.column_name AS references_field
+
+          FROM
+            information_schema.table_constraints tc
+
+          LEFT JOIN information_schema.key_column_usage kcu
+            ON tc.constraint_catalog = kcu.constraint_catalog
+            AND tc.constraint_schema = kcu.constraint_schema
+            AND tc.constraint_name = kcu.constraint_name
+
+          LEFT JOIN information_schema.referential_constraints rc
+            ON tc.constraint_catalog = rc.constraint_catalog
+            AND tc.constraint_schema = rc.constraint_schema
+            AND tc.constraint_name = rc.constraint_name
+
+          LEFT JOIN information_schema.constraint_column_usage ccu
+            ON rc.unique_constraint_catalog = ccu.constraint_catalog
+            AND rc.unique_constraint_schema = ccu.constraint_schema
+            AND rc.unique_constraint_name = ccu.constraint_name
+
+          WHERE
+            tc.constraint_type = 'FOREIGN KEY'
+          ORDER BY
+            1, 2
+        SQL
+        _recordset.each_with_object(@cache){ |row, h|
+          h[:schemas][row["table_schema"]][:tables][row["table_name"]][:foreign_keys][row["column_name"]] = row
+        }
+
+        # Load indexes
+        _recordset = @conn.exec <<~SQL
+          SELECT
+            ns.nspname AS table_schema,
+            t.relname AS table_name,
+            U.usename AS user_name,
+            i.relname AS index_name,
+            idx.indisunique AS is_unique,
+            idx.indisprimary AS is_primary,
+            am.amname AS index_type,
+            idx.indkey,
+            ARRAY(
+              SELECT pg_get_indexdef(idx.indexrelid, k + 1, TRUE)
+              FROM generate_subscripts(idx.indkey, 1) AS k
+              ORDER BY k
+            ) AS index_keys,
+            (idx.indexprs IS NOT NULL) OR (idx.indkey::int[] @> array[0]) AS is_functional,
+            idx.indpred IS NOT NULL AS is_partial
+          FROM
+            pg_index AS idx
+            JOIN pg_class AS i ON i.oid = idx.indexrelid
+            JOIN pg_class AS t ON t.oid = idx.indrelid
+            JOIN pg_am AS am ON i.relam = am.oid
+            JOIN pg_namespace AS ns ON i.relnamespace = ns.oid
+            JOIN pg_user AS U ON i.relowner = U.usesysid
+          WHERE
+            #{@schema_filter.call :"ns.nspname"}
+          ORDER BY
+            1, 2, idx.indisprimary DESC, i.relname
+        SQL
+        _recordset.each_with_object(@cache){ |row, h|
+          h[:schemas][row["table_schema"]][:tables][row["table_name"]][:indexes][row["index_name"]] = row
+        }
+
+      end
+
+      def parse_function_argument arg
+
+        # Determine the argument's mode
+        arg = arg.strip
+        argmode = case arg
+        when /^VARIADIC\b/, /^OUT\b/, /^INOUT\b/, /^IN\b/
+          _parts = arg.split(" ")
+          _mode = _parts.shift
+          arg = _parts.join(" ")
+          _mode
+        else
+          "IN"
+        end
+
+        # Determine it's name and type
+        if arg.count(" ") > 0
+          name, *type = arg.split " "
+          type = type.join " "
+        else
+          name = nil
+          type = arg
+        end
+
+        {name: name, type: type, mode: argmode}
+
+      end
+
+    end
+
+  end
+end

data/lib/pg/doc/version.rb

@@ -1,5 +1,5 @@
 module PG
   module Doc
-    VERSION = "0.0.0"
+    VERSION = "0.0.1"
   end
 end

data/pg-doc.gemspec

@@ -2,22 +2,32 @@ lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "pg/doc/version"
 
-Gem::Specification.new do |spec|
-  spec.name          = "pg-doc"
-  spec.version       = PG::Doc::VERSION
-  spec.authors       = ["Kenaniah Cerny"]
-  spec.email         = ["kenaniah@gmail.com"]
+Gem::Specification.new do |gem|
+  gem.name          = "pg-doc"
+  gem.version       = PG::Doc::VERSION
+  gem.authors       = ["Kenaniah Cerny"]
+  gem.email         = ["kenaniah@gmail.com"]
+  gem.license       = "MIT"
+  gem.required_ruby_version = '~> 2.3'
 
-  spec.summary       = "Automatic documentation for your PostgreSQL database"
-  spec.homepage      = "https://github.com/kenaniah/pg-doc"
+  gem.summary       = "Automatic documentation for your PostgreSQL database"
+  gem.homepage      = "https://github.com/kenaniah/pg-doc"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  gem.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  gem.bindir        = "exe"
+  gem.executables   = gem.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  gem.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  gem.add_development_dependency "bundler", "~> 1.16"
+  gem.add_development_dependency "rake", "~> 10.0"
+  gem.add_development_dependency "appraisal"
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "pry"
+
+  gem.add_dependency "pg", "~> 1.0"
+  gem.add_dependency "sinatra", "~> 2.0"
+  gem.add_dependency "redcarpet", "~> 3.4"
+  gem.add_dependency "mime-types", "~> 3.0"
 end

data/static/pg-doc.js

@@ -0,0 +1,9 @@
+$(document).ready(() =>
+
+	// Toggles submenues in navigation
+	$(document).on("click", ".js-submenu", (event) => {
+		$(event.currentTarget).find("I.caret").transition('toggle')
+		$(event.currentTarget).next("DIV.menu").transition('toggle')
+	})
+
+);

data/static/style.css

@@ -0,0 +1,51 @@
+BODY {
+	background-color: #FFFFFF;
+}
+CODE {
+	font-size: 90%;
+	color: rgb(199, 37, 78);
+	background-color: rgb(249, 242, 244);
+	padding: 2px 4px;
+	border-radius: 4px;
+}
+CODE:empty {
+	display: none;
+}
+.ui.text.main.container {
+	max-width: calc(100% - 14em) !important;
+	width: auto !important;
+	margin-top: 7em;
+}
+.scroll-padding {
+	padding-bottom: 20vh;
+}
+.menu .subheader {
+	color: white;
+	margin: 1em 1em 0.2em 1em;
+	padding-bottom: 0.3em;
+	border-bottom: 1px solid rgba(255, 255, 255, 0.1);
+}
+.ui.visible.left.sidebar~.pusher {
+	width: calc(100% - 260px);
+}
+.ui.main H1,
+.ui.main H2,
+.ui.main H3,
+.ui.main H4,
+.ui.main H5,
+.ui.main H6 {
+	margin-top: 32px;
+	margin-bottom: 16px;
+	padding-bottom: 2px;
+	border-bottom: 1px solid rgb(234, 236, 239);
+}
+.ui.table TD {
+	overflow: scroll !important;
+	text-overflow: unset !important;
+	white-space: nowrap;
+}
+
+.ui.table TD::-webkit-scrollbar {
+	width: 0;
+	height: 0;
+}

data/views/includes/left_menu.erb

@@ -0,0 +1,47 @@
+<div class="ui left vertical inverted visible sidebar menu">
+
+	<a class="item" href="<%= url '/' %>">
+		<span><i class="home icon"></i> Home</span>
+	</a>
+
+	<% @cache[:schemas].each do |schema, data| %>
+
+		<div class="js-submenu link item">
+			<span><i class="database icon"></i> <%= schema %></span>
+			<i class="caret right icon"></i>
+			<i class="caret down icon transition hidden"></i>
+		</div>
+
+		<div class="menu transition hidden">
+
+			<div class="subheader">Schema</div>
+			<a class="item" href="<%= url "/schemas/#{schema}" %>"><span><i class="database icon"></i> <%= schema %></span></a>
+
+			<% unless data[:tables].empty? %>
+				<div class="subheader">Tables</div>
+				<% data[:tables].each do |table_name, table| %>
+					<a class="item" href="<%= url "/schemas/#{schema}/tables/#{table_name}" %>"><span><i class="table icon"></i> <%= table_name %></span></a>
+				<% end %>
+			<% end %>
+
+			<% unless data[:views].empty? %>
+				<div class="subheader">Views</div>
+				<% data[:views].each do |view_name, view| %>
+					<a class="item" href="<%= url "/schemas/#{schema}/views/#{view_name}" %>"><span><i class="table icon"></i> <%= view_name %></span></a>
+				<% end %>
+			<% end %>
+
+			<% unless data[:functions].empty? %>
+				<div class="subheader">Functions</div>
+				<% data[:functions].each do |routine_name, routine| %>
+					<a class="item" href="<%= url "/schemas/#{schema}/functions/#{routine_name}" %>"><span><i class="table icon"></i> <%= routine_name %></span></a>
+				<% end %>
+			<% end %>
+
+		</div>
+
+	<% end %>
+
+	<div class="scroll-padding"></div>
+
+</div>

data/views/includes/markdown.erb

@@ -0,0 +1,32 @@
+<%
+if File.exists? file
+	markdown = Redcarpet::Markdown.new Redcarpet::Render::HTML, tables: true, no_intra_emphasis: true
+	contents = markdown.render File.read(file)
+	contents = contents.gsub("<table>", "<table class='ui celled table'>")
+	contents = contents.gsub("<img ", "<img class='ui fluid image'")
+	contents = contents.gsub(/<img[^>]+src=(['"])([^'"]+)\1[^>]*>/i) { |match|
+
+		next $2 if $2.include? "//"
+
+		# Attempt to find the refrenced file
+		img = File.expand_path($2, File.dirname(file))
+		next $2 unless File.exists? img
+
+		# Only allow images through
+		mime_type = MIME::Types.type_for(File.extname img).first.to_s
+		next $2 unless mime_type.start_with? "image/"
+
+		# Base64 encode & inline the image
+		match.sub $2, "data:#{mime_type};base64,#{Base64.encode64(File.read img)}"
+
+	}
+%>
+	<div class="rendered-markdown">
+		<%= contents %>
+	</div>
+<% else %>
+	<div class="ui warning message">
+		<div class="header">No markdown file found</div>
+		The file <code><%= file %></code> does not exist.
+	</div>
+<% end %>

data/views/index.erb

@@ -0,0 +1,16 @@
+<h1 class="ui header">
+	Database Documentation
+</h1>
+
+<p>
+	Welcome to <code>PG::Doc</code>!
+</p>
+
+<p>
+	This tool automatically generates documentation for PostgreSQL databases.
+</p>
+
+<p>
+	You can learn more about this tool at
+	<a href="https://github.com/kenaniah/pg-doc" target="_blank">https://github.com/kenaniah/pg-doc</a>.
+</p>

data/views/layout.erb

@@ -0,0 +1,32 @@
+<!DOCTYPE html>
+<html>
+<head>
+	<!-- Standard Meta -->
+	<meta charset="utf-8" />
+	<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+	<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0">
+
+	<!-- Site Properties -->
+	<title>Database Documentation</title>
+
+	<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/semantic-ui/2.2.13/semantic.min.css">
+	<link rel="stylesheet" type="text/css" href="<%= url '/style.css' %>">
+
+	<script src="https://code.jquery.com/jquery-3.2.1.slim.min.js"></script>
+	<script src="https://cdnjs.cloudflare.com/ajax/libs/semantic-ui/2.2.13/semantic.min.js"></script>
+	<script src="<%= url '/pg-doc.js' %>"></script>
+
+</head>
+<body class="pushable">
+
+	<%= erb :'includes/left_menu' %>
+
+	<div class="pusher">
+		<div class="ui main container text scroll-padding">
+			<%= yield %>
+		</div>
+	</div>
+
+</body>
+
+</html>

data/views/objects/function.erb

@@ -0,0 +1 @@
+<%= object %>

data/views/objects/schema.erb

@@ -0,0 +1,5 @@
+<h1>
+	Schema - <code><%= params["schema"] %></code>
+</h1>
+
+<%= render_markdown "schema/#{params["schema"]}/README.md" %>

data/views/objects/table.erb

@@ -0,0 +1,94 @@
+<%
+def fk_action_color action
+	case action
+	when 'CASCADE'
+		'negative'
+	when 'SET NULL'
+		'warning'
+	end
+end
+%>
+
+<h1>
+	Table - <code><%= params["schema"] %>.<%= params["name"] %></code>
+</h1>
+
+<% if object[:comment] %>
+	<h2>Database Comment</h2>
+	<p><%= object[:comment] %></p>
+<% end %>
+
+<%= render_markdown "schema/#{params["schema"]}/#{params["name"]}.md" %>
+
+<h2>Columns</h2>
+
+<table class="ui compact fixed celled table">
+	<thead>
+		<th>Column Name</th>
+		<th>Data Type</th>
+		<th class="three wide">Required Field?</th>
+		<th>Default Value</th>
+	</thead>
+	<tbody>
+		<% object[:columns].each do |row| %>
+		<tr>
+			<td>
+				<% if fk = object[:foreign_keys].fetch(row["column_name"], nil) %>
+					<i class="icon book"></i>
+					<a href="<%= url "/schemas/#{fk["references_schema"]}/tables/#{fk["references_table"]}" %>" title="<%= fk["references_schema"] %>.<%= fk["references_table"] %>"><%= row["column_name"] %></a>
+				<% else %>
+					<%= row["column_name"] %>
+				<% end %>
+			</td>
+			<td><%= row["data_type"] %></td>
+			<td class="<%= row["is_nullable"] == 'NO' && row["column_default"].to_s.empty? ? 'warning' : '' %>"><%= row["is_nullable"] == 'NO' ? '<i class="icon check"></i>' : ''%></td>
+			<td><code><%= row["column_default"] %></code></td>
+		</tr>
+		<% end %>
+	</tbody>
+</table>
+
+
+<% unless object[:foreign_keys].empty? %>
+	<h2>Foreign Keys</h2>
+	<table class="ui compact fixed celled table">
+		<thead>
+			<th>Column Name</th>
+			<th>References</th>
+			<th class="three wide">On Delete</th>
+			<th>Constraint Name</th>
+		</thead>
+		<tbody>
+			<% object[:foreign_keys].each do |column_name, row| %>
+			<tr>
+				<td><%= row["column_name"] %></td>
+				<td><i class="icon book"></i> <a href="<%= url "/schemas/#{row["references_schema"]}/tables/#{row["references_table"]}" %>" title="<%= row["references_schema"] %>.<%= row["references_table"] %>"><%= "#{row["references_schema"]}.#{row["references_table"]}" %></a></td>
+				<td class="<%= fk_action_color row["on_delete"] %>"><%= row["on_delete"] %></td>
+				<td><%= row["constraint_name"] %></td>
+			</tr>
+			<% end %>
+		</tbody>
+	</table>
+<% end %>
+
+<h2>Indexes</h2>
+<table class="ui compact fixed celled table">
+	<thead>
+		<th>Index Name</th>
+		<th class="two wide">Primary?</th>
+		<th class="two wide">Unique?</th>
+		<th class="two wide">Type</th>
+		<th>Columns</th>
+	</thead>
+	<tbody>
+		<% object[:indexes].each do |index_name, row| %>
+		<tr>
+			<td><%= row["index_name"] %></td>
+			<td><% if row["is_primary"] == "t" %><i class="icon check"></i><% end %></td>
+			<td><% if row["is_unique"] == "t" %><i class="icon check"></i><% end %></td>
+			<td><%= row["index_type"] %></td>
+			<td><%= row["index_keys"][1..-2].split(",").join ", " %></td>
+		</tr>
+		<% end %>
+	</tbody>
+</table>

data/views/objects/view.erb

@@ -0,0 +1 @@
+<h2>Coming Soon!</h2>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg-doc
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Kenaniah Cerny
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-12 00:00:00.000000000 Z
+date: 2018-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,104 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: 
 email:
 - kenaniah@gmail.com
@@ -46,16 +144,35 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
+- Appraisals
 - Gemfile
 - README.md
 - Rakefile
 - bin/console
+- bin/rackup
+- bin/rake
 - bin/setup
+- config.ru
+- gemfiles/.bundle/config
+- gemfiles/pg_1.x.gemfile
 - lib/pg/doc.rb
+- lib/pg/doc/engine.rb
 - lib/pg/doc/version.rb
 - pg-doc.gemspec
+- static/pg-doc.js
+- static/style.css
+- views/includes/left_menu.erb
+- views/includes/markdown.erb
+- views/index.erb
+- views/layout.erb
+- views/objects/function.erb
+- views/objects/schema.erb
+- views/objects/table.erb
+- views/objects/view.erb
 homepage: https://github.com/kenaniah/pg-doc
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -63,9 +180,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="