Class: RuboCop::Cop::Style::EmptyLiteral

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

Overview

This cop checks for the use of a method, the result of which would be a literal, like an empty array, hash, or string.

Examples:

# bad
a = Array.new
h = Hash.new
s = String.new

# good
a = []
h = {}
s = ''

Constant Summary collapse

ARR_MSG =
'Use array literal `[]` instead of `Array.new`.'
HASH_MSG =
'Use hash literal `{}` instead of `Hash.new`.'
STR_MSG =
'Use string literal `%<prefer>s` instead of `String.new`.'
RESTRICT_ON_SEND =
%i[new].freeze

Constants included from FrozenStringLiteral

FrozenStringLiteral::FROZEN_STRING_LITERAL, FrozenStringLiteral::FROZEN_STRING_LITERAL_ENABLED, FrozenStringLiteral::FROZEN_STRING_LITERAL_TYPES

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods included from FrozenStringLiteral

frozen_string_literal_comment_exists?

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 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

#array_node(node) ⇒ Object


31
# File 'lib/rubocop/cop/style/empty_literal.rb', line 31

def_node_matcher :array_node, '(send (const {nil? cbase} :Array) :new)'

#array_with_block(node) ⇒ Object


40
41
# File 'lib/rubocop/cop/style/empty_literal.rb', line 40

def_node_matcher :array_with_block,
'(block (send (const {nil? cbase} :Array) :new) args _)'

#hash_node(node) ⇒ Object


34
# File 'lib/rubocop/cop/style/empty_literal.rb', line 34

def_node_matcher :hash_node, '(send (const {nil? cbase} :Hash) :new)'

#hash_with_block(node) ⇒ Object


44
45
46
47
48
49
# File 'lib/rubocop/cop/style/empty_literal.rb', line 44

def_node_matcher :hash_with_block, <<~PATTERN
  {
    (block (send (const {nil? cbase} :Hash) :new) args _)
    (numblock (send (const {nil? cbase} :Hash) :new) ...)
  }
PATTERN

#on_send(node) ⇒ Object


51
52
53
54
55
56
57
# File 'lib/rubocop/cop/style/empty_literal.rb', line 51

def on_send(node)
  return unless (message = offense_message(node))

  add_offense(node, message: message) do |corrector|
    corrector.replace(replacement_range(node), correction(node))
  end
end

#str_node(node) ⇒ Object


37
# File 'lib/rubocop/cop/style/empty_literal.rb', line 37

def_node_matcher :str_node, '(send (const {nil? cbase} :String) :new)'