/
move_params.rb
211 lines (164 loc) · 6.7 KB
/
move_params.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# frozen_string_literal: true
require 'active_support/core_ext/hash/deep_merge'
module GrapeSwagger
module DocMethods
class MoveParams
class << self
attr_accessor :definitions
def can_be_moved?(http_verb, params)
move_methods.include?(http_verb) && includes_body_param?(params)
end
def to_definition(path, params, route, definitions)
@definitions = definitions
unify!(params)
params_to_move = movable_params(params)
return (params + correct_array_param(params_to_move)) if should_correct_array?(params_to_move)
params << parent_definition_of_params(params_to_move, path, route)
params
end
private
def should_correct_array?(param)
param.length == 1 && param.first[:in] == 'body' && param.first[:type] == 'array'
end
def correct_array_param(param)
param.first[:schema] = { type: param.first.delete(:type), items: param.first.delete(:items) }
param
end
def parent_definition_of_params(params, path, route)
definition_name = OperationId.manipulate(parse_model(path))
referenced_definition = build_definition(definition_name, params, route.request_method.downcase)
definition = @definitions[referenced_definition]
move_params_to_new(definition, params)
definition[:description] = route.description if route.try(:description)
build_body_parameter(referenced_definition, definition_name, route.options)
end
def move_params_to_new(definition, params)
params, nested_params = params.partition { |x| !x[:name].to_s.include?('[') }
params.each do |param|
property = param[:name]
param_properties, param_required = build_properties([param])
add_properties_to_definition(definition, param_properties, param_required)
related_nested_params, nested_params = nested_params.partition { |x| x[:name].start_with?("#{property}[") }
prepare_nested_names(property, related_nested_params)
next if related_nested_params.blank?
nested_definition = if should_expose_as_array?([param])
move_params_to_new(array_type, related_nested_params)
else
move_params_to_new(object_type, related_nested_params)
end
if definition.key?(:items)
definition[:items][:properties][property.to_sym].deep_merge!(nested_definition)
else
definition[:properties][property.to_sym].deep_merge!(nested_definition)
end
end
definition
end
def build_properties(params)
properties = {}
required = []
params.each do |param|
name = param[:name].to_sym
properties[name] = if should_expose_as_array?([param])
document_as_array(param)
else
document_as_property(param)
end
required << name if deletable?(param) && param[:required]
end
[properties, required]
end
def document_as_array(param)
{}.tap do |property|
property[:type] = 'array'
property[:description] = param.delete(:description) unless param[:description].nil?
property[:items] = document_as_property(param)[:items]
end
end
def document_as_property(param)
property_keys.each_with_object({}) do |x, memo|
value = param[x]
next if value.blank?
if x == :type && @definitions[value].present?
memo['$ref'] = "#/definitions/#{value}"
else
memo[x] = value
end
end
end
def movable_params(params)
to_delete = params.each_with_object([]) { |x, memo| memo << x if deletable?(x) }
delete_from(params, to_delete)
to_delete
end
def delete_from(params, to_delete)
to_delete.each { |x| params.delete(x) }
end
def add_properties_to_definition(definition, properties, required)
if definition.key?(:items)
definition[:items][:properties].deep_merge!(properties)
add_to_required(definition[:items], required)
else
definition[:properties].deep_merge!(properties)
add_to_required(definition, required)
end
end
def add_to_required(definition, value)
return if value.blank?
definition[:required] ||= []
definition[:required].push(*value)
end
def build_body_parameter(reference, name, options)
{}.tap do |x|
x[:name] = options[:body_name] || name
x[:in] = 'body'
x[:required] = true
x[:schema] = { '$ref' => "#/definitions/#{reference}" }
end
end
def build_definition(name, params, verb = nil)
name = "#{verb}#{name}" if verb
@definitions[name] = should_expose_as_array?(params) ? array_type : object_type
name
end
def array_type
{ type: 'array', items: { type: 'object', properties: {} } }
end
def object_type
{ type: 'object', properties: {} }
end
def prepare_nested_names(property, params)
params.each { |x| x[:name] = x[:name].sub(property, '').sub('[', '').sub(']', '') }
end
def unify!(params)
params.each { |x| x[:in] = x.delete(:param_type) if x[:param_type] }
params.each { |x| x[:in] = 'body' if x[:in] == 'formData' } if includes_body_param?(params)
end
def parse_model(ref)
parts = ref.split('/')
parts.last.include?('{') ? parts[0..-2].join('/') : parts[0..-1].join('/')
end
def property_keys
%i[type format description minimum maximum items enum default additionalProperties]
end
def deletable?(param)
param[:in] == 'body'
end
def move_methods
[:post, :put, :patch, 'POST', 'PUT', 'PATCH']
end
def includes_body_param?(params)
params.map { |x| return true if x[:in] == 'body' || x[:param_type] == 'body' }
false
end
def should_expose_as_array?(params)
should_exposed_as(params) == 'array'
end
def should_exposed_as(params)
params.map { |x| return 'object' if x[:type] && x[:type] != 'array' }
'array'
end
end
end
end
end