active_record_doctor 1.10.0 → 1.11.0

data/test/active_record_doctor/detectors/undefined_table_references_test.rb

@@ -3,17 +3,17 @@
 class ActiveRecordDoctor::Detectors::UndefinedTableReferencesTest < Minitest::Test
   def test_model_backed_by_table
     create_table(:users) do
-    end.create_model do
+    end.define_model do
     end
 
     refute_problems
   end
 
   def test_model_backed_by_non_existent_table
-    create_model(:User)
+    define_model(:User)
 
     assert_problems(<<~OUTPUT)
-      ModelFactory::Models::User references a non-existent table or view named users
+      TransientRecord::Models::User references a non-existent table or view named users
     OUTPUT
   end
 
@@ -21,22 +21,20 @@ class ActiveRecordDoctor::Detectors::UndefinedTableReferencesTest < Minitest::Te
     # We replace the underlying table with a view. The view doesn't have to be
     # backed by an actual table - it can simply return a predefined tuple.
     ActiveRecord::Base.connection.execute("CREATE VIEW users AS SELECT 1")
-    create_model(:User)
+    define_model(:User)
 
-    begin
-      refute_problems
-    ensure
-      ActiveRecord::Base.connection.execute("DROP VIEW users")
-    end
+    refute_problems
+  ensure
+    ActiveRecord::Base.connection.execute("DROP VIEW users")
   end
 
   def test_config_ignore_tables
-    create_model(:User)
+    define_model(:User)
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
         config.detector :undefined_table_references,
-          ignore_models: ["ModelFactory::Models::User"]
+          ignore_models: ["TransientRecord::Models::User"]
       end
     CONFIG
 
@@ -44,11 +42,11 @@ class ActiveRecordDoctor::Detectors::UndefinedTableReferencesTest < Minitest::Te
   end
 
   def test_global_ignore_tables
-    create_model(:User)
+    define_model(:User)
 
     config_file(<<-CONFIG)
       ActiveRecordDoctor.configure do |config|
-        config.global :ignore_models, ["ModelFactory::Models::User"]
+        config.global :ignore_models, ["TransientRecord::Models::User"]
       end
     CONFIG
 

data/test/active_record_doctor/runner_test.rb

@@ -1,42 +1,41 @@
 # frozen_string_literal: true
 
 class ActiveRecordDoctor::RunnerTest < Minitest::Test
-  def test_run_one_raises_on_unknown_detectors
-    io = StringIO.new
-    runner = ActiveRecordDoctor::Runner.new(load_config, io)
+  def setup
+    @io = StringIO.new
+    @runner = ActiveRecordDoctor::Runner.new(
+      config: load_config,
+      logger: ActiveRecordDoctor::Logger::Dummy.new,
+      io: @io
+    )
+  end
 
+  def test_run_one_raises_on_unknown_detectors
     assert_raises(KeyError) do
-      runner.run_one(:performance_issues)
+      @runner.run_one(:performance_issues)
     end
   end
 
   def test_run_all_returns_true_when_no_errors
-    io = StringIO.new
-    runner = ActiveRecordDoctor::Runner.new(load_config, io)
-
-    assert(runner.run_all)
-    assert(io.string.blank?)
+    assert(@runner.run_all)
+    assert(@io.string.blank?)
   end
 
   def test_run_all_returns_false_when_errors
     # Create a model without its underlying table to trigger an error.
-    create_model(:User)
-
-    io = StringIO.new
-    runner = ActiveRecordDoctor::Runner.new(load_config, io)
+    define_model(:User)
 
-    refute(runner.run_all)
-    refute(io.string.blank?)
+    refute(@runner.run_all)
+    refute(@io.string.blank?)
   end
 
   def test_help_prints_help
     ActiveRecordDoctor.detectors.each do |name, _|
-      io = StringIO.new
-      runner = ActiveRecordDoctor::Runner.new(load_config, io)
+      @io.truncate(0)
 
-      runner.help(name)
+      @runner.help(name)
 
-      refute(io.string.blank?, "expected help for #{name}")
+      refute(@io.string.blank?, "expected help for #{name}")
     end
   end
 end

data/test/setup.rb

@@ -33,7 +33,7 @@ require "active_record_doctor"
 require "minitest"
 require "minitest/autorun"
 require "minitest/fork_executor"
-require_relative "model_factory"
+require "transient_record"
 
 # Filter out Minitest backtrace while allowing backtrace from other libraries
 # to be shown.
@@ -44,11 +44,11 @@ Minitest.parallel_executor = Minitest::ForkExecutor.new
 
 # Prepare the test class.
 class Minitest::Test
-  include ModelFactory
+  include TransientRecord
 
   def setup
     # Delete remnants (models and tables) of previous test case runs.
-    cleanup_models
+    TransientRecord.cleanup
   end
 
   def teardown
@@ -61,7 +61,7 @@ class Minitest::Test
 
     # Ensure all remnants of previous test runs, most likely in form of tables,
     # are removed.
-    cleanup_models
+    TransientRecord.cleanup
   end
 
   private
@@ -93,7 +93,11 @@ class Minitest::Test
 
   def run_detector
     io = StringIO.new
-    runner = ActiveRecordDoctor::Runner.new(load_config, io)
+    runner = ActiveRecordDoctor::Runner.new(
+      config: load_config,
+      logger: ActiveRecordDoctor::Logger::Dummy.new,
+      io: io
+    )
     success = runner.run_one(detector_name)
     [success, io.string]
   end
