test-prof 1.0.0 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97aebfdedf7ec34fcc2062c13766c1f80a3fa461819d8182164a7c7a77d7a772
-  data.tar.gz: 82b988cae9745444567644481ebddf1876b730424b59a15581bf8ab37ba08033
+  metadata.gz: edd58f04fbf02f8bfa863b2c68e19f26fbdfb95c36bb361d012848f0a4f76790
+  data.tar.gz: 820c00eeaaea782bc89581005ac83cc147551550477519d7dd1a59a212f497c9
 SHA512:
-  metadata.gz: c0276dc796e050fa5debed6e84d7b645c29e612d53498dd7ec1aa7506a38a9dfc1ced64ea7a6576d2b5984f6ef0d39350d3d0fcd9aa02c6974631017ea297dd6
-  data.tar.gz: 9d5273502812d08edf39d9345b9854b97605499713e977bb0c39acf4879a8c7142ad7d04adab481e57c1913cf22afc39a448d170aea0cb3e4adfe0da5a66abb3
+  metadata.gz: f999f2073374210ef7c2afbedc977c21210f69e6e180fb54f6ce452741db1841b396b9358c9892e85ae972019d7204676d8a906d6a9f1f896c3669249027c935
+  data.tar.gz: 38c1f0d45d386acca3edbbd7c52b9d246f02f030cce0717f2480b2917b003c6f2b3542beb6caac45d8fe432bc69b6a7db1720768297eb4a1588f471727664409

data/CHANGELOG.md

@@ -2,6 +2,46 @@
 
 ## master (unrealeased)
 
+## 1.0.5 (2021-05-13)
+
+- Fix logging regression when no newline has been added. ([@palkan][])
+
+## 1.0.4 (2021-05-12)
+
+- Add ability to use custom logger. ([@palkan][])
+
+```ruby
+TestProf.configure do |config|
+  config.logger = Logger.new($stdout, level: Logger::WARN)
+end
+```
+
+- Add `nate_heckler` mode for FactoryProf. ([@palkan][])
+
+Drop this into your `rails_helper.rb` or `test_helper.rb`:
+
+```ruby
+require "test_prof/factory_prof/nate_heckler"
+```
+
+And for every test run see the overall factories usage:
+
+```sh
+[TEST PROF INFO] Time spent in factories: 04:31.222 (54% of total time)
+```
+
+## 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)

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>

data/lib/test_prof.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "fileutils"
+require "logger"
+
 require "test_prof/version"
 require "test_prof/logging"
 require "test_prof/utils"
@@ -130,7 +132,7 @@ module TestProf
 
   # TestProf configuration
   class Configuration
-    attr_accessor :output, # IO to write output messages.
+    attr_accessor :output, # IO to write logs
       :color, # Whether to colorize output or not
       :output_dir, # Directory to store artifacts
       :timestamps, # Whether to use timestamped names for artifacts,
@@ -145,12 +147,16 @@ module TestProf
     end
 
     def color?
-      color == true
+      color == true && output.is_a?(IO) && output.tty?
     end
 
     def timestamps?
       timestamps == true
     end
+
+    def logger
+      @logger ||= Logger.new(output, formatter: Logging::Formatter.new)
+    end
   end
 end
 
@@ -161,5 +167,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
@@ -102,7 +102,7 @@ module TestProf
         def quoted(val)
           if val.is_a?(Array)
             val.map { |v| quoted(v) }
-          elsif val.is_a?(ActiveRecord::Relation::QueryAttribute)
+          elsif val.is_a?(ActiveModel::Attribute)
             quoted(val.value_for_database)
           else
             ActiveRecord::Base.connection.quote(val)
@@ -111,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

@@ -79,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
@@ -88,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

@@ -23,6 +23,7 @@ module TestProf
             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]

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

@@ -2,6 +2,7 @@
 
 require "test_prof/factory_prof/printers/simple"
 require "test_prof/factory_prof/printers/flamegraph"
+require "test_prof/factory_prof/printers/nate_heckler"
 require "test_prof/factory_prof/factory_builders/factory_bot"
 require "test_prof/factory_prof/factory_builders/fabrication"
 
@@ -10,14 +11,23 @@ module TestProf
   # flamegraphs or detect most popular factories
   module FactoryProf
     FACTORY_BUILDERS = [FactoryBuilders::FactoryBot,
-                        FactoryBuilders::Fabrication].freeze
+      FactoryBuilders::Fabrication].freeze
 
     # FactoryProf configuration
     class Configuration
-      attr_accessor :mode
+      attr_accessor :mode, :printer
 
       def initialize
         @mode = ENV["FPROF"] == "flamegraph" ? :flamegraph : :simple
+        @printer =
+          case ENV["FPROF"]
+          when "flamegraph"
+            Printers::Flamegraph
+          when "nate_heckler"
+            Printers::NateHeckler
+          else
+            Printers::Simple
+          end
       end
 
       # Whether we want to generate flamegraphs
@@ -74,7 +84,15 @@ module TestProf
 
         log :info, "FactoryProf enabled (#{config.mode} mode)"
 
+        patch!
+      end
+
+      def patch!
+        return if @patched
+
         FACTORY_BUILDERS.each(&:patch)
+
+        @patched = true
       end
 
       # Inits FactoryProf and setups at exit hook,
@@ -82,9 +100,11 @@ module TestProf
       def run
         init
 
-        printer = config.flamegraph? ? Printers::Flamegraph : Printers::Simple
+        printer = config.printer
+
+        started_at = TestProf.now
 
-        at_exit { printer.dump(result) }
+        at_exit { printer.dump(result, start_time: started_at) }
 
         start
       end

data/lib/test_prof/factory_prof/nate_heckler.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "test_prof/factory_prof"
+
+# A standalone Factory Prof printer which is meant to be always enabled
+
+TestProf::FactoryProf.patch!
+
+started_at = TestProf.now
+at_exit do
+  TestProf::FactoryProf::Printers::NateHeckler.dump(
+    TestProf::FactoryProf.result, start_time: started_at
+  )
+end
+
+TestProf::FactoryProf.start

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

@@ -11,7 +11,7 @@ module TestProf::FactoryProf
       class << self
         include TestProf::Logging
 
