pg-doc 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50222b07884abd889b86cc5cc645916e0c2f992a
-  data.tar.gz: b49449f6ff9e3ac829231db3e4c5290e35f209c0
+  metadata.gz: edd4c08d6e5821b6faa98209653d65c20239881a
+  data.tar.gz: 8bcbf6a133bd04de380e7802c196ca65cf6b81d3
 SHA512:
-  metadata.gz: aa70ad7c57bcff40d6bd6d0080760e354bdf13e3a9171ba7b69ef2278c3719b3f21f89cf7d4dd4d24ecf396c6fd6f78327d3f65f97be5605950b3484ce21df45
-  data.tar.gz: 6775c5074e41bf81874bbf483bbab6bcc3e7f111485f79f26d0bfba45e56ae20170b4b69fd550ece99c88ea405be02a08fc1ca731ccb51590ff53f334d393ebc
+  metadata.gz: 6f5a640423d6e0f65b98f4fd375bb319f89781322a7a22656e6900725ba0076c22e54ee6174479d56ceef97bed7257bffbe74d195a3a2efcb5b0cbf7339cad63
+  data.tar.gz: 9c7f27cf75762c7c440fb4f64c9a6b4d2adad5231bdf143b516a55af37b0e65243d45e3a7b268d0f2d61d1105f7178935bc5d223570e0a0dcde63e720e3fd2ab

data/lib/pg/doc.rb

@@ -3,6 +3,7 @@ require "pg/doc/version"
 require "pg/doc/engine"
 
 require "base64"
+require "cgi"
 require "mime-types"
 require "redcarpet"
 

data/lib/pg/doc/engine.rb

@@ -67,7 +67,8 @@ module PG
           h[:schemas][row["schema_name"]] = {
             tables: {},
             views: {},
-            functions: {}
+            functions: {},
+            triggers: {}
           }
         }
 
@@ -81,6 +82,7 @@ module PG
             information_schema.tables
           WHERE
             #{@schema_filter.call :table_schema}
+            AND table_type != 'VIEW'
           ORDER BY
             1, 2
         SQL
@@ -150,6 +152,8 @@ module PG
             routine_definition,
             external_language,
             pg_get_function_identity_arguments((routine_schema || '.' || routine_name)::regproc) as arguments,
+            pg_get_functiondef((routine_schema || '.' || routine_name)::regproc) as function_definition,
+            pg_get_function_result((routine_schema || '.' || routine_name)::regproc) as function_result,
             obj_description((routine_schema || '.' || routine_name)::regproc::oid, 'pg_proc') as comment
           FROM
             information_schema.routines
