Merge branch 'add-rubocop-return-nil-style' into 'master'

Adds Rubocop ReturnNil cop

Closes #57454

See merge request gitlab-org/gitlab-ce!25034

.rubocop.yml

@@ -181,3 +181,6 @@ Cop/InjectEnterpriseEditionModule:
   Exclude:
     - 'spec/**/*'
     - 'ee/spec/**/*'
+
+Style/ReturnNil:
+  Enabled: true

app/controllers/concerns/continue_params.rb

@@ -6,7 +6,7 @@ module ContinueParams
 
   def continue_params
     continue_params = params[:continue]
-    return nil unless continue_params
+    return unless continue_params
 
     continue_params = continue_params.permit(:to, :notice, :notice_now)
     continue_params[:to] = safe_redirect_path(continue_params[:to])

app/controllers/concerns/renders_notes.rb

@@ -16,7 +16,7 @@ def prepare_notes_for_rendering(notes, noteable = nil)
   private
 
   def preload_max_access_for_authors(notes, project)
-    return nil unless project
+    return unless project
 
     user_ids = notes.map(&:author_id)
     project.team.max_member_access_for_user_ids(user_ids)

app/controllers/projects/application_controller.rb

@@ -17,7 +17,7 @@ class Projects::ApplicationController < ApplicationController
 
   def project
     return @project if @project
-    return nil unless params[:project_id] || params[:id]
+    return unless params[:project_id] || params[:id]
 
     path = File.join(params[:namespace_id], params[:project_id] || params[:id])
     auth_proc = ->(project) { !project.pending_delete? }

app/controllers/projects/merge_requests/diffs_controller.rb

@@ -46,8 +46,8 @@ def define_diff_vars
 
   # rubocop: disable CodeReuse/ActiveRecord
   def commit
-    return nil unless commit_id = params[:commit_id].presence
-    return nil unless @merge_request.all_commits.exists?(sha: commit_id)
+    return unless commit_id = params[:commit_id].presence
+    return unless @merge_request.all_commits.exists?(sha: commit_id)
 
     @commit ||= @project.commit(commit_id)
   end

app/controllers/uploads_controller.rb

@@ -28,13 +28,13 @@ def uploader_class
   end
 
   def find_model
-    return nil unless params[:id]
+    return unless params[:id]
 
     upload_model_class.find(params[:id])
   end
 
   def authorize_access!
-    return nil unless model
+    return unless model
 
     authorized =
       case model
@@ -54,7 +54,7 @@ def authorize_access!
   end
 
   def authorize_create_access!
-    return nil unless model
+    return unless model
 
     # for now we support only personal snippets comments
     authorized = can?(current_user, :comment_personal_snippet, model)

app/helpers/markup_helper.rb

@@ -74,7 +74,7 @@ def link_to_html(redacted, url, html_options = {})
   # the tag contents are truncated without removing the closing tag.
   def first_line_in_markdown(object, attribute, max_chars = nil, options = {})
     md = markdown_field(object, attribute, options)
-    return nil unless md.present?
+    return unless md.present?
 
     tags = %w(a gl-emoji b pre code p span)
     tags << 'img' if options[:allow_images]

app/helpers/merge_requests_helper.rb

@@ -29,7 +29,7 @@ def mr_css_classes(mr)
 
   def ci_build_details_path(merge_request)
     build_url = merge_request.source_project.ci_service.build_page(merge_request.diff_head_sha, merge_request.source_branch)
-    return nil unless build_url
+    return unless build_url
 
     parsed_url = URI.parse(build_url)
 
