grape-swagger-entity 0.3.2 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 728921dd6134e0517a9d041b71ad9eb576cbf69d
-  data.tar.gz: f5a194a8dfff4a6d26283fdc52dbb75e0530e19a
+SHA256:
+  metadata.gz: 45d768ff8d366802a511df94e675aed675d4961c965ac39a130df0e5a5a47f73
+  data.tar.gz: 29289e700cb29cd5d7078b58e04bb284c5ccad4da1f12e24917d31351cb2210c
 SHA512:
-  metadata.gz: 6cde2391099a8e9347d51330d750148aa6d197d6aab5e3d369b1a864ebfe397f26aa42ac4ca1e7d388415f6956b250f491dfa480629899b13ed66a8e9e41fa7a
-  data.tar.gz: 3936253b710cae0bdde531efa60bdc90e3f6c3063c990748c1f4d026cc4f94e9f3c8a0e3e73ed479898a5fbdfaf8bf83c1c5852dfefb0cf1288c2aac7c429394
+  metadata.gz: f1f7cb9609b3412b6fb624aaae0346b34549349a40f7912d1c72131fa7c905f47f8307928edb18dbcbc3ba6cefed34ecd861c125b60b45d8cbe1f4633a036199
+  data.tar.gz: b64399e310447774459e470cb7e9aa1621e2c544641ef16c6ec2e8a3a8cb472fff9cd8e33167a2b61d4939932aaca065172b01526ad099f0011fe989b2e4cdb0

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+.ruby-gemset
+.ruby-version

data/.rubocop.yml

@@ -2,7 +2,7 @@ AllCops:
   Exclude:
     - vendor/**/*
   TargetRubyVersion:
-    2.2
+    2.7
 
 inherit_from: .rubocop_todo.yml
 
@@ -21,5 +21,34 @@ Metrics/MethodLength:
 Naming/FileName:
   Enabled: false
 
-Layout/IndentHash:
+Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true

data/.rubocop_todo.yml

@@ -1,49 +1,48 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-07-03 22:59:40 +0300 using RuboCop version 0.49.1.
+# on 2020-06-29 22:12:50 UTC using RuboCop version 0.86.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: 2
-Metrics/AbcSize:
-  Max: 40
-
 # Offense count: 1
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/BlockLength:
-  Max: 27
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'grape-swagger-entity.gemspec'
+
+# Offense count: 4
+# Configuration parameters: IgnoredMethods.
+Metrics/AbcSize:
+  Max: 30
 
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 124
+  Max: 111
 
-# Offense count: 1
+# Offense count: 2
+# Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
-  Max: 15
-
-# Offense count: 14
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 120
+  Max: 11
 
-# Offense count: 3
-# Configuration parameters: CountComments.
+# Offense count: 5
+# Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
-  Max: 30
+  Max: 25
 
 # Offense count: 2
+# Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 16
+  Max: 12
 
-# Offense count: 2
+# Offense count: 4
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
     - 'lib/grape-swagger/entity.rb'
-    - 'lib/grape-swagger/entity/parser.rb'
     - 'lib/grape-swagger/entity/attribute_parser.rb'
+    - 'lib/grape-swagger/entity/parser.rb'

data/.travis.yml

@@ -10,28 +10,27 @@ after_success:
   - bundle exec danger
 
 rvm:
-  - 2.4.2
-  - 2.3.5
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
 
 env:
-  - GRAPE_ENTITY=0.5.2
   - GRAPE_ENTITY=0.6.1
+  - GRAPE_ENTITY=0.7.1
+  - GRAPE_ENTITY=0.8.0
 
 matrix:
   fast_finish: true
 
   include:
-    - rvm: 2.2.8
+    - rvm: 2.4.10
       env:
     - rvm: ruby-head
       env:
     - rvm: jruby-head
       env:
-    - rvm: rbx-2
-      env:
 
   allow_failures:
-    - rvm: 2.2.8
+    - rvm: 2.4.10
     - rvm: ruby-head
     - rvm: jruby-head
-    - rvm: rbx-2

data/CHANGELOG.md

@@ -8,6 +8,39 @@
 
 * Your contribution here.
 
