38b8ae641f
This refactors the TodoService class according to our code reuse
guidelines. The resulting code is a wee bit more verbose, but it allows
us to decouple the column names from the input, resulting in fewer
changes being necessary when we change the schema.
One particular noteworthy line in TodoService is the following:
todos_ids = todos.update_state(state)
Technically this is a violation of the guidelines, because
`update_state` is a class method, which services are not supposed to use
(safe for a few allowed ones). I decided to keep this, since there is no
alternative. `update_state` doesn't produce a relation so it doesn't
belong in a Finder, and we can't move it to another Service either. As
such I opted to just use the method directly.
Cases like this may happen more frequently, at which point we should
update our documentation with some sort of recommendation. For now, I
want to refrain from doing so until we have a few more examples.
|
||
|---|---|---|
| .. | ||
| admin | ||
| autocomplete | ||
| concerns | ||
| access_requests_finder.rb | ||
| awarded_emoji_finder.rb | ||
| branches_finder.rb | ||
| clusters_finder.rb | ||
| contributed_projects_finder.rb | ||
| environments_finder.rb | ||
| events_finder.rb | ||
| fork_projects_finder.rb | ||
| group_descendants_finder.rb | ||
| group_finder.rb | ||
| group_labels_finder.rb | ||
| group_members_finder.rb | ||
| group_projects_finder.rb | ||
| groups_finder.rb | ||
| issuable_finder.rb | ||
| issues_finder.rb | ||
| joined_groups_finder.rb | ||
| labels_finder.rb | ||
| license_template_finder.rb | ||
| members_finder.rb | ||
| merge_request_target_project_finder.rb | ||
| merge_requests_finder.rb | ||
| milestones_finder.rb | ||
| notes_finder.rb | ||
| pending_todos_finder.rb | ||
| personal_access_tokens_finder.rb | ||
| personal_projects_finder.rb | ||
| pipeline_schedules_finder.rb | ||
| pipelines_finder.rb | ||
| projects_finder.rb | ||
| README.md | ||
| runner_jobs_finder.rb | ||
| snippets_finder.rb | ||
| tags_finder.rb | ||
| template_finder.rb | ||
| todos_finder.rb | ||
| union_finder.rb | ||
| user_finder.rb | ||
| user_recent_events_finder.rb | ||
| users_finder.rb | ||
| users_with_pending_todos_finder.rb | ||
Finders
This type of classes responsible for collection items based on different conditions. To prevent lookup methods in models like this:
class Project
def issues_for_user_filtered_by(user, filter)
# A lot of logic not related to project model itself
end
end
issues = project.issues_for_user_filtered_by(user, params)
Better use this:
issues = IssuesFinder.new(project, user, filter).execute
It will help keep models thiner.