Extract gem loader

Signed-off-by: Alexandre Terrasa <alexandre.terrasa@shopify.com>
Co-authored-by: Ufuk Kayserilioglu <ufuk.kayserilioglu@shopify.com>

Author: Morriar

lib/tapioca/commands/gem.rb

@@ -55,8 +55,7 @@ def initialize(
 
         super()
 
-        @loader = T.let(nil, T.nilable(Runtime::Loader))
-        @bundle = T.let(nil, T.nilable(Gemfile))
+        @bundle = T.let(Gemfile.new(exclude), Gemfile)
         @existing_rbis = T.let(nil, T.nilable(T::Hash[String, String]))
         @expected_rbis = T.let(nil, T.nilable(T::Hash[String, String]))
         @include_doc = T.let(include_doc, T::Boolean)
@@ -66,7 +65,12 @@ def initialize(
 
       sig { override.void }
       def execute
-        require_gem_file
+        Loaders::Gem.load_application(
+          bundle: @bundle,
+          prerequire: @prerequire,
+          postrequire: @postrequire,
+          default_command: default_command(:require),
+        )
 
         gem_queue = gems_to_generate(@gem_names).reject { |gem| @exclude.include?(gem.name) }
         anything_done = [
@@ -87,7 +91,7 @@ def execute
             gem_dir: @outpath.to_s,
             dsl_dir: @dsl_dir,
             auto_strictness: @auto_strictness,
-            gems: bundle.dependencies
+            gems: @bundle.dependencies
           )
 
           say("All operations performed in working directory.", [:green, :bold])
@@ -117,7 +121,7 @@ def sync(should_verify: false, exclude: [])
             gem_dir: @outpath.to_s,
             dsl_dir: @dsl_dir,
             auto_strictness: @auto_strictness,
-            gems: bundle.dependencies
+            gems: @bundle.dependencies
           )
 
           say("All operations performed in working directory.", [:green, :bold])
@@ -131,42 +135,12 @@ def sync(should_verify: false, exclude: [])
 
       private
 
-      sig { returns(Runtime::Loader) }
-      def loader
-        @loader ||= Runtime::Loader.new
-      end
-
-      sig { returns(Gemfile) }
-      def bundle
-        @bundle ||= Gemfile.new(@exclude)
-      end
-
-      sig { void }
-      def require_gem_file
-        say("Requiring all gems to prepare for compiling... ")
-        begin
-          loader.load_bundle(bundle, @prerequire, @postrequire)
-        rescue LoadError => e
-          explain_failed_require(@postrequire, e)
-          exit(1)
-        end
-
-        Runtime::Trackers::Autoload.eager_load_all!
-
-        say(" Done", :green)
-        unless bundle.missing_specs.empty?
-          say("  completed with missing specs: ")
-          say(bundle.missing_specs.join(", "), :yellow)
-        end
-        puts
-      end
-
       sig { params(gem_names: T::Array[String]).returns(T::Array[Gemfile::GemSpec]) }
       def gems_to_generate(gem_names)
-        return bundle.dependencies if gem_names.empty?
+        return @bundle.dependencies if gem_names.empty?
 
         gem_names.map do |gem_name|
-          gem = bundle.gem(gem_name)
+          gem = @bundle.gem(gem_name)
           if gem.nil?
             say("Error: Cannot find gem '#{gem_name}'", :red)
             exit(1)
@@ -263,7 +237,12 @@ def perform_additions
           if gems.empty?
             say("Nothing to do.")
           else
-            require_gem_file
+            Loaders::Gem.load_application(
+              bundle: @bundle,
+              prerequire: @prerequire,
+              postrequire: @postrequire,
+              default_command: default_command(:require),
+            )
 
             Executor.new(gems, number_of_workers: @number_of_workers).run_in_parallel do |gem_name|
               filename = expected_rbi(gem_name)
@@ -273,7 +252,7 @@ def perform_additions
                 move(old_filename, filename) unless old_filename == filename
               end
 
-              gem = T.must(bundle.gem(gem_name))
+              gem = T.must(@bundle.gem(gem_name))
               compile_gem_rbi(gem)
               puts
             end
@@ -287,17 +266,6 @@ def perform_additions
         anything_done
       end
 
-      sig { params(file: String, error: LoadError).void }
-      def explain_failed_require(file, error)
-        say_error("\n\nLoadError: #{error}", :bold, :red)
-        say_error("\nTapioca could not load all the gems required by your application.", :yellow)
-        say_error("If you populated ", :yellow)
-        say_error("#{file} ", :bold, :blue)
-        say_error("with ", :yellow)
-        say_error("`#{default_command(:require)}`", :bold, :blue)
-        say_error("you should probably review it and remove the faulty line.", :yellow)
-      end
-
       sig { returns(T::Array[String]) }
       def removed_rbis
         (existing_rbis.keys - expected_rbis.keys).sort
@@ -359,7 +327,7 @@ def existing_rbis
 
       sig { returns(T::Hash[String, String]) }
       def expected_rbis
-        @expected_rbis ||= bundle.dependencies
+        @expected_rbis ||= @bundle.dependencies
           .reject { |gem| @exclude.include?(gem.name) }
           .to_h { |gem| [gem.name, gem.version.to_s] }
       end

lib/tapioca/internal.rb

@@ -27,7 +27,6 @@
 
 require "tapioca/runtime/dynamic_mixin_compiler"
 require "tapioca/helpers/gem_helper"
-require "tapioca/runtime/loader"
 
 require "tapioca/helpers/sorbet_helper"
 require "tapioca/helpers/rbi_helper"
@@ -51,6 +50,7 @@
 require "tapioca/static/requires_compiler"
 
 require "tapioca/loaders/loader"
+require "tapioca/loaders/gem"
 require "tapioca/loaders/dsl"
 
 require "tapioca/gem"

lib/tapioca/loaders/gem.rb

@@ -0,0 +1,78 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Tapioca
+  module Loaders
+    class Gem < Loader
+      extend T::Sig
+
+      sig do
+        params(
+          bundle: Gemfile,
+          prerequire: T.nilable(String),
+          postrequire: String,
+          default_command: String
+        ).void
+      end
+      def self.load_application(bundle:, prerequire:, postrequire:, default_command:)
+        loader = new(bundle: bundle, prerequire: prerequire, postrequire: postrequire, default_command: default_command)
+        loader.load
+      end
+
+      sig { override.void }
+      def load
+        require_gem_file
+      end
+
+      protected
+
+      sig do
+        params(
+          bundle: Gemfile,
+          prerequire: T.nilable(String),
+          postrequire: String,
+          default_command: String
+        ).void
+      end
+      def initialize(bundle:, prerequire:, postrequire:, default_command:)
+        super()
+
+        @bundle = bundle
+        @prerequire = prerequire
+        @postrequire = postrequire
+        @default_command = default_command
+      end
+
+      sig { void }
+      def require_gem_file
+        say("Requiring all gems to prepare for compiling... ")
+        begin
+          load_bundle(@bundle, @prerequire, @postrequire)
+        rescue LoadError => e
+          explain_failed_require(@postrequire, e)
+          exit(1)
+        end
+
+        Runtime::Trackers::Autoload.eager_load_all!
+
+        say(" Done", :green)
+        unless @bundle.missing_specs.empty?
+          say("  completed with missing specs: ")
+          say(@bundle.missing_specs.join(", "), :yellow)
+        end
+        puts
+      end
+
+      sig { params(file: String, error: LoadError).void }
+      def explain_failed_require(file, error)
+        say_error("\n\nLoadError: #{error}", :bold, :red)
+        say_error("\nTapioca could not load all the gems required by your application.", :yellow)
+        say_error("If you populated ", :yellow)
+        say_error("#{file} ", :bold, :blue)
+        say_error("with ", :yellow)
+        say_error("`#{@default_command}`", :bold, :blue)
+        say_error("you should probably review it and remove the faulty line.", :yellow)
+      end
+    end
+  end
+end

lib/tapioca/loaders/loader.rb

@@ -9,6 +9,7 @@ class Loader
 
       include Thor::Base
       include CliHelper
+      include Tapioca::GemHelper
 
       abstract!
 
@@ -17,6 +18,21 @@ def load; end
 
       private
 
+      sig do
+        params(gemfile: Tapioca::Gemfile, initialize_file: T.nilable(String), require_file: T.nilable(String)).void
+      end
+      def load_bundle(gemfile, initialize_file, require_file)
+        require_helper(initialize_file)
+
+        load_rails_application
+
+        gemfile.require_bundle
+
+        require_helper(require_file)
+
+        load_rails_engines
+      end
+
       sig { params(environment_load: T::Boolean, eager_load: T::Boolean).void }
       def load_rails_application(environment_load: false, eager_load: false)
         return unless File.exist?("config/application.rb")
@@ -32,6 +48,43 @@ def load_rails_application(environment_load: false, eager_load: false)
         eager_load_rails_app if eager_load
       end
 
+      sig { void }
+      def load_rails_engines
+        rails_engines.each do |engine|
+          errored_files = []
+
+          engine.config.eager_load_paths.each do |load_path|
+            Dir.glob("#{load_path}/**/*.rb").sort.each do |file|
+              require(file)
+            rescue LoadError, StandardError
+              errored_files << file
+            end
+          end
+
+          # Try files that have errored one more time
+          # It might have been a load order problem
+          errored_files.each do |file|
+            require(file)
+          rescue LoadError, StandardError
+            nil
+          end
+        end
+      end
+
+      sig { returns(T::Array[T.untyped]) }
+      def rails_engines
+        return [] unless Object.const_defined?("Rails::Engine")
+
+        safe_require("active_support/core_ext/class/subclasses")
+
+        project_path = Bundler.default_gemfile.parent.expand_path
+        # We can use `Class#descendants` here, since we know Rails is loaded
+        Object.const_get("Rails::Engine")
+          .descendants
+          .reject(&:abstract_railtie?)
+          .reject { |engine| gem_in_app_dir?(project_path, engine.config.root.to_path) }
+      end
+
       sig { params(path: String).void }
       def safe_require(path)
         require path
@@ -72,6 +125,16 @@ def eager_load_rails_app
           application.config.eager_load_namespaces.each(&:eager_load!)
         end
       end
+
+      sig { params(file: T.nilable(String)).void }
+      def require_helper(file)
+        return unless file
+
+        file = File.absolute_path(file)
+        return unless File.exist?(file)
+
+        require(file)
+      end
     end
   end
 end