grape-swagger-entity 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72459a987fb7696ab9b9af64da1bcbcd6e1b2de3
-  data.tar.gz: 9c401e5bcab37c4fb90af2b3faf4d5226953f5fa
+  metadata.gz: 25f852e7a159a5e8c626e7fcfdd63c7b9e566674
+  data.tar.gz: f060d4e451f67a8a69f53ee9a013f969f0990259
 SHA512:
-  metadata.gz: 0df830bd1242402544528d473051715e12d5ee82650849582b1126de32048e2b0547478334394559ef584b7c38e7ebb11fa62e0435f6e2da7e6220e6ff36b0b2
-  data.tar.gz: 0b2c212b1580bba2706ca2e116e7f32b1ef50acb083e92191f2ec77363c6839017ac26705b874f81271a4d2d98d721c8c446e8d670ac500490362500445e5fbd
+  metadata.gz: 04652f20c5c6e885a787735d491260cab5343e2fb422907eea80da9463a866135a4435caf6a4c1b0f36365a150337dd7fdc6051de9439748b4bbeb0b0e28bf36
+  data.tar.gz: cd2f8375cbb8bb4d3200f22c8382384b8207e89ccca1324a207f9595f8f8b4bff7db7628f542e86e22ffe239f5aa50a4eb0439a002801db3ad62fdda9d7b397a

data/.rubocop_todo.yml

@@ -1,38 +1,38 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-02-02 15:42:44 +0100 using RuboCop version 0.47.1.
+# on 2017-02-26 22:17:25 +0200 using RuboCop version 0.47.1.
 # 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: 1
+# Offense count: 2
 Metrics/AbcSize:
-  Max: 45
+  Max: 35
 
-# Offense count: 8
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/BlockLength:
-  Max: 27
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 126
 
 # Offense count: 1
 Metrics/CyclomaticComplexity:
   Max: 14
 
-# Offense count: 11
+# Offense count: 14
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
   Max: 120
 
-# Offense count: 2
+# Offense count: 3
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 30
+  Max: 27
 
-# Offense count: 1
+# Offense count: 2
 Metrics/PerceivedComplexity:
-  Max: 16
+  Max: 15
 
 # Offense count: 2
 Style/Documentation:

data/CHANGELOG.md

@@ -8,6 +8,12 @@
 
 * Your contribution here.
 
+### 0.2.0 (March 2, 2017)
+
+#### Features
+
+* [#22](https://github.com/ruby-grape/grape-swagger-entity/pull/22): Nested exposures - [@Bugagazavr](https://github.com/Bugagazavr).
+
 ### 0.1.6 (February 3, 2017)
 
 #### Features

data/grape-swagger-entity.gemspec

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

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

@@ -10,14 +10,8 @@ module GrapeSwagger
       end
 
       def call
-        # TODO: this should only be a temporary hack ;)
-        if ::GrapeEntity::VERSION =~ /0\.4\.\d/
-          warn 'usage of grape-entity <0.5.0 is deprecated'
-          parameters = model.exposures ? model.exposures : model.documentation
-        else
-          parameters = model.root_exposures.each_with_object({}) do |value, memo|
-            memo[value.attribute] = value.send(:options)
-          end
+        parameters = model.root_exposures.each_with_object({}) do |value, memo|
+          memo[value.attribute] = value.send(:options)
         end
 
         parse_grape_entity_params(parameters)
@@ -25,7 +19,7 @@ module GrapeSwagger
 
       private
 
-      def parse_grape_entity_params(params)
+      def parse_grape_entity_params(params, parent_model = nil)
         return unless params
 
         params.each_with_object({}) do |(entity_name, entity_options), memo|
@@ -33,11 +27,13 @@ module GrapeSwagger
 
           entity_name = entity_options[:as] if entity_options[:as]
           documentation = entity_options[:documentation]
-          model = model_from(entity_options)
+          entity_model = model_from(entity_options)
 
-          if model
-            name = endpoint.nil? ? model.to_s.demodulize : endpoint.send(:expose_params_from_model, model)
+          if entity_model
+            name = endpoint.nil? ? entity_model.to_s.demodulize : endpoint.send(:expose_params_from_model, entity_model)
             memo[entity_name] = entity_model_type(name, entity_options)
+          elsif entity_options[:nesting]
+            memo[entity_name] = parse_nested(entity_name, entity_options, parent_model)
           else
             memo[entity_name] = data_type_from(entity_options)
             next unless documentation
@@ -70,6 +66,39 @@ module GrapeSwagger
         model
       end
 
+      def parse_nested(entity_name, entity_options, parent_model = nil)
+        nested_entity = if parent_model.nil?
+                          model.root_exposures.find_by(entity_name)
+                        else
+                          parent_model.nested_exposures.find_by(entity_name)
+                        end
+
+        params = nested_entity.nested_exposures.each_with_object({}) do |value, memo|
+          memo[value.attribute] = value.send(:options)
+        end
+
+        properties = parse_grape_entity_params(params, nested_entity)
+        is_a_collection = entity_options[:documentation].is_a?(Hash) &&
+                          entity_options[:documentation][:type].to_s.casecmp('array').zero?
+
+        if is_a_collection
+          {
+            type: :array,
+            items: {
+              type: :object,
+              properties: properties
+            },
+            description: entity_options[:desc] || ''
+          }
+        else
+          {
+            type: :object,
+            properties: properties,
+            description: entity_options[:desc] || ''
+          }
+        end
+      end
+
       def could_it_be_a_model?(value)
         return false if value.nil?
         direct_model_type?(value[:type]) || ambiguous_model_type?(value[:type])

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

@@ -1,5 +1,5 @@
 module GrapeSwagger
   module Entity
-    VERSION = '0.1.6'.freeze
+    VERSION = '0.2.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger-entity
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Kirill Zaitsev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-03 00:00:00.000000000 Z
+date: 2017-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape-swagger
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.0
 description: 
 email:
 - kirik910@gmail.com