8a72f5c427
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
27 lines
721 B
Ruby
27 lines
721 B
Ruby
# frozen_string_literal: true
|
|
require_relative '../../spec_helpers'
|
|
|
|
module RuboCop
|
|
module Cop
|
|
module Gitlab
|
|
# Cop that disallows the use of `Gitlab::SQL::Union`, in favour of using
|
|
# the `FromUnion` module.
|
|
class Union < RuboCop::Cop::Cop
|
|
include SpecHelpers
|
|
|
|
MSG = 'Use the `FromUnion` concern, instead of using `Gitlab::SQL::Union` directly'
|
|
|
|
def_node_matcher :raw_union?, <<~PATTERN
|
|
(send (const (const (const nil? :Gitlab) :SQL) :Union) :new ...)
|
|
PATTERN
|
|
|
|
def on_send(node)
|
|
return unless raw_union?(node)
|
|
return if in_spec?(node)
|
|
|
|
add_offense(node, location: :expression)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|