test-prof 1.0.0.rc1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b43e971bbd8c55a38c657e3338dc625d5860bd067e96385f310885024a1c5cc5
-  data.tar.gz: 6d4b767d0ed366be1b27521e986785b6ddfa9f2008eb9640c76baae55084bb34
+  metadata.gz: c3ea5b7078b12209f32a60554f25acffccd184bdf852ebfe14cad161ded2c180
+  data.tar.gz: 34e61ec6d58e5688b441ea09c1be524ae563f9ca82f334541c3f2c3197787cbd
 SHA512:
-  metadata.gz: 1b490801a31def008b6e8c77dff834e67c4c27a96d9d09fbe626dbed0009cb541da48acc7308905f3f8b722e8fc6f6bde39ebce5362e928abb0c2d319f259248
-  data.tar.gz: 825b2ca0cd5f0c4ea235c5df11686a39799a70685a1ae0911facceb383facec815bed04322336ec67867b51e3a0152d150ed9fe7db9f01bb1acea520fd095258
+  metadata.gz: d866bfe03650d81cb2dd5b698b5de5703a8fa505c7c8d0b0e4283b8130eb774ac43c5cca6a750fef6f8342acdec7e518613489e898fd354f133e1793df833e45
+  data.tar.gz: cf92cef8973837d2e09ff3bcc4449fb0675ebfca3f10fc75a314f10d885ad92aaae2f6fac0cd99e7250eb57985208e6d6f53b88d101f177709a172b8fcae1815

data/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 ## master (unrealeased)
 
+## 1.0.3 (2021-04-30)
+
+- Minor fixes.
+
+## 1.0.2 (2021-02-26)
+
+- Make `before_all(setup_fixtures: true)` compatible with Rails 6.1. ([@palkan][])
+
+## 1.0.1 (2021-02-12)
+
+- Fixed AnyFixture deprecation warning.
+
+## 1.0.0 (2021-01-21)
+
+## 1.0.0.rc2 (2021-01-06)
+
+- Make Rails fixtures accesible in `before_all`. ([@palkan][])
+
+You can load and access fixtures when explicitly enabling them via `before_all(setup_fixtures: true, &block)`.
+
+- Minitest's `before_all` is not longer experimental. ([@palkan][])
+
+- Add `after_all` to Minitest in addition to `before_all`. ([@palkan][])
+
 ## 1.0.0.rc1 (2020-12-30)
 
 - Remove deprecated `AggregateFailures` cop. ([@palkan][])

data/README.md

