Class: RuboCop::Cop::Style::YodaCondition

Inherits:

Cop

• Object
• Cop
• RuboCop::Cop::Style::YodaCondition

Includes:

ConfigurableEnforcedStyle, RangeHelp

Defined in:

lib/rubocop/cop/style/yoda_condition.rb

Overview

This cop can either enforce or forbid Yoda conditions, i.e. comparison operations where the order of expression is reversed. eg. ‘5 == x`

Examples:

EnforcedStyle: forbid_for_all_comparison_operators (default)

# bad
99 == foo
"bar" != foo
42 >= foo
10 < bar

# good
foo == 99
foo == "bar"
foo <= 42
bar > 10

EnforcedStyle: forbid_for_equality_operators_only

# bad
99 == foo
"bar" != foo

# good
99 >= foo
3 < a && a < 5

EnforcedStyle: require_for_all_comparison_operators

# bad
foo == 99
foo == "bar"
foo <= 42
bar > 10

# good
99 == foo
"bar" != foo
42 >= foo
10 < bar

EnforcedStyle: require_for_equality_operators_only

# bad
99 >= foo
3 < a && a < 5

# good
99 == foo
"bar" != foo

Constant Summary

MSG =

'Reverse the order of the operands `%<source>s`.'

REVERSE_COMPARISON =

{
  '<' => '>',
  '<=' => '>=',
  '>' => '<',
  '>=' => '<='
}.freeze

EQUALITY_OPERATORS =

%i[== !=].freeze

NONCOMMUTATIVE_OPERATORS =

%i[===].freeze

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary

• #autocorrect(node) ⇒ Object
• #on_send(node) ⇒ Object

Methods included from ConfigurableEnforcedStyle

#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

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?, #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, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, 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

# File 'lib/rubocop/cop/style/yoda_condition.rb', line 77

def autocorrect(node)
  lambda do |corrector|
    corrector.replace(actual_code_range(node), corrected_code(node))
  end
end

#on_send(node) ⇒ Object

# File 'lib/rubocop/cop/style/yoda_condition.rb', line 70

def on_send(node)
  return unless yoda_compatible_condition?(node)
  return if equality_only? && non_equality_operator?(node)

  valid_yoda?(node) || add_offense(node)
end