e71cd7a300
Refactor ability.rb into Policies
## What does this MR do?
Factors out `ability.rb` into a new abstraction - the "policy" (stored in `app/policies`). A policy is a class named `#{class_name}Policy` (looked up automatically as needed) that implements `rules` as follows:
``` ruby
class ThingPolicy < BasePolicy
def rules
@user # this is a user to determine abilities for, optionally nil in the anonymous case
@subject # this is the subject of the ability, guaranteed to be an instance of `Thing`
can! :some_ability # grant the :some_ability permission
cannot! :some_ability # ensure that :some_ability is not allowed. this overrides any `can!` that is called before or after
delegate! @subject.other_thing # merge the abilities (can!) and prohibitions (cannot!) from `@subject.other_thing`
can? :some_ability # test whether, so far, :some_ability is allowed
end
def anonymous_rules
# optional. if not implemented `rules` is called where `@user` is nil. otherwise this method is called when `@user` is nil.
end
end
```
See merge request !5796
|
||
|---|---|---|
| .. | ||
| branches_finder.rb | ||
| contributed_projects_finder.rb | ||
| group_projects_finder.rb | ||
| groups_finder.rb | ||
| issuable_finder.rb | ||
| issues_finder.rb | ||
| joined_groups_finder.rb | ||
| merge_requests_finder.rb | ||
| milestones_finder.rb | ||
| move_to_project_finder.rb | ||
| notes_finder.rb | ||
| personal_projects_finder.rb | ||
| pipelines_finder.rb | ||
| projects_finder.rb | ||
| README.md | ||
| snippets_finder.rb | ||
| tags_finder.rb | ||
| todos_finder.rb | ||
| trending_projects_finder.rb | ||
| union_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.