a11y-lint 0.10.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecfe715cda47636bb8dc87f9cf3655c641d33d2e10cfd8471be73b2dd7336a1f
-  data.tar.gz: 818bb7d22993ac9036ac148d60adce32c2ef7ee342bc741bbd8e64d893414d2f
+  metadata.gz: 7f62cdc346f6aa1f5c2cae674c365678a333479966aabd1b144e7901f90e7cdf
+  data.tar.gz: 874c7cb5bac0680cb58fb2f73e89304c21862686010f5b0e721aad19861c0bbb
 SHA512:
-  metadata.gz: 3a0d354908cfc0c670db3556f0854e1e91f0486ae502ff6f93395a95923d1a6b7b456bd625ffb476ba8f7e8d3f8bea5f859ed4875e0cf172770be5e87da8517f
-  data.tar.gz: e0e5e582649edc60f0df35635af190beb49b2ab69c9da392e9ae31326918c6704962b5a5cd6d60f8e1bb8bf47474a9d4b2fdb18baf424f3013871a7d3cc17a10
+  metadata.gz: 5757d27c00656b68b5b4209a153da09e720d190bacb5124e1860a03a53d3e0df4d02909a2c1d667c5be477394228274a6e64c95b4a032d64cb14a65ba72f5bd7
+  data.tar.gz: bf502097c82848041313039b29271808133c1ff3be50b1d8e4b31b5d7df7bb1c35bb1ae643b869143355bbcd3dd2cfcddf98acd44ac858f4edb436e5699b3b92

data/.claude/rules/testing.md

@@ -49,4 +49,4 @@ globs: test/**/*.rb
 
   Each style must be tested for both the offense case and the "passes with fix" case.
 
-- Every rule must be tested against both the Slim and ERB pipelines.
+- Every rule must be tested against the Slim, ERB, and Phlex pipelines.

data/CHANGELOG.md

@@ -7,6 +7,34 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.12.0] - 2026-04-27
+
+### Added
+
+- `.a11y-lint.yml` now supports a top-level `hidden_wrapper_classes` list; content inside elements whose class matches is treated as hidden from assistive technology when the four accessible-name rules (`AnchorMissingAccessibleName`, `ButtonMissingAccessibleName`, `LinkToMissingAccessibleName`, `ButtonTagMissingAccessibleName`) determine whether a button/link has an accessible name. Opt-in; default is no filtering
+
+## [0.11.0] - 2026-04-21
+
+### Added
+
+- `AreaMissingAlt` rule: detects `<area>` tags without `alt` attributes (WCAG 1.1.1)
+- `InputImageMissingAlt` rule: detects `<input type="image">` tags without `alt` attributes (WCAG 1.1.1)
+- `ImageSubmitTagMissingAlt` rule: detects `image_submit_tag` calls without an `alt` option (WCAG 1.1.1)
+- `InputMissingAutocomplete` rule: detects `<input>` elements without an `autocomplete` attribute (WCAG 1.3.5)
+- `AnchorMissingAccessibleName` rule: detects `<a>` elements without text content, `aria-label`, or a child image with `alt` (WCAG 4.1.2)
+- `ButtonMissingAccessibleName` rule: detects `<button>` elements without text content, `aria-label`, or a child image with `alt` (WCAG 4.1.2)
+
+### Changed
+
+- **Breaking:** Split `MissingAccessibleName` into `LinkToMissingAccessibleName` (for `link_to`/`external_link_to`) and `ButtonTagMissingAccessibleName` (for `button_tag`) to follow one-rule-per-helper convention
+- **Breaking:** Rename `A11y::Lint::Rule` to `A11y::Lint::NodeRule`. Custom rules that subclass the base class must update the parent class name
+- Auto-require all rule files instead of listing them individually
+- Node attribute storage now preserves string values, enabling rules to check attribute values (not just existence)
+
+### Fixed
+
+- `LinkToMissingAccessibleName` / `ButtonTagMissingAccessibleName`: no longer flag `link_to`/`button_tag` blocks containing an `image_tag` with a non-empty `alt` option
+
 ## [0.10.0] - 2026-04-15
 
 ### Changed

data/CLAUDE.md

