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

Inherits:

Cop

• Object
• Cop
• RuboCop::Cop::Style::WhileUntilModifier

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 configurable.

Constant Summary

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary

• #autocorrect(node) ⇒ Object
• #on_until(node) ⇒ Object
• #on_while(node) ⇒ Object

Methods included from RuboCop::Cop::StatementModifier

#body_has_comment?, #body_length, #comment_lines, #end_keyword_has_comment?, #fit_within_line_as_modifier_form?, #length, #max_line_length

Methods included from IfNode

#elsif?, #if_else?, #if_node_parts, #modifier_if?, #ternary_op?

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

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?, block_length, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object

# File 'lib/rubocop/cop/style/while_until_modifier.rb', line 21

def autocorrect(node)
  cond, body = *node
  oneline = "#{body.source} #{node.loc.keyword.source} " + cond.source
  ->(corrector) { corrector.replace(node.source_range, oneline) }
end

#on_until(node) ⇒ Object

# File 'lib/rubocop/cop/style/while_until_modifier.rb', line 17

def on_until(node)
  check(node)
end

#on_while(node) ⇒ Object

# File 'lib/rubocop/cop/style/while_until_modifier.rb', line 13

def on_while(node)
  check(node)
end