swaggard 4.0.3 → 4.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cd440c54fb4a517bedb134570c0dd76ed67ef1ef1947d0bcd89dc72f70d89a8
-  data.tar.gz: cdc795955a2d5d3d89e570657da280fa6fb4873a5bd562f086def5871c035354
+  metadata.gz: 74bd791cc89ad2a4bd1c6d2f04dd0d4d0554083ec34fdb77ade0e9d1303d8183
+  data.tar.gz: e535e2f373af7c06ac2b088af0359feb9a67fbd14e65b24204fa4944c28046c3
 SHA512:
-  metadata.gz: e0789daceebcc72d62aca37584b4a2163bc1d5de00d20e22d990a8556797492d29fda8ac85acdbacbfde76b8c985047db02b656e0c91686ac386be7b4c9f088f
-  data.tar.gz: d860cfcc26f4c3a6c241fb5409ed3077c8330023b171b6c8a729e300056166ee58afd94020f43598d271b488c12ec1192265cbcc8ac2d2ed8bbd62677b3be959
+  metadata.gz: 4a15e9bdd53d788aa02c63df29eac1432f623fdfc1d35ac250cf4c6a1810dc3065682e141735cafc0e33684671afe8f25465d95ee9bc451e30f3434a59eb50b6
+  data.tar.gz: 166fed2b90cbfcd83f1c7250b6244c0485e07d999657707a1d433d03316fd2eefc67fb710f488c73a2e762898213791cc5eb8a4bb4ae4ed5f5f3ac58806e5939

data/lib/swaggard/swagger/definition.rb

@@ -5,13 +5,14 @@ module Swaggard
       attr_reader :id
       attr_writer :description, :title, :ignore_inherited
 
-      def initialize(id, ancestors: [])
+      def initialize(id, ancestors: [], collection: false)
         @id = id
         @title = ''
         @properties = []
         @description = ''
         @ancestors = ancestors
         @ignore_inherited = false
+        @collection = collection
       end
 
       def add_property(property)
@@ -41,19 +42,31 @@ module Swaggard
       end
 
       def to_doc(definitions)
-        {}.tap do |doc|
-          doc['title'] = @title if @title.present?
-          doc['type']  = 'object'
+        all_properties = properties(definitions)
+        properties_hash = Hash[all_properties.map { |property| [property.id, property.to_doc] }]
+        required_properties = all_properties.select(&:required?).map(&:id)
 
-          doc['description'] = @description if @description.present?
+        if @collection
+          items = { 'type' => 'object', 'properties' => properties_hash }
+          items['required'] = required_properties if required_properties.any?
 
-          all_properties = properties(definitions)
+          {}.tap do |doc|
+            doc['title'] = @title if @title.present?
+            doc['type'] = 'array'
+            doc['description'] = @description if @description.present?
+            doc['items'] = items
+          end
+        else
+          {}.tap do |doc|
+            doc['title'] = @title if @title.present?
+            doc['type']  = 'object'
 
-          doc['properties'] =  Hash[all_properties.map { |property| [property.id, property.to_doc] }]
-          required_properties = all_properties.select(&:required?).map(&:id)
-          doc['required'] = required_properties if required_properties.any?
-        end
+            doc['description'] = @description if @description.present?
 
+            doc['properties'] = properties_hash
+            doc['required'] = required_properties if required_properties.any?
+          end
+        end
       end
 
     end

data/lib/swaggard/version.rb

@@ -1,3 +1,3 @@
 module Swaggard
-  VERSION = '4.0.3'
+  VERSION = '4.0.4'
 end

data/spec/swaggard/swagger/definition_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Swaggard::Swagger::Definition do
+  let(:property) { Swaggard::Swagger::Property.new('name', Swaggard::Swagger::Type.new(:string)) }
+
+  describe '#to_doc' do
+    context 'when collection is false (default)' do
+      subject(:definition) { described_class.new('Foo') }
+
+      before { definition.add_property(property) }
+
+      it 'emits a type: object schema with inline properties' do
+        expect(definition.to_doc({})).to eq(
+          'type' => 'object',
+          'properties' => { 'name' => { 'type' => 'string' } }
+        )
+      end
+    end
+
+    context 'when collection is true' do
+      subject(:definition) { described_class.new('Foo_all', collection: true) }
+
+      before { definition.add_property(property) }
+
+      it 'emits a type: array schema with properties wrapped under items' do
+        expect(definition.to_doc({})).to eq(
+          'type' => 'array',
+          'items' => {
+            'type' => 'object',
+            'properties' => { 'name' => { 'type' => 'string' } }
+          }
+        )
+      end
+
+      context 'with required properties' do
+        let(:property) do
+          Swaggard::Swagger::Property.new('name', Swaggard::Swagger::Type.new(:string), '', true)
+        end
+
+        it 'places the required array inside items' do
+          doc = definition.to_doc({})
+
+          expect(doc['required']).to be_nil
+          expect(doc['items']['required']).to eq(['name'])
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swaggard
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 4.0.4
 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/swagger/definition_spec.rb
 homepage: https://github.com/adrian-gomez/swaggard
 licenses:
 - MIT
@@ -199,3 +200,4 @@ test_files:
 - spec/integration/openapi_spec.rb
 - spec/integration/swaggard_spec.rb
 - spec/spec_helper.rb
+- spec/swaggard/swagger/definition_spec.rb