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

Inherits:
Base
  • Object
show all
Includes:
RuboCop::Cop::StringHelp
Defined in:
lib/rubocop/cop/style/ip_addresses.rb

Overview

This cop 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 collapse

IPV6_MAX_SIZE =

IPv4-mapped IPv6 is the longest

45
MSG =
'Do not hardcode IP addresses.'

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 RuboCop::Cop::StringHelp

#on_regexp, #on_str

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #ready, #relevant_file?, 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?, #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

#correct_style_detectedObject

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


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

def correct_style_detected; end

#offense?(node) ⇒ Boolean

Returns:

  • (Boolean)

27
28
29
30
31
32
33
34
35
36
37
38
# 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_detectedObject

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


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

def opposite_style_detected; end