Class: RuboCop::Cop::Obsession::Rails::SafetyAssuredComment

Inherits:
Base
  • Object
show all
Defined in:
lib/rubocop/cop/obsession/rails/safety_assured_comment.rb

Overview

This cop checks uses of strong_migrations’ ‘safety_assured { … }` without a valid reason.

‘safety_assured { … }` should only be used after carefully following the instructions from the strong_migrations gem. Always add a `# Safe because <reason>` comment explaining how you assured the safety of the DB migration. The reason should be detailed and reviewed by a knowledgeable PR reviewer. Failure to follow instructions may bring your app down.

Constant Summary collapse

MSG = 
'Add `# Safe because <reason>` comment above safety_assured. ' \
'An invalid reason may bring the site down.'

Instance Method Summary collapse

Instance Method Details

#on_block(node) ⇒ Object 



25
26
27
28
29
30
31
32
 
# File 'lib/rubocop/cop/obsession/rails/safety_assured_comment.rb', line 25

def on_block(node)
  return if !safety_assured_block?(node)
  previous_comment = processed_source.comments_before_line(node.first_line)&.first

  if previous_comment.nil? || !previous_comment.text.match?(/^# Safe because( [^ ]+){4}/)
    add_offense(node)
  end
end