test-prof 1.0.7 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f55e42ee372a9ebe0f8981487931bf70ab3209e38163b32f84a7553bdfb4249
-  data.tar.gz: 3ca0352ca4671c11d18937d3ee1de361322c827671d199d079b1460667c32a1c
+  metadata.gz: 9d847a0016b2749e8ba8a637d2db3d0044f7b77cfc5962596ff490aea0f5fc7d
+  data.tar.gz: 1f32af0e6e09b555bf258c5a52586a9d4a768578b0c816298343dfd5deb826da
 SHA512:
-  metadata.gz: 00dcd7797667e28b54fe32e36392e44b80a1dd6fdcc04b8a0565084311c5420bbe017eecba2ae553b84b2cdd6bc92886f15a919da8e1ba7a293aa737bc2c81da
-  data.tar.gz: eed04e297d23872fae979d7da614d4cf2730c4414b7eb26ad14095e619eeabd872619cd3e51293a4949fc04f214807cb10425da4a7ebe343df8a8f9af766f413
+  metadata.gz: 55db394aef01457404c8f5cd914cfa0eb359f3bea08874c6d4a6b75b1151af5b4153087815c90ed73ea5948c403941918b75af0b79558afe795db77c4d2b2568
+  data.tar.gz: d95cfbd7c513d086cd47b2ce0a804ec52fdf174854c0a07c239289c65d97d18833529321e0ffb4853aabc802f05a8a8eac4e3fcdc7011f0ffd1bf0c60d150b41

data/CHANGELOG.md

@@ -1,6 +1,30 @@
 # Change log
 
-## master (unrealeased)
+## master (unreleased)
+
+## 1.0.10 (2022-08-12)
+
+- Allow overriding global logger. ([@palkan][])
+
+```ruby
+require "test_prof/recipes/logging"
+
+TestProf::Rails::LoggingHelpers.logger = CustomLogger.new
+```
+
+## 1.0.9 (2022-05-05)
+
+- Add `AnyFixture.before_fixtures_reset` and `AnyFixture.after_fixtures_reset` callbacks. ([@ruslanshakirov][])
+
+- Fixes ActiveRecord 6.1 issue with AnyFixture and Postgres config ([@markedmondson][])
+
+## 1.0.8 (2022-03-11)
+
+- Restore the lock_thread value after rollback. ([@cou929][])
+
+- Fixes the configuration of a printer for factory_prof runs
+
+- Ensure that defaults are stored in a threadsafe manner
 
 ## 1.0.7 (2021-08-30)
 
