rails-param-validation 0.4.4 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee538fffc925cb6a1c60304d98c741b7bc5e2397e6144e3dc67a05249c94cf06
-  data.tar.gz: 76d69f62b3cc38cdbd84018c110e7c80e5ac94889338bd18aaf9b078c10912b8
+  metadata.gz: f08d88f808fa165c2d4ffae550d8c4eb6d7a69904ec8f159a29562307a072cf9
+  data.tar.gz: 5335b9a61723376dd56bc09182506c20536bb94cad4630a0380103e65610017c
 SHA512:
-  metadata.gz: 6279e2439b9d4065be253fba5c2d5a7604631808b844c1f1c0f5339709442ba4eb088ad18492271d353dd4a03055e2860faaf1ebd17ce2922334beb479ef6f95
-  data.tar.gz: 672919b2153bb4e3409f9dadbe3a6696f3c9d6f48c3fd9f982064d50f07ed614b3b5c4b0ef5aa7eb5a2a5b76297877d22d89431d1b263cc083a87132b5928ef7
+  metadata.gz: e44809c8f21e77aa4f988cf1317b7f4c4ec312db72e9d239e70544596bbf51bc28007cbd16cb07dffe537ad3762dae09584ff14294afeebffb5a5919d9ef3f82
+  data.tar.gz: ad5241ed4bdaeac88b8416fb1bb63725bf4c2d83c31068425976f5ae527d955fc5b71e8993f2125b8441423ebe63e694044c850a0ed750f98a66a53e7bdecc89

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/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/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

@@ -50,7 +50,10 @@ class CustomT < AnnotationT
   end
 
   def schema
-    CustomT.registry[@type]
+    schema = CustomT.registry[@type]
+    schema = CustomT.registry[@type] = schema.call if schema.is_a?(Proc)
+
+    schema
   end
 
   def self.register(type, schema)
@@ -89,6 +92,8 @@ module Types
 
         path.pop
       end
+
+      nil
     end
 
     def self.caller_file
@@ -140,7 +145,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/version.rb

@@ -1,3 +1,3 @@
 module RailsParamValidation
-  VERSION = "0.4.4"
+  VERSION = "0.4.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-param-validation
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.7
 platform: ruby
 authors:
 - Oskar Kirmis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-07 00:00:00.000000000 Z
+date: 2022-04-21 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.3.7
+rubygems_version: 3.3.12
 signing_key: 
 specification_version: 4
 summary: Declarative parameter definition and validation for Rails