rails-css_unused 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6be69a5f6aa27dedb1aef9797167bf8b8abed066632fa8fee01fe7fefa54554c
-  data.tar.gz: c808dfa0ed3b70ad3a03ec158af1ef5d00a7bcf97ff899b6f4613853955c67fd
+  metadata.gz: 3e275861ec42e64ade413fc24f51105fcdfbc77691b3b8a421029523e96f8b59
+  data.tar.gz: 06da7233e0f634d4feeb02664b24f438537449a20ac2b28845866c60fb73514a
 SHA512:
-  metadata.gz: 62d8dff321fb2dddf72d618747b2e22511a438864b0372067c9c222442f1a39f30513a8922d014a663c4dde0955ca44614d3b9506476df78d41ef7a517ed88cb
-  data.tar.gz: 3e7e72d6cb22f7a6a1138162771cb3906e0b9a1399070131ab660b7a43286f4957faa15dd6d51b14a3981f36779264aa6da38a9ab04cbec1b8c889c189f30db8
+  metadata.gz: ec24c67fc3da46c54954d210c4ae1ffef696abba69a32b06c7e4a56d75c9f72c65f32ad0dfea9044248fd8ff31f9adb847381b2d527215668bac1ebcb66c5619
+  data.tar.gz: 0023736da3656117d62196f8509b04a1b27622726e10772ccad96690e8cd5210b21305ad2034720dffabba50fa3b9756df73c4abee628b8ce23f92dc46ac1be7

data/CHANGELOG.md

@@ -1,30 +1,53 @@
 # Changelog
 
-## [0.2.0] - 2026-06-02
+## [0.2.1] - 2026-06-02
 
-### 🔧 Fixed
-- **Extension noise eliminated** — `.png`, `.css`, `.jpg`, `.js` etc. no longer appear as ghost classes
-- **At-rule noise eliminated** — `@charset`, `@import`, `@keyframes` tokens no longer pollute the class list
-- **`:not()` false positives fixed** — `.foo` inside `:not(.foo)` is no longer treated as a new definition
-- **Double-scanning removed** — `ViewScanner` and `StylesheetScanner` were each instantiated twice in `print_summary`, wasting time and producing wrong counts
+### Added
+- **Smart dynamic class variable detection** — the scanner now automatically
+  detects CSS class strings assigned to variables whose name ends in
+  `_class`, `_classes`, `_style`, or `_css` (e.g. `status_class = "foo-bar"`).
+- **Hyphenated string literal detection** — any quoted string containing a
+  hyphen is now treated as a CSS class value. Since Ruby variable names
+  cannot contain hyphens, hyphenated quoted strings are unambiguously string
+  values, never identifiers. This eliminates false positives from patterns like:
+  ```erb
+  <% status_class =
+    if exam.cancelled?
+      ["Cancelled", "status-cancelled"]
+    elsif exam.approved?
+      ["Approved", "status-approved"]
+    end %>
+  <span class="status-pill <%= status_class %>">
+  ```
+  Classes like `status-cancelled`, `status-approved`, `status-requested`
+  are now correctly detected as used without needing `ignore_patterns`.
+- Dynamic class var detection also runs in HAML, Slim, and Ruby component files.
 
-### ✨ Added
-- **Source file attribution** — `show_source_files: true` shows which stylesheet each ghost comes from
-- **CI mode** — `fail_on_unused: true` + `rake css_unused:ci` exits with code 1 on any ghost
-- **`rake css_unused:report_verbose`** — shows ghost classes with source file inline
-- **HAML & Slim support** — proper extraction of `.foo.bar` shorthand selectors
-- **Slim template support** — `div.foo` class shorthand
-- **Ruby component support** — scans ViewComponent `.rb` files for `class:` attributes
-- **Stimulus / JS support** — `classList.add("foo")` calls detected as used classes
-- **ERB dynamic class extraction** — `class="<%= cond ? 'a' : 'b' %>"` — static string parts extracted
-- **`ignore_patterns`** — regex-based ignore list (e.g. `/\Ajs-/`, `/\Ais-/`)
-- **`scan_javascript_for_classes`** — opt-in JS scanning for dynamically applied classes
-- **`scan_ruby_components`** — opt-in scanning of `.rb` component files
-- **Colour terminal output** — red/green/grey ANSI when outputting to a TTY
-- **BEM double-underscore selectors** — `block__element--modifier` handled correctly
+### Fixed
+- False positives for dynamically assigned CSS classes used via ERB interpolation
+  (e.g. `<%= status_class %>`, `<%= button_css %>`).
 
-### 🗑️ Removed
-- Confusing `stylesheet_scanner.rb` noise filter that used a hardcoded `%w[import media charset...]` list (replaced with proper context-aware skip logic)
+## [0.2.0] - 2026-05-31
 
