Class: RuboCop::Cop::Style::NegatedWhile

Inherits:

Cop

• Object
• Cop
• RuboCop::Cop::Style::NegatedWhile

Includes:

NegativeConditional

Defined in:

lib/rubocop/cop/style/negated_while.rb

Overview

Checks for uses of while with a negated condition.

Constant Summary

MSG =

'Favor `%s` over `%s` for negative conditions.'.freeze

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

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary

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

Methods included from NegativeConditional

#check_negative_conditional, included

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?, #highlights, inherited, #initialize, #join_force?, lint?, match?, #messages, 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?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, 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?, match_path?, relative_path

Constructor Details

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

Instance Method Details

#message(node) ⇒ Object

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

def message(node)
  if node.type == :while
    format(MSG, 'until', 'while')
  else
    format(MSG, 'while', 'until')
  end
end

#on_until(node) ⇒ Object

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

def on_until(node)
  check_negative_conditional(node)
end

#on_while(node) ⇒ Object

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

def on_while(node)
  check_negative_conditional(node)
end