@@ -267,3 +291,6 @@ See [changelog](https://github.com/test-prof/test-prof/blob/v0.8.0/CHANGELOG.md)
 [@stefkin]: https://github.com/stefkin
 [@jaimerson]: https://github.com/jaimerson
 [@alexvko]: https://github.com/alexvko
+[@grillermo]: https://github.com/grillermo
+[@cou929]: https://github.com/cou929
+[@ruslanshakirov]: https://github.com/ruslanshakirov

data/lib/test_prof/any_fixture/dsl.rb

@@ -2,7 +2,7 @@
 
 module TestProf
   module AnyFixture
-    # Adds "global" `fixture` method (through refinement)
+    # 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
@@ -11,6 +11,14 @@ module TestProf
         def fixture(id, &block)
           ::TestProf::AnyFixture.register(:"#{id}", &block)
         end
+
+        def before_fixtures_reset(&block)
+          ::TestProf::AnyFixture.before_fixtures_reset(&block)
+        end
+
+        def after_fixtures_reset(&block)
+          ::TestProf::AnyFixture.after_fixtures_reset(&block)
+        end
       end
     end
   end

data/lib/test_prof/any_fixture/dump/postgresql.rb

@@ -23,14 +23,14 @@ module TestProf
         end
 
         def compile_sql(sql, binds)
-          sql.gsub(/\$\d+/) { binds.shift }
+          sql.gsub(/\$\d+/) { binds.shift.gsub("\n", "' || chr(10) || '") }
         end
 
         def import(path)
           # Test if psql is installed
           `psql --version`
 
-          tasks = ActiveRecord::Tasks::PostgreSQLDatabaseTasks.new(conn.pool.spec.config.with_indifferent_access)
+          tasks = ActiveRecord::Tasks::PostgreSQLDatabaseTasks.new(config)
 
           while_disconnected do
             tasks.structure_load(path, "--output=/dev/null")
@@ -85,6 +85,15 @@ module TestProf
         def execute(query)
           super.values
         end
+
+        def config
+          conn_pool = conn.pool
+          if conn_pool.respond_to?(:spec) # Support for Rails < 6.1
+            conn_pool.spec.config
+          else
+            conn_pool.db_config
+          end
+        end
       end
     end
   end

data/lib/test_prof/any_fixture/dump/sqlite.rb

@@ -18,7 +18,7 @@ module TestProf
         end
 
         def compile_sql(sql, binds)
-          sql.gsub(/\?/) { binds.shift }
+          sql.gsub(/\?/) { binds.shift.gsub("\n", "' || char(10) || '") }
         end
 
         def import(path)

data/lib/test_prof/any_fixture.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "test_prof"
 require "test_prof/ext/float_duration"
 require "test_prof/any_fixture/dump"
 
@@ -118,6 +119,8 @@ module TestProf
       # returns the result of the block execution
       def register(id)
         cached(id) do
+          raise "No fixture named #{id} has been registered" unless block_given?
+
           ActiveSupport::Notifications.subscribed(method(:subscriber), "sql.active_record") do
             yield
           end
@@ -174,9 +177,22 @@ module TestProf
 
       # Reset all information and clean tables
       def reset
+        callbacks[:before_fixtures_reset].each(&:call)
+
         clean
         tables_cache.clear
         cache.clear
+
+        callbacks[:after_fixtures_reset].each(&:call)
+        callbacks.clear
+      end
+
+      def before_fixtures_reset(&block)
+        callbacks[:before_fixtures_reset] << block
+      end
+
+      def after_fixtures_reset(&block)
+        callbacks[:after_fixtures_reset] << block
       end
 
       def subscriber(_event, _start, _finish, _id, data)
@@ -253,6 +269,10 @@ module TestProf
         @tables_cache ||= {}
       end
 
+      def callbacks
+        @callbacks ||= Hash.new { |h, k| h[k] = [] }
+      end
+
       def disable_referential_integrity
         connection = ActiveRecord::Base.connection
         return yield unless connection.respond_to?(:disable_referential_integrity)

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

@@ -37,6 +37,9 @@ module TestProf
       end
     end
 
+    # avoid instance variable collisions with cats
+    PREFIX_RESTORE_LOCK_THREAD = "@😺"
+
     configure do |config|
       # Make sure ActiveRecord uses locked thread.
       # It only gets locked in `before` / `setup` hook,
@@ -44,8 +47,14 @@ module TestProf
       # might lead to leaking connections
       config.before(:begin) do
         next unless ::ActiveRecord::Base.connection.pool.respond_to?(:lock_thread=)
+        instance_variable_set("#{PREFIX_RESTORE_LOCK_THREAD}_orig_lock_thread", ::ActiveRecord::Base.connection.pool.instance_variable_get(:@lock_thread))
         ::ActiveRecord::Base.connection.pool.lock_thread = true
       end
+
+      config.after(:rollback) do
+        next unless ::ActiveRecord::Base.connection.pool.respond_to?(:lock_thread=)
+        ::ActiveRecord::Base.connection.pool.lock_thread = instance_variable_get("#{PREFIX_RESTORE_LOCK_THREAD}_orig_lock_thread")
+      end
     end
   end
 end

data/lib/test_prof/before_all.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "test_prof"
+
 module TestProf
   # `before_all` helper configuration
   module BeforeAll

data/lib/test_prof/cops/rspec/aggregate_examples/its.rb

@@ -48,14 +48,15 @@ module RuboCop
 
           def transform_its(body, arguments)
             argument = arguments.first
-            replacement = case argument.type
-                          when :array
-                            key = argument.values.first
-                            "expect(subject[#{key.source}])"
-                          else
-                            property = argument.value
-                            "expect(subject.#{property})"
-            end
+            replacement =
+              case argument.type
+              when :array
+                key = argument.values.first
+                "expect(subject[#{key.source}])"
+              else
+                property = argument.value
+                "expect(subject.#{property})"
+              end
             body.source.gsub(/is_expected|are_expected/, replacement)
           end
 

data/lib/test_prof/cops/rspec/aggregate_examples/matchers_with_side_effects.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../language"
+require "test_prof/cops/rspec/language"
 
 module RuboCop
   module Cop

data/lib/test_prof/cops/rspec/aggregate_examples/node_matchers.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../language"
+require "test_prof/cops/rspec/language"
 
 module RuboCop
   module Cop

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

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require_relative "aggregate_examples/line_range_helpers"
-require_relative "aggregate_examples/metadata_helpers"
-require_relative "aggregate_examples/node_matchers"
+require "test_prof/cops/rspec/aggregate_examples/line_range_helpers"
+require "test_prof/cops/rspec/aggregate_examples/metadata_helpers"
+require "test_prof/cops/rspec/aggregate_examples/node_matchers"
 
-require_relative "aggregate_examples/its"
-require_relative "aggregate_examples/matchers_with_side_effects"
+require "test_prof/cops/rspec/aggregate_examples/its"
+require "test_prof/cops/rspec/aggregate_examples/matchers_with_side_effects"
 
 module RuboCop
   module Cop

data/lib/test_prof/factory_all_stub.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "test_prof"
 require "test_prof/factory_bot"
 require "test_prof/factory_all_stub/factory_bot_patch"
 

data/lib/test_prof/factory_default.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "test_prof"
 require "test_prof/factory_bot"
 require "test_prof/factory_default/factory_bot_patch"
 
@@ -31,7 +32,6 @@ module TestProf
         TestProf::FactoryBot::Strategy::Build.prepend StrategyExt
         TestProf::FactoryBot::Strategy::Stub.prepend StrategyExt
 
-        @store = {}
         # default is false to retain backward compatibility
         @preserve_traits = false
       end
@@ -57,12 +57,14 @@ module TestProf
       end
 
       def reset
-        @store.clear
+        store.clear
       end
 
       private
 
-      attr_reader :store
+      def store
+        Thread.current[:testprof_factory_store] ||= {}
+      end
     end
   end
 end

data/lib/test_prof/factory_doctor/minitest.rb

@@ -74,8 +74,8 @@ module Minitest
         @example_groups.each do |group, examples|
           msgs << "#{group[:description]} (#{group[:location]})\n"
           examples.each do |ex|
-            msgs << "  #{ex[:description]} (#{ex[:location]}) "\
-                    "– #{pluralize_records(ex[:factories])} created, "\
+            msgs << "  #{ex[:description]} (#{ex[:location]}) " \
+                    "– #{pluralize_records(ex[:factories])} created, " \
                     "#{ex[:time].duration}\n"
           end
           msgs << "\n"

data/lib/test_prof/factory_doctor/rspec.rb

@@ -67,7 +67,7 @@ module TestProf
 
           examples.each do |ex|
             msgs << "  #{ex.description} (#{ex.metadata[:location]}) " \
-                    "– #{pluralize_records(ex.metadata[:factories])} created, "\
+                    "– #{pluralize_records(ex.metadata[:factories])} created, " \
                     "#{ex.metadata[:time].duration}\n"
           end
           msgs << "\n"

data/lib/test_prof/factory_prof.rb

@@ -100,15 +100,21 @@ module TestProf
       def run
         init
 
-        printer = config.printer
-
         started_at = TestProf.now
 
-        at_exit { printer.dump(result, start_time: started_at) }
+        at_exit do
+          print(started_at)
+        end
 
         start
       end
 
+      def print(started_at)
+        printer = config.printer
+
+        printer.dump(result, start_time: started_at)
+      end
+
       def start
         reset!
         @running = true

data/lib/test_prof/logging.rb

@@ -11,7 +11,7 @@ module TestProf
 
     class Formatter
       def call(severity, _time, progname, msg)
-        colorize(severity.to_sym, "[#{progname} #{severity}] #{msg}\n")
+        colorize(severity.to_sym, "[#{progname} #{severity}] #{msg}") + "\n"
       end
 
       private

data/lib/test_prof/recipes/logging.rb

@@ -7,12 +7,38 @@ module TestProf
     # Add `with_logging` and `with_ar_logging helpers`
     module LoggingHelpers
       class << self
-        attr_writer :logger
+        def logger=(logger)
+          @logger = logger
+
+          # swap global loggers
+          global_loggables.each do |loggable|
+            loggable.logger = logger
+          end
+        end
 
         def logger
           return @logger if instance_variable_defined?(:@logger)
 
-          @logger = Logger.new($stdout)
+          @logger = if defined?(ActiveSupport::TaggedLogging)
+            ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new($stdout))
+          elsif defined?(ActiveSupport::Logger)
+            ActiveSupport::Logger.new($stdout)
+          else
+            Logger.new($stdout)
+          end
+        end
+
+        def global_loggables
+          return @global_loggables if instance_variable_defined?(:@global_loggables)
+
+          @global_loggables = []
+        end
+
+        def swap_logger!(loggables)
+          loggables.each do |loggable|
+            loggable.logger = logger
+            global_loggables << loggable
+          end
         end
 
         def ar_loggables
@@ -24,8 +50,6 @@ module TestProf
           ]
         end
 
-        # rubocop:disable Metrics/CyclomaticComplexity
-        # rubocop:disable Metrics/PerceivedComplexity
         def all_loggables
           return @all_loggables if instance_variable_defined?(:@all_loggables)
 
@@ -79,7 +103,9 @@ end
 if TestProf.rspec?
   RSpec.shared_context "logging:verbose" do
     around(:each) do |ex|
-      with_logging(&ex)
+      next with_logging(&ex) if ex.metadata[:log] == true || ex.metadata[:log] == :all
+
+      ex.call
     end
   end
 
@@ -98,13 +124,10 @@ end
 
 TestProf.activate("LOG", "all") do
   TestProf.log :info, "Rails verbose logging enabled"
-  ActiveSupport::LogSubscriber.logger =
-    Rails.logger =
-      ActiveRecord::Base.logger = TestProf::Rails::LoggingHelpers.logger
+  TestProf::Rails::LoggingHelpers.swap_logger!(TestProf::Rails::LoggingHelpers.all_loggables)
 end
 
 TestProf.activate("LOG", "ar") do
   TestProf.log :info, "Active Record verbose logging enabled"
-  ActiveSupport::LogSubscriber.logger =
-    ActiveRecord::Base.logger = TestProf::Rails::LoggingHelpers.logger
+  TestProf::Rails::LoggingHelpers.swap_logger!(TestProf::Rails::LoggingHelpers.ar_loggables)
 end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "test_prof"
