test-prof 0.7.5 → 0.8.0

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

data/lib/test_prof/rspec_dissect.rb

@@ -21,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
@@ -45,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?
@@ -87,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 = {}
 
@@ -100,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
 
@@ -120,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
 
@@ -148,6 +142,6 @@ require "test_prof/rspec_dissect/collectors/let"
 require "test_prof/rspec_dissect/collectors/before"
 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_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_stamp.rb

@@ -16,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?
@@ -26,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
@@ -38,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
@@ -129,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)
@@ -156,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)}"

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

@@ -25,24 +25,24 @@ module TestProf
     # RubyProf configuration
     class Configuration
       PRINTERS = {
-        'flat' => 'FlatPrinter',
-        'flat_wln' => 'FlatPrinterWithLineNumbers',
-        'graph' => 'GraphPrinter',
-        'graph_html' => 'GraphHtmlPrinter',
-        'dot' => 'DotPrinter',
-        '.' => 'DotPrinter',
-        'call_stack' => 'CallStackPrinter',
-        'call_tree' => 'CallTreePrinter',
-        'multi' => 'MultiPrinter'
+        "flat" => "FlatPrinter",
+        "flat_wln" => "FlatPrinterWithLineNumbers",
+        "graph" => "GraphPrinter",
+        "graph_html" => "GraphHtmlPrinter",
+        "dot" => "DotPrinter",
+        "." => "DotPrinter",
+        "call_stack" => "CallStackPrinter",
+        "call_tree" => "CallTreePrinter",
+        "multi" => "MultiPrinter"
       }.freeze
 
       # Mapping from printer to report file extension
       # NOTE: txt is not included and considered default
       PRINTER_EXTENSTION = {
-        'graph_html' => 'html',
-        'dot' => 'dot',
-        '.' => 'dot',
-        'call_stack' => 'html'
+        "graph_html" => "html",
+        "dot" => "dot",
+        "." => "dot",
+        "call_stack" => "html"
       }.freeze
 
       LOGFILE_PREFIX = "ruby-prof-report"
@@ -53,9 +53,9 @@ module TestProf
                     :custom_exclusions
 
       def initialize
-        @printer = ENV['TEST_RUBY_PROF'].to_sym if PRINTERS.key?(ENV['TEST_RUBY_PROF'])
-        @printer ||= ENV.fetch('TEST_RUBY_PROF_PRINTER', :flat).to_sym
-        @mode = ENV.fetch('TEST_RUBY_PROF_MODE', :wall).to_sym
+        @printer = ENV["TEST_RUBY_PROF"].to_sym if PRINTERS.key?(ENV["TEST_RUBY_PROF"])
+        @printer ||= ENV.fetch("TEST_RUBY_PROF_PRINTER", :flat).to_sym
+        @mode = ENV.fetch("TEST_RUBY_PROF_MODE", :wall).to_sym
         @min_percent = 1
         @include_threads = false
         @exclude_common_methods = true
@@ -77,7 +77,7 @@ module TestProf
 
       # Returns an array of printer type (ID) and class.
       def resolve_printer
-        return ['custom', printer] if printer.is_a?(Module)
+        return ["custom", printer] if printer.is_a?(Module)
 
         type = printer.to_s
 
@@ -113,7 +113,7 @@ module TestProf
           )
         else
           path = build_path name, printer_type
-          File.open(path, 'w') do |f|
+          File.open(path, "w") do |f|
             printer_class.new(result).print(f, min_percent: config.min_percent)
           end
 
@@ -127,7 +127,7 @@ module TestProf
       def build_path(name, printer)
         TestProf.artifact_path(
           "#{RubyProf::Configuration::LOGFILE_PREFIX}-#{printer}-#{config.mode}-#{name}" \
-          ".#{RubyProf::Configuration::PRINTER_EXTENSTION.fetch(printer, 'txt')}"
+          ".#{RubyProf::Configuration::PRINTER_EXTENSTION.fetch(printer, "txt")}"
         )
       end
 
@@ -158,13 +158,21 @@ module TestProf
 
         @locked = true
 
-        log :info, "RubyProf enabled"
+        log :info, "RubyProf enabled globally"
 
         at_exit { report.dump("total") }
       end
 
       def profile
