Class: Rubocop::Cop::Style::SignalException

Inherits:
Cop
  • Object
show all
Includes:
ConfigurableEnforcedStyle
Defined in:
lib/rubocop/cop/style/signal_exception.rb

Overview

This cop checks for uses of fail and raise.

Constant Summary collapse

FAIL_MSG = 
'Use `fail` instead of `raise` to signal exceptions.'
RAISE_MSG = 
'Use `raise` instead of `fail` to rethrow exceptions.'

Constants included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from ConfigurableEnforcedStyle

#alternative_style, #both_styles_detected, #correct_style_detected, #opposite_style_detected, #parameter_name, #style, #unrecognized_style_detected

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #debug?, #display_cop_names?, #exclude_file?, #include_file?, inherited, #initialize, lint?, non_rails, rails?, #relevant_file?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

block_length, command?, comment_line?, const_name, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, on_node, operator?, parentheses?, proc?, range_with_surrounding_space, source_range, strip_quotes

Methods included from PathUtil

match_path?, relative_path

Constructor Details

This class inherits a constructor from Rubocop::Cop::Cop

Instance Method Details

#autocorrect(node) ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/rubocop/cop/style/signal_exception.rb', line 37

def autocorrect(node)
  @corrections << lambda do |corrector|
    name =
      case style
      when :semantic then command?(:raise, node) ? 'fail' : 'raise'
      when :only_raise then 'raise'
      when :only_fail then 'fail'
      end

    corrector.replace(node.loc.selector, name)
  end
end

#on_rescue(node) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/rubocop/cop/style/signal_exception.rb', line 13

def on_rescue(node)
  if style == :semantic
    begin_node, *rescue_nodes, _else_node = *node

    check_for(:raise, begin_node)

    rescue_nodes.each do |rescue_node|
      check_for(:fail, rescue_node)
      allow(:raise, rescue_node)
    end
  end
end

#on_send(node) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
 
# File 'lib/rubocop/cop/style/signal_exception.rb', line 26

def on_send(node)
  case style
  when :semantic
    check_for(:raise, node) unless ignored_node?(node)
  when :only_raise
    check_for(:raise, node)
  when :only_fail
    check_for(:fail, node)
  end
end