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::BASIC_LITERALS, Util::EQUALS_ASGN_NODES, Util::LITERALS, 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, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #parameter_name, #style, #style_detected, #unexpected_style_detected

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, non_rails, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object


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

def autocorrect(node)
  lambda do |corrector|
    name =
      case style
      when :semantic
        command_or_kernel_call?(: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
# File 'lib/rubocop/cop/style/signal_exception.rb', line 13

def on_rescue(node)
  return unless 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

#on_send(node) ⇒ Object


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

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