grape-swagger-entity 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '029fa174a6e8b862a95e41092e5eb3f88620d55c'
-  data.tar.gz: e319381ef0cb0e125d838ec535ba7f76961c10b8
+  metadata.gz: 4765712e8fa51a31cb4cde4e6cb6c67e2863f3cb
+  data.tar.gz: 2012ba6b40ad94a02afc087e8ddcfe9a2fb341f1
 SHA512:
-  metadata.gz: c9be3808f26f6024559d88b9ba1824ec4be407a8d79ae1dc78117ceb565b6a5fddf8fd45683977be26a2fe65a490f80d58610c63a3f88f4d31c135b18630a2f4
-  data.tar.gz: a9bfcc5f55b02133f4f6ffa3bc17c57285ddb957ee839d68fc1f9c42e030be9e8f38cb5c597d2d7dca9916d865b17992cfabd23e06df5d0c11fbc6ae12198c2b
+  metadata.gz: bc1f438ae665e682e20603cd9c1693dce8fc41c243b49706aa4939d0c75034f251e6516329a66ac2dbdb09962ab214dc4411ede6e3d72b05b9cc7aec58c92328
+  data.tar.gz: 467778758de82752d19f383bd9be651d06cd6116850ec8d71a21f79e337b822531b49bafbc8d4718940ed3d3b900eaa411cb3c7bb65058c993b65be4c404b3ac

data/.rubocop_todo.yml

@@ -46,3 +46,4 @@ Style/Documentation:
     - 'test/**/*'
     - 'lib/grape-swagger/entity.rb'
     - 'lib/grape-swagger/entity/parser.rb'
+    - 'lib/grape-swagger/entity/attribute_parser.rb'

data/CHANGELOG.md

@@ -8,6 +8,12 @@
 
 * Your contribution here.
 
+### 0.2.2 (November 3, 2017)
+
+#### Features
+
+* [#27](https://github.com/ruby-grape/grape-swagger-entity/pull/27): Add support for attribute examples - [@Kukunin](https://github.com/Kukunin).
+
 ### 0.2.1 (Jule 5, 2017)
 
 #### Features

data/grape-swagger-entity.gemspec

@@ -1,5 +1,3 @@
-# coding: utf-8
-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'grape-swagger/entity/version'
@@ -20,6 +18,6 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.required_ruby_version = '>= 2.2.6'
-  s.add_runtime_dependency 'grape-swagger', '>= 0.20.4'
   s.add_runtime_dependency 'grape-entity', '>= 0.5.0'
+  s.add_runtime_dependency 'grape-swagger', '>= 0.20.4'
 end

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

@@ -0,0 +1,103 @@
+module GrapeSwagger
+  module Entity
+    class AttributeParser
+      attr_reader :endpoint
+
+      def initialize(endpoint)
+        @endpoint = endpoint
+      end
+
+      def call(entity_options)
+        documentation = entity_options[:documentation]
+        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)
+          return entity_model_type(name, entity_options)
+        else
+          param = data_type_from(entity_options)
+          return param unless documentation
+
+          param[:default] = documentation[:default] if documentation[:default]
+          add_attribute_example(param, documentation[:example])
+
+          if (values = documentation[:values])
+            param[:enum] = values if values.is_a?(Array)
+          end
+
+          param = { type: :array, items: param } if documentation[:is_array]
+          param
+        end
+      end
+
+      private
+
+      def model_from(entity_options)
+        model = entity_options[:using] if entity_options[:using].present?
+
+        if could_it_be_a_model?(entity_options[:documentation])
+          model ||= entity_options[:documentation][:type]
+        end
+
+        model
+      end
+
+      def could_it_be_a_model?(value)
+        return false if value.nil?
+        direct_model_type?(value[:type]) || ambiguous_model_type?(value[:type])
+      end
+
+      def direct_model_type?(type)
+        type.to_s.include?('Entity') || type.to_s.include?('Entities')
+      end
+
+      def ambiguous_model_type?(type)
+        type &&
+          type.is_a?(Class) &&
+          !GrapeSwagger::DocMethods::DataType.primitive?(type.name.downcase) &&
+          !type == Array
+      end
+
+      def data_type_from(documentation)
+        documented_type = documentation[:type]
+        documented_type ||= (documentation[:documentation] && documentation[:documentation][:type])
+
+        data_type = GrapeSwagger::DocMethods::DataType.call(documented_type)
+
+        document_data_type(documentation[:documentation], data_type)
+      end
+
+      def document_data_type(documentation, data_type)
+        type = if GrapeSwagger::DocMethods::DataType.primitive?(data_type)
+                 data = GrapeSwagger::DocMethods::DataType.mapping(data_type)
+                 { type: data.first, format: data.last }
+               else
+                 { type: data_type }
+               end
+        type[:format] = documentation[:format] if documentation && documentation.key?(:format)
+
+        type
+      end
+
+      def entity_model_type(name, entity_options)
+        if entity_options[:documentation] && entity_options[:documentation][:is_array]
+          {
+            'type' => 'array',
+            'items' => {
+              '$ref' => "#/definitions/#{name}"
+            }
+          }
+        else
+          {
+            '$ref' => "#/definitions/#{name}"
+          }
+        end
+      end
+
+      def add_attribute_example(attribute, example)
+        return unless example
+        attribute[:example] = example.is_a?(Proc) ? example.call : example
+      end
+    end
+  end
+end

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

