openapi_first 3.3.0 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d164451de439181b88fc45c5735f564cc802f5f53e13e245d224ca474a12c03
-  data.tar.gz: c5adc0092bccf3de1248799ddde58bf77dce9c58858e588dd72e8c8ed4a5c6cd
+  metadata.gz: 1786c083ff520504c716e9bdd1e8b92754be71e70dd774644b6a0c655681369a
+  data.tar.gz: bc86929efbbe041515cfb12e6d453133cb4cf0a849c40ae5c526eda1b910a4cd
 SHA512:
-  metadata.gz: ca4c5185152f49fe83977856d585f31ab1490f6b813a3f9878fc42e266f84dddc445baaf6865868e4a2b9c24f9ab7dccc2732ccc74f15aea43363a2f2b519e80
-  data.tar.gz: 43e0abb51e9d78fe86d0fb0903e372dbdfe480e73906148dd9a1da15261feb41d3614c3a6d337e11796baceff375c7ea887cbb8e7bbbb7098e6f00ec3825c5c8
+  metadata.gz: 4b745143e975173192680152d5b42243c4eb58e8158b4f71aa67730780ad9ec49e788767f8bd5816f0b5dc6ffb711bbba362968a2c075db11dc5c7f11d29733d
+  data.tar.gz: 32b7bbab75bd6fbb1620808f389d4bfc051a20da124823ada6ea154635306b8b6f6ad378c4bc55a1733211b6438092b307d36d83cc3d23494462729c7b80c817

data/CHANGELOG.md

@@ -2,9 +2,14 @@
 
 ## Unreleased
 
+## 3.3.1
+
+- Optimized caching towards reducing retained memory after calling `OpenapiFirst.load` without using a global cache. (Removed `OpenapiFirst.clear_cache!`.)
+- Require ruby >= 3.3.0
+
 ## 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!`.
+- ~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

data/README.md

@@ -82,9 +82,6 @@ The request validation middleware returns a 4xx if the request is invalid or not
 
 ```ruby
 use OpenapiFirst::Middlewares::RequestValidation
-
-# Pass `raise_error: true` to raise an error if request is invalid:
-use OpenapiFirst::Middlewares::RequestValidation, raise_error: true
 ```
 
 #### Error responses

data/lib/openapi_first/builder.rb

@@ -27,18 +27,20 @@ module OpenapiFirst
       meta_schema = detect_meta_schema(contents, filepath)
       @schemer_configuration = build_schemer_config(filepath:, meta_schema:)
       @config = config
-      @contents = RefResolver.for(contents, filepath:)
+      @file_loader = FileLoader.new
+      ref_resolver = RefResolver.new(file_loader:)
+      @contents = ref_resolver.for(contents, filepath:)
     end
 
     attr_reader :config
-    private attr_reader :schemer_configuration
+    private attr_reader :schemer_configuration, :file_loader
 
     def build_schemer_config(filepath:, meta_schema:)
       result = JSONSchemer.configuration.clone
       dir = (filepath && File.absolute_path(File.dirname(filepath))) || Dir.pwd
       result.base_uri = URI::File.build({ path: "#{dir}/" })
       result.ref_resolver = JSONSchemer::CachedResolver.new do |uri|
-        FileLoader.load(uri.path)
+        file_loader.load(uri.path)
       end
       result.meta_schema = meta_schema
       result.insert_property_defaults = true

data/lib/openapi_first/file_loader.rb

@@ -5,11 +5,15 @@ require 'yaml'
 
 module OpenapiFirst
   # @!visibility private
-  module FileLoader
-    @cache = {}
-    @mutex = Mutex.new
+  class FileLoader
+    def self.load(file_path)
+      new.load(file_path)
+    end
 
-    module_function
+    def initialize
+      @cache = {}
+      @mutex = Mutex.new
+    end
 
     def load(file_path)
       @cache[file_path] || @mutex.synchronize do
@@ -29,9 +33,5 @@ module OpenapiFirst
         end
       end
     end
-
-    def clear_cache!
-      @mutex.synchronize { @cache.clear }
-    end
   end
 end

data/lib/openapi_first/ref_resolver.rb

@@ -5,30 +5,42 @@ require 'json_schemer'
 module OpenapiFirst
   # This is here to give traverse an OAD while keeping $refs intact
   # @visibility private
