Merge pull request #259 from crystal-ameba/fix/crystal-nightly

This commit is contained in:
Sijawusz Pur Rahnama 2022-04-05 14:49:47 +02:00 committed by GitHub
commit 734e55fbab
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
15 changed files with 131 additions and 142 deletions

View file

@ -15,6 +15,6 @@ scripts:
executables: executables:
- ameba - ameba
crystal: ">= 0.35.0" crystal: ">= 1.4.0"
license: MIT license: MIT

View file

@ -1,5 +1,4 @@
require "../../spec_helper" require "../../spec_helper"
require "semantic_version"
module Ameba::AST module Ameba::AST
struct Test struct Test
@ -77,14 +76,9 @@ module Ameba::AST
CRYSTAL CRYSTAL
node = as_nodes(s).nil_literal_nodes.first node = as_nodes(s).nil_literal_nodes.first
source = subject.node_source node, s.split("\n") source = subject.node_source node, s.split("\n")
if SemanticVersion.parse(Crystal::VERSION) <= SemanticVersion.parse("0.35.1")
source.should be_nil
else
source.should eq "nil" source.should eq "nil"
end end
end end
end
describe "#flow_command?" do describe "#flow_command?" do
it "returns true if this is return" do it "returns true if this is return" do

View file

@ -5,7 +5,7 @@ module Ameba::Rule::Lint
subject = EmptyEnsure.new subject = EmptyEnsure.new
it "passes if there is no empty ensure blocks" do it "passes if there is no empty ensure blocks" do
s = Source.new %( expect_no_issues subject, <<-CRYSTAL
def some_method def some_method
do_some_stuff do_some_stuff
ensure ensure
@ -23,47 +23,30 @@ module Ameba::Rule::Lint
ensure ensure
nil nil
end end
) CRYSTAL
subject.catch(s).should be_valid
end end
it "fails if there is an empty ensure in method" do it "fails if there is an empty ensure in method" do
s = Source.new %( expect_issue subject, <<-CRYSTAL
def method def method
do_some_stuff do_some_stuff
ensure ensure
# ^^^^^^ error: Empty `ensure` block detected
end end
) CRYSTAL
subject.catch(s).should_not be_valid
end end
it "fails if there is an empty ensure in a block" do it "fails if there is an empty ensure in a block" do
s = Source.new %( expect_issue subject, <<-CRYSTAL
begin
do_some_stuff
ensure
# nothing here
end
)
subject.catch(s).should_not be_valid
end
it "reports rule, pos and message" do
s = Source.new %(
begin begin
do_some_stuff do_some_stuff
rescue rescue
do_some_other_stuff do_some_other_stuff
ensure ensure
# ^^^^^^ error: Empty `ensure` block detected
# nothing here
end end
), "source.cr" CRYSTAL
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:3"
issue.end_location.to_s.should eq "source.cr:6:3"
issue.message.should eq "Empty `ensure` block detected"
end end
end end
end end

View file

