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

Inherits:
Cop
  • 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.'.freeze

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from RuboCop::Cop::StringHelp

#on_regexp, #on_str

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?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

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

#s

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?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

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 whitelist.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)

  contents =~ ::Resolv::IPv4::Regex || contents =~ ::Resolv::IPv6::Regex
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