Merge pull request #21 from github/kh-convert-aria-label-misuse-to-counter

Convert `NoAriaLabelMisuse` to counter

Author: khiga8

README.md

@@ -29,7 +29,7 @@ linters:
     enabled: true
   GitHub::Accessibility::ImageHasAlt:
     enabled: true
-  GitHub::Accessibility::NoAriaLabelMisuse:
+  GitHub::Accessibility::NoAriaLabelMisuseCounter:
     enabled: true
   GitHub::Accessibility::NoPositiveTabIndex:
     enabled: true
@@ -44,7 +44,7 @@ linters:
 - [GitHub::Accessibility::AvoidBothDisabledAndAriaDisabled](./docs/rules/accessibility/avoid-both-disabled-and-aria-disabled.md)
 - [GitHub::Accessibility::IframeHasTitle](./docs/rules/accessibility/iframe-has-title.md)
 - [GitHub::Accessibility::ImageHasAlt](./docs/rules/accessibility/image-has-alt.md)
-- [GitHub::Accessibility::NoAriaLabelMisuse](./docs/rules/accessibility/no-aria-label-misuse.md)
+- [GitHub::Accessibility::NoAriaLabelMisuseCounter](./docs/rules/accessibility/no-aria-label-misuse-counter.md)
 - [GitHub::Accessibility::NoPositiveTabIndex](./docs/rules/accessibility/no-positive-tab-index.md)
 - [GitHub::Accessibility::NoRedundantImageAlt](./docs/rules/accessibility/no-redundant-image-alt.md)
 - [GitHub::Accessibility::NoTitleAttributeCounter](./docs/rules/accessibility/no-title-attribute-counter.md)

…es/accessibility/no-aria-label-misuse.md …sibility/no-aria-label-misuse-counter.mddocs/rules/accessibility/no-aria-label-misuse.md renamed to docs/rules/accessibility/no-aria-label-misuse-counter.md docs/rules/accessibility/no-aria-label-misuse.md renamed to docs/rules/accessibility/no-aria-label-misuse-counter.md

@@ -1,4 +1,4 @@
-# No aria label misuse
+# No aria label misuse counter
 
 ## Rule Details
 

…ub/accessibility/no_aria_label_misuse.rb …sibility/no_aria_label_misuse_counter.rblib/erblint-github/linters/github/accessibility/no_aria_label_misuse.rb renamed to lib/erblint-github/linters/github/accessibility/no_aria_label_misuse_counter.rb lib/erblint-github/linters/github/accessibility/no_aria_label_misuse.rb renamed to lib/erblint-github/linters/github/accessibility/no_aria_label_misuse_counter.rb

@@ -6,7 +6,7 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class NoAriaLabelMisuse < Linter
+        class NoAriaLabelMisuseCounter < Linter
           include ERBLint::Linters::CustomHelpers
           include LinterRegistry
 
@@ -34,7 +34,21 @@ def run(processed_source)
                 end
               end
             end
-            rule_disabled?(processed_source)
+            counter_correct?(processed_source)
+          end
+
+          def autocorrect(processed_source, offense)
+            return unless offense.context
+
+            lambda do |corrector|
+              if processed_source.file_content.include?("erblint:counter #{simple_class_name}")
+                # update the counter if exists
+                corrector.replace(offense.source_range, offense.context)
+              else
+                # add comment with counter if none
+                corrector.insert_before(processed_source.source_buffer.source_range, "#{offense.context}\n")
+              end
+            end
           end
         end
       end

…cessibility/no_aria_label_misuse_test.rb …ity/no_aria_label_misuse_counter_test.rbtest/linters/accessibility/no_aria_label_misuse_test.rb renamed to test/linters/accessibility/no_aria_label_misuse_counter_test.rb test/linters/accessibility/no_aria_label_misuse_test.rb renamed to test/linters/accessibility/no_aria_label_misuse_counter_test.rb

@@ -2,9 +2,9 @@
 
 require "test_helper"
 
-class NoAriaLabelMisuseTest < LinterTestCase
+class NoAriaLabelMisuseCounterTest < LinterTestCase
   def linter_class
-    ERBLint::Linters::GitHub::Accessibility::NoAriaLabelMisuse
+    ERBLint::Linters::GitHub::Accessibility::NoAriaLabelMisuseCounter
   end
 
   def example_invalid_case
@@ -29,7 +29,7 @@ def test_warns_if_banned_elements_have_aria_label
     HTML
 
     @linter.run(processed_source)
-    assert_equal @linter.offenses.length, 11
+    assert_equal @linter.offenses.length, 12
   end
 
   def test_warns_if_generic_elements_have_aria_label_and_no_role
@@ -39,7 +39,7 @@ def test_warns_if_generic_elements_have_aria_label_and_no_role
     HTML
 
     @linter.run(processed_source)
-    assert_equal 2, @linter.offenses.length
+    assert_equal 3, @linter.offenses.length
   end
 
   def test_warns_if_generic_elements_have_aria_label_and_prohibited_role
@@ -61,7 +61,7 @@ def test_warns_if_generic_elements_have_aria_label_and_prohibited_role
     HTML
 
     @linter.run(processed_source)
-    assert_equal 14, @linter.offenses.length
+    assert_equal 15, @linter.offenses.length
   end
 
   def test_does_not_warn_if_generic_elements_have_aria_label_and_allowed_role
@@ -74,4 +74,38 @@ def test_does_not_warn_if_generic_elements_have_aria_label_and_allowed_role
     @linter.run(processed_source)
     assert_empty @linter.offenses
   end
+
+  def test_does_not_raise_when_ignore_comment_with_correct_count
+    @file = <<~ERB
+      <%# erblint:counter GitHub::Accessibility::NoAriaLabelMisuseCounter 2 %>
+      <span aria-label="This is a bad idea">Some text</span>
+      <span aria-label="This is still a bad idea">More text</span>
+    ERB
+
+    @linter.run(processed_source)
+    assert_empty @linter.offenses
+  end
+
+  def test_does_not_autocorrect_when_ignores_are_correct
+    @file = <<~ERB
+      <%# erblint:counter GitHub::Accessibility::NoAriaLabelMisuseCounter 1 %>
+      <span aria-label="This is a bad idea">Some text</span>
+    ERB
+
+    assert_equal @file, corrected_content
+  end
+
+  def test_does_autocorrect_when_ignores_are_not_correct
+    @file = <<~ERB
+      <%# erblint:counter GitHub::Accessibility::NoAriaLabelMisuseCounter 3 %>
+      <span aria-label="This is a bad idea">Some text</span>
+    ERB
+    refute_equal @file, corrected_content
+
+    expected_content = <<~ERB
+      <%# erblint:counter GitHub::Accessibility::NoAriaLabelMisuseCounter 1 %>
+      <span aria-label="This is a bad idea">Some text</span>
+    ERB
+    assert_equal expected_content, corrected_content
+  end
 end