@ -1,17 +1,11 @@
require "../../../spec_helper" require "../../../spec_helper"
private def check_shadowed(source, exceptions)
s = Ameba::Source.new source
Ameba::Rule::Lint::ShadowedException.new.catch(s).should_not be_valid
s.issues.first.message.should contain exceptions.join(", ")
end
module Ameba::Rule::Lint module Ameba::Rule::Lint
describe ShadowedException do describe ShadowedException do
subject = ShadowedException.new subject = ShadowedException.new
it "passes if there isn't shadowed exception" do it "passes if there isn't shadowed exception" do
s = Source.new %( expect_no_issues subject, <<-CRYSTAL
def method def method
do_something do_something
rescue ArgumentError rescue ArgumentError
@ -31,146 +25,158 @@ module Ameba::Rule::Lint
rescue e : Exception rescue e : Exception
handle_exception handle_exception
end end
) CRYSTAL
subject.catch(s).should be_valid
end end
it "fails if there is a shadowed exception" do it "fails if there is a shadowed exception" do
check_shadowed %( expect_issue subject, <<-CRYSTAL
begin begin
do_something do_something
rescue Exception rescue Exception
handle_exception handle_exception
rescue ArgumentError rescue ArgumentError
# ^^^^^^^^^^^^^ error: Shadowed exception found: ArgumentError
handle_argument_error_exception handle_argument_error_exception
end end
), %w(ArgumentError) CRYSTAL
end end
it "fails if there is a custom shadowed exceptions" do it "fails if there is a custom shadowed exceptions" do
check_shadowed %( expect_issue subject, <<-CRYSTAL
begin begin
1 1
rescue Exception rescue Exception
2 2
rescue MySuperException rescue MySuperException
# ^^^^^^^^^^^^^^^^ error: Shadowed exception found: MySuperException
3 3
end end
), %w(MySuperException) CRYSTAL
end end
it "fails if there is a shadowed exception in a type list" do it "fails if there is a shadowed exception in a type list" do
check_shadowed %( expect_issue subject, <<-CRYSTAL
begin begin
rescue Exception | IndexError rescue Exception | IndexError
# ^^^^^^^^^^ error: Shadowed exception found: IndexError
end end
), %w(IndexError) CRYSTAL
end end
it "fails if there is a first shadowed exception in a type list" do it "fails if there is a first shadowed exception in a type list" do
check_shadowed %( expect_issue subject, <<-CRYSTAL
begin begin
rescue IndexError | Exception rescue IndexError | Exception
# ^^^^^^^^^^ error: Shadowed exception found: IndexError
rescue Exception rescue Exception
# ^^^^^^^^^ error: Shadowed exception found: Exception
rescue rescue
end end
), %w(IndexError) CRYSTAL
end end
it "fails if there is a shadowed duplicated exception" do it "fails if there is a shadowed duplicated exception" do
check_shadowed %( expect_issue subject, <<-CRYSTAL
begin begin
rescue IndexError rescue IndexError
rescue ArgumentError rescue ArgumentError
rescue IndexError rescue IndexError
# ^^^^^^^^^^ error: Shadowed exception found: IndexError
end end
), %w(IndexError) CRYSTAL
end end
it "fails if there is a shadowed duplicated exception in a type list" do it "fails if there is a shadowed duplicated exception in a type list" do
check_shadowed %( expect_issue subject, <<-CRYSTAL
begin begin
rescue IndexError rescue IndexError
rescue ArgumentError | IndexError rescue ArgumentError | IndexError
# ^^^^^^^^^^ error: Shadowed exception found: IndexError
end end
), %w(IndexError) CRYSTAL
end end
it "fails if there is only shadowed duplicated exceptions" do it "fails if there is only shadowed duplicated exceptions" do
check_shadowed %( expect_issue subject, <<-CRYSTAL
begin begin
rescue IndexError rescue IndexError
rescue IndexError rescue IndexError
# ^^^^^^^^^^ error: Shadowed exception found: IndexError
rescue Exception
end end
), %w(IndexError) CRYSTAL
end end
it "fails if there is only shadowed duplicated exceptions in a type list" do it "fails if there is only shadowed duplicated exceptions in a type list" do
check_shadowed %( expect_issue subject, <<-CRYSTAL
begin begin
rescue IndexError | IndexError rescue IndexError | IndexError
# ^^^^^^^^^^ error: Shadowed exception found: IndexError
end end
), %w(IndexError) CRYSTAL
end end
it "fails if all rescues are shadowed and there is a catch-all rescue" do it "fails if all rescues are shadowed and there is a catch-all rescue" do
check_shadowed %( expect_issue subject, <<-CRYSTAL
begin begin
rescue Exception rescue Exception
rescue ArgumentError rescue ArgumentError
# ^^^^^^^^^^^^^ error: Shadowed exception found: ArgumentError
rescue IndexError rescue IndexError
# ^^^^^^^^^^ error: Shadowed exception found: IndexError
rescue KeyError | IO::Error rescue KeyError | IO::Error
# ^^^^^^^^^ error: Shadowed exception found: IO::Error
# ^^^^^^^^ error: Shadowed exception found: KeyError
rescue rescue
end end
), %w(IndexError KeyError IO::Error) CRYSTAL
end end
it "fails if there are shadowed exception with args" do it "fails if there are shadowed exception with args" do
check_shadowed %( expect_issue subject, <<-CRYSTAL
begin begin
rescue Exception rescue Exception
rescue ex : IndexError rescue ex : IndexError
# ^^^^^^^^^^ error: Shadowed exception found: IndexError
rescue rescue
end end
), %w(IndexError) CRYSTAL
end end
it "fails if there are multiple shadowed exceptions" do it "fails if there are multiple shadowed exceptions" do
check_shadowed %( expect_issue subject, <<-CRYSTAL
begin begin
rescue Exception rescue Exception
rescue ArgumentError rescue ArgumentError
# ^^^^^^^^^^^^^ error: Shadowed exception found: ArgumentError
rescue IndexError rescue IndexError
# ^^^^^^^^^^ error: Shadowed exception found: IndexError
end end
), %w(ArgumentError IndexError) CRYSTAL
end end
it "fails if there are multiple shadowed exceptions in a type list" do it "fails if there are multiple shadowed exceptions in a type list" do
check_shadowed %( expect_issue subject, <<-CRYSTAL
begin begin
rescue Exception rescue Exception
rescue ArgumentError | IndexError rescue ArgumentError | IndexError
# ^^^^^^^^^^ error: Shadowed exception found: IndexError
# ^^^^^^^^^^^^^ error: Shadowed exception found: ArgumentError
rescue IO::Error rescue IO::Error
# ^^^^^^^^^ error: Shadowed exception found: IO::Error
end end
), %w(ArgumentError IndexError IO::Error) CRYSTAL
end end
it "reports rule, location and a message" do it "fails if there are multiple shadowed exceptions in a single rescue" do
s = Source.new %q( expect_issue subject, <<-CRYSTAL
begin begin
do_something do_something
rescue Exception | IndexError rescue Exception | IndexError | ArgumentError
# ^^^^^^^^^^^^^ error: Shadowed exception found: ArgumentError
# ^^^^^^^^^^ error: Shadowed exception found: IndexError
end end
), "source.cr" CRYSTAL
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:3"
issue.end_location.to_s.should eq "source.cr:4:3"
issue.message.should eq(
"Exception handler has shadowed exceptions: IndexError"
)
end end
end end
end end

