test-prof 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d45463f21e439e42506d700ace1dcc6202869ee8
-  data.tar.gz: 1f6cd4e4a1161cfacda3f6f95371408131e4e49f
+  metadata.gz: 6efa575090e0c535e962071ed5b24a0d5f9f360b
+  data.tar.gz: c60d25f31f5450a7b926845711527531ac595c3c
 SHA512:
-  metadata.gz: 816ca6fed6eb159671eb0563294daae38ec832e7a6530eec7c6cefe16bf66d96d7014c5d3a110a3c207f0cbaa49425cab335fc41b5d7be557e2ad07aee5753ae
-  data.tar.gz: a22cd5e4f92f5e47918132d5646a53593a756cfb27fb88f00152d8e58ca6ec8f0479893f99698cd50f9c4ee26da79ba04351498552224b745a4b0f9376a17179
+  metadata.gz: c4d148c53dd4807ede82768a7e779d56bfcfb04a8ac9ed6f8eb3aa260fbbe753e64dd79a9c021093442fcfb981d9e2a846c2450482c6ffb84c68d05ef336c620
+  data.tar.gz: 5aa0611fe30a98061f0d9a97bf7a09066614a3663e845e99cc510697f29d847c581183b75d89e9ea0cfa92ea93048249780fe77fdd6d4e87b25eacc9b29576fe

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change log
 
