rails-param-validation 0.4.2 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea025e319c6a3d02b8781c6c80ffc068cb72b8d694e3dc1fc843656f2dd4b862
-  data.tar.gz: 9f1f786ec22824cb5ae9eaa8a33ef39d5a147ac9ed19d570e6414513cf418adf
+  metadata.gz: 7cac5e8e1680a9f3cbdce7cd511d39f4b95d0cddf9f2955e9bbbde3ff56daa5b
+  data.tar.gz: a2f4422840a284a0658fa9c241bcda19edbcf7ad3927bc94a79ec38178b86e5b
 SHA512:
-  metadata.gz: a2ec3191599ac5b8fa5a4dbcf7684759de23a129be732e90275298b358e9d84d53cb653225413cadc229ad03b1e9baecac9dbce2e2269b1d8b9e8344a21b3fff
-  data.tar.gz: 980cf1cde5a0d0500da47c4eb69ec514a28c0da4eb769b13d23d443f63d5587faf915c23705b6178c02817d6665bda3249cc1862bcc1c10093e04b6d1c7514d9
+  metadata.gz: 5f1a29d5ed1039772184372c44073af3104cf4acc7d8f9299c561891dcb71f877ef937617fe91776919fd32021e7bc67e69a53f3e78c27e098520376d1ea2466
+  data.tar.gz: e49a9586e8446164a580e4143f8af1dfaa2f04228d102e6ce00b1fb21bc9ddac36c8885b92df5064768439a136bf74d9ff8f1674787f4bf70b605f64ecd6ff6e

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

@@ -64,7 +64,11 @@ module RailsParamValidation
       @paths.push(method: method, path: path)
     end
 
-    def finalize!(class_name, method_name)
+    def finalize!(class_name, method_name, base_path)
+      @paths.each do |path|
+        path[:path] = ("/#{base_path}/#{path[:path]}").gsub(/\/+$/, "").gsub(/\/{2,}/, '/')
+      end
+
       @responses.each do |code, response|
         name = Types::Namespace.with_namespace(
             Types::Namespace.fetch(@source_file),

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

@@ -23,7 +23,7 @@ module RailsParamValidation
 
           @param_definition.store_origin! class_name, method_name
           RailsParamValidation.config.post_action_definition_hook.call(@param_definition)
-          @param_definition.finalize! class_name, method_name
+          @param_definition.finalize! class_name, method_name, (@base_paths || {}).fetch(self.name, self.name.underscore)
 
           AnnotationManager.instance.annotate_method! self, name, :param_definition, @param_definition
           @param_definition = nil
@@ -38,6 +38,11 @@ module RailsParamValidation
     end
 
     module ClassMethods
+      def base_path(path)
+        @base_paths ||= {}
+        @base_paths[self.name] = path
+      end
+
       def param_definition
         @param_definition || raise(StandardError.new "Annotation must be part of an operation-block")
       end
@@ -94,10 +99,23 @@ module RailsParamValidation
       end
 
       def action(description = nil, flags = RailsParamValidation.config.default_action_flags)
+        if description.is_a?(Hash)
+          method = description.keys.first.to_sym
+          path = description.values.first
+          description = ""
+        else
+          method = nil
+          path = nil
+        end
+
         @param_definition = ActionDefinition.new(Types::Namespace.caller_file)
         @param_definition.description = description
         flags.each { |name, value| @param_definition.add_flag name, value }
 
+        if method
+          @param_definition.add_path method, path
+        end
+
         yield
       end
     end

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

@@ -7,7 +7,12 @@ module RailsParamValidation
 
     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
+      (klass.is_a?(String) ? klass : klass.name).gsub(/Controller$/, '').split("::").join(".").to_sym
+    end
+
+    def self.clean_name(klass)
+      klass = klass.to_s if klass.is_a? Symbol
+      (klass.is_a?(String) ? klass : klass.name).split("::").join(".").to_sym
     end
   end
 

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

@@ -46,7 +46,7 @@ module RailsParamValidation
           param_definition
         end
 
-        RoutingHelper.routes_for(operation.controller.to_s.underscore, operation.action.to_s).each do |route|
+        (operation.paths.any? ? operation.paths : 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: [RailsHelper.clean_controller_name(operation.controller)],

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/rails/tasks/openapi.rake

@@ -1,6 +1,6 @@
 namespace :openapi do
 
-  desc "Export OpenAPI definition to openapi.yaml"
+  desc "Export OpenAPI definition to openapi.json"
   task export: :environment do
     # Ensure all controllers are loaded
     if defined? Zeitwerk
@@ -22,7 +22,7 @@ namespace :openapi do
     print "Writing #{filename}..."
 
     begin
-      File.open(filename, "w") { |f| f.write YAML.dump(openapi.to_object) }
+      File.open(filename, "w") { |f| f.write JSON.pretty_generate(openapi.to_object) }
       puts " done."
     rescue Exception => e
       puts " failed."

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

@@ -2,7 +2,7 @@ module RailsParamValidation
 
 def self.register(type, schema)
   AnnotationTypes::CustomT.register(
-      Namespace.with_namespace(Namespace.fetch(Namespace.caller_file), type),
+      Types::Namespace.with_namespace(Types::Namespace.fetch(Types::Namespace.caller_file), type),
       schema
   )
 end
@@ -89,6 +89,8 @@ module Types
 
         path.pop
       end
+
+      nil
     end
 
     def self.caller_file
@@ -140,7 +142,11 @@ module Types
   end
 
   def Type(type)
-    AnnotationTypes::CustomT.new(Namespace.with_namespace(Namespace.fetch(Namespace.caller_file), type))
+    if type.is_a?(Class)
+      AnnotationTypes::CustomT.new(RailsHelper.clean_name(type))
+    else
+      AnnotationTypes::CustomT.new(Namespace.with_namespace(Namespace.fetch(Namespace.caller_file), type))
+    end
   end
 end
 

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

@@ -6,11 +6,6 @@ module RailsParamValidation
     end
 
     def matches?(path, data)
-      if schema.schema.is_a? NilClass
-        puts path
-        puts schema.inspect
-      end
-
       ValidatorFactory.create(schema.schema).matches? path, data
     end
 
@@ -29,4 +24,4 @@ module RailsParamValidation
     end
   end
 
-end
+end

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

@@ -1,3 +1,3 @@
 module RailsParamValidation
-  VERSION = "0.4.2"
+  VERSION = "0.4.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-param-validation
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.5
 platform: ruby
 authors:
 - Oskar Kirmis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-04 00:00:00.000000000 Z
+date: 2022-04-19 00:00:00.000000000 Z
 dependencies: []
 description: Declarative parameter definition and validation for Rails
 email:
@@ -93,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.11
 signing_key: 
 specification_version: 4
 summary: Declarative parameter definition and validation for Rails