test-prof 0.7.5 → 0.9.0

data/lib/test_prof/before_all.rb

@@ -17,13 +17,89 @@ module TestProf
 
       def begin_transaction
         raise AdapterMissing if adapter.nil?
-        adapter.begin_transaction
+
+        config.run_hooks(:begin) do
+          adapter.begin_transaction
+        end
+        yield
+      end
+
+      def within_transaction
+        yield
       end
 
       def rollback_transaction
         raise AdapterMissing if adapter.nil?
-        adapter.rollback_transaction
+
+        config.run_hooks(:rollback) do
+          adapter.rollback_transaction
+        end
+      end
+
+      def config
+        @config ||= Configuration.new
+      end
+
+      def configure
+        yield config
+      end
+    end
+
+    class HooksChain # :nodoc:
+      attr_reader :type, :after, :before
+
+      def initialize(type)
+        @type = type
+        @before = []
+        @after = []
+      end
+
+      def run
+        before.each(&:call)
+        yield
+        after.each(&:call)
+      end
+    end
+
+    class Configuration
+      HOOKS = %i[begin rollback].freeze
+
+      def initialize
+        @hooks = Hash.new { |h, k| h[k] = HooksChain.new(k) }
+      end
+
+      # Add `before` hook for `begin` or
+      # `rollback` operation:
+      #
+      #   config.before(:rollback) { ... }
+      def before(type)
+        validate_hook_type!(type)
+        hooks[type].before << Proc.new
+      end
+
+      # Add `after` hook for `begin` or
+      # `rollback` operation:
+      #
+      #   config.after(:begin) { ... }
+      def after(type)
+        validate_hook_type!(type)
+        hooks[type].after << Proc.new
+      end
+
+      def run_hooks(type) # :nodoc:
+        validate_hook_type!(type)
+        hooks[type].run { yield }
+      end
+
+      private
+
+      def validate_hook_type!(type)
+        return if HOOKS.include?(type)
+
+        raise ArgumentError, "Unknown hook type: #{type}. Valid types: #{HOOKS.join(", ")}"
       end
+
+      attr_reader :hooks
     end
   end
 end
@@ -33,3 +109,7 @@ if defined?(::ActiveRecord::Base)
 
   TestProf::BeforeAll.adapter = TestProf::BeforeAll::Adapters::ActiveRecord
 end
+
+if defined?(::Isolator)
+  require "test_prof/before_all/isolator"
+end

data/lib/test_prof/cops/rspec/aggregate_failures.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'rubocop'
-require 'test_prof/utils'
+require "rubocop"
+require "test_prof/utils"
 
 module RuboCop
   module Cop
@@ -38,7 +38,7 @@ module RuboCop
         class << self
           def supported?
             return @supported if instance_variable_defined?(:@supported)
-            @supported = TestProf::Utils.verify_gem_version('rubocop', at_least: '0.51.0')
+            @supported = TestProf::Utils.verify_gem_version("rubocop", at_least: "0.51.0")
 
             unless @supported
               warn "RSpec/AggregateFailures cop requires RuboCop >= 0.51.0. Skipping"
@@ -62,7 +62,7 @@ module RuboCop
           add_offense(
             node,
             location: :expression,
-            message: 'Use :aggregate_failures instead of several one-liners.'
+            message: "Use :aggregate_failures instead of several one-liners."
           )
         end
 
