Enable frozen string for lib/gitlab/*.rb

changelogs/unreleased/frozen-string-enable-lib-gitlab.yml

@@ -0,0 +1,5 @@
+---
+title: Enable frozen string for lib/gitlab/*.rb
+merge_request:
+author: gfyoung
+type: performance

lib/backup/manager.rb

@@ -164,7 +164,7 @@ module Backup
 
     def tar_version
       tar_version, _ = Gitlab::Popen.popen(%w(tar --version))
-      tar_version.force_encoding('locale').split("\n").first
+      tar_version.dup.force_encoding('locale').split("\n").first
     end
 
     def skipped?(item)

lib/gitlab/access.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Gitlab::Access module
 #
 # Define allowed roles that can be used

lib/gitlab/action_rate_limiter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   # This class implements a simple rate limiter that can be used to throttle
   # certain actions. Unlike Rack Attack and Rack::Throttle, which operate at

lib/gitlab/allowable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Allowable
     def can?(*args)

lib/gitlab/app_logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class AppLogger < Gitlab::Logger
     def self.file_name_noext

lib/gitlab/asciidoc.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'asciidoctor'
 require 'asciidoctor/converter/html5'
 require "asciidoctor-plantuml"

lib/gitlab/auth.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Auth
     MissingPersonalAccessTokenError = Class.new(StandardError)

lib/gitlab/background_migration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module BackgroundMigration
     def self.queue

lib/gitlab/base_doorkeeper_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This is a base controller for doorkeeper.
 # It adds the `can?` helper used in the views.
 module Gitlab

lib/gitlab/blame.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class Blame
     attr_accessor :blob, :commit

lib/gitlab/blob_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This has been extracted from https://github.com/github/linguist/blob/master/lib/linguist/blob_helper.rb
 module Gitlab
   module BlobHelper

lib/gitlab/build_access.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class BuildAccess < UserAccess
     attr_accessor :user, :project

lib/gitlab/changes_list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class ChangesList
     include Enumerable

lib/gitlab/chat_name_token.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module Gitlab

lib/gitlab/ci_access.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   # For backwards compatibility, generic CI (which is a build without a user) is
   # allowed to :build_download_code without any other checks.

lib/gitlab/closing_issue_extractor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class ClosingIssueExtractor
     ISSUE_CLOSING_REGEX = begin

lib/gitlab/color_schemes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   # Module containing GitLab's syntax color scheme definitions and helper
   # methods for accessing them.

lib/gitlab/config_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab::ConfigHelper
   def gitlab_config_features
     Gitlab.config.gitlab.default_projects_features

lib/gitlab/contributions_calendar.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class ContributionsCalendar
     attr_reader :contributor

lib/gitlab/contributor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class Contributor
     attr_accessor :email, :name, :commits, :additions, :deletions

lib/gitlab/cross_project_access.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class CrossProjectAccess
     class << self

lib/gitlab/current_settings.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module CurrentSettings
     class << self

lib/gitlab/daemon.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class Daemon
     def self.initialize_instance(*args)

lib/gitlab/database.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Database
     # The max value of INTEGER type is the same between MySQL and PostgreSQL:
@@ -99,11 +101,11 @@ module Gitlab
       order = "#{field} #{direction}"
 
       if postgresql?
-        order << ' NULLS LAST'
+        order = "#{order} NULLS LAST"
       else
         # `field IS NULL` will be `0` for non-NULL columns and `1` for NULL
         # columns. In the (default) ascending order, `0` comes first.
-        order.prepend("#{field} IS NULL, ") if direction == 'ASC'
+        order = "#{field} IS NULL, #{order}" if direction == 'ASC'
       end
 
       order
@@ -113,11 +115,11 @@ module Gitlab
       order = "#{field} #{direction}"
 
       if postgresql?
-        order << ' NULLS FIRST'
+        order = "#{order} NULLS FIRST"
       else
         # `field IS NULL` will be `0` for non-NULL columns and `1` for NULL
         # columns. In the (default) ascending order, `0` comes first.
-        order.prepend("#{field} IS NULL, ") if direction == 'DESC'
+        order = "#{field} IS NULL, #{order}" if direction == 'DESC'
       end
 
       order
@@ -184,7 +186,7 @@ module Gitlab
       EOF
 
       if return_ids
-        sql << 'RETURNING id'
+        sql = "#{sql}RETURNING id"
       end
 
       result = connection.execute(sql)

lib/gitlab/dependency_linker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module DependencyLinker
     LINKERS = [

lib/gitlab/downtime_check.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   # Checks if a set of migrations requires downtime or not.
   class DowntimeCheck

lib/gitlab/ee_compat_check.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # rubocop: disable Rails/Output
 module Gitlab
   # Checks if a set of migrations requires downtime or not.

lib/gitlab/emoji.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Emoji
     extend self

lib/gitlab/encoding_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module EncodingHelper
     extend self

lib/gitlab/environment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Environment
     def self.hostname

lib/gitlab/environment_logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class EnvironmentLogger < Gitlab::Logger
     def self.file_name_noext

lib/gitlab/exclusive_lease.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'securerandom'
 
 module Gitlab

lib/gitlab/exclusive_lease_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   # This module provides helper methods which are intregrated with GitLab::ExclusiveLease
   module ExclusiveLeaseHelpers

lib/gitlab/fake_application_settings.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This class extends an OpenStruct object by adding predicate methods to mimic
 # ActiveRecord access. We rely on the initial values being true or false to
 # determine whether to define a predicate method because for a newly-added

lib/gitlab/favicon.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class Favicon
     class << self

lib/gitlab/file_detector.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module Gitlab

lib/gitlab/file_finder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This class finds files in a repository by name and content
 # the result is joined and sorted by file name
 module Gitlab

lib/gitlab/file_markdown_link_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Builds the markdown link of a file
 # It needs the methods filename and secure_url (final destination url) to be defined.
 module Gitlab
@@ -8,7 +10,7 @@ module Gitlab
       return unless name = markdown_name
 
       markdown = "[#{name.gsub(']', '\\]')}](#{secure_url})"
-      markdown.prepend("!") if image_or_video? || dangerous?
+      markdown = "!#{markdown}" if image_or_video? || dangerous?
       markdown
     end
 

lib/gitlab/git.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_dependency 'gitlab/encoding_helper'
 
 module Gitlab

lib/gitlab/git_access.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Check a user's access to perform a git action. All public methods in this
 # class return an instance of `GitlabAccessStatus`
 module Gitlab

lib/gitlab/git_access_wiki.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class GitAccessWiki < GitAccess
     ERROR_MESSAGES = {

lib/gitlab/git_logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class GitLogger < Gitlab::Logger
     def self.file_name_noext

lib/gitlab/git_ref_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Gitaly note: JV: does not need to be migrated, works without a repo.
 
 module Gitlab

lib/gitlab/gitaly_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'base64'
 
 require 'gitaly'
@@ -23,7 +25,7 @@ module Gitlab
         stacks = most_invoked_stack.join('\n') if most_invoked_stack
 
         msg = "GitalyClient##{call_site} called #{invocation_count} times from single request. Potential n+1?"
-        msg << "\nThe following call site called into Gitaly #{max_call_stack} times:\n#{stacks}\n" if stacks
+        msg = "#{msg}\nThe following call site called into Gitaly #{max_call_stack} times:\n#{stacks}\n" if stacks
 
         super(msg)
       end

lib/gitlab/github_import.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module GithubImport
     def self.refmap

lib/gitlab/gl_id.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module GlId
     def self.gl_id(user)

lib/gitlab/gl_repository.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module GlRepository
     def self.gl_repository(project, is_wiki)

lib/gitlab/gon_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # rubocop:disable Metrics/AbcSize
 
 module Gitlab

lib/gitlab/gpg.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Gpg
     extend self

lib/gitlab/graphql.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Graphql
     StandardGraphqlError = Class.new(StandardError)

lib/gitlab/group_hierarchy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   # Retrieving of parent or child groups based on a base ActiveRecord relation.
   #

lib/gitlab/highlight.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class Highlight
     TIMEOUT_BACKGROUND = 30.seconds

lib/gitlab/http.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This class is used as a proxy for all outbounding http connection
 # coming from callbacks, services and hooks. The direct use of the HTTParty
 # is discouraged because it can lead to several security problems, like SSRF

lib/gitlab/http_io.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ##
 # This class is compatible with IO class (https://ruby-doc.org/core-2.3.1/IO.html)
 # source: https://gitlab.com/snippets/1685610
@@ -73,8 +75,8 @@ module Gitlab
       end
     end
 
-    def read(length = nil, outbuf = "")
-      out = ""
+    def read(length = nil, outbuf = nil)
+      out = []
 
       length ||= size - tell
 
@@ -90,17 +92,18 @@ module Gitlab
         length -= chunk_data.bytesize
       end
 
+      out = out.join
+
       # If outbuf is passed, we put the output into the buffer. This supports IO.copy_stream functionality
       if outbuf
-        outbuf.slice!(0, outbuf.bytesize)
-        outbuf << out
+        outbuf.replace(out)
       end
 
       out
     end
 
     def readline
-      out = ""
+      out = []
 
       until eof?
         data = get_chunk
@@ -116,7 +119,7 @@ module Gitlab
         end
       end
 
-      out
+      out.join
     end
 
     def write(data)

lib/gitlab/i18n.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module I18n
     extend self

lib/gitlab/identifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Detect user based on identifier like
 # key-13 or user-36 or last commit
 module Gitlab

lib/gitlab/import_export.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module ImportExport
     extend self

lib/gitlab/import_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class ImportFormatter
     def comment(author, date, body)

lib/gitlab/import_sources.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Gitlab::ImportSources module
 #
 # Define import sources that can be used

lib/gitlab/incoming_email.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module IncomingEmail
     UNSUBSCRIBE_SUFFIX = '+unsubscribe'.freeze

lib/gitlab/insecure_key_fingerprint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   #
   # Calculates the fingerprint of a given key without using

lib/gitlab/issuable_metadata.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module IssuableMetadata
     def issuable_meta_data(issuable_collection, collection_type)

lib/gitlab/issuable_sorter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module IssuableSorter
     class << self

lib/gitlab/issuables_count_for_state.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   # Class for counting and caching the number of issuables per state.
   class IssuablesCountForState

lib/gitlab/issues_labels.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class IssuesLabels
     class << self

lib/gitlab/job_waiter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   # JobWaiter can be used to wait for a number of Sidekiq jobs to complete.
   #

lib/gitlab/json_logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class JsonLogger < ::Gitlab::Logger
     def self.file_name_noext

lib/gitlab/kubernetes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   # Helper methods to do with Kubernetes network services & resources
   module Kubernetes

lib/gitlab/language_detection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class LanguageDetection
     MAX_LANGUAGES = 5

lib/gitlab/lazy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   # A class that can be wrapped around an expensive method call so it's only
   # executed when actually needed.

lib/gitlab/lfs_token.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class LfsToken
     attr_accessor :actor

lib/gitlab/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class Logger < ::Logger
     def self.file_name

lib/gitlab/mail_room.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'json'
 require_relative 'redis/queues' unless defined?(Gitlab::Redis::Queues)

lib/gitlab/markup_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module MarkupHelper
     extend self

lib/gitlab/metrics.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Metrics
     include Gitlab::Metrics::InfluxDb

lib/gitlab/multi_collection_paginator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class MultiCollectionPaginator
     attr_reader :first_collection, :second_collection, :per_page

lib/gitlab/omniauth_initializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class OmniauthInitializer
     def initialize(devise_config)

lib/gitlab/optimistic_locking.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module OptimisticLocking
     module_function

lib/gitlab/other_markup.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   # Parser/renderer for markups without other special support code.
   module OtherMarkup

lib/gitlab/otp_key_rotator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   # The +otp_key_base+ param is used to encrypt the User#otp_secret attribute.
   #

lib/gitlab/pages.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Pages
     VERSION = File.read(Rails.root.join("GITLAB_PAGES_VERSION")).strip.freeze

lib/gitlab/pages_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class PagesClient
     class << self

lib/gitlab/pages_transfer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class PagesTransfer < ProjectTransfer
     def root_dir

lib/gitlab/path_regex.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module PathRegex
     extend self

lib/gitlab/performance_bar.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module PerformanceBar
     ALLOWED_USER_IDS_KEY = 'performance_bar_allowed_user_ids:v2'.freeze

lib/gitlab/plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Plugin
     def self.files

lib/gitlab/plugin_logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class PluginLogger < Gitlab::Logger
     def self.file_name_noext

lib/gitlab/polling_interval.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class PollingInterval
     HEADER_NAME = 'Poll-Interval'.freeze

lib/gitlab/popen.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'open3'
 
@@ -11,7 +13,7 @@ module Gitlab
     def popen(cmd, path = nil, vars = {}, &block)
       result = popen_with_detail(cmd, path, vars, &block)
 
-      [result.stdout << result.stderr, result.status&.exitstatus]
+      ["#{result.stdout}#{result.stderr}", result.status&.exitstatus]
     end
 
     # Returns Result

lib/gitlab/profiler.rb

@@ -1,4 +1,6 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 module Gitlab
   module Profiler
     FILTERED_STRING = '[FILTERED]'.freeze

lib/gitlab/project_search_results.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class ProjectSearchResults < SearchResults
     attr_reader :project, :repository_ref
@@ -57,7 +59,8 @@ module Gitlab
       ref = nil
       filename = nil
       basename = nil
-      data = ""
+
+      data = []
       startline = 0
 
       result.each_line.each_with_index do |line, index|
@@ -78,7 +81,7 @@ module Gitlab
         basename: basename,
         ref: ref,
         startline: startline,
-        data: data,
+        data: data.join,
         project_id: project ? project.id : nil
       )
     end

lib/gitlab/project_service_logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class ProjectServiceLogger < Gitlab::JsonLogger
     def self.file_name_noext

lib/gitlab/project_template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   class ProjectTemplate
     attr_reader :title, :name, :description, :preview

lib/gitlab/project_transfer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   # This class is used to move local, unhashed files owned by projects to their new location
   class ProjectTransfer

lib/gitlab/prometheus_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   # Helper methods to interact with Prometheus network services & resources
   class PrometheusClient

lib/gitlab/protocol_access.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module ProtocolAccess
     def self.allowed?(protocol)

lib/gitlab/proxy_http_connection_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This class is part of the Gitlab::HTTP wrapper. Depending on the value
 # of the global setting allow_local_requests_from_hooks_and_services this adapter
 # will allow/block connection to internal IPs and/or urls.

lib/gitlab/query_limiting.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module QueryLimiting
     # Returns true if we should enable tracking of query counts.

lib/gitlab/recaptcha.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module Recaptcha
     def self.load_configurations!