Forbid the use of `#reload` and prefer `#reset`forbid-the-usage-of-reload

The `#reload` makes to load all objects into memory,
and the main purpose of `#reload` is to drop the association cache.

The `#reset` seems to solve exactly that case.

1 files changed, 60 insertions, 0 deletions

diff --git a/spec/rubocop/cop/active_record_association_reload_spec.rb b/spec/rubocop/cop/active_record_association_reload_spec.rb
new file mode 100644
index 00000000000..69eb16a54d2
--- /dev/null
+++ b/spec/rubocop/cop/active_record_association_reload_spec.rb
@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'rubocop'
+require_relative '../../../rubocop/cop/active_record_association_reload'
+
+describe RuboCop::Cop::ActiveRecordAssociationReload do
+  include CopHelper
+
+  subject(:cop) { described_class.new }
+
+  context 'when using ActiveRecord::Base' do
+    it 'registers an offense on reload usage' do
+      expect_offense(<<~PATTERN.strip_indent)
+        users = User.all
+        users.reload
+              ^^^^^^ Use reset instead of reload. For more details check the https://gitlab.com/gitlab-org/gitlab-ce/issues/60218.
+        PATTERN
+    end
+
+    it 'does not register an offense on reset usage' do
+      expect_no_offenses(<<~PATTERN.strip_indent)
+        users = User.all
+        users.reset
+      PATTERN
+    end
+  end
+
+  context 'when using ActiveRecord::Relation' do
+    it 'registers an offense on reload usage' do
+      expect_offense(<<~PATTERN.strip_indent)
+        user = User.new
+        user.reload
+             ^^^^^^ Use reset instead of reload. For more details check the https://gitlab.com/gitlab-org/gitlab-ce/issues/60218.
+      PATTERN
+    end
+
+    it 'does not register an offense on reset usage' do
+      expect_no_offenses(<<~PATTERN.strip_indent)
+        user = User.new
+        user.reset
+      PATTERN
+    end
+  end
+
+  context 'when using on self' do
+    it 'registers an offense on reload usage' do
+      expect_offense(<<~PATTERN.strip_indent)
+        reload
+        ^^^^^^ Use reset instead of reload. For more details check the https://gitlab.com/gitlab-org/gitlab-ce/issues/60218.
+      PATTERN
+    end
+
+    it 'does not register an offense on reset usage' do
+      expect_no_offenses(<<~PATTERN.strip_indent)
+        reset
+      PATTERN
+    end
+  end
+end