New rule: Performance/AnyAfterFilter

This commit is contained in:
Vitalii Elenhaupt 2018-09-03 22:45:14 +03:00
parent 068733a9d3
commit a1b34eb7be
No known key found for this signature in database
GPG key ID: 7558EF3A4056C706
3 changed files with 115 additions and 2 deletions

View file

@ -0,0 +1,64 @@
require "../../../spec_helper"
module Ameba::Rule::Performance
subject = AnyAfterFilter.new
describe AnyAfterFilter do
it "passes if there is no potential performance improvements" do
source = Source.new %(
[1, 2, 3].select { |e| e > 1 }.any?(&.zero?)
[1, 2, 3].reject { |e| e > 1 }.any?(&.zero?)
[1, 2, 3].select { |e| e > 1 }
[1, 2, 3].reject { |e| e > 1 }
[1, 2, 3].any? { |e| e > 1 }
)
subject.catch(source).should be_valid
end
it "reports if there is select followed by any? without a block" do
source = Source.new %(
[1, 2, 3].select { |e| e > 2 }.any?
)
subject.catch(source).should_not be_valid
end
it "reports if there is reject followed by any? without a block" do
source = Source.new %(
[1, 2, 3].reject { |e| e > 2 }.any?
)
subject.catch(source).should_not be_valid
end
it "does not report if any? calls contains a block" do
source = Source.new %(
[1, 2, 3].select { |e| e > 2 }.any?(&.zero?)
[1, 2, 3].reject { |e| e > 2 }.any?(&.zero?)
)
subject.catch(source).should be_valid
end
context "properties" do
it "allows to configure object_call_names" do
source = Source.new %(
[1, 2, 3].reject { |e| e > 2 }.any?
)
rule = Rule::Performance::AnyAfterFilter.new
rule.filter_names = %w(select)
rule.catch(source).should be_valid
end
end
it "reports rule, pos and message" do
s = Source.new %(
[1, 2, 3].reject { |e| e > 2 }.any?
), "source.cr"
subject.catch(s).should_not be_valid
issue = s.issues.first
issue.rule.should_not be_nil
issue.location.to_s.should eq "source.cr:2:19"
issue.end_location.to_s.should eq "source.cr:2:44"
issue.message.should eq "Use `any? {...}` instead of `reject {...}.any?`"
end
end
end

View file

@ -0,0 +1,50 @@
module Ameba::Rule::Performance
# This rule is used to identify usage of `any?` calls that follow filters.
#
# For example, this is considered invalid:
#
# ```
# [1, 2, 3].select { |e| e > 2 }.any?
# [1, 2, 3].reject { |e| e >= 2 }.any?
# ```
#
# And it should be written as this:
#
# ```
# [1, 2, 3].any? { |e| e > 2 }
# [1, 2, 3].any? { |e| e < 2 }
# ```
#
# YAML configuration example:
#
# ```
# Performance/AnyAfterFilter:
# Enabled: true
# FilterNames:
# - select
# - reject
# ```
#
struct AnyAfterFilter < Base
ANY_NAME = "any?"
MSG = "Use `#{ANY_NAME} {...}` instead of `%s {...}.#{ANY_NAME}`"
properties do
filter_names : Array(String) = %w(select reject)
description "Identifies usage of `any?` calls that follow filters."
end
def test(source)
AST::NodeVisitor.new self, source
end
def test(source, node : Crystal::Call)
return unless node.name == ANY_NAME && (obj = node.obj)
if node.block.nil? && obj.is_a?(Crystal::Call) &&
filter_names.includes?(obj.name) && !obj.block.nil?
issue_for obj.name_location, node.name_end_location, MSG % obj.name
end
end
end
end

View file

@ -49,7 +49,6 @@ module Ameba::Rule::Performance
if obj.is_a?(Crystal::Call) &&
filter_names.includes?(obj.name) && !obj.block.nil?
issue_for obj.name_location, node.name_end_location, MSG % obj.name
end
end