debian-mirror-gitlab/rubocop/cop/scalability/file_uploads.rb
2023-04-23 21:23:45 +05:30

52 lines
1.3 KiB
Ruby

# frozen_string_literal: true
module RuboCop
module Cop
module Scalability
# This cop checks for `File` params in API
#
# @example
#
# # bad
# params do
# requires :file, type: File
# end
#
# params do
# optional :file, type: File
# end
#
# # good
# params do
# requires :file, type: ::API::Validations::Types::WorkhorseFile
# end
#
# params do
# optional :file, type: ::API::Validations::Types::WorkhorseFile
# end
#
class FileUploads < RuboCop::Cop::Base
MSG = 'Do not upload files without workhorse acceleration. ' \
'Please refer to https://docs.gitlab.com/ee/development/uploads.html'
def_node_matcher :file_in_type, <<~PATTERN
(send nil? {:requires :optional}
(sym _)
(hash
{
<(pair (sym :types) (array <$(const nil? :File) ...>)) ...>
<(pair (sym :type) $(const nil? :File)) ...>
}
)
)
PATTERN
def on_send(node)
file_in_type(node) do |file_node|
add_offense(file_node)
end
end
end
end
end
end