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

Inherits:
Cop
  • Object
show all
Includes:
FrozenStringLiteral
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.

Constant Summary collapse

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

Empty array node

(send

(const nil :Array) :new)

s(:send, s(:const, nil, :Array), :new)
HASH_NODE =

Empty hash node

(send

(const nil :Hash) :new)

s(:send, s(:const, nil, :Hash), :new)
STR_NODE =

Empty string node

(send

(const nil :String) :new)

s(:send, s(:const, nil, :String), :new)

Constants included from FrozenStringLiteral

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

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

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from FrozenStringLiteral

frozen_string_literal_comment_exists?, frozen_string_literals_enabled?

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?, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, 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?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/rubocop/cop/style/empty_literal.rb', line 51

def autocorrect(node)
  name = case node
         when ARRAY_NODE
           '[]'
         when HASH_NODE
           # `some_method {}` is not same as `some_method Hash.new`
           # because the braces are interpreted as a block, so we avoid
           # the correction. Parentheses around the arguments would
           # solve the problem, but we let the user add those manually.
           return if first_arg_in_method_call_without_parentheses?(node)
           '{}'
         when STR_NODE
           preferred_string_literal
         end
  ->(corrector) { corrector.replace(node.source_range, name) }
end

#on_send(node) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/rubocop/cop/style/empty_literal.rb', line 34

def on_send(node)
  case node
  when ARRAY_NODE
    add_offense(node, :expression, ARR_MSG)
  when HASH_NODE
    # If Hash.new takes a block, it can't be changed to {}.
    return if node.parent && node.parent.block_type?

    add_offense(node, :expression, HASH_MSG)
  when STR_NODE
    return if frozen_string_literals_enabled?(processed_source)

    add_offense(node, :expression,
                format(STR_MSG, preferred_string_literal))
  end
end