Class: RuboCop::Cop::Style::ConcatArrayLiterals

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

Overview

Enforces the use of ‘Array#push(item)` instead of `Array#concat()` to avoid redundant array literals.

Examples:


# bad
list.concat([foo])
list.concat([bar, baz])
list.concat([qux, quux], [corge])

# good
list.push(foo)
list.push(bar, baz)
list.push(qux, quux, corge)

Constant Summary collapse

MSG = 
'Use `%<prefer>s` instead of `%<current>s`.'
MSG_FOR_PERCENT_LITERALS = 
'Use `push` with elements as arguments without array brackets instead of `%<current>s`.'
RESTRICT_ON_SEND = 
%i[concat].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

#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

#on_send(node) ⇒ Object Also known as: on_csend

rubocop:disable Metrics



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/rubocop/cop/style/concat_array_literals.rb', line 34

def on_send(node)
  return if node.arguments.empty?
  return unless node.arguments.all?(&:array_type?)

  offense = offense_range(node)
  current = offense.source

  if (use_percent_literal = node.arguments.any?(&:percent_literal?))
    if percent_literals_includes_only_basic_literals?(node)
      prefer = preferred_method(node)
      message = format(MSG, prefer: prefer, current: current)
    else
      message = format(MSG_FOR_PERCENT_LITERALS, current: current)
    end
  else
    prefer = preferred_method(node)
    message = format(MSG, prefer: prefer, current: current)
  end

  add_offense(offense, message: message) do |corrector|
    if use_percent_literal
      corrector.replace(offense, prefer)
    else
      corrector.replace(node.loc.selector, 'push')
      node.arguments.each do |argument|
        corrector.remove(argument.loc.begin)
        corrector.remove(argument.loc.end)
      end
    end
  end
end