openapi_first 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d95e7c0085b398b3ec034554d30cf4bd6e9dc488c5cc19d7777ec88aa5ed9ec
-  data.tar.gz: 323d16c0d405b4233ebe4377cb1a9960db84d19033193d3ccf9badb052a00f24
+  metadata.gz: 7d164451de439181b88fc45c5735f564cc802f5f53e13e245d224ca474a12c03
+  data.tar.gz: c5adc0092bccf3de1248799ddde58bf77dce9c58858e588dd72e8c8ed4a5c6cd
 SHA512:
-  metadata.gz: d80c5803dcb0746cdf9def8e1b470394b424926a2a0235da90bc47e3f748f74fdbf278cd8e7640b157aabe279e2028e80581f4a7ebcde4b4d1238e9ee0040618
-  data.tar.gz: 1022635f98bd37c776d137315fd61f9ba82dd72831ca16ef2e834f45bcba0456e90614eebc85df1fd08b7e03183daa16beaa098575d4161f74b54e3d1ef998b6
+  metadata.gz: ca4c5185152f49fe83977856d585f31ab1490f6b813a3f9878fc42e266f84dddc445baaf6865868e4a2b9c24f9ab7dccc2732ccc74f15aea43363a2f2b519e80
+  data.tar.gz: 43e0abb51e9d78fe86d0fb0903e372dbdfe480e73906148dd9a1da15261feb41d3614c3a6d337e11796baceff375c7ea887cbb8e7bbbb7098e6f00ec3825c5c8

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Unreleased
 
+## 3.3.0
+
+- OpenapiFirst will now cache the contents of files that have been loaded. If you need to reload your OpenAPI definition for tests or server hot reloading, you can call `OpenapiFirst.clear_cache!`.
+- Optimized `OpenapiFirst::Router#match` for faster path matching and reduced memory allocation.
+ 
+## 3.2.1
+
+- Don't raise `UnknownQueryParameterError` if request is ignored in tests. Fixes [#441](https://github.com/ahx/openapi_first/issues/441).
+
 ## 3.2.0
 
 ### Changed

data/lib/openapi_first/failure.rb

@@ -3,7 +3,7 @@
 module OpenapiFirst
   # A failure object returned when validation or parsing of a request or response has failed.
   # This returned in ValidatedRequest#error and ValidatedResponse#error.