@@ -140,7 +140,7 @@ module RuboCop
           %(#{method_name} "works", :aggregate_failures do)
         end
 
-        def body_from(node, base_indent = '')
+        def body_from(node, base_indent = "")
           method, _args, body = *node
           body_source = method.method_name == :its ? body_from_its(method, body) : body.source
           "#{base_indent}#{indent}#{body_source}"
@@ -162,7 +162,7 @@ module RuboCop
         end
 
         def indent
-          @indent ||= " " * (config.for_cop('IndentationWidth')['Width'] || 2)
+          @indent ||= " " * (config.for_cop("IndentationWidth")["Width"] || 2)
         end
       end
     end

data/lib/test_prof/event_prof/custom_events/factory_create.rb

@@ -1,56 +1,38 @@
 # frozen_string_literal: true
 
 require "test_prof/factory_bot"
+require "test_prof/ext/factory_bot_strategy"
 
-module TestProf::EventProf::CustomEvents
-  module FactoryCreate # :nodoc: all
-    module RunnerPatch
-      def run(strategy = @strategy)
-        return super unless strategy == :create
-        FactoryCreate.track(@name) do
-          super
-        end
-      end
-    end
-
-    class << self
-      def setup!
-        @depth = 0
-        TestProf::FactoryBot::FactoryRunner.prepend RunnerPatch
-      end
+using TestProf::FactoryBotStrategy
 
-      def track(factory)
-        @depth += 1
-        res = nil
-        begin
-          res =
-            if @depth == 1
-              ActiveSupport::Notifications.instrument(
-                'factory.create',
-                name: factory
-              ) { yield }
-            else
-              yield
-            end
-        ensure
-          @depth -= 1
-        end
-        res
-      end
+TestProf::EventProf::CustomEvents.register("factory.create") do
+  if defined?(TestProf::FactoryBot) || defined?(Fabricate)
+    if defined?(TestProf::FactoryBot)
+      TestProf::EventProf.monitor(
+        TestProf::FactoryBot::FactoryRunner,
+        "factory.create",
+        :run,
+        top_level: true,
+        guard: ->(strategy = @strategy) { strategy.create? }
+      )
     end
-  end
-end
 
-TestProf::EventProf::CustomEvents.register("factory.create") do
-  if defined? TestProf::FactoryBot
-    TestProf::EventProf::CustomEvents::FactoryCreate.setup!
+    if defined?(Fabricate)
+      TestProf::EventProf.monitor(
+        Fabricate.singleton_class,
+        "factory.create",
+        :create,
+        top_level: true
+      )
+    end
   else
-    TestProf.log(:error,
-                 <<~MSG
-                   Failed to load factory_bot / factory_girl.
+    TestProf.log(
+      :error,
+      <<~MSG
+        Failed to load factory_bot / factory_girl / fabrication.
 
-                   Make sure that any of them is in your Gemfile.
-                 MSG
-                )
+        Make sure that any of them is in your Gemfile.
+      MSG
+    )
   end
 end

data/lib/test_prof/event_prof/custom_events/sidekiq_inline.rb

@@ -1,50 +1,20 @@
 # frozen_string_literal: true
 
-module TestProf::EventProf::CustomEvents
-  module SidekiqInline # :nodoc: all
-    module ClientPatch
-      def raw_push(*)
-        return super unless Sidekiq::Testing.inline?
-        SidekiqInline.track { super }
-      end
-    end
-
-    class << self
-      def setup!
-        @depth = 0
-        Sidekiq::Client.prepend ClientPatch
-      end
-
-      def track
-        @depth += 1
-        res = nil
-        begin
-          res =
-            if @depth == 1
-              ActiveSupport::Notifications.instrument(
-                'sidekiq.inline'
-              ) { yield }
-            else
-              yield
-            end
-        ensure
-          @depth -= 1
-        end
-        res
-      end
-    end
-  end
-end
-
 TestProf::EventProf::CustomEvents.register("sidekiq.inline") do
   if TestProf.require(
-    'sidekiq/testing',
+    "sidekiq/testing",
     <<~MSG
       Failed to load Sidekiq.
 
       Make sure that "sidekiq" gem is in your Gemfile.
     MSG
   )
-    TestProf::EventProf::CustomEvents::SidekiqInline.setup!
+    TestProf::EventProf.monitor(
+      Sidekiq::Client,
+      "sidekiq.inline",
+      :raw_push,
+      top_level: true,
+      guard: ->(*) { Sidekiq::Testing.inline? }
+    )
   end
 end

data/lib/test_prof/event_prof/custom_events/sidekiq_jobs.rb

@@ -1,38 +1,20 @@
 # frozen_string_literal: true
 
-module TestProf::EventProf::CustomEvents
-  module SidekiqJobs # :nodoc: all
-    module ClientPatch
-      def raw_push(*)
-        return super unless Sidekiq::Testing.inline?
-        SidekiqJobs.track { super }
-      end
-    end
-
-    class << self
-      def setup!
-        Sidekiq::Client.prepend ClientPatch
-      end
-
-      def track
-        ActiveSupport::Notifications.instrument(
-          'sidekiq.jobs'
-        ) { yield }
-      end
-    end
-  end
-end
-
 TestProf::EventProf::CustomEvents.register("sidekiq.jobs") do
   if TestProf.require(
-    'sidekiq/testing',
+    "sidekiq/testing",
     <<~MSG
       Failed to load Sidekiq.
 
       Make sure that "sidekiq" gem is in your Gemfile.
     MSG
   )
-    TestProf::EventProf::CustomEvents::SidekiqJobs.setup!
+    TestProf::EventProf.monitor(
+      Sidekiq::Client,
+      "sidekiq.jobs",
+      :raw_push,
+      guard: ->(*) { Sidekiq::Testing.inline? }
+    )
     TestProf::EventProf.configure do |config|
       config.rank_by = :count
     end

data/lib/test_prof/event_prof/instrumentations/active_support.rb

@@ -6,7 +6,7 @@ module TestProf::EventProf
     module ActiveSupport
       class << self
         def subscribe(event)
-          raise ArgumentError, 'Block is required!' unless block_given?
+          raise ArgumentError, "Block is required!" unless block_given?
 
           ::ActiveSupport::Notifications.subscribe(event) do |_event, start, finish, *_args|
             yield (finish - start)

data/lib/test_prof/event_prof/minitest.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'minitest/base_reporter'
-require 'minitest/event_prof_formatter'
+require "minitest/base_reporter"
+require "minitest/event_prof_formatter"
 
 module Minitest
   module TestProf
@@ -10,7 +10,7 @@ module Minitest
         super
         @profiler = configure_profiler(options)
 
-        log :info, "EventProf enabled (#{@profiler.events.join(', ')})"
+        log :info, "EventProf enabled (#{@profiler.events.join(", ")})"
 
         @formatter = EventProfFormatter.new(@profiler)
         @current_group = nil
@@ -45,7 +45,7 @@ module Minitest
         end
 
         @current_example = {
-          name: example.gsub(/^test_(?:\d+_)?/, ''),
+          name: example.gsub(/^test_(?:\d+_)?/, ""),
           location: location_with_line_number(group, example)
         }
 

data/lib/test_prof/event_prof/monitor.rb

@@ -4,17 +4,54 @@ module TestProf
   module EventProf
     # Wrap methods with instrumentation
     module Monitor
+      class BaseTracker
+        attr_reader :event
+
+        def initialize(event)
+          @event = event
+        end
+
+        def track
+          TestProf::EventProf.instrumenter.instrument(event) { yield }
+        end
+      end
+
+      class TopLevelTracker < BaseTracker
+        attr_reader :id
+
+        def initialize(event)
+          super
+          @id = :"event_prof_monitor_#{event}"
+          Thread.current[id] = 0
+        end
+
+        def track
+          Thread.current[id] += 1
+          res = nil
+          begin
+            res =
+              if Thread.current[id] == 1
+                super { yield }
+              else
+                yield
+              end
+          ensure
+            Thread.current[id] -= 1
+          end
+          res
+        end
+      end
+
       class << self
-        def call(mod, event, *mids)
+        def call(mod, event, *mids, guard: nil, top_level: false)
+          tracker = top_level ? TopLevelTracker.new(event) : BaseTracker.new(event)
+
           patch = Module.new do
             mids.each do |mid|
-              module_eval <<~SRC, __FILE__, __LINE__ + 1
-                def #{mid}(*)
-                  TestProf::EventProf.instrumenter.instrument(
-                    '#{event}'
-                  ) { super }
-                end
-              SRC
+              define_method(mid) do |*args, &block|
+                next super(*args, &block) unless guard.nil? || instance_exec(*args, &guard)
+                tracker.track { super(*args, &block) }
+              end
             end
           end
 

data/lib/test_prof/event_prof/rspec.rb

@@ -14,15 +14,13 @@ module TestProf
         example_group_started
         example_group_finished
         example_started
-        example_failed
-        example_passed
-        example_pending
+        example_finished
       ].freeze
 
       def initialize
         @profiler = EventProf.build
 
