Merge pull request #1537 from onemedical/rails-exit-abort

Add `abort` to the `Rails/Exit` cop

Author: koic

changelog/change_add_abort_to_rails_exit.md

@@ -0,0 +1 @@
+* [#1537](https://github.com/rubocop/rubocop-rails/pull/1537): Add `abort` to the `Rails/Exit` cop. ([@adamstegman][])

lib/rubocop/cop/rails/exit.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module Rails
-      # Enforces that `exit` calls are not used within a rails app.
+      # Enforces that `exit` and `abort` calls are not used within a rails app.
       # Valid options are instead to raise an error, break, return, or some
       # other form of stopping execution of current request.
       #
@@ -26,12 +26,15 @@ module Rails
       class Exit < Base
         include ConfigurableEnforcedStyle
 
-        MSG = 'Do not use `exit` in Rails applications.'
-        RESTRICT_ON_SEND = %i[exit exit!].freeze
+        MSG = 'Do not use `%<current>s` in Rails applications.'
+        RESTRICT_ON_SEND = %i[exit exit! abort].freeze
         EXPLICIT_RECEIVERS = %i[Kernel Process].freeze
 
         def on_send(node)
-          add_offense(node.loc.selector) if offending_node?(node)
+          return unless offending_node?(node)
+
+          message = format(MSG, current: node.method_name)
+          add_offense(node.loc.selector, message: message)
         end
 
         private

spec/rubocop/cop/rails/exit_spec.rb

@@ -11,7 +11,14 @@
   it 'registers an offense for an exit! call with no receiver' do
     expect_offense(<<~RUBY)
       exit!
-      ^^^^^ Do not use `exit` in Rails applications.
+      ^^^^^ Do not use `exit!` in Rails applications.
+    RUBY
+  end
+
+  it 'registers an offense for an abort call with no receiver' do
+    expect_offense(<<~RUBY)
+      abort
+      ^^^^^ Do not use `abort` in Rails applications.
     RUBY
   end
 
@@ -27,6 +34,10 @@
     it 'does not register an offense for an explicit exit! call on an object' do
       expect_no_offenses('Object.new.exit!(0)')
     end
+
+    it 'does not register an offense for an explicit abort call on an object' do
+      expect_no_offenses('Object.new.abort("failed")')
+    end
   end
 
   context 'with arguments' do
@@ -40,6 +51,17 @@
     it 'ignores exit calls with unexpected number of parameters' do
       expect_no_offenses('exit(1, 2)')
     end
+
+    it 'registers an offense for an abort("message") call with no receiver' do
+      expect_offense(<<~RUBY)
+        abort("message")
+        ^^^^^ Do not use `abort` in Rails applications.
+      RUBY
+    end
+
+    it 'ignores abort calls with unexpected number of parameters' do
+      expect_no_offenses('abort("message", "another message")')
+    end
   end
 
   context 'explicit calls' do
@@ -56,5 +78,19 @@
                 ^^^^ Do not use `exit` in Rails applications.
       RUBY
     end
+
+    it 'does register an offense for explicit Kernel.abort calls' do
+      expect_offense(<<~RUBY)
+        Kernel.abort
+               ^^^^^ Do not use `abort` in Rails applications.
+      RUBY
+    end
+
+    it 'does register an offense for explicit Process.abort calls' do
+      expect_offense(<<~RUBY)
+        Process.abort
+                ^^^^^ Do not use `abort` in Rails applications.
+      RUBY
+    end
   end
 end