rspec-openapi 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb2aae5a8366967c1ce6a904bb990372af7f5d3b09d4c81fad3866e590c168c3
-  data.tar.gz: 0665f9348a14cb0eb77c37368f69d3952d6eb71e919d8864931cdfbbbc3055dc
+  metadata.gz: 11f6fd4a506ac6f481fa67c33e2bacecba3ee4e568339338acf4237f4f599bac
+  data.tar.gz: 45ea7bbf466a413d3eb5d32ae19a38591c542431eee4dcb21905b8070b2280ac
 SHA512:
-  metadata.gz: 69ec6408d396d9e4c75bc4ba3ef1c71f82ea2a7bbd67def082262b275c20b9769db851fdb2c1bea971a4ede35c10b6f325fbc35a73be8591f12a986e94a01637
-  data.tar.gz: b71662890f9710012a329db3f380f831e10a8d37671fd9db2a9e3b84d237c699c0c40892020e4f20c781b36ab68563205208bc51607f73f5b2f002c80b5c48de
+  metadata.gz: 3b98372303bb006dba766c0b48218c4be8a45a84f470d6cdfc40b3e7f9d780edb484ca58373239a6aeeba83c7f4c8c3daf8c241cdcb903cc1158c80c92269203
+  data.tar.gz: 8a198194bdc3e4bf0d09f6fe66b1893da1eaa4b0333c1168b9bd309ba26634ab16d53342c140f8d7b4c0f31e02cfc1ba9629b5dc12905dfc5e6eb35990f23c30

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.2.2
+
+* Allow disabling `example` by `RSpec::OpenAPI.enable_example = false`
+
 ## v0.2.1
 
 * Generate `example` of request body and path / query params

data/README.md

@@ -104,6 +104,9 @@ The following configurations are optional.
 # Change the path to generate schema from `doc/openapi.yaml`
 RSpec::OpenAPI.path = 'doc/schema.yaml'
 
+# Disable generating `example`
+RSpec::OpenAPI.enable_example = false
+
 # Generate a comment on top of a schema file
 RSpec::OpenAPI.comment = <<~EOS
   This file is auto-generated by rspec-openapi https://github.com/k0kubun/rspec-openapi
@@ -138,9 +141,9 @@ end
 
 ## Project status
 
-PoC / Experimental
+Beta
 
-This worked for some of my Rails apps, but this may raise a basic error for your app.
+Basic features are there, and some people are already using this.
 
 ### Current limitations
 

data/lib/rspec/openapi.rb

@@ -3,8 +3,10 @@ require 'rspec/openapi/hooks' if ENV['OPENAPI']
 
 module RSpec::OpenAPI
   @path = 'doc/openapi.yaml'
+  @comment = nil
+  @enable_example = true
 
   class << self
-    attr_accessor :path, :comment
+    attr_accessor :path, :comment, :enable_example
   end
 end

data/lib/rspec/openapi/schema_builder.rb

@@ -15,8 +15,8 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
                 content: {
                   normalize_content_type(record.response_content_type) => {
                     schema: build_property(record.response_body),
-                    example: record.response_body,
-                  },
+                    example: (record.response_body if example_enabled?),
+                  }.compact,
                 },
               },
             },
@@ -28,6 +28,10 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
 
   private
 
+  def example_enabled?
+    RSpec::OpenAPI.enable_example
+  end
+
   def build_parameters(record)
     parameters = []
 
@@ -38,8 +42,8 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
         in: 'path',
         required: true,
         schema: build_property(try_cast(value)),
-        example: try_cast(value),
-      }
+        example: (try_cast(value) if example_enabled?),
+      }.compact
     end
 
     record.query_params.each do |key, value|
@@ -47,8 +51,8 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
         name: key.to_s,
         in: 'query',
         schema: build_property(try_cast(value)),
-        example: try_cast(value),
-      }
+        example: (try_cast(value) if example_enabled?),
+      }.compact
     end
 
     return nil if parameters.empty?
@@ -63,8 +67,8 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
       content: {
         normalize_content_type(record.request_content_type) => {
           schema: build_property(record.request_params),
-          example: record.request_params,
-        }
+          example: (record.request_params if example_enabled?),
+        }.compact
       }
     }
   end

data/lib/rspec/openapi/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module OpenAPI
-    VERSION = '0.2.1'
+    VERSION = '0.2.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -74,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.pre1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Generate OpenAPI schema from RSpec request specs