gitlab-styles 4.0.0 → 5.1.0

data/lib/gitlab/styles/rubocop/cop/migration/update_large_table.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+require_relative '../../migration_helpers'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        module Migration
+          # This cop checks for methods that may lead to batch type issues on a table that's been
+          # explicitly denied because of its size.
+          #
+          # Even though though these methods perform functions to avoid
+          # downtime, using it with tables with millions of rows still causes a
+          # significant delay in the deploy process and is best avoided.
+          #
+          # See https://gitlab.com/gitlab-com/infrastructure/issues/1602 for more
+          # information.
+          class UpdateLargeTable < RuboCop::Cop::Cop
+            include MigrationHelpers
+
+            MSG = 'Using `%s` on the `%s` table will take a long time to ' \
+              'complete, and should be avoided unless absolutely ' \
+              'necessary'
+
+            def_node_matcher :batch_update?, <<~PATTERN
+              (send nil? ${#denied_method?}
+                (sym $...)
+                ...)
+            PATTERN
+
+            def on_send(node)
+              return if denied_tables.empty? || denied_methods.empty?
+              return unless in_migration?(node)
+
+              matches = batch_update?(node)
+              return unless matches
+
+              update_method = matches.first
+              table = matches.last.to_a.first
+
+              return unless denied_tables.include?(table)
+
+              add_offense(node, message: format(MSG, update_method, table))
+            end
+
+            private
+
+            def denied_tables
+              cop_config['DeniedTables'] || []
+            end
+
+            def denied_method?(method_name)
+              denied_methods.include?(method_name)
+            end
+
+            def denied_methods
+              cop_config['DeniedMethods'] || []
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/rubocop/cop/polymorphic_associations.rb

@@ -19,7 +19,7 @@ module Gitlab
             node.children.last.each_node(:pair) do |pair|
               key_name = pair.children[0].children[0]
 
-              add_offense(pair, location: :expression) if key_name == :polymorphic
+              add_offense(pair) if key_name == :polymorphic
             end
           end
         end

data/lib/gitlab/styles/rubocop/cop/rspec/base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'rubocop-rspec'
+require_relative '../../rspec/helpers'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        module RSpec
+          class Base < RuboCop::Cop::RSpec::Base
+            include Rubocop::Rspec::Helpers
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/rubocop/cop/rspec/empty_line_after_let_block.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'rubocop-rspec'
+require_relative 'base'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        module RSpec
+          # Checks if there is an empty line after let blocks.
+          #
+          # @example
+          #   # bad
+          #   RSpec.describe Foo do
+          #     let(:something) { 'something' }
+          #     let(:another_thing) do
+          #     end
+          #     let(:something_else) do
+          #     end
+          #     let(:last_thing) { 'last thing' }
+          #   end
+          #
+          #   # good
+          #   RSpec.describe Foo do
+          #     let(:something) { 'something' }
+          #     let(:another_thing) do
+          #     end
+          #
+          #     let(:something_else) do
+          #     end
+          #
+          #     let(:last_thing) { 'last thing' }
+          #   end
+          #
+          #   # good - it's ok to have non-separated without do/end blocks
+          #   RSpec.describe Foo do
+          #     let(:something) { 'something' }
+          #     let(:last_thing) { 'last thing' }
+          #   end
+          #
+          class EmptyLineAfterLetBlock < Base
+            extend RuboCop::Cop::AutoCorrector
+            include RuboCop::RSpec::EmptyLineSeparation
+
+            MSG = 'Add an empty line after `%<let>s` block.'
+
+            def_node_matcher :lets, LET.block_pattern
+
+            def on_block(node)
+              lets(node) do
+                break if last_child?(node)
+                next if node.single_line?
+
+                missing_separating_line_offense(node) do |method|
+                  format(MSG, let: method)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/rubocop/cop/rspec/empty_line_after_shared_example.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'rubocop-rspec'
+require_relative 'base'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Cop
+        module RSpec
+          # Checks if there is an empty line after shared example blocks.
+          #
+          # @example
+          #   # bad
+          #   RSpec.describe Foo do
+          #     it_behaves_like 'do this first'
+          #     it_behaves_like 'does this' do
+          #     end
+          #     it_behaves_like 'does that' do
+          #     end
+          #     it_behaves_like 'do some more'
+          #   end
+          #
+          #   # good
+          #   RSpec.describe Foo do
+          #     it_behaves_like 'do this first'
+          #     it_behaves_like 'does this' do
+          #     end
+          #
+          #     it_behaves_like 'does that' do
+          #     end
+          #
+          #     it_behaves_like 'do some more'
+          #   end
+          #
+          #   # fair - it's ok to have non-separated without blocks
+          #   RSpec.describe Foo do
+          #     it_behaves_like 'do this first'
+          #     it_behaves_like 'does this'
+          #   end
+          #
+          class EmptyLineAfterSharedExample < Base
+            extend RuboCop::Cop::AutoCorrector
+            include RuboCop::RSpec::EmptyLineSeparation
+
+            MSG = 'Add an empty line after `%<example>s` block.'
+
+            def_node_matcher :shared_examples,
+                             (SharedGroups::ALL + Includes::ALL).block_pattern
+
+            def on_block(node)
+              shared_examples(node) do
+                break if last_child?(node)
+
+                missing_separating_line_offense(node) do |method|
+                  format(MSG, example: method)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/rubocop/cop/rspec/have_link_parameters.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'rubocop-rspec'
+require_relative 'base'
 
 module Gitlab
   module Styles
@@ -17,7 +18,9 @@ module Gitlab
           #   # good
           #   expect(page).to have_link('Link', href: 'https://example.com')
           #   expect(page).to have_link('Example')
-          class HaveLinkParameters < RuboCop::Cop::RSpec::Cop
+          class HaveLinkParameters < Base
+            extend RuboCop::Cop::AutoCorrector
+
             MESSAGE = "The second argument to `have_link` should be a Hash."
 
             def_node_matcher :unused_parameters?, <<~PATTERN
@@ -29,11 +32,13 @@ module Gitlab
             def on_send(node)
               return unless unused_parameters?(node)
 
-              location = node.arguments[1..-1]
-                .map(&:source_range)
-                .reduce(:join)
+              location = node.arguments[1..]
+                           .map(&:source_range)
+                           .reduce(:join)
 
-              add_offense(node, location: location, message: MESSAGE)
+              add_offense(location, message: MESSAGE) do |corrector|
+                corrector.insert_after(location.end, "\n")
+              end
             end
           end
         end

data/lib/gitlab/styles/rubocop/cop/rspec/single_line_hook.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'rubocop-rspec'
+require_relative 'base'
 
 module Gitlab
   module Styles
@@ -23,7 +24,7 @@ module Gitlab
           #   after(:each) do
           #     undo_something
           #   end
-          class SingleLineHook < RuboCop::Cop::RSpec::Cop
+          class SingleLineHook < Base
             MESSAGE = "Don't use single-line hook blocks."
 
             def_node_search :rspec_hook?, <<~PATTERN
@@ -34,7 +35,7 @@ module Gitlab
               return unless node.single_line?
               return unless rspec_hook?(node)
 
-              add_offense(node, location: :expression, message: MESSAGE)
+              add_offense(node, message: MESSAGE)
             end
           end
         end

data/lib/gitlab/styles/rubocop/cop/rspec/verbose_include_metadata.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'rubocop-rspec'
+require_relative 'base'
 
 module Gitlab
   module Styles
@@ -17,7 +18,9 @@ module Gitlab
           #   # good
           #   describe MyClass, :js do
           #   end
-          class VerboseIncludeMetadata < RuboCop::Cop::RSpec::Cop
+          class VerboseIncludeMetadata < Base
+            extend RuboCop::Cop::AutoCorrector
+
             MSG = 'Use `%s` instead of `%s`.'
 
             SELECTORS = %i[describe context feature example_group it specify example scenario its].freeze
@@ -37,25 +40,19 @@ module Gitlab
 
             def on_send(node)
               invalid_metadata_matches(node) do |match|
-                add_offense(node, location: :expression, message: format(MSG, good(match), bad(match)))
-              end
-            end
-
-            def autocorrect(node)
-              lambda do |corrector|
-                invalid_metadata_matches(node) do |match|
-                  corrector.replace(match.loc.expression, good(match))
+                add_offense(node, message: format(MSG, good(match), bad(match))) do |corrector|
+                  invalid_metadata_matches(node) do |match|
+                    corrector.replace(match.loc.expression, good(match))
+                  end
                 end
               end
             end
 
             private
 
-            def invalid_metadata_matches(node)
+            def invalid_metadata_matches(node, &block)
               include_metadata(node) do |matches|
-                matches.select(&method(:invalid_metadata?)).each do |match|
-                  yield match
-                end
+                matches.select(&method(:invalid_metadata?)).each(&block)
               end
             end
 

data/lib/gitlab/styles/rubocop/model_helpers.rb

@@ -7,7 +7,7 @@ module Gitlab
         # Returns true if the given node originated from the models directory.
         def in_model?(node)
           path = node.location.expression.source_buffer.name
-          pwd = RuboCop::PathUtil.pwd
+          pwd = Dir.pwd
           models_path = File.join(pwd, 'app', 'models')
           ee_models_path = File.join(pwd, 'ee', 'app', 'models')
 

data/lib/gitlab/styles/rubocop/rspec/helpers.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rubocop-rspec'
+
+module Gitlab
+  module Styles
+    module Rubocop
+      module Rspec
+        module Helpers
+          include RuboCop::RSpec::Language
+
+          LET = SelectorSet.new(%i[let_it_be]) + RuboCop::RSpec::Language::Helpers::ALL
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/styles/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module Styles
-    VERSION = '4.0.0'
+    VERSION = '5.1.0'
   end
 end

data/rubocop-all.yml

@@ -1,3 +1,4 @@
+---
 AllCops:
   TargetRubyVersion: 2.6
   # Cop names are not displayed in offense messages by default. Change behavior

data/rubocop-bundler.yml

@@ -1,3 +1,4 @@
+---
 # Gems in consecutive lines should be alphabetically sorted
 Bundler/OrderedGems:
   Enabled: false

data/rubocop-code_reuse.yml

@@ -0,0 +1,24 @@
+# Denies the use of ActiveRecord methods outside of configured
+# excluded directories
+# Directories that allow the use of the denied methods.
+# To start we provide a default configuration that matches
+# a standard Rails app and enable.
+# The default configuration can be overridden by
+# providing your own Exclusion list as follows:
+# CodeReuse/ActiveRecord:
+#  Enabled: true
+#  Exclude:
+#    - app/models/**/*.rb
+#    - config/**/*.rb
+#    - db/**/*.rb
+#    - lib/tasks/**/*.rb
+#    - spec/**/*.rb
+#    - lib/gitlab/**/*.rb
+CodeReuse/ActiveRecord:
+  Enabled: true
+  Exclude:
+    - app/models/**/*.rb
+    - config/**/*.rb
+    - db/**/*.rb
+    - lib/tasks/**/*.rb
+    - spec/**/*.rb

data/rubocop-default.yml

@@ -1,3 +1,4 @@
+---
 require:
   - rubocop-gitlab-security
   - rubocop-performance
@@ -12,6 +13,7 @@ inherit_from:
   - rubocop-layout.yml
   - rubocop-lint.yml
   - rubocop-metrics.yml
+  - rubocop-migrations.yml
   - rubocop-naming.yml
   - rubocop-performance.yml
   - rubocop-rails.yml

data/rubocop-gemspec.yml

@@ -1,3 +1,4 @@
+---
 # Dependencies in the gemspec should be alphabetically sorted
 # Configuration parameters: Include, TreatCommentsAsGroupSeparators.
 Gemspec/OrderedDependencies:

data/rubocop-layout.yml

@@ -1,3 +1,4 @@
+---
 # Check indentation of private/protected visibility modifiers.
 Layout/AccessModifierIndentation:
   Enabled: true
@@ -60,6 +61,11 @@ Layout/EmptyLines:
 Layout/EmptyLinesAroundAccessModifier:
   Enabled: true
 
+# Checks for a newline after an attribute accessor or a group of them
+# https://docs.rubocop.org/rubocop/0.89/cops_layout.html#layoutemptylinesaroundattributeaccessor
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
 # Keeps track of empty lines around block bodies.
 Layout/EmptyLinesAroundBlockBody:
   Enabled: true