test-prof 1.4.4 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cfa0f1751f398092de8ffa46d5bff81bb9eadd7b90caaf9293c62c93c6b3e20
-  data.tar.gz: 3afcb831782f0e58881839f33af07a41b3b42d63ac8eb87c35b6fd0eb01537ea
+  metadata.gz: 119118a5840991b0d1bde28e49aca9f3f72f77f89ba57704c53ce2e8a023ad06
+  data.tar.gz: 6f124770cfeba6346f744dbf66a00b118c6c207711af9f18977abea153de4f7a
 SHA512:
-  metadata.gz: 2de8fb8232f5ed623167846c37cce6224b297761324acdf6a17a47338e2a3904aa480b48fc9793a51f5595d3d839c3ff3bc9fbb262c7900ad3d7c819113947a0
-  data.tar.gz: dcec92d722f9e7cce9f1d371a2c6d363aa9a78a6cf1149a73d8b836a269ebf6bd14e50d86a8470cccc56a861b94646ad23494f43de6d9beb0cc6a5b478f77e93
+  metadata.gz: 6827f8b914ce78da9cabff0dd04ef643c3571e22864a1c6c215028fd4a2e9f79dbbab0d69e7ac9184753460aee96a2202a9201f7bdf2177074b42de47e893ac4
+  data.tar.gz: 4beacf5a982c0fe64c1c363660f2985be9dd6470ac847eb10e5ef4cd3ddf3360681e8c09fb511d5a99418629b455755e93824768c21520d0c754a908a7e7080c

data/CHANGELOG.md

@@ -2,9 +2,33 @@
 
 ## master (unreleased)
 
+## 1.5.0 (2025-12-04)
+
+- Logging: support Rails 8.2 structured events based logging. ([@palkan][])
+
+- Allow using AnyFixture DSL through module inclusion, not refinements. ([@palkan][])
+
+In Rails 7.2+, refined `#fixture` no longer works since there is a same-called method. So, from now on we recommend including the DSL module, instead of _using_ it.
+
+## 1.4.5. (2025-05-09) 🎇
+
+- FactoryProf: Add truncate_names configuration parameter. ([@skaestle][])
+
+- Update Rubocop setup to support new plugins system. ([@julianpasquale])
+
+Now you can truncate long factory-names when using the simple output mode.
+
+Set `FPROF_TRUNCATE_NAMES=1` env var or set it through `FactoryProf` configuration:
+
+```ruby
+TestProf::FactoryProf.configure do |config|
+  config.truncate_names = true
+end
+```
+
 ## 1.4.4 (2025-01-03)
 
-- Fix _stamping_ specs with single quotes with Rpsec Stamp. ([@elasticspoon][])
+- Fix _stamping_ specs with single quotes with RSpec Stamp. ([@elasticspoon][])
 
 ## 1.4.3 (2024-12-18)
 

data/lib/test_prof/any_fixture/dsl.rb

@@ -9,10 +9,7 @@ module TestProf
   module AnyFixture
     # Adds "global" `fixture`, `before_fixtures_reset` and `after_fixtures_reset` methods (through refinement)
     module DSL
-      # Refine object, 'cause refining modules (Kernel) is vulnerable to prepend:
-      # - https://bugs.ruby-lang.org/issues/13446
-      # - Rails added `Kernel.prepend` in 6.1: https://github.com/rails/rails/commit/3124007bd674dcdc9c3b5c6b2964dfb7a1a0733c
-      refine ::Object do
+      module Methods
         def fixture(id, &block)
           id = :"#{id}"
           record = ::TestProf::AnyFixture.cached(id)
@@ -38,6 +35,21 @@ module TestProf
           ::TestProf::AnyFixture.after_fixtures_reset(&block)
         end
       end
+
+      def self.included(base)
+        base.include Methods
+      end
+
+      # Refine object, 'cause refining modules (Kernel) is vulnerable to prepend:
+      # - https://bugs.ruby-lang.org/issues/13446
+      # - Rails added `Kernel.prepend` in 6.1: https://github.com/rails/rails/commit/3124007bd674dcdc9c3b5c6b2964dfb7a1a0733c
+      refine ::Object do
+        if RUBY_VERSION >= "3.1.0"
+          import_methods Methods
+        else
+          include Methods
+        end
+      end
     end
   end
 end

