erblint-github 0.0.8 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d08f8a3f7dd601469444626fb19413c9e249f7b1a5cc7d2f71416fdb1c05d85
-  data.tar.gz: b0e6eda49feea5b68a77c975160ea2a4690e74a7d5d4b44d3b1c2ff400487ab6
+  metadata.gz: 8e7ce2b605ec0f31cb56b3e74e9f2eb4e10a11a8ab07d960596209b7d9674427
+  data.tar.gz: 0a74bf6def4d4c0b34c3f8bba3af39f7b3207fb87a72e08cf9143f3d42a1f577
 SHA512:
-  metadata.gz: 6e733cebcb4af6a1e3198b58db3df7fd01b8f0d57379da7c0b02f5c4c8f87f24f56462d7badcc2d4029a7e60508a7bc60c40f8312742093318b5c6013948e0ca
-  data.tar.gz: 40868f41b146bc4c534266e270495bbebf08c77208ea9894df13105dab4311ddeb7a238881535337a123ec0b69d1f81fa8155b3f3c81b6181dbfd95066e5d0cb
+  metadata.gz: 04e924e98c1fe68f5b3d56d8f0cf9a4c0083d70d55192661a1c93dcb457b870df4ab5841c8376c2afc8c7b3c86be87266df513e22cecfe5f33b230d450d4f5a4
+  data.tar.gz: f266202201dc8de5a3bd6089ed7b5562962b130ec5643775c3a910a242086a13280e4e449ccf26f3c0f9e5c1874693c8ce3971dff965117079ecd568c3c11e33

data/README.md

@@ -27,10 +27,18 @@ linters:
     enabled: true
   GitHub::Accessibility::AvoidGenericLinkTextCounter:
     enabled: true
+  GitHub::Accessibility::DisabledAttributeCounter:
+    enabled: true
   GitHub::Accessibility::IframeHasTitle:
     enabled: true
   GitHub::Accessibility::ImageHasAlt:
     enabled: true
+  GitHub::Accessibility::LandmarkHasLabelCounter:
+    enabled: true
+  GitHub::Accessibility::LinkHasHrefCounter:
+    enabled: true
+  GitHub::Accessibility::NestedInteractiveElementsCounter:
+    enabled: true
   GitHub::Accessibility::NoAriaLabelMisuseCounter:
     enabled: true
   GitHub::Accessibility::NoPositiveTabIndex:
@@ -39,18 +47,25 @@ linters:
     enabled: true
   GitHub::Accessibility::NoTitleAttributeCounter:
     enabled: true
