doc_my_routes 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b080daf187be65c5a0c472b6ea223962ecbabd2
-  data.tar.gz: 46e57b55164f83abaab13f40c78f0cbdf3388a20
+  metadata.gz: 0f789a0b78d494649c621e36704e917d37d72cf5
+  data.tar.gz: 6374b29644c863962118ce3c76d0eecfff645a66
 SHA512:
-  metadata.gz: 839472c90d4bf0766ff29f7fe404e0a987e11e16c9352678d29e554296dc27c7ef6b25fd0e550c39baddb7972cf74400cea5df025d06a52cf30432b81baa183c
-  data.tar.gz: 8cb9cd53652fe153025650de1a0c6201c495b8c853cb14934e1141b55e6e16d6a4a871ac1ded68fbf568c114342f79b548f248377c7addec9287f95d7e521da5
+  metadata.gz: 61418fb9e733596422b95254798a1885b91411be88fdae64a8369d6790d7848797cbca11bc6e72dbd2b183b2897cc85e9dd9a2eeef7d2577432b4b1396521118
+  data.tar.gz: 05b3f7978092608493e1c189cec8d1b1974bcbd541f3d7a092e61ada04eb8db64ace13ce688c1f49fce7d3d02b8cc017a15c5c4e7d36fc7213ccfa02b097e9d8

data/etc/css/base.css

@@ -248,7 +248,7 @@ table
 table td
 {
   border-top:1px solid #ccc;
-  padding:.5em .5em .5em 0;
+  padding:.5em 1.5em .5em 0;
 }
 
 thead
@@ -282,4 +282,4 @@ article.example
 {
   color:#555;
   margin:1em;
-}
+}

data/etc/partial.html.erb

@@ -48,12 +48,20 @@
                     <thead>
                       <tr>
                         <th>Parameter</th>
+                        <th>Required</th>
+                        <th>Location</th>
+                        <th>Type</th>
+                        <th>Description</th>
                       </tr>
                     </thead>
                     <tbody class="operation-params">
-                    <% route[:parameters].each do |param| %>
+                    <% route[:parameters].each do |param_name, param_options| %>
                       <tr>
-                        <td><%= param %></td>
+                        <td><%= param_name %></td>
+                        <td><%= param_options[:required] ? 'Yes' : 'No' %></td>
+                        <td><%= param_options[:in] %></td>
+                        <td><%= param_options[:type] %></td>
+                        <td><%= param_options[:description] %></td>
                       </tr>
                     <% end %>
                     </tbody>

data/lib/doc_my_routes/doc/hash_helpers.rb

@@ -0,0 +1,16 @@
+module DocMyRoutes
+  # Define hash helpers for deep hash merge and transforming hash into array of keys
+  module HashHelpers
+    def self.deep_merge(first_hash, second_hash)
+      merger = proc do |key, first, second|
+        first.is_a?(Hash) && second.is_a?(Hash) ? first.merge(second, &merger) : second
+      end
+
+      first_hash.merge(second_hash, &merger)
+    end
+
+    def self.array_to_hash_keys(arr, default_value = {})
+      {}.tap { |hash| arr.each { |key| hash[key] = default_value } }
+    end
+  end
+end

data/lib/doc_my_routes/doc/mixins/annotatable.rb

@@ -52,7 +52,6 @@ module DocMyRoutes
 
     def route_documentation
       @route_documentation ||= begin
-        DocMyRoutes.logger.debug 'Tracking new route'
         RouteDocumentation.new
       end
     end
@@ -88,6 +87,10 @@ module DocMyRoutes
       route_documentation.notes_ref = value
     end
 
+    def parameter(value, options = {})
+      route_documentation.add_parameter(value, options)
+    end
+
     private
 
     def track_route(resource, verb, route_pattern, conditions)

data/lib/doc_my_routes/doc/route.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 require 'forwardable'
+require_relative 'hash_helpers'
 
 module DocMyRoutes
   # Simple object representing a route
@@ -22,12 +23,16 @@ module DocMyRoutes
       @documentation = documentation
     end
 
+    # We need to use deep merge as param_info method will return a hash for parameters
+    # with extracted information from the route path, and documentation might also have
+    # parameters with some more documentation and we don't want to loose extracted data
+    # from route path
     def to_hash
-      {
+      HashHelpers.deep_merge({
         http_method: verb,
         parameters: param_info,
         path: path
-      }.merge(documentation.to_hash)
+      }, documentation.to_hash)
     end
 
     def path
@@ -60,13 +65,15 @@ module DocMyRoutes
     #
     # Try to extract parameters from the route definition otherwise
     def param_info
-      if conditions[:parameters]
-        conditions[:parameters]
-      else
-        route_pattern.split('/').map do |part|
-          part.start_with?(':') ? part[1..-1].to_sym : nil
-        end.compact
-      end
+      path_parameters_array = route_pattern.split('/').map do |part|
+        part.start_with?(':') ? part[1..-1].to_sym : nil
+      end.compact
+
+      path_parameters = HashHelpers.array_to_hash_keys(path_parameters_array,
+                                                       { in: :path, required: true })
+      condition_parameters = HashHelpers.array_to_hash_keys(conditions[:parameters] || [])
+
+      HashHelpers.deep_merge(condition_parameters, path_parameters)
     end
   end
 end

data/lib/doc_my_routes/doc/route_documentation.rb

@@ -3,12 +3,13 @@ module DocMyRoutes
   class RouteDocumentation
     attr_accessor :summary, :notes, :status_codes, :examples_regex, :hidden,
                   :produces, :notes_ref
-    attr_reader :examples
+    attr_reader :examples, :parameters
 
     def initialize
       @status_codes = { 200 => DocMyRoutes::StatusCodeInfo::STATUS_CODES[200] }
       @hidden = false
       @produces = []
+      @parameters = {}
     end
 
     # A route documentation object MUST have a summary, otherwise is not
@@ -25,6 +26,7 @@ module DocMyRoutes
         examples_regex: examples_regex,
         produces: produces,
         examples: examples,
+        parameters: parameters,
         hidden: hidden?
       }
     end
@@ -33,6 +35,10 @@ module DocMyRoutes
       @produces = values.flatten.compact
     end
 
+    def add_parameter(name, options)
+      @parameters[name] = options
+    end
+
     def status_codes=(route_status_codes)
       @status_codes = Hash[route_status_codes.map do |code|
         [code, DocMyRoutes::StatusCodeInfo::STATUS_CODES[code]]

data/lib/doc_my_routes/version.rb

@@ -1,4 +1,4 @@
 # DocMyRoutes version
 module DocMyRoutes
-  VERSION = '0.11.1'
+  VERSION = '0.12.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doc_my_routes
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Workday, Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-18 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,6 +123,7 @@ files:
 - lib/doc_my_routes/doc/documentation.rb
 - lib/doc_my_routes/doc/errors.rb
 - lib/doc_my_routes/doc/examples_handler.rb
+- lib/doc_my_routes/doc/hash_helpers.rb
 - lib/doc_my_routes/doc/mapping.rb
 - lib/doc_my_routes/doc/mixins/annotatable.rb
 - lib/doc_my_routes/doc/route.rb