rails-param-validation 0.3.1 → 0.4.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/rails-param-validation/rails/action_definition.rb +7 -3
- data/lib/rails-param-validation/rails/config.rb +2 -0
- data/lib/rails-param-validation/rails/extensions/annotation_extension.rb +1 -1
- data/lib/rails-param-validation/rails/extensions/custom_type_extension.rb +2 -1
- data/lib/rails-param-validation/rails/extensions/validation_extension.rb +2 -0
- data/lib/rails-param-validation/rails/helper.rb +5 -0
- data/lib/rails-param-validation/rails/openapi/openapi.rb +7 -4
- data/lib/rails-param-validation/rails/rails.rb +8 -9
- data/lib/rails-param-validation/types/types.rb +57 -2
- data/lib/rails-param-validation/validators/constant.rb +1 -1
- data/lib/rails-param-validation/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 93474c2cebc9d9ea2ee438a37054a775bf70bd66af809b6b6ebecd1213b29d24
|
4
|
+
data.tar.gz: 3354b776b3f8e9d63551ed1d6e51c350a52eb9aef68eedbcdd5437ab570520de
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: dbf491a6d35b6c7bd6a230aabd4662e66ed40a522020ad55214fa1ef41909103f7e007e12f6aca01b27d0890684762305a6bab419662920ed5af109c5a998487
|
7
|
+
data.tar.gz: 9019f5b9aa9c753ae3de87a81a88ce5b2a74401ef9fde6b67708b2b24f5eb50b386641b9b6d95d0cfe21c5d0626b3b16673d996a4aa4f00df46d9e847f998c49
|
@@ -1,10 +1,10 @@
|
|
1
1
|
module RailsParamValidation
|
2
2
|
|
3
3
|
class ActionDefinition
|
4
|
-
attr_reader :params, :request_body_type, :paths, :responses, :controller, :action, :security
|
4
|
+
attr_reader :params, :request_body_type, :paths, :responses, :controller, :action, :security, :source_file
|
5
5
|
attr_accessor :description
|
6
6
|
|
7
|
-
def initialize
|
7
|
+
def initialize(source_file)
|
8
8
|
@params = {}
|
9
9
|
@paths = []
|
10
10
|
@param_validation_enabled = true
|
@@ -12,6 +12,7 @@ module RailsParamValidation
|
|
12
12
|
@request_body_type = RailsParamValidation.config.default_body_content_type if defined?(Rails)
|
13
13
|
@responses = {}
|
14
14
|
@flags = {}
|
15
|
+
@source_file = source_file
|
15
16
|
@security = []
|
16
17
|
end
|
17
18
|
|
@@ -65,7 +66,10 @@ module RailsParamValidation
|
|
65
66
|
|
66
67
|
def finalize!(class_name, method_name)
|
67
68
|
@responses.each do |code, response|
|
68
|
-
name =
|
69
|
+
name = Types::Namespace.with_namespace(
|
70
|
+
Types::Namespace.fetch(@source_file),
|
71
|
+
"#{RailsHelper.clean_controller_name(class_name)}.#{method_name.to_s.camelcase}.#{Rack::Utils::SYMBOL_TO_STATUS_CODE.key(code).to_s.camelize}Response".to_sym
|
72
|
+
)
|
69
73
|
AnnotationTypes::CustomT.register(name, response[:schema])
|
70
74
|
|
71
75
|
response.merge!(schema: AnnotationTypes::CustomT.new(name))
|
@@ -31,6 +31,7 @@ module RailsParamValidation
|
|
31
31
|
attr_accessor :default_body_content_type
|
32
32
|
attr_accessor :default_action_flags
|
33
33
|
attr_accessor :post_action_definition_hook
|
34
|
+
attr_accessor :auto_include_in_classes
|
34
35
|
attr_reader :openapi
|
35
36
|
|
36
37
|
def initialize
|
@@ -41,6 +42,7 @@ module RailsParamValidation
|
|
41
42
|
@default_body_content_type = 'application/json'
|
42
43
|
@default_action_flags = {}
|
43
44
|
@post_action_definition_hook = ->(_action_definition) {}
|
45
|
+
@auto_include_in_classes = %w[ActionController::Base ActionController::API]
|
44
46
|
end
|
45
47
|
end
|
46
48
|
|
@@ -94,7 +94,7 @@ module RailsParamValidation
|
|
94
94
|
end
|
95
95
|
|
96
96
|
def action(description = nil, flags = RailsParamValidation.config.default_action_flags)
|
97
|
-
@param_definition = ActionDefinition.new
|
97
|
+
@param_definition = ActionDefinition.new(Types::Namespace.caller_file)
|
98
98
|
@param_definition.description = description
|
99
99
|
flags.each { |name, value| @param_definition.add_flag name, value }
|
100
100
|
|
@@ -6,7 +6,8 @@ module RailsParamValidation
|
|
6
6
|
|
7
7
|
module ClassMethods
|
8
8
|
def declare(type, schema)
|
9
|
-
|
9
|
+
namespace = Types::Namespace.fetch(Types::Namespace.caller_file)
|
10
|
+
RailsParamValidation::AnnotationTypes::CustomT.register Types::Namespace.with_namespace(namespace, type), schema
|
10
11
|
end
|
11
12
|
end
|
12
13
|
end
|
@@ -6,6 +6,8 @@ module RailsParamValidation
|
|
6
6
|
|
7
7
|
# The before_action function called which does the actual work
|
8
8
|
def auto_validate_params!
|
9
|
+
@validated_parameters = nil
|
10
|
+
|
9
11
|
# @type [ActionDefinition] definition
|
10
12
|
definition = RailsParamValidation::AnnotationManager.instance.method_annotation self.class.name, action_name.to_sym, :param_definition
|
11
13
|
|
@@ -4,6 +4,11 @@ module RailsParamValidation
|
|
4
4
|
def self.controller_to_tag(klass)
|
5
5
|
(klass.is_a?(String) ? klass : klass.name).gsub(/Controller$/, '').to_sym
|
6
6
|
end
|
7
|
+
|
8
|
+
def self.clean_controller_name(klass)
|
9
|
+
klass = klass.to_s if klass.is_a? Symbol
|
10
|
+
(klass.is_a?(String) ? klass : klass.name).gsub(/Controller$/, '').split('::').last.capitalize.to_sym
|
11
|
+
end
|
7
12
|
end
|
8
13
|
|
9
14
|
end
|
@@ -25,7 +25,7 @@ module RailsParamValidation
|
|
25
25
|
openapi: OPENAPI_VERSION,
|
26
26
|
info: { version: @info[:version], title: @info[:title], description: @info[:description] },
|
27
27
|
servers: @info[:url].map { |url| { url: url } },
|
28
|
-
tags: @tags.map { |tag, description| { name: tag, description: description } },
|
28
|
+
tags: @tags.map { |tag, description| { name: RailsHelper.clean_controller_name(tag), description: description } },
|
29
29
|
paths: {},
|
30
30
|
components: { schemas: {} }
|
31
31
|
}
|
@@ -49,7 +49,7 @@ module RailsParamValidation
|
|
49
49
|
RoutingHelper.routes_for(operation.controller.to_s.underscore, operation.action.to_s).each do |route|
|
50
50
|
action_definition = {
|
51
51
|
operationId: "#{route[:method].downcase}#{route[:path].split(/[^a-zA-Z0-9]+/).map(&:downcase).map(&:capitalize).join}",
|
52
|
-
tags: [operation.controller],
|
52
|
+
tags: [RailsHelper.clean_controller_name(operation.controller)],
|
53
53
|
parameters: parameters,
|
54
54
|
security: operation.security,
|
55
55
|
responses: operation.responses.map do |status, values|
|
@@ -70,7 +70,10 @@ module RailsParamValidation
|
|
70
70
|
action_definition.merge!(summary: operation.description) if operation.description.present?
|
71
71
|
|
72
72
|
if body.any?
|
73
|
-
body_type_name =
|
73
|
+
body_type_name = Types::Namespace.with_namespace(
|
74
|
+
Types::Namespace.fetch(operation.source_file),
|
75
|
+
"#{RailsHelper.clean_controller_name operation.controller}.#{operation.action.to_s.camelcase}.Body".to_sym
|
76
|
+
)
|
74
77
|
AnnotationTypes::CustomT.register(body_type_name, body)
|
75
78
|
|
76
79
|
action_definition[:requestBody] = {
|
@@ -104,7 +107,7 @@ module RailsParamValidation
|
|
104
107
|
description = AnnotationManager.instance.class_annotation klass, :description
|
105
108
|
|
106
109
|
if description
|
107
|
-
@tags[RailsHelper.controller_to_tag klass] = description
|
110
|
+
@tags[RailsHelper.controller_to_tag klass.constantize] = description
|
108
111
|
end
|
109
112
|
|
110
113
|
AnnotationManager.instance.methods(klass).each do |method|
|
@@ -17,15 +17,14 @@ module RailsParamValidation
|
|
17
17
|
|
18
18
|
initializer 'rails_param_validation.action_controller_extension' do
|
19
19
|
ActiveSupport.on_load(:action_controller) do
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
ActionController::API.send :extend, RailsParamValidation::Types
|
20
|
+
RailsParamValidation.config.auto_include_in_classes.each do |klass_name|
|
21
|
+
klass = klass_name.constantize
|
22
|
+
|
23
|
+
klass.send :include, ActionControllerExtension
|
24
|
+
klass.send :include, AnnotationExtension
|
25
|
+
klass.send :include, CustomTypesExtension
|
26
|
+
klass.send :extend, RailsParamValidation::Types
|
27
|
+
end
|
29
28
|
end
|
30
29
|
end
|
31
30
|
|
@@ -1,7 +1,10 @@
|
|
1
1
|
module RailsParamValidation
|
2
2
|
|
3
3
|
def self.register(type, schema)
|
4
|
-
AnnotationTypes::CustomT.register
|
4
|
+
AnnotationTypes::CustomT.register(
|
5
|
+
Namespace.with_namespace(Namespace.fetch(Namespace.caller_file), type),
|
6
|
+
schema
|
7
|
+
)
|
5
8
|
end
|
6
9
|
|
7
10
|
module AnnotationTypes
|
@@ -72,6 +75,58 @@ end
|
|
72
75
|
end
|
73
76
|
|
74
77
|
module Types
|
78
|
+
class Namespace
|
79
|
+
def self.store(scope, namespace)
|
80
|
+
map[scope] = namespace
|
81
|
+
end
|
82
|
+
|
83
|
+
def self.fetch(scope)
|
84
|
+
path = scope.split('/')
|
85
|
+
|
86
|
+
(path.size - 1).times do
|
87
|
+
key = path.join '/'
|
88
|
+
return map[key] if map.key? key
|
89
|
+
|
90
|
+
path.pop
|
91
|
+
end
|
92
|
+
end
|
93
|
+
|
94
|
+
def self.caller_file
|
95
|
+
caller_locations(2, 1)[0].path
|
96
|
+
end
|
97
|
+
|
98
|
+
def self.with_namespace(namespace, type)
|
99
|
+
if namespace
|
100
|
+
path = namespace.to_s.split('.')
|
101
|
+
|
102
|
+
while type.start_with?("_")
|
103
|
+
type = type[1..-1]
|
104
|
+
path.pop
|
105
|
+
end
|
106
|
+
|
107
|
+
"#{path.join(".")}.#{type}".to_sym
|
108
|
+
else
|
109
|
+
type
|
110
|
+
end
|
111
|
+
end
|
112
|
+
|
113
|
+
class << self
|
114
|
+
protected
|
115
|
+
|
116
|
+
def map
|
117
|
+
@map ||= { '' => nil }
|
118
|
+
end
|
119
|
+
end
|
120
|
+
end
|
121
|
+
|
122
|
+
def FileNamespace(namespace)
|
123
|
+
Namespace.store Namespace.caller_file, namespace
|
124
|
+
end
|
125
|
+
|
126
|
+
def DirectoryNamespace(namespace)
|
127
|
+
Namespace.store File.dirname(caller_locations(1, 1)[0].path), namespace
|
128
|
+
end
|
129
|
+
|
75
130
|
def ArrayType(inner_type)
|
76
131
|
AnnotationTypes::ArrayT.new(inner_type)
|
77
132
|
end
|
@@ -85,7 +140,7 @@ module Types
|
|
85
140
|
end
|
86
141
|
|
87
142
|
def Type(type)
|
88
|
-
AnnotationTypes::CustomT.new(type)
|
143
|
+
AnnotationTypes::CustomT.new(Namespace.with_namespace(Namespace.fetch(Namespace.caller_file), type))
|
89
144
|
end
|
90
145
|
end
|
91
146
|
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: rails-param-validation
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.3
|
4
|
+
version: 0.4.3
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Oskar Kirmis
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-
|
11
|
+
date: 2020-08-14 00:00:00.000000000 Z
|
12
12
|
dependencies: []
|
13
13
|
description: Declarative parameter definition and validation for Rails
|
14
14
|
email:
|