rubocop-config-captive 1.4.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e7f4e97ec653176c49a0ed9626a7e310fa44db898b3579d96b13f09a9921057
-  data.tar.gz: 16346168e3786b757d9e4140974f8cb9f9f9b9efc66b11ee2a70e96d27415235
+  metadata.gz: daad52b9ec57ffb696430f0f7b9a1c797b841afb97c64e86bd8610730fdaecaf
+  data.tar.gz: 82d299623bea48f72e8b71111309d051c829782b2f5b5648b3e5f49b3e67c780
 SHA512:
-  metadata.gz: 7c1d1a707e4baab6a32e504414ebee681cf1438ad4970f25e8357e0c7ee3140833c4c3cafcb84dde46b14842a05fa75ebc1cdda8c21ba960b19f43912f46f7c0
-  data.tar.gz: 25064974d91c54d661ab593f149fc0ad64063f8cde8171533208b585af2ea9bef77790d4ae31f45d9b4a6cc163ced59c95d38c766f5acdc6f33b195aa3b90a2e
+  metadata.gz: 2727c1c5c3f2d413e832167b303bb77ecb495a2c65e0fc82147a19882c511fa5235005f471c085f92e9204140b69a7c48e0ad14bbcd4289e1e746e3ab8f2839c
+  data.tar.gz: 0cb908ed58c39398e9bfa1c2f2b49e7ab7ffd96ec5c78518722db0afc992505ad1185064503f97cbe76e9fca604678ee7214bb32ae795f21071724e13b99c0a4

data/config/rubocop-captive.yml

@@ -3,6 +3,7 @@ require:
   - ../lib/rubocop/cop/captive/translation/devise_i18n_presence.rb
   - ../lib/rubocop/cop/captive/translation/rails_i18n_presence.rb
   - ../lib/rubocop/cop/captive/translation/kaminari_i18n_presence.rb
+  - ../lib/rubocop/cop/captive/rspec/specify_before_parameter.rb
   - ../lib/rubocop/cop/captive/string_where_in_scope.rb
   - ../lib/rubocop/cop/captive/no_app_env.rb
 
@@ -28,6 +29,12 @@ Captive/Translation/KaminariI18nPresence:
   Include:
     - 'Gemfile'
 
+# RSpec
+Captive/RSpec/SpecifyBeforeParameter:
+  Description: 'Specify the parameter in `before` blocks. Example : before(:each) or before(:all)'
+  Include:
+    - 'spec/**/*'
+
 # other
 Captive/StringWhereInScope:
   Description: 'The `where` method should be used in a scope in a model.'

data/lib/rubocop/captive/version.rb

@@ -3,6 +3,6 @@
 module RuboCop
   module Captive
     # Version information for the the Airbnb RuboCop plugin.
-    VERSION = '1.4.2'
+    VERSION = '1.5.0'
   end
 end

data/lib/rubocop/cop/captive/rspec/specify_before_parameter.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Captive
+      module RSpec
+        # This cop enforces specifying the parameter in RSpec `before` blocks.
+        #
+        # The cops was created because many people didn't know that `before`
+        # method has default parameter value : `:each`
+        #
+        # @example
+        #   # bad
+        #   before do
+        #     ...
+        #   end
+        #
+        #   # good
+        #   before(:each) do
+        #     ...
+        #   end
+        #
+        #   before(:all) do
+        #     ...
+        #   end
+        #
+        class SpecifyBeforeParameter < RuboCop::Cop::Base
+          extend AutoCorrector
+
+          MSG = 'Specify the parameter in `before` blocks. Example : before(:each) or before(:all)'
+
+          def_node_matcher :before_block?, <<~PATTERN
+            (block
+              (send nil? :before ...)
+              ...
+            )
+          PATTERN
+
+          def_node_search :before_without_parameter?, <<~PATTERN
+            (send nil? :before)
+          PATTERN
+
+          def on_block(node)
+            return unless before_block?(node)
+            return unless before_without_parameter?(node)
+
+            add_offense(node, message: MSG) do |corrector|
+              corrector.replace(node.loc.expression, add_parameter(node))
+            end
+          end
+
+          private
+
+          def add_parameter(node)
+            source = node.loc.expression.source
+            source.insert(source.index('before') + 6, '(:each)')
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-config-captive
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.0
 platform: ruby
 authors:
 - Captive
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-26 00:00:00.000000000 Z
+date: 2023-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -169,6 +169,7 @@ files:
 - lib/rubocop/captive/version.rb
 - lib/rubocop/cop/captive/active_admin/active_admin_addons_presence.rb
 - lib/rubocop/cop/captive/no_app_env.rb
+- lib/rubocop/cop/captive/rspec/specify_before_parameter.rb
 - lib/rubocop/cop/captive/string_where_in_scope.rb
 - lib/rubocop/cop/captive/translation/devise_i18n_presence.rb
 - lib/rubocop/cop/captive/translation/kaminari_i18n_presence.rb