@@ -160,10 +164,13 @@ module PG
             1, 2
         SQL
         _recordset.each_with_object(@cache){ |row, h|
-          h[:schemas][row["routine_schema"]][:functions][row["routine_name"]] = {
+          dest = row["function_result"] == "trigger" ? :triggers : :functions
+          h[:schemas][row["routine_schema"]][dest][row["routine_name"]] = {
             external_language: row["external_language"],
             comment: row["comment"],
-            arguments: row["arguments"].split(",").map{ |arg| parse_function_argument arg }
+            arguments: row["arguments"].split(",").map{ |arg| parse_function_argument arg },
+            function_definition: row["function_definition"],
+            function_result: row["function_result"]
           }
         }
 
@@ -271,7 +278,7 @@ module PG
           type = arg
         end
 
-        {name: name, type: type, mode: argmode}
+        {"name" => name, "type" => type, "mode" => argmode}
 
       end
 

data/lib/pg/doc/version.rb

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

data/static/pg-doc.js

@@ -1,4 +1,4 @@
-$(document).ready(() =>
+$(document).ready(() => {
 
 	// Toggles submenues in navigation
 	$(document).on("click", ".js-submenu", (event) => {
@@ -6,4 +6,9 @@ $(document).ready(() =>
 		$(event.currentTarget).next("DIV.menu").transition('toggle')
 	})
 
-);
+	// Handles code highlighting
+	$('PRE').each((i, block) => {
+		hljs.highlightBlock(block)
+	})
+
+});

data/views/includes/left_menu.erb

@@ -34,7 +34,14 @@
 			<% 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>
+					<a class="item" href="<%= url "/schemas/#{schema}/functions/#{routine_name}" %>"><span><i class="code icon"></i> <%= routine_name %></span></a>
+				<% end %>
+			<% end %>
+
+			<% unless data[:triggers].empty? %>
+				<div class="subheader">Triggers</div>
+				<% data[:triggers].each do |routine_name, routine| %>
+					<a class="item" href="<%= url "/schemas/#{schema}/triggers/#{routine_name}" %>"><span><i class="lightning icon"></i> <%= routine_name %></span></a>
 				<% end %>
 			<% end %>
 

data/views/layout.erb

@@ -10,10 +10,13 @@
 	<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="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/foundation.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="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
+	<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/sql.min.js"></script>
 	<script src="<%= url '/pg-doc.js' %>"></script>
 
 </head>

data/views/objects/function.erb

@@ -1 +1,33 @@
-<%= object %>
+<h1>
+	<%= object[:external_language]%> Function - <code><%= params["schema"] %>.<%= params["name"] %></code>
+</h1>
+
+<% if object[:comment] %>
+	<h2>Description</h2>
+	<p><%= object[:comment] %></p>
+<% end %>
+
+<%= render_markdown "schema/#{params["schema"]}/functions/#{params["name"]}.md" %>
+
+<h2>Function Arguments</h2>
+<table class="ui compact fixed celled table">
+	<thead>
+		<th>Argument Name</th>
+		<th>Data Type</th>
+		<th>Argument Mode</th>
+	</thead>
+	<tbody>
+		<% object[:arguments].each do |row| %>
+		<tr>
+			<td><%= row["name"] %></td>
+			<td><%= row["type"] %></td>
+			<td><%= row["mode"] %></td>
+		</tr>
+		<% end %>
+	</tbody>
+</table>
+
+<% if object[:function_definition] %>
+	<h2>Function Definition</h2>
+	<pre class="ui segment sql"><%= CGI.escapeHTML object[:function_definition] %></pre>
+<% end %>

data/views/objects/table.erb

@@ -14,7 +14,7 @@ end
 </h1>
 
 <% if object[:comment] %>
-	<h2>Database Comment</h2>
+	<h2>Description</h2>
 	<p><%= object[:comment] %></p>
 <% end %>
 

data/views/objects/trigger.erb

@@ -0,0 +1,15 @@
+<h1>
+	<%= object[:external_language]%> Trigger - <code><%= params["schema"] %>.<%= params["name"] %></code>
+</h1>
+
+<% if object[:comment] %>
+	<h2>Description</h2>
+	<p><%= object[:comment] %></p>
+<% end %>
+
+<%= render_markdown "schema/#{params["schema"]}/triggers/#{params["name"]}.md" %>
+
+<% if object[:function_definition] %>
+	<h2>Trigger Definition</h2>
+	<pre class="ui segment sql"><%= CGI.escapeHTML object[:function_definition] %></pre>
+<% end %>

data/views/objects/view.erb

@@ -1 +1,33 @@
-<h2>Coming Soon!</h2>
+<h1>
+	View - <code><%= params["schema"] %>.<%= params["name"] %></code>
+</h1>
+
+<% if object[:comment] %>
+	<h2>Description</h2>
+	<p><%= object[:comment] %></p>
+<% end %>
+
+<%= render_markdown "schema/#{params["schema"]}/views/#{params["name"]}.md" %>
+
+<table class="ui compact fixed celled table">
+	<thead>
+		<th>Column Name</th>
+		<th>Data Type</th>
+		<th>Comment</th>
+	</thead>
+	<tbody>
+		<% object[:columns].each do |row| %>
+		<tr>
+			<td><%= row["column_name"] %></td>
+			<td><%= row["data_type"] %></td>
+			<td><%= row["comment"] %></td>
+		</tr>
+		<% end %>
+	</tbody>
+</table>
+
+<h2>View Definition</h2>
+
+<pre class="ui segment sql">
+<%= CGI.escapeHTML object[:view_definition] %>
+</pre>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg-doc
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kenaniah Cerny
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-17 00:00:00.000000000 Z
+date: 2018-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -169,6 +169,7 @@ files:
 - views/objects/function.erb
 - views/objects/schema.erb
 - views/objects/table.erb
+- views/objects/trigger.erb
 - views/objects/view.erb
 homepage: https://github.com/kenaniah/pg-doc
 licenses: