a11y-lint 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcce561f67949c3ba5eb95447325e06ce67c2e759733c0623168ce5948183222
-  data.tar.gz: 59a739dcb7b14d79d2b8c7a4bb135853c04f3f1e79558cf8ddc05c0435c52a18
+  metadata.gz: a0d462b5e30cff7f4b1c5adaa3eeb9d2ac1a1aa9d3dad477b1841e38e271f22a
+  data.tar.gz: 66d8731b7371b98e4fede0445536d994fcd3405721dfb0617f1c139bd5fce925
 SHA512:
-  metadata.gz: d03e078e621d82b48f114f6f8a2ecfa7bf05f746892bf5640c6ee5e5817ac740ee086ddb6dab3a7c993436d653bbd38f15967696a58f41802d335a67a22ab2ea
-  data.tar.gz: 1a07a2c565896cde540e09adc8352602166ce7da1ecdcb555c52220a8fc764504abab43bf17ebefb0fe436ca4cff3835d9bae355fd620d08b3f64c6dcf83d291
+  metadata.gz: 6459a600d8cbd2465d5a9096eb99e36f319d1576cc685273b78505c636c15f77590104eec89ff4142d6525f70d5fc861822837fdf55cca9ed1afbad9a20011b5
+  data.tar.gz: 3c22904b9d168f559b9bc83522e1a5422fad6f2dd3d5beffd158ad06135ef6dacc85fdf3d832970b330ed1f4fd25c68a41b3bd8a34ef57ca6df8c2211a694dca

data/CHANGELOG.md

@@ -5,7 +5,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [0.8.0] - 2026-04-14
+
+### Added
+
+- Phlex view support: scans `.rb` files containing Phlex components
+  - Detects Phlex files by the presence of a `def view_template` method
+  - All existing rules (`ImgMissingAlt`, `ImageTagMissingAlt`, `ListInvalidChildren`, `MissingAccessibleName`) work with Phlex views
+  - CLI automatically discovers `.rb` files when scanning directories
+
+### Changed
+
+- **Breaking:** `Node` has been renamed to `SlimNode` for consistency with `ErbNode` and `PhlexNode`
+
+### Dependencies
+
+- Added `prism` gem for Ruby AST parsing
 
 ## [0.7.2] - 2026-04-13
 

data/CLAUDE.md

@@ -19,16 +19,17 @@ a11y-lint is a Ruby gem (v0.1.0) for accessibility linting. It uses the `A11y::L
 
 ## Architecture
 
-- **CLI:** `lib/a11y/lint/cli.rb` — command-line interface; executable at `exe/a11y-lint`; routes `.slim` files to `SlimRunner` and `.erb` files to `ErbRunner`
+- **CLI:** `lib/a11y/lint/cli.rb` — command-line interface; executable at `exe/a11y-lint`; routes `.slim` files to `SlimRunner`, `.erb` files to `ErbRunner`, and `.rb` files to `PhlexRunner`
 - **Entry point:** `lib/a11y/lint.rb` — defines the `A11y::Lint` module and `A11y::Lint::Error` exception
-- **Slim pipeline:** `SlimRunner` parses Slim templates via `Slim::Parser`; `Node` wraps Slim S-expressions
+- **Slim pipeline:** `SlimRunner` parses Slim templates via `Slim::Parser`; `SlimNode` wraps Slim S-expressions
 - **ERB pipeline:** `ErbRunner` parses ERB templates via Nokogiri; `ErbNode` wraps Nokogiri nodes and extracted `<%= %>` Ruby code
+- **Phlex pipeline:** `PhlexRunner` parses Phlex view classes via Prism; `PhlexNode` wraps Prism AST call nodes; detects Phlex files by the presence of `def view_template`
 - **Configuration:** `lib/a11y/lint/configuration.rb` — loads `.a11y-lint.yml` to enable/disable individual rules; searches upward from the target path
 - **Rules:** `lib/a11y/lint/rules/` — organized by WCAG principle (`perceivable/`, `operable/`, `understandable/`, `robust/`); rules implement `check(node)` against the shared node interface (`tag_name`, `attribute?`, `attributes`, `ruby_code`, `line`)
 - **Version:** `lib/a11y/lint/version.rb`
 - **Type signatures (RBS):** `sig/a11y/lint.rbs`
 - **Tests:** `test/` directory using Minitest; test helper at `test/test_helper.rb`
-- **Dummy app:** `test/fixtures/dummy_app/` — a fixture app with Slim/ERB templates for end-to-end smoke testing before releases (`bundle exec a11y-lint test/fixtures/dummy_app`)
+- **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`)
 
 ## Code Style
 

