test-prof 0.7.4 → 0.8.0

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

@@ -6,7 +6,7 @@ module TestProf
     COLORS = {
       info: "\e[34m", # blue
       warn: "\e[33m", # yellow
-      error: "\e[31m", # red
+      error: "\e[31m" # red
     }.freeze
 
     def log(level, msg)

data/lib/test_prof/recipes/logging.rb

@@ -1,43 +1,110 @@
 # frozen_string_literal: true
 
-if defined?(RSpec)
-  RSpec.shared_context "logging:verbose", log: true do
+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" 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
@@ -30,6 +39,4 @@ module TestProf
   end
 end
 
-RSpec.configure do |config|
-  config.extend TestProf::BeforeAll::RSpec
-end
+RSpec::Core::ExampleGroup.extend TestProf::BeforeAll::RSpec

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

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

@@ -14,11 +14,6 @@ module TestProf
         end
       end
 
-      # Only works with RSpec 3.2.0
-      def supported?
-        TestProf::Utils.verify_gem_version('rspec-core', at_least: '3.2.0')
-      end
-
       private
 
       def modules
@@ -28,20 +23,15 @@ module TestProf
     # Use uniq prefix for instance variables to avoid collisions
     # We want to use the power of Ruby's unicode support)
     # And we love cats!)
-    PREFIX = RUBY_ENGINE == 'jruby' ? "@__jruby_is_not_cat_friendly__" : "@😸"
+    PREFIX = RUBY_ENGINE == "jruby" ? "@__jruby_is_not_cat_friendly__" : "@😸"
 
     def let_it_be(identifier, **options, &block)
-      unless LetItBe.supported?
-        TestProf.log :warn, "let_it_be requires RSpec >= 3.2.0. Fallback to let!"
-        return let!(identifier, &block)
-      end
-
       initializer = proc do
         instance_variable_set(:"#{PREFIX}#{identifier}", instance_exec(&block))
       end
 
       if within_before_all?
-        before(:all, &initializer)
+        within_before_all(&initializer)
       else
         before_all(&initializer)
       end
@@ -72,7 +62,7 @@ module TestProf
       LetItBe.module_for(self).module_eval do
         define_method(identifier) do
           # Trying to detect the context (couldn't find other way so far)
-          if @__inspect_output =~ /\(:context\)/
+          if /\(:context\)/.match?(@__inspect_output)
             instance_variable_get(:"#{PREFIX}#{identifier}")
           else
             # Fallback to let definition
@@ -86,6 +76,4 @@ module TestProf
   end
 end
 
-RSpec.configure do |config|
-  config.extend TestProf::LetItBe
-end
+RSpec::Core::ExampleGroup.extend TestProf::LetItBe

data/lib/test_prof/rspec_dissect/rspec.rb

@@ -10,8 +10,7 @@ module TestProf
 
       NOTIFICATIONS = %i[
         example_group_finished
-        example_passed
-        example_failed
+        example_finished
       ].freeze
 
       def initialize
@@ -35,9 +34,6 @@ module TestProf
         @examples_time += notification.example.execution_result.run_time
       end
 
-      alias example_passed example_finished
-      alias example_failed example_finished
-
       def example_group_finished(notification)
         return unless notification.group.top_level?
 
@@ -127,7 +123,7 @@ module TestProf
 end
 
 # Register RSpecDissect listener
-TestProf.activate('RD_PROF') do
+TestProf.activate("RD_PROF") do
   RSpec.configure do |config|
     listener = nil
 

data/lib/test_prof/rspec_dissect.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "test_prof"
 require "test_prof/rspec_stamp"
 require "test_prof/logging"
 
@@ -20,10 +21,10 @@ module TestProf
         Thread.current[:_rspec_dissect_let_depth] += 1
         begin
           res = if Thread.current[:_rspec_dissect_let_depth] == 1
-                  RSpecDissect.track(:let, id) { super }
-                else
-                  super
-                end
+            RSpecDissect.track(:let, id) { super }
+          else
+            super
+          end
         ensure
           Thread.current[:_rspec_dissect_let_depth] -= 1
         end
@@ -44,14 +45,14 @@ module TestProf
 
       def initialize
         @let_stats_enabled = true
-        @let_top_count = (ENV['RD_PROF_LET_TOP'] || 3).to_i
-        @top_count = (ENV['RD_PROF_TOP'] || 5).to_i
-        @stamp = ENV['RD_PROF_STAMP']
-        @mode = ENV['RD_PROF'] == '1' ? 'all' : ENV['RD_PROF']
+        @let_top_count = (ENV["RD_PROF_LET_TOP"] || 3).to_i
+        @top_count = (ENV["RD_PROF_TOP"] || 5).to_i
+        @stamp = ENV["RD_PROF_STAMP"]
+        @mode = ENV["RD_PROF"] == "1" ? "all" : ENV["RD_PROF"]
 
         unless MODES.include?(mode)
           raise "Unknown RSpecDissect mode: #{mode};" \
-                "available modes: #{MODES.join(', ')}"
+                "available modes: #{MODES.join(", ")}"
         end
 
         RSpecStamp.config.tags = @stamp if stamp?
@@ -86,10 +87,8 @@ module TestProf
       def init
         RSpec::Core::Example.prepend(ExampleInstrumentation)
 
