rspec-openapi 0.3.19 → 0.3.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc42fc95d88e3523412bf9efbee6066b2789637a5b0213550f9d16711c1c9a94
-  data.tar.gz: fcaa99b78c4cc3404b9ee5b8cb9906fb3872b8c06ceb8ceb5d38f775015ae6ed
+  metadata.gz: d0ff0f4854e68684d59b37788218a797c61cdff744808237ca08818493a393eb
+  data.tar.gz: 0730c2487ccb75a2fd3bec8052136cb75b9410d42daea1e3a6c9826d6854df8d
 SHA512:
-  metadata.gz: aa9865db15800d17549ee640ed88b2d5f32289e4ac61a30db43cf0adf7021889123cedb96558032c0c8b25c03d5390897fa716352edb98c7a5c091b64210b924
-  data.tar.gz: 5da282aa5811e4a61f24f4c853200c3e8e786704d737eff325651eca75cef49c06fb96d1d7c9547afa821e98e807fa8cf1509c672b934a296e57927f584c3e14
+  metadata.gz: dadb96bc250a1c615176c5ada6e5dd6a41f1dec2a96099ef5181ac83e77d9c008168c0219c0a92d59bfc7a5ca0388138bcdd2641d8c5eb767d42a38a2cbd4096
+  data.tar.gz: 276bf5d35e634db31d6cdcaac519dac4972cbf0c93014c9c45d59a97bb0d2c20ee969c843f54e879eca8bab29cea0192cf36aab9c3ba5b0c2ee803692b0a5816

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## v0.3.20
+
+* Add `RSpec::OpenAPI.output` config to output JSON
+  [#31](https://github.com/k0kubun/rspec-openapi/pull/31)
+
 ## v0.3.19
 
 * Add `server_urls` and `request_headers` configs

data/README.md

@@ -108,6 +108,9 @@ The following configurations are optional.
 # Change the path to generate schema from `doc/openapi.yaml`
 RSpec::OpenAPI.path = 'doc/schema.yaml'
 
+# Change the output type yaml or json
+RSpec::OpenAPI.output = :json
+
 # Disable generating `example`
 RSpec::OpenAPI.enable_example = false
 
@@ -163,10 +166,6 @@ Beta
 
 Basic features are there, and some people are already using this.
 
-### Current limitation
-
-* Generating a JSON file is not supported yet
-
 ### Other missing features with notes
 
 * Delete obsoleted endpoints

data/lib/rspec/openapi/schema_file.rb

@@ -1,5 +1,6 @@
 require 'fileutils'
 require 'yaml'
+require 'json'
 
 # TODO: Support JSON
 class RSpec::OpenAPI::SchemaFile
@@ -20,13 +21,25 @@ class RSpec::OpenAPI::SchemaFile
   # @return [Hash]
   def read
     return {} unless File.exist?(@path)
-    YAML.load(File.read(@path))
+
+    content = File.read(@path)
+
+    return JSON.load(content) if json?
+
+    YAML.load(content)
   end
 
   # @param [Hash] spec
   def write(spec)
     FileUtils.mkdir_p(File.dirname(@path))
-    File.write(@path, prepend_comment(YAML.dump(spec)))
+
+    output = if json?
+               JSON.pretty_generate(spec)
+             else
+               prepend_comment(YAML.dump(spec))
+             end
+
+    File.write(@path, output)
   end
 
   def prepend_comment(content)
@@ -38,4 +51,8 @@ class RSpec::OpenAPI::SchemaFile
     end
     "#{comment.gsub(/^/, '# ').gsub(/^# \n/, "#\n")}#{content}"
   end
+
+  def json?
+    RSpec::OpenAPI.output.to_s == 'json'
+  end
 end

data/lib/rspec/openapi/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module OpenAPI
-    VERSION = '0.3.19'
+    VERSION = '0.3.20'
   end
 end

data/lib/rspec/openapi.rb

@@ -7,10 +7,11 @@ module RSpec::OpenAPI
   @enable_example = true
   @description_builder = -> (example) { example.description }
   @application_version = '1.0.0'
+  @output = :yaml
   @request_headers = []
   @server_urls = []
 
   class << self
-    attr_accessor :path, :comment, :enable_example, :description_builder, :application_version, :request_headers, :server_urls
+    attr_accessor :path, :comment, :enable_example, :description_builder, :application_version, :request_headers, :server_urls, :output
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.3.19
+  version: 0.3.20
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-26 00:00:00.000000000 Z
+date: 2021-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -90,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Generate OpenAPI schema from RSpec request specs