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

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `::RuboCop::Cop::AutoCorrector`, `::RuboCop::Cop::Base`, `::RuboCop::ExcludeLimit`, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain: self, `::RuboCop::Cop::ConfigurableEnforcedStyle`, `::RuboCop::Cop::Base`, `::RuboCop::Cop::AutocorrectLogic`, `::RuboCop::Cop::IgnoredNode`, `::RuboCop::Util`, RuboCop::AST::Sexp
Inherits:	RuboCop::Cop::Base Object RuboCop::Cop::Base RuboCop::Cop::Style::FloatDivision
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.

For Regexp.last_match and nth reference (e.g., $1), it assumes that the value is a string matched by a regular expression, and allows conversion with #to_f.

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

MESSAGES =
# File 'lib/rubocop/cop/style/float_division.rb', line 60

{
  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 =
# File 'lib/rubocop/cop/style/float_division.rb', line 67
```
%i[/].freeze
```

`::RuboCop::Cop::Base` - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

`::RuboCop::Cop::ConfigurableEnforcedStyle` - Included

SYMBOL_TO_STRING_CACHE

Class Attribute Summary

`::RuboCop::Cop::AutoCorrector` - Extended

support_autocorrect?

`::RuboCop::Cop::Base` - Inherited

.gem_requirements, .lint?,
.support_autocorrect?	Returns if class supports autocorrect.
.support_multiple_source?	Override if your cop should be called repeatedly for multiple investigations Between calls to `on_new_investigation` and `on_investigation_end`, the result of `processed_source` will remain constant.

Class Method Summary

`::RuboCop::Cop::Base` - Inherited

.autocorrect_incompatible_with	List of cops that should not try to autocorrect at the same time as this cop.
.badge	Naming.
.callbacks_needed, .cop_name, .department,
.documentation_url	Returns a url to view this cops documentation online.
.exclude_from_registry	Call for abstract Cop classes.
.inherited,
.joining_forces	Override and return the Force class(es) you need to join.
.match?	Returns true if the cop name or the cop namespace matches any of the given names.
.new,
.requires_gem	Register a version requirement for the given gem name.
.restrict_on_send

`::RuboCop::ExcludeLimit` - Extended

exclude_limit	Sets up a configuration option to have an exclude limit tracked.
transform

Instance Attribute Summary

Instance Method Summary

#any_coerce?(node)
#both_coerce?(node)
#left_coerce?(node)
#on_send(node)
#regexp_last_match?(node)
#right_coerce?(node)
#to_f_method?(node)
#add_to_f_method(corrector, node) private
#correct_from_slash_to_fdiv(corrector, node, receiver, argument) private
#extract_receiver_source(node) private
#message(_node) private
#offense_condition?(node) ⇒ Boolean private
#remove_to_f_method(corrector, send_node) private

`::RuboCop::Cop::ConfigurableEnforcedStyle` - Included

#alternative_style, #alternative_styles, #ambiguous_style_detected,
#conflicting_styles_detected	Alias for ConfigurableEnforcedStyle#no_acceptable_style!.
#correct_style_detected, #no_acceptable_style!, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected,
#unrecognized_style_detected	Alias for ConfigurableEnforcedStyle#no_acceptable_style!.

`::RuboCop::Cop::Base` - Inherited

#add_global_offense	Adds an offense that has no particular location.
#add_offense	Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense.
#begin_investigation	Called before any investigation.
#callbacks_needed,
#cop_config	Configuration Helpers.
#cop_name, #excluded_file?,
#external_dependency_checksum	This method should be overridden when a cop’s behavior depends on state that lives outside of these locations:
#inspect,
#message	Gets called if no message is specified when calling `add_offense` or `add_global_offense` Cops are discouraged to override this; instead pass your message directly.
#name	Alias for Base#cop_name.
#offenses,
#on_investigation_end	Called after all on_…
#on_new_investigation	Called before all on_…
#on_other_file	Called instead of all on_…
#parse	There should be very limited reasons for a Cop to do it’s own parsing.
#parser_engine,
#ready	Called between investigations.
#relevant_file?,
#target_gem_version	Returns a gems locked versions (i.e.
#target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument	Reserved for Cop::Cop.
#complete_investigation	Called to complete an investigation.
#correct, #current_corrector,
#current_offense_locations	Reserved for Commissioner:
#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range,
#reset_investigation	Actually private methods.
#use_corrector

`::RuboCop::Cop::AutocorrectLogic` - Included

#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #eol_comment, #eol_comment_would_be_inside_literal?, #heredoc_range, #line_with_eol_comment_too_long?, #max_line_length, #multiline_ranges, #multiline_string?,
#range_by_lines	Expand the given range to include all of any lines it covers.
#range_of_first_line, #string_continuation?, #surrounding_heredoc?, #surrounding_percent_array?

`::RuboCop::Cop::IgnoredNode` - Included

#ignore_node, #ignored_node?, #part_of_ignored_node?, #ignored_nodes

Constructor Details

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

Instance Method Details

#add_to_f_method(corrector, node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/float_division.rb', line 139


def add_to_f_method(corrector, node)
  corrector.insert_after(node, '.to_f') unless node.send_type? && node.method?(:to_f)
end

#any_coerce?(node)

[ GitHub ]

# File 'lib/rubocop/cop/style/float_division.rb', line 82


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

#both_coerce?(node)

[ GitHub ]

# File 'lib/rubocop/cop/style/float_division.rb', line 78


def_node_matcher :both_coerce?, <<~PATTERN
  (send #to_f_method? :/ #to_f_method?)
PATTERN

#correct_from_slash_to_fdiv(corrector, node, receiver, argument) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/float_division.rb', line 148


def correct_from_slash_to_fdiv(corrector, node, receiver, argument)
  receiver_source = extract_receiver_source(receiver)
  argument_source = extract_receiver_source(argument)

  if argument.respond_to?(:parenthesized?) && !argument.parenthesized?
    argument_source = "(#{argument_source})"
  end

  corrector.replace(node, "#{receiver_source}.fdiv#{argument_source}")
end

#extract_receiver_source(node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/float_division.rb', line 159


def extract_receiver_source(node)
  if node.send_type? && node.method?(:to_f)
    node.receiver.source
  else
    node.source
  end
end

#left_coerce?(node)

[ GitHub ]

# File 'lib/rubocop/cop/style/float_division.rb', line 74


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

#message(_node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/float_division.rb', line 135


def message(_node)
  MESSAGES[style]
end

#offense_condition?(node) ⇒ `Boolean` (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/float_division.rb', line 117


def offense_condition?(node)
  return false if regexp_last_match?(node.receiver.receiver) ||
                  regexp_last_match?(node.first_argument.receiver)

  case style
  when :left_coerce
    right_coerce?(node)
  when :right_coerce
    left_coerce?(node)
  when :single_coerce
    both_coerce?(node)
  when :fdiv
    any_coerce?(node)
  else
    false
  end
end

#on_send(node)

[ GitHub ]

# File 'lib/rubocop/cop/style/float_division.rb', line 98


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

#regexp_last_match?(node)

[ GitHub ]

# File 'lib/rubocop/cop/style/float_division.rb', line 91


def_node_matcher :regexp_last_match?, <<~PATTERN
  {
    (send (const {nil? cbase} :Regexp) :last_match int)
    (:nth_ref _)
  }
PATTERN

#remove_to_f_method(corrector, send_node) (private)

[ GitHub ]

# File 'lib/rubocop/cop/style/float_division.rb', line 143


def remove_to_f_method(corrector, send_node)
  corrector.remove(send_node.loc.dot)
  corrector.remove(send_node.loc.selector)
end

#right_coerce?(node)

[ GitHub ]

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


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

#to_f_method?(node)

[ GitHub ]

# File 'lib/rubocop/cop/style/float_division.rb', line 86


def_node_matcher :to_f_method?, <<~PATTERN
  (send !nil? :to_f)
PATTERN

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

Overview

Constant Summary

::RuboCop::Cop::Base - Inherited

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

::RuboCop::Cop::Base - Inherited

Class Method Summary

::RuboCop::Cop::Base - Inherited

::RuboCop::ExcludeLimit - Extended

Instance Attribute Summary

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

::RuboCop::Cop::Base - Inherited

::RuboCop::Cop::AutocorrectLogic - Included

Instance Method Summary

::RuboCop::Cop::ConfigurableEnforcedStyle - Included

::RuboCop::Cop::Base - Inherited

::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

Instance Method Details

#add_to_f_method(corrector, node) (private)

#any_coerce?(node)

#both_coerce?(node)

#correct_from_slash_to_fdiv(corrector, node, receiver, argument) (private)

#extract_receiver_source(node) (private)

#left_coerce?(node)

#message(_node) (private)

#offense_condition?(node) ⇒ Boolean (private)

#on_send(node)

#regexp_last_match?(node)

#remove_to_f_method(corrector, send_node) (private)

#right_coerce?(node)

#to_f_method?(node)

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::Cop::ConfigurableEnforcedStyle` - Included

`::RuboCop::Cop::AutoCorrector` - Extended

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::ExcludeLimit` - Extended

`::RuboCop::Cop::ConfigurableEnforcedStyle` - Included

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::Cop::AutocorrectLogic` - Included

`::RuboCop::Cop::ConfigurableEnforcedStyle` - Included

`::RuboCop::Cop::Base` - Inherited

`::RuboCop::Cop::AutocorrectLogic` - Included

`::RuboCop::Cop::IgnoredNode` - Included

#offense_condition?(node) ⇒ `Boolean` (private)