rails-param-validation 0.3.0 → 0.4.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1e81185301762be6703608dfc575c27813c49fde9969057c0b821c7cc78f7680
4
- data.tar.gz: 5c3c75f3d2a8e6275d1c794540d972e62b13ada2592a5602ca71bb80794d6f05
3
+ metadata.gz: ea025e319c6a3d02b8781c6c80ffc068cb72b8d694e3dc1fc843656f2dd4b862
4
+ data.tar.gz: 9f1f786ec22824cb5ae9eaa8a33ef39d5a147ac9ed19d570e6414513cf418adf
5
5
  SHA512:
6
- metadata.gz: 1af2e48e2ef3d6af489e009177839378b5e19b8817a456a9cb1e399e525b2a974d52ed1986a321c44035248c527d8ef1b7711de0e175252791a12567a8bd98da
7
- data.tar.gz: b4528b9e92d0c7079cced511255760766771ba6b6f9e5f013d8f1049bdf1fce6f10f86750760bae7ebb12d53ce66b027d18d4228c7dd953d5f1e6fa70af60979
6
+ metadata.gz: a2ec3191599ac5b8fa5a4dbcf7684759de23a129be732e90275298b358e9d84d53cb653225413cadc229ad03b1e9baecac9dbce2e2269b1d8b9e8344a21b3fff
7
+ data.tar.gz: 980cf1cde5a0d0500da47c4eb69ec514a28c0da4eb769b13d23d443f63d5587faf915c23705b6178c02817d6665bda3249cc1862bcc1c10093e04b6d1c7514d9
@@ -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 = "#{class_name.to_s.capitalize}#{method_name.to_s.camelcase}#{Rack::Utils::SYMBOL_TO_STATUS_CODE.key(code).to_s.camelize}Response".to_sym
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))
@@ -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
- RailsParamValidation::AnnotationTypes::CustomT.register type, schema
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 = "#{operation.controller.capitalize}#{operation.action.capitalize}Body".to_sym
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|
@@ -1,7 +1,10 @@
1
1
  module RailsParamValidation
2
2
 
3
3
  def self.register(type, schema)
4
- AnnotationTypes::CustomT.register type, schema
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
 
@@ -1,6 +1,8 @@
1
1
  module RailsParamValidation
2
2
 
3
3
  class ConstantValidator < Validator
4
+ CLASS_MAP = { TrueClass => Boolean, FalseClass => Boolean }
5
+
4
6
  def initialize(schema)
5
7
  super schema
6
8
 
@@ -21,7 +23,7 @@ module RailsParamValidation
21
23
  end
22
24
 
23
25
  def to_openapi
24
- ValidatorFactory.create(schema.class).to_openapi.merge(enum: [schema])
26
+ ValidatorFactory.create(CLASS_MAP.fetch(schema.class, schema.class)).to_openapi.merge(enum: [schema])
25
27
  end
26
28
  end
27
29
 
@@ -6,6 +6,11 @@ module RailsParamValidation
6
6
  end
7
7
 
8
8
  def matches?(path, data)
9
+ if schema.schema.is_a? NilClass
10
+ puts path
11
+ puts schema.inspect
12
+ end
13
+
9
14
  ValidatorFactory.create(schema.schema).matches? path, data
10
15
  end
11
16
 
@@ -24,4 +29,4 @@ module RailsParamValidation
24
29
  end
25
30
  end
26
31
 
27
- end
32
+ end
@@ -1,3 +1,3 @@
1
1
  module RailsParamValidation
2
- VERSION = "0.3.0"
2
+ VERSION = "0.4.2"
3
3
  end
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.0
4
+ version: 0.4.2
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-07-27 00:00:00.000000000 Z
11
+ date: 2020-08-04 00:00:00.000000000 Z
12
12
  dependencies: []
13
13
  description: Declarative parameter definition and validation for Rails
14
14
  email:
@@ -93,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
93
93
  - !ruby/object:Gem::Version
94
94
  version: '0'
95
95
  requirements: []
96
- rubygems_version: 3.0.2
96
+ rubygems_version: 3.1.2
97
97
  signing_key:
98
98
  specification_version: 4
99
99
  summary: Declarative parameter definition and validation for Rails