View file

@ -3,9 +3,9 @@ require "../spec_helper"
module Ameba module Ameba
private def it_tokenizes(str, expected) private def it_tokenizes(str, expected)
it "tokenizes #{str}" do it "tokenizes #{str}" do
([] of Symbol).tap do |token_types| ([] of String).tap do |token_types|
Tokenizer.new(Source.new str, normalize: false) Tokenizer.new(Source.new str, normalize: false)
.run { |token| token_types << token.type } .run { |token| token_types << token.type.to_s }
.should be_true .should be_true
end.should eq expected end.should eq expected
end end
@ -13,20 +13,20 @@ module Ameba
describe Tokenizer do describe Tokenizer do
describe "#run" do describe "#run" do
it_tokenizes %("string"), %i(DELIMITER_START STRING DELIMITER_END EOF) it_tokenizes %("string"), %w(DELIMITER_START STRING DELIMITER_END EOF)
it_tokenizes %(100), %i(NUMBER EOF) it_tokenizes %(100), %w(NUMBER EOF)
it_tokenizes %('a'), %i(CHAR EOF) it_tokenizes %('a'), %w(CHAR EOF)
it_tokenizes %([]), %i([] EOF) it_tokenizes %([]), %w([] EOF)
it_tokenizes %([] of String), %i([] SPACE IDENT SPACE CONST EOF) it_tokenizes %([] of String), %w([] SPACE IDENT SPACE CONST EOF)
it_tokenizes %q("str #{3}"), %i( it_tokenizes %q("str #{3}"), %w(
DELIMITER_START STRING INTERPOLATION_START NUMBER } DELIMITER_END EOF DELIMITER_START STRING INTERPOLATION_START NUMBER } DELIMITER_END EOF
) )
it_tokenizes %(%w(1 2)), it_tokenizes %(%w(1 2)),
%i(STRING_ARRAY_START STRING STRING STRING_ARRAY_END EOF) %w(STRING_ARRAY_START STRING STRING STRING_ARRAY_END EOF)
it_tokenizes %(%i(one two)), it_tokenizes %(%i(one two)),
%i(SYMBOL_ARRAY_START STRING STRING STRING_ARRAY_END EOF) %w(SYMBOL_ARRAY_START STRING STRING STRING_ARRAY_END EOF)
it_tokenizes %( it_tokenizes %(
class A class A
@ -34,7 +34,7 @@ module Ameba
puts "hello" puts "hello"
end end
end end
), %i( ), %w(
NEWLINE SPACE IDENT SPACE CONST NEWLINE SPACE IDENT SPACE IDENT NEWLINE SPACE IDENT SPACE CONST NEWLINE SPACE IDENT SPACE IDENT
NEWLINE SPACE IDENT SPACE DELIMITER_START STRING DELIMITER_END NEWLINE SPACE IDENT SPACE DELIMITER_START STRING DELIMITER_END
NEWLINE SPACE IDENT NEWLINE SPACE IDENT NEWLINE SPACE EOF NEWLINE SPACE IDENT NEWLINE SPACE IDENT NEWLINE SPACE EOF

View file

@ -195,7 +195,7 @@ module Ameba::AST::Util
case name case name
when Crystal::ASTNode then name.name_size when Crystal::ASTNode then name.name_size
when Symbol then name.to_s.size # Crystal::MagicConstant when Crystal::Token::Kind then name.to_s.size # Crystal::MagicConstant
else name.size else name.size
end end
end end

View file

@ -95,7 +95,7 @@ module Ameba
commented = false commented = false
lexer = Crystal::Lexer.new(line).tap(&.comments_enabled = true) lexer = Crystal::Lexer.new(line).tap(&.comments_enabled = true)
Tokenizer.new(lexer).run { |t| commented = true if t.type == :COMMENT } Tokenizer.new(lexer).run { |t| commented = true if t.type.comment? }
commented commented
end end
end end

View file

@ -28,7 +28,7 @@ module Ameba::Rule::Lint
def test(source) def test(source)
Tokenizer.new(source).run do |token| Tokenizer.new(source).run do |token|
next unless token.type == :COMMENT next unless token.type.comment?
next unless directive = source.parse_inline_directive(token.value.to_s) next unless directive = source.parse_inline_directive(token.value.to_s)
check_action source, token, directive[:action] check_action source, token, directive[:action]

View file

@ -49,7 +49,7 @@ module Ameba::Rule::Lint
node_ensure = node.ensure node_ensure = node.ensure
return if node_ensure.nil? || !node_ensure.nop? return if node_ensure.nil? || !node_ensure.nop?
issue_for node, MSG issue_for node.ensure_location, node.end_location, MSG
end end
end end
end end

View file

@ -38,13 +38,13 @@ module Ameba::Rule::Lint
Tokenizer.new(source).run do |token| Tokenizer.new(source).run do |token|
case token.type case token.type
when :STRING_ARRAY_START, :SYMBOL_ARRAY_START when .string_array_start?, .symbol_array_start?
start_token = token.dup start_token = token.dup
when :STRING when .string?
if start_token && issue.nil? if start_token && issue.nil?
issue = array_entry_invalid?(token.value, start_token.not_nil!.raw) issue = array_entry_invalid?(token.value, start_token.not_nil!.raw)
end end
when :STRING_ARRAY_END, :SYMBOL_ARRAY_END when .string_array_end?
if issue if issue
issue_for start_token.not_nil!, issue.not_nil! issue_for start_token.not_nil!, issue.not_nil!
end end

View file

@ -38,38 +38,44 @@ module Ameba::Rule::Lint
description "Disallows rescued exception that get shadowed" description "Disallows rescued exception that get shadowed"
end end
MSG = "Exception handler has shadowed exceptions: %s" MSG = "Shadowed exception found: %s"
def test(source, node : Crystal::ExceptionHandler) def test(source, node : Crystal::ExceptionHandler)
return unless excs = node.rescues.try &.map(&.types) rescues = node.rescues
return if (excs = shadowed excs).empty?
issue_for node, MSG % excs.join(", ") return if rescues.nil?
shadowed(rescues).each { |tp| issue_for tp, MSG % tp.names.join("::") }
end end
private def shadowed(exceptions, exception_found = false) private def shadowed(rescues, catch_all = false)
previous_exceptions = [] of String traversed_types = Set(String).new
exceptions.reduce([] of String) do |shadowed, excs| filter_rescues(rescues).each_with_object([] of Crystal::Path) do |types, shadowed|
excs = excs.try(&.map(&.to_s)) || %w[Exception] case
when catch_all
if exception_found shadowed.concat(types)
shadowed.concat excs next
previous_exceptions.concat excs when types.any?(&.single?("Exception"))
nodes = types.reject(&.single?("Exception"))
shadowed.concat(nodes) unless nodes.empty?
catch_all = true
next
else else
exception_found ||= excs.any? &.== "Exception" nodes = types.select { |tp| traverse(tp.to_s, traversed_types) }
excs.each do |exc| shadowed.concat(nodes) unless nodes.empty?
if exception_found && exc != "Exception"
shadowed << exc
else
shadowed << exc if previous_exceptions.any? &.== exc
end end
previous_exceptions << exc
end end
end end
shadowed private def filter_rescues(rescues)
rescues.compact_map(&.types.try &.select(Crystal::Path))
end end
private def traverse(path, traversed_types)
dup = traversed_types.includes?(path)
dup || (traversed_types << path)
dup
end end
end end
end end

View file

@ -33,7 +33,7 @@ module Ameba::Rule::Lint
def test(source) def test(source)
Tokenizer.new(source).run do |token| Tokenizer.new(source).run do |token|
next unless token.type == :COMMENT next unless token.type.comment?
next unless directive = source.parse_inline_directive(token.value.to_s) next unless directive = source.parse_inline_directive(token.value.to_s)
next unless names = unneeded_disables(source, directive, token.location) next unless names = unneeded_disables(source, directive, token.location)
next if names.empty? next if names.empty?

View file

@ -37,7 +37,7 @@ module Ameba::Rule::Style
def test(source) def test(source)
Tokenizer.new(source).run do |token| Tokenizer.new(source).run do |token|
next unless token.type == :NUMBER && decimal?(token.raw) next unless token.type.number? && decimal?(token.raw)
parsed = parse_number token.raw parsed = parse_number token.raw

View file

@ -90,7 +90,7 @@ module Ameba::Rule::Style
end end
private def redundant_begin_in_expressions?(node) private def redundant_begin_in_expressions?(node)
node.keyword == :begin !!node.keyword.try(&.begin?)
end end
private def inner_handler?(handler) private def inner_handler?(handler)
@ -119,19 +119,19 @@ module Ameba::Rule::Style
token = lexer.next_token token = lexer.next_token
case token.type case token.type
when :EOF, :"->" when .eof?, .op_minus_gt?
break break
when :IDENT when .ident?
next unless in_body next unless in_body
return unless token.value == :begin return unless token.value == :begin
return token.location return token.location
when :"(" when .op_lparen?
in_argument_list = true in_argument_list = true
when :")" when .op_rparen?
in_argument_list = false in_argument_list = false
when :NEWLINE when .newline?
in_body = true unless in_argument_list in_body = true unless in_argument_list
when :SPACE when .space?
# ignore # ignore
else else
return if in_body return if in_body
@ -142,7 +142,7 @@ module Ameba::Rule::Style
private def def_redundant_end_loc(lexer) private def def_redundant_end_loc(lexer)
end_loc = def_end_loc = nil end_loc = def_end_loc = nil
while (token = lexer.next_token).type != :EOF while !(token = lexer.next_token).type.eof?
next unless token.value == :end next unless token.value == :end
end_loc, def_end_loc = def_end_loc, token.location end_loc, def_end_loc = def_end_loc, token.location

View file

@ -56,13 +56,13 @@ module Ameba
block.call token block.call token
case token.type case token.type
when :DELIMITER_START when .delimiter_start?
run_delimiter_state lexer, token, &block run_delimiter_state lexer, token, &block
when :STRING_ARRAY_START, :SYMBOL_ARRAY_START when .string_array_start?, .symbol_array_start?
run_array_state lexer, token, &block run_array_state lexer, token, &block
when :EOF when .eof?
break break
when :"}" when .op_rcurly?
break if break_on_rcurly break if break_on_rcurly
end end
end end
@ -74,11 +74,11 @@ module Ameba
block.call token block.call token
case token.type case token.type
when :DELIMITER_END when .delimiter_end?
break break
when :INTERPOLATION_START when .interpolation_start?
run_normal_state lexer, break_on_rcurly: true, &block run_normal_state lexer, break_on_rcurly: true, &block
when :EOF when .eof?
break break
end end
end end
@ -90,9 +90,9 @@ module Ameba
block.call token block.call token
case token.type case token.type
when :STRING_ARRAY_END when .string_array_end?
break break
when :EOF when .eof?
break break
end end
end end