Use gitlab-styles

Signed-off-by: Rémy Coutable <remy@rymai.me>

.codeclimate.yml

@@ -16,6 +16,7 @@ engines:
     enabled: true
   rubocop:
     enabled: true
+    channel: "gitlab-rubocop-0-52"
 ratings:
   paths:
   - Gemfile.lock

.gitlab-ci.yml

@@ -594,7 +594,7 @@ codequality:
   script:
     - cp .rubocop.yml .rubocop.yml.bak
     - grep -v "rubocop-gitlab-security" .rubocop.yml.bak > .rubocop.yml
-    - docker run --env CODECLIMATE_CODE="$PWD" --volume "$PWD":/code --volume /var/run/docker.sock:/var/run/docker.sock --volume /tmp/cc:/tmp/cc codeclimate/codeclimate analyze -f json > raw_codeclimate.json
+    - docker run --env CODECLIMATE_CODE="$PWD" --volume "$PWD":/code --volume /var/run/docker.sock:/var/run/docker.sock --volume /tmp/cc:/tmp/cc dev.gitlab.org:5005/gitlab/gitlab-build-images:gitlab-codeclimate-v2 analyze -f json > raw_codeclimate.json
     - cat raw_codeclimate.json | docker run -i stedolan/jq -c 'map({check_name,fingerprint,location})' > codeclimate.json
     - mv .rubocop.yml.bak .rubocop.yml
   artifacts:

Gemfile

@@ -334,9 +334,11 @@ group :development, :test do
   gem 'spring-commands-rspec', '~> 1.0.4'
   gem 'spring-commands-spinach', '~> 1.1.0'
-  gem 'rubocop', '~> 0.49.1', require: false
-  gem 'rubocop-rspec', '~> 1.15.1', require: false
-  gem 'rubocop-gitlab-security', '~> 0.1.0', require: false
+  gem 'gitlab-styles', '~> 2.2.0', require: false
+  # Pin these dependencies, otherwise a new rule could break the CI pipelines
+  gem 'rubocop', '~> 0.52.0'
+  gem 'rubocop-rspec', '~> 1.20.1'
+
   gem 'scss_lint', '~> 0.54.0', require: false
   gem 'haml_lint', '~> 0.26.0', require: false
   gem 'simplecov', '~> 0.14.0', require: false

Gemfile.lock

@@ -303,6 +303,10 @@ GEM
       mime-types (>= 1.16)
       posix-spawn (~> 0.3)
     gitlab-markup (1.6.3)
+    gitlab-styles (2.2.0)
+      rubocop (~> 0.51)
+      rubocop-gitlab-security (~> 0.1.0)
+      rubocop-rspec (~> 1.19)
     gitlab_omniauth-ldap (2.0.4)
       net-ldap (~> 0.16)
       omniauth (~> 1.3)
@@ -777,21 +781,21 @@ GEM
       pg
       rails
       sqlite3
-    rubocop (0.49.1)
+    rubocop (0.52.0)
       parallel (~> 1.10)
-      parser (>= 2.3.3.1, < 3.0)
+      parser (>= 2.4.0.2, < 3.0)
       powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
+      rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    rubocop-gitlab-security (0.1.0)
-      rubocop (>= 0.47.1)
-    rubocop-rspec (1.15.1)
-      rubocop (>= 0.42.0)
+    rubocop-gitlab-security (0.1.1)
+      rubocop (>= 0.51)
+    rubocop-rspec (1.20.1)
+      rubocop (>= 0.51.0)
     ruby-fogbugz (0.2.1)
       crack (~> 0.4)
     ruby-prof (0.16.2)
-    ruby-progressbar (1.8.1)
+    ruby-progressbar (1.9.0)
     ruby-saml (1.4.1)
       nokogiri (>= 1.5.10)
     ruby_parser (3.9.0)
