Added ability to load nested models recursively.

Author: Sergey Verevkin

.rubocop_todo.yml

@@ -1,32 +1,32 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-11-10 15:12:48 -0500 using RuboCop version 0.27.0.
+# on 2014-11-20 15:23:00 +0200 using RuboCop version 0.27.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 8
 Metrics/AbcSize:
-  Max: 327
+  Max: 330
 
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 387
+  Max: 390
 
 # Offense count: 4
 Metrics/CyclomaticComplexity:
   Max: 92
 
-# Offense count: 196
+# Offense count: 203
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
   Max: 254
 
-# Offense count: 12
+# Offense count: 13
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 352
+  Max: 355
 
 # Offense count: 4
 Metrics/PerceivedComplexity:
@@ -36,7 +36,7 @@ Metrics/PerceivedComplexity:
 Style/ClassVars:
   Enabled: false
 
-# Offense count: 62
+# Offense count: 68
 Style/Documentation:
   Enabled: false
 

CHANGELOG.md

@@ -6,6 +6,7 @@
 * [#169](https://github.com/tim-vandecasteele/grape-swagger/pull/169): Test against multiple versions of Grape - [@dblock](https://github.com/dblock).
 * [#166](https://github.com/tim-vandecasteele/grape-swagger/pull/166): Ensure compatibility with Grape 0.8.0 or newer - [@dblock](https://github.com/dblock).
 * [#174](https://github.com/tim-vandecasteele/grape-swagger/pull/172): Fix problem with using prefix name somewhere in api paths - [@grzesiek](https://github.com/grzesiek).
+* [#176](https://github.com/tim-vandecasteele/grape-swagger/pull/176): Added ability to load nested models recursively - [@sergey-verevkin](https://github.com/sergey-verevkin).
 
 * Your contribution here.
 

lib/grape-swagger.rb

@@ -420,10 +420,15 @@ def models_with_included_presenters(models)
 
               models.each do |model|
                 # get model references from exposures with a documentation
-                additional_models = model.exposures.map do |_, config|
+                nested_models = model.exposures.map do |_, config|
                   config[:using] if config.key?(:documentation)
                 end.compact
 
+                # get all nested models recursively
+                additional_models = nested_models.map do |nested_model|
+                  models_with_included_presenters([nested_model])
+                end.flatten
+
                 all_models += additional_models
               end
 

spec/api_models_spec.rb

@@ -51,6 +51,24 @@ class AliasedThing < Grape::Entity
         expose :something, as: :post, using: Entities::Something, documentation: { type: 'Something', desc: 'Reference to something.' }
       end
     end
+
+    module Entities
+      class FourthLevel < Grape::Entity
+        expose :text, documentation: { type: 'string' }
+      end
+
+      class ThirdLevel < Grape::Entity
+        expose :parts, using: Entities::FourthLevel, documentation: { type: 'FourthLevel' }
+      end
+
+      class SecondLevel < Grape::Entity
+        expose :parts, using: Entities::ThirdLevel, documentation: { type: 'ThirdLevel' }
+      end
+
+      class FirstLevel < Grape::Entity
+        expose :parts, using: Entities::SecondLevel, documentation: { type: 'SecondLevel' }
+      end
+    end
   end
 
   def app
@@ -91,6 +109,16 @@ def app
         present something, with: Entities::AliasedThing
       end
 
+      desc 'This gets all nested entities.', entity: Entities::FirstLevel
+      get '/nesting' do
+        fourth_level = OpenStruct.new text: 'something'
+        third_level  = OpenStruct.new parts: [fourth_level]
+        second_level = OpenStruct.new parts: [third_level]
+        first_level  = OpenStruct.new parts: [second_level]
+
+        present first_level, with: Entities::FirstLevel
+      end
+
       add_swagger_documentation
     end
   end
@@ -117,6 +145,7 @@ def app
         { 'path' => '/somethingelse.{format}', 'description' => 'Operations about somethingelses' },
         { 'path' => '/enum_description_in_entity.{format}', 'description' => 'Operations about enum_description_in_entities' },
         { 'path' => '/aliasedthing.{format}', 'description' => 'Operations about aliasedthings' },
+        { 'path' => '/nesting.{format}', 'description' => 'Operations about nestings' },
         { 'path' => '/swagger_doc.{format}', 'description' => 'Operations about swagger_docs' }
       ]
     end
@@ -226,4 +255,11 @@ def app
                                                  }
                                              )
   end
+
+  it 'includes all entities with four levels of nesting' do
+    get '/swagger_doc/nesting.json'
+    result = JSON.parse(last_response.body)
+
+    expect(result['models']).to include('FirstLevel', 'SecondLevel', 'ThirdLevel', 'FourthLevel')
+  end
 end