-## [0.1.0] - 2026-05-01
+### Added
+- HAML and Slim template scanning
+- ViewComponent and Phlex component support
+- Stimulus controller JS class scanning (`classList.add`, `classList.toggle`)
+- `scan_javascript_for_classes` config option
+- `scan_ruby_components` config option
+- `show_source_files` config option
+- `fail_on_unused` config option for CI pipelines
+- BEM class name support (`block__element--modifier`)
+- ERB dynamic class attribute extraction (static parts from `class="<%= expr %>"`)
+- `ignore_patterns` config for regex-based exclusions
+- Spinner output during scanning
+
+## [0.1.0] - 2026-05-15
+
+### Added
 - Initial release
+- CSS/SCSS/SASS stylesheet scanning
+- ERB view scanning (`class="..."`, `class: "..."`, `class: [...]`)
+- Ghost class report with counts
+- `ignore_classes` configuration
+- `css_unused:report` rake task

data/LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2026 sghani001
+Copyright (c) 2026 Syed Ghani
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/rails/css_unused/version.rb

@@ -2,6 +2,6 @@
 
 module Rails
   module CssUnused
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

data/lib/rails/css_unused/view_scanner.rb

@@ -12,6 +12,7 @@ module Rails
     #   Ruby:      html_class: "foo",  css_classes("foo bar"),  "foo bar"
     #   Stimulus:  this.element.classList.add("foo"),  "foo" string literals
     #   Dynamic:   class="<%= cond ? 'foo' : 'bar' %>" — literal parts extracted
+    #   Dynamic vars: status_class = "foo-bar" — string assigned to *_class/*_classes var
     class ViewScanner
       # ── ERB / HTML patterns ──────────────────────────────────────────────
       # class="foo bar baz"  or  class='foo bar'
