Class: RuboCop::Cop::Style::SymbolProc

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

Overview

Use symbols as procs when possible.

Examples:

# bad
something.map { |s| s.upcase }

# good
something.map(&:upcase)

Constant Summary collapse

MSG = 
'Pass `&:%<method>s` as an argument to `%<block_method>s` ' \
'instead of a block.'
SUPER_TYPES = 
%i[super zsuper].freeze

Constants inherited from Base

Base::RESTRICT_ON_SEND

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Class Method Summary collapse

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#add_global_offense, #add_offense, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

add_parentheses, args_begin, args_end, begins_its_line?, comment_line?, comment_lines?, double_quotes_required?, escape_string, first_part_of_call_chain, indent, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file?, hidden_file_in_not_hidden_dir?, match_path?, maybe_hidden_file?, relative_path, smart_path

Constructor Details

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

Class Method Details

.autocorrect_incompatible_with ⇒ Object 


31
32
33
 
# File 'lib/rubocop/cop/style/symbol_proc.rb', line 31

def self.autocorrect_incompatible_with
  [Layout::SpaceBeforeBlockBraces]
end

Instance Method Details

#destructuring_block_argument?(argument_node) ⇒ Boolean

Returns:

  • (Boolean) 

49
50
51
 
# File 'lib/rubocop/cop/style/symbol_proc.rb', line 49

def destructuring_block_argument?(argument_node)
  argument_node.one? && argument_node.source.include?(',')
end

#on_block(node) ⇒ Object 


35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/rubocop/cop/style/symbol_proc.rb', line 35

def on_block(node)
  symbol_proc?(node) do |dispatch_node, arguments_node, method_name|
    # TODO: Rails-specific handling that we should probably make
    # configurable - https://github.com/rubocop-hq/rubocop/issues/1485
    # we should ignore lambdas & procs
    return if proc_node?(dispatch_node)
    return if %i[lambda proc].include?(dispatch_node.method_name)
    return if ignored_method?(dispatch_node.method_name)
    return if destructuring_block_argument?(arguments_node)

    register_offense(node, method_name, dispatch_node.method_name)
  end
end