Class: RuboCop::Cop::Style::WhileUntilModifier

Inherits:
Cop
  • Object
show all
Includes:
RuboCop::Cop::StatementModifier
Defined in:
lib/rubocop/cop/style/while_until_modifier.rb

Overview

Checks for while and until statements that would fit on one line if written as a modifier while/until. The maximum line length is configured in the ‘Metrics/LineLength` cop.

Examples:

# bad
while x < 10
  x += 1
end

# good
x += 1 while x < 10
# bad
until x > 10
  x += 1
end

# good
x += 1 until x > 10

Constant Summary collapse

MSG = 
'Favor modifier `%<keyword>s` usage when ' \
'having a single-line body.'.freeze

Constants included from Util

Util::ASGN_NODES, 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?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

absolute?, 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 



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

def autocorrect(node)
  oneline = "#{node.body.source} #{node.keyword} " \
            "#{node.condition.source}"

  lambda do |corrector|
    corrector.replace(node.source_range, oneline)
  end
end

#on_until(node) ⇒ Object 



37
38
39
 
# File 'lib/rubocop/cop/style/while_until_modifier.rb', line 37

def on_until(node)
  check(node)
end

#on_while(node) ⇒ Object 



33
34
35
 
# File 'lib/rubocop/cop/style/while_until_modifier.rb', line 33

def on_while(node)
  check(node)
end