Class: RuboCop::Cop::Style::RedundantException

Inherits:

Cop

• Object
• Cop
• RuboCop::Cop::Style::RedundantException

Defined in:

lib/rubocop/cop/style/redundant_exception.rb

Overview

This cop checks for RuntimeError as the argument of raise/fail.

Currently it checks for code like this:

Examples:

raise RuntimeError, 'message'

Constant Summary

MSG =

'Redundant `RuntimeError` argument can be removed.'.freeze

TARGET_NODE =

s(:const, nil, :RuntimeError)

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary

• #autocorrect(node) ⇒ Object

  switch ‘raise RuntimeError, ’message’‘ to `raise ’message’‘.

• #on_send(node) ⇒ Object

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?, #message, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

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, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, ternary_op?, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, 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

switch ‘raise RuntimeError, ’message’‘ to `raise ’message’‘

# File 'lib/rubocop/cop/style/redundant_exception.rb', line 32

def autocorrect(node)
  start_range = node.source_range.begin
  no_comma = range_with_surrounding_comma(node.source_range.end, :right)
  comma_range = start_range.join(no_comma)
  final_range = range_with_surrounding_space(comma_range, :right)
  ->(corrector) { corrector.replace(final_range, '') }
end

#on_send(node) ⇒ Object

# File 'lib/rubocop/cop/style/redundant_exception.rb', line 19

def on_send(node)
  return unless node.command?(:raise) || node.command?(:fail)

  _receiver, _selector, *args = *node

  return unless args.size == 2

  first_arg, = *args

  add_offense(first_arg, :expression) if first_arg == TARGET_NODE
end