Replace StrictHashConfiguration by simpler Grape::Util::ApiDescription

[ericproulx]

Refactor: Replace StrictHashConfiguration with ApiDescription

This pull request refactors the mechanism for handling API endpoint descriptions by replacing the overly complex Grape::Util::StrictHashConfiguration with a new, more straightforward class, Grape::Util::ApiDescription.

Problem

The previous implementation, StrictHashConfiguration, used significant metaprogramming (class_eval, define_method, const_set) to dynamically build configuration containers. This made the code:

• Difficult to understand: The dynamic nature obscured the simple goal of collecting description attributes.
• Hard to debug: Errors were often cryptic and disconnected from the original desc block.
• Inflexible: Adding new description attributes was cumbersome and required modifying the dynamic builder.

Solution

The new Grape::Util::ApiDescription class provides a clear and explicit DSL for defining endpoint metadata.

Key Changes:

• Added Grape::Util::ApiDescription: A simple PORO (Plain Old Ruby Object) that uses an instance_eval block to provide a clean DSL for setting description attributes. All available attributes (:summary, :detail, :params, etc.) are explicitly defined.
• Updated Grape::DSL::Desc: The desc method in the DSL now instantiates ApiDescription instead of using the StrictHashConfiguration module.
• Removed Grape::Util::StrictHashConfiguration: The complex, metaprogrammed module and its specs have been completely removed from the codebase.

Benefits

• Improved Readability & Maintainability: The new implementation is simple, explicit, and easy for any developer to understand and extend.
• Simplified Codebase: Removed over 100 lines of complex metaprogramming in favor of a ~50 line PORO.
• Better Developer Experience: Debugging is now much easier, as the code directly reflects the DSL's behavior.
• No Functional Change: This is purely a refactoring. It has no impact on the public API or runtime behavior of Grape. All existing APIs will continue to work as before.

This change makes a core part of Grape's DSL significantly more robust and easier to maintain for the future.

[grape-bot]

	1 Warning
⚠️	There're library changes, but not tests. That's OK as long as you're refactoring existing code.

Generated by 🚫 Danger