rspec-openapi 0.3.5 → 0.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7134b7b05a91d447b6a52af56ee417e6f0c045d73526f171d9792d2301d40db
-  data.tar.gz: 8eeea5674f4e54c7ec53c1275f51b4dc47876438c64ee658db19cdbb6abc4489
+  metadata.gz: 62ae9fb333bba34df56a7675823e22ae9029852028d529ffae48ee9070eadeb0
+  data.tar.gz: 249959214fbce6ae72294f07e1a7de945c1052071d67942ec7f19c68cbe90a9f
 SHA512:
-  metadata.gz: 62b2b1e562954829ba607fa1f6713aa683fd508dde975198aa0c17c3dd7ad5db0e4d7e57aa80d6ca5a9d758a56d274128434eddc3f0dc9ac090117f80861bd7a
-  data.tar.gz: 354bb226fa980dac17d7a67d66404aad653c5fc4dd26b985fbd335152063b67716d2573e699835c5bce10d929fad08ea28a5f4545186b5b6ce17dbf13ffe01f0
+  metadata.gz: 8f66917401fc326b7a290892000ef82af637d959fd337ab158152176605fa5e41a8ce2e904b7c1d73cef203d1b3851912bcff0d58f5e879d27fc728f456d1569
+  data.tar.gz: abf3aee3cd216b58d53079c53372a3839c3cc89470d5a0500274fde35a3103643d8c6a3555b977989bc598f4f71e0518300cec76372dce1a8ff4bb41615a0113

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+## v0.3.10
+
+* Add `info.version`
+  [#16](https://github.com/k0kubun/rspec-openapi/pull/16)
+
+## 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

data/README.md

@@ -64,9 +64,9 @@ info:
 paths:
   "/tables":
     get:
-      summary: 'tables #index'
+      summary: index
       tags:
-      - tables
+      - Table
       parameters:
       - name: page
         in: query
@@ -111,6 +111,9 @@ RSpec::OpenAPI.path = 'doc/schema.yaml'
 # Disable generating `example`
 RSpec::OpenAPI.enable_example = false
 
+# Change `info.version`
+RSpec::OpenAPI.application_version = '1.0.0'
+
 # Generate a comment on top of a schema file
 RSpec::OpenAPI.comment = <<~EOS
   This file is auto-generated by rspec-openapi https://github.com/k0kubun/rspec-openapi

data/lib/rspec/openapi.rb

@@ -6,8 +6,9 @@ module RSpec::OpenAPI
   @comment = nil
   @enable_example = true
   @description_builder = -> (example) { example.description }
+  @application_version = '1.0.0'
 
   class << self
-    attr_accessor :path, :comment, :enable_example, :description_builder
+    attr_accessor :path, :comment, :enable_example, :description_builder, :application_version
   end
 end

data/lib/rspec/openapi/default_schema.rb

@@ -4,6 +4,7 @@ class << RSpec::OpenAPI::DefaultSchema = Object.new
       openapi: '3.0.3',
       info: {
         title: title,
+        version: RSpec::OpenAPI.application_version,
       },
       paths: {},
     }.freeze

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,14 +59,17 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
   end
 
   # @param [ActionDispatch::Request] request
-  def find_rails_route(request)
-    # Reverse the destructive modification by Rails https://github.com/rails/rails/blob/v5.2.4.4/actionpack/lib/action_dispatch/journey/router.rb#L36-L44
-    unless request.script_name.empty?
+  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
 
-    Rails.application.routes.router.recognize(request) do |route|
+    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.5'
+    VERSION = '0.3.10'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.10
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-23 00:00:00.000000000 Z
+date: 2021-01-12 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