123456789_123456789_123456789_123456789_123456789_

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

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::IntegerNode, ::RuboCop::Cop::Base, ::RuboCop::Cop::AutocorrectLogic, ::RuboCop::Cop::IgnoredNode, ::RuboCop::Util, RuboCop::AST::Sexp
Inherits: RuboCop::Cop::Base
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

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

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

::RuboCop::Cop::Base - Inherited

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #processed_source, #string_literals_frozen_by_default?, #target_satisfies_all_gem_version_requirements?

::RuboCop::Cop::AutocorrectLogic - Included

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Instance Method Summary

::RuboCop::Cop::IntegerNode - Included

#integer_part

::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_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, #max_line_length,
#range_by_lines

Expand the given range to include all of any lines it covers.
#range_of_first_line, #range_overlaps_offense?, #string_continuation, #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 Attribute Details

#octal_zero_only? ⇒ Boolean (readonly, private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/style/numeric_literal_prefix.rb', line 93



def octal_zero_only?
  cop_config['EnforcedOctalStyle'] == 'zero_only'
end


  







Instance Method Details



  

    #format_binary(source)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/numeric_literal_prefix.rb', line 109



def format_binary(source)
  source.sub(/^0B/, '0b')
end


  








  

    #format_decimal(source)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/numeric_literal_prefix.rb', line 113



def format_decimal(source)
  source.sub(/^0[dD]/, '')
end


  








  

    #format_hex(source)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/numeric_literal_prefix.rb', line 105



def format_hex(source)
  source.sub(/^0X/, '0x')
end


  








  

    #format_octal(source)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/numeric_literal_prefix.rb', line 97



def format_octal(source)
  source.sub(/^0O?/, '0o')
end


  








  

    #format_octal_zero_only(source)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/numeric_literal_prefix.rb', line 101



def format_octal_zero_only(source)
  source.sub(/^0[Oo]?/, '0')
end


  








  

    #hex_bin_dec_literal_type(literal)   (private)
  

  [ GitHub ]


  

  


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



def hex_bin_dec_literal_type(literal)
  case literal
  when HEX_REGEX
    :hex
  when BINARY_REGEX
    :binary
  when DECIMAL_REGEX
    :decimal
  end
end


  








  

    #literal_type(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/numeric_literal_prefix.rb', line 68



def literal_type(node)
  literal = integer_part(node)

  octal_literal_type(literal) || hex_bin_dec_literal_type(literal)
end


  








  

    #message(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/numeric_literal_prefix.rb', line 64



def message(node)
  self.class.const_get(:"#{literal_type(node).upcase}_MSG")
end


  








  

    #octal_literal_type(literal)   (private)
  

  [ GitHub ]


  

  


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



def octal_literal_type(literal)
  if OCTAL_ZERO_ONLY_REGEX.match?(literal) && octal_zero_only?
    :octal_zero_only
  elsif OCTAL_REGEX.match?(literal) && !octal_zero_only?
    :octal
  end
end


  








  

    #on_int(node)  
  

  [ GitHub ]


  

  


# 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