Refactor versioner middleware: simplify base class and improve consistency #2600
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Remove unset, unset_namespace_stackable, and namespace_inheritable_to_nil methods - Simplify reset_validations! to call delete directly instead of through wrappers - Enhance BaseInheritable#delete to accept multiple keys - Improve without_root_prefix_and_versioning with proper ensure block cleanup - Update tests to verify actual behavior instead of method calls These methods were internal APIs not intended for public use. Removing them reduces the public API surface and simplifies the codebase.
- Replace dynamic method generation with explicit method definitions - Simplify get_or_set to work directly with setting objects instead of type symbols - Update logger to directly access global settings for better performance - Improve test coverage to focus on actual behavior rather than delegation - Remove unnecessary complexity in settings DSL implementation
…tency - Remove method indirection in Base class by using define_method for options - Consolidate version options handling and improve initialization - Replace strict? method calls with direct strict access - Fix parameter_key references to use parameter method directly - Improve version matching logic and error handling consistency
ericproulx
force-pushed
the
small_refactor_versioner_middleware
branch
from
f1874f1 to
1b369a7
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Refactor versioner middleware: simplify base class and improve consistency
Summary
This PR refactors the Grape versioner middleware to improve code maintainability, reduce complexity, and enhance consistency across the versioning components.
Changes Made
🔧 Base Class Simplification
define_methodfor options access🎯 Method Consistency
strict?method calls with directstrictaccess for consistencyparameter_keyreferences to use theparametermethod directly📊 Code Reduction
Files Modified
lib/grape/middleware/versioner/base.rb- Major refactoring of base classlib/grape/middleware/versioner/accept_version_header.rb- Method call consistencylib/grape/middleware/versioner/header.rb- Method call consistencylib/grape/middleware/versioner/param.rb- Parameter method consistencyBenefits
✅ Improved maintainability - Less code to maintain with same functionality
✅ Better consistency - Unified approach to accessing options and methods
✅ Enhanced readability - Cleaner, more straightforward code structure
✅ Performance improvement - Direct method access instead of method indirection
Testing
Branch
small_refactor_versioner_middlewareThis refactoring maintains the same external behavior while significantly improving the internal code structure and maintainability of the versioner middleware components.