+### 0.5.1 (June 30, 2020)
+
+#### Features
+
+* [#50](https://github.com/ruby-grape/grape-swagger-entity/pull/50): Features/inheritance and discriminator - [@MaximeRDY](https://github.com/MaximeRDY).
+
+### 0.5.0 (June 29, 2020)
+
+Yanked due to invalid dependency
+
+### 0.4.0 (May 30, 2020)
+
+#### Features
+
+* [#49](https://github.com/ruby-grape/grape-swagger-entity/pull/49): Bumped minimal required version of grape-swagger to 1.0.0 - [@Bugagazavr](https://github.com/Bugagazavr).
+* [#48](https://github.com/ruby-grape/grape-swagger-entity/pull/48): Add support for extensions - [@MaximeRDY](https://github.com/MaximeRDY).
+
+#### Fixes
+
+* [#46](https://github.com/ruby-grape/grape-swagger-entity/pull/46): Fixed issue where a boolean example value of false would not display in swagger file - [@drewnichols](https://github.com/drewnichols).
+
+### 0.3.4 (January 9, 2020)
+
+#### Features
+
+* [#40](https://github.com/ruby-grape/grape-swagger-entity/pull/40): Add support for minLength and maxLength - [@fotos](https://github.com/fotos).
+
+### 0.3.3 (Fabruary 22, 2019)
+
+#### Features
+
+* [#39](https://github.com/ruby-grape/grape-swagger-entity/pull/39): Fix to avoid conflict with polymorphic model - [@kinoppyd](https://github.com/kinoppyd).
+
 ### 0.3.2 (January 15, 2019)
 
 #### Features

data/Dangerfile

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 danger.import_dangerfile(gem: 'ruby-grape-danger')

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in grape-swagger-entity.gemspec
@@ -12,8 +14,8 @@ group :development, :test do
   gem 'rack-test'
   gem 'rake'
   gem 'rdoc'
-  gem 'rspec', '~> 3.0'
-  gem 'rubocop', '~> 0.48'
+  gem 'rspec', '~> 3.9'
+  gem 'rubocop', '~> 0.85'
 end
 
 gem 'grape-swagger', git: 'https://github.com/ruby-grape/grape-swagger.git'

data/README.md

@@ -26,7 +26,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/grape-swagger-entity.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby-grape/grape-swagger-entity.
 
 ## License
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler'
 

data/bin/pry

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'grape-swagger/entity'

data/grape-swagger-entity.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'grape-swagger/entity/version'
@@ -17,7 +19,7 @@ Gem::Specification.new do |s|
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.required_ruby_version = '>= 2.2.6'
-  s.add_runtime_dependency 'grape-entity', '>= 0.5.0'
-  s.add_runtime_dependency 'grape-swagger', '>= 0.31.0'
+  s.required_ruby_version = '>= 2.4'
+  s.add_runtime_dependency 'grape-entity', '>= 0.6.0'
+  s.add_runtime_dependency 'grape-swagger', '>= 1.2.0'
 end

data/lib/grape-swagger-entity.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'grape-swagger/entity'

data/lib/grape-swagger/entity.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GrapeSwagger
   module Entity
     class AttributeParser
@@ -12,7 +14,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
@@ -24,8 +26,8 @@ module GrapeSwagger
           param = data_type_from(entity_options)
           return param unless documentation
 
-          param[:default] = documentation[:default] if documentation[:default]
-          add_attribute_example(param, documentation[:example])
+          add_attribute_sample(param, documentation, :default)
+          add_attribute_sample(param, documentation, :example)
 
           if (values = documentation[:values])
             param[:enum] = values if values.is_a?(Array)
@@ -36,6 +38,10 @@ module GrapeSwagger
             add_array_documentation(param, documentation)
           end
 
+          add_attribute_documentation(param, documentation)
+
+          add_extension_documentation(param, documentation)
+          add_discriminator_extension(param, documentation)
           param
         end
       end
@@ -61,8 +67,7 @@ module GrapeSwagger
       end
 
       def ambiguous_model_type?(type)
-        type &&
-          type.is_a?(Class) &&
+        type&.is_a?(Class) &&
           !GrapeSwagger::DocMethods::DataType.primitive?(type.name.downcase) &&
           !type == Array
       end
@@ -83,7 +88,7 @@ module GrapeSwagger
                else
                  { type: data_type }
                end
-        type[:format] = documentation[:format] if documentation && documentation.key?(:format)
+        type[:format] = documentation[:format] if documentation&.key?(:format)
 
         type
       end
@@ -103,10 +108,16 @@ module GrapeSwagger
         end
       end
 
-      def add_attribute_example(attribute, example)
-        return unless example
+      def add_attribute_sample(attribute, hash, key)
+        value = hash[key]
+        return if value.nil?
+
+        attribute[key] = value.is_a?(Proc) ? value.call : value
+      end
 
-        attribute[:example] = example.is_a?(Proc) ? example.call : example
+      def add_attribute_documentation(param, documentation)
+        param[:minLength] = documentation[:min_length] if documentation.key?(:min_length)
+        param[:maxLength] = documentation[:max_length] if documentation.key?(:max_length)
       end
 
       def add_array_documentation(param, documentation)
@@ -114,6 +125,14 @@ module GrapeSwagger
         param[:maxItems] = documentation[:max_items] if documentation.key?(:max_items)
         param[:uniqueItems] = documentation[:unique_items] if documentation.key?(:unique_items)
       end
+
+      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,38 @@
+# frozen_string_literal: true
+
+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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GrapeSwagger
   module Entity
     class Parser
@@ -17,15 +19,25 @@ module GrapeSwagger
 
       private
 
+      class Alias
+        attr_reader :original, :renamed
+
+        def initialize(original, renamed)
+          @original = original
+          @renamed = renamed
+        end
+      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
 
             extracted_params = extract_params(entity_class)
             memo.merge!(extracted_params)
           else
-            memo[value.attribute] = value.send(:options)
+            opts = value.send(:options)
+            opts[:as] ? memo[Alias.new(value.attribute, opts[:as])] = opts : memo[value.attribute] = opts
           end
         end
       end
@@ -39,6 +51,7 @@ module GrapeSwagger
           hidden_option = documentation_options.fetch(:hidden, nil)
           next if in_option == 'header' || hidden_option == true
 
+          entity_name = entity_name.original if entity_name.is_a?(Alias)
           final_entity_name = entity_options.fetch(:as, entity_name)
           documentation = entity_options[:documentation]
 
@@ -54,7 +67,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,7 @@
+# frozen_string_literal: true
+
 module GrapeSwagger
   module Entity
-    VERSION = '0.3.2'.freeze
+    VERSION = '0.5.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger-entity
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.5.1
 platform: ruby
 authors:
 - Kirill Zaitsev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-15 00:00:00.000000000 Z
+date: 2020-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape-entity
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: grape-swagger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.31.0
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.31.0
+        version: 1.2.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
@@ -76,15 +77,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.6
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Grape swagger adapter to support grape-entity object parsing