rswag-specs 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fa644707054d546e889410d5715437f34c6704d4a85d70c2d5eba14768da89e
-  data.tar.gz: 9a175de33ad5ab07c111fbc03b475091ec5b51ea2a5c9be05c96fd46638a6f69
+  metadata.gz: fbf70bfdf1bb5ead3794e4d64a1afb85e00864701ec0cf42416a063b522fe489
+  data.tar.gz: ff39363f981f9a868e5afc47a00d87fbc629cda498118b024131318696e5e734
 SHA512:
-  metadata.gz: 5999a7bb27dbcb062e087e8ec1c0513c50f01921ebe6a24596013cdb25b9e3dc7e2e7f696df3fcea52667351e65919f79697e720d664bfe71e80c593db483d75
-  data.tar.gz: 9467528f8a10bb435542b8726b4b677dbb77729606523596f4134b9df59190e7b80e7d7816124f3fadfeb97c9ed329a9dfcd89a9ec6b5a50e21baf857a1c66f4
+  metadata.gz: e21b1bc504582ad44c5df4f24465a3751136ccd2e9114a95bc1aca95cc69b7a6110017c18faf3f2d854bdd596bf0612a56cb40803543c0a078143bc204083f37
+  data.tar.gz: bf21e075a70eb3e3a8712b8ee081aad9358cfe6472d258bacca82565b7d32426023e1c779a8b3e00b5c3496629357749d26daa6713bdfdd3a461cb72b601c773

data/lib/generators/rswag/specs/install/templates/swagger_helper.rb

@@ -13,8 +13,8 @@ RSpec.configure do |config|
   # document below. You can override this behavior by adding a swagger_doc tag to the
   # the root example_group in your specs, e.g. describe '...', swagger_doc: 'v2/swagger.json'
   config.swagger_docs = {
-    'v1/swagger.json' => {
-      swagger: '2.0',
+    'v1/swagger.yaml' => {
+      openapi: '3.0.1',
       info: {
         title: 'API V1',
         version: 'v1'
@@ -22,4 +22,10 @@ RSpec.configure do |config|
       paths: {}
     }
   }
+
+  # Specify the format of the output Swagger file when running 'rswag:specs:swaggerize'.
+  # The swagger_docs configuration option has the filename including format in
+  # the key, this may want to be changed to avoid putting yaml in json files.
+  # Defaults to json. Accepts ':json' and ':yaml'.
+  config.swagger_format = :yaml
 end

data/lib/rswag/specs.rb

@@ -12,6 +12,7 @@ module Rswag
       c.add_setting :swagger_root
       c.add_setting :swagger_docs
       c.add_setting :swagger_dry_run
+      c.add_setting :swagger_format
       c.extend ExampleGroupHelpers, type: :request
       c.include ExampleHelpers, type: :request
     end

data/lib/rswag/specs/configuration.rb

@@ -31,6 +31,14 @@ module Rswag
         end
       end
 
+      def swagger_format
+        @swagger_format ||= begin
+          @rspec_config.swagger_format = :json if @rspec_config.swagger_format.nil? || @rspec_config.swagger_format.empty?
+          raise ConfigurationError, "Unknown swagger_format '#{@rspec_config.swagger_format}'" unless [:json, :yaml].include?(@rspec_config.swagger_format)
+          @rspec_config.swagger_format
+        end
+      end
+
       def get_swagger_doc(name)
         return swagger_docs.values.first if name.nil?
         raise ConfigurationError, "Unknown swagger_doc '#{name}'" unless swagger_docs[name]

data/lib/rswag/specs/swagger_formatter.rb

@@ -37,7 +37,7 @@ module Rswag
           FileUtils.mkdir_p dirname unless File.exists?(dirname)
 
           File.open(file_path, 'w') do |file|
-            file.write(JSON.pretty_generate(doc))
+            file.write(pretty_generate(doc))
           end
 
           @output.puts "Swagger doc generated at #{file_path}"
@@ -46,6 +46,20 @@ module Rswag
 
       private
 
+      def pretty_generate(doc)
+        if @config.swagger_format == :yaml
+          clean_doc = yaml_prepare(doc)
+          YAML.dump(clean_doc)
+        else # config errors are thrown in 'def swagger_format', no throw needed here
+          JSON.pretty_generate(doc)
+        end
+      end
+
+      def yaml_prepare(doc)
+        json_doc = JSON.pretty_generate(doc)
+        clean_doc = JSON.parse(json_doc)
+      end
+
       def metadata_to_swagger(metadata)
         response_code = metadata[:response][:code]
         response = metadata[:response].reject { |k,v| k == :code }

data/lib/tasks/rswag-specs_tasks.rake

@@ -16,3 +16,6 @@ namespace :rswag do
     end
   end
 end
+
+task :rswag => ['rswag:specs:swaggerize']
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rswag-specs
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Richie Morris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-18 00:00:00.000000000 Z
+date: 2019-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -111,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: A Swagger-based DSL for rspec-rails & accompanying rake task for generating