Generate types for path helpers when routes.rb is created or changed

Author: tk0miya

lib/ruby_lsp/rbs_rails/addon.rb

@@ -101,6 +101,8 @@ def generate_signature(uri) #: void
         case path.to_s
         when "db/schema.rb"
           generate_all_model_signatures
+        when %r{^config/(routes\.rb|routes/.*\.rb)$}
+          generate_path_helpers_signature
         else
           klass = constantize(path)
           return unless klass
@@ -118,6 +120,15 @@ def generate_all_model_signatures #: void
         end
       end
 
+      def generate_path_helpers_signature #: void
+        rbs_path = config.signature_root_dir / "path_helpers.rbs"
+        rbs_path.dirname.mkpath
+
+        sig = ::RbsRails::PathHelpers.generate
+        rbs_path.write sig
+        logger.info("Updated RBS signature: #{rbs_path}")
+      end
+
       # @rbs klass: Class
       def generate_signature0(klass) #: void
         return unless klass < ::ActiveRecord::Base

sig/ruby_lsp/rbs_rails/addon.rbs

@@ -44,6 +44,8 @@ module RubyLsp
 
       def generate_all_model_signatures: () -> void
 
+      def generate_path_helpers_signature: () -> void
+
       # @rbs klass: Class
       def generate_signature0: (Class klass) -> void
 

spec/rbs_rails/addon_spec.rb

@@ -116,6 +116,32 @@
         end
       end
 
+      context "when config/routes.rb is created" do
+        let(:filename) { "config/routes.rb" }
+        let(:rbs_path) { Pathname.new("#{workspace_path}/sig/rbs_rails/path_helpers.rbs") }
+
+        it "generates path_helpers.rbs" do
+          subject
+
+          expect(rbs_path).to exist
+          content = rbs_path.read
+          expect(content).to include("interface ::_RbsRailsPathHelpers")
+        end
+      end
+
+      context "when config/routes/*.rb is created" do
+        let(:filename) { "config/routes/api.rb" }
+        let(:rbs_path) { Pathname.new("#{workspace_path}/sig/rbs_rails/path_helpers.rbs") }
+
+        it "generates path_helpers.rbs" do
+          subject
+
+          expect(rbs_path).to exist
+          content = rbs_path.read
+          expect(content).to include("interface ::_RbsRailsPathHelpers")
+        end
+      end
+
       context "when any other file is created" do
         let(:filename) { "app/controllers/users_controller.rb" }