ml-opensource / ml-opensource/flutter-template
Consider avoid using base Use Case classes to avoid redundant code
Nobody has claimed this yet.
- Dominant language
- Dart
- Stars
- 37
- Forks
- 23
- PR merge metrics
- No merged PRs in 30d
Description
The problem
The base use case classes like UseCase, StreamUseCase etc bring us only one benefit: they keep the use cases interface consistent. They force us to use the run method.
But we never operate with use cases using their base classes, e.g. you will never see
final UseCase<int, int> _calculateSomethingUseCase = injector<CalculateSomethingUsecase>();
It will always be:
final CalculateSomethingUseCase _calculateSomethingUseCase = injector<CalculateSomethingUseCase>();
But by using the base class we are forced to always have a single parameter in the run method. If we'd need two or more parameters, we would be forced to create an Input class. This is:
- Not convenient
- Expands our code base for no reason
// Bad
_myUseCase.run(MyInput(param1: 0, param2: 1));
// Good
_myUseCase.run(param1: 0, param2: 1);
The solution
Remove the inheritance from all the use cases. But then we will have to somehow ensure that all the use cases follow the same interface, having a public run method.
We could use this GitHub action to validate our pull requests to have the same use case structure. You can find an example here, it has a valid PR and an invalid PR.
But it is less convenient than a linter rule that could highlight the error in our IDE right when we code, not when we submit a PR.
So... We can create a linter rule that would validate our use case classes. custom_lint could be used for this purpose — but it needs investigation.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the base use case classes and their implementations, then review custom_lint and the linked validator examples. Completion would mean removing the inheritance without losing a consistent public run method and adding IDE-visible validation; no specific files or tests are named, so the scope needs investigation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- dart
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100