-  class Failure
+  class Failure < Data.define(:type, :message, :errors) # rubocop:disable Style/DataInheritance
     TYPES = {
       not_found: [NotFoundError, 'Not found.'],
       method_not_allowed: [RequestInvalidError, 'Request method is not defined.'],
@@ -33,27 +33,25 @@ module OpenapiFirst
     # @param type [Symbol] See TYPES.keys
     # @param message [String] A generic error message
     # @param errors [Array<OpenapiFirst::Schema::ValidationError>]
-    def initialize(type, message: nil, errors: nil)
+    def self.new(type, message: nil, errors: nil)
       unless TYPES.key?(type)
         raise ArgumentError,
               "type must be one of #{TYPES.keys} but was #{type.inspect}"
       end
-
-      @type = type
-      @message = message
-      @errors = errors
+      super(type:, message:, errors:)
     end
 
-    # @attr_reader [Symbol] type The type of the failure. See TYPES.keys.
+    # @method type [Symbol] type The type of the failure. See TYPES.keys.
     # Example: :invalid_body
-    attr_reader :type
 
-    # @attr_reader [Array<OpenapiFirst::Schema::ValidationError>] errors Schema validation errors
-    attr_reader :errors
+    # @method errors [Array<OpenapiFirst::Schema::ValidationError>, nil] errors Schema validation errors
+
+    alias original_message message
+    private :original_message
 
     # A generic error message
     def message
-      @message ||= exception_message
+      original_message || exception_message
     end
 
     def exception(context = nil)
@@ -63,7 +61,7 @@ module OpenapiFirst
     def exception_message
       _, message_prefix = TYPES.fetch(type)
 
-      [message_prefix, @message || generate_message].compact.join(' ')
+      [message_prefix, original_message || generate_message].compact.join(' ')
     end
 
     private

data/lib/openapi_first/file_loader.rb

@@ -6,17 +6,32 @@ require 'yaml'
 module OpenapiFirst
   # @!visibility private
   module FileLoader
+    @cache = {}
+    @mutex = Mutex.new
+
     module_function
 
     def load(file_path)
-      raise FileNotFoundError, "File not found #{file_path.inspect}" unless File.exist?(file_path)
+      @cache[file_path] || @mutex.synchronize do
+        @cache[file_path] ||= begin
+          raise FileNotFoundError, "File not found #{file_path.inspect}" unless File.exist?(file_path)
+
+          body = File.read(file_path)
+          extname = File.extname(file_path)
 
-      body = File.read(file_path)
-      extname = File.extname(file_path)
-      return ::JSON.parse(body) if extname == '.json'
-      return YAML.unsafe_load(body) if ['.yaml', '.yml'].include?(extname)
+          if extname == '.json'
+            ::JSON.parse(body)
+          elsif ['.yaml', '.yml'].include?(extname)
+            YAML.unsafe_load(body)
+          else
+            body
+          end
+        end
+      end
+    end
 
-      body
+    def clear_cache!
+      @mutex.synchronize { @cache.clear }
     end
   end
 end

data/lib/openapi_first/response_parser.rb

@@ -25,7 +25,7 @@ module OpenapiFirst
       buffered_body = +''
 
       if rack_response.body.respond_to?(:each)
-        rack_response.body.each { |chunk| buffered_body.to_s << chunk }
+        rack_response.body.each { |chunk| buffered_body << chunk }
         return buffered_body
       end
       rack_response.body

data/lib/openapi_first/router/find_content.rb

@@ -8,8 +8,10 @@ module OpenapiFirst
         return contents[nil] if content_type.nil? || content_type.empty?
 
         contents.fetch(content_type) do
-          type = content_type.split(';')[0]
-          contents[type] || contents["#{type.split('/')[0]}/*"] || contents['*/*'] || contents[nil]
+          semi = content_type.index(';')
+          type = semi ? content_type[0, semi] : content_type
+          slash = type.index('/') || type.length
+          contents[type] || contents["#{type[0, slash]}/*"] || contents['*/*'] || contents[nil]
         end
       end
     end

data/lib/openapi_first/router/path_template.rb

@@ -6,8 +6,6 @@ module OpenapiFirst
     class PathTemplate
       # See also https://spec.openapis.org/oas/v3.1.0#path-templating
       TEMPLATE_EXPRESSION = /(\{[^{}]+\})/
-      TEMPLATE_EXPRESSION_NAME = /\{([^{}]+)\}/
-      ALLOWED_PARAMETER_CHARACTERS = %r{([^/?#]+)}
 
       def self.template?(string)
         string.include?('{')
@@ -15,7 +13,6 @@ module OpenapiFirst
 
       def initialize(template)
         @template = template
-        @names = template.scan(TEMPLATE_EXPRESSION_NAME).flatten
         @pattern = build_pattern(template)
       end
 
@@ -25,20 +22,22 @@ module OpenapiFirst
 
       def match(path)
         return {} if path == @template
-        return if @names.empty?
 
         matches = path.match(@pattern)
         return unless matches
 
-        values = matches.captures
-        @names.zip(values).to_h
+        matches.named_captures
       end
 
       private
 
       def build_pattern(template)
         parts = template.split(TEMPLATE_EXPRESSION).map! do |part|
-          part.start_with?('{') ? ALLOWED_PARAMETER_CHARACTERS : Regexp.escape(part)
+          if part.start_with?('{')
+            "(?<#{part[1..-2]}>[^/?#]+)"
+          else
+            Regexp.escape(part)
+          end
         end
 
         /^#{parts.join}$/

data/lib/openapi_first/router.rb

@@ -97,15 +97,15 @@ module OpenapiFirst
       found = @static[request_path]
       return [found, {}] if found
 
-      matches = @dynamic.filter_map do |_path, path_item|
+      @dynamic.each_value.reduce(nil) do |best, path_item|
         params = path_item[:template].match(request_path)
-        next unless params
+        next best unless params
 
-        [path_item, params]
-      end
-      return matches.first if matches.length == 1
+        candidate = [path_item, params]
+        next candidate unless best
 
-      matches&.min_by { |match| match[1].values.sum(&:length) }
+        params.values.sum(&:length) < best[1].values.sum(&:length) ? candidate : best
+      end
     end
   end
 end

data/lib/openapi_first/test/configuration.rb

@@ -88,7 +88,7 @@ module OpenapiFirst
         return false if @ignore_request_error&.call(validated_request)
         return false if ignore_unknown_requests? && validated_request.unknown?
 
-        validated_request.unknown?
+        true
       end
 
       def raise_response_error?(validated_response, rack_request)

data/lib/openapi_first/test.rb

@@ -106,9 +106,12 @@ module OpenapiFirst
       OpenapiFirst.configure do |config|
         @after_request_validation = config.after_request_validation do |validated_request, oad|
           next unless registered?(oad)
-          raise validated_request.error.exception if raise_request_error?(validated_request)
 
-          check_unknown_query_parameters(validated_request)
+          if configuration.raise_request_error?(validated_request)
+            raise validated_request.error.exception if validated_request.unknown?
+
+            check_unknown_query_parameters(validated_request)
+          end
 
           Coverage.track_request(validated_request, oad)
         end
@@ -152,12 +155,6 @@ module OpenapiFirst
         "Unknown query parameter#{s} #{list} for #{validated_request.fullpath}"
       end
 
-      def raise_request_error?(validated_request)
-        return false if validated_request.valid?
-
-        configuration.raise_request_error?(validated_request)
-      end
-
       def many?(array) = array.length > 1
 
       def raise_response_error?(validated_response, rack_request)

data/lib/openapi_first/validated_request.rb

@@ -33,6 +33,7 @@ module OpenapiFirst
     def_delegator :request_definition, :operation
 
     # @return [Hash] Query parameters and values that are not defined in the OpenAPI spec.
+    # FIXME: Optimize this so it does not have to parse the query string a second time to find unknown parameters
     def unknown_query_parameters
       @query_parser&.unknown_values(query_string)
     end

data/lib/openapi_first/version.rb

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

data/lib/openapi_first.rb

@@ -22,6 +22,11 @@ module OpenapiFirst
 
   FAILURE = :openapi_first_validation_failure
 
+  # Clears cached files
+  def self.clear_cache!
+    FileLoader.clear_cache!
+  end
+
   # @return [Configuration]
   def self.configuration
     @configuration ||= Configuration.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openapi_first
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Andreas Haller
@@ -186,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.6
 specification_version: 4
 summary: OpenAPI based request validation, response validation, contract-testing and
   coverage