rain-doc 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 760f009f7d9d3a776da4498ff735ac00c1f806d1
-  data.tar.gz: 8a4b8da84914e4ac4be50a986a05fb77112beae0
+  metadata.gz: 17f3f57b0db1830d87f264ed478993bddae46dbf
+  data.tar.gz: 76ae901bacabe4b66368d80b8923e05ff1082d73
 SHA512:
-  metadata.gz: 0b42e4e5eb24008efe96f6953decd4d6aed4930a5c590f966c265676ab09005ead820eaada555d3df4a830431e59e28cb5faf52867c211e349a2689251c875d3
-  data.tar.gz: f22e1e5e95284334181893eaed71dc1eae88413a27db44af9523e4ce623664541437bfee7103f8072e36699c2d6d62606c9db15494efd6efaa560b17d32e601b
+  metadata.gz: d1f10d35fc3cf4c1715e5178d2fd4dca41379a6b4c97fc501373902d8c9488c4acab9a2f7f0cf6a7c7b381fccff49a19bdb435f3d36323f810a9fa754494d436
+  data.tar.gz: b9d11ecabb6012c7ac888cdf837fabe96c3c80b0e95c7c93b45c1d5a6959c7ed36cfb9fb7db1690be9ef8e9f0ef1bf7784a6d7964961be23a4340b36475f29a3

data/lib/doc_part.rb

@@ -103,7 +103,7 @@ module Rain
       if current_param.nil?
         self.params << {
           name: name,
-          text: description,
+          text: [description],
           type: type,
           default: default
         }
@@ -133,7 +133,7 @@ module Rain
       if current_header.nil?
         self.headers << {
           name: name,
-          text: description
+          text: [description]
         }
       else
         # otherwise append to the current header

data/lib/rain.rb

@@ -6,6 +6,9 @@ require 'fileutils'
 class Rain::CLI < Thor
 	@@docs = []
 
+	# loops through all of the specified source
+	# files, parses them line by line and produces
+	# doc and docpart output
 	desc "generate [file/sources/**]", "Generates the rain documentation"
 	method_option :log_parse, aliases: "--lp", desc: "Show the output of each line parse."
 	method_option :parse_signatures, aliases: "--s", desc: "Parse method and class documentation too. Defaults to false."
@@ -23,6 +26,7 @@ class Rain::CLI < Thor
 
 		print "\nBuilding html output... \n"
 		build_html
+		print "\nDone! See rain_out/ directory for output.\n"
 	end
 
 	# define the ascii art for the help command
@@ -39,6 +43,9 @@ class Rain::CLI < Thor
 		print "              \n"
 		print "basic usage:\n"
 		print "  rain generate file/**/*.rb\n"
+		print "options:\n"
+		print "  --lp logs all line parsing output to console\n"
+		print "  --s  generates docs for methods and class signatures\n"
 	end
 
 	no_commands do
@@ -106,7 +113,7 @@ class Rain::CLI < Thor
 						else
 							nav[:navdoc][:parts] << {
 								title: part[:route],
-								url: "#{html_file_name}##{part[:route].gsub('/', '-').gsub(':', '')}"
+								url: "#{html_file_name}##{part[:http_method].downcase}#{part[:route].gsub('/', '-').gsub(':', '')}"
 							}
 						end
 					end

data/templates/css/rain.css

@@ -0,0 +1,36 @@
+hr {
+  width: 80%;
+}
+p {
+  font-size: 120%;
+}
+
+/* Styles for how the route & method display as well as their color. */
+.route-outer {
+  width: 100%;
+  border: 1px solid #ccc;
+  border-radius: 5px;
+  margin: 20px 0;
+}
+.route-method {
+  display: inline-block;
+  font-weight: bold;
+  padding: 5px 10px;
+  color: white;
+}
+.route-path {
+  display: inline-block;
+  padding: 5px 10px;
+}
+.method-get, .method-head {
+  background-color: #009C5d;
+}
+.method-post {
+  background-color: #e58500;
+}
+.method-put, .method-patch {
+  background-color: #075494;
+}
+.method-delete {
+  background-color: #e54400;
+}

data/templates/doc.erb

@@ -1,21 +1,26 @@
-<!-- loop through all of the doc parts for the doc and render output -->
-<% parts.each do |part| %>
+<!-- loop through all of the doc doc_parts for the doc and render output -->
+<% parts.each do |doc_part| %>
 
   <!-- HTTP method and route (if both specified) -->
