Allow entity_name to be called on parent classes (#794)

This resolves issue #659.

Author: urkle

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 #### Features
 
+* [#794](https://github.com/ruby-grape/grape-swagger/pull/794): Allow entity_name to be inherited, fixes #659 - [@urkle](https://githubcom/urkle).
 * Your contribution here.
 * [#793](https://github.com/ruby-grape/grape-swagger/pull/793): Features/inheritance and discriminator - [@MaximeRDY](https://github.com/MaximeRDY).
 

UPGRADING.md

@@ -2,7 +2,29 @@
 
 ### Upgrading to >= 1.2.0
 
-Full class name is modified to use `_` separator (e.g. `A_B_C` instead of `A::B::C`).
+- The entity_name class method is now called on parent classes for inherited entities. Now you can do this
+
+```ruby
+module Some::Long::Module
+  class Base < Grape::Entity
+    # ... other shared logic
+    def self.entity_name
+      "V2::#{self.to_s.demodulize}"
+    end
+  end
+
+  def MyEntity < Base
+    # ....
+  end
+
+  def OtherEntity < Base
+    # revert back to the default behavior by hiding the method
+    private_class_method :entity_name
+  end
+end
+```
+
+- Full class name is modified to use `_` separator (e.g. `A_B_C` instead of `A::B::C`).
 
 ### Upgrading to >= 1.1.0
 

lib/grape-swagger/doc_methods/data_type.rb

@@ -48,7 +48,7 @@ def parse_multi_type(raw_data_type)
         end
 
         def parse_entity_name(model)
-          if model.methods(false).include?(:entity_name)
+          if model.respond_to?(:entity_name)
             model.entity_name
           elsif model.to_s.end_with?('::Entity', '::Entities')
             model.to_s.split('::')[0..-2].join('_')

spec/issues/430_entity_definitions_spec.rb

@@ -55,6 +55,8 @@ def self.entity_name
             class Class7
               class SeventhEntity < Class6::SixthEntity
                 expose :seventh_thing
+
+                private_class_method :entity_name
               end
             end
           end

spec/lib/data_type_spec.rb

@@ -49,6 +49,18 @@
     it { is_expected.to eq 'MyInteger' }
   end
 
+  describe 'Types in array with inherited entity_name' do
+    before do
+      stub_const 'EntityBase', Class.new
+      allow(EntityBase).to receive(:entity_name).and_return 'MyInteger'
+      stub_const 'MyEntity', Class.new(EntityBase)
+    end
+
+    let(:value) { { type: '[MyEntity]' } }
+
+    it { is_expected.to eq 'MyInteger' }
+  end
+
   describe 'Rack::Multipart::UploadedFile' do
     let(:value) { { type: Rack::Multipart::UploadedFile } }
 

spec/swagger_v2/reference_entity_spec.rb

@@ -22,6 +22,20 @@ def self.entity_name
           expose :title, documentation: { type: 'string', desc: 'Title of the kind.' }
           expose :something, documentation: { type: Something, desc: 'Something interesting.' }
         end
+
+        class Base < Grape::Entity
+          def self.entity_name
+            parts = to_s.split('::')
+
+            "MyAPI::#{parts.last}"
+          end
+
+          expose :title, documentation: { type: 'string', desc: 'Title of the parent.' }
+        end
+
+        class Child < Base
+          expose :child, documentation: { type: 'string', desc: 'Child property.' }
+        end
       end
 
       class ResponseModelApi < Grape::API
@@ -40,6 +54,16 @@ class ResponseModelApi < Grape::API
           present kind, with: Entities::Kind
         end
 
+        desc 'This returns a child entity',
+             entity: Entities::Child,
+             http_codes: [
+               { code: 200, message: 'OK', model: Entities::Child }
+             ]
+        get '/child' do
+          child = OpenStruct.new text: 'child'
+          present child, with: Entities::Child
+        end
+
         add_swagger_documentation # models: [MyAPI::Entities::Something, MyAPI::Entities::Kind]
       end
     end
@@ -49,36 +73,57 @@ def app
     MyAPI::ResponseModelApi
   end
 
-  subject do
-    get '/swagger_doc/kind'
-    JSON.parse(last_response.body)
+  describe 'kind' do
+    subject do
+      get '/swagger_doc/kind'
+      JSON.parse(last_response.body)
+    end
+
+    it 'should document specified models' do
+      expect(subject['paths']['/kind']['get']['parameters']).to eq [{
+        'in' => 'query',
+        'name' => 'something',
+        'description' => 'Something interesting.',
+        'type' => 'SomethingCustom',
+        'required' => false
+      }]
+
+      expect(subject['definitions'].keys).to include 'SomethingCustom'
+      expect(subject['definitions']['SomethingCustom']).to eq(
+        'type' => 'object', 'properties' => { 'text' => { 'type' => 'string', 'description' => 'Content of something.' } }
+      )
+
+      expect(subject['definitions'].keys).to include 'KindCustom'
+      expect(subject['definitions']['KindCustom']).to eq(
+        'type' => 'object',
+        'properties' => {
+          'title' => { 'type' => 'string', 'description' => 'Title of the kind.' },
+          'something' => {
+            '$ref' => '#/definitions/SomethingCustom',
+            'description' => 'Something interesting.'
+          }
+        },
+        'description' => 'This returns kind and something or an error'
+      )
+    end
   end
 
-  it 'should document specified models' do
-    expect(subject['paths']['/kind']['get']['parameters']).to eq [{
-      'in' => 'query',
-      'name' => 'something',
-      'description' => 'Something interesting.',
-      'type' => 'SomethingCustom',
-      'required' => false
-    }]
-
-    expect(subject['definitions'].keys).to include 'SomethingCustom'
-    expect(subject['definitions']['SomethingCustom']).to eq(
-      'type' => 'object', 'properties' => { 'text' => { 'type' => 'string', 'description' => 'Content of something.' } }
-    )
-
-    expect(subject['definitions'].keys).to include 'KindCustom'
-    expect(subject['definitions']['KindCustom']).to eq(
-      'type' => 'object',
-      'properties' => {
-        'title' => { 'type' => 'string', 'description' => 'Title of the kind.' },
-        'something' => {
-          '$ref' => '#/definitions/SomethingCustom',
-          'description' => 'Something interesting.'
-        }
-      },
-      'description' => 'This returns kind and something or an error'
-    )
+  describe 'child' do
+    subject do
+      get '/swagger_doc/child'
+      JSON.parse(last_response.body)
+    end
+
+    it 'should document specified models' do
+      expect(subject['definitions'].keys).to include 'MyAPI::Child'
+      expect(subject['definitions']['MyAPI::Child']).to eq(
+        'type' => 'object',
+        'properties' => {
+          'title' => { 'type' => 'string', 'description' => 'Title of the parent.' },
+          'child' => { 'type' => 'string', 'description' => 'Child property.' }
+        },
+        'description' => 'This returns a child entity'
+      )
+    end
   end
 end