chusaku 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d38e9cae0023a682add1a559ef4c40e469247f55ef578b67fc190d81b35e824
-  data.tar.gz: d70d7f1d4aa61451fff49dd99ee1358c375db963db45728f08784827b7f6bfa1
+  metadata.gz: f8ab5946d4be43df335d71e2cc2639c8c4f548230f3ba035a947b53d0008c20a
+  data.tar.gz: b396e52e72f519352e0bfee5d9bde697bd6047a1ba3a1ff79d25a56331ad523a
 SHA512:
-  metadata.gz: b4d2aab917c320e5b821d4e53386b65d5017347e089fe2e62099c94838af14b1824fcde11f2c13c2b97a3af4417764849337a4e577d400d49410ce88e74e34ba
-  data.tar.gz: 67fc92a8285bc86f0d46ff76da41ec425385d131a088be4f76d18892cfc80aeeea2cc8bbdda3cbc2bb458901788711427162a620d3f18f62c1664795b2bcf32b
+  metadata.gz: a586a909a9c01f86555af6e5416d5c20ee3b6baf492c30cde206ec85b26767f9cdc058e08b71fa3ccd660687baa36436a83b545d3533d3ccab2c3156b29a7a0f
+  data.tar.gz: 981fd3e8225cf30346e50c7bc0654fc35b77528e82fabf444a3e25f6254c151f49ba96047e02e685337aa27fd69951f551b75fcf147f03937ac8b0f34cf416db

data/lib/chusaku/routes.rb

@@ -9,16 +9,40 @@ module Chusaku
       #   {
       #     "users" => {
       #       "edit" => [
-      #         {verb: "GET", path: "/users/:id", name: "edit_user"}
+      #         {
+      #           verb: "GET",
+      #           path: "/users/:id",
+      #           name: "edit_user",
+      #           defaults: {},
+      #           source_path: "/path/to/users_controller.rb"
+      #         }
       #       ],
       #       "update" => [
-      #         {verb: "PATCH", path: "/users", name: "edit_user"},
-      #         {verb: "PUT", path: "/users", name: "edit_user"}
+      #         {
+      #           verb: "PATCH",
+      #           path: "/users",
+      #           name: "edit_user",
+      #           defaults: {},
+      #           source_path: "/path/to/users_controller.rb"
+      #         },
+      #         {
+      #           verb: "PUT",
+      #           path: "/users",
+      #           name: "edit_user",
+      #           defaults: {},
+      #           source_path: "/path/to/users_controller.rb"
+      #         }
       #       ]
       #     },
       #     "empanadas" => {
       #       "create" => [
-      #         {verb: "POST", path: "/empanadas", name: nil}
+      #         {
+      #           verb: "POST",
+      #           path: "/empanadas",
+      #           name: nil,
+      #           defaults: {},
+      #           source_path: "/path/to/empanadas_controller.rb"
+      #         }
       #       ]
       #     }
       #   }
@@ -33,6 +57,12 @@ module Chusaku
 
       private
 
+      # Recursively populate the routes hash with information from the given Rails
+      # application. Accounts for Rails engines.
+      #
+      # @param app [Rails::Application] Result of `Rails.application`
+      # @param routes [Hash] Collection of all route info
+      # @return [void]
       def populate_routes(app, routes)
         app.routes.routes.each do |route|
           if route.app.engine?
@@ -40,7 +70,7 @@ module Chusaku
             next
           end
 
-          controller, action, defaults = extract_data_from(route)
+          controller, action, defaults, source_path = extract_data_from(route)
           routes[controller] ||= {}
           routes[controller][action] ||= []
 
@@ -49,7 +79,8 @@ module Chusaku
             routes: routes,
             controller: controller,
             action: action,
-            defaults: defaults
+            defaults: defaults,
+            source_path: source_path
         end
       end
 
@@ -60,11 +91,17 @@ module Chusaku
       # @param controller [String] Controller key
       # @param action [String] Action key
       # @param defaults [Hash] Default parameters for route
+      # @param source_path [String] Path to controller file
       # @return [void]
-      def add_info_for(route:, routes:, controller:, action:, defaults:)
+      def add_info_for(route:, routes:, controller:, action:, defaults:, source_path:)
         verbs_for(route).each do |verb|
