grape-swagger-entity 0.5.5 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2acdf9214576f2fd49186e8bf6163382daa19b6842dc08033567d2427aaa5bcc
-  data.tar.gz: 50fa87da0ef94dff6128cea9b5178d3455c831b87457768ea8140bd14f8fc001
+  metadata.gz: 42830a4af16bc176defa31e496aeebfc5601a503e649169788b4465bdc265aa9
+  data.tar.gz: fbf28a2d59009b68385d8f32e0ff3bbc17cf801c5899274e3886284580393175
 SHA512:
-  metadata.gz: 6f7f9ef5026e54fd99035d38e84c358cc8446a117aadeb486f900775ff15a83bc3b5aaa7c0f3c27afbde6a870ec77a3e8e6baf9fcc1c13df024826f1164aecf8
-  data.tar.gz: 89b9bcb8ef9693861bf2042f70147f611b9500c0dda4db5cac5b08af03a156281be02ec14afd71722d23fa498fec28308f1d638997bae066f3db4c07c7d98397
+  metadata.gz: 39ba0110395a1e3424958ecde9fe48d144af50a7500cc78a19a7a7191e27dc2ac893ce5b1760477fd5c3ae56149506c8ae4466003c2d97d73559e7f9db3afd78
+  data.tar.gz: a3c91cf3cc0d9ad620adb3b3b40a4940430c88b863271fe58b98ee718180a1596ff4a3789ff67bfe12562f29b7acec3fd56635ab214d85499d4c968672742aab

data/.github/workflows/test.yml

@@ -23,21 +23,28 @@ jobs:
         run: bundle exec rubocop
 
   test:
-    env:
-      GRAPE_ENTITY: 1.0.0
-
-    runs-on: ubuntu-latest
+    name: test (ruby=${{ matrix.ruby }}, grape=${{ matrix.grape }}, grape-swagger=${{ matrix.grape_swagger}}, grape_entity=${{ matrix.grape_entity }})
     strategy:
-      fail-fast: false
       matrix:
-        ruby-version: ['3.0', '3.1', '3.2', '3.3']
+        grape: [ '~> 2.0.0', 'head' ]
+        grape_swagger: [ '~> 2.0.3', 'head' ]
+        grape_entity: [ '~> 1.0.1', 'head' ]
+        ruby: [ '3.1', '3.4', 'head' ]
+        # Exclude combinations that are not supported.
+        exclude:
+          - { grape_swagger: '~> 2.0.3', grape: 'head' }
+    runs-on: ubuntu-latest
+    env:
+      GRAPE_VERSION: ${{ matrix.grape }}
+      GRAPE_SWAGGER_VERSION: ${{ matrix.grape_swagger }}
+      GRAPE_ENTITY_VERSION: ${{ matrix.grape_entity }}
 
     steps:
     - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: ${{ matrix.ruby-version }}
+        ruby-version: ${{ matrix.ruby }}
         bundler-cache: true
     - name: Run tests
       run: bundle exec rake spec

data/.rubocop.yml

@@ -7,6 +7,10 @@ AllCops:
 
 inherit_from: .rubocop_todo.yml
 
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
 Naming/FileName:
   Enabled: false
 

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
-# `rubocop --auto-gen-config --auto-gen-only-exclude --exclude-limit 5000`
-# on 2023-07-06 20:16:40 UTC using RuboCop version 1.42.0.
+# `rubocop --auto-gen-config`
+# on 2024-09-09 22:35:29 UTC using RuboCop version 1.66.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
@@ -28,7 +28,7 @@ Lint/EmptyBlock:
   Exclude:
     - 'spec/grape-swagger/entity/attribute_parser_spec.rb'
 
-# Offense count: 1
+# Offense count: 2
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: AllowedMethods.
 # AllowedMethods: instance_of?, kind_of?, is_a?, eql?, respond_to?, equal?
@@ -37,59 +37,109 @@ Lint/RedundantSafeNavigation:
     - 'lib/grape-swagger/entity/attribute_parser.rb'
 
 # Offense count: 4
-# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, CountRepeatedAttributes, Max.
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Exclude:
-    - 'lib/grape-swagger/entity/attribute_parser.rb'
-    - 'lib/grape-swagger/entity/parser.rb'
-
-# Offense count: 13
-# Configuration parameters: CountComments, Max, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
-# AllowedMethods: refine
-Metrics/BlockLength:
-  Exclude:
-    - '**/*.gemspec'
-    - 'spec/grape-swagger/entities/response_model_spec.rb'
-    - 'spec/grape-swagger/entity/attribute_parser_spec.rb'
-    - 'spec/grape-swagger/entity/parser_spec.rb'
-    - 'spec/support/shared_contexts/this_api.rb'
+  Max: 34
 
