Class: RuboCop::Cop::Style::ColonMethodCall

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/style/colon_method_call.rb

Overview

This cop checks for methods invoked via the

operator instead

of the . operator (like FileUtils::rmdir instead of FileUtils.rmdir).

Constant Summary collapse

MSG = 
'Do not use `::` for method calls.'.freeze
JAVA_TYPES = 
[:byte, :boolean, :byte, :short, :char,
:int, :long, :float, :double].freeze
JAVA_TYPE_NODES = 
JAVA_TYPES.map { |t| s(:send, s(:const, nil, :Java), t) }

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

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?, block_length, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, ternary_op?, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#allowed_name(method_name) ⇒ Object 



31
32
33
 
# File 'lib/rubocop/cop/style/colon_method_call.rb', line 31

def allowed_name(method_name)
  method_name.match(/^[A-Z]/)
end

#autocorrect(node) ⇒ Object 



35
36
37
 
# File 'lib/rubocop/cop/style/colon_method_call.rb', line 35

def autocorrect(node)
  ->(corrector) { corrector.replace(node.loc.dot, '.') }
end

#on_send(node) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/rubocop/cop/style/colon_method_call.rb', line 18

def on_send(node)
  # ignore Java interop code like Java::int
  return if JAVA_TYPE_NODES.include?(node)

  receiver, method_name, *_args = *node

  # discard methods with nil receivers and op methods(like [])
  return unless receiver && node.loc.dot && node.loc.dot.is?('::')
  return if allowed_name(method_name.to_s)

  add_offense(node, :dot)
end