-        log :info, "EventProf enabled (#{@profiler.events.join(', ')})"
+        log :info, "EventProf enabled (#{@profiler.events.join(", ")})"
       end
 
       def example_group_started(notification)
@@ -43,11 +41,6 @@ module TestProf
         @profiler.example_finished notification.example
       end
 
-      # NOTE: RSpec < 3.4.0 doesn't have example_finished event
-      alias example_passed example_finished
-      alias example_failed example_finished
-      alias example_pending example_finished
-
       def print
         @profiler.each(&method(:report))
       end
@@ -145,8 +138,8 @@ module TestProf
 end
 
 # Register EventProf listener
-TestProf.activate('EVENT_PROF') do
-  TestProf::EventProf::CustomEvents.activate_all(ENV['EVENT_PROF'])
+TestProf.activate("EVENT_PROF") do
+  TestProf::EventProf::CustomEvents.activate_all(ENV["EVENT_PROF"])
 
   RSpec.configure do |config|
     listener = nil

data/lib/test_prof/event_prof.rb

@@ -31,19 +31,19 @@ module TestProf
     class Configuration
       # Map of supported instrumenters
       INSTRUMENTERS = {
-        active_support: 'ActiveSupport'
+        active_support: "ActiveSupport"
       }.freeze
 
       attr_accessor :instrumenter, :top_count, :per_example,
                     :rank_by, :event
 
       def initialize
