test-prof 0.7.5 → 0.8.0

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/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.rb

@@ -45,7 +45,7 @@ module TestProf
       attr_reader :count, :time, :queries_count
 
       # Patch factory lib, init counters
-      def init(event = 'sql.active_record')
+      def init(event = "sql.active_record")
         @event = event
         reset!
 
@@ -57,7 +57,7 @@ module TestProf
 
         subscribe!
 
-        @stamp = ENV['FDOC_STAMP']
+        @stamp = ENV["FDOC_STAMP"]
 
         RSpecStamp.config.tags = @stamp if stamp?
       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?
 
@@ -122,7 +115,7 @@ module TestProf
 end
 
 # Register FactoryDoctor listener
-TestProf.activate('FDOC') do
+TestProf.activate("FDOC") do
   TestProf::FactoryDoctor.init
 
   RSpec.configure do |config|
@@ -138,7 +131,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

data/lib/test_prof/factory_prof.rb

@@ -17,7 +17,7 @@ module TestProf
       attr_accessor :mode
 
       def initialize
-        @mode = ENV['FPROF'] == 'flamegraph' ? :flamegraph : :simple
+        @mode = ENV["FPROF"] == "flamegraph" ? :flamegraph : :simple
       end
 
       # Whether we want to generate flamegraphs
@@ -39,7 +39,7 @@ module TestProf
         return @stats if instance_variable_defined?(:@stats)
 
         @stats = @raw_stats.values
-                           .sort_by { |el| -el[:total] }
+          .sort_by { |el| -el[:total] }
       end
 
       def total
@@ -51,8 +51,8 @@ module TestProf
 
       def sorted_stats(key)
         @raw_stats.values
-                  .map { |el| [el[:name], el[key]] }
-                  .sort_by { |el| -el[1] }
+          .map { |el| [el[:name], el[key]] }
+          .sort_by { |el| -el[1] }
       end
     end
 
@@ -120,7 +120,7 @@ module TestProf
       def reset!
         @stacks = [] if config.flamegraph?
         @depth = 0
-        @stats = Hash.new { |h, k| h[k] = { name: k, total: 0, top_level: 0 } }
+        @stats = Hash.new { |h, k| h[k] = {name: k, total: 0, top_level: 0} }
         flush_stack
       end
 
@@ -137,6 +137,6 @@ module TestProf
   end
 end
 
-TestProf.activate('FPROF') do
+TestProf.activate("FPROF") do
   TestProf::FactoryProf.run
 end

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

@@ -10,7 +10,7 @@ module TestProf
       class Fabrication
         # Monkey-patch Fabrication
         def self.patch
-          TestProf.require 'fabrication' do
+          TestProf.require "fabrication" do
             ::Fabricate.singleton_class.prepend(FabricationPatch)
           end
         end

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

@@ -45,7 +45,7 @@ module TestProf::FactoryProf
                 node = paths[path]
                 node[:value] += 1
               else
-                node = { name: sample, value: 1, total: result.raw_stats.fetch(sample)[:total] }
+                node = {name: sample, value: 1, total: result.raw_stats.fetch(sample)[:total]}
                 paths[path] = node
 
                 if parent.nil?

data/lib/test_prof/recipes/logging.rb

@@ -2,44 +2,109 @@
 
 require "test_prof"
 