@@ -92,7 +92,7 @@ def merge_request_version_path(project, merge_request, merge_request_diff, start
   end
 
   def version_index(merge_request_diff)
-    return nil if @merge_request_diffs.empty?
+    return if @merge_request_diffs.empty?
 
     @merge_request_diffs.size - @merge_request_diffs.index(merge_request_diff)
   end
@@ -149,7 +149,7 @@ def allow_collaboration_unavailable_reason(merge_request)
 
   def merge_request_source_project_for_project(project = @project)
     unless can?(current_user, :create_merge_request_in, project)
-      return nil
+      return
     end
 
     if can?(current_user, :create_merge_request_from, project)

app/helpers/notes_helper.rb

@@ -122,7 +122,7 @@ def form_resources
   end
 
   def new_form_url
-    return nil unless @snippet.is_a?(PersonalSnippet)
+    return unless @snippet.is_a?(PersonalSnippet)
 
     snippet_notes_path(@snippet)
   end

app/models/ci/build.rb

@@ -735,7 +735,7 @@ def collect_test_reports!(test_reports)
 
     # Virtual deployment status depending on the environment status.
     def deployment_status
-      return nil unless starts_environment?
+      return unless starts_environment?
 
       if success?
         return successful_deployment_status

app/models/commit_range.rb

@@ -134,25 +134,25 @@ def persisted?
   end
 
   def sha_from
-    return nil unless @commit_from
+    return unless @commit_from
 
     @commit_from.id
   end
 
   def sha_to
-    return nil unless @commit_to
+    return unless @commit_to
 
     @commit_to.id
   end
 
   def sha_start
-    return nil unless sha_from
+    return unless sha_from
 
     exclude_start? ? sha_from + '^' : sha_from
   end
 
   def commit_start
-    return nil unless sha_start
+    return unless sha_start
 
     if exclude_start?
       @commit_start ||= project.commit(sha_start)

app/models/concerns/blob_language_from_git_attributes.rb

@@ -5,7 +5,7 @@ module BlobLanguageFromGitAttributes
   extend ActiveSupport::Concern
 
   def language_from_gitattributes
-    return nil unless project
+    return unless project
 
     repository = project.repository
     repository.gitattribute(path, 'gitlab-language')

app/models/concerns/feature_gate.rb

@@ -2,7 +2,7 @@
 
 module FeatureGate
   def flipper_id
-    return nil if new_record?
+    return if new_record?
 
     "#{self.class.name}:#{id}"
   end

app/models/concerns/mirror_authentication.rb

@@ -79,7 +79,7 @@ def auth_method
   end
 
   def ssh_public_key
-    return nil if ssh_private_key.blank?
+    return if ssh_private_key.blank?
 
     comment = "git@#{::Gitlab.config.gitlab.host}"
     ::SSHKey.new(ssh_private_key, comment: comment).ssh_public_key

app/models/concerns/reactive_caching.rb

@@ -69,7 +69,7 @@ def reactive_cache_updated(*args)
     def with_reactive_cache(*args, &blk)
       unless within_reactive_cache_lifetime?(*args)
         refresh_reactive_cache!(*args)
-        return nil
+        return
       end
 
       keep_alive_reactive_cache!(*args)

app/models/environment.rb

@@ -119,7 +119,7 @@ def update_merge_request_metrics?
   def first_deployment_for(commit_sha)
     ref = project.repository.ref_name_for_sha(ref_path, commit_sha)
 
-    return nil unless ref
+    return unless ref
 
     deployment_iid = ref.split('/').last
     deployments.find_by(iid: deployment_iid)
@@ -130,7 +130,7 @@ def ref_path
   end
 
   def formatted_external_url
-    return nil unless external_url
+    return unless external_url
 
     external_url.gsub(%r{\A.*?://}, '')
   end

app/models/label_note.rb

@@ -81,7 +81,7 @@ def labels_str(prefix, label_refs)
     deleted = label_refs.count - existing_refs.count
     deleted_str = deleted == 0 ? nil : "#{deleted} deleted"
 
-    return nil unless refs_str || deleted_str
+    return unless refs_str || deleted_str
 
     label_list_str = [refs_str, deleted_str].compact.join(' + ')
     suffix = 'label'.pluralize(deleted > 0 ? deleted : existing_refs.count)

app/models/legacy_diff_note.rb

@@ -73,7 +73,7 @@ def active?(diff_refs = nil)
   private
 
   def find_diff
-    return nil unless noteable
+    return unless noteable
     return @diff if defined?(@diff)
 
     @diff = noteable.raw_diffs(Commit.max_diff_options).find do |d|

app/models/namespace.rb

@@ -149,7 +149,7 @@ def kind
   end
 
   def find_fork_of(project)
-    return nil unless project.fork_network
+    return unless project.fork_network
 
     if Gitlab::SafeRequestStore.active?
       forks_in_namespace = Gitlab::SafeRequestStore.fetch("namespaces:#{id}:forked_projects") do

app/models/notification_recipient.rb

@@ -119,7 +119,7 @@ def excluded_participating_action?
   private
 
   def read_ability
-    return nil if @skip_read_ability
+    return if @skip_read_ability
     return @read_ability if instance_variable_defined?(:@read_ability)
 
     @read_ability =
@@ -136,7 +136,7 @@ def read_ability
   end
 
   def default_project
-    return nil if @target.nil?
+    return if @target.nil?
     return @target if @target.is_a?(Project)
     return @target.project if @target.respond_to?(:project)
   end

app/models/project.rb

@@ -1230,7 +1230,7 @@ def forked?
   end
 
   def fork_source
-    return nil unless forked?
+    return unless forked?
 
     forked_from_project || fork_network&.root_project
   end
@@ -1679,7 +1679,7 @@ def import_export_shared
   end
 
   def export_path
-    return nil unless namespace.present? || hashed_storage?(:repository)
+    return unless namespace.present? || hashed_storage?(:repository)
 
     import_export_shared.archive_path
   end

app/models/project_services/campfire_service.rb

@@ -57,7 +57,7 @@ def auth
   # https://github.com/basecamp/campfire-api/blob/master/sections/messages.md#create-message
   def speak(room_name, message, auth)
     room = rooms(auth).find { |r| r["name"] == room_name }
-    return nil unless room
+    return unless room
 
     path = "/room/#{room["id"]}/speak.json"
     body = {

app/models/project_services/irker_service.rb

@@ -112,7 +112,7 @@ def format_channel(recipient)
   end
 
   def consider_uri(uri)
-    return nil if uri.scheme.nil?
+    return if uri.scheme.nil?
 
     # Authorize both irc://domain.com/#chan and irc://domain.com/chan
     if uri.is_a?(URI) && uri.scheme[/^ircs?\z/] && !uri.path.nil?

app/models/repository.rb

@@ -79,7 +79,7 @@ def hash
   end
 
   def raw_repository
-    return nil unless full_path
+    return unless full_path
 
     @raw_repository ||= initialize_raw_repository
   end
@@ -103,7 +103,7 @@ def inspect
   end
 
   def commit(ref = nil)
-    return nil unless exists?
+    return unless exists?
     return ref if ref.is_a?(::Commit)
 
     find_commit(ref || root_ref)

app/models/ssh_host_key.rb

@@ -27,7 +27,7 @@ def as_json(*)
 
   def self.find_by(opts = {})
     opts = HashWithIndifferentAccess.new(opts)
-    return nil unless opts.key?(:id)
+    return unless opts.key?(:id)
 
     project_id, url = opts[:id].split(':', 2)
     project = Project.find_by(id: project_id)

app/models/user.rb

@@ -470,7 +470,7 @@ def search_with_secondary_emails(query)
     end
 
     def by_login(login)
-      return nil unless login
+      return unless login
 
       if login.include?('@'.freeze)
         unscoped.iwhere(email: login).take

app/models/wiki_page.rb

@@ -132,7 +132,7 @@ def message
 
   # The GitLab Commit instance for this page.
   def version
-    return nil unless persisted?
+    return unless persisted?
 
     @version ||= @page.version
   end

app/serializers/concerns/user_status_tooltip.rb

@@ -11,7 +11,7 @@ module UserStatusTooltip
     expose :user_status_if_loaded, as: :status_tooltip_html
 
     def user_status_if_loaded
-      return nil unless object.association(:status).loaded?
+      return unless object.association(:status).loaded?
 
       user_status(object)
     end

app/services/application_settings/update_service.rb

@@ -38,7 +38,7 @@ def update_terms(terms)
     def performance_bar_allowed_group_id
       performance_bar_enabled = !params.key?(:performance_bar_enabled) || params.delete(:performance_bar_enabled)
       group_full_path = params.delete(:performance_bar_allowed_group_path)
-      return nil unless Gitlab::Utils.to_boolean(performance_bar_enabled)
+      return unless Gitlab::Utils.to_boolean(performance_bar_enabled)
 
       Group.find_by_full_path(group_full_path)&.id if group_full_path.present?
     end

app/services/boards/visits/latest_service.rb

@@ -4,7 +4,7 @@ module Boards
   module Visits
     class LatestService < Boards::BaseService
       def execute
-        return nil unless current_user
+        return unless current_user
 
         recent_visit_model.latest(current_user, parent, count: params[:count])
       end

app/services/groups/nested_create_service.rb

@@ -12,7 +12,7 @@ def initialize(user, params)
     end
 
     def execute
-      return nil unless group_path
+      return unless group_path
 
       if namespace = namespace_or_group(group_path)
         return namespace

app/services/projects/download_service.rb

@@ -11,7 +11,7 @@ def initialize(project, url)
     end
 
     def execute
-      return nil unless valid_url?(@url)
+      return unless valid_url?(@url)
 
       uploader = FileUploader.new(@project)
       uploader.download!(@url)

app/services/push_event_payload_service.rb

@@ -46,7 +46,7 @@ def execute
   def commit_title
     commit = @push_data.fetch(:commits).last
 
-    return nil unless commit && commit[:message]
+    return unless commit && commit[:message]
 
     raw_msg = commit[:message]
 

app/services/upload_service.rb

@@ -6,7 +6,7 @@ def initialize(model, file, uploader_class = FileUploader, **uploader_context)
   end
 
   def execute
-    return nil unless @file && @file.size <= max_attachment_size
+    return unless @file && @file.size <= max_attachment_size
 
     uploader = @uploader_class.new(@model, nil, @uploader_context)
     uploader.store!(@file)

lib/api/helpers/pagination.rb

@@ -149,7 +149,7 @@ def paginate(relation)
         def conditions(pagination)
           fields = pagination.fields
 
-          return nil if fields.empty?
+          return if fields.empty?
 
           placeholder = fields.map { '?' }
 

lib/bitbucket_server/collection.rb

@@ -25,13 +25,13 @@ def current_page
     end
 
     def prev_page
-      return nil unless current_page > 1
+      return unless current_page > 1
 
       current_page - 1
     end
 
     def next_page
-      return nil unless has_next_page?
+      return unless has_next_page?
 
       current_page + 1
     end

lib/declarative_policy/rule.rb

@@ -84,7 +84,7 @@ def pass?(context)
       # returns nil unless it's already cached
       def cached_pass?(context)
         condition = context.condition(@name)
-        return nil unless condition.cached?
+        return unless condition.cached?
 
         condition.pass?
       end
@@ -124,7 +124,7 @@ def score(context)
 
       def cached_pass?(context)
         condition = delegated_context(context).condition(@name)
-        return nil unless condition.cached?
+        return unless condition.cached?
 
         condition.pass?
       rescue MissingDelegate
@@ -161,7 +161,7 @@ def pass?(context)
 
       def cached_pass?(context)
         runner = context.runner(@ability)
-        return nil unless runner.cached?
+        return unless runner.cached?
 
         runner.pass?
       end

lib/gitlab/auth/ldap/config.rb

@@ -195,7 +195,7 @@ def config_for(provider)
 
         def encryption_options
           method = translate_method
-          return nil unless method
+          return unless method
 
           {
             method: method,
@@ -211,7 +211,7 @@ def tls_options
           return @tls_options if defined?(@tls_options)
 
           method = translate_method
-          return nil unless method
+          return unless method
 
           opts = if options['verify_certificates'] && method != 'plain'
                    # Dup so we don't accidentally overwrite the constant

lib/gitlab/auth/ldap/person.rb

@@ -112,7 +112,7 @@ def attribute_value(attribute)
           attributes = Array(config.attributes[attribute.to_s])
           selected_attr = attributes.find { |attr| entry.respond_to?(attr) }
 
-          return nil unless selected_attr
+          return unless selected_attr
 
           entry.public_send(selected_attr) # rubocop:disable GitlabSecurity/PublicSend
         end

lib/gitlab/auth/saml/auth_hash.rb

@@ -10,11 +10,11 @@ def groups
 
         def authn_context
           response_object = auth_hash.extra[:response_object]
-          return nil if response_object.blank?
+          return if response_object.blank?
 
           document = response_object.decrypted_document
           document ||= response_object.document
-          return nil if document.blank?
+          return if document.blank?
 
           extract_authn_context(document)
         end

lib/gitlab/background_migration/migrate_events_to_push_event_payloads.rb

@@ -24,7 +24,7 @@ def push_event?
         def commit_title
           commit = commits.last
 
-          return nil unless commit && commit[:message]
+          return unless commit && commit[:message]
 
           index = commit[:message].index("\n")
           message = index ? commit[:message][0..index] : commit[:message]

lib/gitlab/background_migration/populate_untracked_uploads_dependencies.rb

@@ -127,7 +127,7 @@ def file_uploader_model_id
 
           full_path = matchd[1]
           project = Gitlab::BackgroundMigration::PopulateUntrackedUploadsDependencies::Project.find_by_full_path(full_path)
-          return nil unless project
+          return unless project
 
           project.id
         end

lib/gitlab/bare_repository_import/importer.rb

@@ -108,7 +108,7 @@ def storage_path_for_shard(shard)
       end
 
       def find_or_create_groups
-        return nil unless group_path.present?
+        return unless group_path.present?
 
         log " * Using namespace: #{group_path}"
 

lib/gitlab/bitbucket_import/importer.rb

@@ -47,7 +47,7 @@ def gitlab_user_id(project, username)
 
       # rubocop: disable CodeReuse/ActiveRecord
       def find_user_id(username)
-        return nil unless username
+        return unless username
 
         return users[username] if users.key?(username)
 

lib/gitlab/bitbucket_server_import/importer.rb

@@ -65,7 +65,7 @@ def gitlab_user_id(email)
       end
 
       def find_user_id(email)
-        return nil unless email
+        return unless email
 
         return users[email] if users.key?(email)
 

lib/gitlab/ci/ansi2html.rb

@@ -313,7 +313,7 @@ def set_bg_color(color_index, prefix = nil)
 
         def get_term_color_class(color_index, prefix)
           color_name = COLOR[color_index]
-          return nil if color_name.nil?
+          return if color_name.nil?
 
           get_color_class(["term", prefix, color_name])
         end

lib/gitlab/ci/build/artifacts/metadata.rb

@@ -103,7 +103,7 @@ def read_uint32(gz)
 
           def read_string(gz)
             string_size = read_uint32(gz)
-            return nil unless string_size
+            return unless string_size
 
             gz.read(string_size)