-        return if locked?
+        if locked?
+          log :warn, <<~MSG
+            RubyProf is activated globally, you cannot generate per-example report.
+
+            Make sure you haven's set the TEST_RUBY_PROF environmental variable.
+          MSG
+          return
+        end
+
         return unless init_ruby_prof
 
         options = {
@@ -204,7 +212,7 @@ module TestProf
         return @initialized if instance_variable_defined?(:@initialized)
         ENV["RUBY_PROF_MEASURE_MODE"] = config.mode.to_s
         @initialized = TestProf.require(
-          'ruby-prof',
+          "ruby-prof",
           <<~MSG
             Please, install 'ruby-prof' first:
                # Gemfile
@@ -214,7 +222,7 @@ module TestProf
       end
 
       def check_ruby_prof_version
-        if Utils.verify_gem_version('ruby-prof', at_least: '0.17.0')
+        if Utils.verify_gem_version("ruby-prof", at_least: "0.17.0")
           true
         else
           log :error, <<~MGS
@@ -259,6 +267,6 @@ if TestProf.rspec?
 end
 
 # Hook to run RubyProf globally
-TestProf.activate('TEST_RUBY_PROF') do
+TestProf.activate("TEST_RUBY_PROF") do
   TestProf::RubyProf.run
 end

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)

data/lib/test_prof/stack_prof.rb

@@ -29,14 +29,14 @@ module TestProf
       attr_accessor :mode, :interval, :raw, :target, :format
 
       def initialize
-        @mode = ENV.fetch('TEST_STACK_PROF_MODE', :wall).to_sym
-        @target = ENV['TEST_STACK_PROF'] == 'boot' ? :boot : :suite
-        @raw = ENV['TEST_STACK_PROF_RAW'] != '0'
+        @mode = ENV.fetch("TEST_STACK_PROF_MODE", :wall).to_sym
+        @target = ENV["TEST_STACK_PROF"] == "boot" ? :boot : :suite
+        @raw = ENV["TEST_STACK_PROF_RAW"] != "0"
         @format =
-          if FORMATS.include?(ENV['TEST_STACK_PROF_FORMAT'])
-            ENV['TEST_STACK_PROF_FORMAT']
+          if FORMATS.include?(ENV["TEST_STACK_PROF_FORMAT"])
+            ENV["TEST_STACK_PROF_FORMAT"]
           else
-            'html'
+            "html"
           end
       end
 
@@ -71,15 +71,23 @@ module TestProf
 
         @locked = true
 
-        log :info, "StackProf enabled#{config.raw? ? ' (raw)' : ''}: " \
+        log :info, "StackProf#{config.raw? ? " (raw)" : ""} enabled globally: " \
                    "mode – #{config.mode}, target – #{config.target}"
 
         at_exit { dump("total") } if config.suite?
       end
 
       def profile(name = nil)
-        return if locked?
-        return unless init_stack_prof
+        if locked?
+          log :warn, <<~MSG
+            StackProf is activated globally, you cannot generate per-example report.
+
+            Make sure you haven's set the TEST_STACK_PROF environmental variable.
+          MSG
+          return false
+        end
+
+        return false unless init_stack_prof
 
         options = {
           mode: config.mode,
@@ -115,7 +123,7 @@ module TestProf
 
       def build_path(name)
         TestProf.artifact_path(
-          "stack-prof-report-#{config.mode}#{config.raw ? '-raw' : ''}-#{name}.dump"
+          "stack-prof-report-#{config.mode}#{config.raw ? "-raw" : ""}-#{name}.dump"
         )
       end
 
@@ -126,7 +134,7 @@ module TestProf
       def init_stack_prof
         return @initialized if instance_variable_defined?(:@initialized)
         @initialized = TestProf.require(
-          'stackprof',
+          "stackprof",
           <<~MSG
             Please, install 'stackprof' first:
                # Gemfile
@@ -136,7 +144,7 @@ module TestProf
       end
 
       def check_stack_prof_version
-        if Utils.verify_gem_version('stackprof', at_least: '0.2.9')
+        if Utils.verify_gem_version("stackprof", at_least: "0.2.9")
           true
         else
           log :error, <<~MSG
@@ -147,7 +155,7 @@ module TestProf
       end
 
       def dump_html_report(path)
-        html_path = path.gsub(/\.dump$/, '.html')
+        html_path = path.gsub(/\.dump$/, ".html")
 
         log :info, <<~MSG
           Run the following command to generate a flame graph report:
@@ -160,7 +168,7 @@ module TestProf
         report = ::StackProf::Report.new(
           Marshal.load(IO.binread(path)) # rubocop:disable Security/MarshalLoad
         )
-        json_path = path.gsub(/\.dump$/, '.json')
+        json_path = path.gsub(/\.dump$/, ".json")
         File.write(json_path, JSON.generate(report.data))
 
         log :info, <<~MSG
@@ -174,6 +182,6 @@ end
 require "test_prof/stack_prof/rspec" if TestProf.rspec?
 
 # Hook to run StackProf globally
-TestProf.activate('TEST_STACK_PROF') do
+TestProf.activate("TEST_STACK_PROF") do
   TestProf::StackProf.run
 end