-        @event = ENV['EVENT_PROF']
+        @event = ENV["EVENT_PROF"]
         @instrumenter = :active_support
-        @top_count = (ENV['EVENT_PROF_TOP'] || 5).to_i
-        @per_example = ENV['EVENT_PROF_EXAMPLES'] == '1'
-        @rank_by = (ENV['EVENT_PROF_RANK'] || :time).to_sym
-        @stamp = ENV['EVENT_PROF_STAMP']
+        @top_count = (ENV["EVENT_PROF_TOP"] || 5).to_i
+        @per_example = ENV["EVENT_PROF_EXAMPLES"] == "1"
+        @rank_by = (ENV["EVENT_PROF_RANK"] || :time).to_sym
+        @stamp = ENV["EVENT_PROF_STAMP"]
 
         RSpecStamp.config.tags = @stamp if stamp?
       end

data/lib/test_prof/ext/factory_bot_strategy.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module TestProf
+  # FactoryBot 5.0 uses strategy classes for associations,
+  # older versions and top-level invocations use Symbols.
+  #
+  # This Refinement should be used FactoryRunner patches to check
+  # that strategy is :create.
+  module FactoryBotStrategy
+    refine Symbol do
+      def create?
+        self == :create
+      end
+    end
+
+    if defined?(::FactoryBot::Strategy::Create)
+      refine Class do
+        def create?
+          self <= ::FactoryBot::Strategy::Create
+        end
+      end
+    end
+  end
+end

data/lib/test_prof/factory_bot.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module TestProf # :nodoc: all
-  FACTORY_GIRL_NAMES = { 'factory_bot' => '::FactoryBot', 'factory_girl' => '::FactoryGirl' }.freeze
+  FACTORY_GIRL_NAMES = {"factory_bot" => "::FactoryBot", "factory_girl" => "::FactoryGirl"}.freeze
 
   FACTORY_GIRL_NAMES.find do |name, cname|
     TestProf.require(name) do

data/lib/test_prof/factory_default.rb

@@ -38,7 +38,7 @@ module TestProf
 
       def register(name, obj, **options)
         options[:preserve_traits] = true if FactoryDefault.preserve_traits
