123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::IpAddresses

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/style/ip_addresses.rb

Overview

Checks for hardcoded IP addresses, which can make code brittle. IP addresses are likely to need to be changed when code is deployed to a different server or environment, which may break a deployment if forgotten. Prefer setting IP addresses in ENV or other configuration.

Examples:

# bad
ip_address = '127.59.241.29'

# good
ip_address = ENV['DEPLOYMENT_IP_ADDRESS']

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

Class Attribute Summary

::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 an 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

Instance Method Summary

::RuboCop::Cop::StringHelp - Included

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

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

This class inherits a constructor from RuboCop::Cop::Base

Instance Method Details

#allowed_addresses (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/ip_addresses.rb', line 50

def allowed_addresses
  allowed_addresses = cop_config['AllowedAddresses']
  Array(allowed_addresses).map(&:downcase)
end

#correct_style_detected

Dummy implementation of method in ConfigurableEnforcedStyle that is called from StringHelp.

[ GitHub ]

  
# File 'lib/rubocop/cop/style/ip_addresses.rb', line 46

def correct_style_detected; end

#could_be_ip?(str) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/ip_addresses.rb', line 55

def could_be_ip?(str)
  # If the string is too long, it can't be an IP
  return false if too_long?(str)

  # If the string doesn't start with a colon or hexadecimal char,
  # we know it's not an IP address
  starts_with_hex_or_colon?(str)
end

#offense?(node) ⇒ Boolean

[ GitHub ]

  
# File 'lib/rubocop/cop/style/ip_addresses.rb', line 27

def offense?(node)
  contents = node.source[1...-1]
  return false if contents.empty?

  return false if allowed_addresses.include?(contents.downcase)

  # To try to avoid doing two regex checks on every string,
  # shortcut out if the string does not look like an IP address
  return false unless could_be_ip?(contents)

  ::Resolv::IPv4::Regex.match?(contents) || ::Resolv::IPv6::Regex.match?(contents)
end

#opposite_style_detected

Dummy implementation of method in ConfigurableEnforcedStyle that is called from StringHelp.

[ GitHub ]

  
# File 'lib/rubocop/cop/style/ip_addresses.rb', line 42

def opposite_style_detected; end

#starts_with_hex_or_colon?(str) ⇒ Boolean (private)

[ GitHub ]

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

def starts_with_hex_or_colon?(str)
  first_char = str[0].ord
  (48..58).cover?(first_char) || (65..70).cover?(first_char) || (97..102).cover?(first_char)
end

#too_long?(str) ⇒ Boolean (private)

[ GitHub ]

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

def too_long?(str)
  str.size > IPV6_MAX_SIZE
end