data/README.md

@@ -33,7 +33,7 @@ a11y-lint app/views/
 a11y-lint app/views/home.html.slim app/views/about.html.slim
 ```
 
-With no arguments, it scans the current directory recursively for `.slim` and `.erb` files:
+With no arguments, it scans the current directory recursively for `.slim`, `.erb`, and `.rb` (Phlex) files:
 
 ```bash
 a11y-lint
@@ -64,10 +64,21 @@ a11y-lint --config path/to/.a11y-lint.yml app/views/
 ```ruby
 require "a11y/lint"
 
+# Slim
 source = File.read("app/views/home.html.slim")
-runner = A11y::Lint::SlimRunner.new([A11y::Lint::Rules::ImgMissingAlt.new])
+runner = A11y::Lint::SlimRunner.new([A11y::Lint::Rules::ImgMissingAlt])
 offenses = runner.run(source, filename: "app/views/home.html.slim")
 
+# ERB
+source = File.read("app/views/home.html.erb")
+runner = A11y::Lint::ErbRunner.new([A11y::Lint::Rules::ImgMissingAlt])
+offenses = runner.run(source, filename: "app/views/home.html.erb")
+
+# Phlex
+source = File.read("app/views/home_view.rb")
+runner = A11y::Lint::PhlexRunner.new([A11y::Lint::Rules::ImgMissingAlt])
+offenses = runner.run(source, filename: "app/views/home_view.rb")
+
 offenses.each do |offense|
   puts "#{offense.filename}:#{offense.line} [#{offense.rule}] #{offense.message}"
 end

data/lib/a11y/lint/cli.rb

@@ -19,7 +19,7 @@ module A11y
         files = resolve_files(@argv)
 
         if files.empty?
-          @stderr.puts("No .slim or .erb files found")
+          @stderr.puts("No .slim, .erb, or .rb files found")
           return 0
         end
 
@@ -62,7 +62,7 @@ module A11y
 
       def expand_path(path)
         if File.directory?(path)
-          Dir.glob(File.join(path, "**", "*.{slim,erb}"))
+          Dir.glob(File.join(path, "**", "*.{slim,erb,rb}"))
         elsif File.file?(path)
           [path]
         else
@@ -75,14 +75,23 @@ module A11y
         rules = all_rules
         slim_runner = SlimRunner.new(rules)
         erb_runner = ErbRunner.new(rules)
+        phlex_runner = PhlexRunner.new(rules)
 
         files.flat_map do |file|
           source = File.read(file)
-          runner = file.end_with?(".erb") ? erb_runner : slim_runner
+          runner = runner_for(file, slim_runner, erb_runner, phlex_runner)
           runner.run(source, filename: file)
         end
       end
 
+      def runner_for(file, slim_runner, erb_runner, phlex_runner)
+        case File.extname(file)
+        when ".erb" then erb_runner
+        when ".rb" then phlex_runner
+        else slim_runner
+        end
+      end
+
       def all_rules
         configuration = Configuration.load(
           @config_path,

data/lib/a11y/lint/phlex_node.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module A11y
+  module Lint
+    # Wraps a Phlex HTML tag call or helper method call
+    # as a queryable node for lint rules.
+    class PhlexNode
+      attr_reader :line, :children
+
+      # Phlex method names that map to a different HTML tag.
+      TAG_ALIASES = {
+        "ruby_element" => "ruby",
+        "template_tag" => "template"
+      }.freeze
+
+      HTML_TAGS = Set.new(
+        %w[
+          a abbr address article aside b bdi bdo
+          blockquote body br button caption cite code
+          col colgroup data datalist dd del details dfn
+          dialog div dl dt em embed fieldset figcaption
+          figure footer form h1 h2 h3 h4 h5 h6 head
+          header hgroup hr html i iframe img input ins
+          kbd label legend li link main map mark menu
+          meter nav noscript object ol optgroup option
+          output p picture pre progress q rp rt
+          ruby_element s samp script search section
+          select slot small span strong style sub
+          summary sup table tbody td template_tag
+          textarea tfoot th thead time title tr u ul
+          var video wbr
+        ]
+      ).freeze
+
+      def initialize(
+        line:, tag_name: nil,
+        attributes: {}, ruby_code: nil, children: []
+      )
+        @tag_name_string = tag_name
+        @attributes_hash = attributes
+        @ruby_code_string = ruby_code
+        @line = line
+        @children = children
+      end
+
+      def tag_name
+        @tag_name_string
+      end
+
+      def attribute?(name)
+        @attributes_hash.key?(name)
+      end
+
+      def attributes
+        @attributes_hash
+      end
+
+      def ruby_code
+        @ruby_code_string
+      end
+
+      def self.html_tag?(method_name)
+        HTML_TAGS.include?(method_name)
+      end
+
+      def self.html_tag_name(method_name)
+        TAG_ALIASES.fetch(method_name, method_name)
+      end
+
+      def self.build_tag(call_node, children: [])
+        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
+        )
+      end
+
+      def self.build_helper(call_node, source)
+        new(
+          ruby_code: ruby_code_for(call_node, source),
+          line: call_node.location.start_line
+        )
+      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
+        end
+      end
+
+      def self.kwarg_nodes(call_node)
+        args = call_node.arguments.arguments
+        args.select { |a| a.is_a?(Prism::KeywordHashNode) }
+            .flat_map { |a| a.elements.select { |e| e.is_a?(Prism::AssocNode) } }
+      end
+
+      def self.kwarg_key(key_node)
+        case key_node
+        when Prism::SymbolNode then key_node.value
+        when Prism::StringNode then key_node.unescaped
+        end
+      end
+
+      def self.ruby_code_for(call_node, source)
+        return call_node.slice unless call_node.block
+
+        stop = call_node.block.location.start_offset
+        start = call_node.location.start_offset
+        "#{source[start...stop].rstrip} do"
+      end
+
+      private_class_method :kwarg_key, :kwarg_nodes,
+                           :ruby_code_for,
+                           :extract_attributes
+    end
+  end
+end

data/lib/a11y/lint/phlex_runner.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require "prism"
+
+module A11y
+  module Lint
+    # Parses Phlex view classes and checks them
+    # against accessibility rules.
+    class PhlexRunner
+      PHLEX_PATTERN = /\bdef\s+view_template\b/
+
+      def initialize(rules)
+        @rules = rules
+      end
+
+      def run(source, filename:)
+        return [] unless source.match?(PHLEX_PATTERN)
+
+        @source = source
+        @filename = filename
+        @offenses = []
+
+        walk(Prism.parse(source).value)
+        @offenses
+      end
+
+      private
+
+      attr_reader :rules
+
+      def walk(node)
+        if receiverless_call?(node)
+          process_call(node)
+        else
+          node.child_nodes.compact.each { |c| walk(c) }
+        end
+      end
+
+      def process_call(node)
+        name = node.name.to_s
+        if PhlexNode.html_tag?(name)
+          check_tag(node)
+        else
+          check_helper(node)
+        end
+      end
+
+      def check_tag(node)
+        children = collect_block_children(node.block)
+        check_node(PhlexNode.build_tag(node, children:))
+      end
+
+      def check_helper(node)
+        check_node(PhlexNode.build_helper(node, @source))
+        walk_block(node.block)
+      end
+
+      def collect_block_children(block)
+        return [] unless block.is_a?(Prism::BlockNode)
+
+        children = []
+        gather_children(block, children)
+        children
+      end
+
+      def gather_children(parent, result)
+        parent.child_nodes.compact.each do |child|
+          if tag_call?(child)
+            gather_tag_child(child, result)
+          elsif receiverless_call?(child)
+            check_helper(child)
+          else
+            gather_children(child, result)
+          end
+        end
+      end
+
+      def gather_tag_child(child, result)
+        kids = collect_block_children(child.block)
+        node = PhlexNode.build_tag(child, children: kids)
+        result << node
+        check_node(node)
+      end
+
+      def walk_block(block)
+        return unless block.is_a?(Prism::BlockNode)
+
+        block.child_nodes.compact.each { |c| walk(c) }
+      end
+
+      def tag_call?(node)
+        receiverless_call?(node) &&
+          PhlexNode.html_tag?(node.name.to_s)
+      end
+
+      def receiverless_call?(node)
+        node.is_a?(Prism::CallNode) && node.receiver.nil?
+      end
+
+      def check_node(node)
+        rules.each do |rule_class|
+          message = rule_class.check(node)
+          next unless message
+
+          @offenses << Offense.new(
+            rule: rule_class.rule_name,
+            filename: @filename,
+            line: node.line,
+            message: message
+          )
+        end
+      end
+    end
+  end
+end

data/lib/a11y/lint/{node.rb → slim_node.rb}

@@ -3,7 +3,7 @@
 module A11y
   module Lint
     # Wraps a Slim AST s-expression as a queryable node for lint rules.
-    class Node
+    class SlimNode
       attr_reader :line
 
       def initialize(sexp, line:)
@@ -29,7 +29,7 @@ module A11y
         @attributes ||= extract_attributes
       end
 
-      # Returns direct HTML element children as Node objects.
+      # Returns direct HTML element children as SlimNode objects.
       # Walks through [:multi] and [:slim, :control] wrappers so that tags
       # nested inside control flow are still treated as direct children.
       # Opaque [:slim, :output] blocks are skipped.
@@ -48,7 +48,7 @@ module A11y
 
       def collect_children(sexp)
         return [] unless sexp.is_a?(Array)
-        return [Node.new(sexp, line: @line)] if html_tag_sexp?(sexp)
+        return [SlimNode.new(sexp, line: @line)] if html_tag_sexp?(sexp)
         return collect_children(sexp[3]) if slim_control_sexp?(sexp)
         return [] unless sexp[0] == :multi
 

data/lib/a11y/lint/slim_runner.rb

@@ -25,7 +25,7 @@ module A11y
         return unless node?(sexp)
 
         @line += 1 if sexp[0] == :newline
-        new_node = Node.new(sexp, line: @line)
+        new_node = SlimNode.new(sexp, line: @line)
         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.7.2"
+    VERSION = "0.8.0"
   end
 end

data/lib/a11y/lint.rb

@@ -2,10 +2,12 @@
 
 require "slim"
 require "nokogiri"
+require "prism"
 require_relative "lint/version"
 require_relative "lint/offense"
-require_relative "lint/node"
+require_relative "lint/slim_node"
 require_relative "lint/erb_node"
+require_relative "lint/phlex_node"
 require_relative "lint/configuration"
 require_relative "lint/rule"
 require_relative "lint/rules/perceivable/image_tag_missing_alt"
@@ -14,6 +16,7 @@ require_relative "lint/rules/perceivable/list_invalid_children"
 require_relative "lint/rules/robust/missing_accessible_name"
 require_relative "lint/slim_runner"
 require_relative "lint/erb_runner"
+require_relative "lint/phlex_runner"
 
 module A11y
   module Lint

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: a11y-lint
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Abdullah Hashim
@@ -23,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: slim
   requirement: !ruby/object:Gem::Requirement
@@ -59,13 +73,15 @@ files:
 - lib/a11y/lint/configuration.rb
 - lib/a11y/lint/erb_node.rb
 - lib/a11y/lint/erb_runner.rb
-- lib/a11y/lint/node.rb
 - lib/a11y/lint/offense.rb
+- lib/a11y/lint/phlex_node.rb
+- lib/a11y/lint/phlex_runner.rb
 - lib/a11y/lint/rule.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/list_invalid_children.rb
 - lib/a11y/lint/rules/robust/missing_accessible_name.rb
+- lib/a11y/lint/slim_node.rb
 - lib/a11y/lint/slim_runner.rb
 - lib/a11y/lint/version.rb
 - sig/a11y/lint.rbs