dry-swagger 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c52c6906b862ea3104ef5d841db24a69f38bbaa5cbda13ef553305453e1665cc
-  data.tar.gz: 5887800bdbcccd0603aad3cecba5c593391be2644456cbf4437557aa039ca923
+  metadata.gz: 3b612143bf3038b32981bae55874524220f769bfe7db95ee1fc2be928f563f73
+  data.tar.gz: 02e71a27f38fafae4f6db24d267157467dbe1889649caf036b3eddafa8b7ef27
 SHA512:
-  metadata.gz: a1c2b6b524bf1a06641b7769c90c40246ef27b970177ddcd81d355c7da38435ea32329eb692107dba85ba00d757e234271a5d72bed167dcc2903e1a0c0312f3e
-  data.tar.gz: cbad39dd938d175ca9713d3a4cb834943d83ceb8efe5507e3c93e9cfb231a70251695fd40bb8eeee3a02278472fcfee603826ef04f3a627c915290f85057635d
+  metadata.gz: 9c3da6167caaf0f60a5d4b6f07aa00b1c964c19c8b8cc7508c7d59a3e266a34c5f54c66644030a3048e2713092ca164f4d1f82315a09a8989bfc702486bc05d8
+  data.tar.gz: 10c946ec34aef062dccccfedfa6fe6fb8b6ba9cfb09d0a434d7cf22d879a60177632f28c082b0dd81091cccf66204b4ded6526888b60b37234c8b8a288af0bc7

data/Gemfile.lock

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

data/README.md

@@ -33,7 +33,7 @@ Or install it yourself as:
         end
     end
     
-    Dry::Swagger::ContractParser.new.call(Contract)
+    Dry::Swagger::ContractParser.new.call(Contract).to_swagger
     => {
          "type": "object",
          "properties": {
@@ -81,7 +81,7 @@ Or install it yourself as:
       end
     end
     
-    Dry::Swagger::ContractParser.new.call(Contract)
+    Dry::Swagger::ContractParser.new.call(Contract).to_swagger
     => {
          "type": "object",
          "properties": {
@@ -135,7 +135,7 @@ Or install it yourself as:
       attribute? :optional_nullable_string, Types::String.optional
     end
     
-    Dry::Swagger::StructParser.new.call(DTO)
+    Dry::Swagger::StructParser.new.call(DTO).to_swagger
     => {
          "type": "object",
          "properties": {
@@ -170,7 +170,22 @@ Or install it yourself as:
          ]
        }
 #### With nested fields
-    {
+    class NestedDTO < Dry::Struct
+      attribute  :required_string, Types::String
+      attribute  :required_nullable_string, Types::String.optional
+      attribute  :required_string_with_enum, Types::String.enum('enum1')
+      attribute? :optional_string, Types::String
+      attribute? :optional_nullable_string, Types::String.optional
+    end
+    
+    class DTO < Dry::Struct
+      attribute  :array_of_integer, Types::Array.of(Types::Integer)
+      attribute  :array_of_objects, Types::Array.of(NestedDTO)
+      attribute  :dto, NestedDTO
+    end
+    
+    Dry::Swagger::StructParser.new.call(DTO).to_swagger
+    => {
       "type": "object",
       "properties": {
         "array_of_integer": {
@@ -258,6 +273,44 @@ Or install it yourself as:
         "dto"
       ]
     }
+## Overriding fields on run time
+You can also modify the fields during runtime by passing a block after the .call() method.
+
+For example:
+    
+    Dry::Swagger::StructParser.new.call(DTO) do |it|
+      # types = string/integer/hash/array
+      
+      # Remove a field
+      its.keys = it.keys.except(:field_name) 
+      
+      # Add new field on root level
+      it.keys[:new_field_name] = { type: type, required: true/false, :it.config.nullable_type=>true/false } 
+      
+      # Add a new field in nested hash/array
+      it.keys[:nested_field][:keys][:new_field_name] = { 
+        type: type, required: true/false, :it.config.nullable_type=>true/false
+      }
+      
+      # Remove a field in nested hash/array
+      it.keys = it.keys[:nested_field][:keys].except(:field_name)
+      
+      # Add an array or hash
+      it.keys[:nested_field] = { 
+        type: "array/hash", required: true/false, :it.config.nullable_type=> true/false, keys: {
+          # List all nested fields
+          new_field: { type: :type, required: true/false, :it.config.nullable_type=>true/false }
+        }
+      }
+      
+      # Add an Array of primitive types, type field needs to be the element type(string, integer, float), 
+      and add an array: true flag
+      
+      it.keys[:array_field_name] = { 
+        type: type, array: true, required: true/false, :it.config.nullable_type=> true/false 
+      }
+      
+    end.to_swagger()
 ## Custom Configuration For Your Project
 You can override default configurations by creating a file in config/initializers/dry-swagger.rb and changing the following values.
 
@@ -270,12 +323,12 @@ You can override default configurations by creating a file in config/initializer
     end
     
     Dry::Swagger::Config::ContractConfiguration.configuration do |config|
-          config.enable_required_validation = true / false       
-          config.enable_nullable_validation = true / false
-          config.enable_enums = true / false
-          config.enable_descriptions = true / false
-          config.nullable_type = :"x-nullable" / :nullable
-        end
+      config.enable_required_validation = true / false       
+      config.enable_nullable_validation = true / false
+      config.enable_enums = true / false
+      config.enable_descriptions = true / false
+      config.nullable_type = :"x-nullable" / :nullable
+    end
         
 By default, all these settings are true, and nullable_type is :"x-nullable".
 ## Development

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[:required] && @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,23 +35,60 @@ module Dry
       end
 
       def generate_field_properties(attributes_hash)
-        if attributes_hash[:type] == 'array'
-          items = generate_documentation(attributes_hash[:keys])
-          items.merge(@config.nullable_type => attributes_hash[@config.nullable_type] | false) if @config.enable_nullable_validation
-          { type: :array, items: items }
-        elsif attributes_hash[:array] && attributes_hash[:type] != 'array'
-          items = SWAGGER_FIELD_TYPE_DEFINITIONS.fetch(attributes_hash[:type])
-          items = items.merge(@config.nullable_type => attributes_hash[@config.nullable_type] | false) if @config.enable_nullable_validation
-          { type: :array, items:  items }
-        elsif attributes_hash[:type] == 'hash'
-          raise Errors::MissingHashSchemaError.new unless attributes_hash[:keys]
-          generate_documentation(attributes_hash[:keys])
+        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
-          field = SWAGGER_FIELD_TYPE_DEFINITIONS.fetch(attributes_hash[:type])
-          field = field.merge(@config.nullable_type => attributes_hash[@config.nullable_type] | false)  if @config.enable_nullable_validation
-          field = field.merge(enum: attributes_hash[:enum]) if attributes_hash[:enum]  if @config.enable_enums
-          field = field.merge(description: attributes_hash[:description]) if attributes_hash[:description] if @config.enable_descriptions
-          field
+          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))
+            end
+          end
+
+          @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

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,14 @@ 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[1][0].equal?(:struct)
+          opts[:oneOf] = true
+          visit(node[0], opts)
+          visit(node[1], opts)
+        end
       end
 
       def visit_struct(node, opts = {})

data/lib/dry/swagger/version.rb

@@ -1,5 +1,5 @@
 module Dry
   module Swagger
-    VERSION = "0.4.0"
+    VERSION = "0.5.1"
   end
 end

metadata

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