data/lib/test_prof/before_all/adapters/active_record.rb

@@ -24,6 +24,11 @@ module TestProf
             end
 
             def subscribe!
+              Thread.current[:before_all_subscription_count] ||= 0
+              Thread.current[:before_all_subscription_count] += 1
+
+              return unless Thread.current[:before_all_subscription_count] == 1
+
               Thread.current[:before_all_connection_subscriber] = ActiveSupport::Notifications.subscribe("!connection.active_record") do |_, _, _, _, payload|
                 connection_name = payload[:connection_name] if payload.key?(:connection_name)
                 shard = payload[:shard] if payload.key?(:shard)
@@ -37,7 +42,12 @@ module TestProf
             end
 
             def unsubscribe!
-              return unless Thread.current[:before_all_connection_subscriber]
+              return unless Thread.current[:before_all_subscription_count]
+
+              Thread.current[:before_all_subscription_count] -= 1
+
+              return unless Thread.current[:before_all_subscription_count] == 0 && Thread.current[:before_all_connection_subscriber]
+
               ActiveSupport::Notifications.unsubscribe(Thread.current[:before_all_connection_subscriber])
               Thread.current[:before_all_connection_subscriber] = nil
             end

data/lib/test_prof/cops/plugin.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "lint_roller"
+
+module RuboCop
+  module TestProf
+    # A plugin that integrates TestProf with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: "test_prof",
+          version: VERSION,
+          homepage: "https://test-prof.evilmartians.io/misc/rubocop",
+          description: "RuboCop plugin to help you write more performant tests."
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: Pathname.new(__dir__).join("../../../config/default.yml")
+        )
+      end
+    end
+  end
+end

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