@@ -115,6 +119,6 @@ class Minitest::Test
   end
 
   def sort_lines(string)
-    string.split("\n").sort.join("\n")
+    string.split("\n").sort
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_doctor
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Greg Navis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-07 00:00:00.000000000 Z
+date: 2023-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: transient_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -138,6 +152,9 @@ files:
 - lib/active_record_doctor/detectors/unindexed_foreign_keys.rb
 - lib/active_record_doctor/errors.rb
 - lib/active_record_doctor/help.rb
+- lib/active_record_doctor/logger.rb
+- lib/active_record_doctor/logger/dummy.rb
+- lib/active_record_doctor/logger/hierarchical.rb
 - lib/active_record_doctor/printers.rb
 - lib/active_record_doctor/railtie.rb
 - lib/active_record_doctor/rake/task.rb
@@ -164,7 +181,6 @@ files:
 - test/active_record_doctor/detectors/unindexed_foreign_keys_test.rb
 - test/active_record_doctor/runner_test.rb
 - test/generators/active_record_doctor/add_indexes/add_indexes_generator_test.rb
-- test/model_factory.rb
 - test/setup.rb
 homepage: https://github.com/gregnavis/active_record_doctor
 licenses:
@@ -208,5 +224,4 @@ test_files:
 - test/active_record_doctor/detectors/unindexed_foreign_keys_test.rb
 - test/active_record_doctor/runner_test.rb
 - test/generators/active_record_doctor/add_indexes/add_indexes_generator_test.rb
-- test/model_factory.rb
 - test/setup.rb

data/test/model_factory.rb

@@ -1,128 +0,0 @@
-# frozen_string_literal: true
-
-module ModelFactory
-  def create_table(*args, &block)
-    ModelFactory.create_table(*args, &block)
-  end
-
-  def create_model(*args, &block)
-    ModelFactory.create_model(*args, &block)
-  end
-
-  def cleanup_models
-    ModelFactory.cleanup_models
-  end
-
-  def self.cleanup_models
-    delete_models
-    drop_all_tables
-    GC.start
-  end
-
-  def self.drop_all_tables
-    connection = ActiveRecord::Base.connection
-    loop do
-      before = connection.data_sources.size
-      break if before.zero?
-
-      try_drop_all_tables_and_views(connection)
-      remaining_data_sources = connection.data_sources
-      after = remaining_data_sources.size
-
-      # rubocop:disable Style/Next
-      if before == after
-        raise(<<~ERROR)
-          Cannot delete temporary tables - most likely due to failing constraints. Remaining tables and views:
-
-          #{remaining_data_sources.join("\n")}
-        ERROR
-      end
-      # rubocop:enable Style/Next
-    end
-  end
-
-  def self.try_drop_all_tables_and_views(connection)
-    connection.data_sources.each do |table_name|
-      try_drop_table(connection, table_name) || try_drop_view(connection, table_name)
-    end
-  end
-
-  def self.try_drop_table(connection, table_name)
-    ActiveRecord::Migration.suppress_messages do
-      begin
-        connection.drop_table(table_name, force: :cascade)
-        true
-      rescue ActiveRecord::InvalidForeignKey, ActiveRecord::StatementInvalid
-        # The table cannot be dropped due to foreign key constraints so
-        # we'll try to drop it on another attempt.
-        false
-      end
-    end
-  end
-
-  def self.try_drop_view(connection, view_name)
-    ActiveRecord::Migration.suppress_messages do
-      begin
-        connection.execute("DROP VIEW #{view_name}")
-        true
-      rescue ActiveRecord::InvalidForeignKey, ActiveRecord::StatementInvalid
-        # The table cannot be dropped due to foreign key constraints so
-        # we'll try to drop it on another attempt.
-        false
-      end
-    end
-  end
-
-  def self.delete_models
-    Models.empty
-  end
-
-  def self.create_table(table_name, options = {}, &block)
-    table_name = table_name.to_sym
-    ActiveRecord::Migration.suppress_messages do
-      ActiveRecord::Migration.create_table(table_name, **options, &block)
-    end
-    # Return a proxy object allowing the caller to chain #create_model
-    # right after creating a table so that it can be followed by the model
-    # definition.
-    ModelDefinitionProxy.new(table_name)
-  end
-
-  def self.create_model(model_name, base_class = ActiveRecord::Base, &block)
-    model_name = model_name.to_sym
-
-    # Normally, when a class is defined via `class MyClass < MySuperclass` the
-    # .name class method returns the name of the class when called from within
-    # the class body. However, anonymous classes defined via Class.new DO NOT
-    # HAVE NAMES. They're assigned names when they're assigned to a constant.
-    # If we evaluated the class body, passed via block here, in the class
-    # definition below then some macros would break
-    # (e.g. has_and_belongs_to_many) due to nil name.
-    #
-    # We solve the problem by defining an empty model class first, assigning to
-    # a constant to ensure a name is assigned, and then reopening the class to
-    # give it a non-trivial body.
-    klass = Class.new(base_class)
-    Models.const_set(model_name, klass)
-
-    klass.class_eval(&block) if block_given?
-  end
-
-  class ModelDefinitionProxy
-    def initialize(table_name)
-      @table_name = table_name
-    end
-
-    def create_model(&block)
-      ModelFactory.create_model(@table_name.to_s.classify, &block)
-    end
-  end
-
-  module Models
-    def self.empty
-      constants.each do |name|
-        remove_const(name)
-      end
-    end
-  end
-end