ordit 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 573d6f3d0536da9b396366f3c794b28b5c74161792ed2b107b9da4b4edc5c268
-  data.tar.gz: a806b40aaefc894a2cfea8caebc4f2c94f19ce87dcab0be01671bf9fd00f8c74
+  metadata.gz: fdefa2e20e2bd7fa34e8c898fc6e54e934a35e6c9dc3eb5e9ce9f22bf0403b87
+  data.tar.gz: 704929dfdbee426f4d358512b18d217f2ddf1521f8e376cdb839993066b229a6
 SHA512:
-  metadata.gz: 4c3a5d96f70d1423f748db50052b37767eec553b5b6577ba18866040cb25d78457835aacbc478ed6169bcf379dea64ed4f743426144ce7e3288a3e854f9097ce
-  data.tar.gz: 0e30d715b13e47c0dd7c3362ee5917f6b1dfd40e9bdbffe1b590352af65791fd53383ddf222ebf982e41ae28d90ca3852557ff83fa03e873f9d44a757d15e73b
+  metadata.gz: 980a3d0f8ba5d373577b55594350962f784775de06f2c0b288271929a71a68998799fc60b1611293a68ce15102168923377d0dccde9699f2348775c5cf4dc180
+  data.tar.gz: 3e83e18491bb40508a8f65a8210b29e1c31e94c4e87c67c64c033ed5a3682768c39cae36c794363d37a8d2bdb3f3a457e161a52001584e0b1eabd8349891a0cc

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.1.2] - 2024-12-12
+
+- refactor, clean up
+
+
+## [0.1.1] - 2024-12-12
+
+- Fix namespace issue in rake task
+
 ## [0.1.0] - 2024-12-12
 
 - Initial release

data/README.md

@@ -56,13 +56,13 @@ Example output:
 Find all uses of a specific controller:
 
 ```bash
-rails audit:scan[controller_name]
+rails ordit:scan[controller_name]
 ```
 
 Example:
 ```bash
-rails audit:scan[products]
-rails audit:scan[users--name]  # For namespaced controllers
+rails ordit:scan[products]
+rails ordit:scan[users--name]  # For namespaced controllers
 ```
 
 ### Configuration

data/lib/ordit/auditor.rb

@@ -2,27 +2,27 @@
 
 module Ordit
   class Auditor
-    def initialize(config = Ordit.configuration)
-      @config = config
+    def self.run
+      new.run
     end
 
