committee 5.0.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 284c8c1198255435e959dcee2b92cb25c3d80dd5fe6d4622b8077a69525712ed
-  data.tar.gz: b306ec0ad5e628d9cc7b6382781c4b710c99bedb127a7000edadf9d0e0b8fa84
+  metadata.gz: 95c313e8694c8ad00b4f0ed75ac173f177cb62c3cc18494a946df9b9066abbaa
+  data.tar.gz: 7080a9ec40c56d2d47fde358217068ac3dcc907528ac359e2a94089f9b9f068e
 SHA512:
-  metadata.gz: 687d9a47d2a17786313bde939339d464a8d775795458b09ad7d7784bfa337f848a9ffabe240e9f39173c4466589c026f64a8eede768e7abfff4b01b2672339f5
-  data.tar.gz: 4ee7781341de9ebafae28d01d98c0f72d54067c425f3ee10b221c4eb88da85e79b36853bbda4818b20348177f8d975103cc5be694ff7e8252a6634a856853b7c
+  metadata.gz: 4530289393371c110c67564e277dbfdaab9f6a83aff9cc3e8c625ee83a6fabb3fb4c1c0abd3e93d83577a8204143672ccab998e50aabccbc866cb619c43f698c
+  data.tar.gz: 91feff9fb8ee526fe0715ce12e570fe53782750ad823a44a31f549d738c0ce9d65421a1323568992e43dd16a4e202130fbd3f020ac836eab5a19a0626a59d5d0

data/lib/committee/drivers.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'digest'
+
 module Committee
   module Drivers
     # Gets a driver instance from the specified name. Raises ArgumentError for
@@ -36,13 +38,16 @@ module Committee
     # @param [String] schema_path
     # @return [Committee::Driver]
     def self.load_from_file(schema_path, parser_options: {})
-      case File.extname(schema_path)
-      when '.json'
-        load_from_json(schema_path, parser_options: parser_options)
-      when '.yaml', '.yml'
-        load_from_yaml(schema_path, parser_options: parser_options)
-      else
-        raise "Committee only supports the following file extensions: '.json', '.yaml', '.yml'"
+      @__load_from_file_cache ||= {}
+      @__load_from_file_cache[cache_key(schema_path, parser_options)] ||= begin
+        case File.extname(schema_path)
+        when '.json'
+          load_from_json(schema_path, parser_options: parser_options)
+        when '.yaml', '.yml'
+          load_from_yaml(schema_path, parser_options: parser_options)
+        else
+          raise "Committee only supports the following file extensions: '.json', '.yaml', '.yml'"
+        end
       end
     end
 
@@ -65,6 +70,12 @@ module Committee
         return Committee::Drivers::OpenAPI3::Driver.new.parse(openapi)
       end
 
+      if (version = hash['openapi'])
+        if Gem::Version.new(version) >= Gem::Version.new("3.1")
+          raise OpenAPI3Unsupported.new('Committee does not support OpenAPI 3.1+ yet')
+        end
+      end
+
       driver = if hash['swagger'] == '2.0'
                  Committee::Drivers::OpenAPI2::Driver.new
                else
@@ -74,6 +85,17 @@ module Committee
       # TODO: in the future, pass `opts` here and allow optionality in other drivers?
       driver.parse(hash)
     end
+
+    class << self
+      private
+
+      def cache_key(schema_path, parser_options)
+        [
+          File.exist?(schema_path) ? Digest::MD5.hexdigest(File.read(schema_path)) : nil,
+          parser_options.hash,
+        ].join('_')
+      end
+    end
   end
 end
 

data/lib/committee/middleware/request_validation.rb

@@ -6,7 +6,7 @@ module Committee
       def initialize(app, options={})
         super
 
-        @strict  = options[:strict]
+        @strict = options[:strict]
       end
 
       def handle(request)

data/lib/committee/schema_validator/open_api_3.rb

@@ -87,7 +87,7 @@ module Committee
 
         request.env[validator_option.headers_key] = unpacker.unpack_headers(request)
 
-        request_param, is_form_params = unpacker.unpack_request_params(request)
+        request_param, _is_form_params = unpacker.unpack_request_params(request)
         request.env[validator_option.request_body_hash_key] = request_param
         request.env[validator_option.path_hash_key] = coerce_path_params
 

data/lib/committee/schema_validator/option.rb

@@ -29,30 +29,30 @@ module Committee
 
       def initialize(options, schema, schema_type)
         # Non-boolean options
-        @headers_key         = options[:headers_key]    || "committee.headers"
-        @params_key          = options[:params_key]     || "committee.params"
-        @query_hash_key      = options[:query_hash_key] || "committee.query_hash"
-        @path_hash_key      = options[:path_hash_key] || "committee.path_hash"
+        @headers_key           = options[:headers_key]    || "committee.headers"
+        @params_key            = options[:params_key]     || "committee.params"
+        @query_hash_key        = options[:query_hash_key] || "committee.query_hash"
+        @path_hash_key         = options[:path_hash_key] || "committee.path_hash"
         @request_body_hash_key = options[:request_body_hash_key] || "committee.request_body_hash"
 
-        @prefix              = options[:prefix]
+        @prefix                = options[:prefix]
 
         # Boolean options and have a common value by default
-        @allow_form_params   = options.fetch(:allow_form_params, true)
-        @allow_query_params  = options.fetch(:allow_query_params, true)
-        @check_content_type  = options.fetch(:check_content_type, true)
-        @check_header        = options.fetch(:check_header, true)
-        @coerce_recursive    = options.fetch(:coerce_recursive, true)
-        @optimistic_json     = options.fetch(:optimistic_json, false)
-        @parse_response_by_content_type = options.fetch(:parse_response_by_content_type, true)
+        @allow_form_params                = options.fetch(:allow_form_params, true)
+        @allow_query_params               = options.fetch(:allow_query_params, true)
+        @check_content_type               = options.fetch(:check_content_type, true)
+        @check_header                     = options.fetch(:check_header, true)
+        @coerce_recursive                 = options.fetch(:coerce_recursive, true)
+        @optimistic_json                  = options.fetch(:optimistic_json, false)
+        @parse_response_by_content_type   = options.fetch(:parse_response_by_content_type, true)
         @parameter_overwite_by_rails_rule = options.fetch(:parameter_overwite_by_rails_rule, true)
 
         # Boolean options and have a different value by default
-        @allow_get_body      = options.fetch(:allow_get_body, schema.driver.default_allow_get_body)
-        @coerce_date_times   = options.fetch(:coerce_date_times, schema.driver.default_coerce_date_times)
-        @coerce_form_params  = options.fetch(:coerce_form_params, schema.driver.default_coerce_form_params)
-        @coerce_path_params  = options.fetch(:coerce_path_params, schema.driver.default_path_params)
-        @coerce_query_params = options.fetch(:coerce_query_params, schema.driver.default_query_params)
+        @allow_get_body        = options.fetch(:allow_get_body, schema.driver.default_allow_get_body)
+        @coerce_date_times     = options.fetch(:coerce_date_times, schema.driver.default_coerce_date_times)
+        @coerce_form_params    = options.fetch(:coerce_form_params, schema.driver.default_coerce_form_params)
+        @coerce_path_params    = options.fetch(:coerce_path_params, schema.driver.default_path_params)
+        @coerce_query_params   = options.fetch(:coerce_query_params, schema.driver.default_query_params)
         @validate_success_only = options.fetch(:validate_success_only, schema.driver.default_validate_success_only)
       end
     end

data/lib/committee/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Committee
-    VERSION = '5.0.0'.freeze
+    VERSION = '5.2.0'.freeze
 end

data/lib/committee.rb

@@ -22,7 +22,7 @@ module Committee
   end
 
   def self.warn_deprecated_until_6(cond, message)
-    raise "remove deprecated!"  unless Committee::VERSION.start_with?("5")
+    raise "remove deprecated!" unless Committee::VERSION.start_with?("5")
     warn("[DEPRECATION] #{message}") if cond
   end
 end

data/test/bin/committee_stub_test.rb

@@ -44,8 +44,6 @@ describe Committee::Bin::CommitteeStub, "app" do
 
   def app
     options = {}
-    # TODO: delete when 5.0.0 released because default value changed
-    options[:parse_response_by_content_type] = false
 
     @bin.get_app(hyper_schema, options)
   end

data/test/committee_test.rb

@@ -19,13 +19,15 @@ describe Committee do
     old_stderr = $stderr
     $stderr = StringIO.new
     begin
-      stub(Committee).debug? { false }
-      Committee.log_debug "blah"
-      assert_equal "", $stderr.string
+      Committee.stub(:debug?, false) do
+        Committee.log_debug "blah"
+        assert_equal "", $stderr.string
+      end
 
-      stub(Committee).debug? { true }
-      Committee.log_debug "blah"
-      assert_equal "blah\n", $stderr.string
+      Committee.stub(:debug?, true) do
+        Committee.log_debug "blah"
+        assert_equal "blah\n", $stderr.string
+      end
     ensure
       $stderr = old_stderr
     end

data/test/drivers_test.rb

@@ -48,6 +48,13 @@ describe Committee::Drivers do
       assert_kind_of Committee::Drivers::OpenAPI3::Schema, s
     end
 
+    it 'fails to load OpenAPI 3.1+' do
+      e = assert_raises(Committee::OpenAPI3Unsupported) do
+        Committee::Drivers.load_from_file(open_api_3_1_schema_path, parser_options:{strict_reference_validation: true})
+      end
+      assert_equal 'Committee does not support OpenAPI 3.1+ yet', e.message
+    end
+
     it 'fails to load OpenAPI 3 with invalid reference' do
       parser_options = { strict_reference_validation: true }
       assert_raises(OpenAPIParser::MissingReferenceError) do
@@ -67,6 +74,35 @@ describe Committee::Drivers do
       end
       assert_equal "Committee only supports the following file extensions: '.json', '.yaml', '.yml'", e.message
     end
+
+    describe 'cache behavior' do
+      describe 'when loading the same file' do
+        it 'returns the same object when the options are identical' do
+          assert_equal(
+            Committee::Drivers.load_from_file(open_api_3_schema_path, parser_options:{strict_reference_validation: true}).object_id,
+            Committee::Drivers.load_from_file(open_api_3_schema_path, parser_options:{strict_reference_validation: true}).object_id,
+          )
+        end
+
+        it 'returns different objects if the options are different' do
+          refute_equal(
+            Committee::Drivers.load_from_file(open_api_3_schema_path, parser_options:{strict_reference_validation: true}).object_id,
+            Committee::Drivers.load_from_file(open_api_3_schema_path, parser_options:{strict_reference_validation: false}).object_id,
+          )
+        end
+
+        it 'returns different objects if the file contents have changed' do
+          object_id = Committee::Drivers.load_from_file(open_api_3_schema_path, parser_options:{strict_reference_validation: true}).object_id
+          original_file_contents = File.read(open_api_3_schema_path)
+          File.write(open_api_3_schema_path, original_file_contents + "\n")
+          refute_equal(
+            Committee::Drivers.load_from_file(open_api_3_schema_path, parser_options:{strict_reference_validation: true}).object_id,
+            object_id,
+          )
+          File.write(open_api_3_schema_path, original_file_contents)
+        end
+      end
+    end
   end
 
   describe 'load_from_json(schema_path)' do
@@ -109,6 +145,13 @@ describe Committee::Drivers do
       assert_kind_of Committee::Drivers::Schema, s
       assert_kind_of Committee::Drivers::HyperSchema::Schema, s
     end