+## 0.4.1
+
+- [#44](https://github.com/palkan/test-prof/pull/44) Suppor older versions of RSpec. ([@palkan][])
+
+Support RSpec 3.1.0+ in general.
+
+`let_it_be` supports only RSpec 3.3.0+.
+
+RSpecDissect `let` tracking supports only RSpec 3.3.0+.
+
+- [#38](https://github.com/palkan/test-prof/pull/38) Factory Doctor Minitest integration. ([@IDolgirev][])
+
+It is possible now to use Factory Doctor with Minitest
+
 ## 0.4.0
 
 ### Features:

data/README.md

@@ -4,7 +4,7 @@
 
 TestProf is a collection of different tools to analyze your test suite performance.
 
-Why does test suite performance matter? First of all, testing is a part of a developer's feedback loop (see @searls [talk](https://www.youtube.com/watch?v=VD51AkG8EZw)) and, secondly, it is a part of a deployment cycle.
+Why does test suite performance matter? First of all, testing is a part of a developer's feedback loop (see [@searls](https://github.com/searls) [talk](https://vimeo.com/145917204)) and, secondly, it is a part of a deployment cycle.
 
 Simply speaking, slow tests waste your time making you less productive.
 
@@ -16,7 +16,7 @@ TestProf toolbox aims to help you identify bottlenecks in your test suite. It co
 
 - ActiveSupport-backed profilers
 
-- Rubocop cops
+- RuboCop cops
 
 - etc.
 
@@ -73,7 +73,7 @@ Checkout our guides for each specific tool:
 
 - [RSpecDissect Profiler](https://github.com/palkan/test-prof/tree/master/guides/rspec_dissect.md)
 
-- [Rubocop Cops](https://github.com/palkan/test-prof/tree/master/guides/rubocop.md)
+- [RuboCop cops](https://github.com/palkan/test-prof/tree/master/guides/rubocop.md)
 
 ## Tips and Tricks (or _Recipes_)
 
@@ -110,13 +110,9 @@ end
 
 ## What's next?
 
-Or TODO list:
 
-- Better Minitest integration (PRs welcome!)
+Have an idea? [Propose](https://github.com/palkan/test-prof/issues/new) a feature request!
 
-- Improve FactoryDoctor
-
-- Add more Rubocop cops (e.g. `CreateListLimit`)
 
 ## License
 

data/guides/any_fixture.md

@@ -112,4 +112,4 @@ include_context "article"
 include_context "author"
 ```
 
-Now we have the following affected tables list: `["articles", "authors"]`. At the end of the suite, the "authors" table is cleaned first which leads to a foreign-key violation error.
+Now we have the following affected tables list: `['articles', 'authors']`. At the end of the suite, the 'authors' table is cleaned first which leads to a foreign-key violation error.

data/guides/before_all.md

@@ -34,7 +34,7 @@ describe BeatleWeightedSearchQuery do
 end
 ```
 
-But then you have to deal with database cleaning, which can be eigher tricky or slow.
+But then you have to deal with database cleaning, which can be either tricky or slow.
 
 There is a better option: we can wrap the whole example group into a transaction.
 And that's how `before_all` works:
@@ -95,4 +95,4 @@ end
 # Note, that @user.reload may not be enough,
 # 'cause it doesn't reset associations
 let(:user) { User.find(@user.id) }
-```
+```

data/guides/event_prof.md

@@ -34,7 +34,7 @@ Currently, EventProf supports only ActiveSupport::Notifications
 
 To activate EventProf with:
 
-### Rspec
+### RSpec
 
 Use `EVENT_PROF` environment variable set to event name:
 
@@ -95,7 +95,7 @@ end
 
 Or provide the `EVENT_PROF_EXAMPLES=1` env variable.
 
-Another useful configuration parameter – `rank_by`. It's responsible for sorting stats – 
+Another useful configuration parameter – `rank_by`. It's responsible for sorting stats –
 either by the time spent in the event or by the number of occurrences:
 
 ```sh

data/guides/factory_default.md

@@ -1,6 +1,6 @@
 # FactoryDefault
 
-_Factory Default_ aims to help you cope with _factory cascades_ (see [FactoryProf](https://github.com/palkan/test-prof/tree/master/guides/factory_prof.md)) by re-using associated records.
+_Factory Default_ aims to help you cope with _factory cascades_ (see [FactoryProf](https://github.com/palkan/test-prof/tree/master/guides/factory_prof.md)) by reusing associated records.
 
 It can be very useful when you're working on a typical SaaS application (or other hierarchical data).
 
@@ -51,7 +51,7 @@ Typical workaround:
 describe "PATCH #update" do
   let(:account) { create(:account) }
   let(:project) { create(:project, account: account) }
-  let(:task( { create(:task, project: project, account: account) }
+  let(:task) { create(:task, project: project, account: account) }
 
   it "works" do
     patch :update, id: task.id, task: { completed: 't' }
@@ -68,9 +68,9 @@ Here is how we can deal with it using FactoryDefault:
 describe "PATCH #update" do
   let(:account) { create_default(:account) }
   let(:project) { create_default(:project) }
-  let(:task( { create(:task) }
+  let(:task) { create(:task) }
 
-  # and if need more projects, users, tasks with the same parent record,
+  # and if we need more projects, users, tasks with the same parent record,
   # we just write
   let(:another_project) { create(:project) } # uses the same account
   let(:another_task) { create(:task) } # uses the same account and the first project

data/guides/factory_doctor.md

@@ -37,12 +37,12 @@ User (./spec/models/user_spec.rb:3)
   validates email (./spec/user_spec.rb:8) – 2 records created, 00:00.514
 ```
 
-**NOTE**: have you noticed the "potentially" word? Unfortunately, FactoryDoctor is not a 
+**NOTE**: have you noticed the "potentially" word? Unfortunately, FactoryDoctor is not a
 magician (it's still learning) and sometimes it produces false negatives and false positives too.
 
 Please, submit an [issue](https://github.com/palkan/test-prof/issues) if you found a case which makes FactoryDoctor fail.
 
-You can also tell FactoryDoctor to ignore specific examples/groups. Just add `:fd_ignore` tag to it:
+You can also tell FactoryDoctor to ignore specific examples/groups. Just add the `:fd_ignore` tag to it:
 
 ```ruby
 # won't be reported as offense
@@ -55,7 +55,9 @@ end
 
 ## Instructions
 
-Currently, FactoryDoctor works only with FactoryGirl and RSpec.
+Currently, FactoryDoctor works only with FactoryGirl.
+
+## RSpec
 
 To activate FactoryDoctor use `FDOC` environment variable:
 
@@ -72,3 +74,46 @@ FDOC=1 FDOC_STAMP="fdoc:consider" rspec ...
 ```
 
 After running the command above all _potentially_ bad examples would be marked with the `fdoc: :consider` tag.
+
+## Minitest
+
+To activate FactoryDoctor use `FDOC` environment variable:
+
+```sh
+FDOC=1 ruby ...
+```
+
+or use CLI option as shown below:
+
+```sh
+ruby ... --factory-doctor
+```
+
+The same option to force Factory Doctor to ignore specific examples is also available for Minitest.
+Just use `fd_ignore` inside your example:
+
+```ruby
+# won't be reported as offense
+it "is ignored" do
+  fd_ignore
+
+  @user.name = ''
+  refute @user.valid?
+end
+```
+
+## Using with Minitest::Reporters
+
+If you're using `Minitest::Reporters` in your project you have to explicitly declare it
+in your test helper file:
+
+```sh
+require 'minitest/reporters'
+Minitest::Reporters.use! [YOUR_FAVORITE_REPORTERS]
+```
+#### NOTICE
+When you have `minitest-reporters` installed as a gem but not declared in your `Gemfile`
+make sure to always prepend your test run command with `bundle exec` (but we sure that you always do it).
+Otherwise, you'll get an error caused by Minitest plugin system, which scans all the entries in the
+`$LOAD_PATH` for any `minitest/*_plugin.rb`, thus initialization of `minitest-reporters` plugin which is
+available in that case doesn't happens correctly.

data/guides/factory_prof.md

@@ -16,7 +16,7 @@ Example output:
 
 It shows both the total number of the factory runs and the number of _top-level_ runs, i.e. not during another factory invocation (e.g. when using associations.)
 
-**NOTE**: FactoryProf only tracks the database-persisted factories. In case of FactoryFirl these are the factories
+**NOTE**: FactoryProf only tracks the database-persisted factories. In case of FactoryGirl these are the factories
 provided by using `create` strategy. In case of Fabrication - objects that created using `create` method.
 
 ## Instructions
@@ -29,20 +29,20 @@ To activate FactoryProf use `FPROF` environment variable:
 # Simple profiler
 FPROF=1 rspec
 
-# or 
+# or
 FPROF=1 bundle exec rake test
 ```
 
 ## Factory Flamegraph
 
-The most useful feature of FactoryProf is the _FactoryFlame_ report. That's the special interpetation of Brendan Gregg's [flame graphs](http://www.brendangregg.com/flamegraphs.html) which allows you to identify _factory cascades_.
+The most useful feature of FactoryProf is the _FactoryFlame_ report. That's the special interpretation of Brendan Gregg's [flame graphs](http://www.brendangregg.com/flamegraphs.html) which allows you to identify _factory cascades_.
 
 To generate FactoryFlame report set `FPROF` environment variable to `flamegraph`:
 
 ```sh
 FPROF=flamegraph rspec
 
-# or 
+# or
 FPROF=flamegraph bundle exec rake test
 ```
 
@@ -52,7 +52,7 @@ That's how a report looks like:
 
 How to read this?
 
-Every column represents a _factory stack_ or _cascade_, that is a sequence of recursive `#create` method calls. Consider and example:
+Every column represents a _factory stack_ or _cascade_, that is a sequence of recursive `#create` method calls. Consider an example:
 
 ```ruby
 factory :comment do

data/guides/let_it_be.md

@@ -11,7 +11,7 @@ describe BeatleWeightedSearchQuery do
   let!(:george) { create(:beatle, name: 'George') }
   let!(:john) { create(:beatle, name: 'John') }
 
-  specify { expect(subject.call('joh')).to contain_exactly(john) }
+  specify { expect(subject.call('john')).to contain_exactly(john) }
 
   # and more examples here
 end
@@ -45,7 +45,7 @@ describe BeatleWeightedSearchQuery do
   let_it_be(:george) { create(:beatle, name: 'George') }
   let_it_be(:john) { create(:beatle, name: 'John') }
 
-  specify { expect(subject.call('joh')).to contain_exactly(john) }
+  specify { expect(subject.call('john')).to contain_exactly(john) }
 
   # and more examples here
 end
@@ -53,6 +53,7 @@ end
 
 That's it! Just replace `let!` with `let_it_be`. That's equal to the `before_all` approach but requires less refactoring.
 
+**NOTE**: requires RSpec >= 3.2.0.
 
 ## Instructions
 

data/guides/rspec_dissect.md

@@ -1,6 +1,6 @@
 # RSpecDissect
 
-Do you know how much time you spend in `before` hooks? Or memoization helpers such as `let`? Usually, the most of the whole test suite time.
+Do you know how much time you spend in `before` hooks? Or in memoization helpers such as `let`? Usually, the most of the whole test suite time.
 
 _RSpecDissect_ provides this kind of information and also shows you the worst example groups. The main purpose of RSpecDissect is to identify these slow groups and refactor them using [`before_all`](https://github.com/palkan/test-prof/tree/master/guides/before_all.md) or [`let_it_be`](https://github.com/palkan/test-prof/tree/master/guides/let_it_be.md) recipes.
 
@@ -31,6 +31,8 @@ BookedSlotsController (./spec/controllers/booked_slots_controller_spec.rb:3) –
 AvailableSlotsController (./spec/controllers/available_slots_controller_spec.rb:3) – 00:18.481 of 00:23.366 (85)
 ```
 
+**NOTE**: Tracking `let` time only supported in RSpec >= 3.3.0.
+
 ## Instructions
 
 RSpecDissect can only be used with RSpec (which is clear from the name).

data/guides/rspec_stamp.md

@@ -1,10 +1,10 @@
-# RSpec Stamp
+# RSpecStamp
 
-RSpec Stamp is a tool to automatically _tag_ failed examples with custom tags.
+RSpecStamp is a tool to automatically _tag_ failed examples with custom tags.
 
 It _literally_ adds tags to your examples (i.e. rewrites them).
 
-The main purpose of RSpec Stamp is to make refactoring testing codebase easy. Changing global configuration may cause a lot of failures. You can patch failing spec by adding a shared context. And here comes RSpec Stamp.
+The main purpose of RSpecStamp is to make testing codebase refactoring easy. Changing global configuration may cause a lot of failures. You can patch failing spec by adding a shared context. And here comes RSpecStamp.
 
 ## Example Use Case: Sidekiq Inline
 
@@ -38,7 +38,7 @@ The output of the command above contains information about the _stamping_ proces
 
 Now all (or almost all) failing specs are tagged with `sidekiq: :inline`. Run the whole suite again and check it there are any failures left.
 
-There is also a _dry-run_ mode (activated by `RSTAMP_DRY_RUN=1` env variable) which prints out patches instead of re-writing files.
+There is also a `dry-run` mode (activated by `RSTAMP_DRY_RUN=1` env variable) which prints out patches instead of re-writing files.
 
 ## Configuration
 
@@ -50,4 +50,3 @@ TestProf::RSpecStamp.configure do |config|
   config.ignore_files << %r{spec/my_directory}
 end
 ```
-

data/guides/rubocop.md

@@ -1,10 +1,10 @@
-# Custom Rubocop Cops
+# Custom RuboCop Cops
 
-TestProf comes with the [Rubocop](https://github.com/bbatsov/rubocop) cops that help you write more performant tests.
+TestProf comes with the [RuboCop](https://github.com/bbatsov/rubocop) cops that help you write more performant tests.
 
 To enable them:
 
-- Require `test_prof/rubocop` in your Rubocop configuration:
+- Require `test_prof/rubocop` in your RuboCop configuration:
 
 ```yml
 # .rubocop.yml
@@ -21,7 +21,7 @@ RSpec/AggregateFailures:
     - 'spec/**/*.rb'
 ```
 
-## Rspec/AggregateFailures
+## RSpec/AggregateFailures
 
 This cop encourages you to use one of the greatest features of the recent RSpec – aggregating failures within an example.
 

data/guides/ruby_prof.md

@@ -13,7 +13,7 @@ group :development, :test do
 end
 ```
 
-RubyProf profiler has two modes: _global_ and _per-example_.
+RubyProf profiler has two modes: `global` and `per-example`.
 
 You can activate the global profiling using the environment variable `TEST_RUBY_PROF`:
 

data/guides/stack_prof.md

@@ -4,7 +4,7 @@
 
 ## Instructions
 
-Install 'stackprof' gem (>= 0.2.9):
+Install `stackprof` gem (>= 0.2.9):
 
 ```ruby
 # Gemfile
@@ -13,9 +13,9 @@ group :development, :test do
 end
 ```
 
-StackProf profiler has 2 modes: _global_ and _per-example_.
+StackProf profiler has 2 modes: `global` and `per-example`.
 
-You can activate the global profiling using the environment variable `TEST_STACK_PROF`:
+You can activate global profiling using the environment variable `TEST_STACK_PROF`:
 
 ```sh
 TEST_STACK_PROF=1 bundle exec rake test

data/lib/minitest/base_reporter.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'minitest'
+require 'test_prof/logging'
+
+module Minitest
+  module TestProf
+    class BaseReporter < AbstractReporter # :nodoc:
+      include ::TestProf::Logging
+
+      attr_accessor :io
+
+      def initialize(io = $stdout, _options = {})
+        @io = io
+        inject_to_minitest_reporters if defined? Minitest::Reporters
+      end
+
+      def start; end
+
+      def prerecord(group, example); end
+
+      def before_test(test); end
+
+      def record(*); end
+
+      def after_test(test); end
+
+      def report; end
+
+      private
+
+      def location(group, example = nil)
+        if group.is_a? Class
+          suite = group.public_instance_methods.select { |mtd| mtd.to_s.match /^test_/ }
+          name = suite.find { |mtd| mtd.to_s == example }
+          group.instance_method(name).source_location
+        else
+          suite = group.methods.select { |mtd| mtd.to_s.match /^test_/ }
+          name = suite.find { |mtd| mtd.to_s == group.name }
+          group.method(name).source_location
+        end
+      end
+
+      def location_with_line_number(group, example = nil)
+        File.expand_path(location(group, example).join(':')).gsub(Dir.getwd, '.')
+      end
+
+      def location_without_line_number(group, example = nil)
+        File.expand_path(location(group, example).first).gsub(Dir.getwd, '.')
+      end
+
+      def inject_to_minitest_reporters
+        Minitest::Reporters.reporters << self if Minitest::Reporters.reporters
+      end
+    end
+  end
+end

data/lib/{test_prof/event_prof/formatters/minitest.rb → minitest/event_prof_formatter.rb}

@@ -4,12 +4,12 @@ require "test_prof/ext/float_duration"
 require "test_prof/ext/string_truncate"
 require "test_prof/ext/string_strip_heredoc"
 
-module TestProf
-  module EventProf
-    class MinitestFormatter # :nodoc:
-      using FloatDuration
-      using StringTruncate
-      using StringStripHeredoc
+module Minitest
+  module TestProf
+    class EventProfFormatter # :nodoc:
+      using ::TestProf::FloatDuration
+      using ::TestProf::StringTruncate
+      using ::TestProf::StringStripHeredoc
 
       def initialize(profiler)
         @profiler = profiler

data/lib/minitest/fd_ignorable.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Minitest
+  module Assertions # :nodoc:
+    def fd_ignore
+      @fd_ignore = true
+    end
+
+    def fd_ignore?
+      @fd_ignore == true
+    end
+  end
+end

data/lib/minitest/test_prof_plugin.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'test_prof/event_prof/minitest'
+require 'test_prof/factory_doctor/minitest'
+
+module Minitest # :nodoc:
+  module TestProf # :nodoc:
+    def self.configure_options(options = {})
+      options.tap do |opts|
+        opts[:event]        = ENV['EVENT_PROF'] if ENV['EVENT_PROF']
+        opts[:rank_by]      = ENV['EVENT_PROF_RANK'].to_sym if ENV['EVENT_PROF_RANK']
+        opts[:top_count]    = ENV['EVENT_PROF_TOP'].to_i if ENV['EVENT_PROF_TOP']
+        opts[:per_example]  = true if ENV['EVENT_PROF_EXAMPLES']
+        opts[:fdoc]         = true if ENV['FDOC']
+      end
+    end
+  end
+
+  def self.plugin_test_prof_options(opts, options)
+    opts.on "--event-prof=EVENT", "Collects metrics for specified EVENT" do |event|
+      options[:event] = event
+    end
+    opts.on "--event-prof-rank-by=RANK_BY", "Defines RANK_BY parameter for results" do |rank|
+      options[:rank_by] = rank.to_sym
+    end
+    opts.on "--event-prof-top-count=N", "Limits results with N groups/examples" do |count|
+      options[:top_count] = count.to_i
+    end
+    opts.on "--event-prof-per-example", TrueClass, "Includes examples metrics to results" do |flag|
+      options[:per_example] = flag
+    end
+    opts.on "--factory-doctor", TrueClass, 'Enable Factory Doctor for your examples' do |flag|
+      options[:fdoc] = flag
+    end
+  end
+
+  def self.plugin_test_prof_init(options)
+    options = TestProf.configure_options(options)
+
+    reporter << TestProf::EventProfReporter.new(options[:io], options) if options[:event]
+    reporter << TestProf::FactoryDoctorReporter.new(options[:io], options) if options[:fdoc]
+  end
+end

data/lib/test_prof.rb

@@ -9,7 +9,7 @@ require "test_prof/utils"
 #
 # Contains tools to anylyze factories usage, integrate with Ruby profilers,
 # profile your examples using ActiveSupport notifications (if any) and
-# statically analyze your code with custom Rubocop cops.
+# statically analyze your code with custom RuboCop cops.
 #
 # Example usage:
 #
@@ -47,11 +47,11 @@ module TestProf
 
     # Require gem and shows a custom
     # message if it fails to load
-    def require(gem_name, msg)
+    def require(gem_name, msg = nil)
       Kernel.require gem_name
       block_given? ? yield : true
     rescue LoadError
-      log :error, msg
+      log(:error, msg) if msg
       false
     end
 

data/lib/test_prof/event_prof/minitest.rb

@@ -1,90 +1,72 @@
 # frozen_string_literal: true
 
-require 'test_prof/logging'
-require 'test_prof/event_prof/formatters/minitest'
+require 'minitest/base_reporter'
+require 'minitest/event_prof_formatter'
 
 module Minitest
-  class EventProfReporter < AbstractReporter # :nodoc:
-    include TestProf::Logging
-
-    attr_accessor :io
-
-    def initialize(io = $stdout, options = {})
-      @io = io
-      @profiler = configure_profiler(options)
-      @formatter = TestProf::EventProf::MinitestFormatter.new(@profiler)
-      @current_group = nil
-      @current_example = nil
-      inject_to_minitest_reporters if defined? Minitest::Reporters
-    end
-
-    def start; end
-
-    def prerecord(group, example)
-      change_current_group(group, example) unless @current_group
-      track_current_example(group, example)
-    end
-
-    def before_test(test)
-      prerecord(test.class, test.name)
-    end
-
-    def record(*)
-      @profiler.example_finished(@current_example)
-    end
+  module TestProf
+    class EventProfReporter < BaseReporter # :nodoc:
+      def initialize(io = $stdout, options = {})
+        super
+        @profiler = configure_profiler(options)
+        @formatter = EventProfFormatter.new(@profiler)
+        @current_group = nil
+        @current_example = nil
+      end
 
-    def after_test(*); end
+      def prerecord(group, example)
+        change_current_group(group, example) unless @current_group
+        track_current_example(group, example)
+      end
 
-    def report
-      @profiler.group_finished(@current_group)
-      result = @formatter.prepare_results
-      puts "\n"
-      log :info, result
-    end
+      def before_test(test)
+        prerecord(test.class, test.name)
+      end
 
-    private
+      def record(*)
+        @profiler.example_finished(@current_example)
+      end
 
-    def track_current_example(group, example)
-      unless @current_group[:name] == group.name
+      def report
         @profiler.group_finished(@current_group)
-        change_current_group(group, example)
+        result = @formatter.prepare_results
+        log :info, result
       end
 
-      @current_example = {
-        name: example.gsub(/^test_(?:\d+_)?/, ''),
-        location: File.expand_path(location(group, example).join(':')).gsub(Dir.getwd, '.')
-      }
+      private
 
-      @profiler.example_started(@current_example)
-    end
+      def track_current_example(group, example)
+        unless @current_group[:name] == group.name
+          @profiler.group_finished(@current_group)
+          change_current_group(group, example)
+        end
 
-    def change_current_group(group, example)
-      @current_group = {
-        name: group.name,
-        location: File.expand_path(location(group, example).first).gsub(Dir.getwd, '.')
-      }
+        @current_example = {
+          name: example.gsub(/^test_(?:\d+_)?/, ''),
+          location: location_with_line_number(group, example)
+        }
 
-      @profiler.group_started(@current_group)
-    end
+        @profiler.example_started(@current_example)
+      end
 
-    def location(group, example)
-      suite = group.public_instance_methods.select { |mtd| mtd.to_s.match /^test_/ }
-      name = suite.find { |mtd| mtd.to_s == example }
-      group.instance_method(name).source_location
-    end
+      def change_current_group(group, example)
+        @current_group = {
+          name: group.name,
+          location: location_without_line_number(group, example)
+        }
 
-    def configure_profiler(options)
-      TestProf::EventProf.configure do |config|
-        config.event = options[:event]
-        config.rank_by = options[:rank_by] if options[:rank_by]
-        config.top_count = options[:top_count] if options[:top_count]
-        config.per_example = options[:per_example] if options[:per_example]
+        @profiler.group_started(@current_group)
       end
-      TestProf::EventProf.build
-    end
 
-    def inject_to_minitest_reporters
-      Minitest::Reporters.reporters << self if Minitest::Reporters.reporters
+      def configure_profiler(options)
+        ::TestProf::EventProf.configure do |config|
+          config.event = options[:event]
+          config.rank_by = options[:rank_by] if options[:rank_by]
+          config.top_count = options[:top_count] if options[:top_count]
+          config.per_example = options[:per_example] if options[:per_example]
+        end
+        ::TestProf::EventProf.build
+      end
     end
   end
 end

data/lib/test_prof/event_prof/rspec.rb

@@ -16,7 +16,9 @@ module TestProf
         example_group_started
         example_group_finished
         example_started
-        example_finished
+        example_failed
+        example_passed
+        example_pending
       ].freeze
 
       def initialize
@@ -41,6 +43,11 @@ module TestProf
         @profiler.example_finished notification.example
       end
 
+      # NOTE: RSpec < 3.4.0 doesn't have example_finished event
+      alias example_passed example_finished
+      alias example_failed example_finished
+      alias example_pending example_finished
+
       def print
         result = @profiler.results
 

data/lib/test_prof/factory_doctor.rb

@@ -134,8 +134,4 @@ module TestProf
 end
 
 require "test_prof/factory_doctor/rspec" if defined?(RSpec::Core)
-require "test_prof/factory_doctor/minitest" if defined?(Minitest::Reporters)
-
-TestProf.activate('FDOC') do
-  TestProf::FactoryDoctor.init
-end
+require "test_prof/factory_doctor/minitest" if defined?(Minitest)

data/lib/test_prof/factory_doctor/minitest.rb

@@ -1,3 +1,86 @@
 # frozen_string_literal: true
 
-# TODO: write Minitest reporter
+require 'minitest/base_reporter'
+require 'minitest/fd_ignorable'
+require 'test_prof/factory_doctor'
+require 'test_prof/ext/float_duration'
+require 'test_prof/ext/string_strip_heredoc'
+
+module Minitest
+  module TestProf
+    class FactoryDoctorReporter < BaseReporter # :nodoc:
+      using ::TestProf::FloatDuration
+      using ::TestProf::StringStripHeredoc
+
+      SUCCESS_MESSAGE = 'FactoryDoctor says: "Looks good to me!"'.freeze
+
+      def initialize(io = $stdout, options = {})
+        super
+        ::TestProf::FactoryDoctor.init
+        @count = 0
+        @time = 0.0
+        @example_groups = Hash.new { |h, k| h[k] = [] }
+      end
+
+      def prerecord(_group, _example)
+        ::TestProf::FactoryDoctor.start
+      end
+
+      def record(example)
+        ::TestProf::FactoryDoctor.stop
+        return if example.skipped? || example.fd_ignore?
+
+        result = ::TestProf::FactoryDoctor.result
+        return unless result.bad?
+
+        group = {
+          description: example.class.name,
+          location: location_without_line_number(example)
+        }
+
+        @example_groups[group] << {
+          description: example.name.gsub(/^test_(?:\d+_)?/, ''),
+          location: location_with_line_number(example),
+          factories: result.count,
+          time: result.time
+        }
+
+        @count += 1
+        @time += result.time
+      end
+
+      def report
+        return log(:info, SUCCESS_MESSAGE) if @example_groups.empty?
+
+        msgs = []
+
+        msgs <<
+          <<-MSG.strip_heredoc
+            FactoryDoctor report
+
+            Total (potentially) bad examples: #{@count}
+            Total wasted time: #{@time.duration}
+
+          MSG
+
+        @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, "\
+                    "#{ex[:time].duration}\n"
+          end
+          msgs << "\n"
+        end
+
+        log :info, msgs.join
+      end
+
+      private
+
+      def pluralize_records(count)
+        count == 1 ? '1 record' : "#{count} records"
+      end
+    end
+  end
+end

data/lib/test_prof/factory_doctor/rspec.rb

@@ -14,7 +14,9 @@ module TestProf
 
       NOTIFICATIONS = %i[
         example_started
-        example_finished
+        example_passed
+        example_failed
+        example_pending
       ].freeze
 
       def initialize
@@ -45,6 +47,11 @@ module TestProf
         @time += result.time
       end
 
+      # NOTE: RSpec < 3.4.0 doesn't have example_finished event
+      alias example_passed example_finished
+      alias example_failed example_finished
+      alias example_pending example_finished
+
       def print
         return log(:info, SUCCESS_MESSAGE) if @example_groups.empty?
 
@@ -118,6 +125,8 @@ end
 
 # Register FactoryDoctor listener
 TestProf.activate('FDOC') do
+  TestProf::FactoryDoctor.init
+
   RSpec.configure do |config|
     listener = TestProf::FactoryDoctor::RSpecListener.new
 

data/lib/test_prof/factory_prof/factory_builders/fabrication.rb

@@ -10,9 +10,9 @@ module TestProf
       class Fabrication
         # Monkey-patch Fabrication
         def self.patch
-          TestProf.require 'fabrication', ""
-          ::Fabricate.singleton_class.prepend(FabricationPatch) if
-            defined?(::Fabrication)
+          TestProf.require 'fabrication' do
+            ::Fabricate.singleton_class.prepend(FabricationPatch)
+          end
         end
 
         def self.track(factory, &block)

data/lib/test_prof/factory_prof/factory_builders/factory_girl.rb

@@ -10,8 +10,9 @@ module TestProf
       class FactoryGirl
         # Monkey-patch FactoryGirl
         def self.patch
-          ::FactoryGirl::FactoryRunner.prepend(FactoryGirlPatch) if
-            defined?(::FactoryGirl)
+          TestProf.require 'factory_girl' do
+            ::FactoryGirl::FactoryRunner.prepend(FactoryGirlPatch)
+          end
         end
 
         def self.track(strategy, factory, &block)

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

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

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

@@ -10,6 +10,7 @@ module TestProf::FactoryProf
         using TestProf::StringStripHeredoc
 
         def dump(result)
+          return log(:info, "No factories detected") if result.raw_stats == {}
           msgs = []
 
           msgs <<

data/lib/test_prof/logging.rb

@@ -5,6 +5,7 @@ module TestProf
   module Logging
     COLORS = {
       info: "\e[34m", # blue
+      warn: "\e[33m", # yellow
       error: "\e[31m", # red
     }.freeze
 

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "test_prof"
 require_relative "./before_all"
 
 module TestProf
@@ -13,6 +14,11 @@ module TestProf
         end
       end
 
+      # Only works with RSpec 3.2.0
+      def supported?
+        TestProf::Utils.verify_gem_version('rspec', at_least: '3.2.0')
+      end
+
       private
 
       def modules
@@ -25,6 +31,11 @@ module TestProf
     PREFIX = RUBY_ENGINE == 'jruby' ? "@__jruby_is_not_cat_friendly__".freeze : "@😸".freeze
 
     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

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

@@ -2,7 +2,7 @@
 
 module TestProf
   # Add ability to run only a specified number of example groups (randomly selected)
-  module RspecSample
+  module RSpecSample
     def ordered_example_groups
       @example_groups = @example_groups.sample(ENV['SAMPLE'].to_i) unless ENV['SAMPLE'].nil?
       super
@@ -10,4 +10,4 @@ module TestProf
   end
 end
 
-RSpec::Core::World.prepend(TestProf::RspecSample)
+RSpec::Core::World.prepend(TestProf::RSpecSample)

data/lib/test_prof/rspec_dissect.rb

@@ -62,8 +62,11 @@ module TestProf
 
       def init
         RSpec::Core::Example.prepend(ExampleInstrumentation)
-        RSpec::Core::MemoizedHelpers::ThreadsafeMemoized.prepend(MemoizedInstrumentation)
-        RSpec::Core::MemoizedHelpers::NonThreadSafeMemoized.prepend(MemoizedInstrumentation)
+
+        if memoization_available?
+          RSpec::Core::MemoizedHelpers::ThreadsafeMemoized.prepend(MemoizedInstrumentation)
+          RSpec::Core::MemoizedHelpers::NonThreadSafeMemoized.prepend(MemoizedInstrumentation)
+        end
 
         @data = {}
 
@@ -92,6 +95,11 @@ module TestProf
         end
       end
 
+      # Whether we are able to track `let` usage
+      def memoization_available?
+        defined?(::RSpec::Core::MemoizedHelpers::ThreadsafeMemoized)
+      end
+
       METRICS.each do |type|
         define_method("#{type}_time") do
           @data[type.to_s]

data/lib/test_prof/rspec_dissect/rspec.rb

@@ -7,6 +7,7 @@ require "test_prof/ext/string_strip_heredoc"
 
 module TestProf
   module RSpecDissect
+    # rubocop:disable Metrics/ClassLength
     class Listener # :nodoc:
       include Logging
       using FloatDuration
@@ -16,6 +17,9 @@ module TestProf
       NOTIFICATIONS = %i[
         example_finished
         example_group_finished
+        example_passed
+        example_failed
+        example_pending
       ].freeze
 
       def initialize
@@ -35,6 +39,11 @@ module TestProf
         @examples_time += notification.example.execution_result.run_time
       end
 
+      # NOTE: RSpec < 3.4.0 doesn't have example_finished event
+      alias example_passed example_finished
+      alias example_failed example_finished
+      alias example_pending example_finished
+
       def example_group_finished(notification)
         return unless notification.group.top_level?
 
@@ -65,10 +74,15 @@ module TestProf
 
             Total time: #{@total_examples_time.duration}
             Total `before(:each)` time: #{RSpecDissect.total_before_time.duration}
-            Total `let` time: #{RSpecDissect.total_memo_time.duration}
-
           MSG
 
+        msgs <<
+          if RSpecDissect.memoization_available?
+            "Total `let` time: #{RSpecDissect.total_memo_time.duration}\n\n"
+          else
+            "Total `let` time: NOT SUPPORTED (requires RSpec >= 3.3.0)\n\n"
+          end
+
         msgs <<
           <<-MSG.strip_heredoc
             Top #{top_count} slowest suites (by `before(:each)` time):
@@ -82,18 +96,20 @@ module TestProf
             GROUP
         end
 
-        msgs <<
-          <<-MSG.strip_heredoc
+        if RSpecDissect.memoization_available?
+          msgs <<
+            <<-MSG.strip_heredoc
 
-            Top #{top_count} slowest suites (by `let` time):
+              Top #{top_count} slowest suites (by `let` time):
 
-          MSG
+            MSG
 
-        @memo_results.each do |group|
-          msgs <<
-            <<-GROUP.strip_heredoc
-              #{group[:desc].truncate} (#{group[:loc]}) – #{group[:memo].duration} of #{group[:total].duration} (#{group[:count]})
-            GROUP
+          @memo_results.each do |group|
+            msgs <<
+              <<-GROUP.strip_heredoc
+                #{group[:desc].truncate} (#{group[:loc]}) – #{group[:memo].duration} of #{group[:total].duration} (#{group[:count]})
+              GROUP
+          end
         end
 
         log :info, msgs.join

data/lib/test_prof/tag_prof/rspec.rb

@@ -12,7 +12,8 @@ module TestProf
 
       NOTIFICATIONS = %i[
         example_started
-        example_finished
+        example_failed
+        example_passed
       ].freeze
 
       def initialize
@@ -27,14 +28,16 @@ module TestProf
       end
 
       def example_finished(notification)
-        return if notification.example.pending?
-
         tag = notification.example.metadata.fetch(@tag, :__unknown__)
 
         @tags[tag][:count] += 1
         @tags[tag][:time] += (TestProf.now - @ts)
       end
 
+      # NOTE: RSpec < 3.4.0 doesn't have example_finished event
+      alias example_passed example_finished
+      alias example_failed example_finished
+
       def print
         msgs = []
 

data/lib/test_prof/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TestProf
-  VERSION = "0.4.0".freeze
+  VERSION = "0.4.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-03 00:00:00.000000000 Z
+date: 2017-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,7 +83,7 @@ dependencies:
 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
-  with custom Rubocop cops.\n  "
+  with custom RuboCop cops.\n  "
 email:
 - dementiev.vm@gmail.com
 executables: []
@@ -116,7 +116,10 @@ files:
 - guides/stack_prof.md
 - guides/tag_prof.md
 - guides/tests_sampling.md
-- lib/minitest/event_prof_plugin.rb
+- lib/minitest/base_reporter.rb
+- lib/minitest/event_prof_formatter.rb
+- lib/minitest/fd_ignorable.rb
+- lib/minitest/test_prof_plugin.rb
 - lib/test-prof.rb
 - lib/test_prof.rb
 - lib/test_prof/any_fixture.rb
@@ -126,7 +129,6 @@ files:
 - lib/test_prof/event_prof/custom_events/factory_create.rb
 - lib/test_prof/event_prof/custom_events/sidekiq_inline.rb
 - lib/test_prof/event_prof/custom_events/sidekiq_jobs.rb
-- lib/test_prof/event_prof/formatters/minitest.rb
 - lib/test_prof/event_prof/instrumentations/active_support.rb
 - lib/test_prof/event_prof/minitest.rb
 - lib/test_prof/event_prof/rspec.rb

data/lib/minitest/event_prof_plugin.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_prof/event_prof/minitest'
-
-module Minitest # :nodoc:
-  def self.plugin_event_prof_options(opts, options)
-    opts.on "--event-prof=EVENT", "Collects metrics for specified EVENT" do |event|
-      options[:event] = event
-    end
-    opts.on "--event-prof-rank-by=RANK_BY", "Defines RANK_BY parameter for results" do |rank|
-      options[:rank_by] = rank.to_sym
-    end
-    opts.on "--event-prof-top-count=N", "Limits results with N groups/examples" do |count|
-      options[:top_count] = count.to_i
-    end
-    opts.on "--event-prof-per-example", TrueClass, "Includes examples metrics to results" do |flag|
-      options[:per_example] = flag
-    end
-  end
-
-  def self.plugin_event_prof_init(options)
-    options[:event] = ENV['EVENT_PROF'] if ENV['EVENT_PROF']
-    options[:rank_by] = ENV['EVENT_PROF_RANK'].to_sym if ENV['EVENT_PROF_RANK']
-    options[:top_count] = ENV['EVENT_PROF_TOP'].to_i if ENV['EVENT_PROF_TOP']
-    options[:per_example] = true if ENV['EVENT_PROF_EXAMPLES']
-
-    return unless options[:event]
-    reporter << EventProfReporter.new(options[:io], options)
-  end
-end