@@ -1046,6 +1050,7 @@ DEPENDENCIES
   github-linguist (~> 4.7.0)
   gitlab-flowdock-git-hook (~> 1.0.1)
   gitlab-markup (~> 1.6.2)
+  gitlab-styles (~> 2.2.0)
   gitlab_omniauth-ldap (~> 2.0.4)
   gollum-lib (~> 4.2)
   gollum-rugged_adapter (~> 0.4.4)
@@ -1148,9 +1153,8 @@ DEPENDENCIES
   rspec-retry (~> 0.4.5)
   rspec-set (~> 0.1.3)
   rspec_profiling (~> 0.0.5)
-  rubocop (~> 0.49.1)
-  rubocop-gitlab-security (~> 0.1.0)
-  rubocop-rspec (~> 1.15.1)
+  rubocop (~> 0.52.0)
+  rubocop-rspec (~> 1.20.1)
   ruby-fogbugz (~> 0.2.1)
   ruby-prof (~> 0.16.2)
   ruby_parser (~> 3.8)

config/initializers/peek.rb

@@ -18,7 +18,7 @@ Peek.into Peek::Views::Rblineprof
 Peek.into Peek::Views::GC
 Peek.into Peek::Views::Gitaly
-# rubocop:disable Style/ClassAndModuleCamelCase
+# rubocop:disable Naming/ClassAndModuleCamelCase
 class PEEK_DB_CLIENT
   class << self
     attr_accessor :query_details

lib/gitlab/ci/config/entry/node.rb

@@ -93,9 +93,7 @@ module Gitlab
           private
-          def entries
-            @entries
-          end
+          attr_reader :entries
         end
       end
     end

lib/gitlab/git/repository.rb

@@ -56,11 +56,12 @@ module Gitlab
           # Do nothing if hooks already exist
           unless real_local_hooks_path == File.realpath(global_hooks_path)
-            # Move the existing hooks somewhere safe
-            FileUtils.mv(
-              local_hooks_path,
-              "#{local_hooks_path}.old.#{Time.now.to_i}"
-            ) if File.exist?(local_hooks_path)
+            if File.exist?(local_hooks_path)
+              # Move the existing hooks somewhere safe
+              FileUtils.mv(
+                local_hooks_path,
+                "#{local_hooks_path}.old.#{Time.now.to_i}")
+            end
             # Create the hooks symlink
             FileUtils.ln_sf(global_hooks_path, local_hooks_path)

rubocop/cop/active_record_dependent.rb

-require_relative '../model_helpers'
-
-module RuboCop
-  module Cop
-    # Cop that prevents the use of `dependent: ...` in ActiveRecord models.
-    class ActiveRecordDependent < RuboCop::Cop::Cop
-      include ModelHelpers
-
-      MSG = 'Do not use `dependent: to remove associated data, ' \
-        'use foreign keys with cascading deletes instead'.freeze
-
-      METHOD_NAMES = [:has_many, :has_one, :belongs_to].freeze
-
-      def on_send(node)
-        return unless in_model?(node)
-        return unless METHOD_NAMES.include?(node.children[1])
-
-        node.children.last.each_node(:pair) do |pair|
-          key_name = pair.children[0].children[0]
-
-          add_offense(pair, :expression) if key_name == :dependent
-        end
-      end
-    end
-  end
-end

rubocop/cop/active_record_serialize.rb

-require_relative '../model_helpers'
-
-module RuboCop
-  module Cop
-    # Cop that prevents the use of `serialize` in ActiveRecord models.
-    class ActiveRecordSerialize < RuboCop::Cop::Cop
-      include ModelHelpers
-
-      MSG = 'Do not store serialized data in the database, use separate columns and/or tables instead'.freeze
-
-      def on_send(node)
-        return unless in_model?(node)
-
-        add_offense(node, :selector) if node.children[1] == :serialize
-      end
-    end
-  end
-end

rubocop/cop/custom_error_class.rb

