Convert Style/VariableNames spec

spec/ameba/rule/style/variable_names_spec.cr

@@ -3,17 +3,19 @@ require "../../../spec_helper"
 module Ameba
   subject = Rule::Style::VariableNames.new
 
-  private def it_reports_var_name(code, expected)
+  private def it_reports_var_name(name, value, expected)
-    it "reports method name #{expected}" do
+    it "reports variable name #{expected}" do
-      s = Source.new code
+      rule = Rule::Style::VariableNames.new
-      Rule::Style::VariableNames.new.catch(s).should_not be_valid
+      expect_issue rule, <<-CRYSTAL, name: name
-      s.issues.first.message.should contain expected
+          %{name} = #{value}
+        # ^{name} error: Var name should be underscore-cased: #{expected}, not %{name}
+        CRYSTAL
     end
   end
 
   describe Rule::Style::VariableNames do
     it "passes if var names are underscore-cased" do
-      s = Source.new %(
+      expect_no_issues subject, <<-CRYSTAL
         class Greeting
           @@default_greeting = "Hello world"
 
@@ -25,25 +27,31 @@ module Ameba
             puts greeting
           end
         end
-      )
+        CRYSTAL
-      subject.catch(s).should be_valid
     end
 
-    it_reports_var_name %(myBadNamedVar = 1), "my_bad_named_var"
+    it_reports_var_name "myBadNamedVar", "1", "my_bad_named_var"
-    it_reports_var_name %(wrong_Name = 'y'), "wrong_name"
+    it_reports_var_name "wrong_Name", "'y'", "wrong_name"
 
-    it_reports_var_name %(
+    it "reports instance variable name" do
-      class Greeting
+      expect_issue subject, <<-CRYSTAL
-        def initialize(@badNamed = nil)
+        class Greeting
+          def initialize(@badNamed = nil)
+                       # ^ error: Var name should be underscore-cased: @bad_named, not @badNamed
+                       # ^ error: Var name should be underscore-cased: bad_named, not badNamed
+          end
         end
-      end
+        CRYSTAL
-    ), "bad_named"
+    end
 
-    it_reports_var_name %(
+    it "reports class variable name" do
-      class Greeting
+      expect_issue subject, <<-CRYSTAL
-        @@defaultGreeting = "Hello world"
+        class Greeting
-      end
+          @@defaultGreeting = "Hello world"
-    ), "default_greeting"
+        # ^^^^^^^^^^^^^^^^^ error: Var name should be underscore-cased: @@default_greeting, not @@defaultGreeting
+        end
+        CRYSTAL
+    end
 
     it "reports rule, pos and message" do
       s = Source.new %(

src/ameba/rule/style/variable_names.cr

@@ -35,6 +35,18 @@ module Ameba::Rule::Style
       issue_for node, MSG % {expected, node.name}
     end
 
+    # TODO: Handle special case where instance variable is method parameter.
+    #       For example, this:
+    #
+    #         def initialize(@foo)
+    #         end
+    #
+    #       is represented in the AST as:
+    #
+    #         def initialize(foo)
+    #           @foo = foo
+    #         end
+
     def test(source, node : Crystal::Var)
       check_node source, node
     end