grape-swagger-entity 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cbc9a4f5350f907024319ec60d6bebcf58c1d9a9fbe0a87157eb521f5d90c27
-  data.tar.gz: d70650e560a98a5c8e6299136146796d87bb8e124944c2b09603ddcab415085a
+  metadata.gz: 4c6aad956f868bcf6563b52eaaf6347b821fe06a63153324e299562857418dc3
+  data.tar.gz: 04ffc54b6c66cb328e7687aac44f9140f0891ab74c3fab05463bda4a43f02f41
 SHA512:
-  metadata.gz: 4fffce9cc2ae49583807c9e02a5ed6d0c6fdbd1e3acc2f4816868b292fb8ae0e77161bd4736dcb2d91e30633a814cd8fd31c2f21af9fec12cc4cec8243bb5ce1
-  data.tar.gz: 2c5cdf2184fefbd92fda6b7f65d95d31f0c331e225be2439b5fa2f6d711a7754890271b7a41b06cdd36c44d3bcace9b836cd727c93b21892e6ae9651badb712a
+  metadata.gz: e4e6cd881f3c194a10beb6489b295ecc0d3168479935c4402922d4e4f9358686c3aa2d3df1023e99114710c14efa9685d8f5b1792558538f680721d77d7b8177
+  data.tar.gz: 5090a6ae14257708c383c10b858b6c89ba21e54fd5a873dfe10dcd1873b1aac125b3d4be4ad0c055778461859b91c18c2505607ecbd4552384c1a0f01ce46033

data/CHANGELOG.md

@@ -4,10 +4,16 @@
 
 * Your contribution here.
 
-#### Features
+#### Fixes
 
 * Your contribution here.
 
