rspec-openapi 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f16d83f7a23388930df36ade00c6a17dfc53de509eac6c3a5d99c41235bd281b
-  data.tar.gz: 9b65d3f8942388bfe9b62435ceef108ff55bc7e9f15af2c63bfee67bb10197ec
+  metadata.gz: 934be20ed834fa8fa6c975eccf5c63f218b06a80136e6a50920914d4bfd867d0
+  data.tar.gz: 4921448fe86bf5ad591cf73ab965c38667df4d37daa319d696e8c42e614dcb7a
 SHA512:
-  metadata.gz: 447d354f4c0ef64cf78fd9eb2b0f47b42d943d12f9c73cc6eb51ef3ba20a931b7a4cc6c0fd214ece15214a029fc0ab28d6b028b774f652a10940806d3df5e014
-  data.tar.gz: 44566e265fbca4419f15cc8d59948804f72b133092fe5a920bcd80bc889959ccee201395c3cf8c76849daa552d9ecbc094d271ff5885a0e972a2ad8b1752dfb1
+  metadata.gz: d45c922230748ab26637a1865aa4cd82a201f84a314b0c18a2a9ed820c9819b17f8506bcc8dbc6e67f0b6b84ed6eb88de061d53981ef99dacdcfdf54c09dbb27
+  data.tar.gz: 3ffb70c7167f312511febf9969e69ef8e3bc6b6757115ae3f400a46d9628475e5681e976e389011459e5a7891940fbbb62089d059b962e055e4c0306ce1a6a44

data/CHANGELOG.md

@@ -1,6 +1,10 @@
+## v0.1.3
+
+* Add `RSpec::OpenAPI.comment` configuration
+
 ## v0.1.2
 
-* Generate `required: true` for path params
+* Generate `required: true` for path params [#1](https://github.com/k0kubun/rspec-openapi/issues/1)
 
 ## v0.1.1
 

data/README.md

@@ -52,7 +52,7 @@ end
 If you run the spec with `OPENAPI=1`,
 
 ```
-OPENAPI=1 be rspec spec/requests/tables_spec.rb
+OPENAPI=1 rspec spec/requests/tables_spec.rb
 ```
 
 It will generate [`doc/openapi.yaml` file](./spec/railsapp/doc/openapi.yaml) like:
@@ -101,7 +101,16 @@ and the schema file can be used as an input of [Swagger UI](https://github.com/s
 If you want to change the path to generate a spec from `doc/openapi.yaml`, use:
 
 ```rb
+# Change the path to generate schema from `doc/openapi.yaml`
 RSpec::OpenAPI.path = 'doc/schema.yaml'
+
+# 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
+
+  When you write a spec in spec/requests, running the spec with `OPENAPI=1 rspec` will
+  update this file automatically. You can also manually edit this file.
+EOS
 ```
 
 ### How can I add information which can't be generated from RSpec?

data/lib/rspec/openapi.rb

@@ -5,6 +5,6 @@ module RSpec::OpenAPI
   @path = 'doc/openapi.yaml'
 
   class << self
-    attr_accessor :path
+    attr_accessor :path, :comment
   end
 end

data/lib/rspec/openapi/schema_file.rb

@@ -26,6 +26,16 @@ class RSpec::OpenAPI::SchemaFile
   # @param [Hash] spec
   def write(spec)
     FileUtils.mkdir_p(File.dirname(@path))
-    File.write(@path, YAML.dump(spec))
+    File.write(@path, prepend_comment(YAML.dump(spec)))
+  end
+
+  def prepend_comment(content)
+    return content if RSpec::OpenAPI.comment.nil?
+
+    comment = RSpec::OpenAPI.comment.dup
+    unless comment.end_with?("\n")
+      comment << "\n"
+    end
+    "#{comment.gsub(/^/, '# ').gsub(/^# \n/, "#\n")}#{content}"
   end
 end

data/lib/rspec/openapi/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module OpenAPI
-    VERSION = '0.1.2'
+    VERSION = '0.1.3'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Takashi Kokubun