rails-param-validation 0.3.1 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 379a0af49ad44233f32c49a193e2eabae05b111330d93316c87d83968ea0693e
-  data.tar.gz: a0db01c2e6c16a1f0b1ed940d7c54d3c347fb46532119bc737dab460889a3b84
+  metadata.gz: 93474c2cebc9d9ea2ee438a37054a775bf70bd66af809b6b6ebecd1213b29d24
+  data.tar.gz: 3354b776b3f8e9d63551ed1d6e51c350a52eb9aef68eedbcdd5437ab570520de
 SHA512:
-  metadata.gz: 7d5b1a95b756da8407b90d8cc8acff4910aa3d3f81af2bdbd740b04fdc8defb38737eb09e60ed2c1a430c8b27b70db6dcad3c85d579b16809a7cb1230d1b08a6
-  data.tar.gz: 8f66b039139bf738674123a44168083fc94a6d00c2eee3255d2853e27746f98403a622ca9302accc92fd7f199f181a78e35e2d0d6392102e23ba45650f9d2b10
+  metadata.gz: dbf491a6d35b6c7bd6a230aabd4662e66ed40a522020ad55214fa1ef41909103f7e007e12f6aca01b27d0890684762305a6bab419662920ed5af109c5a998487
+  data.tar.gz: 9019f5b9aa9c753ae3de87a81a88ce5b2a74401ef9fde6b67708b2b24f5eb50b386641b9b6d95d0cfe21c5d0626b3b16673d996a4aa4f00df46d9e847f998c49

data/lib/rails-param-validation/rails/action_definition.rb

@@ -1,10 +1,10 @@
 module RailsParamValidation
 
   class ActionDefinition
-    attr_reader :params, :request_body_type, :paths, :responses, :controller, :action, :security
+    attr_reader :params, :request_body_type, :paths, :responses, :controller, :action, :security, :source_file
     attr_accessor :description
 
-    def initialize
+    def initialize(source_file)
       @params = {}
       @paths = []
       @param_validation_enabled = true
@@ -12,6 +12,7 @@ module RailsParamValidation
       @request_body_type = RailsParamValidation.config.default_body_content_type if defined?(Rails)
       @responses = {}
       @flags = {}
+      @source_file = source_file
       @security = []
     end
 
@@ -65,7 +66,10 @@ module RailsParamValidation
 
     def finalize!(class_name, method_name)
       @responses.each do |code, response|
-        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
+        name = Types::Namespace.with_namespace(
+            Types::Namespace.fetch(@source_file),
+            "#{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
+        )
         AnnotationTypes::CustomT.register(name, response[:schema])
 
         response.merge!(schema: AnnotationTypes::CustomT.new(name))

data/lib/rails-param-validation/rails/config.rb

@@ -31,6 +31,7 @@ module RailsParamValidation
     attr_accessor :default_body_content_type
     attr_accessor :default_action_flags
     attr_accessor :post_action_definition_hook
+    attr_accessor :auto_include_in_classes
     attr_reader   :openapi
 
     def initialize
@@ -41,6 +42,7 @@ module RailsParamValidation
       @default_body_content_type = 'application/json'
       @default_action_flags = {}
       @post_action_definition_hook = ->(_action_definition) {}
+      @auto_include_in_classes = %w[ActionController::Base ActionController::API]
     end
   end
 

data/lib/rails-param-validation/rails/extensions/annotation_extension.rb

@@ -94,7 +94,7 @@ module RailsParamValidation
       end
 
       def action(description = nil, flags = RailsParamValidation.config.default_action_flags)
-        @param_definition = ActionDefinition.new
+        @param_definition = ActionDefinition.new(Types::Namespace.caller_file)
         @param_definition.description = description
         flags.each { |name, value| @param_definition.add_flag name, value }
 

data/lib/rails-param-validation/rails/extensions/custom_type_extension.rb

@@ -6,7 +6,8 @@ module RailsParamValidation
 
     module ClassMethods
       def declare(type, schema)
-        RailsParamValidation::AnnotationTypes::CustomT.register type, schema
+        namespace = Types::Namespace.fetch(Types::Namespace.caller_file)
+        RailsParamValidation::AnnotationTypes::CustomT.register Types::Namespace.with_namespace(namespace, type), schema
       end
     end
   end

data/lib/rails-param-validation/rails/extensions/validation_extension.rb

@@ -6,6 +6,8 @@ module RailsParamValidation
 
     # The before_action function called which does the actual work
     def auto_validate_params!
+      @validated_parameters = nil
+
       # @type [ActionDefinition] definition
       definition = RailsParamValidation::AnnotationManager.instance.method_annotation self.class.name, action_name.to_sym, :param_definition
 

data/lib/rails-param-validation/rails/helper.rb

@@ -4,6 +4,11 @@ module RailsParamValidation
     def self.controller_to_tag(klass)
       (klass.is_a?(String) ? klass : klass.name).gsub(/Controller$/, '').to_sym
     end
+
+    def self.clean_controller_name(klass)
+      klass = klass.to_s if klass.is_a? Symbol
+      (klass.is_a?(String) ? klass : klass.name).gsub(/Controller$/, '').split('::').last.capitalize.to_sym
+    end
   end
 
 end

data/lib/rails-param-validation/rails/openapi/openapi.rb

@@ -25,7 +25,7 @@ module RailsParamValidation
         openapi: OPENAPI_VERSION,
         info: { version: @info[:version], title: @info[:title], description: @info[:description] },
         servers: @info[:url].map { |url| { url: url } },
