Class: RuboCop::Cop::Style::MapJoin

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

Overview

Checks for ‘map { |x| x.to_s }.join` and similar calls where the map is redundant because `Array#join` implicitly calls #to_s on each element.

Examples:

# bad
array.map(&:to_s).join(', ')

# bad
array.map { |x| x.to_s }.join(', ')

# bad
array.collect(&:to_s).join

# good
array.join(', ')

# good
array.join

Constant Summary collapse

MSG = 
'Remove redundant `%<method>s(&:to_s)` before `join`.'
RESTRICT_ON_SEND = 
i[join].freeze

Constants included from RangeHelp

RangeHelp::BYTE_ORDER_MARK, RangeHelp::NOT_GIVEN

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

#map_to_s_block_join?(node) ⇒ Object

map { |x| x.to_s }.join(…)



49
50
51
52
53
54
55
56
 
# File 'lib/rubocop/cop/style/map_join.rb', line 49

def_node_matcher :map_to_s_block_join?, "(call\n  $(block\n    (call _ ${:map :collect})\n    (args (arg _x))\n    (send (lvar _x) :to_s))\n  :join ...)\n"

#map_to_s_itblock_join?(node) ⇒ Object

map { it.to_s }.join(…)



71
72
73
74
75
76
77
78
 
# File 'lib/rubocop/cop/style/map_join.rb', line 71

def_node_matcher :map_to_s_itblock_join?, "(call\n  $(itblock\n    (call _ ${:map :collect})\n    :it\n    (send (lvar :it) :to_s))\n  :join ...)\n"

#map_to_s_join?(node) ⇒ Object

map(&:to_s).join(…)



41
42
43
44
45
 
# File 'lib/rubocop/cop/style/map_join.rb', line 41

def_node_matcher :map_to_s_join?, "(call\n  $(call _ ${:map :collect} (block_pass (sym :to_s)))\n  :join ...)\n"

#map_to_s_numblock_join?(node) ⇒ Object

map { _1.to_s }.join(…)



60
61
62
63
64
65
66
67
 
# File 'lib/rubocop/cop/style/map_join.rb', line 60

def_node_matcher :map_to_s_numblock_join?, "(call\n  $(numblock\n    (call _ ${:map :collect})\n    1\n    (send (lvar :_1) :to_s))\n  :join ...)\n"

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



80
81
82
83
84
85
 
# File 'lib/rubocop/cop/style/map_join.rb', line 80

def on_send(node)
  map_to_s_join?(node) { |m, n| register_offense(node, m, n) } ||
    map_to_s_block_join?(node) { |m, n| register_offense(node, m, n) } ||
    map_to_s_numblock_join?(node) { |m, n| register_offense(node, m, n) } ||
    map_to_s_itblock_join?(node) { |m, n| register_offense(node, m, n) }
end