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

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

Overview

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

It checks for code like this:

Examples:

# Bad
raise RuntimeError, 'message'

# Bad
raise RuntimeError.new('message')

# Good
raise 'message'

Constant Summary collapse

MSG_1 = 
'Redundant `RuntimeError` argument can be removed.'.freeze
MSG_2 = 
'Redundant `RuntimeError.new` call can be replaced with ' \
'just the message.'.freeze

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 collapse

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, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, 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’‘, and `raise RuntimeError.new(’message’)‘ to `raise ’message’‘.



32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/rubocop/cop/style/redundant_exception.rb', line 32

def autocorrect(node)
  exploded?(node) do |command, message|
    return lambda do |corrector|
      corrector.replace(node.source_range,
                        "#{command} #{message.source}")
    end
  end
  compact?(node) do |new_call, message|
    lambda do |corrector|
      corrector.replace(new_call.source_range, message.source)
    end
  end
end

#on_send(node) ⇒ Object 



25
26
27
28
 
# File 'lib/rubocop/cop/style/redundant_exception.rb', line 25

def on_send(node)
  exploded?(node) { return add_offense(node, :expression, MSG_1) }
  compact?(node) { add_offense(node, :expression, MSG_2) }
end