Skip to content

Commit 12892b0

Browse files
AlexeyMatskevichAlexeyMatskevich
authored
Add support hanami router (#205)
1 parent a978adf commit 12892b0

File tree

12 files changed

+595
-274
lines changed

12 files changed

+595
-274
lines changed

‎lib/rspec/openapi.rb

+17
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,23 @@
1111
require 'rspec/openapi/schema_cleaner'
1212
require 'rspec/openapi/schema_sorter'
1313
require 'rspec/openapi/key_transformer'
14+
require 'rspec/openapi/shared_hooks'
15+
require 'rspec/openapi/extractors'
16+
require 'rspec/openapi/extractors/rack'
17+
18+
begin
19+
require 'hanami'
20+
require 'rspec/openapi/extractors/hanami'
21+
rescue LoadError
22+
puts 'Hanami not detected'
23+
end
24+
25+
begin
26+
require 'rails'
27+
require 'rspec/openapi/extractors/rails'
28+
rescue LoadError
29+
puts 'Rails not detected'
30+
end
1431

1532
require 'rspec/openapi/minitest_hooks' if Object.const_defined?('Minitest')
1633
require 'rspec/openapi/rspec_hooks' if ENV['OPENAPI'] && Object.const_defined?('RSpec')

‎lib/rspec/openapi/extractors.rb

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# frozen_string_literal: true
2+
3+
# Create namespace
4+
module RSpec::OpenAPI::Extractors
5+
end

‎lib/rspec/openapi/extractors/hanami.rb

+118
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
# frozen_string_literal: true
2+
3+
require 'dry/inflector'
4+
require 'hanami'
5+
6+
# https://github.com/hanami/router/blob/97f75b8529574bd4ff23165460e82a6587bc323c/lib/hanami/router/inspector.rb#L13
7+
class Inspector
8+
attr_accessor :routes, :inflector
9+
10+
def initialize(routes: [])
11+
@routes = routes
12+
@inflector = Dry::Inflector.new
13+
end
14+
15+
def add_route(route)
16+
routes.push(route)
17+
end
18+
19+
def call(verb, path)
20+
route = routes.find { |r| r.http_method == verb && r.path == path }
21+
22+
if route.to.is_a?(Proc)
23+
{
24+
tags: [],
25+
summary: "#{verb} #{path}",
26+
}
27+
else
28+
data = route.to.split('.')
29+
30+
{
31+
tags: [inflector.classify(data[0])],
32+
summary: data[1],
33+
}
34+
end
35+
end
36+
end
37+
38+
InspectorAnalyzer = Inspector.new
39+
40+
# Add default parameter to load inspector before test cases run
41+
module InspectorAnalyzerPrepender
42+
def router(inspector: InspectorAnalyzer)
43+
super
44+
end
45+
end
46+
47+
Hanami::Slice::ClassMethods.prepend(InspectorAnalyzerPrepender)
48+
49+
# Extractor for hanami
50+
class << RSpec::OpenAPI::Extractors::Hanami = Object.new
51+
# @param [RSpec::ExampleGroups::*] context
52+
# @param [RSpec::Core::Example] example
53+
# @return Array
54+
def request_attributes(request, example)
55+
metadata = example.metadata[:openapi] || {}
56+
summary = metadata[:summary] || RSpec::OpenAPI.summary_builder.call(example)
57+
tags = metadata[:tags] || RSpec::OpenAPI.tags_builder.call(example)
58+
operation_id = metadata[:operation_id]
59+
required_request_params = metadata[:required_request_params] || []
60+
security = metadata[:security]
61+
description = metadata[:description] || RSpec::OpenAPI.description_builder.call(example)
62+
deprecated = metadata[:deprecated]
63+
path = request.path
64+
65+
route = Hanami.app.router.recognize(request.path, method: request.method)
66+
67+
raw_path_params = route.params.filter { |_key, value| number_or_nil(value) }
68+
69+
result = InspectorAnalyzer.call(request.method, add_id(path, route))
70+
71+
summary ||= result[:summary]
72+
tags ||= result[:tags]
73+
path = add_openapi_id(path, route)
74+
75+
raw_path_params = raw_path_params.slice(*(raw_path_params.keys - RSpec::OpenAPI.ignored_path_params))
76+
77+
[path, summary, tags, operation_id, required_request_params, raw_path_params, description, security, deprecated]
78+
end
79+
80+
# @param [RSpec::ExampleGroups::*] context
81+
def request_response(context)
82+
request = ActionDispatch::Request.new(context.last_request.env)
83+
request.body.rewind if request.body.respond_to?(:rewind)
84+
response = ActionDispatch::TestResponse.new(*context.last_response.to_a)
85+
86+
[request, response]
87+
end
88+
89+
def add_id(path, route)
90+
return path if route.params.empty?
91+
92+
route.params.each_pair do |key, value|
93+
next unless number_or_nil(value)
94+
95+
path = path.sub("/#{value}", "/:#{key}")
96+
end
97+
98+
path
99+
end
100+
101+
def add_openapi_id(path, route)
102+
return path if route.params.empty?
103+
104+
route.params.each_pair do |key, value|
105+
next unless number_or_nil(value)
106+
107+
path = path.sub("/#{value}", "/{#{key}}")
108+
end
109+
110+
path
111+
end
112+
113+
def number_or_nil(string)
114+
Integer(string || '')
115+
rescue ArgumentError
116+
nil
117+
end
118+
end

‎lib/rspec/openapi/extractors/rack.rb

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# frozen_string_literal: true
2+
3+
# Extractor for rack
4+
class << RSpec::OpenAPI::Extractors::Rack = Object.new
5+
# @param [RSpec::ExampleGroups::*] context
6+
# @param [RSpec::Core::Example] example
7+
# @return Array
8+
def request_attributes(request, example)
9+
metadata = example.metadata[:openapi] || {}
10+
summary = metadata[:summary] || RSpec::OpenAPI.summary_builder.call(example)
11+
tags = metadata[:tags] || RSpec::OpenAPI.tags_builder.call(example)
12+
operation_id = metadata[:operation_id]
13+
required_request_params = metadata[:required_request_params] || []
14+
security = metadata[:security]
15+
description = metadata[:description] || RSpec::OpenAPI.description_builder.call(example)
16+
deprecated = metadata[:deprecated]
17+
raw_path_params = request.path_parameters
18+
path = request.path
19+
summary ||= "#{request.method} #{path}"
20+
[path, summary, tags, operation_id, required_request_params, raw_path_params, description, security, deprecated]
21+
end
22+
23+
# @param [RSpec::ExampleGroups::*] context
24+
def request_response(context)
25+
request = ActionDispatch::Request.new(context.last_request.env)
26+
request.body.rewind if request.body.respond_to?(:rewind)
27+
response = ActionDispatch::TestResponse.new(*context.last_response.to_a)
28+
29+
[request, response]
30+
end
31+
end

‎lib/rspec/openapi/extractors/rails.rb

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# frozen_string_literal: true
2+
3+
# Extractor for rails
4+
class << RSpec::OpenAPI::Extractors::Rails = Object.new
5+
# @param [RSpec::ExampleGroups::*] context
6+
# @param [RSpec::Core::Example] example
7+
# @return Array
8+
def request_attributes(request, example)
9+
metadata = example.metadata[:openapi] || {}
10+
summary = metadata[:summary] || RSpec::OpenAPI.summary_builder.call(example)
11+
tags = metadata[:tags] || RSpec::OpenAPI.tags_builder.call(example)
12+
operation_id = metadata[:operation_id]
13+
required_request_params = metadata[:required_request_params] || []
14+
security = metadata[:security]
15+
description = metadata[:description] || RSpec::OpenAPI.description_builder.call(example)
16+
deprecated = metadata[:deprecated]
17+
raw_path_params = request.path_parameters
18+
19+
# 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
20+
fixed_request = request.dup
21+
fixed_request.path_info = File.join(request.script_name, request.path_info) if request.script_name.present?
22+
23+
route, path = find_rails_route(fixed_request)
24+
raise "No route matched for #{fixed_request.request_method} #{fixed_request.path_info}" if route.nil?
25+
26+
path = path.delete_suffix('(.:format)')
27+
summary ||= route.requirements[:action]
28+
tags ||= [route.requirements[:controller]&.classify].compact
29+
# :controller and :action always exist. :format is added when routes is configured as such.
30+
# TODO: Use .except(:controller, :action, :format) when we drop support for Ruby 2.x
31+
raw_path_params = raw_path_params.slice(*(raw_path_params.keys - RSpec::OpenAPI.ignored_path_params))
32+
33+
summary ||= "#{request.method} #{path}"
34+
35+
[path, summary, tags, operation_id, required_request_params, raw_path_params, description, security, deprecated]
36+
end
37+
38+
# @param [RSpec::ExampleGroups::*] context
39+
def request_response(context)
40+
[context.request, context.response]
41+
end
42+
43+
# @param [ActionDispatch::Request] request
44+
def find_rails_route(request, app: Rails.application, path_prefix: '')
45+
app.routes.router.recognize(request) do |route|
46+
path = route.path.spec.to_s
47+
if route.app.matches?(request)
48+
if route.app.engine?
49+
route, path = find_rails_route(request, app: route.app.app, path_prefix: path)
50+
next if route.nil?
51+
end
52+
return [route, path_prefix + path]
53+
end
54+
end
55+
56+
nil
57+
end
58+
end

‎lib/rspec/openapi/minitest_hooks.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ def run(*args)
1313
human_name = name.sub(/^test_/, '').gsub('_', ' ')
1414
example = Example.new(self, human_name, {}, file_path)
1515
path = RSpec::OpenAPI.path.then { |p| p.is_a?(Proc) ? p.call(example) : p }
16-
record = RSpec::OpenAPI::RecordBuilder.build(self, example: example)
16+
record = RSpec::OpenAPI::RecordBuilder.build(self, example: example, extractor: SharedHooks.find_extractor)
1717
RSpec::OpenAPI.path_records[path] << record if record
1818
end
1919
result

‎lib/rspec/openapi/record_builder.rb

+3-68
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
77
# @param [RSpec::ExampleGroups::*] context
88
# @param [RSpec::Core::Example] example
99
# @return [RSpec::OpenAPI::Record,nil]
10-
def build(context, example:)
11-
request, response = extract_request_response(context)
10+
def build(context, example:, extractor:)
11+
request, response = extractor.request_response(context)
1212
return if request.nil?
1313

1414
path, summary, tags, operation_id, required_request_params, raw_path_params, description, security, deprecated =
15-
extract_request_attributes(request, example)
15+
extractor.request_attributes(request, example)
1616

1717
return if RSpec::OpenAPI.ignored_paths.any? { |ignored_path| path.match?(ignored_path) }
1818

@@ -69,71 +69,6 @@ def extract_headers(request, response)
6969
[request_headers, response_headers]
7070
end
7171

72-
def extract_request_attributes(request, example)
73-
metadata = example.metadata[:openapi] || {}
74-
summary = metadata[:summary] || RSpec::OpenAPI.summary_builder.call(example)
75-
tags = metadata[:tags] || RSpec::OpenAPI.tags_builder.call(example)
76-
operation_id = metadata[:operation_id]
77-
required_request_params = metadata[:required_request_params] || []
78-
security = metadata[:security]
79-
description = metadata[:description] || RSpec::OpenAPI.description_builder.call(example)
80-
deprecated = metadata[:deprecated]
81-
raw_path_params = request.path_parameters
82-
path = request.path
83-
if rails?
84-
# 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
85-
fixed_request = request.dup
86-
fixed_request.path_info = File.join(request.script_name, request.path_info) if request.script_name.present?
87-
88-
route, path = find_rails_route(fixed_request)
89-
raise "No route matched for #{fixed_request.request_method} #{fixed_request.path_info}" if route.nil?
90-
91-
path = path.delete_suffix('(.:format)')
92-
summary ||= route.requirements[:action]
93-
tags ||= [route.requirements[:controller]&.classify].compact
94-
# :controller and :action always exist. :format is added when routes is configured as such.
95-
# TODO: Use .except(:controller, :action, :format) when we drop support for Ruby 2.x
96-
raw_path_params = raw_path_params.slice(*(raw_path_params.keys - RSpec::OpenAPI.ignored_path_params))
97-
end
98-
summary ||= "#{request.method} #{path}"
99-
[path, summary, tags, operation_id, required_request_params, raw_path_params, description, security, deprecated]
100-
end
101-
102-
def extract_request_response(context)
103-
if rack_test?(context)
104-
request = ActionDispatch::Request.new(context.last_request.env)
105-
request.body.rewind if request.body.respond_to?(:rewind)
106-
response = ActionDispatch::TestResponse.new(*context.last_response.to_a)
107-
else
108-
request = context.request
109-
response = context.response
110-
end
111-
[request, response]
112-
end
113-
114-
def rails?
115-
defined?(Rails) && Rails.respond_to?(:application) && Rails.application
116-
end
117-
118-
def rack_test?(context)
119-
defined?(Rack::Test::Methods) && context.class < Rack::Test::Methods
120-
end
121-
122-
# @param [ActionDispatch::Request] request
123-
def find_rails_route(request, app: Rails.application, path_prefix: '')
124-
app.routes.router.recognize(request) do |route|
125-
path = route.path.spec.to_s
126-
if route.app.matches?(request)
127-
if route.app.engine?
128-
route, path = find_rails_route(request, app: route.app.app, path_prefix: path)
129-
next if route.nil?
130-
end
131-
return [route, path_prefix + path]
132-
end
133-
end
134-
nil
135-
end
136-
13772
# workaround to get real request parameters
13873
# because ActionController::ParamsWrapper overwrites request_parameters
13974
def raw_request_params(request)

‎lib/rspec/openapi/rspec_hooks.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
RSpec.configuration.after(:each) do |example|
66
if RSpec::OpenAPI.example_types.include?(example.metadata[:type]) && example.metadata[:openapi] != false
77
path = RSpec::OpenAPI.path.then { |p| p.is_a?(Proc) ? p.call(example) : p }
8-
record = RSpec::OpenAPI::RecordBuilder.build(self, example: example)
8+
record = RSpec::OpenAPI::RecordBuilder.build(self, example: example, extractor: SharedHooks.find_extractor)
99
RSpec::OpenAPI.path_records[path] << record if record
1010
end
1111
end

‎lib/rspec/openapi/shared_hooks.rb

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
module SharedHooks
2+
def self.find_extractor
3+
if defined?(Rails) && Rails.respond_to?(:application) && Rails.application
4+
RSpec::OpenAPI::Extractors::Rails
5+
elsif defined?(Hanami) && Hanami.respond_to?(:app) && Hanami.app?
6+
RSpec::OpenAPI::Extractors::Hanami
7+
# elsif defined?(Roda)
8+
# some Roda extractor
9+
else
10+
RSpec::OpenAPI::Extractors::Rack
11+
end
12+
end
13+
end

0 commit comments

Comments
 (0)