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

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
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:


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

# good
def preferred
  ala
  bala
rescue StandardError => e
  something
end

# bad
begin
  do_something
end

# good
do_something

# bad
# When using Ruby 2.5 or later.
do_something do
  begin
    something
  rescue => ex
    anything
  end
end

# good
# In Ruby 2.5 or later, you can omit `begin` in `do-end` block.
do_something do
  something
rescue => ex
  anything
end

# good
# Stabby lambdas don't support implicit `begin` in `do-end` blocks.
-> do
  begin
    foo
  rescue Bar
    baz
  end
end

Constant Summary collapse

MSG = 
'Redundant `begin` block detected.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

add_parentheses, args_begin, args_end, begins_its_line?, comment_line?, comment_lines?, double_quotes_required?, escape_string, first_part_of_call_chain, indent, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file?, hidden_file_in_not_hidden_dir?, match_path?, maybe_hidden_file?, relative_path, smart_path

Constructor Details

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

Instance Method Details

#on_block(node) ⇒ Object 



77
78
79
80
81
82
83
84
85
 
# File 'lib/rubocop/cop/style/redundant_begin.rb', line 77

def on_block(node)
  return if target_ruby_version < 2.5

  return if node.send_node.lambda_literal?
  return if node.braces?
  return unless node.body&.kwbegin_type?

  register_offense(node.body)
end

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



70
71
72
73
74
 
# File 'lib/rubocop/cop/style/redundant_begin.rb', line 70

def on_def(node)
  return unless node.body&.kwbegin_type?

  register_offense(node.body)
end

#on_kwbegin(node) ⇒ Object 



87
88
89
90
91
 
# File 'lib/rubocop/cop/style/redundant_begin.rb', line 87

def on_kwbegin(node)
  return if contain_rescue_or_ensure?(node) || valid_context_using_only_begin?(node)

  register_offense(node)
end