Merge pull request #1418 from jeffcarbs/pending-migrations

Only run pending migrations check if necessary

Author: egiurleo

lib/tapioca/dsl/pipeline.rb

@@ -68,6 +68,10 @@ def run(&blk)
           ERROR
         end
 
+        if defined?(::ActiveRecord::Base) && constants_to_process.any? { |c| ::ActiveRecord::Base > c }
+          abort_if_pending_migrations!
+        end
+
         result = Executor.new(
           constants_to_process,
           number_of_workers: @number_of_workers,
@@ -184,6 +188,16 @@ def report_error(error)
         handler.call(error)
         exit(1)
       end
+
+      sig { void }
+      def abort_if_pending_migrations!
+        return unless defined?(::Rake)
+
+        Rails.application.load_tasks
+        if Rake::Task.task_defined?("db:abort_if_pending_migrations")
+          Rake::Task["db:abort_if_pending_migrations"].invoke
+        end
+      end
     end
   end
 end

lib/tapioca/loaders/dsl.rb

@@ -20,7 +20,6 @@ def load_application(tapioca_path:, eager_load: true, app_root: ".")
       def load
         load_dsl_extensions
         load_application
-        abort_if_pending_migrations!
         load_dsl_compilers
       end
 
@@ -70,17 +69,6 @@ def load_application
 
         say("Done", :green)
       end
-
-      sig { void }
-      def abort_if_pending_migrations!
-        return unless File.exist?("#{@app_root}/config/application.rb")
-        return unless defined?(::Rake)
-
-        Rails.application.load_tasks
-        if Rake::Task.task_defined?("db:abort_if_pending_migrations")
-          Rake::Task["db:abort_if_pending_migrations"].invoke
-        end
-      end
     end
   end
 end

spec/tapioca/cli/dsl_spec.rb

@@ -1212,64 +1212,128 @@ def body=(body); end
           RBI
         end
 
-        it "aborts if there are pending migrations" do
-          @project.require_real_gem("rake", "13.0.6")
-          @project.bundle_install
+        describe "pending migrations" do
+          before do
+            @project.write("db/migrate/202001010000_create_articles.rb", <<~RB)
+              class CreateArticles < ActiveRecord::Migration[6.1]
+                def change
+                  create_table(:articles) do |t|
+                    t.timestamps
+                  end
+                end
+              end
+            RB
 
-          @project.write("lib/post.rb", <<~RB)
-            require "smart_properties"
+            @project.write("lib/database.rb", <<~RB)
+              require "rake"
 
-            class Post
-              include SmartProperties
-              property :title, accepts: String
-            end
-          RB
+              namespace :db do
+                task :abort_if_pending_migrations do
+                  pending_migrations = Dir["\#{Kernel.__dir__}/../db/migrate/*.rb"]
 
-          @project.write("db/migrate/202001010000_create_articles.rb", <<~RB)
-            class CreateArticles < ActiveRecord::Migration[6.1]
-              def change
-                create_table(:articles) do |t|
-                  t.timestamps
+                  if pending_migrations.any?
+                    Kernel.puts "You have \#{pending_migrations.size} pending migration:"
+
+                    pending_migrations.each do |pending_migration|
+                      name = pending_migration.split("/").last
+                      Kernel.puts name
+                    end
+
+                    Kernel.abort(%{Run `bin/rails db:migrate` to update your database then try again.})
+                  end
                 end
               end
-            end
-          RB
+            RB
 
-          @project.write("lib/database.rb", <<~RB)
-            require "rake"
+            @project.require_real_gem("rake", "13.0.6")
+            @project.require_real_gem("activerecord")
+            @project.bundle_install
+          end
 
-            namespace :db do
-              task :abort_if_pending_migrations do
-                pending_migrations = Dir["\#{Kernel.__dir__}/../db/migrate/*.rb"]
+          it "aborts if there are pending migrations" do
+            @project.write("lib/post.rb", <<~RB)
+              class Post < ActiveRecord::Base
+              end
+            RB
 
-                if pending_migrations.any?
-                  Kernel.puts "You have \#{pending_migrations.size} pending migration:"
+            result = @project.tapioca("dsl Post")
 
-                  pending_migrations.each do |pending_migration|
-                    name = pending_migration.split("/").last
-                    Kernel.puts name
-                  end
+            # FIXME: print the error to the correct stream
+            assert_equal(<<~OUT, result.out)
+              Loading Rails application... Done
+              Loading DSL compiler classes... Done
+              Compiling DSL RBI files...
 
-                  Kernel.abort(%{Run `bin/rails db:migrate` to update your database then try again.})
-                end
+              You have 1 pending migration:
+              202001010000_create_articles.rb
+            OUT
+
+            assert_equal(<<~ERR, result.err)
+              Run `bin/rails db:migrate` to update your database then try again.
+            ERR
+
+            refute_success_status(result)
+          end
+
+          it "aborts if there are pending migrations and no arg was passed" do
+            @project.write("lib/post.rb", <<~RB)
+              class Post < ActiveRecord::Base
               end
-            end
-          RB
+            RB
 
-          result = @project.tapioca("dsl")
+            result = @project.tapioca("dsl")
 
-          # FIXME: print the error to the correct stream
-          assert_equal(<<~OUT, result.out)
-            Loading Rails application... Done
-            You have 1 pending migration:
-            202001010000_create_articles.rb
-          OUT
+            # FIXME: print the error to the correct stream
+            assert_equal(<<~OUT, result.out)
+              Loading Rails application... Done
+              Loading DSL compiler classes... Done
+              Compiling DSL RBI files...
 
-          assert_equal(<<~ERR, result.err)
-            Run `bin/rails db:migrate` to update your database then try again.
-          ERR
+              You have 1 pending migration:
+              202001010000_create_articles.rb
+            OUT
 
-          refute_success_status(result)
+            assert_equal(<<~ERR, result.err)
+              Run `bin/rails db:migrate` to update your database then try again.
+            ERR
+
+            refute_success_status(result)
+          end
+
+          it "does not abort if there are pending migrations but no active record models" do
+            @project.write("lib/post.rb", <<~RB)
+              require "smart_properties"
+
+              class Post
+                include SmartProperties
+                property :title, accepts: String
+              end
+            RB
+
+            result = @project.tapioca("dsl Post")
+
+            assert_equal(<<~OUT, result.out)
+              Loading Rails application... Done
+              Loading DSL compiler classes... Done
+              Compiling DSL RBI files...
+
+                    create  sorbet/rbi/dsl/post.rbi
+
+              Done
+
+              Checking generated RBI files...  Done
+                No errors found
+
+              All operations performed in working directory.
+              Please review changes and commit them.
+            OUT
+
+            assert_empty_stderr(result)
+
+            assert_project_file_exist("sorbet/rbi/dsl/post.rbi")
+
+            assert_success_status(result)
+          end
         end
 
         it "overwrites existing RBIs without user input" do