Class: RuboCop::Cop::Style::StderrPuts

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/style/stderr_puts.rb

Overview

This cop identifies places where `$stderr.puts` can be replaced by `warn`. The latter has the advantage of easily being disabled by, the `-W0` interpreter flag or setting `$VERBOSE` to `nil`.

Examples:

# bad
$stderr.puts('hello')

# good
warn('hello')

Constant Summary collapse

MSG =
'Use `warn` instead of `%<bad>s` to allow such output to be disabled.'
RESTRICT_ON_SEND =
%i[puts].freeze

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

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?, #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

#on_send(node) ⇒ Object


32
33
34
35
36
37
38
39
# File 'lib/rubocop/cop/style/stderr_puts.rb', line 32

def on_send(node)
  return unless stderr_puts?(node)

  message = message(node)
  add_offense(stderr_puts_range(node), message: message) do |corrector|
    corrector.replace(stderr_puts_range(node), 'warn')
  end
end

#stderr_puts?(node) ⇒ Object


25
26
27
28
29
30
# File 'lib/rubocop/cop/style/stderr_puts.rb', line 25

def_node_matcher :stderr_puts?, <<~PATTERN
  (send
    {(gvar #stderr_gvar?) (const {nil? cbase} :STDERR)}
    :puts $_
    ...)
PATTERN