Add yaml support (#7)

rswag-specs/spec/rswag/specs/configuration_spec.rb

@@ -8,7 +8,9 @@ module OpenApi
       describe Configuration do
         subject { described_class.new(rspec_config) }
 
-        let(:rspec_config) { OpenStruct.new(swagger_root: swagger_root, swagger_docs: swagger_docs) }
+        let(:rspec_config) do
+          OpenStruct.new(swagger_root: swagger_root, swagger_docs: swagger_docs, swagger_format: swagger_format)
+        end
         let(:swagger_root) { 'foobar' }
         let(:swagger_docs) do
           {
@@ -16,6 +18,7 @@ module OpenApi
               'v2/swagger.json' => { info: { title: 'v2' } }
           }
         end
+        let(:swagger_format) { :yaml }
 
         describe '#swagger_root' do
           let(:response) { subject.swagger_root }
@@ -48,6 +51,26 @@ module OpenApi
           end
         end
 
+        describe '#swagger_format' do
+          let(:response) { subject.swagger_format }
+
+          context 'provided in rspec config' do
+            it { expect(response).to be_an_instance_of(Symbol) }
+          end
+
+          context 'unsupported format provided' do
+            let(:swagger_format) { :xml }
+
+            it { expect { response }.to raise_error ConfigurationError }
+          end
+
+          context 'not provided' do
+            let(:swagger_format) { nil }
+
+            it { expect(response).to eq(:json) }
+          end
+        end
+
         describe '#get_swagger_doc(tag=nil)' do
           let(:swagger_doc) { subject.get_swagger_doc(tag) }
 

rswag-specs/spec/rswag/specs/swagger_formatter_spec.rb

@@ -55,14 +55,31 @@ module OpenApi
                 'v1/swagger.json' => { info: { version: 'v1' } },
                 'v2/swagger.json' => { info: { version: 'v2' } }
             )
+            allow(config).to receive(:swagger_format).and_return(swagger_format)
             subject.stop(notification)
           end
 
           let(:notification) { double('notification') }
 
-          it 'writes the swagger_doc(s) to file' do
-            expect(File).to exist("#{swagger_root}/v1/swagger.json")
-            expect(File).to exist("#{swagger_root}/v2/swagger.json")
+          context 'with default format' do
+            let(:swagger_format) { :json }
+
+            it 'writes the swagger_doc(s) to file' do
+              expect(File).to exist("#{swagger_root}/v1/swagger.json")
+              expect(File).to exist("#{swagger_root}/v2/swagger.json")
+              expect { JSON.parse(File.read("#{swagger_root}/v2/swagger.json")) }.not_to raise_error
+            end
+          end
+
+          context 'with yaml format' do
+            let(:swagger_format) { :yaml }
+
+            it 'writes the swagger_doc(s) as yaml' do
+              expect(File).to exist("#{swagger_root}/v1/swagger.json")
+              expect { JSON.parse(File.read("#{swagger_root}/v1/swagger.json")) }.to raise_error(JSON::ParserError)
+              # Psych::DisallowedClass would be raised if we do not pre-process ruby symbols
+              expect { YAML.safe_load(File.read("#{swagger_root}/v1/swagger.json")) }.not_to raise_error
+            end
           end
 
           after do