Make use of expect_correction in rails tests

Author: rrosenblum

spec/rubocop/cop/rails/active_record_aliases_spec.rb

@@ -4,67 +4,53 @@
   subject(:cop) { described_class.new }
 
   describe '#update_attributes' do
-    it 'registers an offense' do
+    it 'registers an offense and corrects' do
       expect_offense(<<-RUBY.strip_indent)
         book.update_attributes(author: "Alice")
              ^^^^^^^^^^^^^^^^^ Use `update` instead of `update_attributes`.
       RUBY
-    end
 
-    it 'is autocorrected' do
-      new_source = autocorrect_source(
-        'book.update_attributes(author: "Alice")'
-      )
-      expect(new_source).to eq 'book.update(author: "Alice")'
+      expect_correction(<<-RUBY.strip_indent)
+        book.update(author: "Alice")
+      RUBY
     end
   end
 
   describe '#update_attributes!' do
-    it 'registers an offense' do
+    it 'registers an offense and corrects' do
       expect_offense(<<-RUBY.strip_indent)
         book.update_attributes!(author: "Bob")
              ^^^^^^^^^^^^^^^^^^ Use `update!` instead of `update_attributes!`.
       RUBY
-    end
 
-    it 'is autocorrected' do
-      new_source = autocorrect_source(
-        'book.update_attributes!(author: "Bob")'
-      )
-      expect(new_source).to eq 'book.update!(author: "Bob")'
+      expect_correction(<<-RUBY.strip_indent)
+        book.update!(author: "Bob")
+      RUBY
     end
   end
 
   describe '#update' do
     it 'does not register an offense' do
       expect_no_offenses('book.update(author: "Alice")')
     end
-
-    it 'is not autocorrected' do
-      source = 'book.update(author: "Alice")'
-      new_source = autocorrect_source(source)
-      expect(new_source).to eq source
-    end
   end
 
   describe '#update!' do
     it 'does not register an offense' do
       expect_no_offenses('book.update!(author: "Bob")')
     end
-
-    it 'is not autocorrected' do
-      source = 'book.update!(author: "Bob")'
-      new_source = autocorrect_source(source)
-      expect(new_source).to eq source
-    end
   end
 
   describe 'other use of the `update_attributes` string' do
     it 'does not autocorrect the other usage' do
-      new_source = autocorrect_source(
-        'update_attributes_book.update_attributes(author: "Alice")'
-      )
-      expect(new_source).to eq 'update_attributes_book.update(author: "Alice")'
+      expect_offense(<<-RUBY.strip_indent)
+        update_attributes_book.update_attributes(author: "Alice")
+                               ^^^^^^^^^^^^^^^^^ Use `update` instead of `update_attributes`.
+      RUBY
+
+      expect_correction(<<-RUBY.strip_indent)
+        update_attributes_book.update(author: "Alice")
+      RUBY
     end
   end
 end

spec/rubocop/cop/rails/active_support_aliases_spec.rb

@@ -5,18 +5,15 @@
 
   describe 'String' do
     describe '#starts_with?' do
-      it 'is registered as an offense' do
+      it 'registers as an offense and corrects' do
         expect_offense(<<-RUBY.strip_indent)
           'some_string'.starts_with?('prefix')
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `start_with?` instead of `starts_with?`.
         RUBY
-      end
 
-      it 'is autocorrected' do
-        new_source = autocorrect_source(
-          "'some_string'.starts_with?('prefix')"
-        )
-        expect(new_source).to eq "'some_string'.start_with?('prefix')"
+        expect_correction(<<-RUBY.strip_indent)
+          'some_string'.start_with?('prefix')
+        RUBY
       end
     end
 
@@ -27,18 +24,15 @@
     end
 
     describe '#ends_with?' do
-      it 'is registered as an offense' do
+      it 'registers as an offense and corrects' do
         expect_offense(<<-RUBY.strip_indent)
           'some_string'.ends_with?('prefix')
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `end_with?` instead of `ends_with?`.
         RUBY
-      end
 
-      it 'is autocorrected' do
-        new_source = autocorrect_source(
-          "'some_string'.ends_with?('prefix')"
-        )
-        expect(new_source).to eq "'some_string'.end_with?('prefix')"
+        expect_correction(<<-RUBY.strip_indent)
+          'some_string'.end_with?('prefix')
+        RUBY
       end
     end
 
@@ -51,17 +45,15 @@
 
   describe 'Array' do
     describe '#append' do
-      it 'is registered as an offense' do
+      it 'registers as an offense and does not correct' do
         expect_offense(<<-RUBY.strip_indent)
           [1, 'a', 3].append('element')
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `<<` instead of `append`.
         RUBY
-      end
 
-      it 'is not autocorrected' do
-        source = "[1, 'a', 3].append('element')"
-        new_source = autocorrect_source(source)
-        expect(new_source).to eq source
+        expect_correction(<<-RUBY.strip_indent)
+          [1, 'a', 3].append('element')
+        RUBY
       end
     end
 