-  module RefResolver
-    def self.load(filepath)
-      contents = OpenapiFirst::FileLoader.load(filepath)
+  class RefResolver
+    def initialize(file_loader:)
+      @file_loader = file_loader
+    end
+
+    private attr_reader :file_loader
+
+    def load(filepath)
+      contents = file_loader.load(filepath)
       self.for(contents, filepath:)
     end
 
-    def self.for(value, filepath: nil, context: value)
+    def for(value, filepath: nil, context: value)
       case value
       when ::Hash
-        resolver = Hash.new(value, context:, filepath:)
+        resolver = Hash.new(value, context:, filepath:, ref_resolver: self)
         if value.key?('$ref')
           probe = resolver.resolve_ref(value['$ref'])
           return probe if probe.is_a?(Array)
         end
         resolver
       when ::Array
-        Array.new(value, context:, filepath:)
+        Array.new(value, context:, filepath:, ref_resolver: self)
       when ::NilClass
         nil
       else
-        Simple.new(value)
+        Simple.new(value, ref_resolver: self)
       end
     end
 
+    def file_at(filepath, file_pointer)
+      file_contents = file_loader.load(filepath)
+      value = Hana::Pointer.new(file_pointer).eval(file_contents)
+      self.for(value, filepath: filepath, context: file_contents)
+    end
+
     # @visibility private
     module Diggable
       def dig(*keys)
@@ -42,10 +54,11 @@ module OpenapiFirst
 
     # @visibility private
     module Resolvable
-      def initialize(value, context: value, filepath: nil)
+      def initialize(value, ref_resolver:, context: value, filepath: nil)
         @value = value
         @context = context
         @filepath = filepath
+        @ref_resolver = ref_resolver
         @dir = if filepath
                  File.dirname(File.absolute_path(filepath))
                else
@@ -62,6 +75,8 @@ module OpenapiFirst
 
       attr_reader :filepath
 
+      private attr_reader :ref_resolver
+
       def ==(_other)
         raise "Don't call == on an unresolved value. Use .value == other instead."
       end
@@ -71,16 +86,14 @@ module OpenapiFirst
           value = Hana::Pointer.new(pointer[1..]).eval(context)
           raise "Unknown reference #{pointer} in #{context}" unless value
 
-          return RefResolver.for(value, filepath:, context:)
+          return ref_resolver.for(value, filepath:, context:)
         end
 
         relative_path, file_pointer = pointer.split('#')
         full_path = File.expand_path(relative_path, dir)
-        return RefResolver.load(full_path) unless file_pointer
+        return ref_resolver.load(full_path) unless file_pointer
 
-        file_contents = FileLoader.load(full_path)
-        value = Hana::Pointer.new(file_pointer).eval(file_contents)
-        RefResolver.for(value, filepath: full_path, context: file_contents)
+        ref_resolver.file_at(full_path, file_pointer)
       rescue OpenapiFirst::FileNotFoundError => e
         message = "Problem with reference resolving #{pointer.inspect} in " \
                   "file #{File.absolute_path(filepath).inspect}: #{e.message}"
@@ -114,13 +127,13 @@ module OpenapiFirst
       def [](key)
         return resolve_ref(@value['$ref'])[key] if !@value.key?(key) && @value.key?('$ref')
 
-        RefResolver.for(@value[key], filepath:, context:)
+        ref_resolver.for(@value[key], filepath:, context:)
       end
 
       def fetch(key)
         return resolve_ref(@value['$ref']).fetch(key) if !@value.key?(key) && @value.key?('$ref')
 
-        RefResolver.for(@value.fetch(key), filepath:, context:)
+        ref_resolver.for(@value.fetch(key), filepath:, context:)
       end
 
       def each
@@ -170,7 +183,7 @@ module OpenapiFirst
         item = @value[index]
         return resolve_ref(item['$ref']) if item.is_a?(::Hash) && item.key?('$ref')
 
-        RefResolver.for(item, filepath:, context:)
+        ref_resolver.for(item, filepath:, context:)
       end
 
       def each

data/lib/openapi_first/version.rb

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

data/lib/openapi_first.rb

@@ -22,11 +22,6 @@ 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.3.0
+  version: 3.3.1
 platform: ruby
 authors:
 - Andreas Haller
@@ -179,14 +179,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.10
 specification_version: 4
 summary: OpenAPI based request validation, response validation, contract-testing and
   coverage