rspec-document_requests 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6b543a04a752abc10e26ff44cbafc7c123d2669
-  data.tar.gz: 171d4df08329b57b1459ddca59e3e39411a02509
+  metadata.gz: bc000344bde08e36293ce8a3baf060288b0302d5
+  data.tar.gz: 39f6f21bca22ecb1fd529b632efee84b6b5e0966
 SHA512:
-  metadata.gz: 564517fff40607173e540b7452c6d7ba359500ace2d09f377c355d0dc07371e187683cced4b94a4d3d8c842b9a80031964567dd1334ac4bff52b89c385c56180
-  data.tar.gz: ce6f282549317f61d99d049def1dd73af432610aea25eabaa72f8ea2129fb78bcad8155fc150bb32171473c4daeb1b1c7b60e3c463848b8c17f040d080963e83
+  metadata.gz: c77b38455da8936b95352f125609253061cf44dda9685bfd18d4b4dbd44979a6e466604f365cd2ef38b88bc9e5d4e4a741ffd6c9f45d7b69e4bb301878c3deae
+  data.tar.gz: 36accade2ab7448c6de009f1c6ad3be70fb1e1a1367fda065fe94afab04573dc46589fc32a9197d59913fb8e5ec687606047b811dfc3bdf61aa267786e86ce75

data/README.md

@@ -102,8 +102,8 @@ RSpec.describe "Session resource", type: :request, doc: true do
     before do
       explain do # No request explanation
         request do
-          parameter 'session[username]', "The username", required: true, type: :string
-          parameter 'session[password]', required: true, type: :string # No explanation
+          parameter 'session[username]', "The username", required: true, type: 'string'
+          parameter 'session[password]', required: true, type: 'string' # No explanation
           header 'Content-Type', ... # you get the point
         end
         response do

data/lib/rspec/document_requests/dsl.rb

@@ -30,7 +30,7 @@ module RSpec
       end
 
       def explain(message = nil, &block)
-        document_request_explanation.message = message
+        document_request_explanation.message = message if message
         document_request_explanation.instance_eval(&block) if block_given?
       end
 

data/lib/rspec/document_requests/explanation.rb

@@ -26,13 +26,13 @@ module RSpec
       end
 
       def request(&block)
-        return @request if not block_given?
-        @request.instance_eval(&block)
+        @request.instance_eval(&block) if block_given?
+        @request
       end
 
       def response(&block)
-        return @request if not block_given?
-        @response.instance_eval(&block)
+        @response.instance_eval(&block) if block_given?
+        @response
       end
     end
   end

data/lib/rspec/document_requests/request.rb

@@ -59,7 +59,7 @@ module RSpec
 
       def process_request_parameters(parameters, prefix: nil)
         @request_parameters = {}
-        process_parameters(request_parameters, @request_parameters, explanation: @explanation.request.parameters)
+        process_parameters(parameters, @request_parameters, explanation: @explanation.request.parameters)
       end
 
       def process_request_headers(headers)

data/lib/rspec/document_requests/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module DocumentRequests
-    VERSION = "0.1.1"
+    VERSION = "1.0.0"
   end
 end

data/lib/rspec/document_requests/writers/markdown.rb

@@ -30,7 +30,7 @@ module RSpec
 
         def request(request, missing_levels:)
           @file.write <<FILE
-### Request #{"(#{request.explanation.message})" if request.explanation.message}
+### Request#{" (#{request.explanation.message})" if request.explanation.message}
 
     #{request.method} #{request.path}
 
@@ -38,7 +38,6 @@ FILE
 
           if request.request_parameters.any?
             @file.write <<FILE
-
 #### Parameters
 
 FILE
@@ -47,7 +46,6 @@ FILE
 
           if request.request_headers.any?
             @file.write <<FILE
-
 #### Headers
 
 FILE
@@ -55,13 +53,16 @@ FILE
           end
 
           @file.write <<FILE
-
 ### Response
 
 #### Status
 
     #{request.response.status} #{request.response.status_message}
 
+#### Content-Type
+
+    #{request.response.content_type}
+
 FILE
 
           if request.response_parameters and request.response_parameters.any?
@@ -73,7 +74,6 @@ FILE
           end
 
           @file.write <<FILE
-
 #### Body
 
     #{request.response.body}
@@ -82,7 +82,6 @@ FILE
 
           if request.response_headers.any?
             @file.write <<FILE
-
 #### Headers
 
 FILE
@@ -94,13 +93,14 @@ FILE
 
         def parameters_table(parameters)
           @file.write <<FILE
-| Name | Type | Required? | Value | Explanation |
-|------|------|-----------|-------|-------------|
+| Name | Type | Required? | Value |   |
+|------|------|-----------|-------|---|
 FILE
 
           parameters.sort.each do |name, parameter|
             @file.puts "| #{name}  | #{parameter.type}  | #{"Required" if parameter.required}  | #{parameter.value}  | #{parameter.message}  |"
           end
+          @file.puts
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-document_requests
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Oded Niv