-require_relative "./before_all"
+require "test_prof/recipes/rspec/before_all"
 
 module TestProf
   # Just like `let`, but persist the result for the whole group.
@@ -75,7 +75,7 @@ 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 = "@😸"
 
     FROZEN_ERROR_HINT = "\nIf you are using `let_it_be`, you may want to pass `reload: true` or `refind: true` modifier to it."
 

data/lib/test_prof/rspec_dissect/collectors/before.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "./base"
+require "test_prof/rspec_dissect/collectors/base"
 
 module TestProf
   module RSpecDissect

data/lib/test_prof/rspec_dissect/collectors/let.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "./base"
+require "test_prof/rspec_dissect/collectors/base"
 
 module TestProf
   module RSpecDissect

data/lib/test_prof/rspec_stamp/parser.rb

@@ -28,8 +28,6 @@ module TestProf
       end
 
       class << self
-        # rubocop: disable Metrics/CyclomaticComplexity
-        # rubocop: disable Metrics/PerceivedComplexity
         def parse(code)
           sexp = Ripper.sexp(code)
           return unless sexp

data/lib/test_prof/rspec_stamp.rb

@@ -116,8 +116,6 @@ module TestProf
 
       private
 
-      # rubocop: disable Metrics/CyclomaticComplexity
-      # rubocop: disable Metrics/PerceivedComplexity
       def stamp_example(example, tags)
         matches = example.match(EXAMPLE_RXP)
         return false unless matches
@@ -155,8 +153,8 @@ module TestProf
           end
         end
 
-        replacement = "\\1#{parsed.fname}#{need_parens ? "(" : " "}"\
-                      "#{[desc, tags_str, htags_str].compact.join(", ")}"\
+        replacement = "\\1#{parsed.fname}#{need_parens ? "(" : " "}" \
+                      "#{[desc, tags_str, htags_str].compact.join(", ")}" \
                       "#{need_parens ? ") " : " "}\\3"
 
         if config.dry_run?

data/lib/test_prof/rubocop.rb

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

data/lib/test_prof/stack_prof.rb

@@ -162,13 +162,13 @@ module TestProf
         log :info, <<~MSG
           Run the following command to generate a flame graph report:
 
-          stackprof --flamegraph #{path} > #{html_path} && stackprof --flamegraph-viewer=#{html_path}
+          stackprof --d3-flamegraph #{path} > #{html_path} && stackprof --flamegraph-viewer=#{html_path}
         MSG
       end
 
       def dump_json_report(path)
         report = ::StackProf::Report.new(
-          Marshal.load(IO.binread(path)) # rubocop:disable Security/MarshalLoad
+          Marshal.load(IO.binread(path))
         )
         json_path = path.gsub(/\.dump$/, ".json")
         File.write(json_path, JSON.generate(report.data))

data/lib/test_prof/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.10
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2022-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -237,7 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.11
 signing_key:
 specification_version: 4
 summary: Ruby applications tests profiling tools