chusaku 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f73db691fb40f399f999f495736dca02bd8c372934aa4122824d086a723d0479
-  data.tar.gz: dea436d47f3101f5d3112c3722b04c00b317fc32c7ad3ee2c2594ca12fbe3c01
+  metadata.gz: 48034ba3796c8cd1ab1a16b0db1065dcdf487ea5e6bc1b08a7fcd18db4ad1d33
+  data.tar.gz: 65cf7dbbf5571f547aeb9cefc8cd804ccab9467b0765edcc00691c777c158554
 SHA512:
-  metadata.gz: 03bff26c3f0a2de5ed0b4c64feb3c2a198c4704f53f3683d5bbcf0699f2c36081672324ea871ed664836d0a6d09f9314b1b4c23d886885597c7e9f03bcb13821
-  data.tar.gz: 8d4def4efa795ac278608c7d9c8f19dd361e361b4e1ff4da7a9434fa85d865acb3de28e183d67f74bf244023220ad84464735da275516a236576c29dde9d9d64
+  metadata.gz: 83c00966e23c6d8a63f9b68e35cc48a975689f21473e83344927764ac200d9eb378274c6ad82fa90a0ac6a06d286763f45661f4b2433983f903cf93371158167
+  data.tar.gz: 70afe36985465e34f3fa18e5eea3d51d130daaada6414a51b680a0e4f32f31e14a3e3225f8f70b594d19d8c23e9ad3b00ac9f43c4dd83c493bdd5befba483e8a

data/.gitignore

@@ -7,5 +7,7 @@
 /spec/reports/
 /tmp/
 
+.DS_Store
+
 .ruby-version
 Gemfile.lock

data/lib/chusaku/cli.rb

@@ -41,7 +41,8 @@ module Chusaku
     # @raise [Chusaku::CLI::NotARailsProject] Exception if not Rails project
     # @return [void]
     def check_for_rails_project
-      has_controllers = File.directory?("./app/controllers")
+      controllers_pattern = options[:controllers_pattern] || DEFAULT_CONTROLLERS_PATTERN
+      has_controllers = !Dir.glob(Rails.root.join(controllers_pattern)).empty?
       has_rakefile = File.exist?("./Rakefile")
       raise NotARailsProject unless has_controllers && has_rakefile
     end

data/lib/chusaku/routes.rb

@@ -27,7 +27,19 @@ module Chusaku
       def call
         routes = {}
 
-        Rails.application.routes.routes.each do |route|
+        populate_routes(Rails.application, routes)
+        backfill_routes(routes)
+      end
+
+      private
+
+      def populate_routes(app, routes)
+        app.routes.routes.each do |route|
+          if route.app.engine?
+            populate_routes(route.app.app, routes)
+            next
+          end
+
           controller, action, defaults = extract_data_from(route)
           routes[controller] ||= {}
           routes[controller][action] ||= []
@@ -39,12 +51,8 @@ module Chusaku
             action: action,
             defaults: defaults
         end
-
-        backfill_routes(routes)
       end
 
-      private
-
       # Adds formatted route info for the given param combination.
       #
       # @param route [Hash] Route info

data/lib/chusaku/version.rb

@@ -1,3 +1,3 @@
 module Chusaku
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/lib/chusaku.rb

@@ -4,6 +4,8 @@ require "chusaku/routes"
 
 # Handles core functionality of annotating projects.
 module Chusaku
+  DEFAULT_CONTROLLERS_PATTERN = "**/*_controller.rb".freeze
+
   class << self
     # The main method to run Chusaku. Annotate all actions in a Rails project as
     # follows:
@@ -19,14 +21,20 @@ module Chusaku
       @flags = flags
       @routes = Chusaku::Routes.call
       @changed_files = []
-      controllers_pattern = @flags[:controllers_pattern] || "app/controllers/**/*_controller.rb"
+      controllers_pattern = @flags[:controllers_pattern] || DEFAULT_CONTROLLERS_PATTERN
+      controllers_paths = Dir.glob(Rails.root.join(controllers_pattern))
+
+      @routes.each do |controller, actions|
+        next unless controller
+
+        controller_class = "#{controller.underscore.camelize}Controller".constantize
+        action_method_name = actions.keys.first&.to_sym
+        next unless !action_method_name.nil? && controller_class.method_defined?(action_method_name)
 
-      Dir.glob(Rails.root.join(controllers_pattern)).each do |path|
-        controller = %r{controllers/(.*)_controller\.rb}.match(path)[1]
-        actions = @routes[controller]
-        next if actions.nil?
+        source_path = controller_class.instance_method(action_method_name).source_location&.[](0)
+        next unless controllers_paths.include?(source_path)
 
-        annotate_file(path: path, controller: controller, actions: actions.keys)
+        annotate_file(path: source_path, actions: actions)
       end
 
       output_results
@@ -46,16 +54,15 @@ module Chusaku
     # Adds annotations to the given file.
     #
     # @param path [String] Path to file
-    # @param controller [String] Controller name
-    # @param actions [Array<String>] List of valid actions for the controller
+    # @param actions [Hash<String, Hash>] List of valid action data for the controller
     # @return [void]
-    def annotate_file(path:, controller:, actions:)
-      parsed_file = Chusaku::Parser.call(path: path, actions: actions)
+    def annotate_file(path:, actions:)
+      parsed_file = Chusaku::Parser.call(path: path, actions: actions.keys)
       parsed_file[:groups].each_cons(2) do |prev, curr|
         clean_group(prev)
         next unless curr[:type] == :action
 
-        route_data = @routes[controller][curr[:action]]
+        route_data = actions[curr[:action]]
         next unless route_data.any?
 
         annotate_group(group: curr, route_data: route_data)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chusaku
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Nishiki Liu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-06 00:00:00.000000000 Z
+date: 2024-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.1
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: Annotate your Rails controllers with route info.