test-prof 0.7.4 → 0.8.0

data/lib/test_prof/ruby_prof.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "test_prof"
+
 module TestProf
   # RubyProf wrapper.
   #
@@ -23,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"
@@ -51,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
@@ -75,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
 
@@ -111,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
 
@@ -125,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
 
@@ -156,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 = {
@@ -202,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
@@ -212,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
@@ -223,7 +233,7 @@ module TestProf
       end
 
       def exclude_rspec_methods(profiler)
-        return unless defined?(RSpec::Core)
+        return unless TestProf.rspec?
 
         RSpecExclusions.generate.each do |klass, mids|
           profiler.exclude_methods!(klass, *mids)
@@ -251,12 +261,12 @@ module TestProf
   end
 end
 
-if defined?(RSpec::Core)
+if TestProf.rspec?
   require "test_prof/ruby_prof/rspec"
   require "test_prof/ruby_prof/rspec_exclusions"
 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/stack_prof/rspec.rb

@@ -6,24 +6,23 @@ module TestProf
     class Listener # :nodoc:
       NOTIFICATIONS = %i[
         example_started
-        example_failed
-        example_passed
+        example_finished
       ].freeze
 
       def example_started(notification)
-        TestProf::StackProf.profile if profile?(notification.example)
+        return unless profile?(notification.example)
+        notification.example.metadata[:sprof_report] = TestProf::StackProf.profile
       end
 
       def example_finished(notification)
         return unless profile?(notification.example)
+        return unless notification.example.metadata[:sprof_report] == false
+
         TestProf::StackProf.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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "test_prof"
+
 module TestProf
   # StackProf wrapper.
   #
@@ -27,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
 
@@ -69,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,
@@ -113,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
 
@@ -124,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
@@ -134,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
@@ -145,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:
@@ -158,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
@@ -169,9 +179,9 @@ module TestProf
   end
 end
 
-require "test_prof/stack_prof/rspec" if defined?(RSpec::Core)
+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

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

@@ -20,8 +20,8 @@ module TestProf::TagProf
           header = []
 
           header << format(
-            '%15s  %12s  ',
-            result.tag, 'time'
+            "%15s  %12s  ",
+            result.tag, "time"
           )
 
           events_format = nil
@@ -36,8 +36,8 @@ module TestProf::TagProf
           end
 
           header << format(
-            '%6s  %6s  %6s  %12s',
-            'total', '%total', '%time', 'avg'
+            "%6s  %6s  %6s  %12s",
+            "total", "%total", "%time", "avg"
           )
 
           msgs << header.join

data/lib/test_prof/tag_prof/result.rb

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

data/lib/test_prof/tag_prof/rspec.rb

@@ -7,24 +7,23 @@ module TestProf
 
       NOTIFICATIONS = %i[
         example_started
-        example_failed
-        example_passed
+        example_finished
       ].freeze
 
       attr_reader :result, :printer
 
       def initialize
-        @printer = ENV['TAG_PROF_FORMAT'] == 'html' ? Printers::HTML : Printers::Simple
+        @printer = ENV["TAG_PROF_FORMAT"] == "html" ? Printers::HTML : Printers::Simple
 
         @result =
-          if ENV['TAG_PROF_EVENT'].nil?
-            Result.new ENV['TAG_PROF'].to_sym
+          if ENV["TAG_PROF_EVENT"].nil?
+            Result.new ENV["TAG_PROF"].to_sym
           else
             require "test_prof/event_prof"
 
-            @events_profiler = EventProf.build(ENV['TAG_PROF_EVENT'])
+            @events_profiler = EventProf.build(ENV["TAG_PROF_EVENT"])
 
-            Result.new ENV['TAG_PROF'].to_sym, @events_profiler.events
+            Result.new ENV["TAG_PROF"].to_sym, @events_profiler.events
           end
 
         log :info, "TagProf enabled (#{result.tag})"
@@ -45,10 +44,6 @@ module TestProf
         @events_profiler&.group_started(nil)
       end
 
-      # NOTE: RSpec < 3.4.0 doesn't have example_finished event
-      alias example_passed example_finished
-      alias example_failed example_finished
-
       def report
         printer.dump(result)
       end
@@ -69,7 +64,7 @@ module TestProf
 end
 
 # Register TagProf listener
-TestProf.activate('TAG_PROF') do
+TestProf.activate("TAG_PROF") do
   RSpec.configure do |config|
     listener = nil
 
@@ -85,8 +80,8 @@ TestProf.activate('TAG_PROF') do
 end
 
 # Activate custom events
-TestProf.activate('TAG_PROF_EVENT') do
+TestProf.activate("TAG_PROF_EVENT") do
   require "test_prof/event_prof"
 
-  TestProf::EventProf::CustomEvents.activate_all(ENV['TAG_PROF_EVENT'])
+  TestProf::EventProf::CustomEvents.activate_all(ENV["TAG_PROF_EVENT"])
 end

data/lib/test_prof/tag_prof.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "test_prof"
+
 require "test_prof/tag_prof/result"
 require "test_prof/tag_prof/printers/simple"
 require "test_prof/tag_prof/printers/html"
@@ -9,4 +11,4 @@ module TestProf
   end
 end
 
-require "test_prof/tag_prof/rspec" if defined?(RSpec::Core)
+require "test_prof/tag_prof/rspec" if TestProf.rspec?

data/lib/test_prof/utils/html_builder.rb

@@ -9,7 +9,7 @@ module TestProf
       class << self
         def generate(data:, template:, output:)
           template = File.read(TestProf.asset_path(template))
-          template.sub! '/**REPORT-DATA**/', data.to_json
+          template.sub! "/**REPORT-DATA**/", data.to_json
 
           outpath = TestProf.artifact_path(output)
           File.write(outpath, template)

data/lib/test_prof/utils/sized_ordered_set.rb

@@ -26,7 +26,7 @@ module TestProf
 
       def <<(item)
         return if data.size == max_size &&
-                  comparator.call(data.last, item)
+          comparator.call(data.last, item)
 
         # Find an index of a smaller element
         index = data.bsearch_index { |x| !comparator.call(x, item) }

data/lib/test_prof/version.rb

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

data/lib/test_prof.rb

@@ -34,6 +34,16 @@ module TestProf
       yield config
     end
 
+    # Returns true if we're inside RSpec
+    def rspec?
+      defined?(RSpec::Core)
+    end
+
+    # Returns true if we're inside Minitest
+    def minitest?
+      defined?(Minitest)
+    end
+
     # Avoid issues with wrong time due to monkey-patches (e.g. timecop)
     # See https://github.com/rspec/rspec-core/blob/v3.6.0/lib/rspec/core.rb#L147
     #
@@ -104,13 +114,13 @@ module TestProf
     def with_timestamps(path)
       return path unless config.timestamps?
       timestamps = "-#{now.to_i}"
-      "#{path.sub(/\.\w+$/, '')}#{timestamps}#{::File.extname(path)}"
+      "#{path.sub(/\.\w+$/, "")}#{timestamps}#{::File.extname(path)}"
     end
 
     def with_report_suffix(path)
       return path if config.report_suffix.nil?
 
-      "#{path.sub(/\.\w+$/, '')}-#{config.report_suffix}#{::File.extname(path)}"
+      "#{path.sub(/\.\w+$/, "")}-#{config.report_suffix}#{::File.extname(path)}"
     end
 
     def notify_spring_detected
@@ -137,7 +147,7 @@ module TestProf
       @color = true
       @output_dir = "tmp/test_prof"
       @timestamps = false
-      @report_suffix = ENV['TEST_PROF_REPORT']
+      @report_suffix = ENV["TEST_PROF_REPORT"]
     end
 
     def color?

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.8.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-16 00:00:00.000000000 Z
+date: 2019-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: isolator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -72,28 +86,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.60.0
+        version: 0.65.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.60.0
+        version: 0.65.0
 - !ruby/object:Gem::Dependency
   name: rubocop-md
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.36
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.0.36
 description: "\n    Ruby applications tests profiling tools.\n\n    Contains tools
   to analyze factories usage, integrate with Ruby profilers,\n    profile your examples
   using ActiveSupport notifications (if any) and\n    statically analyze your code
@@ -127,6 +155,7 @@ files:
 - lib/test_prof/any_fixture/dsl.rb
 - lib/test_prof/before_all.rb
 - lib/test_prof/before_all/adapters/active_record.rb
+- lib/test_prof/before_all/isolator.rb
 - lib/test_prof/cops/rspec/aggregate_failures.rb
 - lib/test_prof/event_prof.rb
 - lib/test_prof/event_prof/custom_events.rb
@@ -206,15 +235,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Ruby applications tests profiling tools