@@ -3,10 +3,12 @@ module GrapeSwagger
     class Parser
       attr_reader :model
       attr_reader :endpoint
+      attr_reader :attribute_parser
 
       def initialize(model, endpoint)
         @model = model
         @endpoint = endpoint
+        @attribute_parser = AttributeParser.new(endpoint)
       end
 
       def call
@@ -27,30 +29,12 @@ module GrapeSwagger
 
           entity_name = entity_options[:as] if entity_options[:as]
           documentation = entity_options[:documentation]
-          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)
-            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
-
-            memo[entity_name][:default] = documentation[:default] if documentation[:default]
-
-            if (values = documentation[:values])
-              memo[entity_name][:enum] = values if values.is_a?(Array)
-            end
-
-            if documentation[:is_array]
-              memo[entity_name] = {
-                type: :array,
-                items: memo.delete(entity_name)
-              }
-            end
-          end
+          memo[entity_name] = if entity_options[:nesting]
+                                parse_nested(entity_name, entity_options, parent_model)
+                              else
+                                attribute_parser.call(entity_options)
+                              end
 
           if documentation
             memo[entity_name][:read_only] = documentation[:read_only].to_s == 'true' if documentation[:read_only]
@@ -59,16 +43,6 @@ module GrapeSwagger
         end
       end
 
-      def model_from(entity_options)
-        model = entity_options[:using] if entity_options[:using].present?
-
-        if could_it_be_a_model?(entity_options[:documentation])
-          model ||= entity_options[:documentation][:type]
-        end
-
-        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)
@@ -101,58 +75,6 @@ module GrapeSwagger
           }
         end
       end
-
-      def could_it_be_a_model?(value)
-        return false if value.nil?
-        direct_model_type?(value[:type]) || ambiguous_model_type?(value[:type])
-      end
-
-      def direct_model_type?(type)
-        type.to_s.include?('Entity') || type.to_s.include?('Entities')
-      end
-
-      def ambiguous_model_type?(type)
-        type &&
-          type.is_a?(Class) &&
-          !GrapeSwagger::DocMethods::DataType.primitive?(type.name.downcase) &&
-          !type == Array
-      end
-
-      def data_type_from(documentation)
-        documented_type = documentation[:type]
-        documented_type ||= (documentation[:documentation] && documentation[:documentation][:type])
-
-        data_type = GrapeSwagger::DocMethods::DataType.call(documented_type)
-
-        document_data_type(documentation[:documentation], data_type)
-      end
-
-      def document_data_type(documentation, data_type)
-        type = if GrapeSwagger::DocMethods::DataType.primitive?(data_type)
-                 data = GrapeSwagger::DocMethods::DataType.mapping(data_type)
-                 { type: data.first, format: data.last }
-               else
-                 { type: data_type }
-               end
-        type[:format] = documentation[:format] if documentation && documentation.key?(:format)
-
-        type
-      end
-
-      def entity_model_type(name, entity_options)
-        if entity_options[:documentation] && entity_options[:documentation][:is_array]
-          {
-            'type' => 'array',
-            'items' => {
-              '$ref' => "#/definitions/#{name}"
-            }
-          }
-        else
-          {
-            '$ref' => "#/definitions/#{name}"
-          }
-        end
-      end
     end
   end
 end

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

@@ -1,5 +1,5 @@
 module GrapeSwagger
   module Entity
-    VERSION = '0.2.1'.freeze
+    VERSION = '0.2.2'.freeze
   end
 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/attribute_parser'
 require 'grape-swagger/entity/parser'
 
 module GrapeSwagger

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger-entity
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Kirill Zaitsev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-05 00:00:00.000000000 Z
+date: 2017-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: grape-swagger
+  name: grape-entity
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.20.4
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.20.4
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
-  name: grape-entity
+  name: grape-swagger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.20.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.20.4
 description: 
 email:
 - kirik910@gmail.com
@@ -61,6 +61,7 @@ files:
 - grape-swagger-entity.gemspec
 - lib/grape-swagger-entity.rb
 - lib/grape-swagger/entity.rb
+- lib/grape-swagger/entity/attribute_parser.rb
 - lib/grape-swagger/entity/parser.rb
 - lib/grape-swagger/entity/version.rb
 homepage: https://github.com/ruby-grape/grape-swagger-entity