-  <% if !part[:route].nil? && !part[:http_method].nil? %>
-    <p id="<%= part[:route].gsub('/', '-').gsub(':', '') %>"><strong><%= part[:http_method] %></strong> <%= part[:route] %></p>
-  <% elsif !part[:signature].nil? %>
-    <p id="<%= part[:signature].gsub(' ', '-').gsub(',', '').gsub('(', '-').gsub(')', '-')[0..12] %>"><strong><%= part[:signature] %></strong></p>
+  <% if !doc_part[:route].nil? && !doc_part[:http_method].nil? %>
+  <div class="route-outer">
+    <div id="<%= doc_part[:route].gsub('/', '-').gsub(':', '') %>" class="route-method method-<%=doc_part[:http_method].downcase %>">
+      <%= doc_part[:http_method] %>
+    </div>
+    <div class="route-path"><%= doc_part[:route] %></div>
+  </div>
+  <% elsif !doc_part[:signature].nil? %>
+    <p id="<%= doc_part[:signature].gsub(' ', '-').gsub(',', '').gsub('(', '-').gsub(')', '-')[0..12] %>"><strong><%= doc_part[:signature] %></strong></p>
   <% end %>
 
-  <!-- display all of the docs together for the part -->
-  <p><% part[:doc].each do |doc| %>
-    <%= doc %>
+  <!-- display all of the docs together for the doc_part -->
+  <p><% doc_part[:doc].each do |doc| %>
+    <%= doc %>&nbsp;
   <% end %></p>
 
   <!-- show all of the params in a table -->
-  <% if part[:params].length > 0 %>
-    <h4>Parameters</h4>
+  <% if doc_part[:params].length > 0 %>
+    <h5>Parameters</h5>
     <table class="u-full-width">
       <thead>
         <tr>
@@ -25,20 +30,20 @@
           <th>Description</th>
         </tr>
       </thead>
-      <% part[:params].each do |param| %>
+      <% doc_part[:params].each do |param| %>
         <tr>
           <td><%= param[:name] %></td>
           <td><%= param[:type] %></td>
           <td><%= param[:default].nil? ? 'N/A' : param[:default] %></td>
-          <td><%= param[:text] %></td>
+          <td><%= param[:text].join(' ') %></td>
         </tr>
       <% end %>
     </table>
   <% end %>
 
   <!-- show all of the headers in a table -->
-  <% if part[:headers].length > 0 %>
-    <h4>Headers</h4>
+  <% if doc_part[:headers].length > 0 %>
+    <h5>Headers</h5>
     <table class="u-full-width">
       <thead>
         <tr>
@@ -46,21 +51,22 @@
           <th>Description</th>
         </tr>
       </thead>
-      <% part[:headers].each do |param| %>
+      <% doc_part[:headers].each do |param| %>
         <tr>
           <td><%= param[:name] %></td>
-          <td><%= param[:text] %></td>
+          <td><%= param[:text].join(' ') %></td>
         </tr>
       <% end %>
     </table>
   <% end %>
 
   <!-- show all of the responses with examples -->
-  <% if part[:responses].length > 0 %>
-    <h4>Response Examples</h4>
-    <% part[:responses].each do |response| %>
+  <% if doc_part[:responses].length > 0 %>
+    <h5>Response Examples</h5>
+    <% doc_part[:responses].each do |response| %>
       <p><strong><%= response[:code] %></strong> <%= response[:id].upcase %></p>
       <pre><code><%= response[:text].join("\n") %></code></pre>
     <% end %>
   <% end %>
+  <hr />
 <% end %>

data/templates/layout.erb

@@ -3,6 +3,7 @@
   <title>Rain | <%= title %></title>
   <link rel="stylesheet" type="text/css" href="css/normalize.css" />
   <link rel="stylesheet" type="text/css" href="css/skeleton.css" />
+  <link rel="stylesheet" type="text/css" href="css/rain.css" />
 </head>
 <body>
   <div class="container">

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rain-doc
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Martin Brennan
@@ -72,6 +72,7 @@ files:
 - lib/parser.rb
 - lib/rain.rb
 - templates/css/normalize.css
+- templates/css/rain.css
 - templates/css/skeleton.css
 - templates/doc.erb
 - templates/layout.erb