ordit 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdefa2e20e2bd7fa34e8c898fc6e54e934a35e6c9dc3eb5e9ce9f22bf0403b87
-  data.tar.gz: 704929dfdbee426f4d358512b18d217f2ddf1521f8e376cdb839993066b229a6
+  metadata.gz: 85359a41eabc4eca9dd38bf08749860a980e7eb3a4f31c4e1550243a141fa14a
+  data.tar.gz: c2fb171d7a685aa3180c00fa3aee02af58d265f53e35d7d1eca7ca66bd33a3a3
 SHA512:
-  metadata.gz: 980a3d0f8ba5d373577b55594350962f784775de06f2c0b288271929a71a68998799fc60b1611293a68ce15102168923377d0dccde9699f2348775c5cf4dc180
-  data.tar.gz: 3e83e18491bb40508a8f65a8210b29e1c31e94c4e87c67c64c033ed5a3682768c39cae36c794363d37a8d2bdb3f3a457e161a52001584e0b1eabd8349891a0cc
+  metadata.gz: 8366966cf1d4fed14fe17580e926d01e0f2f2450f4499b7fd724cda766cdf774cd0edd4203a418c9f7fc6445082366604cd32284372af70324988c24a91eefe8
+  data.tar.gz: 1d9af5057943c712b64116749d069cd8a737ae0a0338e32e8a7e11037b1b35a5701afc40a530fe82b768c22cc77196e21557cb44b312e8a16dc1948622843ab3

data/CHANGELOG.md

@@ -1,10 +1,17 @@
 ## [Unreleased]
 
+## [0.1.4] - 2024-16-12
+
+- remove scan, your editor does this already
+
+## [0.1.3] - 2024-16-12
+
+- more refactor, clean up, make more logical
+
 ## [0.1.2] - 2024-12-12
 
 - refactor, clean up
 
-
 ## [0.1.1] - 2024-12-12
 
 - Fix namespace issue in rake task

data/README.md

@@ -17,7 +17,7 @@ bundle install
 
 ## Usage
 
-### Audit All Controllers
+### Audit Stimulus Controllers
 
 Run an audit to see all defined and used controllers in your application:
 
@@ -28,41 +28,21 @@ rails ordit:stimulus
 This will show:
 - Controllers that are defined but never used
 - Controllers that are used but don't have corresponding files
-- Active controllers and where they're being used
 - Summary statistics
 
 Example output:
 ```
 📊 Stimulus Controller Audit
 
-❌ Defined but unused controllers:
-   unused_feature
-   └─ app/javascript/controllers/unused_feature_controller.js
+❌ Controllers not defined in any views:
+   unused-feature
+   users--edit-password
 
 ⚠️  Used but undefined controllers:
-   missing_controller
-   └─ app/views/products/show.html.erb (lines: 15, 23)
-
-✅ Active controllers:
-   products
-   └─ Defined in: app/javascript/controllers/products_controller.js
-   └─ Used in:
-      └─ app/views/products/index.html.erb (lines: 10, 45)
-      └─ app/components/product_card/component.html.erb (lines: 3)
-```
-
-### Scan for Specific Controller Usage
-
-Find all uses of a specific controller:
-
-```bash
-rails ordit:scan[controller_name]
-```
+   missing-controller
+   └─  📁 app/views/products/show.html.erb
+       📁 app/views/users/edit.html.erb
 
-Example:
-```bash
-rails ordit:scan[products]
-rails ordit:scan[users--name]  # For namespaced controllers
 ```
 
 ### Configuration
@@ -98,6 +78,9 @@ end
   
   # Hash rocket syntax
   <%= f.submit 'Save', data: { :controller => 'products' } %>