-        tags: @tags.map { |tag, description| { name: tag, description: description } },
+        tags: @tags.map { |tag, description| { name: RailsHelper.clean_controller_name(tag), description: description } },
         paths: {},
         components: { schemas: {} }
       }
@@ -49,7 +49,7 @@ module RailsParamValidation
         RoutingHelper.routes_for(operation.controller.to_s.underscore, operation.action.to_s).each do |route|
           action_definition = {
               operationId: "#{route[:method].downcase}#{route[:path].split(/[^a-zA-Z0-9]+/).map(&:downcase).map(&:capitalize).join}",
-              tags: [operation.controller],
+              tags: [RailsHelper.clean_controller_name(operation.controller)],
               parameters: parameters,
               security: operation.security,
               responses: operation.responses.map do |status, values|
@@ -70,7 +70,10 @@ module RailsParamValidation
           action_definition.merge!(summary: operation.description) if operation.description.present?
 
           if body.any?
-            body_type_name = "#{operation.controller.capitalize}#{operation.action.capitalize}Body".to_sym
+            body_type_name = Types::Namespace.with_namespace(
+                Types::Namespace.fetch(operation.source_file),
+                "#{RailsHelper.clean_controller_name operation.controller}.#{operation.action.to_s.camelcase}.Body".to_sym
+            )
             AnnotationTypes::CustomT.register(body_type_name, body)
 
             action_definition[:requestBody] = {
@@ -104,7 +107,7 @@ module RailsParamValidation
         description = AnnotationManager.instance.class_annotation klass, :description
 
         if description
-          @tags[RailsHelper.controller_to_tag klass] = description
+          @tags[RailsHelper.controller_to_tag klass.constantize] = description
         end
 
         AnnotationManager.instance.methods(klass).each do |method|

data/lib/rails-param-validation/rails/rails.rb

@@ -17,15 +17,14 @@ module RailsParamValidation
 
     initializer 'rails_param_validation.action_controller_extension' do
       ActiveSupport.on_load(:action_controller) do
-        ActionController::Base.send :include, ActionControllerExtension
-        ActionController::Base.send :include, AnnotationExtension
-        ActionController::Base.send :include, CustomTypesExtension
-        ActionController::Base.send :extend, RailsParamValidation::Types
-
-        ActionController::API.send :include, ActionControllerExtension
-        ActionController::API.send :include, AnnotationExtension
-        ActionController::API.send :include, CustomTypesExtension
-        ActionController::API.send :extend, RailsParamValidation::Types
+        RailsParamValidation.config.auto_include_in_classes.each do |klass_name|
+          klass = klass_name.constantize
+
+          klass.send :include, ActionControllerExtension
+          klass.send :include, AnnotationExtension
+          klass.send :include, CustomTypesExtension
+          klass.send :extend, RailsParamValidation::Types
+        end
       end
     end
 

data/lib/rails-param-validation/types/types.rb

@@ -1,7 +1,10 @@
 module RailsParamValidation
 
 def self.register(type, schema)
-  AnnotationTypes::CustomT.register type, schema
+  AnnotationTypes::CustomT.register(
+      Namespace.with_namespace(Namespace.fetch(Namespace.caller_file), type),
+      schema
+  )
 end
 
 module AnnotationTypes
@@ -72,6 +75,58 @@ end
 end
 
 module Types
+  class Namespace
+    def self.store(scope, namespace)
+      map[scope] = namespace
+    end
+
+    def self.fetch(scope)
+      path = scope.split('/')
+
+      (path.size - 1).times do
+        key = path.join '/'
+        return map[key] if map.key? key
+
+        path.pop
+      end
+    end
+
+    def self.caller_file
+      caller_locations(2, 1)[0].path
+    end
+
+    def self.with_namespace(namespace, type)
+      if namespace
+        path = namespace.to_s.split('.')
+
+        while type.start_with?("_")
+          type = type[1..-1]
+          path.pop
+        end
+
+        "#{path.join(".")}.#{type}".to_sym
+      else
+        type
+      end
+    end
+
+    class << self
+      protected
+
+      def map
+        @map ||= { '' => nil }
+      end
+    end
+  end
+
+  def FileNamespace(namespace)
+    Namespace.store Namespace.caller_file, namespace
+  end
+
+  def DirectoryNamespace(namespace)
+    Namespace.store File.dirname(caller_locations(1, 1)[0].path), namespace
+  end
+
   def ArrayType(inner_type)
     AnnotationTypes::ArrayT.new(inner_type)
   end
@@ -85,7 +140,7 @@ module Types
   end
 
   def Type(type)
-    AnnotationTypes::CustomT.new(type)
+    AnnotationTypes::CustomT.new(Namespace.with_namespace(Namespace.fetch(Namespace.caller_file), type))
   end
 end
 

data/lib/rails-param-validation/validators/constant.rb

@@ -37,4 +37,4 @@ module RailsParamValidation
     end
   end
 
-end
+end

data/lib/rails-param-validation/version.rb

@@ -1,3 +1,3 @@
 module RailsParamValidation
-  VERSION = "0.3.1"
+  VERSION = "0.4.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-param-validation
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.3
 platform: ruby
 authors:
 - Oskar Kirmis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-29 00:00:00.000000000 Z
+date: 2020-08-14 00:00:00.000000000 Z
 dependencies: []
 description: Declarative parameter definition and validation for Rails
 email: