rain-doc 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ac2daf49d1502a2f8042be98b8bcf2f0a8c285f
-  data.tar.gz: 55fa316386cf105a6c5fe59b0deac896e0e27156
+  metadata.gz: 760f009f7d9d3a776da4498ff735ac00c1f806d1
+  data.tar.gz: 8a4b8da84914e4ac4be50a986a05fb77112beae0
 SHA512:
-  metadata.gz: 45a73cb660db67b8a21a012dbf1c05e32d70d853ddbdf4ec805e9c4600e0ccce561e309605c9cbabb55b74f37e86e19bdf81b5dd97a44258c5f789d75de72994
-  data.tar.gz: 90634848c3256aa1261a72e234f7df6216d0c4bafa9a77b8618b04be8f2bcc9104d9e20f8f8c2f3e0ca6d09c5b82c9ad8ea37e33347e081b0e48803699b093df
+  metadata.gz: 0b42e4e5eb24008efe96f6953decd4d6aed4930a5c590f966c265676ab09005ead820eaada555d3df4a830431e59e28cb5faf52867c211e349a2689251c875d3
+  data.tar.gz: f22e1e5e95284334181893eaed71dc1eae88413a27db44af9523e4ce623664541437bfee7103f8072e36699c2d6d62606c9db15494efd6efaa560b17d32e601b

data/lib/doc.rb

@@ -12,6 +12,7 @@ module Rain
     attr_accessor :parser, :type, :parts, :current_part, :lines, :title,
             :file_name, :file_contents, :file_ext
 
+    @@open_header = nil
     @@open_response = nil
     @@open_response_id = nil
     @@open_param = nil
@@ -108,6 +109,14 @@ module Rain
           else
             @@open_response = nil
           end
+        when :header
+
+          # open the current header tag using the code as a key
+          if result[:open]
+            @@open_header = result[:name]
+          else
+            @@open_header = nil
+          end
         when :param
 
           # open the current param tag using the name as the key
@@ -126,6 +135,8 @@ module Rain
             self.current_part.append_response(@@open_response.to_i, @@open_response_id, result[:text])
           elsif !@@open_param.nil?
             self.current_part.append_param(@@open_param, result[:text], @@open_param_type, @@open_param_default)
+          elsif !@@open_header.nil?
+            self.current_part.append_header(@@open_header, result[:text])
           else
             self.current_part.append_doc(result[:text])
           end
@@ -139,7 +150,7 @@ module Rain
 
       # remove any empty parts or parts without method signatures (for ruby docs)
       if self.type == :RUBY
-        self.parts = self.parts.select{ |part| part.route != "//" || !part.signature.nil? }
+        self.parts = self.parts.select{ |part| !part.route.nil? || !part.signature.nil? }
       end
     end
 

data/lib/doc_part.rb

@@ -8,7 +8,7 @@ module Rain
     def initialize
       self.responses = []
       self.doc = []
-      self.route = '//'
+      self.route = nil
       self.params = []
       self.headers = []
     end
@@ -95,12 +95,26 @@ module Rain
     # adds a parameter with the specified type. also sets a
     # default value if specified
     def append_param(name, description, type, default = nil)
-      self.params << {
-        name: name,
-        text: description,
-        type: type,
-        default: default
-      }
+
+      # try and find the current param by name
+      current_param = self.params.select { |param| param[:name] == name }.first
+
+      # add new param if one doesn't exist
+      if current_param.nil?
+        self.params << {
+          name: name,
+          text: description,
+          type: type,
+          default: default
+        }
+      else
+        # otherwise append to the current param
+        self.params.each do |param|
+          if param[:name] == name
+            param[:text] << description
+          end
+        end
+      end
     end
 
     # gets a parameter by name. will return nil if
@@ -112,10 +126,23 @@ module Rain
     # adds a http header with name and
     # description of the header
     def append_header(name, description)
-      self.headers << {
-        name: name,
-        text: description
-      }
+
+      # try and find the current header by name
+      current_header = self.headers.select { |header| header[:name] == name }.first
+
+      if current_header.nil?
+        self.headers << {
+          name: name,
+          text: description
+        }
+      else
+        # otherwise append to the current header
+        self.headers.each do |header|
+          if header[:name] == name
+            header[:text] << description
+          end
+        end
+      end
     end
 
     # gets a header's description from the store

data/lib/parser.rb

@@ -4,6 +4,7 @@ module Rain
 
     @@title_regex = /{title (.*?)}/m
     @@route_regex = /{route (.*?)}/m
+    @@header_regex = /{header (.*?)}/m
     @@response_regex = /{response (.*?) (.*?)}/m
     @@param_regex = /{param (.*?) (.*?)}/m
     @@param_regex_default = /{param (.*?) (.*?) (.*?)}/m
@@ -86,6 +87,17 @@ module Rain
         }
       end
 
+      # param tag. must determine whether to open the tag
+      # for extra docs or close it
+      if is_header?(line)
+        open = line.start_with?('{/header') ? false : true
+        return {
+          tag: :header,
+          name: extract_header_name(line),
+          open: open
+        }
+      end
+
       # return method signature if found
       if parse_signatures
         if line.start_with?('def ', 'class ', 'get "', "get '", 'put "', "put '", 'post "', "post '", 'delete "', "delete '")
@@ -173,5 +185,13 @@ module Rain
     def extract_param_default(line)
       line[@@param_regex_default, 3]
     end
+
+    def is_header?(line)
+      line.start_with?('{header') || line.start_with?('{/header')
+    end
+
+    def extract_header_name(line)
+      line[@@header_regex, 1]
+    end
   end
 end

data/templates/doc.erb

@@ -36,6 +36,25 @@
     </table>
   <% end %>
 
+  <!-- show all of the headers in a table -->
+  <% if part[:headers].length > 0 %>
+    <h4>Headers</h4>
+    <table class="u-full-width">
+      <thead>
+        <tr>
+          <th>Name</th>
+          <th>Description</th>
+        </tr>
+      </thead>
+      <% part[:headers].each do |param| %>
+        <tr>
+          <td><%= param[:name] %></td>
+          <td><%= param[:text] %></td>
+        </tr>
+      <% end %>
+    </table>
+  <% end %>
+
   <!-- show all of the responses with examples -->
   <% if part[:responses].length > 0 %>
     <h4>Response Examples</h4>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rain-doc
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Martin Brennan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-18 00:00:00.000000000 Z
+date: 2014-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec