Merge pull request #379 from ahx/fix-multi-json-parse

Fix OpenapiFirst.load when MultiJson is configured to return symbol keys

Author: ahx

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Fix OpenapiFirst.load when MultiJson is configured to return symbol keys
+
 ## 2.9.2
 
 - OpenapiFirst::Test reports all non-covered requests now

Gemfile.multi_json

@@ -9,10 +9,13 @@ gem 'multi_json'
 group :test, :development do
   gem 'actionpack'
   gem 'bundler'
+  gem 'minitest'
   gem 'rack-test'
+  gem 'rails'
   gem 'rake'
   gem 'rspec'
   gem 'rubocop'
   gem 'rubocop-performance'
   gem 'simplecov'
+  gem 'sinatra'
 end

Gemfile.rack2

@@ -9,9 +9,13 @@ gem 'rack', '< 3.0.0'
 group :test, :development do
   gem 'actionpack'
   gem 'bundler'
+  gem 'minitest'
   gem 'rack-test'
+  gem 'rails'
   gem 'rake'
   gem 'rspec'
   gem 'rubocop'
+  gem 'rubocop-performance'
   gem 'simplecov'
+  gem 'sinatra'
 end

Gemfile.rack30

@@ -9,10 +9,13 @@ gem 'rack', '>= 3.0.0', '< 3.1.0'
 group :test, :development do
   gem 'actionpack'
   gem 'bundler'
+  gem 'minitest'
   gem 'rack-test'
+  gem 'rails'
   gem 'rake'
   gem 'rspec'
   gem 'rubocop'
   gem 'rubocop-performance'
   gem 'simplecov'
+  gem 'sinatra'
 end

Gemfile.rails6

@@ -7,11 +7,14 @@ gemspec
 gem 'rackup'
 
 group :test, :development do
-  gem 'actionpack', '~> 6.1'
   gem 'bundler'
+  gem 'minitest'
   gem 'rack-test'
+  gem 'rails', '~> 6.1'
   gem 'rake'
   gem 'rspec'
   gem 'rubocop'
+  gem 'rubocop-performance'
   gem 'simplecov'
+  gem 'sinatra'
 end

lib/openapi_first.rb

@@ -66,7 +66,7 @@ def self.load(filepath_or_definition, only: nil, &)
   # @return [Definition]
   # TODO: This needs to work with unresolved contents as well
   def self.parse(contents, only: nil, filepath: nil, &)
-    contents = JSON.parse(JSON.generate(contents)) # Deeply stringify keys, because of YAML. See https://github.com/ahx/openapi_first/issues/367
+    contents = ::JSON.parse(::JSON.generate(contents)) # Deeply stringify keys, because of YAML. See https://github.com/ahx/openapi_first/issues/367
     contents['paths'].filter!(&->(key, _) { only.call(key) }) if only
     Definition.new(contents, filepath, &)
   end

lib/openapi_first/file_loader.rb

@@ -13,7 +13,7 @@ def load(file_path)
 
       body = File.read(file_path)
       extname = File.extname(file_path)
-      return JSON.parse(body) if extname == '.json'
+      return ::JSON.parse(body) if extname == '.json'
       return YAML.unsafe_load(body) if ['.yaml', '.yml'].include?(extname)
 
       body

spec/file_loader_spec.rb

@@ -2,9 +2,16 @@
 
 RSpec.describe OpenapiFirst::FileLoader do
   describe '.load' do
-    it 'loads .json' do
-      contents = described_class.load('./spec/data/petstore.json')
-      expect(contents['openapi']).to eq('3.0.0')
+    begin
+      require 'multi_json'
+      before do
+        MultiJson.load_options = { symbolize_keys: true }
+      end
+
+      after do
+        MultiJson.load_options = { symbolize_keys: false }
+      end
+    rescue LoadError # rubocop:disable Lint/SuppressedException
     end
 
     it 'loads .yaml' do
@@ -17,6 +24,11 @@
       expect(contents['openapi']).to eq('3.0.0')
     end
 
+    it 'loads .json' do
+      contents = described_class.load('./spec/data/petstore.json')
+      expect(contents['openapi']).to eq('3.0.0')
+    end
+
     it 'raises FileNotFoundError if file was not found' do
       expect { described_class.load('./spec/data/unknown.yaml') }.to raise_error(OpenapiFirst::FileNotFoundError, 'File not found "./spec/data/unknown.yaml"')
     end

spec/openapi_first_spec.rb

@@ -38,6 +38,18 @@
   end
 
   describe '.load' do
+    begin
+      require 'multi_json'
+      before do
+        MultiJson.load_options = { symbolize_keys: true }
+      end
+
+      after do
+        MultiJson.load_options = { symbolize_keys: false }
+      end
+    rescue LoadError # rubocop:disable Lint/SuppressedException
+    end
+
     it 'returns a Definition' do
       expect(OpenapiFirst.load(spec_path)).to be_a OpenapiFirst::Definition
     end