-# Offense count: 1
-# Configuration parameters: CountComments, Max, CountAsOne.
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Exclude:
-    - 'lib/grape-swagger/entity/attribute_parser.rb'
-    - 'lib/grape-swagger/entity/parser.rb'
+  Max: 112
 
 # Offense count: 2
-# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, Max.
+# Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
-  Exclude:
-    - 'lib/grape-swagger/entity/attribute_parser.rb'
-    - 'lib/grape-swagger/entity/parser.rb'
+  Max: 11
 
-# Offense count: 5
-# Configuration parameters: CountComments, Max, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
+# Offense count: 7
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Exclude:
-    - 'lib/grape-swagger/entity/attribute_parser.rb'
-    - 'lib/grape-swagger/entity/parser.rb'
+  Max: 28
 
 # Offense count: 2
-# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, Max.
+# Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/PerceivedComplexity:
-  Exclude:
-    - 'lib/grape-swagger/entity/attribute_parser.rb'
-    - 'lib/grape-swagger/entity/parser.rb'
+  Max: 13
 
-# Offense count: 2
+# Offense count: 5
 # Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
 # SupportedStyles: snake_case, normalcase, non_integer
-# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339
+# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
 Naming/VariableNumber:
   Exclude:
     - 'spec/grape-swagger/entities/response_model_spec.rb'
 
