Class: RuboCop::Cop::Style::FloatDivision

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

Overview

Checks for division with integers coerced to floats. It is recommended to either always use fdiv or coerce one side only. This cop also provides other options for code consistency.

Examples:

EnforcedStyle: single_coerce (default)

# bad
a.to_f / b.to_f

# good
a.to_f / b
a / b.to_f

EnforcedStyle: left_coerce

# bad
a / b.to_f
a.to_f / b.to_f

# good
a.to_f / b

EnforcedStyle: right_coerce

# bad
a.to_f / b
a.to_f / b.to_f

# good
a / b.to_f

EnforcedStyle: fdiv

# bad
a / b.to_f
a.to_f / b
a.to_f / b.to_f

# good
a.fdiv(b)

Cop Safety Information:

  • This cop is unsafe, because if the operand variable is a string object then .to_f will be removed and an error will occur.

    a = '1.2'
    b = '3.4'
    a.to_f / b.to_f # Both `to_f` calls are required here

Constant Summary collapse

MESSAGES =
{
  left_coerce: 'Prefer using `.to_f` on the left side.',
  right_coerce: 'Prefer using `.to_f` on the right side.',
  single_coerce: 'Prefer using `.to_f` on one side only.',
  fdiv: 'Prefer using `fdiv` for float divisions.'
}.freeze
RESTRICT_ON_SEND =
%i[/].freeze

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

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_configured?, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #begin_investigation, callbacks_needed, #callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #ready, #relevant_file?, 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

#any_coerce?(node) ⇒ Object



79
80
81
# File 'lib/rubocop/cop/style/float_division.rb', line 79

def_node_matcher :any_coerce?, <<~PATTERN
  {(send _ :/ (send _ :to_f)) (send (send _ :to_f) :/ _)}
PATTERN

#both_coerce?(node) ⇒ Object



75
76
77
# File 'lib/rubocop/cop/style/float_division.rb', line 75

def_node_matcher :both_coerce?, <<~PATTERN
  (send (send _ :to_f) :/ (send _ :to_f))
PATTERN

#left_coerce?(node) ⇒ Object



71
72
73
# File 'lib/rubocop/cop/style/float_division.rb', line 71

def_node_matcher :left_coerce?, <<~PATTERN
  (send (send _ :to_f) :/ _)
PATTERN

#on_send(node) ⇒ Object



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'lib/rubocop/cop/style/float_division.rb', line 83

def on_send(node)
  return unless offense_condition?(node)

  add_offense(node) do |corrector|
    case style
    when :left_coerce, :single_coerce
      add_to_f_method(corrector, node.receiver)
      remove_to_f_method(corrector, node.first_argument)
    when :right_coerce
      remove_to_f_method(corrector, node.receiver)
      add_to_f_method(corrector, node.first_argument)
    when :fdiv
      correct_from_slash_to_fdiv(corrector, node, node.receiver, node.first_argument)
    end
  end
end

#right_coerce?(node) ⇒ Object



67
68
69
# File 'lib/rubocop/cop/style/float_division.rb', line 67

def_node_matcher :right_coerce?, <<~PATTERN
  (send _ :/ (send _ :to_f))
PATTERN