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

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

Overview

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.'
OCTAL_MSG = 
'Use 0o for octal literals.'
HEX_MSG = 
'Use 0x for hexadecimal literals.'
BINARY_MSG = 
'Use 0b for binary literals.'
DECIMAL_MSG = 
'Do not use prefixes for decimal literals.'

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?, #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_int(node) ⇒ Object 



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

def on_int(node)
  type = literal_type(node)

  return unless type

  add_offense(node) do |corrector|
    corrector.replace(node, send(:"format_#{type}", node.source))
  end
end