+# Offense count: 1
+RSpec/BeforeAfterAll:
+  Exclude:
+    - '**/spec/spec_helper.rb'
+    - '**/spec/rails_helper.rb'
+    - '**/spec/support/**/*.rb'
+    - 'spec/grape-swagger/entities/response_model_spec.rb'
+
+# Offense count: 4
+# Configuration parameters: Prefixes, AllowedPatterns.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/grape-swagger/entity/parser_spec.rb'
+    - 'spec/support/shared_contexts/inheritance_api.rb'
+    - 'spec/support/shared_contexts/this_api.rb'
+
+# Offense count: 2
+# Configuration parameters: IgnoredMetadata.
+RSpec/DescribeClass:
+  Exclude:
+    - '**/spec/features/**/*'
+    - '**/spec/requests/**/*'
+    - '**/spec/routing/**/*'
+    - '**/spec/system/**/*'
+    - '**/spec/views/**/*'
+    - 'spec/grape-swagger/entities/response_model_spec.rb'
+
+# Offense count: 4
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 187
+
+# Offense count: 24
+RSpec/LeakyConstantDeclaration:
+  Exclude:
+    - 'spec/grape-swagger/entities/response_model_spec.rb'
+    - 'spec/support/shared_contexts/inheritance_api.rb'
+    - 'spec/support/shared_contexts/this_api.rb'
+
+# Offense count: 1
+RSpec/MultipleDescribes:
+  Exclude:
+    - 'spec/grape-swagger/entities/response_model_spec.rb'
+
+# Offense count: 5
+RSpec/MultipleExpectations:
+  Max: 11
+
+# Offense count: 20
+# Configuration parameters: EnforcedStyle, IgnoreSharedExamples.
+# SupportedStyles: always, named_only
+RSpec/NamedSubject:
+  Exclude:
+    - 'spec/grape-swagger/entities/response_model_spec.rb'
+
+# Offense count: 39
+# Configuration parameters: AllowedGroups.
+RSpec/NestedGroups:
+  Max: 5
+
+# Offense count: 3
+# Configuration parameters: Include, CustomTransform, IgnoreMethods, IgnoreMetadata.
+# Include: **/*_spec.rb
+RSpec/SpecFilePathFormat:
+  Exclude:
+    - '**/spec/routing/**/*'
+    - 'spec/grape-swagger/entity/attribute_parser_spec.rb'
+    - 'spec/grape-swagger/entity/parser_spec.rb'
+    - 'spec/grape-swagger/entity_spec.rb'
+
 # Offense count: 4
 # Configuration parameters: AllowedConstants.
 Style/Documentation:

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+### 0.6.1 (2025/05/06)
+
+#### Fixes
+
+* [#79](https://github.com/ruby-grape/grape-swagger-entity/pull/79): Fix correctly handle class types like time in documentation - [@krororo](https://github.com/krororo).
+
+### 0.6.0 (2025/04/26)
+
+#### Features
+
+* [#76](https://github.com/ruby-grape/grape-swagger-entity/pull/76): Update ci matrix and gemfile for multi-version grape testing - [@numbata](https://github.com/numbata).
+* [#77](https://github.com/ruby-grape/grape-swagger-entity/pull/77): Allow proc for enum values in documentation - [@krororo](https://github.com/krororo).
+
+#### Fixes
+
+* [#75](https://github.com/ruby-grape/grape-swagger-entity/pull/75): Fix handling of entity with class names without "entity" or "entities" - [@numbata](https://github.com/numbata).
+
 ### 0.5.5 (2024/09/09)
 
 #### Fixes

data/Gemfile

@@ -5,6 +5,25 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in grape-swagger-entity.gemspec
 gemspec
 
+grape_version = ENV.fetch('GRAPE_VERSION', '< 3.0')
+grape_swagger_version = ENV.fetch('GRAPE_SWAGGER_VERSION', '< 3.0')
+grape_entity_version = ENV.fetch('GRAPE_ENTITY_VERSION', '< 2.0')
+
+grape_spec = grape_version.casecmp('HEAD').zero? ? { git: 'https://github.com/ruby-grape/grape' } : grape_version
+grape_swagger_spec = if grape_swagger_version.casecmp('HEAD').zero?
+                       { git: 'https://github.com/ruby-grape/grape-swagger.git' }
+                     else
+                       grape_swagger_version
+                     end
+grape_entity_spec = if grape_entity_version.casecmp('HEAD').zero?
+                      { git: 'https://github.com/ruby-grape/grape-entity.git' }
+                    else
+                      grape_entity_version
+                    end
+
+gem 'grape', grape_spec
+gem 'grape-swagger', grape_swagger_spec
+
 group :development, :test do
   gem 'bundler'
   gem 'pry', platforms: [:mri]
@@ -16,12 +35,12 @@ group :development, :test do
   gem 'rdoc'
   gem 'rspec'
   gem 'rubocop'
+  gem 'rubocop-rake'
+  gem 'rubocop-rspec'
 end
 
-gem 'grape-swagger', git: 'https://github.com/ruby-grape/grape-swagger.git'
-
 group :test do
-  gem 'grape-entity', ENV.fetch('GRAPE_ENTITY', '1.0.0')
+  gem 'grape-entity', grape_entity_spec
   gem 'ruby-grape-danger', '~> 0.2.1', require: false
   gem 'simplecov', require: false
 end

data/README.md

@@ -1,7 +1,7 @@
 # GrapeSwagger::Entity
 
 [![Gem Version](https://badge.fury.io/rb/grape-swagger-entity.svg)](https://badge.fury.io/rb/grape-swagger-entity)
-[![Build Status](https://github.com/ruby-grape/grape-swagger-entity/workflows/test/badge.svg?branch=master)](https://github.com/ruby-grape/grape-swagger-entity/actions)
+[![Build Status](https://github.com/ruby-grape/grape-swagger-entity/actions/workflows/test.yml/badge.svg)](https://github.com/ruby-grape/grape-swagger-entity/actions/workflows/test.yml)
 
 ## Table of Contents
 

data/grape-swagger-entity.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.required_ruby_version = '>= 3.0'
-  s.add_runtime_dependency 'grape-entity', '~> 1'
-  s.add_runtime_dependency 'grape-swagger', '~> 2'
+  s.add_dependency 'grape-entity', '~> 1'
+  s.add_dependency 'grape-swagger', '~> 2'
   s.metadata['rubygems_mfa_required'] = 'true'
 end

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

@@ -5,6 +5,9 @@ module GrapeSwagger
     class AttributeParser
       attr_reader :endpoint
 
+      # The list of that doesn't handled by `GrapeSwagger::DocMethods::DataType.primitive?` method
+      ADDITIONAL_PRIMITIVE_TYPES = %w[string array].freeze
+
       def initialize(endpoint)
         @endpoint = endpoint
       end
@@ -53,9 +56,13 @@ module GrapeSwagger
       end
 
       def ambiguous_model_type?(type)
-        type&.is_a?(Class) &&
-          !GrapeSwagger::DocMethods::DataType.primitive?(type.name.downcase) &&
-          !type == Array
+        type&.is_a?(Class) && !primitive_type?(type)
+      end
+
+      def primitive_type?(type)
+        data_type = GrapeSwagger::DocMethods::DataType.call(type)
+        GrapeSwagger::DocMethods::DataType.primitive?(data_type) ||
+          ADDITIONAL_PRIMITIVE_TYPES.include?(data_type)
       end
 
       def data_type_from(entity_options)
@@ -86,9 +93,9 @@ module GrapeSwagger
 
         type[:format] = documentation[:format] if documentation.key?(:format)
 
-        if (values = documentation[:values]) && values.is_a?(Array)
-          type[:enum] = values
-        end
+        values = documentation[:values]
+        values = values.call if values.is_a?(Proc)
+        type[:enum] = values if values.is_a?(Array)
 
         type
       end

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

@@ -2,6 +2,6 @@
 
 module GrapeSwagger
   module Entity
-    VERSION = '0.5.5'
+    VERSION = '0.6.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger-entity
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.6.1
 platform: ruby
 authors:
 - Kirill Zaitsev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-09 00:00:00.000000000 Z
+date: 2025-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape-entity
@@ -87,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Grape swagger adapter to support grape-entity object parsing