Class: Gitlab::Styles::Rubocop::Cop::CustomErrorClass

Inherits:
RuboCop::Cop::Cop
  • Object
show all
Defined in:
lib/gitlab/styles/rubocop/cop/custom_error_class.rb

Overview

This cop makes sure that custom error classes, when empty, are declared with Class.new.

Examples:

# bad
class FooError < StandardError
end

# okish
class FooError < StandardError; end

# good
FooError = Class.new(StandardError)

Constant Summary collapse

MSG = 
'Use `Class.new(SuperClass)` to define an empty custom error class.'.freeze

Instance Method Summary collapse

Instance Method Details

#autocorrect(node) ⇒ Object 



33
34
35
36
37
38
39
40
 
# File 'lib/gitlab/styles/rubocop/cop/custom_error_class.rb', line 33

def autocorrect(node)
  klass, parent, _body = node.children
  replacement = "#{class_name_from_node(klass)} = Class.new(#{class_name_from_node(parent)})"

  lambda do |corrector|
    corrector.replace(node.source_range, replacement)
  end
end

#on_class(node) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/gitlab/styles/rubocop/cop/custom_error_class.rb', line 21

def on_class(node)
  _klass, parent, body = node.children

  return if body

  parent_klass = class_name_from_node(parent)

  return unless parent_klass&.to_s&.end_with?('Error')

  add_offense(node, location: :expression)
end