Fix Array[Object] documentation type parsing

[numbata]

Fixes incorrect Swagger schema generation when using custom array documentation syntax like type: 'Array[Object]'.

Problem

When using type: 'Array[Object]' with an entity, the Swagger schema was not correctly generated as an array type with $ref items.

Solution

Add array_type? method that detects array notations:

• is_array: true - explicit flag (existing behavior)
• type: 'Array[Object]' - new syntax for entity arrays

Usage Example

class Report < Grape::Entity
  expose :items,
         using: ItemEntity,
         documentation: {
           type: 'Array[Object]',
           desc: 'List of items'
         }
end

Generates correct schema:

{
  "type": "array",
  "description": "List of items",
  "items": { "$ref": "#/definitions/ItemEntity" }
}

Other Changes

• Refactor parse_grape_entity_params into smaller, focused methods for readability
• Add nil guards to prevent potential crashes
• Fix indentation in parse_nested method

Backward Compatibility

• is_array: true continues to work as before
• is_array: false is respected when explicitly set
• Bare type: 'Array' is not double-wrapped

Note

Tests for empty entity handling require grape-swagger >= 2.1.3 (ruby-grape/grape-swagger#963) and are skipped for older versions.

Fixes ruby-grape/grape-swagger#962

[grape-bot]

	1 Warning
⚠️	Unless you're refactoring existing code or improving documentation, please update CHANGELOG.md.

Here's an example of a CHANGELOG.md entry:

* [#86](https://github.com/ruby-grape/grape-swagger-entity/pull/86): Fix: properly parse custom array documentation - [@numbata](https://github.com/numbata).

Generated by 🚫 Danger

[github-actions]

Danger Report

No issues found.

View run

[Copilot]

Pull request overview

This PR fixes Swagger schema generation for Grape entities documented with custom array type syntax like type: 'Array[Object]', and refactors entity parsing for better readability and testability.

Changes:

• Introduces array_type? in AttributeParser to interpret is_array, type: 'array', and type: 'Array[object]' as arrays, and refines model/type resolution logic.
• Refactors Parser#parse_grape_entity_params into smaller helpers (parse_params, skip_param?, parse_entity_options, handle_discriminator, etc.) while preserving the public result structure.
• Adds regression specs for issue #962 (polymorphic entity with custom documentation type), wires shared contexts correctly, and updates test/config files (.rspec, .rubocop_todo.yml, CHANGELOG.md).

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
lib/grape-swagger/entity/attribute_parser.rb	Adds array_type?, improves primitive/model detection, and updates array handling for both documented primitives and entity models; contains a bug where array_type? is called with a potentially nil documentation hash in entity_model_type.
lib/grape-swagger/entity/parser.rb	Refactors entity param parsing into helper methods, centralizes required-field computation, and adjusts discriminator handling while keeping the external return shape compatible.
spec/issues/962_polymorphic_entity_with_custom_documentation_spec.rb	New regression specs ensuring entities with documentation: { type: 'Array[object]' } and empty/hidden properties generate the expected Swagger definitions; the skip message’s version text is inconsistent with the actual version check.
spec/grape-swagger/entities/response_model_spec.rb	Ensures the shared this api context is included for the first describe block so the API under test is properly defined.
spec/support/shared_contexts/custom_type_parser.rb	Replaces the anonymous CustomType = Class.new with an explicit empty CustomType class to satisfy style cops and keep the custom model parser registration intact.
CHANGELOG.md	Documents this fix as PR #86 in the “Fixes” section.
.rubocop_todo.yml	Updates RuboCop exclusions and offense counts to accommodate the new spec file, empty class, and issue-spec layout.
.rspec	Ensures spec_helper is always loaded via the RSpec configuration, simplifying spec setup.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated no new comments.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.