Class: RuboCop::Cop::Style::ArrayJoin

Inherits:

Cop

• Object
• Cop
• RuboCop::Cop::Style::ArrayJoin

Defined in:

lib/rubocop/cop/style/array_join.rb

Overview

This cop checks for uses of "*" as a substitute for join.

Not all cases can reliably checked, due to Ruby's dynamic types, so we consider only cases when the first argument is an array literal or the second is a string literal.

Constant Summary

MSG =

'Favor `Array#join` over `Array#*`.'

Constants included from Util

Util::ASGN_NODES, Util::BASIC_LITERALS, Util::EQUALS_ASGN_NODES, Util::LITERALS, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary

• #autocorrect(node) ⇒ Object
• #on_send(node) ⇒ Object

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, qualified_cop_name, rails?, #reference_url, #relevant_file?, #style_guide_url

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search

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, command?, comment_line?, const_name, directions, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

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

# File 'lib/rubocop/cop/style/array_join.rb', line 22

def autocorrect(node)
  receiver_node, _method_name, *arg_nodes = *node
  expr = node.loc.expression
  array = receiver_node.loc.expression.source
  join_arg  = arg_nodes[0].loc.expression.source

  lambda do |corrector|
    corrector.replace(expr, "#{array}.join(#{join_arg})")
  end
end

#on_send(node) ⇒ Object

# File 'lib/rubocop/cop/style/array_join.rb', line 14

def on_send(node)
  receiver_node, method_name, *arg_nodes = *node
  return unless receiver_node && receiver_node.type == :array &&
                method_name == :* && arg_nodes[0].type == :str

  add_offense(node, :selector)
end