chusaku 1.4.0 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d38e9cae0023a682add1a559ef4c40e469247f55ef578b67fc190d81b35e824
-  data.tar.gz: d70d7f1d4aa61451fff49dd99ee1358c375db963db45728f08784827b7f6bfa1
+  metadata.gz: 91762a5b8314f0486e73067fd338cad5b440ca263d77c90322787ba86f318e58
+  data.tar.gz: c9dcc279a4401864a946b1c97115d9f759152166eea11fa633517474529b8f56
 SHA512:
-  metadata.gz: b4d2aab917c320e5b821d4e53386b65d5017347e089fe2e62099c94838af14b1824fcde11f2c13c2b97a3af4417764849337a4e577d400d49410ce88e74e34ba
-  data.tar.gz: 67fc92a8285bc86f0d46ff76da41ec425385d131a088be4f76d18892cfc80aeeea2cc8bbdda3cbc2bb458901788711427162a620d3f18f62c1664795b2bcf32b
+  metadata.gz: 96bad9906074a576eefd8ec2e1bb30c3a3f6774f42127107feeb2a7414db41e493417bde9f97d8b7dacc32a8f71302abb47c4ffcf3250503e4c26b3e2975de9c
+  data.tar.gz: 278543a4dbe3f74fbb1de39ab06ab455896f1f255a9410e52902955180d2d02a4a15e9cce075f6db444acaccecfd1018cc38cba2e117725e1b43ed4d287a199b

data/.github/workflows/linting.yml

@@ -1,14 +1,18 @@
 name: Linting
 on: [pull_request]
 jobs:
-  standard:
+  lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout
+        uses: actions/checkout@v4
+
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.3
+          ruby-version: 4.0
+          bundler: 4
           bundler-cache: true
+
       - name: Run Standard
         run: bundle exec standardrb --fail-level A

data/.github/workflows/testing.yml

@@ -5,13 +5,18 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ["3.1", "3.2", "3.3"]
+        ruby-version: ["3.2", "3.3", "3.4", "4.0"]
+
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout
+        uses: actions/checkout@v4
+
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
+          bundler: 4
           bundler-cache: true
+
       - name: Run tests
-        run: bundle exec rake
+        run: bundle exec rake test

data/chusaku.gemspec

@@ -23,8 +23,7 @@ Gem::Specification.new do |spec|
     spec.metadata["source_code_uri"] = spec.homepage
     spec.metadata["changelog_uri"] = spec.homepage
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-          "public gem pushes."
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
   end
 
   # Specify which files should be added to the gem when it is released.
@@ -39,10 +38,10 @@ Gem::Specification.new do |spec|
   spec.executables = "chusaku"
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 2.2"
-  spec.add_development_dependency "minitest", "~> 5.14"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "standardrb", "~> 1.0"
+  spec.add_development_dependency "bundler", "~> 4"
+  spec.add_development_dependency "minitest", "~> 5"
+  spec.add_development_dependency "rake", "~> 13"
+  spec.add_development_dependency "standard", "~> 1"
 
   spec.add_dependency "railties", ">= 3.0"
 end

data/lib/chusaku/routes.rb

@@ -1,3 +1,5 @@
+require "active_support/inflector"
+
 module Chusaku
   # Handles extracting information about the Rails project's routes.
   class Routes
@@ -9,16 +11,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 +59,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 +72,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 +81,8 @@ module Chusaku
             routes: routes,
             controller: controller,
             action: action,
-            defaults: defaults
+            defaults: defaults,
+            source_path: source_path
         end
       end
 
@@ -60,11 +93,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 +127,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 +184,27 @@ 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_name = ActiveSupport::Inflector.camelize(ActiveSupport::Inflector.underscore(controller))
+        controller_class = controller ? ActiveSupport::Inflector.constantize("#{controller_name}Controller") : 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.2"
 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 =
@@ -166,7 +188,7 @@ module Chusaku
     #
     # @return [String] 'r' or 'w'
     def file_mode
-      File.instance_methods.include?(:test_write) ? "r" : "w"
+      File.method_defined?(:test_write) ? "r" : "w"
     end
 
     # Output results to user.

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: chusaku
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.2
 platform: ruby
 authors:
 - Nishiki Liu
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,56 +15,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13'
 - !ruby/object:Gem::Dependency
-  name: standardrb
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +113,6 @@ metadata:
   homepage_uri: https://github.com/nshki/chusaku
   source_code_uri: https://github.com/nshki/chusaku
   changelog_uri: https://github.com/nshki/chusaku
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -129,8 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Annotate your Rails controllers with route info.
 test_files: []