-        def dump(result)
+        def dump(result, **)
           return log(:info, "No factories detected") if result.raw_stats == {}
           report_data = {
             total_stacks: result.stacks.size,

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "test_prof/ext/float_duration"
+
+module TestProf::FactoryProf
+  module Printers
+    # See https://twitter.com/nateberkopec/status/1389945187766456333
+    module NateHeckler # :nodoc: all
+      class << self
+        using TestProf::FloatDuration
+        include TestProf::Logging
+
+        def dump(result, start_time:)
+          return if result.raw_stats == {}
+
+          total_time = result.stats.sum { |stat| stat[:top_level_time] }
+          total_run_time = TestProf.now - start_time
+
+          percentage = ((total_time / total_run_time) * 100).round(2)
+
+          log :info, "Time spent in factories: #{total_time.duration} (#{percentage}% of total time)"
+        end
+      end
+    end
+  end
+end

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

@@ -1,15 +1,19 @@
 # frozen_string_literal: true
 
+require "test_prof/ext/float_duration"
+
 module TestProf::FactoryProf
   module Printers
     module Simple # :nodoc: all
       class << self
+        using TestProf::FloatDuration
         include TestProf::Logging
 
-        def dump(result)
+        def dump(result, start_time:)
           return log(:info, "No factories detected") if result.raw_stats == {}
           msgs = []
 
+          total_run_time = TestProf.now - start_time
           total_count = result.stats.sum { |stat| stat[:total_count] }
           total_top_level_count = result.stats.sum { |stat| stat[:top_level_count] }
           total_time = result.stats.sum { |stat| stat[:top_level_time] }
@@ -21,7 +25,7 @@ module TestProf::FactoryProf
 
                Total: #{total_count}
                Total top-level: #{total_top_level_count}
-               Total time: #{format("%.4f", total_time)}s
+               Total time: #{total_time.duration} (out of #{total_run_time.duration})
                Total uniq factories: #{total_uniq_factories}
 
                  total   top-level     total time      time per call      top-level time               name

data/lib/test_prof/logging.rb

@@ -4,23 +4,29 @@ module TestProf
   # Helper for output printing
   module Logging
     COLORS = {
-      info: "\e[34m", # blue
-      warn: "\e[33m", # yellow
-      error: "\e[31m" # red
+      INFO: "\e[34m", # blue
+      WARN: "\e[33m", # yellow
+      ERROR: "\e[31m" # red
     }.freeze
 
-    def log(level, msg)
-      TestProf.config.output.puts(build_log_msg(level, msg))
-    end
+    class Formatter
+      def call(severity, _time, progname, msg)
+        colorize(severity.to_sym, "[#{progname} #{severity}] #{msg}\n")
+      end
 
-    def build_log_msg(level, msg)
-      colorize(level, "[TEST PROF #{level.to_s.upcase}] #{msg}")
-    end
+      private
+
+      def colorize(level, msg)
+        return msg unless TestProf.config.color?
 
-    def colorize(level, msg)
-      return msg unless TestProf.config.color?
+        return msg unless COLORS.key?(level)
 
-      "#{COLORS[level]}#{msg}\e[0m"
+        "#{COLORS[level]}#{msg}\e[0m"
+      end
+    end
+
+    def log(level, msg)
+      TestProf.config.logger.public_send(level, "TEST PROF") { msg }
     end
   end
 end

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

@@ -11,8 +11,8 @@ module TestProf
         attr_reader :active, :block, :captured_ivars, :teardown_block, :current_test_object,
           :setup_fixtures
 
-        alias active? active
-        alias setup_fixtures? setup_fixtures
+        alias_method :active?, :active
+        alias_method :setup_fixtures?, :setup_fixtures
 
         def initialize(setup_fixtures: false, &block)
           @setup_fixtures = setup_fixtures

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

@@ -7,7 +7,7 @@ module TestProf
     # Helper to wrap the whole example group into a transaction
     module RSpec
       def before_all(setup_fixtures: BeforeAll.config.setup_fixtures, &block)
-        raise ArgumentError, "Block is required!" unless block_given?
+        raise ArgumentError, "Block is required!" unless block
 
         if within_before_all?
           before(:all) do

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
@@ -243,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/rspec_stamp.rb

@@ -39,7 +39,7 @@ module TestProf
           acc << if v.nil?
             k.to_sym
           else
-            Hash[k.to_sym, v.to_sym]
+            {k.to_sym => v.to_sym}
           end
         end
       end

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

@@ -12,7 +12,7 @@ module TestProf
 
         @data = Hash.new do |h, k|
           h[k] = {value: k, count: 0, time: 0.0}
-          h[k].merge!(Hash[events.map { |event| [event, 0.0] }]) unless
+          h[k].merge!(events.map { |event| [event, 0.0] }.to_h) unless
             events.empty?
           h[k]
         end

data/lib/test_prof/tag_prof/rspec.rb

@@ -53,11 +53,9 @@ module TestProf
       def fetch_events_data
         return {} unless @events_profiler
 
-        Hash[
-          @events_profiler.profilers.map do |profiler|
-            [profiler.event, profiler.time]
-          end
-        ]
+        @events_profiler.profilers.map do |profiler|
+          [profiler.event, profiler.time]
+        end.to_h
       end
     end
   end

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"
+  VERSION = "1.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.5
 platform: ruby
 authors:
 - Vladimir Dementyev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-21 00:00:00.000000000 Z
+date: 2021-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -174,7 +174,9 @@ files:
 - lib/test_prof/factory_prof/factory_bot_patch.rb
 - lib/test_prof/factory_prof/factory_builders/fabrication.rb
 - lib/test_prof/factory_prof/factory_builders/factory_bot.rb
+- lib/test_prof/factory_prof/nate_heckler.rb
 - lib/test_prof/factory_prof/printers/flamegraph.rb
+- lib/test_prof/factory_prof/printers/nate_heckler.rb
 - lib/test_prof/factory_prof/printers/simple.rb
 - lib/test_prof/logging.rb
 - lib/test_prof/recipes/logging.rb
@@ -214,12 +216,13 @@ homepage: http://github.com/test-prof/test-prof
 licenses:
 - MIT
 metadata:
-  bug_tracker_uri: http://github.com/test-prof/test-prof/issues
+  bug_tracker_uri: https://github.com/test-prof/test-prof/issues
   changelog_uri: https://github.com/test-prof/test-prof/blob/master/CHANGELOG.md
   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: 
+  source_code_uri: https://github.com/test-prof/test-prof
+  funding_uri: https://github.com/sponsors/test-prof
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -234,8 +237,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       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: []