rspec-openapi 0.3.4 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72b0193cdb3e3f8ee7b2cf52f1d2211a0b57a2074424323ab595af78693b5563
-  data.tar.gz: 021e6b386ffb4ed889bd08e61b8d26030cae32667fd8225f1e6ad24e1345aaf4
+  metadata.gz: 93751a821ec1800557dddd948ba2096f19c03f86a474dd2d63bf2c181fe44162
+  data.tar.gz: 8dfb18c46f4ba4621c1f46ff9948a2305ffd429ea39b4e36ceb005a3bbd6b8d9
 SHA512:
-  metadata.gz: 65e8998e2bcfd5ad2d34bd42477e86474baa3daadc8de07210ae9601c05cdb571306b9e8768d3d50de803fd078e167592febea3f820df294e3807e09f0c0c2fd
-  data.tar.gz: 1b9fee7f0277f71d4364ee7d39679749c941afcf3fd79df0180abf7510379b9d06e7f9ce24f0cb686f258204c205251f0d50b7211706f82e62f27f1ebc2ff0ce
+  metadata.gz: 0fde2eed92e5aec96e7949dc1255d9d55a3fb68cd492356dd1d05744a627f9d7ee04a5d05228f5577d9a8caa70df0d5e01b338b9b7cc65a29ee8c86eaa8c2173
+  data.tar.gz: 8564180885a24f861ca7d3a87e8e6a5f0b6d2750444efac4875b1052b8cfbcfb795157a7feb8fe966d1f8352d1847a78d4237c97b316fb02a1c62651e4974a02

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## v0.3.9
+
+* Initial support for multipart/form-data
+  [#12](https://github.com/k0kubun/rspec-openapi/pull/12)
+
+## 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

data/README.md

@@ -64,9 +64,9 @@ info:
 paths:
   "/tables":
     get:
-      summary: 'tables #index'
+      summary: index
       tags:
-      - tables
+      - Table
       parameters:
       - name: page
         in: query

data/lib/rspec/openapi/record_builder.rb

@@ -18,8 +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]}"
-      tags = [route.requirements[:controller]]
+      summary = "#{route.requirements[:action]}"
+      tags = [route.requirements[:controller].classify]
     else
       path = request.path
       summary = "#{request.method} #{request.path}"
@@ -59,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

@@ -79,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)
@@ -96,19 +97,21 @@ 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 ActionDispatch::Http::UploadedFile
+      { type: 'string', format: 'binary' }
     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.4'
+    VERSION = '0.3.9'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.9
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-22 00:00:00.000000000 Z
+date: 2020-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -66,6 +66,7 @@ files:
 - lib/rspec/openapi/schema_merger.rb
 - lib/rspec/openapi/version.rb
 - rspec-openapi.gemspec
+- test.png
 homepage: https://github.com/k0kubun/rspec-openapi
 licenses:
 - MIT
@@ -88,7 +89,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