rspec-openapi 0.3.3 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b483a73ef32d771b4da3e66f3c63d1cd0a1cfbb839752546d5465cda43ff8444
-  data.tar.gz: cf8ec362c29193e2434db5433170ec655008cd5f636a8f2341f9abf7e7f3d454
+  metadata.gz: 0d269feb84050ecb4ccc68924f76ae57ff4404521c22dc6cc004a177a579138b
+  data.tar.gz: 7df64e4c1ec76e652039e952b66d10322d3fa56f9a8af125da7872bade8ae2ad
 SHA512:
-  metadata.gz: de935612cc1afdd9c8ccca7d69711beca33dea36ec97555293978544c9c1a978c04cdc196c42a39888408d7575e40d0d6dff76adf1d629b27512c569feb9b29a
-  data.tar.gz: 423d62a92e8a9b143fae9304af57d893e079dbc9cb956e17320ea45a3bf30d8084f88395fdeaa835cd8689c3b72ecba2b40812bd9c81a0f044ddf91754169f9c
+  metadata.gz: bbb3af75f12db96f24941fb6f14112fa860ff98a23b44fecb9a2efb87974dfdb68d11afa113cedea15761dd59b33a621357a1e829613c61235338bf436d09965
+  data.tar.gz: 552c01a691716245c43c186cc913e26578d287c54e005633901da94e286694e1b83f47a0a438aebd18a0b6b8a1b6d7cb3dd1afe21faef87dae3765613ebef57f

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## v0.3.8
+
+* Generate `type: 'number', format: 'float'` instead of `type: 'float'` for Float
+  [#11](https://github.com/k0kubun/rspec-openapi/issues/11)
+
+## v0.3.7
+
+* Classify tag names and remove controller names from summary in Rails
+
+## v0.3.6
+
+* Fix documents generated by Rails engines
+
+## v0.3.5
+
+* Support finding routes in Rails engines
+
+## v0.3.4
+
+* Generate tags by controller names
+  [#10](https://github.com/k0kubun/rspec-openapi/issues/10)
+
 ## v0.3.3
 
 * Avoid `JSON::ParserError` when a response body is no content

data/README.md

@@ -64,16 +64,20 @@ info:
 paths:
   "/tables":
     get:
-      summary: 'tables #index'
+      summary: index
+      tags:
+      - Table
       parameters:
       - name: page
         in: query
         schema:
           type: integer
+        example: 1
       - name: per
         in: query
         schema:
           type: integer
+        example: 10
       responses:
         '200':
           description: returns a list of tables

data/lib/rspec/openapi/record.rb

@@ -6,6 +6,7 @@ RSpec::OpenAPI::Record = Struct.new(
   :request_params,        # @param [Hash]    - {:request=>"body"}
   :request_content_type,  # @param [String]  - "application/json"
   :summary,               # @param [String]  - "v1/statuses #show"
+  :tags,                  # @param [Array]   - ["Status"]
   :description,           # @param [String]  - "returns a status"
   :status,                # @param [Integer] - 200
   :response_body,         # @param [Object]  - {"status" => "ok"}

data/lib/rspec/openapi/record_builder.rb

@@ -18,7 +18,8 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
     if rails?
       route = find_rails_route(request)
       path = route.path.spec.to_s.delete_suffix('(.:format)')
-      summary = "#{route.requirements[:controller]} ##{route.requirements[:action]}"
+      summary = "#{route.requirements[:action]}"
+      tags = [route.requirements[:controller].classify]
     else
       path = request.path
       summary = "#{request.method} #{request.path}"
@@ -39,6 +40,7 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
       request_params: raw_request_params(request),
       request_content_type: request.content_type,
       summary: summary,
+      tags: tags,
       description: RSpec::OpenAPI.description_builder.call(example),
       status: response.status,
       response_body: response_body,
@@ -57,8 +59,17 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
   end
 
   # @param [ActionDispatch::Request] request
-  def find_rails_route(request)
-    Rails.application.routes.router.recognize(request) do |route|
+  def find_rails_route(request, app: Rails.application, fix_path: true)
+    # Reverse the destructive modification by Rails https://github.com/rails/rails/blob/v6.0.3.4/actionpack/lib/action_dispatch/journey/router.rb#L33-L41
+    if fix_path && !request.script_name.empty?
+      request = request.dup
+      request.path_info = File.join(request.script_name, request.path_info)
+    end
+
+    app.routes.router.recognize(request) do |route|
+      unless route.path.anchored
+        route = find_rails_route(request, app: route.app.app, fix_path: false)
+      end
       return route
     end
     raise "No route matched for #{request.request_method} #{request.path_info}"

data/lib/rspec/openapi/schema_builder.rb

@@ -20,6 +20,7 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
         normalize_path(record.path) => {
           record.method.downcase => {
             summary: record.summary,
+            tags: record.tags,
             parameters: build_parameters(record),
             requestBody: build_request_body(record),
             responses: {
@@ -78,7 +79,8 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
   end
 
   def build_property(value)
-    property = { type: build_type(value) }
+    property = build_type(value)
+
     case value
     when Array
       property[:items] = build_property(value.first)
@@ -95,19 +97,19 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
   def build_type(value)
     case value
     when String
-      'string'
-    when Float
-      'float'
+      { type: 'string' }
     when Integer
-      'integer'
+      { type: 'integer' }
+    when Float
+      { type: 'number', format: 'float' }
     when TrueClass, FalseClass
-      'boolean'
+      { type: 'boolean' }
     when Array
-      'array'
+      { type: 'array' }
     when Hash
-      'object'
+      { type: 'object' }
     when NilClass
-      'null'
+      { type: 'null' }
     else
       raise NotImplementedError, "type detection is not implemented for: #{value.inspect}"
     end

data/lib/rspec/openapi/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module OpenAPI
-    VERSION = '0.3.3'
+    VERSION = '0.3.8'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.8
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-11 00:00:00.000000000 Z
+date: 2020-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -88,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Generate OpenAPI schema from RSpec request specs