Class: RuboCop::Cop::Style::RedundantBegin

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

Overview

This cop checks for redundant begin blocks.

Currently it checks for code like this:

Examples:


def redundant
  begin
    ala
    bala
  rescue StandardError => e
    something
  end
end

def preferred
  ala
  bala
rescue StandardError => e
  something
end

Constant Summary collapse

MSG =
'Redundant `begin` block detected.'

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 OnMethodDef

#on_def, #on_defs

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_name_with_namespace, cop_type, #debug?, #display_cop_names?, inherited, #initialize, #join_force?, lint?, #message, non_rails, qualified_cop_name, rails?, #relevant_file?, #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, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object


38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/rubocop/cop/style/redundant_begin.rb', line 38

def autocorrect(node)
  @corrections << lambda do |corrector|
    child = node.children.first

    begin_indent = node.loc.column
    child_indent = child.loc.column

    indent_diff = child_indent - begin_indent

    corrector.replace(
      range_with_surrounding_space(node.loc.expression),
      range_with_surrounding_space(
        child.loc.expression
      ).source.gsub(/^[ \t]{#{indent_diff}}/, '')
    )
  end
end

#on_method_def(_node, _method_name, _args, body) ⇒ Object


32
33
34
35
36
# File 'lib/rubocop/cop/style/redundant_begin.rb', line 32

def on_method_def(_node, _method_name, _args, body)
  return unless body && body.type == :kwbegin

  add_offense(body, :begin)
end