Class: RuboCop::Cop::Style::NumericPredicate

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

Overview

This cop checks for using of comparison operators (‘==`, `!=`, `>`, `<`), to test numbers as zero, nonzero, positive, or negative. These can be replaced by their respective predicate methods. The cop can also be configured to do the reverse.

Examples:


# EnforcedStyle: predicate (default)

# bad

foo == 0
0 != bar.baz
0 > foo
bar.baz > 0

# good

foo.zero?
bar.baz.nonzero?
foo.negative?
bar.baz.positive?

# EnforcedStyle: comparison

# bad

foo.zero?
bar.baz.nonzero?
foo.negative?
bar.baz.positive?

# good

foo == 0
0 != bar.baz
0 > foo
bar.baz > 0

Constant Summary collapse

MSG = 
'Use `%s` instead of `%s`.'.freeze
REPLACEMENTS = 
{
  'zero?' => '==',
  'nonzero?' => '!=',
  'positive?' => '>',
  'negative?' => '<'
}.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 collapse

Methods included from ConfigurableEnforcedStyle

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

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?, #message, #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

#on_send(node) ⇒ Object 



59
60
61
62
63
64
65
66
 
# File 'lib/rubocop/cop/style/numeric_predicate.rb', line 59

def on_send(node)
  numeric, replacement = check(node)

  if numeric
    add_offense(node, node.loc.expression,
                format(MSG, replacement, node.source))
  end
end