-    def audit
-      defined_controllers = find_defined_controllers
-      used_controllers = find_used_controllers
-
-      AuditResult.new(
-        defined_controllers: defined_controllers,
-        used_controllers: used_controllers,
-        controller_locations: find_controller_locations,
-        usage_locations: find_usage_locations
+    def run
+      ResultGenerator.new(
+        defined_controllers:,
+        used_controllers:,
+        controller_locations:,
+        usage_locations:
       )
     end
 
     private
 
-    def find_defined_controllers
-      controllers = Set.new
-      @config.controller_paths.each do |path|
+    def config
+      @config ||= Ordit.configuration
+    end
+
+    def defined_controllers
+      config.controller_paths.each_with_object(Set.new) do |path, controllers|
         Dir.glob(path.to_s).each do |file|
           # Extract relative path from controllers directory
           full_path = Pathname.new(file)
@@ -32,6 +32,8 @@ module Ordit
 
           # Get path components after 'controllers'
           controller_path = full_path.each_filename.to_a[(controllers_dir + 1)..]
+          next unless controller_path[-1].include?('_controller')
+
           # Remove _controller.js from the last component
           controller_path[-1] = controller_path[-1].sub(/_controller\.(js|ts)$/, "")
           # Join with -- for namespacing and convert underscores to hyphens
@@ -39,17 +41,10 @@ module Ordit
           controllers << name
         end
       end
-      controllers
     end
 
-    def find_used_controllers
-      controllers = Set.new
-      patterns = [
-        /data-controller=["']([^"']+)["']/, # HTML attribute syntax
-        /data:\s*{\s*(?:controller:|:controller\s*=>)\s*["']([^"']+)["']/ # Both hash syntaxes
-      ]
-
-      @config.view_paths.each do |path|
+    def used_controllers
+      config.view_paths.each_with_object(Set.new) do |path, controllers|
         Dir.glob(path.to_s).each do |file|
           content = File.read(file)
           patterns.each do |pattern|
@@ -64,12 +59,10 @@ module Ordit
           end
         end
       end
-      controllers
     end
 
-    def find_controller_locations
-      locations = {}
-      @config.controller_paths.each do |path_pattern|
+    def controller_locations
+      config.controller_paths.each_with_object({}) do |path_pattern, locations|
         Dir.glob(path_pattern).each do |file|
           relative_path = Pathname.new(file).relative_path_from(Dir.pwd)
           controller_path = relative_path.to_s.gsub(%r{^app/javascript/controllers/|_controller\.(js|ts)$}, "")
@@ -77,18 +70,10 @@ module Ordit
           locations[name] = relative_path
         end
       end
-      locations
     end
 
-    def find_usage_locations
-      locations = Hash.new { |h, k| h[k] = {} }
-      patterns = [
-        /data-controller=["']([^"']+)["']/,
-        /data:\s*{(?:[^}]*\s)?controller:\s*["']([^"']+)["']/,
-        /data:\s*{(?:[^}]*\s)?controller\s*=>\s*["']([^"']+)["']/
-      ]
-
-      @config.view_paths.each do |path_pattern|
+    def usage_locations
+      config.view_paths.each_with_object(Hash.new { |h, k| h[k] = {} }) do |path_pattern, locations|
         Dir.glob(path_pattern).each do |file|
           File.readlines(file).each_with_index do |line, index|
             patterns.each do |pattern|
@@ -103,73 +88,16 @@ module Ordit
           end
         end
       end
-      locations
-    end
-  end
-
-  class AuditResult
-    attr_reader :defined_controllers, :used_controllers,
-                :controller_locations, :usage_locations
-
-    def initialize(defined_controllers:, used_controllers:,
-                   controller_locations:, usage_locations:)
-      @defined_controllers = defined_controllers
-      @used_controllers = used_controllers
-      @controller_locations = controller_locations
-      @usage_locations = usage_locations
-    end
-
-    def unused_controllers
-      defined_controllers - used_controllers
-    end
-
-    def undefined_controllers
-      used_controllers - defined_controllers
     end
 
-    def active_controllers
-      defined_controllers & used_controllers
-    end
-
-    def to_console
-      puts "\n📊 Stimulus Controller Audit\n"
-
-      if unused_controllers.any?
-        puts "\n❌ Defined but unused controllers:"
-        unused_controllers.sort.each do |controller|
-          puts "   #{controller}"
-          puts "   └─ #{controller_locations[controller]}"
-        end
-      end
-
-      if undefined_controllers.any?
-        puts "\n⚠️  Used but undefined controllers:"
-        undefined_controllers.sort.each do |controller|
-          puts "   #{controller}"
-          usage_locations[controller].each do |file, lines|
-            puts "   └─ #{file} (lines: #{lines.join(", ")})"
-          end
-        end
-      end
-
-      if active_controllers.any?
-        puts "\n✅ Active controllers:"
-        active_controllers.sort.each do |controller|
-          puts "   #{controller}"
-          puts "   └─ Defined in: #{controller_locations[controller]}"
-          puts "   └─ Used in:"
-          usage_locations[controller].each do |file, lines|
-            puts "      └─ #{file} (lines: #{lines.join(", ")})"
-          end
-        end
-      end
-
-      puts "\n📈 Summary:"
-      puts "   Total controllers defined: #{defined_controllers.size}"
-      puts "   Total controllers in use:  #{used_controllers.size}"
-      puts "   Unused controllers:        #{unused_controllers.size}"
-      puts "   Undefined controllers:     #{undefined_controllers.size}"
-      puts "   Properly paired:           #{active_controllers.size}"
+    def patterns
+      @patterns ||= [
+        /data-controller=["']([^"']+)["']/, # HTML attribute syntax
+        # Ruby 1.9+ hash syntax - covers both with and without symbol prefix
+        /data:\s*{(?:[^}]*\s)?(?::)?controller:\s*["']([^"']+)["']/,
+        # Hash rocket syntax - covers both with and without symbol prefix
+        /data:\s*{(?:[^}]*\s)?(?::)?controller\s*=>\s*["']([^"']+)["']/
+      ]
     end
   end
 end

data/lib/ordit/result_generator.rb

@@ -0,0 +1,67 @@
+module Ordit
+  class ResultGenerator
+    attr_reader :defined_controllers, :used_controllers,
+                :controller_locations, :usage_locations
+
+    def initialize(defined_controllers:, used_controllers:,
+                   controller_locations:, usage_locations:)
+      @defined_controllers = defined_controllers
+      @used_controllers = used_controllers
+      @controller_locations = controller_locations
+      @usage_locations = usage_locations
+    end
+
+    def unused_controllers
+      defined_controllers - used_controllers
+    end
+
+    def undefined_controllers
+      used_controllers - defined_controllers
+    end
+
+    def active_controllers
+      defined_controllers & used_controllers
+    end
+
+    def to_console
+      puts "\n📊 Stimulus Controller Audit\n"
+
+      if unused_controllers.any?
+        puts "\n❌ Defined but unused controllers:"
+        unused_controllers.sort.each do |controller|
+          puts "   #{controller}"
+          puts "   └─ #{controller_locations[controller]}"
+        end
+      end
+
+      if undefined_controllers.any?
+        puts "\n⚠️  Used but undefined controllers:"
+        undefined_controllers.sort.each do |controller|
+          puts "   #{controller}"
+          usage_locations[controller].each do |file, lines|
+            puts "   └─ #{file} (lines: #{lines.join(", ")})"
+          end
+        end
+      end
+
+      if active_controllers.any?
+        puts "\n✅ Active controllers:"
+        active_controllers.sort.each do |controller|
+          puts "   #{controller}"
+          puts "   └─ Defined in: #{controller_locations[controller]}"
+          puts "   └─ Used in:"
+          usage_locations[controller].each do |file, lines|
+            puts "      └─ #{file} (lines: #{lines.join(", ")})"
+          end
+        end
+      end
+
+      puts "\n📈 Summary:"
+      puts "   Total controllers defined: #{defined_controllers.size}"
+      puts "   Total controllers in use:  #{used_controllers.size}"
+      puts "   Unused controllers:        #{unused_controllers.size}"
+      puts "   Undefined controllers:     #{undefined_controllers.size}"
+      puts "   Properly paired:           #{active_controllers.size}"
+    end
+  end
+end

data/lib/ordit/scanner.rb

@@ -2,25 +2,22 @@
 
 module Ordit
   class Scanner
-    def initialize(config = Ordit.configuration)
-      @config = config
+    def self.run(controller)
+      new(controller).run
     end
 
-    def scan(controller)
-      matches = find_matches(controller)
-      print_results(controller, matches)
-    end
+    attr_reader :controller
 
-    private
+    def initialize(controller)
+      @controller = controller
+    end
 
-    def find_matches(controller)
-      matches = []
-      patterns = [
-        /data-controller=["'](?:[^"']*\s)?#{Regexp.escape(controller)}(?:\s[^"']*)?["']/, # HTML attribute
-        /data:\s*{\s*(?:controller:|:controller\s*=>)\s*["'](?:[^"']*\s)?#{Regexp.escape(controller)}(?:\s[^"']*)?["']/ # Both hash syntaxes
-      ]
+    def run
+      print
+    end
 
-      @config.view_paths.each do |path|
+    def results
+      config.view_paths.each_with_object([]) do |path, matches|
         Dir.glob(path.to_s).each do |file|
           content = File.readlines(file)
           content.each_with_index do |line, index|
@@ -34,19 +31,31 @@ module Ordit
           end
         end
       end
-      matches
     end
 
-    def print_results(controller, matches)
+    private
+
+    def config
+      @config ||= Ordit.configuration
+    end
+
+    def patterns
+      @patterns ||= [
+        /data-controller=["'](?:[^"']*\s)?#{Regexp.escape(controller)}(?:\s[^"']*)?["']/, # HTML attribute
+        /data:\s*{\s*(?:controller:|:controller\s*=>)\s*["'](?:[^"']*\s)?#{Regexp.escape(controller)}(?:\s[^"']*)?["']/ # Both hash syntaxes
+      ]
+    end
+
+    def print
       puts "\nSearching for stimulus controller: '#{controller}'\n\n"
 
-      if matches.empty?
+      if results.empty?
         puts "No matches found."
         return
       end
 
       current_file = nil
-      matches.each do |match|
+      results.each do |match|
         if current_file != match[:file]
           puts "📁 #{match[:file]}"
           current_file = match[:file]

data/lib/ordit/version.rb

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

data/lib/ordit.rb

@@ -6,6 +6,7 @@ require_relative "ordit/version"
 require_relative "ordit/configuration"
 require_relative "ordit/auditor"
 require_relative "ordit/scanner"
+require_relative "ordit/result_generator"
 
 if defined?(Rails)
   require "rails"

data/lib/tasks/ordit.rake

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ordit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Toby
@@ -53,6 +53,7 @@ files:
 - lib/ordit/auditor.rb
 - lib/ordit/configuration.rb
 - lib/ordit/railtie.rb
+- lib/ordit/result_generator.rb
 - lib/ordit/scanner.rb
 - lib/ordit/version.rb
 - lib/tasks/ordit.rake