-module RuboCop
-  module Cop
-    # This cop makes sure that custom error classes, when empty, are declared
-    # with Class.new.
-    #
-    # @example
-    #   # bad
-    #   class FooError < StandardError
-    #   end
-    #
-    #   # okish
-    #   class FooError < StandardError; end
-    #
-    #   # good
-    #   FooError = Class.new(StandardError)
-    class CustomErrorClass < RuboCop::Cop::Cop
-      MSG = 'Use `Class.new(SuperClass)` to define an empty custom error class.'.freeze
-
-      def on_class(node)
-        _klass, parent, body = node.children
-
-        return if body
-
-        parent_klass = class_name_from_node(parent)
-
-        return unless parent_klass && parent_klass.to_s.end_with?('Error')
-
-        add_offense(node, :expression)
-      end
-
-      def autocorrect(node)
-        klass, parent, _body = node.children
-        replacement = "#{class_name_from_node(klass)} = Class.new(#{class_name_from_node(parent)})"
-
-        lambda do |corrector|
-          corrector.replace(node.source_range, replacement)
-        end
-      end
-
-      private
-
-      # The nested constant `Foo::Bar::Baz` looks like:
-      #
-      #   s(:const,
-      #     s(:const,
-      #       s(:const, nil, :Foo), :Bar), :Baz)
-      #
-      # So recurse through that to get the name as written in the source.
-      #
-      def class_name_from_node(node, suffix = nil)
-        return unless node&.type == :const
-
-        name = node.children[1].to_s
-        name = "#{name}::#{suffix}" if suffix
-
-        if node.children[0]
-          class_name_from_node(node.children[0], name)
-        else
-          name
-        end
-      end
-    end
-  end
-end

rubocop/cop/gem_fetcher.rb

-module RuboCop
-  module Cop
-    # This cop prevents usage of the `git` and `github` arguments to `gem` in a
-    # `Gemfile` in order to avoid additional points of failure beyond
-    # rubygems.org.
-    class GemFetcher < RuboCop::Cop::Cop
-      MSG = 'Do not use gems from git repositories, only use gems from RubyGems.'.freeze
-
-      GIT_KEYS = [:git, :github].freeze
-
-      def on_send(node)
-        return unless gemfile?(node)
-
-        func_name = node.children[1]
-        return unless func_name == :gem
-
-        node.children.last.each_node(:pair) do |pair|
-          key_name = pair.children[0].children[0].to_sym
-          if GIT_KEYS.include?(key_name)
-            add_offense(node, pair.source_range, MSG)
-          end
-        end
-      end
-
-      private
-
-      def gemfile?(node)
-        node
-          .location
-          .expression
-          .source_buffer
-          .name
-          .end_with?("Gemfile")
-      end
-    end
-  end
-end

rubocop/cop/gitlab/module_with_instance_variables.rb

@@ -30,12 +30,12 @@ module RuboCop
             if only_ivar_or_assignment?(definition)
               # We don't allow if any other ivar is used
               definition.each_descendant(:ivar) do |offense|
-                add_offense(offense, :expression)
+                add_offense(offense, location: :expression)
               end
             # We allow initialize method and single ivar
             elsif !initialize_method?(definition) && !single_ivar?(definition)
               definition.each_descendant(:ivar, :ivasgn) do |offense|
-                add_offense(offense, :expression)
+                add_offense(offense, location: :expression)
               end
             end
           end

rubocop/cop/in_batches.rb

-require_relative '../model_helpers'
-
-module RuboCop
-  module Cop
-    # Cop that prevents the use of `in_batches`
-    class InBatches < RuboCop::Cop::Cop
-      MSG = 'Do not use `in_batches`, use `each_batch` from the EachBatch module instead'.freeze
-
-      def on_send(node)
-        return unless node.children[1] == :in_batches
-
-        add_offense(node, :selector)
-      end
-    end
-  end
-end

rubocop/cop/include_sidekiq_worker.rb

@@ -9,14 +9,14 @@ module RuboCop
       MSG = 'Include `ApplicationWorker`, not `Sidekiq::Worker`.'.freeze
       def_node_matcher :includes_sidekiq_worker?, <<~PATTERN
-        (send nil :include (const (const nil :Sidekiq) :Worker))
+        (send nil? :include (const (const nil? :Sidekiq) :Worker))
       PATTERN
       def on_send(node)
         return if in_spec?(node)
         return unless includes_sidekiq_worker?(node)
-        add_offense(node.arguments.first, :expression)
+        add_offense(node.arguments.first, location: :expression)
       end
       def autocorrect(node)

rubocop/cop/line_break_after_guard_clauses.rb

-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    # Ensures a line break after guard clauses.
-    #
-    # @example
-    #   # bad
-    #   return unless condition
-    #   do_stuff
-    #
-    #   # good
-    #   return unless condition
-    #
-    #   do_stuff
-    #
-    #   # bad
-    #   raise if condition
-    #   do_stuff
-    #
-    #   # good
-    #   raise if condition
-    #
-    #   do_stuff
-    #
-    #   Multiple guard clauses are allowed without
-    #   line break.
-    #
-    #   # good
-    #   return unless condition_a
-    #   return unless condition_b
-    #
-    #   do_stuff
-    #
-    #   Guard clauses in case statement are allowed without
-    #   line break.
-    #
-    #   # good
-    #   case model
-    #     when condition_a
-    #       return true unless condition_b
-    #     when
-    #       ...
-    #   end
-    #
-    #   Guard clauses before end are allowed without
-    #   line break.
-    #
-    #   # good
-    #   if condition_a
-    #     do_something
-    #   else
-    #     do_something_else
-    #     return unless condition
-    #   end
-    #
-    #   do_something_more
-    class LineBreakAfterGuardClauses < RuboCop::Cop::Cop
-      MSG = 'Add a line break after guard clauses'
-
-      def_node_matcher :guard_clause_node?, <<-PATTERN
-        [{(send nil? {:raise :fail :throw} ...) return break next} single_line?]
-      PATTERN
-
-      def on_if(node)
-        return unless node.single_line?
-        return unless guard_clause?(node)
-        return if next_line(node).blank? || clause_last_line?(next_line(node)) || guard_clause?(next_sibling(node))
-
-        add_offense(node, :expression, MSG)
-      end
-
-      def autocorrect(node)
-        lambda do |corrector|
-          corrector.insert_after(node.loc.expression, "\n")
-        end
-      end
-
-      private
-
-      def guard_clause?(node)
-        return false unless node.if_type?
-
-        guard_clause_node?(node.if_branch)
-      end
-
-      def next_sibling(node)
-        node.parent.children[node.sibling_index + 1]
-      end
-
-      def next_line(node)
-        processed_source[node.loc.line]
-      end
-
-      def clause_last_line?(line)
-        line =~ /^\s*(?:end|elsif|else|when|rescue|ensure)/
-      end
-    end
-  end
-end

rubocop/cop/migration/add_column.rb

@@ -29,7 +29,7 @@ module RuboCop
           opts.each_node(:pair) do |pair|
             if hash_key_type(pair) == :sym && hash_key_name(pair) == :default
-              add_offense(node, :selector)
+              add_offense(node, location: :selector)
             end
           end
         end

rubocop/cop/migration/add_concurrent_foreign_key.rb

@@ -15,7 +15,7 @@ module RuboCop
           name = node.children[1]
-          add_offense(node, :selector) if name == :add_foreign_key
+          add_offense(node, location: :selector) if name == :add_foreign_key
         end
         def method_name(node)

rubocop/cop/migration/add_concurrent_index.rb

@@ -21,7 +21,7 @@ module RuboCop
           node.each_ancestor(:def) do |def_node|
             next unless method_name(def_node) == :change
-            add_offense(def_node, :name)
+            add_offense(def_node, location: :name)
           end
         end