dry-swagger 0.4.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76187fb16daf0690d5cea5b3725d6c0a50ea8a69fa5172557e233c4832ab776d
-  data.tar.gz: 8c0c9bd3ba2574e8f6b081cf7248b85f03ce12cc0240cf08bce6e09962eaf067
+  metadata.gz: 7ed13f9dd94583c53a6397262cd798a8a8897b4ac7d7f1c4484116751ff37e5d
+  data.tar.gz: 777014e503f1f3febde2662275cf858a423806671e0ee4a843be3af43287df10
 SHA512:
-  metadata.gz: fc5e7e55e448a6964f12038de02d5f3b90c16cb7d950c3154dbe3df863cc3c14f76838c556ac8c538a3da50ed5f62b30b0266a5da3d3f8d83ce44546d8f18cd2
-  data.tar.gz: 0e3cc570dda791eaed872f7ea98f2404b16c80cbe73caadfdfd6e1e68bbdec576e339c839e70454fafa99757d2e57f4c81493be3514e0555ad079e611fc7dafd
+  metadata.gz: 16a4528fbed7c9dfaba78a4757f489f49e80ffef3801b8cf5a10a49c13951530789ffb2ef1e89daba94b618ef8c3348cb4d4790e4e26db420eef74548cc51664
+  data.tar.gz: a3411261ed52732f5d85fa7402fe232fbd4596b0d4618e22316d8f7f37ee70715481340a9256969a81418ba6c99b2321bcd09570ca371a9ec9c27702c48b5f2b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dry-swagger (0.4.1)
+    dry-swagger (0.5.2)
 
 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,61 @@ 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
+          if attributes_hash[0][:type] == 'array'
+            attributes_hash.each { |definition| definition[:type] = 'hash'}
+            {
+                type: :array,
+                items: {
+                    type: :object,
+                    properties: properties,
+                    oneOf: attributes_hash.map{ |it| generate_field_properties(it) },
+                    example: 'Dynamic Field. See Model Definitions'
+                },
+            }
+          else
+            {
+                oneOf: attributes_hash.map{ |it| generate_field_properties(it) },
+                type: :object,
+                properties: properties,
+                example: 'Dynamic Field. See Model Definitions'
+            }
           end
+        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 = {})
@@ -110,8 +116,13 @@ module Dry
       end
 
       def visit_sum(node, opts = {})
-        opts[:nullable] = true
-        visit(node[1], opts)
+        if node[0][0].equal?(:constrained)
+          opts[:nullable] = true
+          visit(node[1], opts) # ignore NilClass constrained
+        elsif node[0][0].equal?(:struct) || node[0][0].equal?(:sum)
+          opts[:oneOf] = true
+          node.each { |child| visit(child, opts) unless child.is_a?(Hash) }
+        end
       end
 
       def visit_struct(node, opts = {})

data/lib/dry/swagger/version.rb

@@ -1,5 +1,5 @@
 module Dry
   module Swagger
-    VERSION = "0.4.1"
+    VERSION = "0.5.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-swagger
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.2
 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