+
+  # Hash rocket string syntax
+  <%= f.submit 'Save', 'data' => { 'controller' => 'products' } %>
   ```
 - Scans ERB, HTML, and HAML files
 - Works with both JavaScript and TypeScript controller files

data/lib/ordit/configuration.rb

@@ -12,8 +12,7 @@ module Ordit
       base_path = Ordit.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/views/**/*.{html,erb,haml,slim}").to_s,
         base_path.join("app/components/**/*.{html,erb,haml,rb}").to_s
       ]
 

data/lib/ordit/console_output.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module Ordit
+  class ConsoleOutput
+    extend Forwardable
+
+    def self.run
+      new.run
+    end
+
+    def_delegators :@results,
+                   :files, :active_controllers, :undefined_controllers, :unused_controllers
+
+    def initialize
+      @results = Results.new
+    end
+
+    def run
+      print_audit
+    end
+
+    def print_audit
+      puts "\n📊 Stimulus Controller Audit\n"
+
+      if unused_controllers.any?
+        puts "\n❌ Controllers not defined in any views:"
+        unused_controllers.sort.each do |controller|
+          puts "   #{controller}"
+        end
+      end
+
+      if undefined_controllers.any?
+        puts "\n⚠️ View with defined but missing controller:"
+        undefined_controllers.each do |controller, files|
+          puts "\n   #{controller}_controller"
+
+          files.each_with_index do |file, index|
+            puts "   #{ index.zero? ? '└─' : '  ' } 📁 #{file}"
+          end
+        end
+      end
+
+      puts "\n📈 Summary:"
+      puts "   Total controllers defined: #{files.size}"
+      puts "   Total controllers in use:  #{active_controllers.size}"
+      puts "   Unused controllers:        #{unused_controllers.size}"
+      puts "   Undefined controllers:     #{undefined_controllers.size}"
+    end
+  end
+end

data/lib/ordit/definition_matcher.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Ordit
+  class DefinitionMatcher
+    # Match data-controller in HTML attributes
+    HTML_PATTERN = /data-controller=["']([^"']+)["']/.freeze
+    # Match controller: in Ruby/ERB
+    RUBY_PATTERN = /controller:\s*['"]([^'"]+)['"]/.freeze
+    # Match 'controller' => in Ruby/ERB
+    HASH_ROCKET_PATTERN = /(?:['"]controller['"]|:controller)\s*=>\s*['"]([^'"]+)['"]/.freeze
+
+    ALL_REGEX = [HTML_PATTERN, RUBY_PATTERN, HASH_ROCKET_PATTERN].freeze
+
+    def self.run(str)
+      ALL_REGEX.each_with_object(Set.new) do |pattern, controllers|
+        matches = str.scan(pattern)
+        next if matches.empty? || matches.nil?
+
+        flattened_matches = matches.flatten.flat_map(&:split)
+        controllers.merge(flattened_matches)
+      end.to_a
+    end
+  end
+end

data/lib/ordit/definitions.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Ordit
+  class Definitions
+    def self.all
+      Ordit.configuration.view_paths.each_with_object({}) do |path, hash|
+        Dir.glob(path.to_s).each do |file|
+          content = File.read(file)
+          matches = DefinitionMatcher.run(content)
+          next if matches.empty?
+
+          matches.each do |match|
+            relative_file = Pathname.new(file).relative_path_from(
+              Pathname.new(Ordit.root)
+            ).to_s
+            hash[match] ||= []
+            hash[match] |= [relative_file]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ordit/files.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Ordit
+  class Files
+    def self.all
+      run
+    end
+
+    def self.run
+      Ordit.configuration.controller_paths.flat_map do |path_pattern|
+        base_dir = path_pattern.split("/*").first
+        
+        Dir.glob(path_pattern).select do |file|
+          # Only filter by controller pattern if we're finding all files
+          file.match?(%r{[^/]*_?controller\.(js|ts)$})
+        end.map do |file|
+          Pathname.new(file).relative_path_from(Pathname.new(base_dir)).to_s
+        end
+      end.uniq
+    end
+  end
+end

data/lib/ordit/results.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Ordit
+  class Results
+    def initialize
+    end
+
+    def files
+      Files.all
+    end
+
+    def definitions
+      Definitions.all
+    end
+
+    def active_controllers = to_h[:active_controllers].sort
+    def undefined_controllers = to_h[:undefined_controllers]
+    def unused_controllers = to_h[:unused_controllers].sort
+
+    def to_h
+      @to_h ||= begin
+        base_object = {
+          active_controllers: [],
+          undefined_controllers: {},
+          unused_controllers: files.dup || []
+        }
+
+
+        definitions.each_with_object(base_object) do |(definition, file), result|
+          # Convert definition pattern to match file pattern
+          file_pattern = definition_to_file_pattern(definition)
+
+          # Find matching file
+          matching_file = files.find { |f| file_pattern == file_pattern_from_path(f) }
+
+          if matching_file
+            result[:active_controllers] << matching_file
+            result[:unused_controllers].delete(matching_file)
+            result[:active_controllers].sort!
+          else
+            result[:undefined_controllers][definition] ||= []
+            result[:undefined_controllers][definition] |= file
+          end
+        end
+      end
+    end
+
+    private
+
+    def definition_to_file_pattern(definition)
+      # Handle nested paths (double hyphen becomes directory separator)
+      path_parts = definition.split("--")
+
+      # Convert each part from kebab-case to snake_case
+      path_parts = path_parts.map { |part| part.gsub("-", "_") }
+
+      # Join with directory separator
+      path_parts.join("/")
+    end
+
+    def file_pattern_from_path(file)
+      # Remove _controller.js suffix and return the pattern
+      file.sub(/_controller\.(js|ts)$/, "")
+    end
+  end
+end

data/lib/ordit/version.rb

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

data/lib/ordit.rb

@@ -4,9 +4,11 @@ require "set"
 require "pathname"
 require_relative "ordit/version"
 require_relative "ordit/configuration"
-require_relative "ordit/auditor"
-require_relative "ordit/scanner"
-require_relative "ordit/result_generator"
+require_relative "ordit/files"
+require_relative "ordit/definitions"
+require_relative "ordit/definition_matcher"
+require_relative "ordit/results"
+require_relative "ordit/console_output"
 
 if defined?(Rails)
   require "rails"

data/lib/tasks/ordit.rake

@@ -3,18 +3,6 @@
 namespace :ordit do
   desc "Audit Stimulus controllers usage and find orphaned controllers"
   task stimulus: :environment do
-    Ordit::Auditor.run
-  end
-
-  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 ordit:scan[controller_name]"
-      next
-    end
-
-    Ordit::Scanner.run(controller)
+    Ordit::ConsoleOutput.run
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ordit
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Toby
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-12 00:00:00.000000000 Z
+date: 2024-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -50,11 +50,13 @@ files:
 - LICENSE.txt
 - README.md
 - lib/ordit.rb
-- lib/ordit/auditor.rb
 - lib/ordit/configuration.rb
+- lib/ordit/console_output.rb
+- lib/ordit/definition_matcher.rb
+- lib/ordit/definitions.rb
+- lib/ordit/files.rb
 - lib/ordit/railtie.rb
-- lib/ordit/result_generator.rb
-- lib/ordit/scanner.rb
+- lib/ordit/results.rb
 - lib/ordit/version.rb
 - lib/tasks/ordit.rake
 homepage: https://github.com/tobyond/ordit

data/lib/ordit/auditor.rb

@@ -1,103 +0,0 @@
-# frozen_string_literal: true
-
-module Ordit
-  class Auditor
-    def self.run
-      new.run
-    end
-
-    def run
-      ResultGenerator.new(
-        defined_controllers:,
-        used_controllers:,
-        controller_locations:,
-        usage_locations:
-      )
-    end
-
-    private
-
-    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)
-          controllers_dir = full_path.each_filename.find_index("controllers")
-
-          next unless controllers_dir
-
-          # 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
-          name = controller_path.join("--").gsub("_", "-")
-          controllers << name
-        end
-      end
-    end
-
-    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|
-            content.scan(pattern) do |match|
-              # 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
-          end
-        end
-      end
-    end
-
-    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)$}, "")
-          name = controller_path.gsub("/", "--")
-          locations[name] = relative_path
-        end
-      end
-    end
-
-    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|
-              line.scan(pattern) do |match|
-                match[0].split(/\s+/).each do |controller|
-                  relative_path = Pathname.new(file).relative_path_from(Dir.pwd)
-                  locations[controller][relative_path] ||= []
-                  locations[controller][relative_path] << index + 1
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-
-    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

@@ -1,67 +0,0 @@
-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

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-module Ordit
-  class Scanner
-    def self.run(controller)
-      new(controller).run
-    end
-
-    attr_reader :controller
-
-    def initialize(controller)
-      @controller = controller
-    end
-
-    def run
-      print
-    end
-
-    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|
-            next unless patterns.any? { |pattern| line.match?(pattern) }
-
-            matches << {
-              file: Pathname.new(file).relative_path_from(Pathname.new(Dir.pwd)),
-              line_number: index + 1,
-              content: line.strip
-            }
-          end
-        end
-      end
-    end
-
-    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 results.empty?
-        puts "No matches found."
-        return
-      end
-
-      current_file = nil
-      results.each do |match|
-        if current_file != match[:file]
-          puts "📁 #{match[:file]}"
-          current_file = match[:file]
-        end
-        puts "   Line #{match[:line_number]}:"
-        puts "      #{match[:content]}\n\n"
-      end
-    end
-  end
-end