/
active_support_on_load.rb
50 lines (43 loc) · 1.76 KB
/
active_support_on_load.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# frozen_string_literal: true
module RuboCop
module Cop
module Rails
# Use Active Support lazy load hooks to patch Rails core classes, so they are not forcible loaded early.
#
# @example
#
# # bad
# ActiveRecord::Base.include(MyClass)
#
# # good
# ActiveSupport.on_load(:active_record) { include MyClass }
class ActiveSupportOnLoad < Base
extend AutoCorrector
AUTOCORRECTABLE_CLASSES = {
'ActiveRecord::Base' => 'active_record',
'ActionController::Base' => 'action_controller',
'ActiveJob::Base' => 'active_job',
'ActionView::Base' => 'action_view',
'ActionMailer::Base' => 'action_mailer',
'ActionController::TestCase' => 'action_controller_test_case',
'ActiveSupport::TestCase' => 'active_support_test_case',
'ActiveJob::TestCase' => 'active_job_test_case',
'ActionDispatch::IntegrationTest' => 'action_dispatch_integration_test',
'ActionMailer::TestCase' => 'action_mailer_test_case'
}.freeze
RESTRICT_ON_SEND = %i[prepend include extend].freeze
MSG =
"Don't use \x1b[32m%<source>s\x1b[0m. Use this form instead \x1b[32m%<preferred>s\x1b[0m"
def on_send(node)
receiver, method, arguments = *node
return unless receiver && AUTOCORRECTABLE_CLASSES.key?(receiver.const_name)
hook_name = AUTOCORRECTABLE_CLASSES[receiver.const_name]
preferred = "ActiveSupport.on_load(:#{hook_name}) { #{method} #{arguments.source} }"
add_offense(node, message: format(MSG, preferred: preferred, source: node.source)) do |corrector|
corrector.replace(node, preferred)
end
end
end
end
end
end