-        store[name] = { object: obj, **options }
+        store[name] = {object: obj, **options}
         obj
       end
 

data/lib/test_prof/factory_doctor/fabrication_patch.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module TestProf
+  module FactoryDoctor
+    # Wrap #run method with FactoryDoctor tracking
+    module FabricationPatch
+      def create(*)
+        FactoryDoctor.within_factory(:create) { super }
+      end
+    end
+  end
+end

data/lib/test_prof/factory_doctor/factory_bot_patch.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
+require "test_prof/ext/factory_bot_strategy"
+
 module TestProf
   module FactoryDoctor
     # Wrap #run method with FactoryDoctor tracking
     module FactoryBotPatch
+      using TestProf::FactoryBotStrategy
+
       def run(strategy = @strategy)
-        FactoryDoctor.within_factory(strategy) { super }
+        FactoryDoctor.within_factory(strategy.create? ? :create : :other) { super }
       end
     end
   end

data/lib/test_prof/factory_doctor/minitest.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'minitest/base_reporter'
-require 'test_prof/ext/float_duration'
+require "minitest/base_reporter"
+require "test_prof/ext/float_duration"
 
 module Minitest
   module TestProf # :nodoc:
@@ -47,7 +47,7 @@ module Minitest
         }
 
         @example_groups[group] << {
-          description: example.name.gsub(/^test_(?:\d+_)?/, ''),
+          description: example.name.gsub(/^test_(?:\d+_)?/, ""),
           location: location_with_line_number(example),
           factories: result.count,
           time: result.time
@@ -87,7 +87,7 @@ module Minitest
       private
 
       def pluralize_records(count)
-        count == 1 ? '1 record' : "#{count} records"
+        count == 1 ? "1 record" : "#{count} records"
       end
     end
   end

data/lib/test_prof/factory_doctor/rspec.rb

@@ -12,9 +12,7 @@ module TestProf
 
       NOTIFICATIONS = %i[
         example_started
-        example_passed
-        example_failed
-        example_pending
+        example_finished
       ].freeze
 
       def initialize
@@ -45,11 +43,6 @@ module TestProf
         @time += result.time
       end
 
-      # NOTE: RSpec < 3.4.0 doesn't have example_finished event
-      alias example_passed example_finished
-      alias example_failed example_finished
-      alias example_pending example_finished
-
       def print
         return log(:info, SUCCESS_MESSAGE) if @example_groups.empty?
 
@@ -65,9 +58,15 @@ module TestProf
           MSG
 
         @example_groups.each do |group, examples|
-          msgs << "#{group.description} (#{group.metadata[:location]})\n"
+          group_time = examples.sum { |ex| ex.metadata[:time] }
+          group_count = examples.sum { |ex| ex.metadata[:factories] }
+
+          msgs << "#{group.description} (#{group.metadata[:location]}) " \
+                  "(#{pluralize_records(group_count)} created, " \
+                  "#{group_time.duration})\n"
+
           examples.each do |ex|
-            msgs << "  #{ex.description} (#{ex.metadata[:location]}) "\
+            msgs << "  #{ex.description} (#{ex.metadata[:location]}) " \
                     "– #{pluralize_records(ex.metadata[:factories])} created, "\
                     "#{ex.metadata[:time].duration}\n"
           end
@@ -122,7 +121,7 @@ module TestProf
 end
 
 # Register FactoryDoctor listener
-TestProf.activate('FDOC') do
+TestProf.activate("FDOC") do
   TestProf::FactoryDoctor.init
 
   RSpec.configure do |config|
@@ -138,7 +137,11 @@ TestProf.activate('FDOC') do
     config.after(:suite) { listener&.print }
   end
 
-  RSpec.shared_context "factory_doctor:ignore", fd_ignore: true do
+  RSpec.shared_context "factory_doctor:ignore" do
     around(:each) { |ex| TestProf::FactoryDoctor.ignore(&ex) }
   end
+
+  RSpec.configure do |config|
+    config.include_context "factory_doctor:ignore", fd_ignore: true
+  end
 end