Class: RuboCop::Cop::Style::MinMaxComparison

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/style/min_max_comparison.rb

Overview

Enforces the use of ‘max` or `min` instead of comparison for greater or less.

NOTE: It can be used if you want to present limit or threshold in Ruby 2.7+. That it is slow though. So autocorrection will apply generic ‘max` or `min`:

source,ruby

a.clamp(b..) # Same as ‘[a, b].max` a.clamp(..b) # Same as `[a, b].min`

Examples:


# bad
a > b ? a : b
a >= b ? a : b

# good
[a, b].max

# bad
a < b ? a : b
a <= b ? a : b

# good
[a, b].min

Constant Summary collapse

MSG = 
'Use `%<prefer>s` instead.'
GRATER_OPERATORS = 
%i[> >=].freeze
LESS_OPERATORS = 
%i[< <=].freeze
COMPARISON_OPERATORS = 
GRATER_OPERATORS + LESS_OPERATORS

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#on_if(node) ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/rubocop/cop/style/min_max_comparison.rb', line 46

def on_if(node)
  lhs, operator, rhs = *node.condition
  return unless COMPARISON_OPERATORS.include?(operator)

  if_branch = node.if_branch
  else_branch = node.else_branch
  preferred_method = preferred_method(operator, lhs, rhs, if_branch, else_branch)
  return unless preferred_method

  replacement = "[#{lhs.source}, #{rhs.source}].#{preferred_method}"

  add_offense(node, message: format(MSG, prefer: replacement)) do |corrector|
    autocorrect(corrector, node, replacement)
  end
end