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). eg. for octal use ‘0o` instead of `0` or `0O`.

Can be configured to use ‘0` only for octal literals using `EnforcedOctalStyle` => `zero_only`

Constant Summary collapse

OCTAL_ZERO_ONLY_REGEX = 
/^0[Oo][0-7]+$/
OCTAL_REGEX = 
/^0O?[0-7]+$/
HEX_REGEX = 
/^0X[0-9A-F]+$/
BINARY_REGEX = 
/^0B[01]+$/
DECIMAL_REGEX = 
/^0[dD][0-9]+$/
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::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

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

#s

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 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?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, parenthesized_call?, precede?, range_between, range_by_whole_lines, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, symbol_without_quote?, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, find_file_upwards, 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 



36
37
38
39
40
41
42
 
# File 'lib/rubocop/cop/style/numeric_literal_prefix.rb', line 36

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 



28
29
30
31
32
33
34
 
# File 'lib/rubocop/cop/style/numeric_literal_prefix.rb', line 28

def on_int(node)
  type = literal_type(node)

  return unless type

  add_offense(node)
end