@@ -32,7 +32,7 @@ TestProf toolbox aims to help you identify bottlenecks in your test suite. It co
 📑 [Documentation](https://test-prof.evilmartians.io)
 
 <p align="center">
-  <a href="http://bit.ly/test-prof-map">
+  <a href="http://bit.ly/test-prof-map-v1">
     <img src="./docs/assets/images/coggle.png" alt="TestProf map" width="738">
   </a>
 </p>
@@ -75,7 +75,7 @@ Add `test-prof` gem to your application:
 
 ```ruby
 group :test do
-  gem "test-prof"
+  gem "test-prof", "~> 1.0"
 end
 ```
 

data/lib/test_prof.rb

@@ -161,5 +161,5 @@ require "test_prof/factory_doctor"
 require "test_prof/factory_prof"
 require "test_prof/rspec_stamp"
 require "test_prof/tag_prof"
-require "test_prof/rspec_dissect"
+require "test_prof/rspec_dissect" if TestProf.rspec?
 require "test_prof/factory_all_stub"

data/lib/test_prof/any_fixture.rb

@@ -6,7 +6,7 @@ require "test_prof/any_fixture/dump"
 module TestProf
   # Make DB fixtures from blocks.
   module AnyFixture
-    INSERT_RXP = /^INSERT INTO ([\S]+)/.freeze
+    INSERT_RXP = /^INSERT INTO (\S+)/.freeze
 
     using FloatDuration
 
@@ -16,8 +16,8 @@ module TestProf
         :import_dump_via_cli, :dump_matching_queries, :force_matching_dumps
       attr_reader :default_dump_watch_paths
 
-      alias reporting_enabled? reporting_enabled
-      alias import_dump_via_cli? import_dump_via_cli
+      alias_method :reporting_enabled?, :reporting_enabled
+      alias_method :import_dump_via_cli?, :import_dump_via_cli
 
       def initialize
         @reporting_enabled = ENV["ANYFIXTURE_REPORT"] == "1"
@@ -42,7 +42,7 @@ module TestProf
       end
 
       def before_dump(&block)
-        if block_given?
+        if block
           @before_dump << block
         else
           @before_dump
@@ -50,7 +50,7 @@ module TestProf
       end
 
       def after_dump(&block)
-        if block_given?
+        if block
           @after_dump << block
         else
           @after_dump
@@ -112,7 +112,7 @@ module TestProf
         config.reporting_enabled
       end
 
-      alias reporting_enabled? reporting_enabled
+      alias_method :reporting_enabled?, :reporting_enabled
 
       # Register a block of code as a fixture,
       # returns the result of the block execution

data/lib/test_prof/any_fixture/dump.rb

@@ -6,9 +6,9 @@ require "set"
 
 module TestProf
   module AnyFixture
-    MODIFY_RXP = /^(INSERT INTO|UPDATE|DELETE FROM) ([\S]+)/i.freeze
-    ANY_FIXTURE_RXP = /(\/\*|\-\-).*\bany_fixture:dump/.freeze
-    ANY_FIXTURE_IGNORE_RXP = /(\/\*|\-\-).*\bany_fixture:ignore/.freeze
+    MODIFY_RXP = /^(INSERT INTO|UPDATE|DELETE FROM) (\S+)/i.freeze
+    ANY_FIXTURE_RXP = /(\/\*|--).*\bany_fixture:dump/.freeze
+    ANY_FIXTURE_IGNORE_RXP = /(\/\*|--).*\bany_fixture:ignore/.freeze
 
     using(Module.new do
       refine Object do
@@ -45,7 +45,6 @@ module TestProf
           @adapter = adapter
           @tmp_path = path + ".tmp"
           @reset_pk = Set.new
-          @file = File.open(tmp_path, "w")
         end
 
         def start(_event, _id, payload)
@@ -70,6 +69,8 @@ module TestProf
         end
 
         def commit
+          return unless defined?(:@file)
+
           file.close
 
           FileUtils.mv(tmp_path, path)
@@ -77,7 +78,11 @@ module TestProf
 
         private
 
-        attr_reader :file, :reset_pk, :adapter
+        attr_reader :reset_pk, :adapter
+
+        def file
+          @file ||= File.open(tmp_path, "w")
+        end
 
         def reset_pk!(table_name)
           return if /sqlite_sequence/.match?(table_name)
@@ -106,7 +111,7 @@ module TestProf
       end
 
       attr_reader :name, :digest, :path, :subscriber, :success
-      alias success? success
+      alias_method :success?, :success
 
       def initialize(name, watch: [], cache_key: nil)
         @name = name

data/lib/test_prof/before_all.rb

@@ -32,6 +32,12 @@ module TestProf
         end
       end
 
+      def setup_fixtures(test_object)
+        raise ArgumentError, "Current adapter doesn't support #setup_fixtures" unless adapter.respond_to?(:setup_fixtures)
+
+        adapter.setup_fixtures(test_object)
+      end
+
       def config
         @config ||= Configuration.new
       end
@@ -60,8 +66,11 @@ module TestProf
     class Configuration
       HOOKS = %i[begin rollback].freeze
 
+      attr_accessor :setup_fixtures
+
       def initialize
         @hooks = Hash.new { |h, k| h[k] = HooksChain.new(k) }
+        @setup_fixtures = false
       end
 
       # Add `before` hook for `begin` or
@@ -70,7 +79,7 @@ module TestProf
       #   config.before(:rollback) { ... }
       def before(type, &block)
         validate_hook_type!(type)
-        hooks[type].before << block if block_given?
+        hooks[type].before << block if block
       end
 
       # Add `after` hook for `begin` or
@@ -79,7 +88,7 @@ module TestProf
       #   config.after(:begin) { ... }
       def after(type, &block)
         validate_hook_type!(type)
-        hooks[type].after << block if block_given?
+        hooks[type].after << block if block
       end
 
       def run_hooks(type) # :nodoc:

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

@@ -18,6 +18,21 @@ module TestProf
             end
             ::ActiveRecord::Base.connection.rollback_transaction
           end
+
+          def setup_fixtures(test_object)
+            test_object.instance_eval do
+              @@already_loaded_fixtures ||= {}
+              @fixture_cache ||= {}
+              config = ::ActiveRecord::Base
+
+              if @@already_loaded_fixtures[self.class]
+                @loaded_fixtures = @@already_loaded_fixtures[self.class]
+              else
+                @loaded_fixtures = load_fixtures(config)
+                @@already_loaded_fixtures[self.class] = @loaded_fixtures
+              end
+            end
+          end
         end
       end
     end

data/lib/test_prof/event_prof/custom_events.rb

@@ -6,7 +6,7 @@ module TestProf
     module CustomEvents
       class << self
         def register(event, &block)
-          raise ArgumentError, "Block is required!" unless block_given?
+          raise ArgumentError, "Block is required!" unless block
           registrations[event] = block
         end
 

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

@@ -26,7 +26,7 @@ module TestProf::EventProf
 
       class << self
         def subscribe(event, &block)
-          raise ArgumentError, "Block is required!" unless block_given?
+          raise ArgumentError, "Block is required!" unless block
 
           ::ActiveSupport::Notifications.subscribe(event, Subscriber.new(block))
         end

data/lib/test_prof/event_prof/profiler.rb

@@ -6,7 +6,7 @@ module TestProf
       attr_reader :event, :total_count, :total_time, :rank_by, :top_count, :per_example,
         :time, :count, :example_time, :example_count, :absolute_run_time
 
-      alias per_example? per_example
+      alias_method :per_example?, :per_example
 
       def initialize(event:, instrumenter:, rank_by: :time, top_count: 5, per_example: false)
         @event = event
@@ -88,14 +88,13 @@ module TestProf
       end
 
       def results
-        results = {
+        {
           groups: @groups.to_a
         }.tap do |data|
           next unless per_example?
 
           data[:examples] = @examples.to_a
         end
-        results
       end
 
       def take_time(start_ts)
@@ -130,7 +129,7 @@ module TestProf
       end
 
       def each(&block)
-        if block_given?
+        if block
           @profilers.each(&block)
         else
           @profilers.each

data/lib/test_prof/factory_prof.rb

@@ -10,7 +10,7 @@ module TestProf
   # flamegraphs or detect most popular factories
   module FactoryProf
     FACTORY_BUILDERS = [FactoryBuilders::FactoryBot,
-                        FactoryBuilders::Fabrication].freeze
+      FactoryBuilders::Fabrication].freeze
 
     # FactoryProf configuration
     class Configuration

data/lib/test_prof/recipes/logging.rb

@@ -12,7 +12,7 @@ module TestProf
         def logger
           return @logger if instance_variable_defined?(:@logger)
 
-          @logger = Logger.new(STDOUT)
+          @logger = Logger.new($stdout)
         end
 
         def ar_loggables

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

@@ -8,33 +8,45 @@ module TestProf
     # store instance variables
     module Minitest # :nodoc: all
       class Executor
-        attr_reader :active, :block, :captured_ivars
+        attr_reader :active, :block, :captured_ivars, :teardown_block, :current_test_object,
+          :setup_fixtures
 
-        alias active? active
+        alias_method :active?, :active
+        alias_method :setup_fixtures?, :setup_fixtures
 
-        def initialize(&block)
+        def initialize(setup_fixtures: false, &block)
+          @setup_fixtures = setup_fixtures
           @block = block
           @captured_ivars = []
         end
 
+        def teardown(&block)
+          @teardown_block = block
+        end
+
         def activate!(test_object)
+          @current_test_object = test_object
+
           return restore_ivars(test_object) if active?
           @active = true
-          @examples_left = test_object.class.runnable_methods.size
+          BeforeAll.setup_fixtures(test_object) if setup_fixtures?
           BeforeAll.begin_transaction do
             capture!(test_object)
           end
         end
 
-        def try_deactivate!
-          @examples_left -= 1
-          return unless @examples_left.zero?
-
+        def deactivate!
           @active = false
+
+          current_test_object&.instance_eval(&teardown_block) if teardown_block
+
+          @current_test_object = nil
           BeforeAll.rollback_transaction
         end
 
         def capture!(test_object)
+          return unless block
+
           before_ivars = test_object.instance_variables
 
           test_object.instance_eval(&block)
@@ -63,21 +75,29 @@ module TestProf
       module ClassMethods
         attr_accessor :before_all_executor
 
-        def before_all(&block)
-          self.before_all_executor = Executor.new(&block)
+        def before_all(setup_fixtures: BeforeAll.config.setup_fixtures, &block)
+          self.before_all_executor = Executor.new(setup_fixtures: setup_fixtures, &block)
 
           prepend(Module.new do
-            def setup
+            def before_setup
               self.class.before_all_executor.activate!(self)
               super
             end
+          end)
 
-            def teardown
+          singleton_class.prepend(Module.new do
+            def run(*)
               super
-              self.class.before_all_executor.try_deactivate!
+            ensure
+              before_all_executor&.deactivate!
             end
           end)
         end
+
+        def after_all(&block)
+          self.before_all_executor ||= Executor.new
+          before_all_executor.teardown(&block)
+        end
       end
     end
   end

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

@@ -15,7 +15,7 @@ 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.report_stats if TestProf::AnyFixture.config.reporting_enabled?
     TestProf::AnyFixture.reset
   end
 end

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

@@ -6,14 +6,22 @@ module TestProf
   module BeforeAll
     # Helper to wrap the whole example group into a transaction
     module RSpec
-      def before_all(&block)
-        raise ArgumentError, "Block is required!" unless block_given?
+      def before_all(setup_fixtures: BeforeAll.config.setup_fixtures, &block)
+        raise ArgumentError, "Block is required!" unless block
 
-        return before(:all, &block) if within_before_all?
+        if within_before_all?
+          before(:all) do
+            @__inspect_output = "before_all hook"
+            instance_eval(&block)
+          end
+          return
+        end
 
         @__before_all_activated__ = true
 
         before(:all) do
+          @__inspect_output = "before_all hook"
+          BeforeAll.setup_fixtures(self) if setup_fixtures
           BeforeAll.begin_transaction do
             instance_eval(&block)
           end

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

@@ -55,9 +55,7 @@ module TestProf
       end
 
       def module_for(group)
-        modules[group] ||= begin
-          Module.new.tap { |mod| group.prepend(mod) }
-        end
+        modules[group] ||= Module.new.tap { |mod| group.prepend(mod) }
       end
 
       private
@@ -91,8 +89,7 @@ module TestProf
       initializer = proc do
         instance_variable_set(:"#{TestProf::LetItBe::PREFIX}#{identifier}", instance_exec(&block))
       rescue FrozenError => e
-        e.message << TestProf::LetItBe::FROZEN_ERROR_HINT
-        raise
+        raise e.exception("#{e.message}#{TestProf::LetItBe::FROZEN_ERROR_HINT}")
       end
 
       default_options = LetItBe.config.default_modifiers.dup
@@ -108,8 +105,9 @@ 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 /\(:context\)/.match?(@__inspect_output)
+          # Trying to detect the context
+          # Based on https://github.com/rspec/rspec-rails/commit/7cb796db064f58da7790a92e73ab906ef50b1f34
+          if @__inspect_output.include?("before(:context)") || @__inspect_output.include?("before_all")
             instance_variable_get(:"#{PREFIX}#{identifier}")
           else
             # Fallback to let definition
@@ -242,7 +240,7 @@ end
 RSpec.configure do |config|
   config.after(:example) do |example|
     if example.exception&.is_a?(FrozenError)
-      example.exception.message << TestProf::LetItBe::FROZEN_ERROR_HINT
+      example.exception.message << TestProf::LetItBe::FROZEN_ERROR_HINT unless example.exception.message.frozen?
     end
   end
 end

data/lib/test_prof/rspec_dissect.rb

@@ -38,7 +38,7 @@ module TestProf
       attr_accessor :top_count, :let_stats_enabled,
         :let_top_count
 
-      alias let_stats_enabled? let_stats_enabled
+      alias_method :let_stats_enabled?, :let_stats_enabled
 
       attr_reader :mode
 
@@ -139,7 +139,7 @@ end
 
 require "test_prof/rspec_dissect/collectors/let"
 require "test_prof/rspec_dissect/collectors/before"
-require "test_prof/rspec_dissect/rspec" if TestProf.rspec?
+require "test_prof/rspec_dissect/rspec"
 
 TestProf.activate("RD_PROF") do
   TestProf::RSpecDissect.init

data/lib/test_prof/ruby_prof.rb

@@ -239,16 +239,18 @@ module TestProf
       end
 
       def exclude_common_methods(profiler)
-        profiler.exclude_methods!(
-          TSort,
-          :tsort_each
-        )
+        if defined?(TSort)
+          profiler.exclude_methods!(
+            TSort,
+            :tsort_each
+          )
 
-        profiler.exclude_methods!(
-          TSort.singleton_class,
-          :tsort_each, :each_strongly_connected_component,
-          :each_strongly_connected_component_from
-        )
+          profiler.exclude_methods!(
+            TSort.singleton_class,
+            :tsort_each, :each_strongly_connected_component,
+            :each_strongly_connected_component_from
+          )
+        end
 
         profiler.exclude_methods!(
           BasicObject,

data/lib/test_prof/utils/sized_ordered_set.rb

@@ -14,7 +14,7 @@ module TestProf
       def initialize(max_size, sort_by: nil, &block)
         @max_size = max_size
         @comparator =
-          if block_given?
+          if block
             block
           elsif !sort_by.nil?
             ->(x, y) { x[sort_by] >= y[sort_by] }
@@ -42,7 +42,7 @@ module TestProf
       end
 
       def each(&block)
-        if block_given?
+        if block
           data.each(&block)
         else
           data.each

data/lib/test_prof/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TestProf
-  VERSION = "1.0.0.rc1"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.3
 platform: ruby
 authors:
 - Vladimir Dementyev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-30 00:00:00.000000000 Z
+date: 2021-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -219,7 +219,7 @@ metadata:
   documentation_uri: https://test-prof.evilmartians.io/
   homepage_uri: https://test-prof.evilmartians.io/
   source_code_uri: http://github.com/test-prof/test-prof
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -230,12 +230,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Ruby applications tests profiling tools
 test_files: []