gitlab-org--gitlab-foss/app/finders
Yorick Peterse 8a72f5c427
Added FromUnion to easily select from a UNION
This commit adds the module `FromUnion`, which provides the class method
`from_union`. This simplifies the process of selecting data from the
result of a UNION, and reduces the likelihood of making mistakes. As a
result, instead of this:

    union = Gitlab::SQL::Union.new([foo, bar])

    Foo.from("(#{union.to_sql}) #{Foo.table_name}")

We can now write this instead:

    Foo.from_union([foo, bar])

This commit also includes some changes to make this new setup work
properly. For example, a bug in Rails 4
(https://github.com/rails/rails/issues/24193) would break the use of
`from("sub-query-here").includes(:relation)` in certain cases. There was
also a CI query which appeared to repeat a lot of conditions from an
outer query on an inner query, which isn't necessary.

Finally, we include a RuboCop cop to ensure developers use this new
module, instead of using Gitlab::SQL::Union directly.

Fixes https://gitlab.com/gitlab-org/gitlab-ce/issues/51307
2018-09-17 12:39:43 +02:00
..
admin Cleaned up CI runner administration code 2018-09-14 15:05:46 +02:00
autocomplete Disable existing offenses for the CodeReuse cops 2018-09-11 17:32:00 +02:00
concerns Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
README.md
access_requests_finder.rb Enable frozen string in app/graphql + app/finders 2018-09-11 12:15:23 -07:00
awarded_emoji_finder.rb Refactor AutocompleteController 2018-08-20 13:53:00 +02:00
branches_finder.rb Enable frozen string in app/graphql + app/finders 2018-09-11 12:15:23 -07:00
clusters_finder.rb Enable frozen string in app/graphql + app/finders 2018-09-11 12:15:23 -07:00
contributed_projects_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
environments_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
events_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
fork_projects_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
group_descendants_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
group_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
group_members_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
group_projects_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
groups_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
issuable_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
issues_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
joined_groups_finder.rb Enable frozen string in app/graphql + app/finders 2018-09-11 12:15:23 -07:00
labels_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
license_template_finder.rb Enable frozen string in app/graphql + app/finders 2018-09-11 12:15:23 -07:00
members_finder.rb Added FromUnion to easily select from a UNION 2018-09-17 12:39:43 +02:00
merge_request_target_project_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
merge_requests_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
milestones_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
notes_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
personal_access_tokens_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
personal_projects_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
pipeline_schedules_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
pipelines_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
projects_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
runner_jobs_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
snippets_finder.rb Added FromUnion to easily select from a UNION 2018-09-17 12:39:43 +02:00
tags_finder.rb Enable frozen string in app/graphql + app/finders 2018-09-11 12:15:23 -07:00
template_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
todos_finder.rb Added FromUnion to easily select from a UNION 2018-09-17 12:39:43 +02:00
union_finder.rb Added FromUnion to easily select from a UNION 2018-09-17 12:39:43 +02:00
user_finder.rb Disable existing offenses for the CodeReuse cops 2018-09-11 17:32:00 +02:00
user_recent_events_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00
users_finder.rb Merge branch 'frozen-string-app-finders-graphql' into 'master' 2018-09-13 19:44:31 +00:00

README.md

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.