Class: RuboCop::Cop::Lint::NumberConversion

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/lint/number_conversion.rb

Overview

This cop warns the usage of unsafe number conversions. Unsafe number conversion can cause unexpected error if auto type conversion fails. Cop prefer parsing with number class instead.

Examples:


# bad

'10'.to_i
'10.2'.to_f
'10'.to_c

# good

Integer('10', 10)
Float('10.2')
Complex('10')

Constant Summary collapse

CONVERSION_METHOD_CLASS_MAPPING =
{
  to_i: "#{Integer.name}(%<number_object>s, 10)",
  to_f: "#{Float.name}(%<number_object>s)",
  to_c: "#{Complex.name}(%<number_object>s)"
}.freeze
MSG =
'Replace unsafe number conversion with number '\
'class parsing, instead of using '\
'%<number_object>s.%<to_method>s, use stricter '\
'%<corrected_method>s.'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

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, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

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 AST::Sexp

#s

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #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


56
57
58
59
60
61
# File 'lib/rubocop/cop/lint/number_conversion.rb', line 56

def autocorrect(node)
  lambda do |corrector|
    corrector.replace(node.loc.expression,
                      correct_method(node, node.receiver))
  end
end

#on_send(node) ⇒ Object


42
43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/rubocop/cop/lint/number_conversion.rb', line 42

def on_send(node)
  to_method(node) do |receiver, to_method|
    next if date_time_object?(receiver)

    message = format(
      MSG,
      number_object: receiver.source,
      to_method: to_method,
      corrected_method: correct_method(node, receiver)
    )
    add_offense(node, message: message)
  end
end