rspec-openapi 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9534432fc4ab2f67ce016ed07e0c36c687c201e4c1c01388beb4d845a24def6d
-  data.tar.gz: e7884e1ea34519588d2c008af56faaf7c7435f5c287ec5408515a6b66d16cb7c
+  metadata.gz: adaf5569dc17aa32bf1f570f77023097aed29ce2b76ee9c9c62ab5b48208dc31
+  data.tar.gz: ddf2e7c33c5a02a86f610dc68d6e3a46f1be0a44b2df838ab1681c9e09cca5dc
 SHA512:
-  metadata.gz: 50af774aa04fc4fc47a52b89ce4355b313faa5d201796aff05f30fdb275d411b6f1bfcbb7762f3a6363484cec9ab69067c70dba1fc867f163631061d0629c874
-  data.tar.gz: 7498b91af6496b0d4a500405c194584425ca32276f6c9fedbbe92f431c370a035210f99ec103a33d595dc4f18cc2de361cea98f327a4324d3ebbd23a3bcfbb54
+  metadata.gz: 07011c0a01fce891827ee62898a814ce653f17b68a13dca3dd11c4b166e3ef0c864675a43a86c8f94175ea50936d0cfb3a3a386c2c1eeaf68c13f3c180731be2
+  data.tar.gz: cb24d803cc198dd7df3578147a54c4160dbd160bb642e5ecfad149c5c119a3d6cd35a2fba02618b7c58a2511b5907129ced6d408fbe2e341cd616d0224f01a4d

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+## v0.1.5
+
+* Support detecting `float` type [#2](https://github.com/k0kubun/rspec-openapi/issues/2)
+
+## v0.1.4
+
+* Avoid NoMethodError on nil Content-Type
+* Include a space between controller and action in summary
+
+## v0.1.3
+
+* Add `RSpec::OpenAPI.comment` configuration
+
+## v0.1.2
+
+* Generate `required: true` for path params [#1](https://github.com/k0kubun/rspec-openapi/issues/1)
+
+## v0.1.1
+
+* Generate a path like `/{id}` instead of `/:id`
+
 ## v0.1.0
 
 * Initial release

data/README.md

@@ -29,7 +29,7 @@ $ OPENAPI=1 rspec
 
 ### Example
 
-Let's say you have [a request spec](./spec/requests/table_spec.rb) like this:
+Let's say you have [a request spec](./spec/requests/tables_spec.rb) like this:
 
 ```rb
 RSpec.describe 'Tables', type: :request do
@@ -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:
@@ -64,7 +64,7 @@ info:
 paths:
   "/tables":
     get:
-      summary: tables#index
+      summary: 'tables #index'
       parameters:
       - name: page
         in: query
@@ -98,10 +98,19 @@ and the schema file can be used as an input of [Swagger UI](https://github.com/s
 
 ### Configuration
 
-If you want to change the path to generate a spec from `doc/openapi.yaml`, use:
+The following configurations are optional.
 
 ```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_builder.rb

@@ -4,9 +4,9 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
   def build(record)
     {
       paths: {
-        record.path => {
+        normalize_path(record.path) => {
           record.method.downcase => {
-            summary: "#{record.controller}##{record.action}",
+            summary: "#{record.controller} ##{record.action}",
             parameters: build_parameters(record),
             requestBody: build_request_body(record),
             responses: {
@@ -35,6 +35,7 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
       parameters << {
         name: key.to_s,
         in: 'path',
+        required: true,
         schema: build_property(try_cast(value)),
       }
     end
@@ -83,6 +84,8 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
     case value
     when String
       'string'
+    when Float
+      'float'
     when Integer
       'integer'
     when TrueClass, FalseClass
@@ -107,7 +110,11 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
     end
   end
 
+  def normalize_path(path)
+    path.gsub(%r|/:([^:/]+)|, '/{\1}')
+  end
+
   def normalize_content_type(content_type)
-    content_type.sub(/;.+\z/, '')
+    content_type&.sub(/;.+\z/, '')
   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.0'
+    VERSION = '0.1.5'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-19 00:00:00.000000000 Z
+date: 2020-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec