erblint-github 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 310138254b0989437e8cf803d52cba66ad005d7cae43b8b6233e638a20e40868
-  data.tar.gz: 654d731eb0c99317883327dd401726582d7df70995350d0006b365fe1b9670b6
+  metadata.gz: 2e31129554b451397cf438dc56e52ce9f0e21b7df4cecb59f92324b7ca0c7e5c
+  data.tar.gz: a17e3f541f4975cdfafb0d046a312581fe6481ba4e113f49f7cb9ed67a09d477
 SHA512:
-  metadata.gz: ce1a90a1c2482b29b406787a1c530614718242de1b9fac828617c2f476db00578872bcddf52037bf8195c71beb8750916e853b5127f4de036aea5771a8edbe2b
-  data.tar.gz: 2a1e8844fdae5d352a6798937629e4ae70bea7d3a16c00e1a6de363dcc805044164b55e5166d9ffaf6f288bbdb135c373c2f1b1b40d27ecb0705c2cb616a833c
+  metadata.gz: 2aba7d9263d58382aabef89e3688993dc7bbf230199ae8b952159bc0c3287402107562537095b7184f55fa192a7bf0366ff43875f3f85fcf73ca57cb45a9ee21
+  data.tar.gz: 69a2e3fb5a40d79120655ba41bb38c2120f01b941b73ce888bc7e29e57fc9c31c119770f3b719fedb9cf1a8cef4db341696eea54c4b658320e80ff540dec4e64

data/lib/erblint-github/linters/github/accessibility/avoid_generic_link_text_counter.rb

@@ -18,6 +18,8 @@ module ERBLint
             "Link",
             "Here"
           ].freeze
+          ARIA_LABEL_ATTRIBUTES = %w[aria-labelledby aria-label].freeze
+
           MESSAGE = "Avoid using generic link text such as #{BANNED_GENERIC_TEXT.join(', ')} which do not make sense in isolation."
 
           def run(processed_source)
@@ -25,6 +27,7 @@ module ERBLint
               next unless node.methods.include?(:type) && node.type == :text
 
               text = node.children.join.strip
+
               # Checks HTML tags
               if banned_text?(text)
                 prev_node = processed_source.ast.children[index - 1]
@@ -36,8 +39,17 @@ module ERBLint
                 prev_node_tag = BetterHtml::Tree::Tag.from_node(prev_node)
                 next_node_tag = BetterHtml::Tree::Tag.from_node(next_node)
 
-                # We only report if the text is nested between two link tags.
+                aria_label = possible_attribute_values(prev_node_tag, "aria-label")
+                aria_labelledby = possible_attribute_values(prev_node_tag, "aria-labelledby")
+
+                # Checks if nested between two link tags.
                 if link_tag?(prev_node_tag) && link_tag?(next_node_tag) && next_node_tag.closing?
+                  # Skip because we cannot reliably check accessible name from aria-labelledby, or an aria-label that is set to a variable
+                  # with static code analysis.
+                  next if aria_labelledby.present? || (aria_label.present? && aria_label.join.include?("<%="))
+                  # Skip because aria-label starts with visible text which we allow. Related to Success Criterion 2.5.3: Label in Name
+                  next if aria_label.present? && valid_accessible_name?(aria_label.join, text)
+
                   range = prev_node_tag.loc.begin_pos...text_node_tag.loc.end_pos
                   source_range = processed_source.to_source_range(range)
                   generate_offense_from_source_range(self.class, source_range)
@@ -45,20 +57,40 @@ module ERBLint
               end
 
               # Checks Rails link helpers like `link_to`
-              erb_node = node.type == :erb ? node : node.descendants(:erb).first
-              next unless erb_node
-
-              _, _, code_node = *erb_node
-              source = code_node.loc.source
-              ruby_node = extract_ruby_node(source)
-              send_node = ruby_node&.descendants(:send)&.first
-              next unless send_node.methods.include?(:method_name) && send_node.method_name == :link_to
-
-              send_node.child_nodes.each do |child_node|
-                if child_node.methods.include?(:type) && child_node.type == :str && banned_text?(child_node.children.join)
+              node.descendants(:erb).each do |erb_node|
+                _, _, code_node = *erb_node
+                source = code_node.loc.source
+                ruby_node = extract_ruby_node(source)
+                send_node = ruby_node&.descendants(:send)&.first
+                next unless send_node.methods.include?(:method_name) && send_node.method_name == :link_to
+
+                banned_text = nil
+
+                send_node.child_nodes.each do |child_node|
+                  banned_text = child_node.children.join if child_node.methods.include?(:type) && child_node.type == :str && banned_text?(child_node.children.join)
+                  next if banned_text.blank?
+                  next unless child_node.methods.include?(:type) && child_node.type == :hash
+
+                  child_node.descendants(:pair).each do |pair_node|
+                    next unless pair_node.children.first.type?(:sym)
+
+                    # Skips if `link_to` has `aria-labelledby` or `aria-label` which cannot be evaluated accurately with ERB lint alone.
+                    # ERB lint removes Ruby string interpolation so the `aria-label` for "<%= link_to 'Learn more', "aria-label": "Learn #{@some_variable}" %>" will
+                    # only be `Learn` which is unreliable so we can't do checks :(
+                    key_value = pair_node.children.first.children.join
+                    banned_text = nil if ARIA_LABEL_ATTRIBUTES.include?(key_value)
+                    next unless key_value == "aria"
+
+                    pair_node.children[1].descendants(:sym).each do |sym_node|
+                      banned_text = nil if sym_node.children.join == "label" || sym_node.children.join == "labelledby"
+                    end
+                  end
+                end
+                if banned_text.present?
                   tag = BetterHtml::Tree::Tag.from_node(code_node)
                   generate_offense(self.class, processed_source, tag)
-                  end
+                end
+                banned_text = nil
               end
             end
             counter_correct?(processed_source)
@@ -84,6 +116,10 @@ module ERBLint
             BANNED_GENERIC_TEXT.map(&:downcase).include?(text.downcase)
           end
 
+          def valid_accessible_name?(aria_label, text)
+            aria_label.downcase.include?(text.downcase)
+          end
+
           def extract_ruby_node(source)
             BetterHtml::TestHelper::RubyNode.parse(source)
           rescue ::Parser::SyntaxError

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erblint-github
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-15 00:00:00.000000000 Z
+date: 2022-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb_lint