rails-param-validation 0.4.3 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93474c2cebc9d9ea2ee438a37054a775bf70bd66af809b6b6ebecd1213b29d24
-  data.tar.gz: 3354b776b3f8e9d63551ed1d6e51c350a52eb9aef68eedbcdd5437ab570520de
+  metadata.gz: 45f982e8976d083082c29971f2b4deef210958452f473836f9436a1af1826636
+  data.tar.gz: 72ddb69843370c35b464b2aedb15ea65f377b86302c3f4e47ab4ea0226f13d38
 SHA512:
-  metadata.gz: dbf491a6d35b6c7bd6a230aabd4662e66ed40a522020ad55214fa1ef41909103f7e007e12f6aca01b27d0890684762305a6bab419662920ed5af109c5a998487
-  data.tar.gz: 9019f5b9aa9c753ae3de87a81a88ce5b2a74401ef9fde6b67708b2b24f5eb50b386641b9b6d95d0cfe21c5d0626b3b16673d996a4aa4f00df46d9e847f998c49
+  metadata.gz: ed86c39b631c509f08e16f1f1fd054255ade51d98ff5ec10bc16c94a5deebd4ee1d01c07a9f7cfa5a3d15c5be1d1eab91a9460888cd8c5ab39010e62ed888e42
+  data.tar.gz: c500dd124663f480ce19832e3d7d766318b0b0be5c55a0f38ed71ebdae786a752a8b94fa3fb052a16e87542d103763546def758f968b21cee928371d3e6e2100

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.gsub(/Controller$/, "").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)],
@@ -67,7 +67,19 @@ module RailsParamValidation
               end.to_h
           }
 
-          action_definition.merge!(summary: operation.description) if operation.description.present?
+          param_documentation = operation
+                                  .params
+                                  .filter { |_, v| v[:description].present? }
+                                  .map { |name, param| "* `#{name}`<br />#{param[:description]}" }
+                                  .join("\n\n")
+
+          if param_documentation.present?
+            param_documentation = "**Parameters**\n#{param_documentation}"
+          end
+
+          if param_documentation.present? || operation.description.present?
+            action_definition.merge!(description: "#{operation.description}\n\n#{param_documentation}".strip)
+          end
 
           if body.any?
             body_type_name = Types::Namespace.with_namespace(

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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-param-validation
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.6
 platform: ruby
 authors:
 - Oskar Kirmis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-14 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.0.2
+rubygems_version: 3.3.11
 signing_key: 
 specification_version: 4
 summary: Declarative parameter definition and validation for Rails