+
+    it 'fails to load OpenAPI 3.1+' do
+      e = assert_raises(Committee::OpenAPI3Unsupported) do
+        Committee::Drivers.load_from_data(open_api_3_1_data)
+      end
+      assert_equal 'Committee does not support OpenAPI 3.1+ yet', e.message
+    end
   end
 end
 

data/test/middleware/base_test.rb

@@ -117,9 +117,6 @@ describe Committee::Middleware::Base do
   private
 
   def new_rack_app(options = {})
-    # TODO: delete when 5.0.0 released because default value changed
-    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
-
     Rack::Builder.new {
       use Committee::Middleware::RequestValidation, options
       run lambda { |_|

data/test/middleware/request_validation_open_api_3_test.rb

@@ -615,9 +615,6 @@ describe Committee::Middleware::RequestValidation do
   end
 
   def new_rack_app_with_lambda(check_lambda, options = {})
-    # TODO: delete when 5.0.0 released because default value changed
-    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
-
     Rack::Builder.new {
       use Committee::Middleware::RequestValidation, options
       run check_lambda

data/test/middleware/request_validation_test.rb

@@ -505,9 +505,6 @@ describe Committee::Middleware::RequestValidation do
 
 
   def new_rack_app_with_lambda(check_lambda, options = {})
-    # TODO: delete when 5.0.0 released because default value changed
-    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
-
     Rack::Builder.new {
       use Committee::Middleware::RequestValidation, options
       run check_lambda

data/test/middleware/response_validation_open_api_3_test.rb

@@ -273,9 +273,6 @@ describe Committee::Middleware::ResponseValidation do
   private
 
   def new_response_rack(response, headers = {}, options = {}, rack_options = {})
-    # TODO: delete when 5.0.0 released because default value changed
-    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
-
     status = rack_options[:status] || 200
     content_type = rack_options[:content_type] || "application/json"
     headers = {

data/test/middleware/response_validation_test.rb

@@ -15,14 +15,6 @@ describe Committee::Middleware::ResponseValidation do
     assert_equal 200, last_response.status
   end
 
-  # TODO: remove 5.0.0
-  it "passes through a valid response" do
-    # will show deprecated message
-    @app = new_rack_app(JSON.generate([ValidApp]), {}, schema: hyper_schema, strict: true)
-    get "/apps"
-    assert_equal 200, last_response.status
-  end
-
   it "doesn't call error_handler (has a arg) when response is valid" do
     called = false
     pr = ->(_e) { called = true }
@@ -173,9 +165,6 @@ describe Committee::Middleware::ResponseValidation do
   private
 
   def new_rack_app(response, headers = {}, options = {})
-    # TODO: delete when 5.0.0 released because default value changed
-    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
-
     headers = {
       "Content-Type" => "application/json"
     }.merge(headers)

data/test/middleware/stub_test.rb

@@ -113,9 +113,6 @@ describe Committee::Middleware::Stub do
     response = options.delete(:response)
     suppress = options.delete(:suppress)
 
-    # TODO: delete when 5.0.0 released because default value changed
-    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
-
     Rack::Builder.new {
       use Committee::Middleware::Stub, options
       run lambda { |env|

data/test/schema_validator/hyper_schema/router_test.rb

@@ -69,8 +69,6 @@ describe Committee::SchemaValidator::HyperSchema::Router do
   end
 
   def hyper_schema_router(options = {})
-    # TODO: delete when 5.0.0 released because default value changed
-    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
     schema = Committee::Drivers::HyperSchema::Driver.new.parse(hyper_schema_data)
     validator_option = Committee::SchemaValidator::Option.new(options, schema, :hyper_schema)
 
@@ -78,8 +76,6 @@ describe Committee::SchemaValidator::HyperSchema::Router do
   end
 
   def open_api_2_router(options = {})
-    # TODO: delete when 5.0.0 released because default value changed
-    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
     schema = Committee::Drivers::OpenAPI2::Driver.new.parse(open_api_2_data)
     validator_option = Committee::SchemaValidator::Option.new(options, schema, :hyper_schema)
 

data/test/schema_validator/open_api_3/operation_wrapper_test.rb

@@ -9,12 +9,7 @@ describe Committee::SchemaValidator::OpenAPI3::OperationWrapper do
     before do
       @path = '/validate'
       @method = 'post'
-
-      # TODO: delete when 5.0.0 released because default value changed
-      options = {}
-      options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
-
-      @validator_option = Committee::SchemaValidator::Option.new(options, open_api_3_schema, :open_api_3)
+      @validator_option = Committee::SchemaValidator::Option.new({}, open_api_3_schema, :open_api_3)
     end
 
     def operation_object

data/test/schema_validator/open_api_3/request_validator_test.rb

@@ -96,9 +96,6 @@ describe Committee::SchemaValidator::OpenAPI3::RequestValidator do
     end    
 
     def new_rack_app(options = {})
-      # TODO: delete when 5.0.0 released because default value changed
-      options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
-
       Rack::Builder.new {
         use Committee::Middleware::RequestValidation, options
         run lambda { |_|

data/test/schema_validator/open_api_3/response_validator_test.rb

@@ -13,11 +13,7 @@ describe Committee::SchemaValidator::OpenAPI3::ResponseValidator do
     @path = '/validate'
     @method = 'post'
 
-    # TODO: delete when 5.0.0 released because default value changed
-    options = {}
-    options[:parse_response_by_content_type] = true if options[:parse_response_by_content_type] == nil
-    
-    @validator_option = Committee::SchemaValidator::Option.new(options, open_api_3_schema, :open_api_3)
+    @validator_option = Committee::SchemaValidator::Option.new({}, open_api_3_schema, :open_api_3)
   end
 
   it "passes through a valid response" do

data/test/test/methods_new_version_test.rb

@@ -30,9 +30,6 @@ describe Committee::Test::Methods do
     @committee_schema = nil
 
     @committee_options = {schema: hyper_schema}
-
-    # TODO: delete when 5.0.0 released because default value changed
-    @committee_options[:parse_response_by_content_type] = false
   end
 
   describe "#assert_schema_conform" do

data/test/test/methods_test.rb

@@ -29,9 +29,6 @@ describe Committee::Test::Methods do
     @committee_router = nil
     @committee_schema = nil
     @committee_options = {}
-
-    # TODO: delete when 5.0.0 released because default value changed
-    @committee_options[:parse_response_by_content_type] = true
   end
 
   describe "Hyper-Schema" do

data/test/test_helper.rb

@@ -21,7 +21,6 @@ require "minitest"
 require "minitest/spec"
 require "minitest/autorun"
 require "rack/test"
-require "rr"
 require "pry"
 require "stringio"
 
@@ -91,6 +90,14 @@ def open_api_3_data
   end
 end
 
+def open_api_3_1_data
+  if YAML.respond_to?(:unsafe_load_file)
+    YAML.unsafe_load_file(open_api_3_1_schema_path)
+  else
+    YAML.load_file(open_api_3_1_schema_path)
+  end
+end
+
 def hyper_schema_schema_path
   "./test/data/hyperschema/paas.json"
 end
@@ -115,6 +122,10 @@ def open_api_3_0_1_schema_path
   "./test/data/openapi3/3_0_1.yaml"
 end
 
+def open_api_3_1_schema_path
+  "./test/data/openapi3/3_1.yaml"
+end
+
 def open_api_3_invalid_reference_path
   "./test/data/openapi3/invalid_reference.yaml"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: committee
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Brandur
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-28 00:00:00.000000000 Z
+date: 2024-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_schema
@@ -52,14 +52,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -94,28 +94,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
-- !ruby/object:Gem::Dependency
-  name: rr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '13.1'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -146,20 +132,6 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.13.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.13.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -173,21 +145,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -314,14 +272,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: A collection of Rack middleware to support JSON Schema.