Integrate model_dependencies.rbs to each model signatures

As a preparation for LSP server, this integrates model_dependencies.rbs
to each model signatures.

With this change, the signature of dependencies will be separated to the
each RBS file of the model.  It allows to rbs_rails to generate
signatures for models one by one, not only the whole of application.  It
also helps the LSP server generate signatures on the fly.

Author: tk0miya

lib/rbs_rails/active_record.rb

@@ -10,23 +10,23 @@ def self.generatable?(klass) #: boolish
 
     # @rbs klass: untyped
     # @rbs dependencies: Array[String]
-    def self.class_to_rbs(klass, dependencies: []) #: untyped
-      Generator.new(klass, dependencies: dependencies).generate
+    def self.class_to_rbs(klass) #: untyped
+      Generator.new(klass).generate
     end
 
     class Generator
       IGNORED_ENUM_KEYS = %i[_prefix _suffix _default _scopes] #: Array[Symbol]
 
       # @rbs @parse_model_file: nil | Parser::AST::Node
-      # @rbs @dependencies: Array[String]
       # @rbs @enum_definitions: Array[Hash[Symbol, untyped]]
       # @rbs @klass_name: String
 
+      attr_reader :dependencies #: DependencyBuilder
+
       # @rbs klass: singleton(ActiveRecord::Base) & Enum
-      # @rbs dependencies: Array[String]
-      def initialize(klass, dependencies:) #: untyped
+      def initialize(klass) #: untyped
         @klass = klass
-        @dependencies = dependencies
+        @dependencies = DependencyBuilder.new
         @klass_name = Util.module_name(klass, abs: false)
 
         namespaces = klass_name(abs: false).split('::').tap{ |names| names.pop }
@@ -62,6 +62,8 @@ def generate #: String
           #{collection_proxy_decl}
 
           #{footer}
+
+          #{dependencies.build}
         RBS
       end
 

lib/rbs_rails/cli.rb

@@ -92,23 +92,16 @@ def install_hooks #: void
     def generate_models #: void
       Rails.application.eager_load!
 
-      dep_builder = DependencyBuilder.new
-
       ::ActiveRecord::Base.descendants.each do |klass|
-        generate_single_model(klass, dep_builder)
+        generate_single_model(klass)
       rescue => e
         puts "Error generating RBS for #{klass.name} model"
         raise e
       end
-
-      if dep_rbs = dep_builder.build
-        config.signature_root_dir.join('model_dependencies.rbs').write(dep_rbs)
-      end
     end
 
     # @rbs klass: singleton(ActiveRecord::Base)
-    # @rbs dep_builder: DependencyBuilder
-    def generate_single_model(klass, dep_builder) #: bool
+    def generate_single_model(klass) #: bool
       return false if config.ignored_model?(klass)
       return false unless RbsRails::ActiveRecord.generatable?(klass)
 
@@ -125,9 +118,8 @@ def generate_single_model(klass, dep_builder) #: bool
       path = config.signature_root_dir / rbs_relative_path
       path.dirname.mkpath
 
-      sig = RbsRails::ActiveRecord.class_to_rbs(klass, dependencies: dep_builder.deps)
+      sig = RbsRails::ActiveRecord.class_to_rbs(klass)
       path.write sig
-      dep_builder.done << klass.name
 
       true
     end

lib/rbs_rails/dependency_builder.rb

@@ -19,6 +19,11 @@ def initialize #: void
       ])
     end
 
+    # @rbs name: String
+    def <<(name) #: Array[String]
+      deps << name
+    end
+
     def build #: String | nil
       dep_rbs = +""
       deps.uniq!

sig/rbs_rails/active_record.rbs

@@ -7,7 +7,7 @@ module RbsRails
 
     # @rbs klass: untyped
     # @rbs dependencies: Array[String]
-    def self.class_to_rbs: (untyped klass, ?dependencies: Array[String]) -> untyped
+    def self.class_to_rbs: (untyped klass) -> untyped
 
     class Generator
       IGNORED_ENUM_KEYS: Array[Symbol]
@@ -16,13 +16,12 @@ module RbsRails
 
       @enum_definitions: Array[Hash[Symbol, untyped]]
 
-      @dependencies: Array[String]
-
       @parse_model_file: nil | Parser::AST::Node
 
+      attr_reader dependencies: DependencyBuilder
+
       # @rbs klass: singleton(ActiveRecord::Base) & Enum
-      # @rbs dependencies: Array[String]
-      def initialize: (singleton(ActiveRecord::Base) & Enum klass, dependencies: Array[String]) -> untyped
+      def initialize: (singleton(ActiveRecord::Base) & Enum klass) -> untyped
 
       def generate: () -> String
 

sig/rbs_rails/cli.rbs

@@ -23,8 +23,7 @@ module RbsRails
     def generate_models: () -> void
 
     # @rbs klass: singleton(ActiveRecord::Base)
-    # @rbs dep_builder: DependencyBuilder
-    def generate_single_model: (singleton(ActiveRecord::Base) klass, DependencyBuilder dep_builder) -> bool
+    def generate_single_model: (singleton(ActiveRecord::Base) klass) -> bool
 
     def generate_path_helpers: () -> void
 

sig/rbs_rails/dependency_builder.rbs

@@ -8,6 +8,9 @@ module RbsRails
 
     def initialize: () -> void
 
+    # @rbs name: String
+    def <<: (String name) -> Array[String]
+
     def build: () -> (String | nil)
 
     private def shift: () -> (String | nil)

test/expectations/audited_audit.rbs

@@ -681,3 +681,6 @@ module ::Audited
     end
   end
 end
+
+module ::Audited
+end

test/expectations/blog.rbs

@@ -288,3 +288,10 @@ class ::Blog < ::ApplicationRecord
     def prepend: (*::Blog | ::Array[::Blog]) -> self
   end
 end
+
+class ::ApplicationRecord < ::ActiveRecord::Base
+end
+class ::User < ::ApplicationRecord
+end
+class ::User::ActiveRecord_Associations_CollectionProxy < ::ActiveRecord::Associations::CollectionProxy
+end

test/expectations/model_dependencies.rbs

@@ -508,3 +508,10 @@ class ::User < ::ApplicationRecord
     def prepend: (*::User | ::Array[::User]) -> self
   end
 end
+
+class ::ApplicationRecord < ::ActiveRecord::Base
+end
+class ::Blog < ::ApplicationRecord
+end
+class ::Blog::ActiveRecord_Associations_CollectionProxy < ::ActiveRecord::Associations::CollectionProxy
+end