grape-swagger-entity 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d482687ea661169b18eb8f35ef06aa7601a57f4965c568b8f130c0451964465b
-  data.tar.gz: 31e4b9aa0f9d132aabaefd2463a0fcecb3758eddc2316a13a5c77e443a653a55
+  metadata.gz: 3d55e877c4ed7f40cbc6331e38fdb62522c85e92dfcb5bbf239be8181cbcd456
+  data.tar.gz: c22441830ec45ee2ef82dff6066106bfecfd5a820050665090e4c4f9c110b16e
 SHA512:
-  metadata.gz: 865221ba8a968d4f52d0572c30b3bcbff87797827f36056a34b9addb7e6cdc496354fbc87d8e89ed0b39e22691a32797b129219666a6c19f5dc2837983161344
-  data.tar.gz: 2a87aa4e3b5219238d1c59e184c0e52acb2c8e9f077830117895fd7af554721631f64e3ce9be73b1f4573d9a4026a68a8805d2298c4717f2133b99cabe58aa2c
+  metadata.gz: bbf329848abcdcef57edd7cde491cef96160f29e266958f9ad5763f987210d506811858937c4e9cee59d85e2ff3ad200e85834a2cece230a172d22a6b0aaa2c9
+  data.tar.gz: efe0f9739a54925a044661d02ecd9ba232a5909a9c08556bd5a51c39aa6ea82ab413db5e77a350659ccba75462ceba704efb95f02ce2f774ea762f3491d8460c

data/.github/workflows/test.yml

@@ -15,7 +15,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.2
+          ruby-version: 3.0
           bundler-cache: true
           rubygems: latest
 
@@ -26,13 +26,70 @@ jobs:
     name: test (ruby=${{ matrix.ruby }}, grape=${{ matrix.grape }}, grape-swagger=${{ matrix.grape_swagger}}, grape_entity=${{ matrix.grape_entity }})
     strategy:
       matrix:
-        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' }
+        include:
+          # Ruby 3.1 combinations
+          - ruby: '3.0'
+            grape: '~> 2.0.0'
+            grape_swagger: '~> 2.0.3'
+            grape_entity: '~> 1.0.1'
+          - ruby: '3.0'
+            grape: '~> 2.0.0'
+            grape_swagger: '~> 2.1.1'
+            grape_entity: 'head'
+
+          # Ruby 3.4 combinations
+          - ruby: '3.4'
+            grape: '~> 2.0.0'
+            grape_swagger: '~> 2.0.3'
+            grape_entity: '~> 1.0.1'
+          - ruby: '3.4'
+            grape: '~> 2.0.0'
+            grape_swagger: '~> 2.0.3'
+            grape_entity: 'head'
+          - ruby: '3.4'
+            grape: '~> 2.0.0'
+            grape_swagger: 'head'
+            grape_entity: '~> 1.0.1'
+          - ruby: '3.4'
+            grape: '~> 2.0.0'
+            grape_swagger: 'head'
+            grape_entity: 'head'
+          # - ruby: '3.4'
+          #   grape: 'head'
+          #   grape_swagger: 'head'
+          #   grape_entity: '~> 1.0.1'
+          # - ruby: '3.4'
+          #   grape: 'head'
+          #   grape_swagger: 'head'
+          #   grape_entity: 'head'
+
+          # Ruby head combinations
+          - ruby: 'head'
+            grape: '~> 2.0.0'
+            grape_swagger: '~> 2.0.3'
+            grape_entity: '~> 1.0.1'
+          - ruby: 'head'
+            grape: '~> 2.0.0'
+            grape_swagger: '~> 2.0.3'
+            grape_entity: 'head'
+          - ruby: 'head'
+            grape: '~> 2.0.0'
+            grape_swagger: 'head'
+            grape_entity: '~> 1.0.1'
+
+          # - ruby: 'head'
+          #   grape: '~> 2.0.0'
+          #   grape_swagger: 'head'
+          #   grape_entity: 'head'
+          # - ruby: 'head'
+          #   grape: 'head'
+          #   grape_swagger: 'head'
+          #   grape_entity: '~> 1.0.1'
+          # - ruby: 'head'
+          #   grape: 'head'
+          #   grape_swagger: 'head'
+          #   grape_entity: 'head'
+
     runs-on: ubuntu-latest
     env:
       GRAPE_VERSION: ${{ matrix.grape }}

data/.rubocop.yml

@@ -3,11 +3,11 @@ AllCops:
   Exclude:
     - vendor/**/*
   TargetRubyVersion:
-    2.7
+    3.0
 
 inherit_from: .rubocop_todo.yml
 
-require:
+plugins:
   - rubocop-rake
   - rubocop-rspec
 

data/.rubocop_todo.yml

@@ -1,18 +1,11 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-09-09 22:35:29 UTC using RuboCop version 1.66.1.
+# on 2025-05-28 16:52:10 UTC using RuboCop version 1.75.8.
 # 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
-# Configuration parameters: Severity, Include.
-# Include: **/*.gemspec
-Gemspec/RequiredRubyVersion:
-  Exclude:
-    - 'grape-swagger-entity.gemspec'
-
 # Offense count: 3
 # Configuration parameters: AllowedMethods.
 # AllowedMethods: enums
@@ -44,7 +37,7 @@ Metrics/AbcSize:
 # Offense count: 2
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 112
+  Max: 117
 
 # Offense count: 2
 # Configuration parameters: AllowedMethods, AllowedPatterns.
@@ -64,7 +57,7 @@ Metrics/PerceivedComplexity:
 # Offense count: 5
 # Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
 # SupportedStyles: snake_case, normalcase, non_integer
-# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
+# AllowedIdentifiers: TLS1_1, TLS1_2, capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
 Naming/VariableNumber:
   Exclude:
     - 'spec/grape-swagger/entities/response_model_spec.rb'
@@ -100,9 +93,9 @@ RSpec/DescribeClass:
 # Offense count: 4
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
-  Max: 187
+  Max: 213
 
-# Offense count: 24
+# Offense count: 26
 RSpec/LeakyConstantDeclaration:
   Exclude:
     - 'spec/grape-swagger/entities/response_model_spec.rb'
@@ -118,14 +111,14 @@ RSpec/MultipleDescribes:
 RSpec/MultipleExpectations:
   Max: 11
 
-# Offense count: 20
+# Offense count: 21
 # Configuration parameters: EnforcedStyle, IgnoreSharedExamples.
 # SupportedStyles: always, named_only
 RSpec/NamedSubject:
   Exclude:
     - 'spec/grape-swagger/entities/response_model_spec.rb'
 
-# Offense count: 39
+# Offense count: 46
 # Configuration parameters: AllowedGroups.
 RSpec/NestedGroups:
   Max: 5

data/CHANGELOG.md

@@ -1,5 +1,11 @@
-### 0.6.2 (2025/05/10)
+### 0.7.0 (2025/08/02)
+
+#### Features
 
+* [#81](https://github.com/ruby-grape/grape-swagger-entity/pull/81): Make entity fields required by default - [@olivier-thatch](https://github.com/olivier-thatch).
+* [#85](https://github.com/ruby-grape/grape-swagger-entity/pull/85): Use rubocop plugins, use ruby 3.0 as minimum version everywhere - [@olivier-thatch](https://github.com/olivier-thatch).
+
+### 0.6.2 (2025/05/10)
 
 #### Fixes
 

data/Gemfile

@@ -34,9 +34,12 @@ group :development, :test do
   gem 'rake'
   gem 'rdoc'
   gem 'rspec'
-  gem 'rubocop'
-  gem 'rubocop-rake'
-  gem 'rubocop-rspec'
+end
+
+group :development do
+  gem 'rubocop', '>= 1.72', require: false
+  gem 'rubocop-rake', '>= 0.7', require: false
+  gem 'rubocop-rspec', '>= 3.5.0', require: false
 end
 
 group :test do

data/UPGRADING.md

@@ -0,0 +1,54 @@
+## Upgrading grape-swagger-entity
+
+### Upgrading to >= 0.7.0
+
+#### Entity Fields Required by Default
+
+This release changes how `grape-swagger-entity` determines if an entity field is
+**required** in the generated Swagger documentation. This is a **breaking change**
+and may require updates to your API documentation and any tools or tests that rely
+on the previous behavior.
+
+**Previous Behavior:**
+Fields were considered optional by default unless explicitly marked as `required: true`
+in their `documentation` options.
+
+**New Behavior:**
+Fields are now considered **required by default** unless one of the following
+conditions is met:
+
+1.  **`documentation: { required: false }` is explicitly set:** If you want a field to
+    be optional, you must now explicitly set `required: false` within its
+    `documentation` hash.
+    ```ruby
+    expose :field_name,
+           documentation: { type: String, required: false, desc: 'An optional field' }
+    ```
+2.  **`if` or `unless` options are present:** If a field uses `if` or `unless` for
+    conditional exposure, it will be considered optional.
+    ```ruby
+    expose :conditional_field,
+           if: -> { some_condition? },
+           documentation: { type: String, desc: 'Exposed only if condition is met' }
+    ```
+3.  **`expose_nil: false` is set:** If `expose_nil` is set to `false`, the field will
+    be considered optional.
+    ```ruby
+    expose :non_nil_field,
+           expose_nil: false,
+           documentation: { type: String, desc: 'Not exposed if nil' }
+    ```
+
+This change aligns `grape-swagger-entity`'s behavior with `grape-entity`'s rendering
+logic, where fields are always exposed unless `if` or `unless` is provided.
+
+**Action Required:**
+Review your existing Grape entities. If you have fields that were implicitly
+considered optional but did not explicitly set `required: false`, `if`, `unless`, or
+`expose_nil: false`, they will now be marked as required in your Swagger
+documentation.Adjust your `documentation` options accordingly to maintain the desired
+optionality for these fields.
+
+For more details, refer to GitHub Pull Request
+[#81](https://github.com/ruby-grape/grape-swagger-entity/pull/81).
+````

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

@@ -135,9 +135,15 @@ module GrapeSwagger
       end
 
       def required_params(params)
-        params.select { |_, options| options.fetch(:documentation, {}).fetch(:required, false) }
-              .map { |(key, options)| [options.fetch(:as, key), options] }
-              .map(&:first)
+        params.each_with_object(Set.new) do |(key, options), accum|
+          required = if options.fetch(:documentation, {}).key?(:required)
+                       options.dig(:documentation, :required)
+                     else
+                       !options.key?(:if) && !options.key?(:unless) && options[:expose_nil] != false
+                     end
+
+          accum.add(options.fetch(:as, key)) if required
+        end.to_a
       end
 
       def with_required(hash, required)

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

@@ -2,6 +2,6 @@
 
 module GrapeSwagger
   module Entity
-    VERSION = '0.6.2'
+    VERSION = '0.7.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger-entity
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Kirill Zaitsev
@@ -56,6 +56,7 @@ files:
 - README.md
 - RELEASING.md
 - Rakefile
+- UPGRADING.md
 - bin/pry
 - bin/setup
 - grape-swagger-entity.gemspec