Class: RuboCop::Cop::Performance::FlatMap

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/performance/flat_map.rb

Overview

This cop is used to identify usages of

Examples:

# bad
[1, 2, 3, 4].map { |e| [e, e] }.flatten(1)
[1, 2, 3, 4].collect { |e| [e, e] }.flatten(1)

# good
[1, 2, 3, 4].flat_map { |e| [e, e] }
[1, 2, 3, 4].map { |e| [e, e] }.flatten
[1, 2, 3, 4].collect { |e| [e, e] }.flatten

Constant Summary collapse

MSG = 
'Use `flat_map` instead of `%s...%s`.'.freeze
FLATTEN_MULTIPLE_LEVELS = 
' Beware, `flat_map` only flattens 1 level ' \
'and `flatten` can be used to flatten ' \
'multiple levels.'.freeze
FLATTEN = 
[:flatten, :flatten!].freeze

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, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

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

Methods included from PathUtil

absolute?, hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/rubocop/cop/performance/flat_map.rb', line 47

def autocorrect(node)
  receiver, _flatten, flatten_param = *node
  flatten_level, = *flatten_param
  return if flatten_level.nil?

  array, = *receiver

  lambda do |corrector|
    range = Parser::Source::Range.new(node.source_range.source_buffer,
                                      node.loc.dot.begin_pos,
                                      node.source_range.end_pos)

    corrector.remove(range)
    corrector.replace(array.loc.selector, 'flat_map')
  end
end

#on_send(node) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/rubocop/cop/performance/flat_map.rb', line 25

def on_send(node)
  left, second_method, flatten_param = *node
  return unless FLATTEN.include?(second_method)
  flatten_level, = *flatten_param
  expression, = *left
  _array, first_method = *expression
  return unless first_method == :map || first_method == :collect

  message = MSG
  if cop_config['EnabledForFlattenWithoutParams'] && flatten_level.nil?
    message = MSG + FLATTEN_MULTIPLE_LEVELS
  elsif flatten_level != 1
    return
  end

  range = Parser::Source::Range.new(node.source_range.source_buffer,
                                    expression.loc.selector.begin_pos,
                                    node.loc.selector.end_pos)

  add_offense(node, range, format(message, first_method, second_method))
end