Class: RuboCop::Cop::Style::WhileUntilDo

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

Overview

Checks for uses of ‘do` in multi-line `while/until` statements.

Examples:


# bad
while x.any? do
  do_something(x.pop)
end

# good
while x.any?
  do_something(x.pop)
end

# bad
until x.empty? do
  do_something(x.pop)
end

# good
until x.empty?
  do_something(x.pop)
end

Constant Summary collapse

MSG = 
'Do not use `do` with multi-line `%<keyword>s`.'.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?, #message, #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 



49
50
51
52
53
54
55
 
# File 'lib/rubocop/cop/style/while_until_do.rb', line 49

def autocorrect(node)
  do_range = node.condition.source_range.end.join(node.loc.begin)

  lambda do |corrector|
    corrector.remove(do_range)
  end
end

#handle(node) ⇒ Object 



42
43
44
45
46
47
 
# File 'lib/rubocop/cop/style/while_until_do.rb', line 42

def handle(node)
  return unless node.multiline? && node.do?

  add_offense(node, location: :begin,
                    message: format(MSG, keyword: node.keyword))
end

#on_until(node) ⇒ Object 



38
39
40
 
# File 'lib/rubocop/cop/style/while_until_do.rb', line 38

def on_until(node)
  handle(node)
end

#on_while(node) ⇒ Object 



34
35
36
 
# File 'lib/rubocop/cop/style/while_until_do.rb', line 34

def on_while(node)
  handle(node)
end