+  GitHub::Accessibility::SvgHasAccessibleTextCounter:
+    enabled: true
 ```
 
 ## Rules
 
 - [GitHub::Accessibility::AvoidBothDisabledAndAriaDisabled](./docs/rules/accessibility/avoid-both-disabled-and-aria-disabled.md)
 - [GitHub::Accessibility::AvoidGenericLinkTextCounter](./docs/rules/accessibility/avoid-generic-link-text-counter.md)
+- [GitHub::Accessibility::DisabledAttributeCounter](./docs/rules/accessibility/disabled-attribute-counter-test)
 - [GitHub::Accessibility::IframeHasTitle](./docs/rules/accessibility/iframe-has-title.md)
+- [GitHub::Accessibility::LandmarkHasLabelCounter](./docs/rules/accessibility/landmark-has-label-counter.md)
 - [GitHub::Accessibility::ImageHasAlt](./docs/rules/accessibility/image-has-alt.md)
+- [GitHub::Accessibility::LinkHasHrefCounter](./docs/rules/accessibility/link-has-href-counter.md)
+- [GitHub::Accessibility::NestedInteractiveElementsCounter](./docs/rules/accessibility/nested-interactive-elements-counter.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)
+- [GitHub::Accessibility::SvgHasAccessibleTextCounter](./docs/rules/accessibility/svg-has-accessible-text-counter.md)
 
 ## Testing
 
@@ -66,4 +81,4 @@ If you use VS Code, we highly encourage [ERB Linter extension](https://marketpla
 ## Note
 
 This repo contains several accessibility-related linting rules to help surface accessibility issues that would otherwise go undetected until a later stage. Please note that due to the limitations of static code analysis,
-these ERB accessibility checks are NOT enough for ensuring the accessibility of your app. This shouldn't be the only tool you use to catch accessibility issues and should be supplemented with other tools that can check the runtime browser DOM output, as well as processes like accessibility design reviews, manual audits, user testing, etc.
+these ERB accessibility checks are NOT enough for ensuring the accessibility of your app. This shouldn't be the only tool you use to catch accessibility issues and should be supplemented with other tools that can check the runtime browser DOM output, as well as processes like accessibility design reviews, manual audits, user testing, etc.

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

@@ -112,12 +112,17 @@ module ERBLint
 
           private
 
+          # Downcase and strip punctuation and extra whitespaces.
+          def stripped_text(text)
+            text.downcase.gsub(/\W+/, " ").strip
+          end
+
           def banned_text?(text)
-            BANNED_GENERIC_TEXT.map(&:downcase).include?(text.downcase.gsub(/\W+/, " ").strip)
+            BANNED_GENERIC_TEXT.map(&:downcase).include?(stripped_text(text))
           end
 
           def valid_accessible_name?(aria_label, text)
-            aria_label.downcase.include?(text.downcase)
+            stripped_text(aria_label).include?(stripped_text(text))
           end
 
           def extract_ruby_node(source)

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "../../custom_helpers"
+
+module ERBLint
+  module Linters
+    module GitHub
+      module Accessibility
+        class DisabledAttributeCounter < Linter
+          include ERBLint::Linters::CustomHelpers
+          include LinterRegistry
+
+          VALID_DISABLED_TAGS = %w[button input textarea option select fieldset optgroup task-lists].freeze
+          MESSAGE = "`disabled` is only valid on #{VALID_DISABLED_TAGS.join(', ')}."
+
+          def run(processed_source)
+            tags(processed_source).each do |tag|
+              next if tag.closing?
+              next if VALID_DISABLED_TAGS.include?(tag.name)
+              next if tag.attributes["disabled"].nil?
+
+              generate_offense(self.class, processed_source, tag)
+            end
+
+            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
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative "../../custom_helpers"
+
+module ERBLint
+  module Linters
+    module GitHub
+      module Accessibility
+        class LandmarkHasLabelCounter < Linter
+          include ERBLint::Linters::CustomHelpers
+          include LinterRegistry
+
+          LANDMARK_ROLES = %w[complementary navigation region search].freeze
+          LANDMARK_TAGS = %w[aside nav section].freeze
+          MESSAGE = "Landmark elements should have an aria-label attribute, or aria-labelledby if a heading elements exists in the landmark."
+          ROLE_TAG_MAPPING = { "complementary" => "aside", "navigation" => "nav", "region" => "section" }.freeze
+
+          def get_additional_message(tag, roles)
+            role_matched = (roles & ROLE_TAG_MAPPING.keys).first
+            if role_matched
+              tag_matched = ROLE_TAG_MAPPING[role_matched]
+
+              if tag.name == tag_matched
+                "The <#{tag_matched}> element will automatically communicate a role of '#{role_matched}'. You can safely drop the role attribute."
+              else
+                replace_message = if tag.name == "div"
+                                    "If possible replace this tag with a <#{tag_matched}>."
+                                  else
+                                    "Wrapping this element in a <#{tag_matched}> and setting a label on it is reccomended."
+                                  end
+
+                "The <#{tag_matched}> element will automatically communicate a role of '#{role_matched}'. #{replace_message}"
+              end
+            elsif roles.include?("search") && tag.name != "form"
+              "The 'search' role works best when applied to a <form> element. If possible replace this tag with a <form>."
+            end
+          end
+
+          def run(processed_source)
+            tags(processed_source).each do |tag|
+              next if tag.closing?
+
+              possible_roles = possible_attribute_values(tag, "role")
+              next unless LANDMARK_TAGS.include?(tag.name) && (possible_roles & LANDMARK_ROLES).empty?
+              next if tag.attributes["aria-label"]&.value&.present? || tag.attributes["aria-labelledby"]&.value&.present?
+
+              message = get_additional_message(tag, possible_roles)
+              if message
+                generate_offense(self.class, processed_source, tag, "#{MESSAGE}\n#{message}")
+              else
+                generate_offense(self.class, processed_source, tag)
+              end
+            end
+
+            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
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "../../custom_helpers"
+
+module ERBLint
+  module Linters
+    module GitHub
+      module Accessibility
+        class LinkHasHrefCounter < Linter
+          include ERBLint::Linters::CustomHelpers
+          include LinterRegistry
+
+          MESSAGE = "Links should go somewhere, you probably want to use a `<button>` instead."
+
+          def run(processed_source)
+            tags(processed_source).each do |tag|
+              next if tag.name != "a"
+              next if tag.closing?
+
+              href = possible_attribute_values(tag, "href")
+              name = tag.attributes["name"]
+              generate_offense(self.class, processed_source, tag) if (!name && href.empty?) || href.include?("#")
+            end
+
+            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
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative "../../custom_helpers"
+
+module ERBLint
+  module Linters
+    module GitHub
+      module Accessibility
+        class NestedInteractiveElementsCounter < Linter
+          include ERBLint::Linters::CustomHelpers
+          include LinterRegistry
+
+          INTERACTIVE_ELEMENTS = %w[button summary input select textarea a].freeze
+          MESSAGE = "Nesting interactive elements produces invalid HTML, and ssistive technologies, such as screen readers, might ignore or respond unexpectedly to such nested controls."
+
+          def run(processed_source)
+            last_interactive_element = nil
+            tags(processed_source).each do |tag|
+              next unless INTERACTIVE_ELEMENTS.include?(tag.name)
+
+              last_interactive_element = nil if last_interactive_element && tag.name == last_interactive_element.name && tag.closing?
+              next if tag.closing?
+
+              if last_interactive_element
+                next if last_interactive_element.name == "summary" && tag.name == "a"
+                next if tag.name == "input" && tag.attributes["type"]&.value == "hidden"
+
+                message = "Found <#{tag.name}> nested inside of <#{last_interactive_element.name}>.\n" + MESSAGE
+                generate_offense(self.class, processed_source, tag, message)
+              end
+
+              last_interactive_element = tag unless tag&.name == "input"
+            end
+
+            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
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative "../../custom_helpers"
+
+module ERBLint
+  module Linters
+    module GitHub
+      module Accessibility
+        class SvgHasAccessibleTextCounter < Linter
+          include ERBLint::Linters::CustomHelpers
+          include LinterRegistry
+
+          MESSAGE = "`<svg>` must have accessible text. Set `aria-label`, or `aria-labelledby`, or nest a `<title>` element. However, if the `<svg>` is purely decorative, hide it with `aria-hidden='true'.\nFor more info, see https://css-tricks.com/accessible-svgs/."
+
+          def run(processed_source)
+            current_svg = nil
+            has_accessible_label = false
+
+            tags(processed_source).each do |tag|
+              # Checks whether tag is a <title> nested in an <svg>
+              has_accessible_label = true if current_svg && tag.name == "title" && !tag.closing?
+
+              next if tag.name != "svg"
+
+              if tag.closing?
+                generate_offense(self.class, processed_source, current_svg) unless has_accessible_label
+                current_svg = nil
+              elsif possible_attribute_values(tag, "aria-hidden").join == "true"
+                has_accessible_label = true
+                current_svg = tag
+              else
+                current_svg = tag
+                aria_label = possible_attribute_values(tag, "aria-label").join
+                aria_labelledby = possible_attribute_values(tag, "aria-labelledby").join
+
+                has_accessible_label = aria_label.present? || aria_labelledby.present?
+              end
+            end
+
+            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
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erblint-github
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.1
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-30 00:00:00.000000000 Z
+date: 2022-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb_lint
@@ -107,12 +107,17 @@ files:
 - lib/erblint-github/linters/custom_helpers.rb
 - lib/erblint-github/linters/github/accessibility/avoid_both_disabled_and_aria_disabled.rb
 - lib/erblint-github/linters/github/accessibility/avoid_generic_link_text_counter.rb
+- lib/erblint-github/linters/github/accessibility/disabled_attribute_counter.rb
 - lib/erblint-github/linters/github/accessibility/iframe_has_title.rb
 - lib/erblint-github/linters/github/accessibility/image_has_alt.rb
+- lib/erblint-github/linters/github/accessibility/landmark_has_label_counter.rb
+- lib/erblint-github/linters/github/accessibility/link_has_href_counter.rb
+- lib/erblint-github/linters/github/accessibility/nested_interactive_elements_counter.rb
 - lib/erblint-github/linters/github/accessibility/no_aria_label_misuse_counter.rb
 - lib/erblint-github/linters/github/accessibility/no_positive_tab_index.rb
 - lib/erblint-github/linters/github/accessibility/no_redundant_image_alt.rb
 - lib/erblint-github/linters/github/accessibility/no_title_attribute_counter.rb
+- lib/erblint-github/linters/github/accessibility/svg_has_accessible_text_counter.rb
 - lib/tasks/docs.rake
 - lib/tasks/tests.rake
 homepage: https://github.com/github/erblint-github
@@ -135,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.2.9
 signing_key: 
 specification_version: 4
 summary: erblint GitHub