@@ -72,18 +64,15 @@
     end
 
     describe '#prepend' do
-      it 'is registered as an offense' do
+      it 'registers as an offense and corrects' do
         expect_offense(<<-RUBY.strip_indent)
           [1, 'a', 3].prepend('element')
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `unshift` instead of `prepend`.
         RUBY
-      end
 
-      it 'is autocorrected' do
-        new_source = autocorrect_source(
-          "[1, 'a', 3].prepend('element')"
-        )
-        expect(new_source).to eq "[1, 'a', 3].unshift('element')"
+        expect_correction(<<-RUBY.strip_indent)
+          [1, 'a', 3].unshift('element')
+        RUBY
       end
     end
 

spec/rubocop/cop/rails/application_job_spec.rb

@@ -70,11 +70,10 @@ class ApplicationJob < ActiveJob::Base; end
           class MyJob < ActiveJob::Base; end
                         ^^^^^^^^^^^^^^^ Jobs should subclass `ApplicationJob`.
         RUBY
-      end
 
-      it 'auto-corrects' do
-        expect(autocorrect_source('class MyJob < ActiveJob::Base; end'))
-          .to eq('class MyJob < ApplicationJob; end')
+        expect_correction(<<-RUBY.strip_indent)
+          class MyJob < ApplicationJob; end
+        RUBY
       end
     end
 
@@ -99,30 +98,36 @@ class Nested::MyJob < ActiveJob::Base; end
     end
 
     it 'corrects jobs defined using Class.new' do
-      source = 'MyJob = Class.new(ActiveJob::Base)'
-      inspect_source(source)
-      expect(cop.messages).to eq(['Jobs should subclass `ApplicationJob`.'])
-      expect(cop.highlights).to eq(['ActiveJob::Base'])
-      expect(autocorrect_source(source))
-        .to eq('MyJob = Class.new(ApplicationJob)')
+      expect_offense(<<-RUBY.strip_indent)
+        MyJob = Class.new(ActiveJob::Base)
+                          ^^^^^^^^^^^^^^^ Jobs should subclass `ApplicationJob`.
+      RUBY
+
+      expect_correction(<<-RUBY.strip_indent)
+        MyJob = Class.new(ApplicationJob)
+      RUBY
     end
 
     it 'corrects nested jobs defined using Class.new' do
-      source = 'Nested::MyJob = Class.new(ActiveJob::Base)'
-      inspect_source(source)
-      expect(cop.messages).to eq(['Jobs should subclass `ApplicationJob`.'])
-      expect(cop.highlights).to eq(['ActiveJob::Base'])
-      expect(autocorrect_source(source))
-        .to eq('Nested::MyJob = Class.new(ApplicationJob)')
+      expect_offense(<<-RUBY.strip_indent)
+        Nested::MyJob = Class.new(ActiveJob::Base)
+                                  ^^^^^^^^^^^^^^^ Jobs should subclass `ApplicationJob`.
+      RUBY
+
+      expect_correction(<<-RUBY.strip_indent)
+        Nested::MyJob = Class.new(ApplicationJob)
+      RUBY
     end
 
     it 'corrects anonymous jobs' do
-      source = 'Class.new(ActiveJob::Base) {}'
-      inspect_source(source)
-      expect(cop.messages).to eq(['Jobs should subclass `ApplicationJob`.'])
-      expect(cop.highlights).to eq(['ActiveJob::Base'])
-      expect(autocorrect_source(source))
-        .to eq('Class.new(ApplicationJob) {}')
+      expect_offense(<<-RUBY.strip_indent)
+        Class.new(ActiveJob::Base) {}
+                  ^^^^^^^^^^^^^^^ Jobs should subclass `ApplicationJob`.
+      RUBY
+
+      expect_correction(<<-RUBY.strip_indent)
+        Class.new(ApplicationJob) {}
+      RUBY
     end
 
     it 'allows ApplicationJob defined using Class.new' do

spec/rubocop/cop/rails/application_record_spec.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 RSpec.describe RuboCop::Cop::Rails::ApplicationRecord do
-  let(:msgs) { ['Models should subclass `ApplicationRecord`.'] }
-
   context 'rails 4', :rails4, :config do
     subject(:cop) { described_class.new(config) }
 
@@ -64,66 +62,90 @@ class ApplicationRecord < ActiveRecord::Base
     end
 
     it 'corrects models that subclass ActiveRecord::Base' do
-      source = "class MyModel < ActiveRecord::Base\nend"
-      inspect_source(source)
-      expect(cop.messages).to eq(msgs)
-      expect(cop.highlights).to eq(['ActiveRecord::Base'])
-      expect(autocorrect_source(source))
-        .to eq("class MyModel < ApplicationRecord\nend")
+      expect_offense(<<-RUBY.strip_indent)
+        class MyModel < ActiveRecord::Base
+                        ^^^^^^^^^^^^^^^^^^ Models should subclass `ApplicationRecord`.
+        end
+      RUBY
+
+      expect_correction(<<-RUBY.strip_indent)
+        class MyModel < ApplicationRecord
+        end
+      RUBY
     end
 
     it 'corrects single-line class definitions' do
