Add expect_issue and expect_no_issues spec helpers (#245)

This commit is contained in:
fn ⌃ ⌥ 2021-10-22 10:54:39 -07:00 committed by GitHub
parent 48b15b9bf8
commit 3d432fdee8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 609 additions and 126 deletions

View file

@ -5,7 +5,7 @@ module Ameba::Rule::Lint
describe DebuggerStatement do
it "passes if there is no debugger statement" do
s = Source.new %(
expect_no_issues subject, %(
"this is not a debugger statement"
s = "debugger"
@ -19,16 +19,15 @@ module Ameba::Rule::Lint
end
A.new.debugger
)
subject.catch(s).should be_valid
end
it "fails if there is a debugger statement" do
s = Source.new %(
expect_issue subject, %(
a = 2
debugger
# ^{} error: Possible forgotten debugger statement detected
a = a + 1
)
subject.catch(s).should_not be_valid
end
it "reports rule, pos and message" do

View file

@ -5,21 +5,20 @@ module Ameba::Rule::Lint
describe DuplicatedRequire do
it "passes if there are no duplicated requires" do
source = Source.new %(
expect_no_issues subject, %(
require "math"
require "big"
require "big/big_decimal"
)
subject.catch(source).should be_valid
end
it "reports if there are a duplicated requires" do
source = Source.new %(
expect_issue subject, %(
require "big"
require "math"
require "big"
# ^{} error: Duplicated require of `big`
)
subject.catch(source).should_not be_valid
end
it "reports rule, pos and message" do

View file

@ -5,7 +5,7 @@ module Ameba::Rule::Lint
subject = SharedVarInFiber.new
it "doesn't report if there is only local shared var in fiber" do
s = Source.new %(
expect_no_issues subject, %(
spawn do
i = 1
puts i
@ -13,11 +13,10 @@ module Ameba::Rule::Lint
Fiber.yield
)
subject.catch(s).should be_valid
end
it "doesn't report if there is only block shared var in fiber" do
s = Source.new %(
expect_no_issues subject, %(
10.times do |i|
spawn do
puts i
@ -26,11 +25,10 @@ module Ameba::Rule::Lint
Fiber.yield
)
subject.catch(s).should be_valid
end
it "doesn't report if there a spawn macro is used" do
s = Source.new %(
expect_no_issues subject, %(
i = 0
while i < 10
spawn puts(i)
@ -39,26 +37,25 @@ module Ameba::Rule::Lint
Fiber.yield
)
subject.catch(s).should be_valid
end
it "reports if there is a shared var in spawn" do
s = Source.new %(
expect_issue subject, %(
i = 0
while i < 10
spawn do
puts(i)
# ^ error: Shared variable `i` is used in fiber
end
i += 1
end
Fiber.yield
)
subject.catch(s).should_not be_valid
end
it "reports reassigned reference to shared var in spawn" do
s = Source.new %(
expect_issue subject, %(
channel = Channel(String).new
n = 0
@ -66,15 +63,15 @@ module Ameba::Rule::Lint
n = n + 1
spawn do
m = n
# ^ error: Shared variable `n` is used in fiber
channel.send m
end
end
)
subject.catch(s).should_not be_valid
end
it "doesn't report reassigned reference to shared var in block" do
s = Source.new %(
expect_no_issues subject, %(
channel = Channel(String).new
n = 0
@ -86,49 +83,37 @@ module Ameba::Rule::Lint
end
end
)
subject.catch(s).should be_valid
end
it "does not report block is called in a spawn" do
s = Source.new %(
expect_no_issues subject, %(
def method(block)
spawn do
block.call(10)
end
end
)
subject.catch(s).should be_valid
end
it "reports multiple shared variables in spawn" do
s = Source.new %(
expect_issue subject, %(
foo, bar, baz = 0, 0, 0
while foo < 10
baz += 1
spawn do
puts foo
# ^^^ error: Shared variable `foo` is used in fiber
puts foo + bar + baz
# ^^^ error: Shared variable `foo` is used in fiber
# ^^^ error: Shared variable `baz` is used in fiber
end
foo += 1
end
)
subject.catch(s).should_not be_valid
s.issues.size.should eq 3
s.issues[0].location.to_s.should eq ":5:10"
s.issues[0].end_location.to_s.should eq ":5:12"
s.issues[0].message.should eq "Shared variable `foo` is used in fiber"
s.issues[1].location.to_s.should eq ":6:10"
s.issues[1].end_location.to_s.should eq ":6:12"
s.issues[1].message.should eq "Shared variable `foo` is used in fiber"
s.issues[2].location.to_s.should eq ":6:22"
s.issues[2].end_location.to_s.should eq ":6:24"
s.issues[2].message.should eq "Shared variable `baz` is used in fiber"
end
it "doesn't report if variable is passed to the proc" do
s = Source.new %(
expect_no_issues subject, %(
i = 0
while i < 10
proc = ->(x : Int32) do
@ -140,20 +125,18 @@ module Ameba::Rule::Lint
i += 1
end
)
subject.catch(s).should be_valid
end
it "doesn't report if a channel is declared in outer scope" do
s = Source.new %(
expect_no_issues subject, %(
channel = Channel(Nil).new
spawn { channel.send(nil) }
channel.receive
)
subject.catch(s).should be_valid
end
it "doesn't report if there is a loop in spawn" do
s = Source.new %(
expect_no_issues subject, %(
channel = Channel(String).new
spawn do
@ -164,34 +147,30 @@ module Ameba::Rule::Lint
end
end
)
subject.catch(s).should be_valid
end
it "doesn't report if a var is mutated in spawn and referenced outside" do
s = Source.new %(
expect_no_issues subject, %(
def method
foo = 1
spawn { foo = 2 }
foo
end
)
subject.catch(s).should be_valid
end
it "doesn't report if variable is changed without iterations" do
s = Source.new %(
expect_no_issues subject, %(
def foo
i = 0
i += 1
spawn { i }
end
), "source.cr"
subject.catch(s).should be_valid
)
end
it "doesn't report if variable is in a loop inside spawn" do
s = Source.new %(
expect_no_issues subject, %(
i = 0
spawn do
while i < 10
@ -199,19 +178,15 @@ module Ameba::Rule::Lint
end
end
)
subject.catch(s).should be_valid
end
it "doesn't report if variable declared inside loop" do
s = Source.new %(
expect_no_issues subject, %(
while true
i = 0
spawn { i += 1 }
end
)
subject.catch(s).should be_valid
end
it "reports rule, location and message" do

View file

@ -5,76 +5,66 @@ module Ameba::Rule::Performance
describe AnyAfterFilter do
it "passes if there is no potential performance improvements" do
source = Source.new %(
expect_no_issues subject, %(
[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 %(
expect_issue subject, %(
[1, 2, 3].select { |e| e > 2 }.any?
# ^^^^^^^^^^^^^^^^^^^^^^^^^^ error: Use `any? {...}` instead of `select {...}.any?`
)
subject.catch(source).should_not be_valid
end
it "does not report if source is a spec" do
source = Source.new %(
expect_no_issues subject, %(
[1, 2, 3].select { |e| e > 2 }.any?
), "source_spec.cr"
subject.catch(source).should be_valid
end
it "reports if there is reject followed by any? without a block" do
source = Source.new %(
expect_issue subject, %(
[1, 2, 3].reject { |e| e > 2 }.any?
# ^^^^^^^^^^^^^^^^^^^^^^^^^^ error: Use `any? {...}` instead of `reject {...}.any?`
)
subject.catch(source).should_not be_valid
end
it "does not report if any? calls contains a block" do
source = Source.new %(
expect_no_issues subject, %(
[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
expect_no_issues rule, %(
[1, 2, 3].reject { |e| e > 2 }.any?
)
end
end
context "macro" do
it "reports in macro scope" do
source = Source.new %(
expect_issue subject, %(
{{ [1, 2, 3].reject { |e| e > 2 }.any? }}
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^ error: Use `any? {...}` instead of `reject {...}.any?`
)
subject.catch(source).should_not be_valid
end
end
it "reports rule, pos and message" do
s = Source.new %(
expect_issue subject, %(
[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:1:11"
issue.end_location.to_s.should eq "source.cr:1:36"
issue.message.should eq "Use `any? {...}` instead of `reject {...}.any?`"
# ^^^^^^^^^^^^^^^^^^^^^^^^^^ error: Use `any? {...}` instead of `reject {...}.any?`
)
end
end
end