@@ -29,7 +29,7 @@ TestProf::EventProf::CustomEvents.register("factory.create") do
     TestProf.log(
       :error,
       <<~MSG
-        Failed to load factory_bot / factory_girl / fabrication.
+        Failed to load factory_bot / fabrication.
 
         Make sure that any of them is in your Gemfile.
       MSG

data/lib/test_prof/event_prof/rspec.rb

@@ -7,6 +7,7 @@ module TestProf
   module EventProf
     class RSpecListener # :nodoc:
       include Logging
+
       using FloatDuration
       using StringTruncate
 

data/lib/test_prof/factory_all_stub.rb

@@ -12,7 +12,7 @@ module TestProf
 
     class << self
       def init
-        # Monkey-patch FactoryBot / FactoryGirl
+        # Monkey-patch FactoryBot
         TestProf::FactoryBot::FactoryRunner.prepend(FactoryBotPatch) if
           defined?(TestProf::FactoryBot)
       end

data/lib/test_prof/factory_bot.rb

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

data/lib/test_prof/factory_doctor/rspec.rb

@@ -6,6 +6,7 @@ module TestProf
   module FactoryDoctor
     class RSpecListener # :nodoc:
       include Logging
+
       using FloatDuration
 
       SUCCESS_MESSAGE = 'FactoryDoctor says: "Looks good to me!"'

data/lib/test_prof/factory_doctor.rb

@@ -27,6 +27,7 @@ module TestProf
       pg_attribute|
       pg_namespace|
       show\stables|
+      show\ssearch_path|
       pragma|
       sqlite_master/rollback|
       \ATRUNCATE TABLE|
@@ -70,7 +71,7 @@ module TestProf
 
         log :info, "FactoryDoctor enabled (event: \"#{config.event}\", threshold: #{config.threshold})"
 
-        # Monkey-patch FactoryBot / FactoryGirl
+        # Monkey-patch FactoryBot
         TestProf::FactoryBot::FactoryRunner.prepend(FactoryBotPatch) if
           defined?(TestProf::FactoryBot)
 

data/lib/test_prof/factory_prof/factory_builders/factory_bot.rb

@@ -12,7 +12,7 @@ module TestProf
       class FactoryBot
         using TestProf::FactoryBotStrategy
 
-        # Monkey-patch FactoryBot / FactoryGirl
+        # Monkey-patch FactoryBot
         def self.patch
           TestProf::FactoryBot::FactoryRunner.prepend(FactoryBotPatch) if
             defined? TestProf::FactoryBot

data/lib/test_prof/factory_prof/printers/simple.rb

@@ -9,7 +9,7 @@ module TestProf::FactoryProf
         using TestProf::FloatDuration
         include TestProf::Logging
 
-        def dump(result, start_time:, threshold:)
+        def dump(result, start_time:, threshold:, truncate_names:)
           return log(:info, "No factories detected") if result.raw_stats == {}
           msgs = []
 
@@ -19,6 +19,12 @@ module TestProf::FactoryProf
           total_time = result.stats.sum { |stat| stat[:top_level_time] }
           total_uniq_factories = result.stats.map { |stat| stat[:name] }.uniq.count
 
+          table_indent = 3
+          variations_indent = 2
+          max_name_length = result.stats.map { _1[:name].length }.max
+          max_variation_length = result.stats.flat_map { _1[:variations] }.select(&:present?).map { _1[:name].length }.max || 0
+          name_column_length = truncate_names ? 20 : ([max_name_length, max_variation_length].max + variations_indent)
+
           msgs <<
             <<~MSG
               Factories usage
@@ -27,14 +33,24 @@ module TestProf::FactoryProf
                Total top-level: #{total_top_level_count}
                Total time: #{total_time.duration} (out of #{total_run_time.duration})
                Total uniq factories: #{total_uniq_factories}
-
-                 name                    total   top-level     total time      time per call      top-level time
             MSG
 
+          msgs << format(
+            "%#{table_indent}s%-#{name_column_length}s %8s %12s %13s %16s %17s",
+            "", "name", "total", "top-level", "total time", "time per call", "top-level time"
+          )
+          msgs << ""
+
           result.stats.each do |stat|
             next if stat[:total_count] < threshold
 
-            msgs << format("%-3s%-20s %8d %11d %13.4fs %17.4fs %18.4fs", *format_args(stat))
+            msgs << formatted(
+              table_indent,
+              name_column_length,
+              truncate_names,
+              stat
+            )
+
             # move other variation ("[...]") to the end of the array
             sorted_variations = stat[:variations].sort_by.with_index do |variation, i|
               (variation[:name] == "[...]") ? stat[:variations].size + 1 : i
@@ -42,7 +58,12 @@ module TestProf::FactoryProf
             sorted_variations.each do |variation_stat|
               next if variation_stat[:total_count] < threshold
 
-              msgs << format("%-5s%-18s %8d %11d %13.4fs %17.4fs %18.4fs", *format_args(variation_stat))
+              msgs << formatted(
+                table_indent + variations_indent,
+                name_column_length - variations_indent,
+                truncate_names,
+                variation_stat
+              )
             end
           end
 
@@ -51,6 +72,10 @@ module TestProf::FactoryProf
 
         private
 
+        def formatted(indent_len, name_len, truncate_names, stat)
+          format(format_string(indent_len, name_len, truncate_names), *format_args(stat))
+        end
+
         def format_args(stat)
           time_per_call = stat[:total_time] / stat[:total_count]
           format_args = [""]
@@ -58,6 +83,11 @@ module TestProf::FactoryProf
           format_args << time_per_call
           format_args << stat[:top_level_time]
         end
+
+        def format_string(indent_len, name_len, truncate_names)
+          name_format = truncate_names ? "#{name_len}.#{name_len}" : name_len.to_s
+          "%#{indent_len}s%-#{name_format}s %8d %12d %12.4fs %15.4fs %16.4fs"
+        end
       end
     end
   end

data/lib/test_prof/factory_prof.rb

@@ -16,7 +16,8 @@ module TestProf
 
     # FactoryProf configuration
     class Configuration
-      attr_accessor :mode, :printer, :threshold, :include_variations, :variations_limit
+      attr_accessor :mode, :printer, :threshold, :include_variations, :variations_limit,
+        :truncate_names
 
       def initialize
         @mode = (ENV["FPROF"] == "flamegraph") ? :flamegraph : :simple
@@ -34,6 +35,7 @@ module TestProf
         @threshold = ENV.fetch("FPROF_THRESHOLD", 0).to_i
         @include_variations = ENV["FPROF_VARS"] == "1"
         @variations_limit = ENV.fetch("FPROF_VARIATIONS_LIMIT", 2).to_i
+        @truncate_names = ENV["FPROF_TRUNCATE_NAMES"] == "1"
       end
 
       # Whether we want to generate flamegraphs
@@ -120,7 +122,7 @@ module TestProf
       def print(started_at)
         printer = config.printer
 
-        printer.dump(result, start_time: started_at, threshold: config.threshold)
+        printer.dump(result, start_time: started_at, threshold: config.threshold, truncate_names: config.truncate_names)
       end
 
       def start
@@ -158,7 +160,7 @@ module TestProf
 
       def variation_name(variation)
         return "-" if variation.empty?
-        variations_count = variation.to_s.scan(/[\w]+/).size
+        variations_count = variation.to_s.scan(/\w+/).size
         return "[...]" if variations_count > config.variations_limit
 
         variation

data/lib/test_prof/memory_prof/printer.rb

@@ -7,6 +7,7 @@ module TestProf
   module MemoryProf
     class Printer
       include Logging
+
       using StringTruncate
 
       def initialize(tracker)

data/lib/test_prof/recipes/logging.rb

@@ -84,16 +84,30 @@ module TestProf
 
       # Enable verbose Rails logging within a block
       def with_logging
+        if ::ActiveSupport.respond_to?(:event_reporter)
+          @was_events_debug_mode = ActiveSupport.event_reporter.debug_mode?
+          ::ActiveSupport.event_reporter.debug_mode = true
+        end
         *loggers = LoggingHelpers.swap_logger(LoggingHelpers.all_loggables)
         yield
       ensure
+        if ::ActiveSupport.respond_to?(:event_reporter)
+          ::ActiveSupport.event_reporter.debug_mode = @was_events_debug_mode
+        end
         LoggingHelpers.restore_logger(loggers, LoggingHelpers.all_loggables)
       end
 
       def with_ar_logging
+        if ::ActiveSupport.respond_to?(:event_reporter)
+          @was_events_debug_mode = ActiveSupport.event_reporter.debug_mode?
+          ::ActiveSupport.event_reporter.debug_mode = true
+        end
         *loggers = LoggingHelpers.swap_logger(LoggingHelpers.ar_loggables)
         yield
       ensure
+        if ::ActiveSupport.respond_to?(:event_reporter)
+          ::ActiveSupport.event_reporter.debug_mode = @was_events_debug_mode
+        end
         LoggingHelpers.restore_logger(loggers, LoggingHelpers.ar_loggables)
       end
     end
@@ -124,10 +138,16 @@ end
 
 TestProf.activate("LOG", "all") do
   TestProf.log :info, "Rails verbose logging enabled"
+  if ::ActiveSupport.respond_to?(:event_reporter)
+    ::ActiveSupport.event_reporter.debug_mode = true
+  end
   TestProf::Rails::LoggingHelpers.swap_logger!(TestProf::Rails::LoggingHelpers.all_loggables)
 end
 
 TestProf.activate("LOG", "ar") do
   TestProf.log :info, "Active Record verbose logging enabled"
+  if ::ActiveSupport.respond_to?(:event_reporter)
+    ::ActiveSupport.event_reporter.debug_mode = true
+  end
   TestProf::Rails::LoggingHelpers.swap_logger!(TestProf::Rails::LoggingHelpers.ar_loggables)
 end

data/lib/test_prof/rspec_dissect/rspec.rb

@@ -6,6 +6,7 @@ module TestProf
   module RSpecDissect
     class Listener # :nodoc:
       include Logging
+
       using FloatDuration
 
       NOTIFICATIONS = %i[

data/lib/test_prof/rubocop.rb

@@ -9,5 +9,5 @@ end
 
 require "rubocop"
 
-require "test_prof/cops/inject"
+require "test_prof/cops/plugin"
 require "test_prof/cops/rspec/aggregate_examples"

data/lib/test_prof/stack_prof.rb

@@ -72,7 +72,7 @@ module TestProf
 
         @locked = true
 
-        log :info, "StackProf#{config.raw? ? " (raw)" : ""} enabled globally: " \
+        log :info, "StackProf#{" (raw)" if config.raw?} enabled globally: " \
                    "mode – #{config.mode}, target – #{config.target}"
 
         at_exit { dump("total") } if config.suite?
@@ -125,7 +125,7 @@ module TestProf
 
       def build_path(name)
         TestProf.artifact_path(
-          "stack-prof-report-#{config.mode}#{config.raw ? "-raw" : ""}-#{name}.dump"
+          "stack-prof-report-#{config.mode}#{"-raw" if config.raw}-#{name}.dump"
         )
       end
 

data/lib/test_prof/tag_prof/printers/simple.rb

@@ -7,6 +7,7 @@ module TestProf::TagProf
     module Simple # :nodoc: all
       class << self
         include TestProf::Logging
+
         using TestProf::FloatDuration
 
         def dump(result)
@@ -35,7 +36,7 @@ module TestProf::TagProf
             )
           end
 
-          header << format(
+          header << format( # rubocop:disable Style/RedundantFormat
             "%6s  %6s  %6s  %12s",
             "total", "%total", "%time", "avg"
           )

data/lib/test_prof/tps_prof/reporter/text.rb

@@ -8,6 +8,7 @@ module TestProf
     module Reporter
       class Text
         include Logging
+
         using FloatDuration
         using StringTruncate
 

data/lib/test_prof/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TestProf
-  VERSION = "1.4.4"
+  VERSION = "1.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.5.0
 platform: ruby
 authors:
 - Vladimir Dementyev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-03 00:00:00.000000000 Z
+date: 2025-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -135,7 +135,7 @@ files:
 - lib/test_prof/before_all.rb
 - lib/test_prof/before_all/adapters/active_record.rb
 - lib/test_prof/before_all/isolator.rb
-- lib/test_prof/cops/inject.rb
+- lib/test_prof/cops/plugin.rb
 - lib/test_prof/cops/rspec/aggregate_examples.rb
 - lib/test_prof/cops/rspec/aggregate_examples/its.rb
 - lib/test_prof/cops/rspec/aggregate_examples/line_range_helpers.rb
@@ -241,7 +241,8 @@ metadata:
   homepage_uri: https://test-prof.evilmartians.io/
   source_code_uri: https://github.com/test-prof/test-prof
   funding_uri: https://github.com/sponsors/test-prof
-post_install_message: 
+  default_lint_roller_plugin: RuboCop::TestProf::Plugin
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -257,7 +258,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.19
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Ruby applications tests profiling tools
 test_files: []

data/lib/test_prof/cops/inject.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-# This is shamelessly borrowed from RuboCop RSpec
-# https://github.com/rubocop-hq/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
-module TestProf
-  module Cops
-    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
-    # bit of our configuration.
-    module Inject
-      PROJECT_ROOT = Pathname.new(__dir__).parent.parent.parent.expand_path.freeze
-      CONFIG_DEFAULT = PROJECT_ROOT.join("config", "default.yml").freeze
-
-      def self.defaults!
-        path = CONFIG_DEFAULT.to_s
-        hash = RuboCop::ConfigLoader.send(:load_yaml_configuration, path)
-        config = RuboCop::Config.new(hash, path)
-        puts "configuration from #{path}" if RuboCop::ConfigLoader.debug?
-        config = RuboCop::ConfigLoader.merge_with_default(config, path)
-        RuboCop::ConfigLoader.instance_variable_set(:@default_configuration, config)
-      end
-    end
-  end
-end
-
-TestProf::Cops::Inject.defaults!