-          routes[controller][action]
-            .push(format(route: route, verb: verb, defaults: defaults))
+          routes[controller][action].push \
+            format(
+              route: route,
+              verb: verb,
+              defaults: defaults,
+              source_path: source_path
+            )
           routes[controller][action].uniq!
         end
       end
@@ -88,13 +125,15 @@ module Chusaku
       # @param route [ActionDispatch::Journey::Route] Route given by Rails
       # @param verb [String] HTTP verb
       # @param defaults [Hash] Default parameters for route
+      # @param source_path [String] Path to controller file
       # @return [Hash] { verb => String, path => String, name => String }
-      def format(route:, verb:, defaults:)
+      def format(route:, verb:, defaults:, source_path:)
         {
           verb: verb,
           path: route.path.spec.to_s.gsub("(.:format)", ""),
           name: route.name,
-          defaults: defaults
+          defaults: defaults,
+          source_path: source_path
         }
       end
 
@@ -143,16 +182,26 @@ module Chusaku
         routes
       end
 
-      # Given a route, extract the controller and action strings.
+      # Given a route, extract the controller & action strings as well as defaults
+      # hash and source path.
       #
       # @param route [ActionDispatch::Journey::Route] Route instance
-      # @return [Array<Object>] (String, String, Hash)
+      # @return [Array<Object>] (String, String, Hash, String)
       def extract_data_from(route)
         defaults = route.defaults.dup
         controller = defaults.delete(:controller)
         action = defaults.delete(:action)
 
-        [controller, action, defaults]
+        controller_class = controller ? "#{controller.underscore.camelize}Controller".constantize : nil
+        action_method_name = action&.to_sym
+        source_path =
+          if !action_method_name.nil? && controller_class&.method_defined?(action_method_name)
+            controller_class.instance_method(action_method_name).source_location&.[](0)
+          else
+            ""
+          end
+
+        [controller, action, defaults, source_path]
       end
     end
   end

data/lib/chusaku/version.rb

@@ -1,3 +1,3 @@
 module Chusaku
-  VERSION = "1.4.0"
+  VERSION = "1.4.1"
 end

data/lib/chusaku.rb

@@ -29,14 +29,7 @@ module Chusaku
         .new(Rails.root.join(controllers_pattern))
         .exclude(Rails.root.join(exclusion_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)
-
-        source_path = controller_class.instance_method(action_method_name).source_location&.[](0)
+      source_paths_map.each do |source_path, actions|
         next unless controllers_paths.include?(source_path)
 
         annotate_file(path: source_path, actions: actions)
@@ -56,6 +49,34 @@ module Chusaku
 
     private
 
+    # Maps source paths to their respective routes.
+    #
+    # Example output:
+    #
+    #   {
+    #     "/path/to/users_controller.rb" => {
+    #       "edit" => [...],
+    #       "update" => [...]
+    #     }
+    #   }
+    #
+    # @return [Hash] Source paths mapped to their respective routes
+    def source_paths_map
+      map = {}
+
+      @routes.each do |controller, actions|
+        actions.each do |action, data|
+          data.each do |datum|
+            map[datum[:source_path]] ||= {}
+            map[datum[:source_path]][action] ||= []
+            map[datum[:source_path]][action].push(datum)
+          end
+        end
+      end
+
+      map
+    end
+
     # Adds annotations to the given file.
     #
     # @param path [String] Path to file
@@ -110,8 +131,9 @@ module Chusaku
     # @param path [String] Rails path for route
     # @param name [String] Name used in route helpers
     # @param defaults [Hash] Default parameters for route
+    # @param source_path [String] Path to controller file
     # @return [String] "@route <verb> <path> {<defaults>} (<name>)"
-    def annotate_route(verb:, path:, name:, defaults:)
+    def annotate_route(verb:, path:, name:, defaults:, source_path:)
       annotation = "@route #{verb} #{path}"
       if defaults&.any?
         defaults_str =

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chusaku
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Nishiki Liu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-08 00:00:00.000000000 Z
+date: 2024-11-10 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.17
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Annotate your Rails controllers with route info.