2018-06-16 11:50:59 +00:00
|
|
|
require "../../../spec_helper"
|
2017-11-04 21:13:38 +00:00
|
|
|
|
|
|
|
module Ameba
|
2018-06-16 11:50:59 +00:00
|
|
|
subject = Rule::Style::VariableNames.new
|
2017-11-04 21:13:38 +00:00
|
|
|
|
2021-10-27 23:13:29 +00:00
|
|
|
private def it_reports_var_name(name, value, expected)
|
|
|
|
it "reports variable name #{expected}" do
|
|
|
|
rule = Rule::Style::VariableNames.new
|
|
|
|
expect_issue rule, <<-CRYSTAL, name: name
|
|
|
|
%{name} = #{value}
|
|
|
|
# ^{name} error: Var name should be underscore-cased: #{expected}, not %{name}
|
|
|
|
CRYSTAL
|
2017-11-04 21:13:38 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2018-06-16 11:50:59 +00:00
|
|
|
describe Rule::Style::VariableNames do
|
2017-11-04 21:13:38 +00:00
|
|
|
it "passes if var names are underscore-cased" do
|
2021-10-27 23:13:29 +00:00
|
|
|
expect_no_issues subject, <<-CRYSTAL
|
2017-11-04 21:13:38 +00:00
|
|
|
class Greeting
|
|
|
|
@@default_greeting = "Hello world"
|
|
|
|
|
|
|
|
def initialize(@custom_greeting = nil)
|
|
|
|
end
|
|
|
|
|
|
|
|
def print_greeting
|
|
|
|
greeting = @custom_greeting || @@default_greeting
|
|
|
|
puts greeting
|
|
|
|
end
|
|
|
|
end
|
2021-10-27 23:13:29 +00:00
|
|
|
CRYSTAL
|
2017-11-04 21:13:38 +00:00
|
|
|
end
|
|
|
|
|
2021-10-27 23:13:29 +00:00
|
|
|
it_reports_var_name "myBadNamedVar", "1", "my_bad_named_var"
|
|
|
|
it_reports_var_name "wrong_Name", "'y'", "wrong_name"
|
2017-11-04 21:13:38 +00:00
|
|
|
|
2021-10-27 23:13:29 +00:00
|
|
|
it "reports instance variable name" do
|
|
|
|
expect_issue subject, <<-CRYSTAL
|
|
|
|
class Greeting
|
|
|
|
def initialize(@badNamed = nil)
|
|
|
|
# ^ error: Var name should be underscore-cased: @bad_named, not @badNamed
|
|
|
|
end
|
2017-11-04 21:13:38 +00:00
|
|
|
end
|
2021-10-27 23:13:29 +00:00
|
|
|
CRYSTAL
|
|
|
|
end
|
|
|
|
|
2021-11-09 19:49:29 +00:00
|
|
|
it "reports method with multiple instance variables" do
|
|
|
|
expect_issue subject, <<-CRYSTAL
|
|
|
|
class Location
|
|
|
|
def at(@startLocation = nil, @endLocation = nil)
|
|
|
|
# ^ error: Var name should be underscore-cased: @start_location, not @startLocation
|
|
|
|
# ^ error: Var name should be underscore-cased: @end_location, not @endLocation
|
|
|
|
end
|
|
|
|
end
|
|
|
|
CRYSTAL
|
|
|
|
end
|
|
|
|
|
2021-10-27 23:13:29 +00:00
|
|
|
it "reports class variable name" do
|
|
|
|
expect_issue subject, <<-CRYSTAL
|
|
|
|
class Greeting
|
|
|
|
@@defaultGreeting = "Hello world"
|
|
|
|
# ^^^^^^^^^^^^^^^^^ error: Var name should be underscore-cased: @@default_greeting, not @@defaultGreeting
|
|
|
|
end
|
|
|
|
CRYSTAL
|
|
|
|
end
|
2017-11-04 21:13:38 +00:00
|
|
|
|
|
|
|
it "reports rule, pos and message" do
|
|
|
|
s = Source.new %(
|
|
|
|
badName = "Yeah"
|
2017-11-07 20:02:51 +00:00
|
|
|
), "source.cr"
|
2017-11-04 21:13:38 +00:00
|
|
|
subject.catch(s).should_not be_valid
|
2018-06-10 21:15:12 +00:00
|
|
|
issue = s.issues.first
|
|
|
|
issue.rule.should_not be_nil
|
2018-09-07 12:07:03 +00:00
|
|
|
issue.location.to_s.should eq "source.cr:1:1"
|
2018-11-24 17:38:13 +00:00
|
|
|
issue.end_location.to_s.should eq "source.cr:1:7"
|
2018-06-10 21:15:12 +00:00
|
|
|
issue.message.should eq(
|
2017-11-04 21:13:38 +00:00
|
|
|
"Var name should be underscore-cased: bad_name, not badName"
|
|
|
|
)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|