Class: RuboCop::Cop::Style::RedundantReturn

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

Overview

This cop checks for redundant ‘return` expressions.

It should be extended to handle methods whose body is if/else or a case expression with a default branch.

Examples:


def test
  return something
end

def test
  one
  two
  three
  return something
end

Constant Summary collapse

MSG = 
'Redundant `return` detected.'.freeze
MULTI_RETURN_MSG = 
'To return multiple values, use an array.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

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?, comment_line?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, parenthesized_call?, precede?, range_between, range_by_whole_lines, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, symbol_without_quote?, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, find_file_upwards, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object

rubocop:disable Metrics/MethodLength



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/rubocop/cop/style/redundant_return.rb', line 34

def autocorrect(node) # rubocop:disable Metrics/MethodLength
  lambda do |corrector|
    unless arguments?(node.children)
      corrector.replace(node.source_range, 'nil')
      next
    end

    return_value, = *node
    if node.children.size > 1
      add_brackets(corrector, node)
    elsif return_value.hash_type?
      add_braces(corrector, return_value) unless return_value.braces?
    end
    return_kw = range_with_surrounding_space(range: node.loc.keyword,
                                             side: :right)
    corrector.remove(return_kw)
  end
end

#on_def(node) ⇒ Object Also known as: on_defs 



27
28
29
30
31
 
# File 'lib/rubocop/cop/style/redundant_return.rb', line 27

def on_def(node)
  return unless node.body

  check_branch(node.body)
end