Sha256: 28244473743e9df17aeeaf2f8ff494b5ee40c4ada974d9102d1d836c7d245272
Contents?: true
Size: 1.88 KB
Versions: 27
Compression:
Stored size: 1.88 KB
Contents
# frozen_string_literal: true
module RuboCop
module Cop
module Style
# This cop enforces the use of consistent method names
# from the Enumerable module.
#
# Unfortunately we cannot actually know if a method is from
# Enumerable or not (static analysis limitation), so this cop
# can yield some false positives.
#
# You can customize the mapping from undesired method to desired method.
#
# e.g. to use `detect` over `find`:
#
# Style/CollectionMethods:
# PreferredMethods:
# find: detect
#
# The default mapping for `PreferredMethods` behaves as follows.
#
# @example
# # bad
# items.collect
# items.collect!
# items.inject
# items.detect
# items.find_all
# items.member?
#
# # good
# items.map
# items.map!
# items.reduce
# items.find
# items.select
# items.include?
#
class CollectionMethods < Base
include MethodPreference
extend AutoCorrector
MSG = 'Prefer `%<prefer>s` over `%<current>s`.'
def on_block(node)
check_method_node(node.send_node)
end
def on_send(node)
return unless node.arguments.one? && node.first_argument.block_pass_type?
check_method_node(node)
end
private
def check_method_node(node)
return unless preferred_methods[node.method_name]
message = message(node)
add_offense(node.loc.selector, message: message) do |corrector|
corrector.replace(node.loc.selector, preferred_method(node.loc.selector.source))
end
end
def message(node)
format(MSG, prefer: preferred_method(node.method_name), current: node.method_name)
end
end
end
end
end
Version data entries
27 entries across 27 versions & 3 rubygems