test-prof 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3ea5b7078b12209f32a60554f25acffccd184bdf852ebfe14cad161ded2c180
-  data.tar.gz: 34e61ec6d58e5688b441ea09c1be524ae563f9ca82f334541c3f2c3197787cbd
+  metadata.gz: c90e1ef55e15100f84c70ca251e27113353a7998735966f56401fea543a43d1f
+  data.tar.gz: c91c7e49b98bb8904dcb18805bf38d8b9c1f29ea80559c037626dd5439929c32
 SHA512:
-  metadata.gz: d866bfe03650d81cb2dd5b698b5de5703a8fa505c7c8d0b0e4283b8130eb774ac43c5cca6a750fef6f8342acdec7e518613489e898fd354f133e1793df833e45
-  data.tar.gz: cf92cef8973837d2e09ff3bcc4449fb0675ebfca3f10fc75a314f10d885ad92aaae2f6fac0cd99e7250eb57985208e6d6f53b88d101f177709a172b8fcae1815
+  metadata.gz: d983f2986f990eb2a81064604dbd5f488bd34ffb80d74f2450cdf265601583062ba6eddc0746b6e10fa168b5aafe8c987350deb427198e011d937e27f210865e
+  data.tar.gz: 6c391a64e5d34ea094d81854bd03b142ae1e6bdf8040f9e3273430a26d7f92190e4455c2acb5db8ee6741b37b5a6529c0b2bee1fb871a884b0cf6e4bb1126b9e

data/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 ## master (unrealeased)
 
+## 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.

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,8 @@ module TestProf
 
   # TestProf configuration
   class Configuration
-    attr_accessor :output, # IO to write output messages.
+    attr_accessor :output, # IO to write logs
+      :logger, # Logger instance to write to the output io
       :color, # Whether to colorize output or not
       :output_dir, # Directory to store artifacts
       :timestamps, # Whether to use timestamped names for artifacts,
@@ -138,6 +141,7 @@ module TestProf
 
     def initialize
       @output = $stdout
+      @logger = Logger.new(@output, formatter: Logging::Formatter.new)
       @color = true
       @output_dir = "tmp/test_prof"
       @timestamps = false

data/lib/test_prof/any_fixture/dump.rb

@@ -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)

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"
 
@@ -14,10 +15,19 @@ module TestProf
 
     # 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}")
+      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/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/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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-30 00:00:00.000000000 Z
+date: 2021-05-12 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,11 +216,12 @@ 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
+  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: