Apply template update: Rubocop: add linter to disallow before blocks

Source: mockdeep/Rails-Template#1399

Author: Template Bot

.rubocop.yml

@@ -1,3 +1,6 @@
+require:
+  - ./linters/rubocop/cop/rspec/no_before_hook
+
 inherit_from: .rubocop_todo.yml
 inherit_mode: { merge: [Exclude] }
 
@@ -21,6 +24,7 @@ Layout/LineLength: { Max: 80, Exclude: [db/migrate/*.rb] }
 Layout/RedundantLineBreak: { InspectBlocks: true }
 Metrics/AbcSize: { Exclude: [db/migrate/*.rb], CountRepeatedAttributes: false }
 Metrics/BlockLength:
+<<<<<<< HEAD
   Exclude: [config/**/*.rb, db/migrate/*.rb, spec/**/*.rb, db/seeds/**/*.rb]
 Metrics/MethodLength: { Exclude: [db/migrate/*.rb] }
 Rails/SkipsModelValidations: { AllowedMethods: [update_all] }
@@ -31,6 +35,26 @@ RSpec/MessageExpectation:
 RSpec/MessageSpies: { EnforcedStyle: receive }
 RSpec/MultipleMemoizedHelpers: { Max: 0, AllowSubject: false }
 Style/ClassAndModuleChildren: { EnforcedStyle: compact }
+=======
+  AllowedMethods:
+    - describe
+  Exclude:
+    - Guardfile
+    - db/schema.rb
+    - config/environments/development.rb
+Rails/FilePath: { EnforcedStyle: slashes }
+Metrics/MethodLength: { Exclude: [db/migrate/**/*.rb] }
+RSpec/MultipleExpectations:
+  Exclude:
+    - spec/system/**/*.rb
+RSpec/MessageExpectation: { EnforcedStyle: expect }
+RSpec/MultipleMemoizedHelpers:
+  Max: 0
+  AllowSubject: false
+  Exclude:
+    - spec/linters/rubocop/**/*.rb
+Style/ArrayFirstLast: { Exclude: [Guardfile] }
+>>>>>>> 0b27ab6 (Rubocop: add linter to disallow before blocks (#1399))
 Style/MethodCallWithArgsParentheses:
   AllowedMethods:
     - and
@@ -45,9 +69,18 @@ Style/StringLiterals: { EnforcedStyle: double_quotes }
 Style/SymbolArray: { EnforcedStyle: brackets }
 Style/WordArray: { EnforcedStyle: brackets }
 
+<<<<<<< HEAD
 # want to enable these, but they don't work right when using `.rubocop_todo.yml`
 Style/DocumentationMethod: { Enabled: false }
 Style/Documentation: { Enabled: false }
+=======
+I18n/GetText/DecorateString:
+  Exclude:
+    - linters/**/*.rb
+I18n/RailsI18n/DecorateString:
+  Exclude:
+    - linters/**/*.rb
+>>>>>>> 0b27ab6 (Rubocop: add linter to disallow before blocks (#1399))
 
 ################################################################################
 #

linters/rubocop/cop/rspec/no_before_hook.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Disallows the use of `before` hooks in specs.
+      #
+      # @example
+      #   # bad
+      #   before { do_something }
+      #   before(:each) { do_something }
+      #
+      #   # good
+      #   # Inline setup directly in the example.
+      class NoBeforeHook < Base
+        MSG = "Do not use `before` hooks."
+
+        # @!method before_hook?(node)
+        def_node_matcher(:before_hook?, <<~PATTERN)
+          (block (send nil? :before ...) ...)
+        PATTERN
+
+        def on_block(node)
+          return unless before_hook?(node)
+
+          add_offense(node)
+        end
+
+        alias on_numblock on_block
+      end
+    end
+  end
+end

spec/linters/rubocop/cop/rspec/no_before_hook_spec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require "rubocop-rspec"
+require "rubocop/rspec/cop_helper"
+require "rubocop/rspec/expect_offense"
+require_relative("../../../../../linters/rubocop/cop/rspec/no_before_hook")
+
+RSpec.describe RuboCop::Cop::RSpec::NoBeforeHook do
+  include CopHelper
+  include RuboCop::RSpec::ExpectOffense
+
+  let(:cop) { described_class.new }
+
+  it "registers an offense for a before block" do
+    expect_offense(<<~RUBY)
+      before { do_something }
+      ^^^^^^^^^^^^^^^^^^^^^^^ RSpec/NoBeforeHook: Do not use `before` hooks.
+    RUBY
+  end
+
+  it "registers an offense for before(:each)" do
+    expect_offense(<<~RUBY)
+      before(:each) { do_something }
+      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RSpec/NoBeforeHook: Do not use `before` hooks.
+    RUBY
+  end
+
+  it "registers an offense for before(:all)" do
+    expect_offense(<<~RUBY)
+      before(:all) { do_something }
+      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ RSpec/NoBeforeHook: Do not use `before` hooks.
+    RUBY
+  end
+
+  it "does not register an offense for an after block" do
+    expect_no_offenses(<<~RUBY)
+      after { do_something }
+    RUBY
+  end
+
+  it "does not register an offense for a regular method call" do
+    expect_no_offenses(<<~RUBY)
+      def setup
+        do_something
+      end
+    RUBY
+  end
+end