123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::NumericLiterals

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::AllowedPattern, ::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_literals.rb

Overview

Checks for big numeric literals without _ between groups of digits in them.

Additional allowed patterns can be added by adding regexps to the AllowedPatterns configuration. All regexps are treated as anchored even if the patterns do not contain anchors (so \d{4}_\d{4} will allow 1234_5678 but not 1234_5678_9012).

Note
 Even if AllowedPatterns are given, autocorrection will only correct to the standard pattern of an _ every 3 digits.

Examples:

# bad
1000000
1_00_000
1_0000

# good
1_000_000
1000

Strict: false (default)

# good
10_000_00 # typical representation of $10,000 in cents

Strict: true

# bad
10_000_00 # typical representation of $10,000 in cents

AllowedNumbers: [3000]

# good
3000 # You can specify allowed numbers. (e.g. port number)

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.
.builtin?

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

Cops (other than builtin) are encouraged to implement this.
.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, #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::AllowedPattern - Included

#allowed_line?, #allowed_patterns, #cop_config_deprecated_methods_values, #cop_config_patterns_values,
#ignored_line?

Alias for AllowedPattern#allowed_line?.
#matches_allowed_pattern?,
#matches_ignored_pattern?

Alias for AllowedPattern#matches_allowed_pattern?.

::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, #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, #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 Method Details

#allowed_numbers (private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/style/numeric_literals.rb', line 118



def allowed_numbers
  cop_config.fetch('AllowedNumbers', []).map(&:to_s)
end


  








  

    #allowed_patterns   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/numeric_literals.rb', line 122



def allowed_patterns
  # Convert the patterns to be anchored
  super.map { |regexp| /\A#{regexp}\z/ }
end


  








  

    #check(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/numeric_literals.rb', line 66



def check(node)
  int = integer_part(node)
  # TODO: handle non-decimal literals as well
  return if int.start_with?('0')
  return if allowed_numbers.include?(int)
  return if matches_allowed_pattern?(int)
  return unless int.size >= min_digits

  case int
  when /^\d+$/
    register_offense(node) { self.min_digits = int.size + 1 }
  when /\d{4}/, short_group_regex
    register_offense(node) { self.config_to_allow_offenses = { 'Enabled' => false } }
  end
end


  








  

    #format_int_part(int_part)   (private)
  



  

    
  





  
Parameters:





  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/numeric_literals.rb', line 107



def format_int_part(int_part)
  int_part = Integer(int_part)
  formatted_int = int_part.abs.to_s.reverse.gsub(/...(?=.)/, '\&_').reverse
  formatted_int.insert(0, '-') if int_part.negative?
  formatted_int
end


  








  

    #format_number(node)   (private)
  

  [ GitHub ]


  

  


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



def format_number(node)
  source = node.source.gsub(/\s+/, '')
  int_part, additional_part = source.split(DELIMITER_REGEXP, 2)
  formatted_int = format_int_part(int_part)
  delimiter = source[DELIMITER_REGEXP]

  if additional_part
    formatted_int + delimiter + additional_part
  else
    formatted_int
  end
end


  








  

    #min_digits   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/numeric_literals.rb', line 114



def min_digits
  cop_config['MinDigits']
end


  








  

    #on_float(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/numeric_literals.rb', line 60



def on_float(node)
  check(node)
end


  








  

    #on_int(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/numeric_literals.rb', line 56



def on_int(node)
  check(node)
end


  








  

    #register_offense(node, &_block)   (private)
  

  [ GitHub ]


  

  


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



def register_offense(node, &_block)
  add_offense(node) do |corrector|
    yield
    corrector.replace(node, format_number(node))
  end
end


  








  

    #short_group_regex   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/numeric_literals.rb', line 89



def short_group_regex
  cop_config['Strict'] ? /_\d{1,2}(_|$)/ : /_\d{1,2}_/
end