Class: RuboCop::Cop::Lint::Void

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

Overview

This cop checks for operators, variables, literals, and nonmutating methods used in void context.

Examples:

CheckForMethodsWithNoSideEffects: false (default)

# bad
def some_method
  some_num * 10
  do_something
end

def some_method(some_var)
  some_var
  do_something
end

CheckForMethodsWithNoSideEffects: true

# bad
def some_method(some_array)
  some_array.sort
  do_something(some_array)
end

# good
def some_method
  do_something
  some_num * 10
end

def some_method(some_var)
  do_something
  some_var
end

def some_method(some_array)
  some_array.sort!
  do_something(some_array)
end

Constant Summary collapse

OP_MSG =
'Operator `%<op>s` used in void context.'
VAR_MSG =
'Variable `%<var>s` used in void context.'
LIT_MSG =
'Literal `%<lit>s` used in void context.'
SELF_MSG =
'`self` used in void context.'
DEFINED_MSG =
'`%<defined>s` used in void context.'
NONMUTATING_MSG =
'Method `#%<method>s` used in void context. ' \
'Did you mean `#%<method>s!`?'
BINARY_OPERATORS =
%i[* / % + - == === != < > <= >= <=>].freeze
UNARY_OPERATORS =
%i[[email protected] [email protected] ~ !].freeze
OPERATORS =
(BINARY_OPERATORS + UNARY_OPERATORS).freeze
VOID_CONTEXT_TYPES =
%i[def for block].freeze
NONMUTATING_METHODS =
%i[capitalize chomp chop collect compact
delete_prefix delete_suffix downcase
encode flatten gsub lstrip map merge next
reject reverse rotate rstrip scrub select
shuffle slice sort sort_by squeeze strip sub
succ swapcase tr tr_s transform_values
unicode_normalize uniq upcase].freeze

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

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, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

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

#on_begin(node) ⇒ Object Also known as: on_kwbegin


71
72
73
# File 'lib/rubocop/cop/lint/void.rb', line 71

def on_begin(node)
  check_begin(node)
end

#on_block(node) ⇒ Object


64
65
66
67
68
69
# File 'lib/rubocop/cop/lint/void.rb', line 64

def on_block(node)
  return unless node.body && !node.body.begin_type?
  return unless in_void_context?(node.body)

  check_expression(node.body)
end