Class: RuboCop::Cop::Style::NumericLiteralPrefix

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

Overview

This cop checks for octal, hex, binary, and decimal literals using uppercase prefixes and corrects them to lowercase prefix or no prefix (in case of decimals).

Examples:

EnforcedOctalStyle: zero_with_o (default)

# bad - missing octal prefix
num = 01234

# bad - uppercase prefix
num = 0O1234
num = 0X12AB
num = 0B10101

# bad - redundant decimal prefix
num = 0D1234
num = 0d1234

# good
num = 0o1234
num = 0x12AB
num = 0b10101
num = 1234

EnforcedOctalStyle: zero_only

# bad
num = 0o1234
num = 0O1234

# good
num = 01234

Constant Summary collapse

OCTAL_ZERO_ONLY_REGEX =
/^0[Oo][0-7]+$/.freeze
OCTAL_REGEX =
/^0O?[0-7]+$/.freeze
HEX_REGEX =
/^0X[0-9A-F]+$/.freeze
BINARY_REGEX =
/^0B[01]+$/.freeze
DECIMAL_REGEX =
/^0[dD][0-9]+$/.freeze
OCTAL_ZERO_ONLY_MSG =
'Use 0 for octal literals.'.freeze
OCTAL_MSG =
'Use 0o for octal literals.'.freeze
HEX_MSG =
'Use 0x for hexadecimal literals.'.freeze
BINARY_MSG =
'Use 0b for binary literals.'.freeze
DECIMAL_MSG =
'Do not use prefixes for decimal literals.'.freeze

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, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #messages, non_rails, #parse, qualified_cop_name, #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?, #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

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



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

def autocorrect(node)
  lambda do |corrector|
    type = literal_type(node)
    corrector.replace(node.source_range,
                      send(:"format_#{type}", node.source))
  end
end

#on_int(node) ⇒ Object



51
52
53
54
55
56
57
# File 'lib/rubocop/cop/style/numeric_literal_prefix.rb', line 51

def on_int(node)
  type = literal_type(node)

  return unless type

  add_offense(node)
end