@@ -32,6 +32,16 @@ a11y-lint is a Ruby gem (v0.1.0) for accessibility linting. It uses the `A11y::L
 - **Tests:** `test/` directory using Minitest; test helper at `test/test_helper.rb`
 - **Dummy app:** `test/fixtures/dummy_app/` — a fixture app with Slim/ERB/Phlex templates for end-to-end smoke testing before releases (`bundle exec a11y-lint test/fixtures/dummy_app`)
 
+## Rule Scoping Convention
+
+Each rule targets **one element or helper**, unless multiple elements share identical check logic (e.g., `<ul>` and `<ol>` in `ListInvalidChildren`).
+
+- **HTML element rules** are named after the element: `ImgMissingAlt`, `AreaMissingAlt`, `AnchorMissingAccessibleName`
+- **Rails helper rules** are named after the helper: `ImageTagMissingAlt`, `LinkToMissingAccessibleName`
+- HTML/helper pairs mirror each other (e.g., `ImgMissingAlt` / `ImageTagMissingAlt`)
+
+Do not bundle unrelated elements or helpers into a single rule just because they share a WCAG criterion.
+
 ## Code Style
 
 RuboCop is configured in `.rubocop.yml`:

data/lib/a11y/lint/block_inspection.rb

@@ -6,7 +6,7 @@ module A11y
     # Depends on the host class implementing
     # #block_has_text_children? and #block_body_codes.
     module BlockInspection
-      ICON_HELPERS = %w[inline_svg icon image_tag svg_icon].freeze
+      ICON_HELPERS = %w[inline_svg icon svg_icon].freeze
 
       def block_has_only_icon_helpers?
         return false if block_has_text_children?
@@ -14,15 +14,28 @@ module A11y
         codes = block_body_codes
         return true unless codes&.any?
 
-        codes.all? { |code| icon_helper_call?(code) }
+        codes.all? do |code|
+          icon_helper?(code) || decorative_image_tag?(code)
+        end
       end
 
       private
 
-      def icon_helper_call?(code)
+      def icon_helper?(code)
         call = RubyCode.new(code).call_node
         call && ICON_HELPERS.include?(call.method_name)
       end
+
+      # image_tag counts as decorative only when it lacks a non-empty
+      # alt. A non-empty alt provides the accessible name, matching how
+      # <a><img alt="Home"></a> is treated by
+      # AnchorMissingAccessibleName#child_image_has_alt?.
+      def decorative_image_tag?(code)
+        call = RubyCode.new(code).call_node
+        call &&
+          call.method_name == "image_tag" &&
+          !call.keyword_non_empty?(:alt)
+      end
     end
   end
 end

data/lib/a11y/lint/call_node.rb

@@ -30,6 +30,23 @@ module A11y
         end
       end
 
+      # True when the keyword is present AND its value is a non-empty
+      # string literal OR any non-string expression (dynamic — can't be
+      # statically proven empty, so treat as providing content).
+      # False when the key is absent or the value is an empty string
+      # literal.
+      def keyword_non_empty?(key)
+        return false unless (kw_hash = find_keyword_hash)
+
+        assoc = kw_hash.elements.find { |a| key_name(a) == key.to_s }
+        return false unless assoc
+
+        value = assoc.value
+        return !value.unescaped.empty? if value.is_a?(Prism::StringNode)
+
+        true
+      end
+
       def positional_args
         return [] unless @prism_node.arguments
 

data/lib/a11y/lint/cli.rb

@@ -71,10 +71,10 @@ module A11y
       end
 
       def lint_files(files)
-        rules = all_rules
-        slim_runner = SlimRunner.new(rules)
-        erb_runner = ErbRunner.new(rules)
-        phlex_runner = PhlexRunner.new(rules)
+        configuration = load_configuration
+        slim_runner = SlimRunner.new(configuration:)
+        erb_runner = ErbRunner.new(configuration:)
+        phlex_runner = PhlexRunner.new(configuration:)
 
         files.flat_map do |file|
           source = File.read(file)
@@ -91,18 +91,8 @@ module A11y
         end
       end
 
-      def all_rules
-        configuration = Configuration.load(
-          @config_path,
-          search_path: @argv.first || "."
-        )
-
-        Rules.constants.filter_map do |name|
-          klass = Rules.const_get(name)
-          next unless klass.is_a?(Class) && klass < Rule
-
-          klass if configuration.enabled?(klass.rule_name)
-        end
+      def load_configuration
+        Configuration.load(@config_path, search_path: @argv.first || ".")
       end
 
       def print_results(offenses)

data/lib/a11y/lint/configuration.rb

@@ -41,6 +41,20 @@ module A11y
 
         @config.dig(rule_name, "Enabled") != false
       end
+
+      def hidden_wrapper_classes
+        @hidden_wrapper_classes ||=
+          Array(@config["hidden_wrapper_classes"]).map(&:to_s).freeze
+      end
+
+      def enabled_rules
+        Rules.constants.filter_map do |name|
+          klass = Rules.const_get(name)
+          next unless klass.is_a?(Class) && klass < NodeRule
+
+          klass if enabled?(klass.rule_name)
+        end
+      end
     end
   end
 end

data/lib/a11y/lint/erb_element_node.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module A11y
+  module Lint
+    # Wraps a Nokogiri HTML element from an ERB template
+    # as a queryable node for lint rules.
+    class ErbElementNode
+      attr_reader :line, :configuration
+
+      def initialize(
+        nokogiri_node:, line:, configuration: Configuration.new
+      )
+        @nokogiri_node = nokogiri_node
+        @line = line
+        @configuration = configuration
+      end
+
+      def tag_name
+        @nokogiri_node.name
+      end
+
+      def attribute?(name)
+        attributes.key?(name)
+      end
+
+      def attributes
+        @attributes ||=
+          @nokogiri_node
+          .attributes
+          .transform_values(&:value)
+      end
+
+      def call_node
+        nil
+      end
+
+      def ruby_code
+        nil
+      end
+
+      def block_body_codes
+        nil
+      end
+
+      def block_has_text_children?
+        false
+      end
+
+      def text_content?
+        return false if hidden_wrapper?(@nokogiri_node)
+
+        visible_text_or_output?(@nokogiri_node)
+      end
+
+      # Returns direct element children wrapped as ErbElementNode objects.
+      # Excludes elements whose class attribute matches a configured
+      # hidden-wrapper class, since CSS-hidden subtrees do not contribute
+      # to the accessible name.
+      def children
+        @nokogiri_node.element_children.filter_map do |child|
+          next if hidden_wrapper?(child)
+
+          ErbElementNode.new(
+            nokogiri_node: child, line: child.line,
+            configuration: configuration
+          )
+        end
+      end
+
+      private
+
+      def visible_text_or_output?(node)
+        return false if hidden_wrapper?(node)
+        return true if own_text_or_marker?(node)
+
+        node.element_children.any? { |c| visible_text_or_output?(c) }
+      end
+
+      def own_text_or_marker?(node)
+        node.children.any? do |c|
+          next false unless c.text?
+
+          content = c.content
+          content.include?(ErbRunner::ERB_OUTPUT_MARKER) ||
+            !content.strip.empty?
+        end
+      end
+
+      def hidden_wrapper?(node)
+        classes = configuration.hidden_wrapper_classes
+        return false if classes.empty?
+
+        node_classes(node).any? { |klass| classes.include?(klass) }
+      end
+
+      def node_classes(node)
+        return [] unless node.respond_to?(:attributes)
+
+        value = node.attributes["class"]&.value
+        value.is_a?(String) ? value.split : []
+      end
+    end
+  end
+end

data/lib/a11y/lint/erb_output_node.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module A11y
+  module Lint
+    # Wraps an extracted ERB output tag (<%= ... %>)
+    # as a queryable node for lint rules.
+    class ErbOutputNode
+      include BlockInspection
+
+      attr_reader(:block_body_codes, :line, :ruby_code)
+
+      def initialize(
+        ruby_code:, line:,
+        block_body_codes: nil, block_has_text_children: false
+      )
+        @ruby_code = ruby_code
+        @line = line
+        @block_body_codes = block_body_codes
+        @block_has_text_children = block_has_text_children
+      end
+
+      def tag_name
+        nil
+      end
+
+      def attribute?(name)
+        attributes.key?(name)
+      end
+
+      def attributes
+        {}
+      end
+
+      def call_node
+        @call_node ||= RubyCode.new(ruby_code).call_node
+      end
+
+      def block_has_text_children?
+        @block_has_text_children
+      end
+
+      def children
+        []
+      end
+    end
+  end
+end

data/lib/a11y/lint/erb_runner.rb

@@ -8,13 +8,15 @@ module A11y
     class ErbRunner
       ERB_TAG = /<%.*?%>/m
       ERB_OUTPUT_TAG = /<%=\s*(.*?)\s*-?%>/m
+      ERB_OUTPUT_MARKER = "A11Y_LINT_ERB_OUTPUT"
       VOID_ELEMENTS = %w[
         area base br col embed hr img input
         link meta param source track wbr
       ].freeze
 
-      def initialize(rules)
-        @rules = rules
+      def initialize(rules = nil, configuration: Configuration.new)
+        @rules = rules || configuration.enabled_rules
+        @configuration = configuration
       end
 
       def run(source, filename:)
@@ -29,22 +31,30 @@ module A11y
 
       private
 
-      attr_reader :rules
+      attr_reader :rules, :configuration
 
       def check_html_nodes(source)
-        html = source.gsub(ERB_TAG, "")
+        html = source.gsub(ERB_OUTPUT_TAG, ERB_OUTPUT_MARKER)
+        html = html.gsub(ERB_TAG, "")
         doc = Nokogiri::HTML4::DocumentFragment.parse(html)
 
         doc.traverse do |nokogiri_node|
           next unless nokogiri_node.element?
           next unless source_confirmed_element?(html, nokogiri_node.name)
 
-          check_node(
-            ErbNode.new(nokogiri_node: nokogiri_node, line: nokogiri_node.line)
-          )
+          node = build_erb_element_node(nokogiri_node)
+          check_node(node)
         end
       end
 
+      def build_erb_element_node(nokogiri_node)
+        ErbElementNode.new(
+          nokogiri_node: nokogiri_node,
+          line: nokogiri_node.line,
+          configuration: configuration
+        )
+      end
+
       def source_confirmed_element?(html, tag_name)
         VOID_ELEMENTS.include?(tag_name) || html.include?("</#{tag_name}>")
       end
@@ -64,7 +74,7 @@ module A11y
         block_body_codes, block_has_text =
           extract_block_info(source, code, match_end)
 
-        ErbNode.new(
+        ErbOutputNode.new(
           ruby_code: code, line: line,
           block_body_codes: block_body_codes,
           block_has_text_children: block_has_text
@@ -79,10 +89,53 @@ module A11y
         return [nil, false] unless end_match
 
         block_content = rest[0...end_match.begin(0)]
-        codes = block_content.scan(ERB_OUTPUT_TAG).map { |m| m[0].strip }
-        text_only = block_content.gsub(ERB_TAG, "").strip
+        visible_codes_and_text(block_content)
+      end
+
+      # Returns [visible_codes, visible_non_output_text?] where "visible"
+      # means not inside a hidden-wrapper element (per configuration).
+      def visible_codes_and_text(block_content)
+        indexed_codes = []
+        html = indexed_marker_html(block_content, indexed_codes)
+        fragment = Nokogiri::HTML4::DocumentFragment.parse(html)
+        strip_hidden_wrappers!(fragment)
+
+        remaining = fragment.to_html
+        visible_codes = indexed_codes.each_with_index.filter_map do |code, i|
+          code if remaining.include?("#{ERB_OUTPUT_MARKER}#{i}_")
+        end
+        [visible_codes, non_marker_text?(remaining)]
+      end
+
+      def indexed_marker_html(block_content, codes)
+        block_content.gsub(ERB_OUTPUT_TAG) do
+          codes << Regexp.last_match(1).strip
+          "#{ERB_OUTPUT_MARKER}#{codes.length - 1}_"
+        end.gsub(ERB_TAG, "")
+      end
+
+      def non_marker_text?(html)
+        !html.gsub(/#{ERB_OUTPUT_MARKER}\d+_/, "").strip.empty?
+      end
+
+      def strip_hidden_wrappers!(node)
+        return if configuration.hidden_wrapper_classes.empty?
+
+        node.element_children.each do |child|
+          if hidden_wrapper_element?(child)
+            child.remove
+          else
+            strip_hidden_wrappers!(child)
+          end
+        end
+      end
+
+      def hidden_wrapper_element?(node)
+        value = node.attributes["class"]&.value
+        return false unless value.is_a?(String)
 
-        [codes, !text_only.empty?]
+        classes = configuration.hidden_wrapper_classes
+        value.split.any? { |klass| classes.include?(klass) }
       end
 
       def check_node(node)

data/lib/a11y/lint/{rule.rb → node_rule.rb}

@@ -2,8 +2,8 @@
 
 module A11y
   module Lint
-    # Base class for accessibility lint rules.
-    class Rule
+    # Base class for per-node accessibility lint rules.
+    class NodeRule
       def self.check(node)
         new(node).check
       end

data/lib/a11y/lint/phlex_node.rb

@@ -13,6 +13,7 @@ module A11y
         :block_body_codes,
         :call_node,
         :children,
+        :configuration,
         :line,
         :tag_name
       )
@@ -22,7 +23,9 @@ module A11y
         line:, tag_name: nil, attributes: {},
         call_node: nil, children: [],
         block_body_codes: nil,
-        block_has_text_children: false
+        block_has_text_children: false,
+        text_content: false,
+        configuration: Configuration.new
       )
         @tag_name = tag_name
         @attributes = attributes
@@ -31,6 +34,8 @@ module A11y
         @children = children
         @block_body_codes = block_body_codes
         @block_has_text_children = block_has_text_children
+        @text_content = text_content
+        @configuration = configuration
       end
       # rubocop:enable Metrics/ParameterLists
 
@@ -46,35 +51,56 @@ module A11y
         @block_has_text_children
       end
 
-      def self.build_tag(call_node, children: [])
+      def text_content?
+        @text_content
+      end
+
+      def self.build_tag(
+        call_node, children: [], text_content: false,
+        configuration: Configuration.new
+      )
         name = call_node.name.to_s
         new(
           tag_name: html_tag_name(name),
           attributes: extract_attributes(call_node),
           line: call_node.location.start_line,
-          children: children
+          children: children,
+          text_content: text_content,
+          configuration: configuration
         )
       end
 
       def self.build_helper(
         call_node,
         block_body_codes: nil,
-        block_has_text_children: false
+        block_has_text_children: false,
+        configuration: Configuration.new
       )
         new(
           call_node: CallNode.new(call_node),
           line: call_node.location.start_line,
           block_body_codes: block_body_codes,
-          block_has_text_children: block_has_text_children
+          block_has_text_children: block_has_text_children,
+          configuration: configuration
         )
       end
 
+      def self.kwarg_class_values(call_node)
+        return [] unless call_node.arguments
+
+        value = kwarg_nodes(call_node).find do |elem|
+          kwarg_key(elem.key) == "class"
+        end&.value
+
+        value.is_a?(Prism::StringNode) ? value.unescaped.split : []
+      end
+
       def self.extract_attributes(call_node)
         return {} unless call_node.arguments
 
         kwarg_nodes(call_node).each_with_object({}) do |elem, h|
           key = kwarg_key(elem.key)
-          h[key] = true if key
+          h[key] = kwarg_value(elem.value) if key
         end
       end
 
@@ -91,7 +117,15 @@ module A11y
         end
       end
 
-      private_class_method :kwarg_key, :kwarg_nodes,
+      def self.kwarg_value(value_node)
+        case value_node
+        when Prism::StringNode then value_node.unescaped
+        when Prism::SymbolNode then value_node.value
+        else true
+        end
+      end
+
+      private_class_method :kwarg_key, :kwarg_nodes, :kwarg_value,
                            :extract_attributes
     end
   end

data/lib/a11y/lint/phlex_runner.rb

@@ -9,8 +9,9 @@ module A11y
     class PhlexRunner
       PHLEX_PATTERN = /\bdef\s+view_template\b/
 
-      def initialize(rules)
-        @rules = rules
+      def initialize(rules = nil, configuration: Configuration.new)
+        @rules = rules || configuration.enabled_rules
+        @configuration = configuration
       end
 
       def run(source, filename:)
@@ -26,7 +27,7 @@ module A11y
 
       private
 
-      attr_reader :rules
+      attr_reader :rules, :configuration
 
       def walk(node)
         if receiverless_call?(node)
@@ -46,7 +47,15 @@ module A11y
 
       def check_tag(node)
         children = collect_block_children(node.block)
-        check_node(PhlexNode.build_tag(node, children:))
+        has_text = tag_block_has_text?(node.block, children)
+        check_node(
+          PhlexNode.build_tag(
+            node,
+            children: children,
+            text_content: has_text,
+            configuration: configuration
+          )
+        )
       end
 
       def check_helper(node)
@@ -54,7 +63,8 @@ module A11y
         helper = PhlexNode.build_helper(
           node,
           block_body_codes: codes,
-          block_has_text_children: has_text
+          block_has_text_children: has_text,
+          configuration: configuration
         )
         check_node(helper)
         walk_block(node.block)
@@ -80,8 +90,39 @@ module A11y
 
       def gather_tag_child(child, result)
         kids = collect_block_children(child.block)
-        result << PhlexNode.build_tag(child, children: kids)
-        check_node(result.last)
+        has_text = tag_block_has_text?(child.block, kids)
+        tag = PhlexNode.build_tag(
+          child, children: kids, text_content: has_text,
+                 configuration: configuration
+        )
+        check_node(tag)
+        result << tag unless hidden_wrapper_tag?(child)
+      end
+
+      def hidden_wrapper_tag?(call_node)
+        classes = configuration.hidden_wrapper_classes
+        return false if classes.empty?
+
+        tag_class_values(call_node).any? { |klass| classes.include?(klass) }
+      end
+
+      def tag_class_values(call_node)
+        return [] unless call_node.arguments
+
+        PhlexNode.kwarg_class_values(call_node)
+      end
+
+      def tag_block_has_text?(block, children)
+        return false unless block.is_a?(Prism::BlockNode)
+
+        scan_for_text(block) || children.any?(&:text_content?)
+      end
+
+      def scan_for_text(node)
+        node.child_nodes.compact.any? do |child|
+          text_call?(child) || child.is_a?(Prism::YieldNode) ||
+            (!receiverless_call?(child) && scan_for_text(child))
+        end
       end
 
       def analyze_helper_block(call_node)
@@ -94,8 +135,10 @@ module A11y
       end
 
       # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
       def scan_block_content(node, codes)
         node.child_nodes.compact.each do |child|
+          next if tag_call?(child) && hidden_wrapper_tag?(child)
           return true if child.is_a?(Prism::YieldNode)
           return true if tag_call?(child) && child.block
           next if tag_call?(child)
@@ -105,6 +148,7 @@ module A11y
         false
       end
       # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity
 
       def walk_block(block)
         return unless block.is_a?(Prism::BlockNode)
@@ -116,6 +160,10 @@ module A11y
         receiverless_call?(node) && PhlexNode.html_tag?(node.name.to_s)
       end
 
+      def text_call?(node)
+        receiverless_call?(node) && node.name.to_s == "plain"
+      end
+
       def receiverless_call?(node)
         node.is_a?(Prism::CallNode) && node.receiver.nil?
       end

data/lib/a11y/lint/phlex_tags.rb

@@ -14,6 +14,7 @@ module A11y
         %w[
           a
           abbr
+          area
           address
           article
           aside

data/lib/a11y/lint/rules/perceivable/area_missing_alt.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module A11y
+  module Lint
+    module Rules
+      # Checks that area tags include an alt attribute (WCAG 1.1.1).
+      # https://www.w3.org/WAI/WCAG21/Techniques/html/H24
+      class AreaMissingAlt < NodeRule
+        def check
+          return unless an_area_without_an_alt_attribute?
+
+          "area tag is missing an alt attribute (WCAG 1.1.1)"
+        end
+
+        private
+
+        def an_area_without_an_alt_attribute?
+          node.tag_name == "area" && !node.attribute?("alt")
+        end
+      end
+    end
+  end
+end

data/lib/a11y/lint/rules/perceivable/image_submit_tag_missing_alt.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module A11y
+  module Lint
+    module Rules
+      # Checks that image_submit_tag calls include an alt option (WCAG 1.1.1).
+      # https://www.w3.org/WAI/WCAG21/Techniques/html/H36
+      class ImageSubmitTagMissingAlt < NodeRule
+        def check
+          return if no_offense?
+
+          "image_submit_tag is missing an alt option (WCAG 1.1.1)"
+        end
+
+        private
+
+        def no_offense?
+          !image_submit_tag || image_submit_tag.keyword?(:alt)
+        end
+
+        def image_submit_tag
+          @image_submit_tag ||= node.call_node&.find("image_submit_tag")
+        end
+      end
+    end
+  end
+end

data/lib/a11y/lint/rules/perceivable/image_tag_missing_alt.rb

@@ -4,7 +4,7 @@ module A11y
   module Lint
     module Rules
       # Checks that image_tag calls include an alt option (WCAG 1.1.1).
-      class ImageTagMissingAlt < Rule
+      class ImageTagMissingAlt < NodeRule
         def check
           return if no_offense?
 

data/lib/a11y/lint/rules/perceivable/img_missing_alt.rb

@@ -4,7 +4,7 @@ module A11y
   module Lint
     module Rules
       # Checks that img tags include an alt attribute (WCAG 1.1.1).
-      class ImgMissingAlt < Rule
+      class ImgMissingAlt < NodeRule
         def check
           return unless an_image_without_an_alt_attribute?
 

data/lib/a11y/lint/rules/perceivable/input_image_missing_alt.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module A11y
+  module Lint
+    module Rules
+      # Checks that <input type="image"> tags include an alt
+      # attribute (WCAG 1.1.1).
+      # https://www.w3.org/WAI/WCAG21/Techniques/html/H36
+      class InputImageMissingAlt < NodeRule
+        def check
+          return unless an_input_image_without_an_alt_attribute?
+
+          "input type=\"image\" is missing an alt attribute (WCAG 1.1.1)"
+        end
+
+        private
+
+        def an_input_image_without_an_alt_attribute?
+          node.tag_name == "input" &&
+            node.attributes["type"] == "image" &&
+            !node.attribute?("alt")
+        end
+      end
+    end
+  end
+end

data/lib/a11y/lint/rules/perceivable/input_missing_autocomplete.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module A11y
+  module Lint
+    module Rules
+      # Checks that <input> elements include an autocomplete
+      # attribute (WCAG 1.3.5).
+      # https://www.w3.org/WAI/WCAG21/Understanding/identify-input-purpose.html
+      class InputMissingAutocomplete < NodeRule
+        EXCLUDED_TYPES = %w[
+          button
+          checkbox
+          file
+          hidden
+          image
+          radio
+          reset
+          submit
+        ].freeze
+
+        def check
+          return unless an_input_missing_autocomplete?
+
+          "input is missing an autocomplete attribute (WCAG 1.3.5)"
+        end
+
+        private
+
+        def an_input_missing_autocomplete?
+          node.tag_name == "input" &&
+            !EXCLUDED_TYPES.include?(node.attributes["type"]) &&
+            !node.attribute?("autocomplete")
+        end
+      end
+    end
+  end
+end

data/lib/a11y/lint/rules/perceivable/list_invalid_children.rb

@@ -5,7 +5,7 @@ module A11y
     module Rules
       # Checks that <ul> and <ol> only directly contain <li>, <script>,
       # or <template> elements (WCAG 1.3.1).
-      class ListInvalidChildren < Rule
+      class ListInvalidChildren < NodeRule
         LIST_TAGS = %w[ul ol].freeze
         ALLOWED_CHILDREN = %w[li script template].freeze
 

data/lib/a11y/lint/rules/robust/anchor_missing_accessible_name.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module A11y
+  module Lint
+    module Rules
+      # Checks that <a> elements with no text content or meaningful
+      # child elements include an aria-label (WCAG 4.1.2).
+      class AnchorMissingAccessibleName < NodeRule
+        def check
+          return if no_offense?
+
+          "a tag is missing an accessible name " \
+            "requires an aria-label (WCAG 4.1.2)"
+        end
+
+        private
+
+        def no_offense?
+          node.tag_name != "a" ||
+            aria_label? ||
+            node.text_content? ||
+            child_image_has_alt?
+        end
+
+        def aria_label?
+          node.attribute?("aria-label") || node.attribute?("aria_label")
+        end
+
+        def child_image_has_alt?
+          node.children.any? do |child|
+            child.tag_name == "img" && non_empty_alt?(child)
+          end
+        end
+
+        def non_empty_alt?(child)
+          alt = child.attributes["alt"]
+          alt.is_a?(String) && !alt.strip.empty?
+        end
+      end
+    end
+  end
+end

data/lib/a11y/lint/rules/robust/button_missing_accessible_name.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module A11y
+  module Lint
+    module Rules
+      # Checks that <button> elements with no text content or meaningful
+      # child elements include an aria-label (WCAG 4.1.2).
+      class ButtonMissingAccessibleName < NodeRule
+        def check
+          return if no_offense?
+
+          "button tag is missing an accessible name " \
+            "requires an aria-label (WCAG 4.1.2)"
+        end
+
+        private
+
+        def no_offense?
+          node.tag_name != "button" ||
+            aria_label? ||
+            node.text_content? ||
+            child_image_has_alt?
+        end
+
+        def aria_label?
+          node.attribute?("aria-label") || node.attribute?("aria_label")
+        end
+
+        def child_image_has_alt?
+          node.children.any? do |child|
+            child.tag_name == "img" && non_empty_alt?(child)
+          end
+        end
+
+        def non_empty_alt?(child)
+          alt = child.attributes["alt"]
+          alt.is_a?(String) && !alt.strip.empty?
+        end
+      end
+    end
+  end
+end

data/lib/a11y/lint/rules/robust/button_tag_missing_accessible_name.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module A11y
+  module Lint
+    module Rules
+      # Checks that button_tag calls with empty text or block content
+      # include an aria-label (WCAG 4.1.2).
+      class ButtonTagMissingAccessibleName < NodeRule
+        def check
+          return if no_offense?
+
+          offense_message
+        end
+
+        private
+
+        def no_offense?
+          !helper_call ||
+            aria_label? ||
+            !(helper_call.first_positional_arg_empty_string? ||
+              (helper_call.block? && node.block_has_only_icon_helpers?))
+        end
+
+        def aria_label?
+          helper_call.keyword?(:aria, :label) ||
+            helper_call.keyword?(:"aria-label")
+        end
+
+        def helper_call
+          @helper_call ||= begin
+            call = node.call_node
+            call if call && call.method_name == "button_tag"
+          end
+        end
+
+        def offense_message
+          <<~MSG.strip
+            button_tag missing an accessible name \
+            requires an aria-label (WCAG 4.1.2)
+          MSG
+        end
+      end
+    end
+  end
+end

data/lib/a11y/lint/rules/robust/{missing_accessible_name.rb → link_to_missing_accessible_name.rb}

@@ -3,10 +3,10 @@
 module A11y
   module Lint
     module Rules
-      # Checks that link_to, external_link_to, and button_tag calls with
-      # empty text or block content include an aria-label (WCAG 4.1.2).
-      class MissingAccessibleName < Rule
-        METHODS = %w[link_to external_link_to button_tag].freeze
+      # Checks that link_to and external_link_to calls with empty text or
+      # block content include an aria-label (WCAG 4.1.2).
+      class LinkToMissingAccessibleName < NodeRule
+        METHODS = %w[link_to external_link_to].freeze
 
         def check
           return if no_offense?

data/lib/a11y/lint/slim_node.rb

@@ -6,11 +6,12 @@ module A11y
     class SlimNode
       include BlockInspection
 
-      attr_reader :line
+      attr_reader :line, :configuration
 
-      def initialize(sexp, line:)
+      def initialize(sexp, line:, configuration: Configuration.new)
         @sexp = sexp
         @line = line
+        @configuration = configuration
       end
 
       def tag_name
@@ -62,7 +63,16 @@ module A11y
       def block_has_text_children?
         return false unless slim_output?
 
-        text_content?(@sexp[4])
+        block_text_content?(@sexp[4])
+      end
+
+      # Returns true when the HTML element body contains visible text
+      # or dynamic output (i.e. content that could provide an accessible
+      # name). Only meaningful for HTML tag nodes.
+      def text_content?
+        return false unless html_tag?
+
+        text_or_output?(@sexp[4])
       end
 
       private
@@ -81,6 +91,7 @@ module A11y
 
       def collect_output_codes(sexp)
         return [] unless sexp.is_a?(Array)
+        return [] if hidden_wrapper_sexp?(sexp)
         return [sexp[3]] if slim_output_sexp?(sexp)
 
         sexp.flat_map { |child| collect_output_codes(child) }
@@ -90,11 +101,66 @@ module A11y
         sexp.is_a?(Array) && sexp[0] == :slim && sexp[1] == :output
       end
 
-      def text_content?(sexp)
+      def block_text_content?(sexp)
         return false unless sexp.is_a?(Array)
+        return false if hidden_wrapper_sexp?(sexp)
         return true if slim_text_sexp?(sexp) || html_tag_sexp?(sexp)
 
-        sexp.any? { |child| text_content?(child) }
+        sexp.any? { |child| block_text_content?(child) }
+      end
+
+      def text_or_output?(sexp)
+        return false unless sexp.is_a?(Array)
+        return false if hidden_wrapper_sexp?(sexp)
+        return true if slim_text_sexp?(sexp) || slim_output_sexp?(sexp)
+
+        sexp.any? { |child| text_or_output?(child) }
+      end
+
+      def hidden_wrapper_sexp?(sexp)
+        return false unless html_tag_sexp?(sexp)
+        return false if configuration.hidden_wrapper_classes.empty?
+
+        class_values(sexp[3]).any? do |klass|
+          configuration.hidden_wrapper_classes.include?(klass)
+        end
+      end
+
+      def class_values(attrs_sexp)
+        return [] unless attrs_sexp.is_a?(Array) &&
+                         attrs_sexp[0] == :html && attrs_sexp[1] == :attrs
+
+        attrs_sexp[2..].flat_map { |attr| class_values_for_attr(attr) }
+      end
+
+      def class_values_for_attr(attr)
+        return [] unless attr.is_a?(Array) &&
+                         attr[0] == :html && attr[1] == :attr &&
+                         attr[2] == "class"
+
+        value = static_class_string(attr[3])
+        value ? value.split : []
+      end
+
+      # Extracts a static class string from the two forms Slim emits:
+      # `[:static, "name"]` for class shortcuts (`.popover`) and
+      # `[:escape, true, [:slim, :interpolate, "name"]]` for `class="..."`.
+      def static_class_string(value_sexp)
+        return unless value_sexp.is_a?(Array)
+        return static_sexp_value(value_sexp) if value_sexp[0] == :static
+
+        interpolate_sexp_value(value_sexp)
+      end
+
+      def static_sexp_value(sexp)
+        sexp[1] if sexp[1].is_a?(String)
+      end
+
+      def interpolate_sexp_value(sexp)
+        return unless sexp[0] == :escape && sexp[2].is_a?(Array)
+        return unless sexp[2][0] == :slim && sexp[2][1] == :interpolate
+
+        sexp[2][2] if sexp[2][2].is_a?(String)
       end
 
       def slim_text_sexp?(sexp)
@@ -103,7 +169,11 @@ module A11y
 
       def collect_children(sexp)
         return [] unless sexp.is_a?(Array)
-        return [SlimNode.new(sexp, line: @line)] if html_tag_sexp?(sexp)
+
+        if html_tag_sexp?(sexp)
+          return [SlimNode.new(sexp, line: @line, configuration: configuration)]
+        end
+
         return collect_children(sexp[3]) if slim_control_sexp?(sexp)
         return [] unless sexp[0] == :multi
 
@@ -122,7 +192,19 @@ module A11y
         return {} unless html_attributes?
 
         sexp_attributes[2..].each_with_object({}) do |attr_sexp, result|
-          result[attr_sexp[2]] = true if html_attribute?(attr_sexp)
+          next unless html_attribute?(attr_sexp)
+
+          result[attr_sexp[2]] = static_value(attr_sexp[3])
+        end
+      end
+
+      def static_value(value_sexp)
+        if value_sexp.is_a?(Array) && value_sexp[0] == :escape &&
+           value_sexp[2].is_a?(Array) &&
+           value_sexp[2][0] == :slim && value_sexp[2][1] == :interpolate
+          value_sexp[2][2]
+        else
+          true
         end
       end
 

data/lib/a11y/lint/slim_runner.rb

@@ -4,8 +4,9 @@ module A11y
   module Lint
     # Parses Slim templates and checks them against accessibility rules.
     class SlimRunner
-      def initialize(rules)
-        @rules = rules
+      def initialize(rules = nil, configuration: Configuration.new)
+        @rules = rules || configuration.enabled_rules
+        @configuration = configuration
       end
 
       def run(source, filename:)
@@ -22,13 +23,13 @@ module A11y
 
       private
 
-      attr_reader(:rules)
+      attr_reader(:rules, :configuration)
 
       def walk(sexp)
         return unless node?(sexp)
 
         @line += 1 if sexp[0] == :newline
-        new_node = SlimNode.new(sexp, line: @line)
+        new_node = SlimNode.new(sexp, line: @line, configuration:)
         check_node(new_node) if html_tag?(sexp) || slim_output?(sexp)
         @line += continuation_newlines(sexp)
         sexp.each { |child| walk(child) }

data/lib/a11y/lint/version.rb

@@ -2,6 +2,6 @@
 
 module A11y
   module Lint
-    VERSION = "0.10.0"
+    VERSION = "0.12.0"
   end
 end

data/lib/a11y/lint.rb

@@ -8,15 +8,13 @@ require_relative "lint/call_node"
 require_relative "lint/ruby_code"
 require_relative "lint/block_inspection"
 require_relative "lint/slim_node"
-require_relative "lint/erb_node"
+require_relative "lint/erb_element_node"
+require_relative "lint/erb_output_node"
 require_relative "lint/phlex_tags"
 require_relative "lint/phlex_node"
 require_relative "lint/configuration"
-require_relative "lint/rule"
-require_relative "lint/rules/perceivable/image_tag_missing_alt"
-require_relative "lint/rules/perceivable/img_missing_alt"
-require_relative "lint/rules/perceivable/list_invalid_children"
-require_relative "lint/rules/robust/missing_accessible_name"
+require_relative "lint/node_rule"
+Dir[File.join(__dir__, "lint", "rules", "**", "*.rb")].each { |f| require f }
 require_relative "lint/slim_runner"
 require_relative "lint/erb_runner"
 require_relative "lint/phlex_runner"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: a11y-lint
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Abdullah Hashim
@@ -59,19 +59,27 @@ files:
 - lib/a11y/lint/call_node.rb
 - lib/a11y/lint/cli.rb
 - lib/a11y/lint/configuration.rb
-- lib/a11y/lint/erb_node.rb
+- lib/a11y/lint/erb_element_node.rb
+- lib/a11y/lint/erb_output_node.rb
 - lib/a11y/lint/erb_runner.rb
 - lib/a11y/lint/errors.rb
+- lib/a11y/lint/node_rule.rb
 - lib/a11y/lint/offense.rb
 - lib/a11y/lint/phlex_node.rb
 - lib/a11y/lint/phlex_runner.rb
 - lib/a11y/lint/phlex_tags.rb
 - lib/a11y/lint/ruby_code.rb
-- lib/a11y/lint/rule.rb
+- lib/a11y/lint/rules/perceivable/area_missing_alt.rb
+- lib/a11y/lint/rules/perceivable/image_submit_tag_missing_alt.rb
 - lib/a11y/lint/rules/perceivable/image_tag_missing_alt.rb
 - lib/a11y/lint/rules/perceivable/img_missing_alt.rb
+- lib/a11y/lint/rules/perceivable/input_image_missing_alt.rb
+- lib/a11y/lint/rules/perceivable/input_missing_autocomplete.rb
 - lib/a11y/lint/rules/perceivable/list_invalid_children.rb
-- lib/a11y/lint/rules/robust/missing_accessible_name.rb
+- lib/a11y/lint/rules/robust/anchor_missing_accessible_name.rb
+- lib/a11y/lint/rules/robust/button_missing_accessible_name.rb
+- lib/a11y/lint/rules/robust/button_tag_missing_accessible_name.rb
+- lib/a11y/lint/rules/robust/link_to_missing_accessible_name.rb
 - lib/a11y/lint/slim_node.rb
 - lib/a11y/lint/slim_runner.rb
 - lib/a11y/lint/version.rb

data/lib/a11y/lint/erb_node.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-module A11y
-  module Lint
-    # Wraps a Nokogiri node or extracted ERB output tag
-    # as a queryable node for lint rules.
-    class ErbNode
-      include BlockInspection
-
-      attr_reader(:block_body_codes, :line, :ruby_code)
-
-      def initialize(
-        line:,
-        block_body_codes: nil,
-        block_has_text_children: false,
-        nokogiri_node: nil,
-        ruby_code: nil
-      )
-        @line = line
-        @block_body_codes = block_body_codes
-        @block_has_text_children = block_has_text_children
-        @nokogiri_node = nokogiri_node
-        @ruby_code = ruby_code
-      end
-
-      def tag_name
-        nokogiri_node&.name
-      end
-
-      def attribute?(name)
-        attributes.key?(name)
-      end
-
-      def attributes
-        @attributes ||= extract_attributes
-      end
-
-      def call_node
-        @call_node ||= RubyCode.new(ruby_code).call_node
-      end
-
-      def block_has_text_children?
-        @block_has_text_children
-      end
-
-      # Returns direct element children wrapped as ErbNode objects.
-      def children
-        return [] unless nokogiri_node
-
-        nokogiri_node.element_children.map do |child|
-          ErbNode.new(nokogiri_node: child, line: child.line)
-        end
-      end
-
-      private
-
-      attr_reader(:nokogiri_node)
-
-      def extract_attributes
-        return {} unless nokogiri_node
-
-        nokogiri_node
-          .attributes
-          .each_with_object({}) do |(name, _attr), result|
-            result[name] = true
-        end
-      end
-    end
-  end
-end