-        if memoization_available?
-          RSpec::Core::MemoizedHelpers::ThreadsafeMemoized.prepend(MemoizedInstrumentation)
-          RSpec::Core::MemoizedHelpers::NonThreadSafeMemoized.prepend(MemoizedInstrumentation)
-        end
+        RSpec::Core::MemoizedHelpers::ThreadsafeMemoized.prepend(MemoizedInstrumentation)
+        RSpec::Core::MemoizedHelpers::NonThreadSafeMemoized.prepend(MemoizedInstrumentation)
 
         @data = {}
 
@@ -99,10 +98,6 @@ module TestProf
 
         reset!
 
-        if config.let? && !memoization_available?
-          log :warn, "RSpecDissect: `let` profiling is not supported (requires RSpec >= 3.3.0)\n"
-        end
-
         log :info, "RSpecDissect enabled"
       end
 
@@ -119,7 +114,7 @@ module TestProf
 
       def reset!
         METRICS.each do |type|
-          @data[type.to_s] = { time: 0.0, meta: [] }
+          @data[type.to_s] = {time: 0.0, meta: []}
         end
       end
 
@@ -145,8 +140,8 @@ end
 
 require "test_prof/rspec_dissect/collectors/let"
 require "test_prof/rspec_dissect/collectors/before"
-require "test_prof/rspec_dissect/rspec" if defined?(RSpec::Core)
+require "test_prof/rspec_dissect/rspec" if TestProf.rspec?
 
-TestProf.activate('RD_PROF') do
+TestProf.activate("RD_PROF") do
   TestProf::RSpecDissect.init
 end

data/lib/test_prof/rspec_stamp/parser.rb

@@ -126,7 +126,7 @@ module TestProf
         def parse_literal(expr)
           val = expr[1][1][1]
           val = val.to_sym if expr[0] == :symbol_literal ||
-                              expr[0] == :assoc_new
+            expr[0] == :assoc_new
           val
         end
 

data/lib/test_prof/rspec_stamp/rspec.rb

@@ -53,7 +53,7 @@ module TestProf
 end
 
 # Register EventProf listener
-TestProf.activate('RSTAMP') do
+TestProf.activate("RSTAMP") do
   RSpec.configure do |config|
     listener = nil
 

data/lib/test_prof/rspec_stamp.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "test_prof"
 require "test_prof/logging"
 require "test_prof/rspec_stamp/parser"
 
@@ -15,8 +16,8 @@ module TestProf
 
       def initialize
         @ignore_files = [%r{spec/support}]
-        @dry_run = ENV['RSTAMP_DRY_RUN'] == '1'
-        self.tags = ENV['RSTAMP']
+        @dry_run = ENV["RSTAMP_DRY_RUN"] == "1"
+        self.tags = ENV["RSTAMP"]
       end
 
       def dry_run?
@@ -25,10 +26,10 @@ module TestProf
 
       def tags=(val)
         @tags = if val.is_a?(String)
-                  parse_tags(val)
-                else
-                  val
-                end
+          parse_tags(val)
+        else
+          val
+        end
       end
 
       private
@@ -37,10 +38,10 @@ module TestProf
         str.split(/\s*,\s*/).each_with_object([]) do |tag, acc|
           k, v = tag.split(":")
           acc << if v.nil?
-                   k.to_sym
-                 else
-                   Hash[k.to_sym, v.to_sym]
-                 end
+            k.to_sym
+          else
+            Hash[k.to_sym, v.to_sym]
+          end
         end
       end
     end
@@ -128,7 +129,7 @@ module TestProf
         parsed = Parser.parse(code)
         return false unless parsed
 
-        desc = parsed.desc_const || quote(parsed.desc || 'works')
+        desc = parsed.desc_const || quote(parsed.desc || "works")
 
         tags.each do |t|
           if t.is_a?(Hash)
@@ -155,9 +156,9 @@ module TestProf
           end
         end
 
-        replacement = "\\1#{parsed.fname}#{need_parens ? '(' : ' '}"\
-                      "#{[desc, tags_str, htags_str].compact.join(', ')}"\
-                      "#{need_parens ? ') ' : ' '}\\3"
+        replacement = "\\1#{parsed.fname}#{need_parens ? "(" : " "}"\
+                      "#{[desc, tags_str, htags_str].compact.join(", ")}"\
+                      "#{need_parens ? ") " : " "}\\3"
 
         if config.dry_run?
           log :info, "Patched: #{example.sub(EXAMPLE_RXP, replacement)}"
@@ -181,4 +182,4 @@ module TestProf
   end
 end
 
-require "test_prof/rspec_stamp/rspec" if defined?(RSpec::Core)
+require "test_prof/rspec_stamp/rspec" if TestProf.rspec?

data/lib/test_prof/ruby_prof/rspec.rb

@@ -6,8 +6,7 @@ module TestProf
     class Listener # :nodoc:
       NOTIFICATIONS = %i[
         example_started
-        example_failed
-        example_passed
+        example_finished
       ].freeze
 
       def example_started(notification)
@@ -18,14 +17,11 @@ module TestProf
 
       def example_finished(notification)
         return unless profile?(notification.example)
-        notification.example.metadata[:rprof_report].dump(
+        notification.example.metadata[:rprof_report]&.dump(
           notification.example.full_description.parameterize
         )
       end
 
-      alias example_passed example_finished
-      alias example_failed example_finished
-
       private
 
       def profile?(example)