stimulus-audit 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d97ee4d76118febf8f6d72f4434bdcef35e925dd5871bbc624bfb221e0cd0fd3
-  data.tar.gz: a54d0519141cced0080073a8713ae0d923e0452b0203817543cc1b99ed95c44d
+  metadata.gz: dca7ccc3e9aa70d2569f5dac251cd6ffb735904a26a5ae47d08acb0795f31f74
+  data.tar.gz: b11fe5d83255fc3ae5951953e7b7c15c3420c2ed134d5d499bd32de4db17a632
 SHA512:
-  metadata.gz: '0458a1420dfd0419ceefe18b4a70e8ba676690c99e700b21a594cedf7d397f41ac884555233fb6bf6dccf9e13bfc48f7f7f54b3dcd5cb30badb71ce387f42b89'
-  data.tar.gz: 67e254902d28bdf8abfa7d268cc6f603ffe6893420c7fab4652d9eed3b2cac0c5cd8899cf0387da938b25fb007db7fff8068f70215b7a4164da4d1108222a459
+  metadata.gz: 01a291f6c08a66ec9a1e3f08b6fc4ed8995cccd1a171fbbbf70f935eb08d5dc097d0641082eb2156052fe0ccfd86e45f0198ec545c19f213c9f820798f79a6af
+  data.tar.gz: a8250cd99d2edaf96b2a89f0dcbbe64d21e8c47707e9e72a3f506f932665e6c7061ccd14a5b9cc2a3782e0848ea607b66904f3639233eca80383ca2b78a7ad6c

data/CHANGELOG.md

@@ -1,5 +1,24 @@
-## [Unreleased]
+# Changelog
+All notable changes to this project will be documented in this file.
 
-## [0.1.0] - 2024-12-11
+## [0.2.0] - 2024-03-11
+### Changed
+- Renamed rake tasks to avoid conflicts with stimulus-rails
+- stimulus:audit is now audit:stimulus
+- stimulus:scan is now audit:scan
 
+### Fixed
+- Fixed gem auto-loading in Rails applications
+
+## [0.1.1] - 2024-03-11
+### Fixed
+- Fixed controller name handling to support underscore to hyphen conversion
+- Added proper Rails integration via Railtie
+- Cleaned up gem dependencies
+
+## [0.1.0] - 2024-03-11
+### Added
 - Initial release
+- Basic controller scanning functionality
+- Controller usage audit capabilities
+- Support for namespaced controllers

data/README.md

@@ -22,7 +22,7 @@ bundle install
 Run an audit to see all defined and used controllers in your application:
 
 ```bash
-rails stimulus:audit
+rails audit:stimulus
 ```
 
 This will show:
@@ -56,13 +56,13 @@ Example output:
 Find all uses of a specific controller:
 
 ```bash
-rails stimulus:scan[controller_name]
+rails audit:scan[controller_name]
 ```
 
 Example:
 ```bash
-rails stimulus:scan[products]
-rails stimulus:scan[users--name]  # For namespaced controllers
+rails audit:scan[products]
+rails audit:scan[users--name]  # For namespaced controllers
 ```
 
 ### Configuration

data/lib/stimulus_audit/auditor.rb

@@ -34,8 +34,8 @@ module StimulusAudit
           controller_path = full_path.each_filename.to_a[(controllers_dir + 1)..]
           # Remove _controller.js from the last component
           controller_path[-1] = controller_path[-1].sub(/_controller\.(js|ts)$/, "")
-          # Join with -- for namespacing
-          name = controller_path.join("--")
+          # Join with -- for namespacing and convert underscores to hyphens
+          name = controller_path.join("--").gsub("_", "-")
           controllers << name
         end
       end
@@ -54,8 +54,10 @@ module StimulusAudit
           content = File.read(file)
           patterns.each do |pattern|
             content.scan(pattern) do |match|
-              # Split in case of multiple controllers: "users--name list toggle"
+              # Split in case of multiple controllers
               match[0].split(/\s+/).each do |controller|
+                # Store controller names exactly as they appear in the view
+                # (they should already have hyphens as per Stimulus conventions)
                 controllers << controller
               end
             end