@@ -37,12 +38,33 @@ module Rails
       # class="<%= expr %>", class="prefix-<%= var %>"  — extracts static parts
       ERB_DYNAMIC_CLASS = /class\s*=\s*["'][^"']*<%=[^%]+%>[^"']*["']/m
 
+      # ── Dynamic class variable detection (v0.2.1) ────────────────────────
+      # Detects string literals assigned to variables whose name ends with
+      # _class, _classes, _style, or _css — and the string contains hyphens
+      # (Ruby variable names cannot contain hyphens, so it must be a value).
+      #
+      # Matches patterns like:
+      #   status_class = "foo-bar"
+      #   button_classes = "btn btn-primary"
+      #   ["Active", "status-active"]          (array element with hyphenated string)
+      #   ["Cancelled", "status-cancelled"]
+      #
+      # Rule: any double- or single-quoted string containing at least one
+      # hyphen is unambiguously a string value (not a Ruby identifier), so
+      # we can safely extract it as a potential class name.
+      #
+      # Pattern 1: variable ending in _class/_classes/_style/_css = "value"
+      DYNAMIC_CLASS_VAR = /\b\w+_(?:class(?:es)?|style|css)\s*=\s*["']([^"'\n]+)["']/
+      #
+      # Pattern 2: any quoted string with hyphens in array/tuple context
+      # e.g. ["Active", "status-active"] — the hyphenated strings are CSS classes
+      HYPHENATED_STRING = /["']([a-zA-Z][a-zA-Z0-9]*(?:-[a-zA-Z0-9]+)+)["']/
+
       # ── Ruby / Stimulus string literals ─────────────────────────────────
       # Any double-quoted string that looks like a space-separated class list
-      # Used when scan_javascript_for_classes or scan_ruby_components is on.
       JS_ADD_CLASS      = /(?:classList\.add|classList\.toggle|classList\.replace)\s*\(\s*["']([^"']+)["']/
-      JS_REMOVE_CLASS   = /(?:classList\.remove)\s*\(\s*["']([^"']+)["']/  # these ARE used
-      RUBY_STRING_CLASSES = /["']([a-zA-Z][a-zA-Z0-9_-]*(?:\s+[a-zA-Z][a-zA-Z0-9_-]*)*)["']/
+      JS_REMOVE_CLASS   = /(?:classList\.remove)\s*\(\s*["']([^"']+)["']/
+      RUBY_STRING_CLASSES = /["']([a-zA-Z][a-zA-Z0-9_-]*(?:\s+[a-zA-Z][a-zA-Z0-9_-]*)*)[\"']/
 
       def initialize(root:, config: CssUnused.configuration)
         @root   = Pathname(root)
@@ -104,7 +126,6 @@ module Rails
           end
         end
 
-        # Also scan Ruby component files if configured
         return unless @config.scan_ruby_components
 
         @config.component_paths.each do |rel|
@@ -132,22 +153,18 @@ module Rails
         ext   = path.extname
         base  = path.basename.to_s
 
-        # ERB / HTML (also used for .html.erb compound names)
         if ext == ".erb" || base.end_with?(".html.erb")
           found.merge extract_erb(content)
         end
 
-        # HAML
         if ext == ".haml" || base.end_with?(".html.haml")
           found.merge extract_haml(content)
         end
 
-        # Slim
         if ext == ".slim" || base.end_with?(".html.slim")
           found.merge extract_slim(content)
         end
 
-        # Ruby files (ViewComponent .rb, Phlex, helpers)
         if ext == ".rb"
           found.merge extract_ruby(content)
         end
@@ -171,11 +188,14 @@ module Rails
         # ERB dynamic class attributes — extract static string parts
         content.scan(ERB_DYNAMIC_CLASS) do
           chunk = Regexp.last_match(0)
-          # Strip ERB tags, grab remaining quoted tokens
           stripped = chunk.gsub(/<%.*?%>/m, " ")
           stripped.scan(/["']([^"']+)["']/) { |m| found.merge tokenize(m[0]) }
         end
 
+        # ── v0.2.1: Dynamic class variable detection ──────────────────────
+        # Detects: status_class = "foo-bar" or button_classes = "btn btn-primary"
+        found.merge extract_dynamic_class_vars(content)
+
         found
       end
 
@@ -183,7 +203,6 @@ module Rails
         found = Set.new
 
         content.scan(HAML_IMPLICIT) do |m|
-          # m[0] = ".foo.bar" — split on dots
           m[0].split(".").reject(&:empty?).each do |cls|
             found << cls if valid_class?(cls)
           end
@@ -192,6 +211,9 @@ module Rails
         content.scan(HAML_HASH_CLASS) { |m| found.merge tokenize(m[0]) }
         content.scan(RUBY_CLASS_KV)   { |m| found.merge tokenize(m[0]) }
 
+        # v0.2.1: detect dynamic class vars in HAML Ruby blocks too
+        found.merge extract_dynamic_class_vars(content)
+
         found
       end
 
@@ -206,23 +228,26 @@ module Rails
 
         content.scan(RUBY_CLASS_KV) { |m| found.merge tokenize(m[0]) }
 
+        # v0.2.1: detect dynamic class vars in Slim Ruby blocks too
+        found.merge extract_dynamic_class_vars(content)
+
         found
       end
 
       def extract_ruby(content)
         found = Set.new
 
-        # ViewComponent / Phlex: render with class: "foo"
         content.scan(RUBY_CLASS_KV)   { |m| found.merge tokenize(m[0]) }
         content.scan(RUBY_CLASS_ARRAY) { |m| found.merge tokenize(m[0].gsub(/["',]/, " ")) }
 
-        # Loose string literals that look like class name lists (safe: validated below)
         content.scan(RUBY_STRING_CLASSES) do |m|
           tokens = tokenize(m[0])
-          # Only trust them if every token is a plausible CSS class
           found.merge(tokens) if tokens.all? { |t| valid_class?(t) }
         end
 
+        # v0.2.1: detect dynamic class vars in Ruby component files
+        found.merge extract_dynamic_class_vars(content)
+
         found
       end
 
@@ -233,16 +258,49 @@ module Rails
         found
       end
 
+      # ── v0.2.1: Smart dynamic class variable extraction ──────────────────
+      #
+      # Scans content for two patterns:
+      #
+      # 1. Variables named *_class, *_classes, *_style, *_css assigned a string:
+      #      status_class = "foo-bar"        => extracts "foo-bar"
+      #      button_classes = "btn btn-sm"   => extracts "btn", "btn-sm"
+      #
+      # 2. Any quoted string containing a hyphen (unambiguous: Ruby variable
+      #    names cannot contain hyphens, so hyphenated quoted strings MUST be
+      #    string values, never variable names):
+      #      ["Active", "status-active"]     => extracts "status-active"
+      #      ["Cancelled", "status-cancelled"] => extracts "status-cancelled"
+      #
+      # This directly solves the false-positive problem where classes like
+      # status-approved, status-cancelled, status-requested were flagged as
+      # ghost classes because they were assigned to a variable (status_class)
+      # and used via <%= status_class %> interpolation.
+      def extract_dynamic_class_vars(content)
+        found = Set.new
+
+        # Pattern 1: *_class/*_classes variable assignments
+        content.scan(DYNAMIC_CLASS_VAR) do |m|
+          tokenize(m[0]).each { |cls| found << cls if valid_class?(cls) }
+        end
+
+        # Pattern 2: hyphenated string literals (unambiguously CSS class values)
+        content.scan(HYPHENATED_STRING) do |m|
+          cls = m[0].strip
+          found << cls if valid_class?(cls)
+        end
+
+        found
+      end
+
       # ── Helpers ───────────────────────────────────────────────────────────
 
-      # Splits a raw class attribute value into individual class tokens.
-      # Handles: spaces, commas, quotes, ERB fragments.
       def tokenize(raw)
         return Set.new if raw.nil?
 
         raw
-          .gsub(/["']/, " ")               # strip stray quotes
-          .split(/[\s,]+/)                  # split on whitespace/commas
+          .gsub(/["']/, " ")
+          .split(/[\s,]+/)
           .map { |t| t.strip.delete_prefix(".") }
           .reject(&:empty?)
           .reject { |t| t.include?("<%") || t.include?('#{') }
@@ -250,9 +308,6 @@ module Rails
           .to_set
       end
 
-      # A valid CSS class token: starts with a letter or underscore,
-      # contains only alphanumeric, hyphens, underscores.
-      # Allows BEM: block__element--modifier
       def valid_class?(token)
         token.match?(/\A-?[a-zA-Z_][a-zA-Z0-9_-]*\z/)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-css_unused
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - sghani001
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-01 00:00:00.000000000 Z
+date: 2026-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties