-
-
Notifications
You must be signed in to change notification settings - Fork 81
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add new Performance/CollectionLiteralInLoop
cop
#140
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
140 changes: 140 additions & 0 deletions
140
lib/rubocop/cop/performance/collection_literal_in_loop.rb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,140 @@ | ||
# frozen_string_literal: true | ||
|
||
require 'set' | ||
|
||
module RuboCop | ||
module Cop | ||
module Performance | ||
# This cop identifies places where Array and Hash literals are used | ||
# within loops. It is better to extract them into a local variable or constant | ||
# to avoid unnecessary allocations on each iteration. | ||
# | ||
# You can set the minimum number of elements to consider | ||
# an offense with `MinSize`. | ||
# | ||
# @example | ||
# # bad | ||
# users.select do |user| | ||
# %i[superadmin admin].include?(user.role) | ||
# end | ||
# | ||
# # good | ||
# admin_roles = %i[superadmin admin] | ||
# users.select do |user| | ||
# admin_roles.include?(user.role) | ||
# end | ||
# | ||
# # good | ||
# ADMIN_ROLES = %i[superadmin admin] | ||
# ... | ||
# users.select do |user| | ||
# ADMIN_ROLES.include?(user.role) | ||
# end | ||
# | ||
class CollectionLiteralInLoop < Cop | ||
MSG = 'Avoid immutable %<literal_class>s literals in loops. '\ | ||
'It is better to extract it into a local variable or a constant.' | ||
|
||
POST_CONDITION_LOOP_TYPES = %i[while_post until_post].freeze | ||
LOOP_TYPES = (POST_CONDITION_LOOP_TYPES + %i[while until for]).freeze | ||
|
||
ENUMERABLE_METHOD_NAMES = (Enumerable.instance_methods + [:each]).to_set.freeze | ||
NONMUTATING_ARRAY_METHODS = %i[& * + - <=> == [] all? any? assoc at | ||
bsearch bsearch_index collect combination | ||
compact count cycle deconstruct difference dig | ||
drop drop_while each each_index empty? eql? | ||
fetch filter find_index first flatten hash | ||
include? index inspect intersection join | ||
last length map max min minmax none? one? pack | ||
permutation product rassoc reject | ||
repeated_combination repeated_permutation reverse | ||
reverse_each rindex rotate sample select shuffle | ||
size slice sort sum take take_while | ||
to_a to_ary to_h to_s transpose union uniq | ||
values_at zip |].freeze | ||
|
||
ARRAY_METHODS = (ENUMERABLE_METHOD_NAMES | NONMUTATING_ARRAY_METHODS).to_set.freeze | ||
|
||
NONMUTATING_HASH_METHODS = %i[< <= == > >= [] any? assoc compact dig | ||
each each_key each_pair each_value empty? | ||
eql? fetch fetch_values filter flatten has_key? | ||
has_value? hash include? inspect invert key key? | ||
keys? length member? merge rassoc rehash reject | ||
select size slice to_a to_h to_hash to_proc to_s | ||
transform_keys transform_values value? values values_at].freeze | ||
|
||
HASH_METHODS = (ENUMERABLE_METHOD_NAMES | NONMUTATING_HASH_METHODS).to_set.freeze | ||
|
||
def_node_matcher :kernel_loop?, <<~PATTERN | ||
(block | ||
(send {nil? (const nil? :Kernel)} :loop) | ||
...) | ||
PATTERN | ||
|
||
def_node_matcher :enumerable_loop?, <<~PATTERN | ||
(block | ||
(send $_ #enumerable_method? ...) | ||
...) | ||
PATTERN | ||
|
||
def on_send(node) | ||
receiver, method, = *node.children | ||
return unless check_literal?(receiver, method) && parent_is_loop?(receiver) | ||
|
||
message = format(MSG, literal_class: literal_class(receiver)) | ||
add_offense(receiver, message: message) | ||
end | ||
|
||
private | ||
|
||
def check_literal?(node, method) | ||
!node.nil? && | ||
nonmutable_method_of_array_or_hash?(node, method) && | ||
node.children.size >= min_size && | ||
node.recursive_basic_literal? | ||
end | ||
|
||
def nonmutable_method_of_array_or_hash?(node, method) | ||
(node.array_type? && ARRAY_METHODS.include?(method)) || | ||
(node.hash_type? && HASH_METHODS.include?(method)) | ||
end | ||
|
||
def parent_is_loop?(node) | ||
node.each_ancestor.any? { |ancestor| loop?(ancestor, node) } | ||
end | ||
|
||
def loop?(ancestor, node) | ||
keyword_loop?(ancestor.type) || | ||
kernel_loop?(ancestor) || | ||
node_within_enumerable_loop?(node, ancestor) | ||
end | ||
|
||
def keyword_loop?(type) | ||
LOOP_TYPES.include?(type) | ||
end | ||
|
||
def node_within_enumerable_loop?(node, ancestor) | ||
enumerable_loop?(ancestor) do |receiver| | ||
receiver != node && !receiver.descendants.include?(node) | ||
end | ||
end | ||
|
||
def literal_class(node) | ||
if node.array_type? | ||
'Array' | ||
elsif node.hash_type? | ||
'Hash' | ||
end | ||
end | ||
|
||
def enumerable_method?(method_name) | ||
ENUMERABLE_METHOD_NAMES.include?(method_name) | ||
end | ||
|
||
def min_size | ||
Integer(cop_config['MinSize'] || 1) | ||
end | ||
end | ||
end | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't this have been
pending
?