data/lib/stimulus_audit/configuration.rb

@@ -12,13 +12,13 @@ module StimulusAudit
       base_path = StimulusAudit.root
 
       @view_paths = [
-        base_path.join('app/views/**/*.{html,erb,haml}').to_s,
-        base_path.join('app/javascript/**/*.{js,jsx}').to_s,
-        base_path.join('app/components/**/*.{html,erb,haml,rb}').to_s
+        base_path.join("app/views/**/*.{html,erb,haml}").to_s,
+        base_path.join("app/javascript/**/*.{js,jsx}").to_s,
+        base_path.join("app/components/**/*.{html,erb,haml,rb}").to_s
       ]
 
       @controller_paths = [
-        base_path.join('app/javascript/controllers/**/*.{js,ts}').to_s
+        base_path.join("app/javascript/controllers/**/*.{js,ts}").to_s
       ]
     end
   end

data/lib/stimulus_audit/railtie.rb

@@ -5,5 +5,9 @@ module StimulusAudit
     rake_tasks do
       load "tasks/stimulus_audit.rake"
     end
+
+    initializer "stimulus-audit.setup" do
+      require "stimulus_audit"
+    end
   end
 end

data/lib/stimulus_audit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StimulusAudit
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/stimulus_audit.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
-require 'set'
-require 'pathname'
-require "stimulus_audit/version"
-require "stimulus_audit/configuration"
-require "stimulus_audit/auditor"
-require "stimulus_audit/scanner"
+require "set"
+require "pathname"
+require_relative "stimulus_audit/version"
+require_relative "stimulus_audit/configuration"
+require_relative "stimulus_audit/auditor"
+require_relative "stimulus_audit/scanner"
 
 if defined?(Rails)
   require "rails"
-  require "stimulus_audit/railtie" 
+  require 'stimulus_audit'
+  require "stimulus_audit/railtie"
 end
 
 module StimulusAudit

data/lib/tasks/stimulus_audit.rake

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-namespace :stimulus do
+namespace :audit do
   desc "Audit Stimulus controllers usage and find orphaned controllers"
-  task audit: :environment do
+  task stimulus: :environment do
     StimulusAudit::Auditor.new.audit.to_console
   end
 
-  desc "Scan files for stimulus controller usage (e.g., rake stimulus:scan[users--name])"
+  desc "Scan files for stimulus controller usage (e.g., rake audit:scan[products])"
   task :scan, [:controller] => :environment do |_, args|
     controller = args[:controller]
     if controller.nil? || controller.empty?
-      puts "Please provide a controller name: rake stimulus:scan[controller_name]"
+      puts "Please provide a controller name: rake audit:scan[controller_name]"
       next
     end
 

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: stimulus-audit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
-- Toby
+- Your Name
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 2024-12-11 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: A Ruby gem to analyze usage of Stimulus controllers, finding unused controllers
   and undefined controllers
 email:
@@ -18,11 +46,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rubocop.yml"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/stimulus_audit.rb
 - lib/stimulus_audit/auditor.rb
 - lib/stimulus_audit/configuration.rb
@@ -30,14 +56,14 @@ files:
 - lib/stimulus_audit/scanner.rb
 - lib/stimulus_audit/version.rb
 - lib/tasks/stimulus_audit.rake
-- sig/stimulus_audit.rbs
-homepage: https://github.com/yourusername/stimulus-audit
+homepage: https://github.com/tobyond/stimulus-audit
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/yourusername/stimulus-audit
-  source_code_uri: https://github.com/yourusername/stimulus-audit
-  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/tobyond/stimulus-audit
+  changelog_uri: https://github.com/tobyond/stimulus-audit/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/tobyond/stimulus-audit
+  bug_tracker_uri: https://github.com/tobyond/stimulus-audit/issues
 post_install_message:
 rdoc_options: []
 require_paths:

data/.rubocop.yml

@@ -1,13 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.6
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "minitest/test_task"
-
-Minitest::TestTask.create
-
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: %i[test rubocop]

data/sig/stimulus_audit.rbs

@@ -1,4 +0,0 @@
-module StimulusAudit
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end