rubocop-view_component 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab88d6999ec2a99b6f9e459d22a14b9d727b62edd967088fa22aef709681dbdb
-  data.tar.gz: b06b97cebdb888ba95176af4d9d664c9f75bf75865eacb148bc327bba761f77f
+  metadata.gz: 7ae5d788e931ed620494da128b9d5d971b8b6278841b11037a9594cf9da7cadf
+  data.tar.gz: e4202f7c094efe88eb925802022d6a7abebede5886ae5d381d2ae8eb44cd4c49
 SHA512:
-  metadata.gz: 8b6aa5e13ce63d13205335bb2d900a29d57e80ce1b9d1906c92e3548d85941875b18235a36775849e35752fed347c260e842289fb8e805ad0ee7670c252c89b1
-  data.tar.gz: b65833f97c6211d366b5c0cdeba807e501f6ef10a8a878f63e0379de23be3c2a4842542e50e43171254886204990ae5224a4d3e3abbe90f72be1e05f9cfb0f08
+  metadata.gz: 5d4a8f3314b13a36463adaa1545e747b120c430cfddba098e79af01083d906d126bea6714674084109a11a2c577e6a835c3bd7f6ca1ddd5c4b4a3289bedf430c
+  data.tar.gz: b2f22476fcda3172a5a33326ae2e09246df2377b2baaf5071433a5e7ef15c09285151a98b1093c294ea281b5b034d92e321fc8956443275a9d3642416649281e

data/AGENTS.md

