openapi_first 3.3.1 → 3.4.1

data/lib/openapi_first/test/observe.rb

@@ -6,7 +6,7 @@ module OpenapiFirst
   module Test
     class ObserveError < Error; end
 
-    # @visible private
+    # @visibility private
     module Observed; end
 
     # Inject silent request/response validation to observe rack apps during testing

data/lib/openapi_first/test.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'logger'
 require_relative 'test/configuration'
 require_relative 'registry'
 
@@ -30,6 +31,10 @@ module OpenapiFirst
       super.empty? ? OpenapiFirst.definitions : super
     end
 
+    def self.logger
+      configuration.logger
+    end
+
     def self.configuration
       @configuration ||= Configuration.new
     end
@@ -72,8 +77,8 @@ module OpenapiFirst
       return unless configuration.report_coverage
 
       report_coverage(
-        formatter: configuration.coverage_formatter,
-        **configuration.coverage_formatter_options
+        reporter: configuration.coverage_reporter,
+        **configuration.coverage_reporter_options
       )
       return unless configuration.report_coverage == true
 
@@ -86,10 +91,15 @@ module OpenapiFirst
     end
 
     # Print the coverage report
-    # @param formatter A formatter to define the report.
-    # @output [IO] An output where to puts the report.
-    def self.report_coverage(formatter: Coverage::TerminalFormatter, **)
-      puts formatter.new(**).format(Coverage.result)
+    # @param reporter A reporter class to render the report.
+    # @param formatter @deprecated Alias for `reporter:`.
+    # @return [IO] An output where to puts the report.
+    def self.report_coverage(reporter: Coverage::TerminalReporter, formatter: nil, **)
+      if formatter
+        warn 'DEPRECATION WARNING: Test.report_coverage(formatter:) is deprecated, use reporter: instead.'
+        reporter = formatter
+      end
+      reporter.new(**).report(Coverage.result)
     end
 
     # Returns the Rack app wrapped with silent request, response validation

data/lib/openapi_first/validators/request_body.rb

@@ -11,14 +11,15 @@ module OpenapiFirst
       def call(parsed_request)
         body = parsed_request.body
         if body.nil?
-          Failure.fail!(:invalid_body, message: 'Request body must not be empty') if @required
+          return Failure.new(:invalid_body, message: 'Request body must not be empty') if @required
+
           return
         end
 
         validation = Schema::ValidationResult.new(
           @schema.validate(body, access_mode: 'write')
         )
-        Failure.fail!(:invalid_body, errors: validation.errors) if validation.error?
+        Failure.new(:invalid_body, errors: validation.errors) if validation.error?
       end
     end
   end

data/lib/openapi_first/validators/request_parameters.rb

@@ -6,28 +6,28 @@ module OpenapiFirst
       RequestHeaders = Data.define(:schema) do
         def call(parsed_request)
           validation = schema.validate(parsed_request.headers)
-          Failure.fail!(:invalid_header, errors: validation.errors) if validation.error?
+          Failure.new(:invalid_header, errors: validation.errors) if validation.error?
         end
       end
 
       Path = Data.define(:schema) do
         def call(parsed_request)
           validation = schema.validate(parsed_request.path)
-          Failure.fail!(:invalid_path, errors: validation.errors) if validation.error?
+          Failure.new(:invalid_path, errors: validation.errors) if validation.error?
         end
       end
 
       Query = Data.define(:schema) do
         def call(parsed_request)
           validation = schema.validate(parsed_request.query)
-          Failure.fail!(:invalid_query, errors: validation.errors) if validation.error?
+          Failure.new(:invalid_query, errors: validation.errors) if validation.error?
         end
       end
 
       RequestCookies = Data.define(:schema) do
         def call(parsed_request)
           validation = schema.validate(parsed_request.cookies)
-          Failure.fail!(:invalid_cookie, errors: validation.errors) if validation.error?
+          Failure.new(:invalid_cookie, errors: validation.errors) if validation.error?
         end
       end
 

data/lib/openapi_first/validators/response_body.rb

@@ -15,12 +15,12 @@ module OpenapiFirst
         begin
           parsed_body = response.body
         rescue ParseError => e
