refactor: don't design interfaces, discover them. #110
Conversation
This file contains 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
muktihari
commented
Sep 2, 2024
| func NewService(preproc *activity.Preprocessor) activity.Service { | ||
| return &service{preprocessor: preproc} | ||
| // NewDecodeEncoder creates new GPX decode-encoder. | ||
| func NewDecodeEncoder(preproc *activity.Preprocessor) *DecodeEncoder { |
There was a problem hiding this comment.
Now the constructor return concrete type rather than interface for flexibility
raditzlawliet
approved these changes
Sep 4, 2024
| fs := fit.NewService(preproc) | ||
| gs := gpx.NewService(preproc) | ||
| ts := tcx.NewService(preproc) | ||
| fit := fit.NewDecodeEncoder(preproc) |
There was a problem hiding this comment.
fyi, This local variable name may cause confusion when maintain in the future
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
"Don't design with interfaces, discover them" - Rob Pike
Interfaces should be created by the consumer instead of the producer. The consumer, in this case
service/service.go (Service{}), are the one who decides which methods are needed to carry the operation. We as software engineer should discover it this way, not by designing interfaces. The producer, in this casefit,gpx, andtcx, only responsible to satisfy the interface.The interface named Service in
activity/service.gois removed, the name ofServiceinterface is renamed toDecodeEncoderas it only needs to do two things, to decode and to encode. This also eliminates the ambiguity surrounding the name 'Service'.