+module TestProf
+  module Rails
+    # Add `with_logging` and `with_ar_logging helpers`
+    module LoggingHelpers
+      class << self
+        attr_writer :logger
+
+        def logger
+          return @logger if instance_variable_defined?(:@logger)
+
+          @logger = Logger.new(STDOUT)
+        end
+
+        def ar_loggables
+          return @ar_loggables if instance_variable_defined?(:@ar_loggables)
+
+          @ar_loggables = [
+            ::ActiveRecord::Base,
+            ::ActiveSupport::LogSubscriber
+          ]
+        end
+
+        # rubocop:disable Metrics/CyclomaticComplexity
+        # rubocop:disable Metrics/PerceivedComplexity
+        def all_loggables
+          return @all_loggables if instance_variable_defined?(:@all_loggables)
+
+          @all_loggables = [
+            ::ActiveSupport::LogSubscriber,
+            ::Rails,
+            defined?(::ActiveRecord::Base) && ::ActiveRecord::Base,
+            defined?(::ActiveJob::Base) && ::ActiveJob::Base,
+            defined?(::ActionView::Base) && ::ActionView::Base,
+            defined?(::ActionMailer::Base) && ::ActionMailer::Base,
+            defined?(::ActionCable::Server::Base.config) && ::ActionCable::Server::Base.config,
+            defined?(::ActiveStorage) && ::ActiveStorage
+          ].compact
+        end
+        # rubocop:enable Metrics/CyclomaticComplexity
+        # rubocop:enable Metrics/PerceivedComplexity
+
+        def swap_logger(loggables)
+          loggables.map do |loggable|
+            was_logger = loggable.logger
+            loggable.logger = logger
+            was_logger
+          end
+        end
+
+        def restore_logger(was_loggers, loggables)
+          loggables.each_with_index do |loggable, i|
+            loggable.logger = was_loggers[i]
+          end
+        end
+      end
+
+      # Enable verbose Rails logging within a block
+      def with_logging
+        *loggers = LoggingHelpers.swap_logger(LoggingHelpers.all_loggables)
+        yield
+      ensure
+        LoggingHelpers.restore_logger(loggers, LoggingHelpers.all_loggables)
+      end
+
+      def with_ar_logging
+        *loggers = LoggingHelpers.swap_logger(LoggingHelpers.ar_loggables)
+        yield
+      ensure
+        LoggingHelpers.restore_logger(loggers, LoggingHelpers.ar_loggables)
+      end
+    end
+  end
+end
+
 if TestProf.rspec?
-  RSpec.shared_context "logging:verbose", log: true do
+  RSpec.shared_context "logging:verbose" do
     around(:each) do |ex|
-      *loggers = ActiveSupport::LogSubscriber.logger,
-                 Rails.logger,
-                 ActiveRecord::Base.logger
-      ActiveSupport::LogSubscriber.logger =
-        Rails.logger =
-          ActiveRecord::Base.logger = Logger.new(STDOUT)
-      ex.run
-      ActiveSupport::LogSubscriber.logger,
-      Rails.logger,
-      ActiveRecord::Base.logger = *loggers
+      with_logging(&ex)
     end
   end
 
-  RSpec.shared_context "logging:active_record", log: :ar do
+  RSpec.shared_context "logging:active_record" do
     around(:each) do |ex|
-      *loggers = ActiveRecord::Base.logger,
-                 ActiveSupport::LogSubscriber.logger
-      ActiveSupport::LogSubscriber.logger =
-        ActiveRecord::Base.logger = Logger.new(STDOUT)
-      ex.run
-      ActiveSupport::LogSubscriber.logger,
-      ActiveRecord::Base.logger = *loggers
+      with_ar_logging(&ex)
     end
   end
+
+  RSpec.configure do |config|
+    config.include TestProf::Rails::LoggingHelpers
+    config.include_context "logging:active_record", log: :ar
+    config.include_context "logging:verbose", log: true
+  end
 end
 
 TestProf.activate("LOG", "all") do
   TestProf.log :info, "Rails verbose logging enabled"
   ActiveSupport::LogSubscriber.logger =
     Rails.logger =
-      ActiveRecord::Base.logger = Logger.new(STDOUT)
+      ActiveRecord::Base.logger = TestProf::Rails::LoggingHelpers.logger
 end
 
 TestProf.activate("LOG", "ar") do
   TestProf.log :info, "Active Record verbose logging enabled"
   ActiveSupport::LogSubscriber.logger =
-    ActiveRecord::Base.logger = Logger.new(STDOUT)
+    ActiveRecord::Base.logger = TestProf::Rails::LoggingHelpers.logger
 end

data/lib/test_prof/recipes/minitest/before_all.rb

@@ -20,8 +20,9 @@ module TestProf
           return if active?
           @active = true
           @examples_left = test_class.runnable_methods.size
-          BeforeAll.begin_transaction
-          capture!
+          BeforeAll.begin_transaction do
+            capture!
+          end
         end
 
         def try_deactivate!

data/lib/test_prof/recipes/minitest/sample.rb

@@ -14,7 +14,7 @@ module TestProf
       def suites
         # Make sure that sample contains only _real_ suites
         Minitest::Runnable.runnables
-                          .reject { |suite| CORE_RUNNABLES.include?(suite) }
+          .reject { |suite| CORE_RUNNABLES.include?(suite) }
       end
 
       def sample_groups(sample_size)
@@ -39,10 +39,10 @@ module TestProf
 
     # Overrides Minitest.run
     def run(*)
-      if ENV['SAMPLE']
-        MinitestSample.sample_examples(ENV['SAMPLE'].to_i)
-      elsif ENV['SAMPLE_GROUPS']
-        MinitestSample.sample_groups(ENV['SAMPLE_GROUPS'].to_i)
+      if ENV["SAMPLE"]
+        MinitestSample.sample_examples(ENV["SAMPLE"].to_i)
+      elsif ENV["SAMPLE_GROUPS"]
+        MinitestSample.sample_groups(ENV["SAMPLE_GROUPS"].to_i)
       end
       super
     end

data/lib/test_prof/recipes/rspec/any_fixture.rb

@@ -3,7 +3,7 @@
 require "test_prof/any_fixture"
 require "test_prof/recipes/rspec/before_all"
 
-RSpec.shared_context "any_fixture:clean", with_clean_fixture: true do
+RSpec.shared_context "any_fixture:clean" do
   extend TestProf::BeforeAll::RSpec
 
   before_all do
@@ -12,6 +12,8 @@ RSpec.shared_context "any_fixture:clean", with_clean_fixture: true do
 end
 
 RSpec.configure do |config|
+  config.include_context "any_fixture:clean", with_clean_fixture: true
+
   config.after(:suite) do
     TestProf::AnyFixture.report_stats if TestProf::AnyFixture.reporting_enabled?
     TestProf::AnyFixture.reset

data/lib/test_prof/recipes/rspec/before_all.rb

@@ -9,13 +9,14 @@ module TestProf
       def before_all(&block)
         raise ArgumentError, "Block is required!" unless block_given?
 
-        return before(:all, &block) if within_before_all?
+        return within_before_all(&block) if within_before_all?
 
         @__before_all_activated__ = true
 
         before(:all) do
-          BeforeAll.begin_transaction
-          instance_eval(&block)
+          BeforeAll.begin_transaction do
+            instance_eval(&block)
+          end
         end
 
         after(:all) do
@@ -23,6 +24,14 @@ module TestProf
         end
       end
 
+      def within_before_all(&block)
+        before(:all) do
+          BeforeAll.within_transaction do
+            instance_eval(&block)
+          end
+        end
+      end
+
       def within_before_all?
         instance_variable_defined?(:@__before_all_activated__)
       end

data/lib/test_prof/recipes/rspec/factory_all_stub.rb

@@ -4,7 +4,11 @@ require "test_prof/factory_all_stub"
 
 TestProf::FactoryAllStub.init
 
-RSpec.shared_context "factory:stub", factory: :stub do
+RSpec.shared_context "factory:stub" do
   prepend_before(:all) { TestProf::FactoryAllStub.enable! }
   append_after(:all) { TestProf::FactoryAllStub.disable! }
 end
+
+RSpec.configure do |config|
+  config.include_context "factory:stub", factory: :stub
+end