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

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

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?, compatible_external_encoding_for?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, hard_to_type?, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_supported_styles, 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 



39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/rubocop/cop/performance/flat_map.rb', line 39

def autocorrect(node)
  map_node, _first_method, _flatten, params = flat_map_candidate?(node)
  flatten_level, = *params.first
  return if flatten_level.nil?

  lambda do |corrector|
    range = range_between(node.loc.dot.begin_pos,
                          node.source_range.end_pos)

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

#on_send(node) ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/rubocop/cop/performance/flat_map.rb', line 27

def on_send(node)
  flat_map_candidate?(node) do |map_node, first_method, flatten, params|
    flatten_level, = *params.first
    if cop_config['EnabledForFlattenWithoutParams'] &&
       flatten_level.nil?
      offense_for_levels(node, map_node, first_method, flatten)
    elsif flatten_level == 1
      offense_for_method(node, map_node, first_method, flatten)
    end
  end
end