@@ -47,10 +47,10 @@ All cops inherit from `RuboCop::Cop::Base` and are located in `lib/rubocop/cop/v
 - Provides `inside_view_component?(node)` - Checks if code is within a ViewComponent
 
 **`TemplateAnalyzer`** (`lib/rubocop/cop/view_component/template_analyzer.rb`)
-- Used by PreferPrivateMethods cop to analyze ERB templates
+- Used by PreferPrivateMethods cop to analyze ERB, Haml, and Slim templates
 - Extracts method calls from templates to avoid flagging template-used methods as private candidates
-- Handles both sibling templates (`component.html.erb`) and sidecar templates (`component/component.html.erb`)
-- Uses the `herb` gem to parse ERB and extract Ruby code
+- Handles both sibling templates (`component.html.erb`) and sidecar templates (`component/component.html.erb`), including format-less templates (`component.erb`)
+- Uses the `herb` gem to parse ERB and the `haml` (6+) and `slim` engines to compile Haml and Slim templates to Ruby
 
 ### Verification System
 
@@ -59,6 +59,6 @@ The `script/verify` script downloads real component libraries, runs all ViewComp
 ## Implementation Notes
 
 - When adding a new cop, use `rake new_cop[ViewComponent/CopName]` to generate the boilerplate
-- Template analysis is performance-sensitive - `PreferPrivateMethods` uses `herb` gem for efficient ERB parsing
+- Template analysis is performance-sensitive - `PreferPrivateMethods` uses `herb` gem for efficient ERB parsing, while Haml and Slim rely on their template engines to compile to Ruby
 - Cops must handle graceful degradation when templates can't be parsed
 - All cops should include `ViewComponent::Base` module to get detection helpers

data/Appraisals

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
 appraise "rubocop-minimum" do
+  gem "haml", ">= 6"
   gem "rubocop", "= 1.89.0"
+  gem "slim", ">= 4"
 end

data/README.md

@@ -33,7 +33,7 @@ This gem provides several cops to enforce ViewComponent best practices:
 
 - **ViewComponent/ComponentSuffix** - Enforce `-Component` suffix for ViewComponent classes
 - **ViewComponent/NoGlobalState** - Prevent direct access to `params`, `request`, `session`, etc.
-- **ViewComponent/PreferPrivateMethods** - Suggest making helper methods private (analyzes ERB templates to avoid flagging methods used in views)
+- **ViewComponent/PreferPrivateMethods** - Suggest making helper methods private (analyzes ERB, Haml, and Slim templates to avoid flagging methods used in views)
 - **ViewComponent/PreferSlots** - Detect HTML parameters that should be slots
 - **ViewComponent/PreferComposition** - Avoid inheriting one ViewComponent from another (prefer composition). Abstract bases without their own template, such as `ApplicationComponent`, are allowed
 - **ViewComponent/TestRenderedOutput** - Encourage testing rendered output over private methods. Supports Minitest and RSpec styles, including components built via `described_class.new` or a `let`/`subject` helper

data/gemfiles/rubocop_minimum.gemfile

@@ -3,11 +3,13 @@
 source "https://rubygems.org"
 
 gem "appraisal"
+gem "haml", ">= 6"
 gem "irb"
 gem "rake", "~> 13.4"
 gem "rspec"
 gem "rubocop", "= 1.89.0"
 gem "rubocop-rake"
 gem "rubocop-rspec"
+gem "slim", ">= 4"
 
 gemspec path: "../"

data/gemfiles/rubocop_minimum.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    rubocop-view_component (0.6.0)
+    rubocop-view_component (0.8.0)
       activesupport
       herb
       lint_roller (~> 1.1)
@@ -37,6 +37,11 @@ GEM
     diff-lcs (1.6.2)
     drb (2.2.3)
     erb (6.0.7)
+    haml (7.5.1)
+      prism (>= 1.1.0)
+      temple (>= 0.8.2)
+      thor
+      tilt
     herb (0.10.3)
     herb (0.10.3-aarch64-linux-gnu)
     herb (0.10.3-aarch64-linux-musl)
@@ -126,7 +131,12 @@ GEM
     rubydex (0.3.0-x86_64-darwin)
     rubydex (0.3.0-x86_64-linux)
     securerandom (0.4.1)
+    slim (5.2.2)
+      temple (~> 0.10.0)
+      tilt (>= 2.1.0)
+    temple (0.10.7)
     thor (1.5.0)
+    tilt (2.9.0)
     tsort (0.2.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
@@ -150,6 +160,7 @@ PLATFORMS
 
 DEPENDENCIES
   appraisal
+  haml (>= 6)
   irb
   rake (~> 13.4)
   rspec
@@ -157,6 +168,7 @@ DEPENDENCIES
   rubocop-rake
   rubocop-rspec
   rubocop-view_component!
+  slim (>= 4)
 
 BUNDLED WITH
    2.7.2

data/lib/rubocop/cop/view_component/template_analyzer.rb

@@ -5,8 +5,13 @@ require "herb"
 module RuboCop
   module Cop
     module ViewComponent
-      # Helper module for analyzing ViewComponent ERB templates
+      # Helper module for analyzing ViewComponent templates.
+      #
+      # Supports ERB, Haml (6+) and Slim templates.
       module TemplateAnalyzer
+        TEMPLATE_EXTENSIONS = %w[erb haml slim].freeze
+        TEMPLATE_GLOB = "{#{TEMPLATE_EXTENSIONS.join(",")}}".freeze
+
         # Find template file paths for a component
         # @param component_path [String] Path to the component Ruby file
         # @return [Array<String>] Array of template file paths
@@ -18,38 +23,28 @@ module RuboCop
           component_name = File.basename(component_path, ".rb")
           sidecar_dir = File.join(component_dir, component_name)
 
-          paths = sibling_templates(base_path) + sidecar_templates(sidecar_dir, component_name)
-          paths.uniq
+          (sibling_templates(base_path) + sidecar_templates(sidecar_dir, component_name)).uniq
         end
 
         def sibling_templates(base_path)
-          paths = []
-          sibling = "#{base_path}.html.erb"
-          paths << sibling if File.exist?(sibling)
-          paths.concat(Dir.glob("#{base_path}.*.html.erb"))
-          paths
+          template_paths(base_path)
         end
 
         def sidecar_templates(sidecar_dir, component_name)
-          paths = []
-          sidecar = File.join(sidecar_dir, "#{component_name}.html.erb")
-          paths << sidecar if File.exist?(sidecar)
-          paths.concat(Dir.glob(File.join(sidecar_dir, "#{component_name}.*.html.erb")))
-          paths
+          template_paths(File.join(sidecar_dir, component_name))
         end
 
-        # Extract method calls from an ERB template
-        # @param template_path [String] Path to the ERB template file
+        # Extract method calls from a template
+        # @param template_path [String] Path to the template file
         # @return [Set<Symbol>] Set of method names called in the template
         def extract_method_calls(template_path)
           return Set.new unless File.exist?(template_path)
 
-          source = File.read(template_path)
-          ruby_code = Herb.extract_ruby(source)
+          ruby_code = extract_template_ruby(template_path)
+          return Set.new unless ruby_code
 
-          # Parse the extracted Ruby code
           parse_ruby_for_method_calls(ruby_code)
-        rescue StandardError => e
+        rescue LoadError, StandardError => e
           # Graceful degradation on parse errors
           warn "Warning: Failed to parse template #{template_path}: #{e.message}" if ENV["RUBOCOP_DEBUG"]
           Set.new
@@ -57,6 +52,53 @@ module RuboCop
 
         private
 
+        def template_paths(base_path)
+          exact_paths = TEMPLATE_EXTENSIONS.flat_map do |extension|
+            ["#{base_path}.#{extension}", "#{base_path}.html.#{extension}"].select { |path| File.exist?(path) }
+          end
+
+          exact_paths + Dir.glob("#{base_path}.*.#{TEMPLATE_GLOB}")
+        end
+
+        def extract_template_ruby(template_path)
+          source = File.read(template_path)
+
+          case File.extname(template_path)
+          when ".erb"
+            Herb.extract_ruby(source)
+          when ".haml"
+            haml_to_ruby(source)
+          when ".slim"
+            slim_to_ruby(source)
+          end
+        end
+
+        def haml_to_ruby(source)
+          require "haml"
+          return unless supported_haml?
+
+          ::Haml::Engine.new.call(source)
+        rescue LoadError
+          nil
+        end
+
+        def supported_haml?
+          return true if ::Haml::VERSION.to_i >= 6
+
+          if ENV["RUBOCOP_DEBUG"]
+            warn "Warning: Haml #{::Haml::VERSION} is not supported; " \
+                 "Haml 6 or later is required"
+          end
+          false
+        end
+
+        def slim_to_ruby(source)
+          require "slim"
+          ::Slim::Engine.new.call(source)
+        rescue LoadError
+          nil
+        end
+
         # Parse Ruby code and extract method calls (send nodes with nil receiver)
         def parse_ruby_for_method_calls(ruby_code)
           # Use RuboCop's ProcessedSource to parse Ruby code

data/lib/rubocop/view_component/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module ViewComponent
-    VERSION = "0.8.0"
+    VERSION = "0.9.0"
   end
 end

data/script/verify

@@ -114,8 +114,10 @@ def replace_gemfile
   File.write("Gemfile", <<~RUBY)
     source "https://rubygems.org"
 
+    gem "haml", ">= 6"
     gem "rubocop"
     gem "rubocop-view_component", path: "#{GEM_DIR}"
+    gem "slim", ">= 4"
     gem "view_component"
   RUBY
 end

data/spec/fixtures/components/haml_method_component.html.haml

@@ -0,0 +1,2 @@
+.card
+  %h1= formatted_title

data/spec/fixtures/components/haml_method_component.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class HamlMethodComponent < ViewComponent::Base
+  def initialize(title)
+    @title = title
+  end
+
+  def formatted_title
+    @title.upcase
+  end
+
+  def helper_not_used
+    "not used"
+  end
+end

data/spec/fixtures/components/slim_method_component.html.slim

@@ -0,0 +1,2 @@
+.card
+  h1 = formatted_title

data/spec/fixtures/components/slim_method_component.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class SlimMethodComponent < ViewComponent::Base
+  def initialize(title)
+    @title = title
+  end
+
+  def formatted_title
+    @title.upcase
+  end
+
+  def helper_not_used
+    "not used"
+  end
+end

data/spec/rubocop/cop/view_component/prefer_composition_spec.rb

@@ -72,6 +72,34 @@ RSpec.describe RuboCop::Cop::ViewComponent::PreferComposition, :config do
         end
       RUBY
     end
+
+    it "registers an offense for a Haml template" do
+      allow(File).to receive(:exist?).and_call_original
+      allow(File).to receive(:exist?).with("/test_source.html.haml").and_return(true)
+
+      expect_offense(<<~RUBY)
+        class BaseCardComponent < ViewComponent::Base
+        end
+
+        class UserCardComponent < BaseCardComponent
+                                  ^^^^^^^^^^^^^^^^^ ViewComponent/PreferComposition: Avoid inheriting from another ViewComponent.
+        end
+      RUBY
+    end
+
+    it "registers an offense for a Slim template" do
+      allow(File).to receive(:exist?).and_call_original
+      allow(File).to receive(:exist?).with("/test_source.html.slim").and_return(true)
+
+      expect_offense(<<~RUBY)
+        class BaseCardComponent < ViewComponent::Base
+        end
+
+        class UserCardComponent < BaseCardComponent
+                                  ^^^^^^^^^^^^^^^^^ ViewComponent/PreferComposition: Avoid inheriting from another ViewComponent.
+        end
+      RUBY
+    end
   end
 
   context "when the parent is a resolvable component without a template" do
@@ -185,6 +213,26 @@ RSpec.describe RuboCop::Cop::ViewComponent::PreferComposition, :config do
       RUBY
     end
 
+    it "flags a parent with a Haml template" do
+      File.write(File.join(engine_dir, "app", "components", "engine_card", "component.html.haml"), "%div\n")
+
+      expect_offense(<<~RUBY)
+        class UserCardComponent < EngineCard::Component
+                                  ^^^^^^^^^^^^^^^^^^^^^ Avoid inheriting from another ViewComponent.
+        end
+      RUBY
+    end
+
+    it "flags a parent with a Slim template" do
+      File.write(File.join(engine_dir, "app", "components", "engine_card", "component.html.slim"), "div\n")
+
+      expect_offense(<<~RUBY)
+        class UserCardComponent < EngineCard::Component
+                                  ^^^^^^^^^^^^^^^^^^^^^ Avoid inheriting from another ViewComponent.
+        end
+      RUBY
+    end
+
     it "does not flag a parent resolved through the additional paths without a template" do
       expect_no_offenses(<<~RUBY)
         class UserCardComponent < EngineBase::Component

data/spec/rubocop/cop/view_component/prefer_private_methods_spec.rb

@@ -382,6 +382,56 @@ RSpec.describe RuboCop::Cop::ViewComponent::PreferPrivateMethods, :config do
     end
   end
 
+  context "with Haml template files" do
+    let(:component_file) { "spec/fixtures/components/haml_method_component.rb" }
+
+    it "flags methods not called in the Haml template" do
+      expect_offense(<<~RUBY, component_file)
+        # frozen_string_literal: true
+
+        class HamlMethodComponent < ViewComponent::Base
+          def initialize(title)
+            @title = title
+          end
+
+          def formatted_title
+            @title.upcase
+          end
+
+          def helper_not_used
+          ^^^^^^^^^^^^^^^^^^^ ViewComponent/PreferPrivateMethods: Consider making `helper_not_used` private. Only ViewComponent interface methods should be public.
+            "not used"
+          end
+        end
+      RUBY
+    end
+  end
+
+  context "with Slim template files" do
+    let(:component_file) { "spec/fixtures/components/slim_method_component.rb" }
+
+    it "flags methods not called in the Slim template" do
+      expect_offense(<<~RUBY, component_file)
+        # frozen_string_literal: true
+
+        class SlimMethodComponent < ViewComponent::Base
+          def initialize(title)
+            @title = title
+          end
+
+          def formatted_title
+            @title.upcase
+          end
+
+          def helper_not_used
+          ^^^^^^^^^^^^^^^^^^^ ViewComponent/PreferPrivateMethods: Consider making `helper_not_used` private. Only ViewComponent interface methods should be public.
+            "not used"
+          end
+        end
+      RUBY
+    end
+  end
+
   context "with template files" do
     let(:component_file) { "spec/fixtures/components/template_method_component.rb" }
 

data/spec/rubocop/cop/view_component/template_analyzer_spec.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "tmpdir"
+
+RSpec.describe RuboCop::Cop::ViewComponent::TemplateAnalyzer do
+  subject(:analyzer) { Object.new.extend(described_class) }
+
+  let(:directory) { Dir.mktmpdir("template_analyzer") }
+
+  after { FileUtils.remove_entry(directory) }
+
+  describe "#template_paths_for" do
+    let(:component_path) { File.join(directory, "example_component.rb") }
+
+    before do
+      File.write(component_path, "")
+      %w[
+        example_component.erb
+        example_component.html.erb
+        example_component.en.html.haml
+        example_component.html.slim
+      ].each do |name|
+        File.write(File.join(directory, name), "")
+      end
+
+      sidecar_directory = File.join(directory, "example_component")
+      FileUtils.mkdir_p(sidecar_directory)
+      File.write(File.join(sidecar_directory, "example_component.html.haml"), "")
+      File.write(File.join(sidecar_directory, "unrelated.rb"), "")
+    end
+
+    it "finds sibling and sidecar templates in every supported language" do
+      expect(analyzer.template_paths_for(component_path)).to contain_exactly(
+        File.join(directory, "example_component.erb"),
+        File.join(directory, "example_component.html.erb"),
+        File.join(directory, "example_component.en.html.haml"),
+        File.join(directory, "example_component.html.slim"),
+        File.join(directory, "example_component", "example_component.html.haml")
+      )
+    end
+  end
+
+  describe "#extract_method_calls" do
+    it "extracts method calls from ERB" do
+      path = write_template("example.html.erb", "<h1><%= formatted_title %></h1>\n")
+
+      expect(analyzer.extract_method_calls(path)).to eq(Set[:formatted_title])
+    end
+
+    it "extracts method calls from Haml" do
+      path = write_template("example.html.haml", "%h1{title: tooltip_text}= formatted_title\n")
+
+      expect(analyzer.extract_method_calls(path)).to eq(Set[:tooltip_text, :formatted_title])
+    end
+
+    it "extracts method calls from Slim" do
+      path = write_template("example.html.slim", "h1 title=tooltip_text = formatted_title\n")
+
+      expect(analyzer.extract_method_calls(path)).to eq(Set[:tooltip_text, :formatted_title])
+    end
+
+    it "extracts method calls from Haml control flow and blocks" do
+      path = write_template("example.html.haml", <<~HAML)
+        .card
+          - if show_icon?
+            = render IconComponent.new(name: icon_name) { helper_block }
+      HAML
+
+      expect(analyzer.extract_method_calls(path)).to include(
+        :show_icon?,
+        :icon_name,
+        :helper_block
+      )
+    end
+
+    it "returns an empty set for an unsupported template language" do
+      path = write_template("example.txt", "formatted_title\n")
+
+      expect(analyzer.extract_method_calls(path)).to eq(Set.new)
+    end
+
+    it "returns an empty set when the template does not exist" do
+      expect(analyzer.extract_method_calls(File.join(directory, "missing.html.haml"))).to eq(Set.new)
+    end
+  end
+
+  def write_template(name, content)
+    path = File.join(directory, name)
+    File.write(path, content)
+    path
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-view_component
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Andy Waite
@@ -132,6 +132,10 @@ files:
 - spec/expected_govuk_failures.yml
 - spec/expected_polaris_failures.yml
 - spec/expected_primer_failures.yml
+- spec/fixtures/components/haml_method_component.html.haml
+- spec/fixtures/components/haml_method_component.rb
+- spec/fixtures/components/slim_method_component.html.slim
+- spec/fixtures/components/slim_method_component.rb
 - spec/fixtures/components/template_method_component.html.erb
 - spec/fixtures/components/template_method_component.rb
 - spec/rubocop/cop/view_component/base_spec.rb
@@ -141,6 +145,7 @@ files:
 - spec/rubocop/cop/view_component/prefer_composition_spec.rb
 - spec/rubocop/cop/view_component/prefer_private_methods_spec.rb
 - spec/rubocop/cop/view_component/prefer_slots_spec.rb
+- spec/rubocop/cop/view_component/template_analyzer_spec.rb
 - spec/rubocop/cop/view_component/test_rendered_output_spec.rb
 - spec/spec_helper.rb
 - spec/support/project_index_helpers.rb