-          Failure.fail!(:invalid_response_body, message: e.message)
+          return Failure.new(:invalid_response_body, message: e.message)
         end
         validation = Schema::ValidationResult.new(
           schema.validate(parsed_body, access_mode: 'read')
         )
-        Failure.fail!(:invalid_response_body, errors: validation.errors) if validation.error?
+        Failure.new(:invalid_response_body, errors: validation.errors) if validation.error?
       end
     end
   end

data/lib/openapi_first/validators/response_headers.rb

@@ -17,10 +17,11 @@ module OpenapiFirst
           validation_errors = header.schema.validate(header_value)
           next unless validation_errors.any?
 
-          Failure.fail!(:invalid_response_header,
-                        errors: [error_for(data_pointer: "/#{header.name}", value: header_value,
-                                           error: validation_errors.first)])
+          return Failure.new(:invalid_response_header,
+                             errors: [error_for(data_pointer: "/#{header.name}", value: header_value,
+                                                error: validation_errors.first)])
         end
+        nil
       end
 
       private

data/lib/openapi_first/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiFirst
-  VERSION = '3.3.1'
+  VERSION = '3.4.1'
 end

data/lib/openapi_first.rb

@@ -7,6 +7,7 @@ require_relative 'openapi_first/registry'
 require_relative 'openapi_first/configuration'
 require_relative 'openapi_first/child_configuration'
 require_relative 'openapi_first/definition'
+require_relative 'openapi_first/plugins'
 require_relative 'openapi_first/version'
 require_relative 'openapi_first/middlewares/response_validation'
 require_relative 'openapi_first/middlewares/request_validation'
@@ -53,6 +54,13 @@ module OpenapiFirst
     end
   end
 
+  # Load a plugin into the global configuration.
+  # @param name [Symbol] Plugin name. Looks up OpenapiFirst::Plugins::<Name> or requires "openapi_first/plugins/<name>".
+  # @param opts [Hash] Options forwarded to the plugin's .configure method.
+  def self.plugin(name, **)
+    configuration.plugin(name, **)
+  end
+
   # Load and dereference an OpenAPI spec file or return the Definition if it's already loaded
   # @param filepath_or_definition [String, Definition] The path to the file or a Definition object
   # @param only [Proc, nil] An optional proc to filter paths. It is called with the path string and should return

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 3.4.1
 platform: ruby
 authors:
 - Andreas Haller
@@ -63,7 +63,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.12.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -73,7 +73,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.12.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -122,6 +122,8 @@ files:
 - lib/openapi_first/middlewares/request_validation.rb
 - lib/openapi_first/middlewares/response_validation.rb
 - lib/openapi_first/parsed_request.rb
+- lib/openapi_first/plugins.rb
+- lib/openapi_first/plugins/x_public.rb
 - lib/openapi_first/ref_resolver.rb
 - lib/openapi_first/registry.rb
 - lib/openapi_first/request.rb
@@ -145,12 +147,17 @@ files:
 - lib/openapi_first/test/coverage.rb
 - lib/openapi_first/test/coverage/covered_request.rb
 - lib/openapi_first/test/coverage/covered_response.rb
+- lib/openapi_first/test/coverage/html_reporter.css
+- lib/openapi_first/test/coverage/html_reporter.html.erb
+- lib/openapi_first/test/coverage/html_reporter.rb
+- lib/openapi_first/test/coverage/html_reporter/context.rb
 - lib/openapi_first/test/coverage/plan.rb
 - lib/openapi_first/test/coverage/request_task.rb
 - lib/openapi_first/test/coverage/response_task.rb
 - lib/openapi_first/test/coverage/route_task.rb
-- lib/openapi_first/test/coverage/terminal_formatter.rb
+- lib/openapi_first/test/coverage/terminal_reporter.rb
 - lib/openapi_first/test/coverage/tracker.rb
+- lib/openapi_first/test/logger.rb
 - lib/openapi_first/test/methods.rb
 - lib/openapi_first/test/minitest_helpers.rb
 - lib/openapi_first/test/observe.rb