dry-swagger 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b13a0cda4f7abf7bc7e5438b5b4be9e91f2a06f46abc38d431ce8f6df9ba20ed
-  data.tar.gz: 7d3d42835269384bd81df3a687528e23a125bdbb40a30d54b34d0c517fbe5993
+  metadata.gz: 5179183ed4122bcf5042f8aa812b6830b1126ae00d4eb2975bd17203af2bf375
+  data.tar.gz: 9eb614eaaaca4752a39f9a77ef2fac3dffb4df2179a0c7e7f427d13f9f02333e
 SHA512:
-  metadata.gz: ffb3be97689579101a317b3e3747b6fd033a2d66bd37644135a029a6a5ca228e4bec4974d2a59ae1339a720b11f5de2bb32aa9f94e7f6be3dac4e9b87b699a7d
-  data.tar.gz: e7164332db7a8c1e07048632180c1a4576ea4608e530fc4545ca5358e2169dc2db16236df17ed7356e8888bd8ed492ed196688df9113905521e7a94801d69ecb
+  metadata.gz: 58dea258473d5fea4c521d699a2332ec8a444d15504b81ff3eefba0ef50c08371fe5d9b3fd7e2d3331613375f625bdb3ea54073dde31cfc20eafdc0d29e49202
+  data.tar.gz: 2ec6862a8021cb836101cac89b394482507a6b48021cfbf304b63c8753fe0bcefb822730a194ae869da6c83dc34e965af771a58b6052dc729cea0d528a97b6a4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dry-swagger (0.4.2)
+    dry-swagger (0.5.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/dry/swagger/documentation_generator.rb

@@ -19,7 +19,11 @@ module Dry
         documentation = { properties: {}, required: [] }
         fields.each do |field_name, attributes_hash|
           documentation[:properties][field_name] = generate_field_properties(attributes_hash)
-          documentation[:required] << field_name if attributes_hash.fetch(:required, true) && @config.enable_required_validation
+          if attributes_hash.is_a?(Hash)
+            documentation[:required] << field_name if attributes_hash.fetch(:required, true) && @config.enable_required_validation
+          else
+            documentation[:required] << field_name if attributes_hash[0].fetch(:required, true) && @config.enable_required_validation
+          end
 
         rescue Errors::MissingTypeError => e
           raise StandardError.new e.message % { field_name: field_name, valid_types: SWAGGER_FIELD_TYPE_DEFINITIONS.keys, attributes_hash: attributes_hash }
@@ -31,35 +35,48 @@ module Dry
       end
 
       def generate_field_properties(attributes_hash)
-        if attributes_hash[:type] == 'array'
-          items = generate_documentation(attributes_hash.fetch(:keys))
-          items =  @config.enable_nullable_validation ?
-                       items.merge(@config.nullable_type => attributes_hash.fetch(@config.nullable_type, false)) :
-                       items.merge(@config.nullable_type => true)
-          documentation = { type: :array, items: items }
-        elsif attributes_hash[:array] && attributes_hash.fetch(:type) != 'array'
-          items = SWAGGER_FIELD_TYPE_DEFINITIONS.fetch(attributes_hash.fetch(:type))
-          items = @config.enable_nullable_validation ?
-                      items.merge(@config.nullable_type => attributes_hash.fetch(@config.nullable_type, false)) :
-                      items.merge(@config.nullable_type => true)
-          documentation = { type: :array, items:  items }
-        elsif attributes_hash[:type] == 'hash'
-          raise Errors::MissingHashSchemaError.new unless attributes_hash[:keys]
-          documentation = generate_documentation(attributes_hash.fetch(:keys))
-        else
-          documentation = SWAGGER_FIELD_TYPE_DEFINITIONS.fetch(attributes_hash.fetch(:type))
-          if attributes_hash[:enum] && @config.enable_enums
-            documentation = documentation.merge(enum: attributes_hash.fetch(:enum))
+        if attributes_hash.is_a?(Array)
+          properties = {}
+          attributes_hash.each_with_index do |_, index|
+            properties["definition_#{index + 1}"] = generate_field_properties(attributes_hash[index])
           end
+          {
+              oneOf: attributes_hash.map{ |it| generate_field_properties(it) },
+              type: :object,
+              properties: properties,
+              example: 'Dynamic Field. See Model Definitions'
+          }
+        else
+          if attributes_hash[:type] == 'array'
+            items = generate_documentation(attributes_hash.fetch(:keys))
+            items =  @config.enable_nullable_validation ?
+                         items.merge(@config.nullable_type => attributes_hash.fetch(@config.nullable_type, false)) :
+                         items.merge(@config.nullable_type => true)
+            documentation = { type: :array, items: items }
+          elsif attributes_hash[:array] && attributes_hash.fetch(:type) != 'array'
+            items = SWAGGER_FIELD_TYPE_DEFINITIONS.fetch(attributes_hash.fetch(:type))
+            items = @config.enable_nullable_validation ?
+                        items.merge(@config.nullable_type => attributes_hash.fetch(@config.nullable_type, false)) :
+                        items.merge(@config.nullable_type => true)
+            documentation = { type: :array, items:  items }
+          elsif attributes_hash[:type] == 'hash'
+            raise Errors::MissingHashSchemaError.new unless attributes_hash[:keys]
+            documentation = generate_documentation(attributes_hash.fetch(:keys))
+          else
+            documentation = SWAGGER_FIELD_TYPE_DEFINITIONS.fetch(attributes_hash.fetch(:type))
+            if attributes_hash[:enum] && @config.enable_enums
+              documentation = documentation.merge(enum: attributes_hash.fetch(:enum))
+            end
 
-          if attributes_hash[:description] && @config.enable_descriptions
-            documentation = documentation.merge(description: attributes_hash.fetch(:description))
+            if attributes_hash[:description] && @config.enable_descriptions
+              documentation = documentation.merge(description: attributes_hash.fetch(:description))
+            end
           end
-        end
 
-        @config.enable_nullable_validation ?
-            documentation.merge(@config.nullable_type => attributes_hash.fetch(@config.nullable_type, false)) :
-            documentation.merge(@config.nullable_type => true)
+          @config.enable_nullable_validation ?
+              documentation.merge(@config.nullable_type => attributes_hash.fetch(@config.nullable_type, false)) :
+              documentation.merge(@config.nullable_type => true)
+        end
 
       rescue KeyError
         raise Errors::MissingTypeError.new

data/lib/dry/swagger/struct_parser.rb

@@ -15,7 +15,7 @@ module Dry
 
       def initialize
         @keys = {}
-        @config = Config::StructConfiguration
+        @config = Dry::Swagger::Config::StructConfiguration
       end
 
       def to_h
@@ -54,12 +54,18 @@ module Dry
 
         type = opts[:array]? 'array' : 'hash'
 
-        keys[key] = {
+        definition = {
             type: type,
             required: required,
             @config.nullable_type => nullable,
             **target_info
         }
+
+        if opts[:oneOf]
+          keys[key] = keys[key] ? keys[key] << definition : [definition]
+        else
+          keys[key] = definition
+        end
       end
 
       def visit_key(node, opts = {})
@@ -113,8 +119,10 @@ module Dry
         if node[0][0].equal?(:constrained)
           opts[:nullable] = true
           visit(node[1], opts) # ignore NilClass constrained
-        elsif node[0][0].equal?(:struct)
-          visit(node[0], opts) # grab left operand, this means if you have it defined as DTO1 | DTO2, it will grab DTO1
+        elsif node[0][0].equal?(:struct) && node[1][0].equal?(:struct)
+          opts[:oneOf] = true
+          visit(node[0], opts)
+          visit(node[1], opts)
         end
       end
 

data/lib/dry/swagger/version.rb

@@ -1,5 +1,5 @@
 module Dry
   module Swagger
-    VERSION = "0.4.2"
+    VERSION = "0.5.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-swagger
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Jane-Terziev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-01 00:00:00.000000000 Z
+date: 2021-08-03 00:00:00.000000000 Z
 dependencies: []
 description: A parser which converts dry-validation or dry-struct into valid swagger
   documentation