swaggard 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28d2106f9e0d61087b74c97d99c4e3e6c848b9bee4afa7fb6a828db0466cb134
-  data.tar.gz: 668252d84bbdc87a23ed4191cc5baae2c2c7dfbe2b06cb794d8a7fe947cbf70c
+  metadata.gz: 22712f08a524289197fef03b0fa4b6e2f9b76bb998c78909ca0b8459a240b0fd
+  data.tar.gz: c6002db5029e1013e0597a041dae4ce1ce03622e5245647bd9249d2524e5ccaf
 SHA512:
-  metadata.gz: fbc1a171bbb0b3eaf2d285e4eebb9e3b2d76196745865afb727de157be519be9604d12af0745c9d2a7d73a5b52f0916230e98372bbc94af67159552cf72302dc
-  data.tar.gz: a648d45fc2cffc78502e548ccafcfbc2ff4ece0bccee7a75b3d4827cffab98d1672304bca5d63bcd1b94f1f0dc4d7a8cd373faea5adf61ca356f4f553928493c
+  metadata.gz: a4cc784c4e3f5e930e5be443bc3c026da984194087c939867eea961e77b5259b4ec84daef72802bfbb44519cf2da5fb2834bdacc7eaafdc62e94cf4a213b2ee3
+  data.tar.gz: 06e9c4079d1dd6ae1f12a6bdd69b79279ae1d2481629e15a11b6beab3900fe1957f8b32b083951512a2dcc819eadbe6fe979b963ba177ba0b0f6bfc0bfab96e5

data/lib/swaggard/api_definition.rb

@@ -66,7 +66,9 @@ module Swaggard
     def format_path(path)
       return path unless Swaggard.configuration.exclude_base_path_from_paths
 
-      path.gsub(Swaggard.configuration.api_base_path, '')
+      base_path = Swaggard.configuration.api_base_path
+
+      path.sub(/\A#{Regexp.escape(base_path)}/, '')
     end
 
     def build_components

data/lib/swaggard/swagger/operation.rb

@@ -19,6 +19,7 @@ module Swaggard
         @summary = (yard_object.docstring.lines.first || '').chomp
         @parameters  = []
         @responses = []
+        @deprecated = false
 
         @description = (yard_object.docstring.lines[1..-1] || []).map(&:chomp).reject(&:empty?).compact.join("\n")
         @http_method = verb
@@ -32,6 +33,8 @@ module Swaggard
           case yard_tag.tag_name
           when 'operation_id'
             @operation_id = "#{@tag.name}.#{value}"
+          when 'deprecated'
+            @deprecated = true
           when 'query_parameter'
             @parameters << Parameters::Query.new(value)
           when 'form_parameter'
@@ -98,6 +101,8 @@ module Swaggard
           doc['requestBody'] = build_form_request_body(form_params)
         end
 
+        doc['deprecated'] = true if @deprecated
+
         doc
       end
 

data/lib/swaggard/version.rb

@@ -1,3 +1,3 @@
 module Swaggard
-  VERSION = '4.1.0'
+  VERSION = '4.2.0'
 end

data/lib/swaggard.rb

@@ -24,6 +24,7 @@ module Swaggard
     def register_custom_yard_tags!
       ::YARD::Tags::Library.define_tag('Controller\'s tag', :tag)
       ::YARD::Tags::Library.define_tag('Operation id', :operation_id)
+      ::YARD::Tags::Library.define_tag('Deprecated', :deprecated)
       ::YARD::Tags::Library.define_tag('Query parameter', :query_parameter)
       ::YARD::Tags::Library.define_tag('Form parameter', :form_parameter)
       ::YARD::Tags::Library.define_tag('Body required', :body_required)

data/spec/fixtures/api.json

@@ -80,7 +80,8 @@
               }
             }
           }
-        }
+        },
+        "deprecated": true
       }
     },
     "/pets/{id}": {

data/spec/fixtures/dummy/app/controllers/pets_controller.rb

@@ -15,6 +15,7 @@ class PetsController < ApplicationController
 
   # create a new Pet
   #
+  # @deprecated
   # @body_required
   # @body_definition PetBody
   def create

data/spec/swaggard/api_definition_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Swaggard::ApiDefinition do
+  describe '#format_path' do
+    subject(:formatted) { described_class.new.send(:format_path, path) }
+
+    let(:original_base_path) { Swaggard.configuration.api_base_path }
+    let(:original_exclude)   { Swaggard.configuration.exclude_base_path_from_paths }
+
+    before do
+      original_base_path
+      original_exclude
+      Swaggard.configuration.api_base_path = '/api'
+      Swaggard.configuration.exclude_base_path_from_paths = true
+    end
+
+    after do
+      Swaggard.configuration.api_base_path = original_base_path
+      Swaggard.configuration.exclude_base_path_from_paths = original_exclude
+    end
+
+    context 'when the base path also appears inside a later path segment' do
+      let(:path) { '/api/partner/api_keys' }
+
+      it 'strips only the leading base path, not every occurrence' do
+        expect(formatted).to eq('/partner/api_keys')
+      end
+    end
+
+    context 'with a path that only contains the leading base path' do
+      let(:path) { '/api/partner/products' }
+
+      it 'strips the leading base path' do
+        expect(formatted).to eq('/partner/products')
+      end
+    end
+
+    context 'when exclude_base_path_from_paths is disabled' do
+      let(:path) { '/api/partner/api_keys' }
+
+      before { Swaggard.configuration.exclude_base_path_from_paths = false }
+
+      it 'returns the path unchanged' do
+        expect(formatted).to eq('/api/partner/api_keys')
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swaggard
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Adrian Gomez
@@ -162,6 +162,7 @@ files:
 - spec/integration/openapi_spec.rb
 - spec/integration/swaggard_spec.rb
 - spec/spec_helper.rb
+- spec/swaggard/api_definition_spec.rb
 - spec/swaggard/parsers/property_spec.rb
 - spec/swaggard/swagger/definition_spec.rb
 - spec/swaggard/swagger/parameters/body_spec.rb
@@ -203,6 +204,7 @@ test_files:
 - spec/integration/openapi_spec.rb
 - spec/integration/swaggard_spec.rb
 - spec/spec_helper.rb
+- spec/swaggard/api_definition_spec.rb
 - spec/swaggard/parsers/property_spec.rb
 - spec/swaggard/swagger/definition_spec.rb
 - spec/swaggard/swagger/parameters/body_spec.rb