-      source = 'class MyModel < ActiveRecord::Base; end'
-      inspect_source(source)
-      expect(cop.messages).to eq(msgs)
-      expect(cop.highlights).to eq(['ActiveRecord::Base'])
-      expect(autocorrect_source(source))
-        .to eq('class MyModel < ApplicationRecord; end')
+      expect_offense(<<-RUBY.strip_indent)
+        class MyModel < ActiveRecord::Base; end
+                        ^^^^^^^^^^^^^^^^^^ Models should subclass `ApplicationRecord`.
+      RUBY
+
+      expect_correction(<<-RUBY.strip_indent)
+        class MyModel < ApplicationRecord; end
+      RUBY
     end
 
     it 'corrects namespaced models that subclass ActiveRecord::Base' do
-      source = "module Nested\n  class MyModel < ActiveRecord::Base\n  end\nend"
-      inspect_source(source)
-      expect(cop.messages).to eq(msgs)
-      expect(cop.highlights).to eq(['ActiveRecord::Base'])
-      expect(autocorrect_source(source))
-        .to eq("module Nested\n  class MyModel < ApplicationRecord\n  end\nend")
+      expect_offense(<<-RUBY.strip_indent)
+        module Nested
+          class MyModel < ActiveRecord::Base
+                          ^^^^^^^^^^^^^^^^^^ Models should subclass `ApplicationRecord`.
+          end
+        end
+      RUBY
+
+      expect_correction(<<-RUBY.strip_indent)
+        module Nested
+          class MyModel < ApplicationRecord
+          end
+        end
+      RUBY
     end
 
     it 'corrects models defined using nested constants' do
-      source = "class Nested::MyModel < ActiveRecord::Base\nend"
-      inspect_source(source)
-      expect(cop.messages).to eq(msgs)
-      expect(cop.highlights).to eq(['ActiveRecord::Base'])
-      expect(autocorrect_source(source))
-        .to eq("class Nested::MyModel < ApplicationRecord\nend")
+      expect_offense(<<-RUBY.strip_indent)
+        class Nested::MyModel < ActiveRecord::Base
+                                ^^^^^^^^^^^^^^^^^^ Models should subclass `ApplicationRecord`.
+        end
+      RUBY
+
+      expect_correction(<<-RUBY.strip_indent)
+        class Nested::MyModel < ApplicationRecord
+        end
+      RUBY
     end
 
     it 'corrects models defined using Class.new' do
-      source = 'MyModel = Class.new(ActiveRecord::Base)'
-      inspect_source(source)
-      expect(cop.messages).to eq(msgs)
-      expect(cop.highlights).to eq(['ActiveRecord::Base'])
-      expect(autocorrect_source(source))
-        .to eq('MyModel = Class.new(ApplicationRecord)')
+      expect_offense(<<-RUBY.strip_indent)
+        MyModel = Class.new(ActiveRecord::Base)
+                            ^^^^^^^^^^^^^^^^^^ Models should subclass `ApplicationRecord`.
+      RUBY
+
+      expect_correction(<<-RUBY.strip_indent)
+        MyModel = Class.new(ApplicationRecord)
+      RUBY
     end
 
     it 'corrects nested models defined using Class.new' do
-      source = 'Nested::MyModel = Class.new(ActiveRecord::Base)'
-      inspect_source(source)
-      expect(cop.messages).to eq(msgs)
-      expect(cop.highlights).to eq(['ActiveRecord::Base'])
-      expect(autocorrect_source(source))
-        .to eq('Nested::MyModel = Class.new(ApplicationRecord)')
+      expect_offense(<<-RUBY.strip_indent)
+        Nested::MyModel = Class.new(ActiveRecord::Base)
+                                    ^^^^^^^^^^^^^^^^^^ Models should subclass `ApplicationRecord`.
+      RUBY
+
+      expect_correction(<<-RUBY.strip_indent)
+        Nested::MyModel = Class.new(ApplicationRecord)
+      RUBY
     end
 
     it 'corrects anonymous models' do
-      source = 'Class.new(ActiveRecord::Base) {}'
-      inspect_source(source)
-      expect(cop.messages).to eq(msgs)
-      expect(cop.highlights).to eq(['ActiveRecord::Base'])
-      expect(autocorrect_source(source))
-        .to eq('Class.new(ApplicationRecord) {}')
+      expect_offense(<<-RUBY.strip_indent)
+        Class.new(ActiveRecord::Base) {}
+                  ^^^^^^^^^^^^^^^^^^ Models should subclass `ApplicationRecord`.
+      RUBY
+
+      expect_correction(<<-RUBY.strip_indent)
+        Class.new(ApplicationRecord) {}
+      RUBY
     end
 
     it 'allows ApplicationRecord defined using Class.new' do