+### 0.5.0 (June 29, 2020)
+
+#### Features
+
+* [#50](https://github.com/ruby-grape/grape-swagger-entity/pull/50): Features/inheritance and discriminator - [@MaximeRDY](https://github.com/MaximeRDY).
+
 ### 0.4.0 (May 30, 2020)
 
 #### Features

data/Gemfile

@@ -16,7 +16,7 @@ group :development, :test do
   gem 'rubocop', '~> 0.68.1'
 end
 
-gem 'grape-swagger', git: 'https://github.com/ruby-grape/grape-swagger.git'
+gem 'grape-swagger', path: '../grape-swagger'
 
 group :test do
   gem 'grape-entity', ENV.fetch('GRAPE_ENTITY', '0.6.1')

data/grape-swagger-entity.gemspec

@@ -19,5 +19,5 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.2.6'
   s.add_runtime_dependency 'grape-entity', '>= 0.5.0'
-  s.add_runtime_dependency 'grape-swagger', '>= 1.0.0'
+  s.add_runtime_dependency 'grape-swagger', '>= 1.4.0'
 end

data/lib/grape-swagger/entity.rb

@@ -2,6 +2,7 @@ require 'grape-swagger'
 require 'grape-entity'
 
 require 'grape-swagger/entity/version'
+require 'grape-swagger/entity/helper'
 require 'grape-swagger/entity/attribute_parser'
 require 'grape-swagger/entity/parser'
 

data/lib/grape-swagger/entity/attribute_parser.rb

@@ -12,7 +12,7 @@ module GrapeSwagger
         entity_model = model_from(entity_options)
 
         if entity_model
-          name = endpoint.nil? ? entity_model.to_s.demodulize : endpoint.send(:expose_params_from_model, entity_model)
+          name = GrapeSwagger::Entity::Helper.model_name(entity_model, endpoint)
 
           entity_model_type = entity_model_type(name, entity_options)
           return entity_model_type unless documentation
@@ -39,7 +39,7 @@ module GrapeSwagger
           add_attribute_documentation(param, documentation)
 
           add_extension_documentation(param, documentation)
-
+          add_discriminator_extension(param, documentation)
           param
         end
       end
@@ -128,6 +128,10 @@ module GrapeSwagger
       def add_extension_documentation(param, documentation)
         GrapeSwagger::DocMethods::Extensions.add_extensions_to_root(documentation, param)
       end
+
+      def add_discriminator_extension(param, documentation)
+        param[:documentation] = { is_discriminator: true } if documentation.key?(:is_discriminator)
+      end
     end
   end
 end

data/lib/grape-swagger/entity/helper.rb

@@ -0,0 +1,36 @@
+module GrapeSwagger
+  module Entity
+    # Helper methods for DRY
+    class Helper
+      class << self
+        def model_name(entity_model, endpoint)
+          if endpoint.nil?
+            entity_model.to_s.demodulize
+          else
+            endpoint.send(:expose_params_from_model, entity_model)
+          end
+        end
+
+        def discriminator(entity_model)
+          entity_model.superclass.root_exposures.detect do |value|
+            value.documentation.dig(:is_discriminator)
+          end
+        end
+
+        def root_exposures_without_parent(entity_model)
+          entity_model.root_exposures.select do |value|
+            entity_model.superclass.root_exposures.find_by(value.attribute).nil?
+          end
+        end
+
+        def root_exposure_with_discriminator(entity_model)
+          if discriminator(entity_model)
+            root_exposures_without_parent(entity_model)
+          else
+            entity_model.root_exposures
+          end
+        end
+      end
+    end
+  end
+end

data/lib/grape-swagger/entity/parser.rb

@@ -26,7 +26,7 @@ module GrapeSwagger
       end
 
       def extract_params(exposure)
-        exposure.root_exposures.each_with_object({}) do |value, memo|
+        GrapeSwagger::Entity::Helper.root_exposure_with_discriminator(exposure).each_with_object({}) do |value, memo|
           if value.for_merge && (value.respond_to?(:entity_class) || value.respond_to?(:using_class_name))
             entity_class = value.respond_to?(:entity_class) ? value.entity_class : value.using_class_name
 
@@ -64,7 +64,39 @@ module GrapeSwagger
           memo[final_entity_name][:description] = documentation[:desc] if documentation[:desc]
         end
 
-        [parsed, required_params(params)]
+        discriminator = GrapeSwagger::Entity::Helper.discriminator(model)
+        if discriminator
+          respond_with_all_of(parsed, params, discriminator)
+        else
+          [parsed, required_params(params)]
+        end
+      end
+
+      def respond_with_all_of(parsed, params, discriminator)
+        parent_name = GrapeSwagger::Entity::Helper.model_name(model.superclass, endpoint)
+
+        {
+          allOf: [
+            {
+              '$ref' => "#/definitions/#{parent_name}"
+            },
+            [
+              add_discriminator(parsed, discriminator),
+              required_params(params).push(discriminator.attribute)
+            ]
+          ]
+        }
+      end
+
+      def add_discriminator(parsed, discriminator)
+        model_name = GrapeSwagger::Entity::Helper.model_name(model, endpoint)
+
+        parsed.merge(
+          discriminator.attribute => {
+            type: 'string',
+            enum: [model_name]
+          }
+        )
       end
 
       def parse_nested(entity_name, entity_options, parent_model = nil)

data/lib/grape-swagger/entity/version.rb

@@ -1,5 +1,5 @@
 module GrapeSwagger
   module Entity
-    VERSION = '0.4.0'.freeze
+    VERSION = '0.5.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger-entity
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Kirill Zaitsev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-30 00:00:00.000000000 Z
+date: 2020-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape-entity
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.4.0
 description: 
 email:
 - kirik910@gmail.com
@@ -62,6 +62,7 @@ files:
 - lib/grape-swagger-entity.rb
 - lib/grape-swagger/entity.rb
 - lib/grape-swagger/entity/attribute_parser.rb
+- lib/grape-swagger/entity/helper.rb
 - lib/grape-swagger/entity/parser.rb
 - lib/grape-swagger/entity/version.rb
 homepage: https://github.com/ruby-grape/grape-swagger-entity