Class: RuboCop::Cop::Lint::UselessRuby2Keywords

Inherits:
Base
  • Object
show all
Defined in:
lib/rubocop/cop/lint/useless_ruby2_keywords.rb

Overview

Looks for ‘ruby2_keywords` calls for methods that do not need it.

‘ruby2_keywords` should only be called on methods that accept an argument splat (`*args`) but do not explicit keyword arguments (`k:` or `k: true`) or a keyword splat (`**kwargs`).

Examples:

# good (splat argument without keyword arguments)
ruby2_keywords def foo(*args); end

# bad (no arguments)
ruby2_keywords def foo; end

# good
def foo; end

# bad (positional argument)
ruby2_keywords def foo(arg); end

# good
def foo(arg); end

# bad (double splatted argument)
ruby2_keywords def foo(**args); end

# good
def foo(**args); end

# bad (keyword arguments)
ruby2_keywords def foo(i:, j:); end

# good
def foo(i:, j:); end

# bad (splat argument with keyword arguments)
ruby2_keywords def foo(*args, i:, j:); end

# good
def foo(*args, i:, j:); end

# bad (splat argument with double splat)
ruby2_keywords def foo(*args, **kwargs); end

# good
def foo(*args, **kwargs); end

# bad (ruby2_keywords given a symbol)
def foo; end
ruby2_keywords :foo

# good
def foo; end

# bad (ruby2_keywords with dynamic method)
define_method(:foo) { |arg| }
ruby2_keywords :foo

# good
define_method(:foo) { |arg| }

Constant Summary collapse

MSG = 
'`ruby2_keywords` is unnecessary for method `%<method_name>s`.'
RESTRICT_ON_SEND = 
%i[ruby2_keywords].freeze

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods inherited from Base

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

#method_definition(node, method_name) ⇒ Object

Looks for statically or dynamically defined methods with a given name



72
73
74
75
76
77
 
# File 'lib/rubocop/cop/lint/useless_ruby2_keywords.rb', line 72

def_node_matcher :method_definition, <<~PATTERN
  {
    (def %1 ...)
    ({block numblock} (send _ :define_method (sym %1)) ...)
  }
PATTERN

#on_send(node) ⇒ Object 



79
80
81
82
83
84
85
86
87
 
# File 'lib/rubocop/cop/lint/useless_ruby2_keywords.rb', line 79

def on_send(node)
  return unless (first_argument = node.first_argument)

  if first_argument.def_type?
    inspect_def(node, first_argument)
  elsif node.first_argument.sym_type?
    inspect_sym(node, first_argument)
  end
end