Name the ResourceEndpoint helpers consistently - #6
Merged
Conversation
The five protected helpers mixed three conventions: getOne/createOne (semantic verb + One), bare update, the noun operation, and the abbreviated putSub. Now every helper is either semanticVerb+One (typed single-resource CRUD) or httpVerb+target (transport helpers): - update -> updateOne - operation -> postOperation - putSub -> putSubResource Also fixes the class docblock's update() bullet, which said PUT while the helper sends PATCH (the same slip #4 fixed on updatePayment()). Internal-only rename: the helpers are protected, endpoint subclassing is explicitly unsupported, and all call sites live in PaymentsEndpoint.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## 1.x #6 +/- ##
=========================================
Coverage 97.00% 97.00%
Complexity 146 146
=========================================
Files 24 24
Lines 401 401
=========================================
Hits 389 389
Misses 12 12 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The five protected helpers mixed three naming conventions:
getOne/createOne(semantic verb +One), bareupdate, the nounoperation, and the abbreviatedputSub. After this PR every helper follows one of two patterns:getOne,createOne,updateOnepostOperation,putSubResourceupdate()updateOne()operation()postOperation()putSub()putSubResource()Also fixes the class docblock's
update()bullet, which said PUT while the helper sends PATCH — the same slip #4 fixed onupdatePayment().No BC impact: the helpers are
protected, endpoint subclassing is explicitly unsupported (@internal, outside the BC promise), and every call site lives inPaymentsEndpoint. Behavior-neutral rename — all checks green (103 tests, PHPStan max, ECS, Rector).