test-prof 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0df1119b6d47cf2641984fe6bcc7387c228353ff
-  data.tar.gz: d472861344964d895fc964afb099f3d3a35dbfae
+  metadata.gz: eb103d86ccc7a513de8b30ae8ddf536c9bbc6255
+  data.tar.gz: f0fe1c206faab5761b4419ccbf8745f4060d3e82
 SHA512:
-  metadata.gz: ccde20ed06a18ff23b85ee1d2b42269214d8ea8dbaf88fda55a78093bd76c99cafef050b3db70e76f98570709b7adfec46d45e9cbb1140233f688c80bc158115
-  data.tar.gz: 2bda30e78808f8edfa279b88abafa617d416fa6f1bc9f235c883ab106a18d9619c8a5f4db3c412ede368307eade325db0d3559788e2015f2a7aeac6445cdeaed
+  metadata.gz: f6a4881cfc954438fa4184c2cd9be1784d10bfcd6d92931ea5132c8422aa08866b77e60ec91066ddd6afb620c524e99b4584818d158f396176f9649ef3a0e038
+  data.tar.gz: a699bd6e308b370aa4e53447025551a5b2f30249eb893356d30238eaed4dc135bb69335c780ea9d0b306ce569bca29117494ab91b6a70bbb7a22f714a65f827f

data/CHANGELOG.md

@@ -1,5 +1,42 @@
 # Change log
 
+## 0.3.0
+
+### Features:
+
+- Combine RSpecStamp with FactoryDoctor. ([@palkan][])
+
+Automatically mark _bad_ examples with custom tags.
+
+- [#17](https://github.com/palkan/test-prof/pull/17) Combine RSpecStamp with EventProf and RSpecDissect. ([@palkan][])
+
+It is possible now to automatically mark _slow_ examples and groups with custom tags. For example:
+
+```sh
+EVENT_PROF="sql.active_record" EVENT_PROF_STAMP="slow:sql" rspec ...
+```
+
+After running the command above the top 5 slowest example groups would be marked with `slow: :sql` tag.
+
+- [#14](https://github.com/palkan/test-prof/pull/14) RSpecDissect profiler. ([@palkan][])
+
+RSpecDissect tracks how much time do you spend in `before` hooks 
+and memoization helpers (i.e. `let`) in your tests.
+
+- [#13](https://github.com/palkan/test-prof/pull/13) RSpec `let_it_be` method. ([@palkan][])
+
+Just like `let`, but persist the result for the whole group (i.e. `let` + `before_all`).
+
+### Improvements:
+
+- Add ability to specify RubyProf report through `TEST_RUBY_PROF` env variable. ([@palkan][])
+
+- Add ability to specify StackProf raw mode through `TEST_STACK_PROF` env variable. ([@palkan][])
+
+### Changes
+
+- Use RubyProf `FlatPrinter` by default (was `CallStackPrinter`). ([@palkan][])
+
 ## 0.2.5
 
 - [#16](https://github.com/palkan/test-prof/pull/16) Support Ruby >= 2.2.0 (was >= 2.3.0). ([@palkan][])

data/README.md

@@ -10,7 +10,7 @@ Simply speaking, slow tests waste your time making you less productive.
 
 TestProf toolbox aims to help you identify bottlenecks in your test suite. It contains:
 
-- Plug'n'Play integrations for general Ruby profilers ([`ruby-prof`](https://github.com/ruby-prof), [`stackprof`](https://github.com/tmm1/stackprof))
+- Plug'n'Play integrations for general Ruby profilers ([`ruby-prof`](https://github.com/ruby-prof/ruby-prof), [`stackprof`](https://github.com/tmm1/stackprof))
 
 - Factories usage analyzers and profilers
 
@@ -20,7 +20,7 @@ TestProf toolbox aims to help you identify bottlenecks in your test suite. It co
 
 - etc.
 
-Of course, we have some [solutions](#tips-and-tricks) for common performance issues too, bundled into the gem.
+Of course, we have some [solutions](#tips-and-tricks-or-recipes) for common performance issues too, bundled into the gem.
 
 See [Table of Contents](#table-of-contents) for more.
 
@@ -69,6 +69,8 @@ Checkout our guides for each specific tool:
 
 - [Factory Profiler](https://github.com/palkan/test-prof/tree/master/guides/factory_prof.md)
 
+- [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)
 
 ## Tips and Tricks (or _Recipes_)
@@ -77,6 +79,8 @@ We also want to share some small code tricks which can help you to improve your
 
 - [`before_all` Hook](https://github.com/palkan/test-prof/tree/master/guides/before_all.md)
 
+- [`let_it_be` Helper](https://github.com/palkan/test-prof/tree/master/guides/let_it_be.md)
+
 - [AnyFixture](https://github.com/palkan/test-prof/tree/master/guides/any_fixture.md)
 
 - [FactoryDefault](https://github.com/palkan/test-prof/tree/master/guides/factory_default.md)

data/guides/event_prof.md

@@ -66,6 +66,16 @@ EVENT_PROF_RANK=count EVENT_PROF='instantiation.active_record' be rspec
 
 See [event_prof.rb](https://github.com/palkan/test-prof/tree/master/lib/test_prof/event_prof.rb) for all available configuration options and their usage.
 
+## Using with RSpecStamp
+
+EventProf can be used with [RSpec Stamp](https://github.com/palkan/test-prof/tree/master/guides/rspec_stamp.md) to automatically mark _slow_ examples with custom tags. For example:
+
+```sh
+EVENT_PROF="sql.active_record" EVENT_PROF_STAMP="slow:sql" rspec ...
+```
+
+After running the command above the slowest example groups (and examples if configured) would be marked with the `slow: :sql` tag.
+
 ## Custom Instrumentation
 
 To use EventProf with your instrumentation engine just complete the two following steps:

data/guides/factory_doctor.md

@@ -62,3 +62,13 @@ To activate FactoryDoctor use `FDOC` environment variable:
 ```sh
 FDOC=1 rspec ...
 ```
+
+## Using with RSpecStamp
+
+FactoryDoctor can be used with [RSpec Stamp](https://github.com/palkan/test-prof/tree/master/guides/rspec_stamp.md) to automatically mark _bad_ examples with custom tags. For example:
+
+```sh
+FDOC=1 FDOC_STAMP="fdoc:consider" rspec ...
+```
+
+After running the command above all _potentially_ bad examples would be marked with the `fdoc: :consider` tag.

data/guides/let_it_be.md

@@ -0,0 +1,96 @@
+# Let It Be!
+
+Let's bring a little bit of magic and introduce a new way to setup a _shared_ test data.
+
+Suppose you have the following setup:
+
+```ruby
+describe BeatleWeightedSearchQuery do
+  let!(:paul) { create(:beatle, name: 'Paul') }
+  let!(:ringo) { create(:beatle, name: 'Ringo') }
+  let!(:george) { create(:beatle, name: 'George') }
+  let!(:john) { create(:beatle, name: 'John') }
+
+  specify { expect(subject.call('joh')).to contain_exactly(john) }
+
+  # and more examples here
+end
+```
+
+We don't need to re-create the Fab Four for every example, do we?
+
+We already have [`before_all`](https://github.com/palkan/test-prof/tree/master/guides/before_all.md) to solve the problem of _repeatable_ data:
+
+```ruby
+describe BeatleWeightedSearchQuery do
+  before_all do
+    @paul = create(:beatle, name: 'Paul')
+    ...
+  end
+
+  specify { expect(subject.call('joh')).to contain_exactly(@john) }
+
+  ...
+end
+```
+
+That technique works pretty good but requires us to use instance variables and define everything at once. Thus it's not easy to refactor existing tests which use `let/let!` instead.
+
+With `let_it_be` you can do the following:
+
+```ruby
+describe BeatleWeightedSearchQuery do
+  let_it_be(:paul) { create(:beatle, name: 'Paul') }
+  let_it_be(:ringo) { create(:beatle, name: 'Ringo') }
+  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) }
+
+  # and more examples here
+end
+```
+
+That's it! Just replace `let!` with `let_it_be`. That's equal to the `before_all` approach but requires less refactoring.
+
+
+## Instructions
+
+In your `spec_helper.rb`:
+
+```ruby
+require "test_prof/recipes/rspec/let_it_be"
+```
+
+In your tests:
+
+```ruby
+describe MySuperDryService do
+  let_it_be(:user) { create(:user) }
+
+  ...
+end
+```
+
+## Caveats
+
+If you modify objects generated within a `let_it_be` block in your examples, you maybe have to re-initiate them.
+We have a built-in support for that:
+
+
+```ruby
+# Use reload: true option to reload user object (assuming it's an instance of ActiveRecord)
+# for every example
+let_it_be(:user, reload: true) { create(:user) }
+
+# it is almost equal to
+before_all { @user = create(:user) }
+let(:user) { @user.reload }
+
+# You can also specify refind: true option to hard-reload the record
+let_it_be(:user, refind: true) { create(:user) }
+
+# it is almost equal to
+before_all { @user = create(:user) }
+let(:user) { User.find(@user.id) }
+```

data/guides/rspec_dissect.md

@@ -0,0 +1,58 @@
+# 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.
+
+_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.
+
+Example output:
+
+```sh
+[TEST PROF INFO] RSpecDissect enabled
+
+Total time: 25:14.870
+Total `before(:each)` time: 14:36.482
+Total `let` time: 19:20.259
+
+Top 5 slowest suites (by `before(:each)` time):
+
+Webhooks::DispatchTransition (./spec/services/webhooks/dispatch_transition_spec.rb:3) – 00:29.895 of 00:33.706 (327)
+FunnelsController (./spec/controllers/funnels_controller_spec.rb:3) – 00:22.117 of 00:43.649 (133)
+ApplicantsController (./spec/controllers/applicants_controller_spec.rb:3) – 00:21.220 of 00:41.407 (222)
+BookedSlotsController (./spec/controllers/booked_slots_controller_spec.rb:3) – 00:15.729 of 00:27.893 (50)
+Analytics::Wor...rsion::Summary (./spec/services/analytics/workflow_conversion/summary_spec.rb:3) – 00:15.383 of 00:15.914 (12)
+
+
+Top 5 slowest suites (by `let` time):
+
+FunnelsController (./spec/controllers/funnels_controller_spec.rb:3) – 00:38.532 of 00:43.649 (133)
+ApplicantsController (./spec/controllers/applicants_controller_spec.rb:3) – 00:33.252 of 00:41.407 (222)
+Webhooks::DispatchTransition (./spec/services/webhooks/dispatch_transition_spec.rb:3) – 00:30.320 of 00:33.706 (327)
+BookedSlotsController (./spec/controllers/booked_slots_controller_spec.rb:3) – 00:25.710 of 00:27.893 (50)
+AvailableSlotsController (./spec/controllers/available_slots_controller_spec.rb:3) – 00:18.481 of 00:23.366 (85)
+```
+
+## Instructions
+
+RSpecDissect can only be used with RSpec (which is clear from the name).
+
+To activate RSpecDissect use `RD_PROF` environment variable:
+
+```sh
+RD_PROF=1 rspec ...
+```
+
+You can also specify the number of top slow groups through `RD_PROF_TOP` variable:
+
+```sh
+RD_PROF=1 RD_PROF_TOP=10 rspec ...
+```
+
+## Using with RSpecStamp
+
+RSpecDissect can be used with [RSpec Stamp](https://github.com/palkan/test-prof/tree/master/guides/rspec_stamp.md) to automatically mark _slow_ examples with custom tags. For example:
+
+```sh
+RD_PROF=1 RD_PROF_STAMP="slow" rspec ...
+```
+
+After running the command above the slowest example groups would be marked with the `:slow` tag.

data/guides/ruby_prof.md

@@ -42,21 +42,21 @@ end
 
 The most useful configuration option is `printer` – it allows you to specify a RubyProf [printer](https://github.com/ruby-prof/ruby-prof#printers).
 
-You can specify a printer through environment variable `TEST_RUBY_PROF_PRINTER`:
+You can specify a printer through environment variable `TEST_RUBY_PROF`:
 
 ```sh
-TEST_RUBY_PROF_PRINTER=flat bundle exec rake test
+TEST_RUBY_PROF=call_stack bundle exec rake test
 ```
 
 Or in your code:
 
 ```ruby
 TestProf::RubyProf.configure do |config|
-  config.printer = :flat
+  config.printer = :call_stack
 end
 ```
 
-By default, we use `CallStackPrinter`.
+By default, we use `FlatPrinter`.
 
 Also, you can specify RubyProf mode (`wall`, `cpu`, etc) through `TEST_RUBY_PROF_MODE` env variable.
 

data/guides/stack_prof.md

@@ -42,6 +42,6 @@ end
 
 You can change StackProf mode (which is `wall` by default) through `TEST_STACK_PROF_MODE` env variable.
 
-If you want to generate flame graphs you should collect _raw_ data. Turn _raw_ collection on by passing `TEST_STACK_PROF_RAW=1`.
+If you want to generate flame graphs you should collect _raw_ data. Turn _raw_ collection on by passing `TEST_STACK_PROF=raw`.
 
 See [stack_prof.rb](https://github.com/palkan/test-prof/tree/master/lib/test_prof/stack_prof.rb) for all available configuration options and their usage.

data/lib/test_prof/event_prof/rspec.rb

@@ -81,6 +81,41 @@ module TestProf
         end
 
         log :info, msgs.join
+
+        stamp! if EventProf.config.stamp?
+      end
+
+      def stamp!
+        result = @profiler.results
+
+        stamper = RSpecStamp::Stamper.new
+
+        examples = Hash.new { |h, k| h[k] = [] }
+
+        (result[:groups].to_a + result.fetch(:examples, []).to_a)
+          .map { |obj| obj[:id].metadata[:location] }.each do |location|
+          file, line = location.split(":")
+          examples[file] << line.to_i
+        end
+
+        examples.each do |file, lines|
+          stamper.stamp_file(file, lines.uniq)
+        end
+
+        msgs = []
+
+        msgs <<
+          <<-MSG.strip_heredoc
+            RSpec Stamp results
+
+            Total patches: #{stamper.total}
+            Total files: #{examples.keys.size}
+
+            Failed patches: #{stamper.failed}
+            Ignored files: #{stamper.ignored}
+          MSG
+
+        log :info, msgs.join
       end
     end
   end

data/lib/test_prof/event_prof.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "test_prof/rspec_stamp"
 require "test_prof/event_prof/instrumentations/active_support"
 require "test_prof/utils/sized_ordered_set"
 
@@ -39,6 +40,13 @@ module TestProf
         @top_count = (ENV['EVENT_PROF_TOP'] || 5).to_i
         @per_example = ENV['EVENT_PROF_EXAMPLES'] == '1'
         @rank_by = (ENV['EVENT_PROF_RANK'] || :time).to_sym
+        @stamp = ENV['EVENT_PROF_STAMP']
+
+        RSpecStamp.config.tags = @stamp if stamp?
+      end
+
+      def stamp?
+        !@stamp.nil?
       end
 
       def per_example?
@@ -76,7 +84,7 @@ module TestProf
     class Profiler # :nodoc:
       include TestProf::Logging
 
-      attr_reader :event, :top_count, :rank_by, :total_count, :total_time
+      attr_reader :event, :total_count, :total_time
 
       def initialize(event:, instrumenter:)
         @event = event

data/lib/test_prof/factory_doctor/rspec.rb

@@ -70,6 +70,40 @@ module TestProf
         end
 
         log :info, msgs.join
+
+        stamp! if FactoryDoctor.stamp?
+      end
+
+      def stamp!
+        stamper = RSpecStamp::Stamper.new
+
+        examples = Hash.new { |h, k| h[k] = [] }
+
+        @example_groups.each_value do |bad_examples|
+          bad_examples.each do |example|
+            file, line = example.metadata[:location].split(":")
+            examples[file] << line.to_i
+          end
+        end
+
+        examples.each do |file, lines|
+          stamper.stamp_file(file, lines.uniq)
+        end
+
+        msgs = []
+
+        msgs <<
+          <<-MSG.strip_heredoc
+            RSpec Stamp results
+
+            Total patches: #{stamper.total}
+            Total files: #{examples.keys.size}
+
+            Failed patches: #{stamper.failed}
+            Ignored files: #{stamper.ignored}
+          MSG
+
+        log :info, msgs.join
       end
 
       private

data/lib/test_prof/factory_doctor.rb

@@ -54,6 +54,14 @@ module TestProf
           defined?(::FactoryGirl)
 
         subscribe!
+
+        @stamp = ENV['FDOC_STAMP']
+
+        RSpecStamp.config.tags = @stamp if stamp?
+      end
+
+      def stamp?
+        !@stamp.nil?
       end
 
       def start

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

@@ -6,6 +6,10 @@ module TestProf
     def before_all(&block)
       raise ArgumentError, "Block is required!" unless block_given?
 
+      return if within_before_all?
+
+      @__before_all_activated__ = true
+
       before(:all) do
         ActiveRecord::Base.connection.begin_transaction(joinable: false)
         instance_eval(&block)
@@ -15,6 +19,10 @@ module TestProf
         ActiveRecord::Base.connection.rollback_transaction
       end
     end
+
+    def within_before_all?
+      instance_variable_defined?(:@__before_all_activated__)
+    end
   end
 end
 

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

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require_relative "./before_all"
+
+module TestProf
+  # Just like `let`, but persist the result for the whole group.
+  # NOTE: Experimental and magical, for more control use `before_all`.
+  module LetItBe
+    class << self
+      def module_for(group)
+        modules.fetch(group) do
+          Module.new.tap { |mod| group.prepend(mod) }
+        end
+      end
+
+      private
+
+      def modules
+        @modules ||= {}
+      end
+    end
+    # 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__".freeze : "@😸".freeze
+
+    def let_it_be(identifier, **options, &block)
+      initializer = proc do
+        instance_variable_set(:"#{PREFIX}#{identifier}", instance_exec(&block))
+      end
+
+      if within_before_all?
+        before(:all, &initializer)
+      else
+        before_all(&initializer)
+      end
+
+      define_let_it_be_methods(identifier, **options)
+    end
+
+    def define_let_it_be_methods(identifier, reload: false, refind: false)
+      let_accessor = -> { instance_variable_get(:"#{PREFIX}#{identifier}") }
+
+      if reload
+        let_accessor = lambda do
+          record = instance_variable_get(:"#{PREFIX}#{identifier}")
+          next unless record.is_a?(::ActiveRecord::Base)
+          record.reload
+        end
+      end
+
+      if refind
+        let_accessor = lambda do
+          record = instance_variable_get(:"#{PREFIX}#{identifier}")
+          next unless record.is_a?(::ActiveRecord::Base)
+
+          record.class.find(record.send(record.class.primary_key))
+        end
+      end
+
+      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\)/
+            instance_variable_get(:"#{PREFIX}#{identifier}")
+          else
+            # Fallback to let definition
+            super()
+          end
+        end
+      end
+
+      let(identifier, &let_accessor)
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.extend TestProf::LetItBe
+end

data/lib/test_prof/rspec_dissect/rspec.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require "test_prof/ext/float_duration"
+require "test_prof/ext/string_truncate"
+require "test_prof/utils/sized_ordered_set"
+require "test_prof/ext/string_strip_heredoc"
+
+module TestProf
+  module RSpecDissect
+    class Listener # :nodoc:
+      include Logging
+      using FloatDuration
+      using StringTruncate
+      using StringStripHeredoc
+
+      NOTIFICATIONS = %i[
+        example_finished
+        example_group_finished
+      ].freeze
+
+      def initialize
+        @before_results = Utils::SizedOrderedSet.new(
+          top_count, sort_by: :before
+        )
+        @memo_results = Utils::SizedOrderedSet.new(
+          top_count, sort_by: :memo
+        )
+        @examples_count = 0
+        @examples_time = 0.0
+        @total_examples_time = 0.0
+      end
+
+      def example_finished(notification)
+        @examples_count += 1
+        @examples_time += notification.example.execution_result.run_time
+      end
+
+      def example_group_finished(notification)
+        return unless notification.group.top_level?
+
+        data = {}
+        data[:total] = @examples_time
+        data[:count] = @examples_count
+        data[:before] = RSpecDissect.before_time
+        data[:memo] = RSpecDissect.memo_time
+        data[:desc] = notification.group.top_level_description
+        data[:loc] = notification.group.metadata[:location]
+
+        @before_results << data
+        @memo_results << data
+
+        @total_examples_time += @examples_time
+        @examples_count = 0
+        @examples_time = 0.0
+
+        RSpecDissect.reset!
+      end
+
+      def print
+        msgs = []
+
+        msgs <<
+          <<-MSG.strip_heredoc
+            RSpecDissect report
+
+            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 <<
+          <<-MSG.strip_heredoc
+            Top #{top_count} slowest suites (by `before(:each)` time):
+
+          MSG
+
+        @before_results.each do |group|
+          msgs <<
+            <<-GROUP.strip_heredoc
+              #{group[:desc].truncate} (#{group[:loc]}) – #{group[:before].duration} of #{group[:total].duration} (#{group[:count]})
+            GROUP
+        end
+
+        msgs <<
+          <<-MSG.strip_heredoc
+
+            Top #{top_count} slowest suites (by `let` time):
+
+          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
+        end
+
+        log :info, msgs.join
+
+        stamp! if RSpecDissect.config.stamp?
+      end
+
+      def stamp!
+        stamper = RSpecStamp::Stamper.new
+
+        examples = Hash.new { |h, k| h[k] = [] }
+
+        (@before_results.to_a + @memo_results.to_a)
+          .map { |obj| obj[:loc] }.each do |location|
+          file, line = location.split(":")
+          examples[file] << line.to_i
+        end
+
+        examples.each do |file, lines|
+          stamper.stamp_file(file, lines.uniq)
+        end
+
+        msgs = []
+
+        msgs <<
+          <<-MSG.strip_heredoc
+            RSpec Stamp results
+
+            Total patches: #{stamper.total}
+            Total files: #{examples.keys.size}
+
+            Failed patches: #{stamper.failed}
+            Ignored files: #{stamper.ignored}
+          MSG
+
+        log :info, msgs.join
+      end
+
+      private
+
+      def top_count
+        RSpecDissect.config.top_count
+      end
+    end
+  end
+end
+
+# Register RSpecDissect listener
+TestProf.activate('RD_PROF') do
+  RSpec.configure do |config|
+    listener = TestProf::RSpecDissect::Listener.new
+
+    config.before(:suite) do
+      config.reporter.register_listener(
+        listener, *TestProf::RSpecDissect::Listener::NOTIFICATIONS
+      )
+    end
+
+    config.after(:suite) { listener.print }
+  end
+end

data/lib/test_prof/rspec_dissect.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require "test_prof/rspec_stamp"
+require "test_prof/logging"
+
+module TestProf
+  # RSpecDissect tracks how much time do you spend in `before` hooks
+  # and memoization helpers (i.e. `let`) in your tests.
+  module RSpecDissect
+    module ExampleInstrumentation # :nodoc:
+      def run_before_example(*)
+        RSpecDissect.track(:before) { super }
+      end
+    end
+
+    module MemoizedInstrumentation # :nodoc:
+      def fetch_or_store(*)
+        res = nil
+        Thread.current[:_rspec_dissect_memo_depth] ||= 0
+        Thread.current[:_rspec_dissect_memo_depth] += 1
+        begin
+          res = if Thread.current[:_rspec_dissect_memo_depth] == 1
+                  RSpecDissect.track(:memo) { super }
+                else
+                  super
+                end
+        ensure
+          Thread.current[:_rspec_dissect_memo_depth] -= 1
+        end
+        res
+      end
+    end
+
+    # RSpecDisect configuration
+    class Configuration
+      attr_accessor :top_count
+
+      def initialize
+        @top_count = (ENV['RD_PROF_TOP'] || 5).to_i
+        @stamp = ENV['RD_PROF_STAMP']
+
+        RSpecStamp.config.tags = @stamp if stamp?
+      end
+
+      def stamp?
+        !@stamp.nil?
+      end
+    end
+
+    METRICS = %w[before memo].freeze
+
+    class << self
+      include Logging
+
+      def config
+        @config ||= Configuration.new
+      end
+
+      def configure
+        yield config
+      end
+
+      def init
+        RSpec::Core::Example.prepend(ExampleInstrumentation)
+        RSpec::Core::MemoizedHelpers::ThreadsafeMemoized.prepend(MemoizedInstrumentation)
+        RSpec::Core::MemoizedHelpers::NonThreadSafeMemoized.prepend(MemoizedInstrumentation)
+
+        @data = {}
+
+        METRICS.each do |type|
+          @data["total_#{type}"] = 0.0
+        end
+
+        reset!
+
+        log :info, "RSpecDissect enabled"
+      end
+
+      def track(type)
+        start = TestProf.now
+        res = yield
+        delta = (TestProf.now - start)
+        type = type.to_s
+        @data[type] += delta
+        @data["total_#{type}"] += delta
+        res
+      end
+
+      def reset!
+        METRICS.each do |type|
+          @data[type.to_s] = 0.0
+        end
+      end
+
+      METRICS.each do |type|
+        define_method("#{type}_time") do
+          @data[type.to_s]
+        end
+
+        define_method("total_#{type}_time") do
+          @data["total_#{type}"]
+        end
+      end
+    end
+  end
+end
+
+require "test_prof/rspec_dissect/rspec" if defined?(RSpec::Core)
+
+TestProf.activate('RD_PROF') do
+  TestProf::RSpecDissect.init
+end

data/lib/test_prof/rspec_stamp/parser.rb

@@ -8,7 +8,7 @@ module TestProf
     module Parser
       # Contains the result of parsing
       class Result
-        attr_accessor :fname, :desc
+        attr_accessor :fname, :desc, :desc_const
         attr_reader :tags, :htags
 
         def add_tag(v)
@@ -29,6 +29,7 @@ module TestProf
 
       class << self
         # rubocop: disable Metrics/CyclomaticComplexity
+        # rubocop: disable Metrics/PerceivedComplexity
         def parse(code)
           sexp = Ripper.sexp(code)
           return unless sexp
@@ -57,11 +58,17 @@ module TestProf
           res = Result.new
 
           fcall = sexp[1][0][1]
-          fcall = fcall[1] if fcall.first == :fcall
-          res.fname = fcall[1]
-
           args_block = sexp[1][0][2]
 
+          if fcall.first == :fcall
+            fcall = fcall[1]
+          elsif fcall.first == :var_ref
+            res.fname = [parse_const(fcall), sexp[1][0][3][1]].join(".")
+            args_block = sexp[1][0][4]
+          end
+
+          res.fname ||= fcall[1]
+
           return res if args_block.nil?
 
           args_block = args_block[1] if args_block.first == :arg_paren
@@ -70,6 +77,8 @@ module TestProf
 
           if args.first.first == :string_literal
             res.desc = parse_literal(args.shift)
+          elsif args.first.first == :var_ref || args.first.first == :const_path_ref
+            res.desc_const = parse_const(args.shift)
           end
 
           parse_arg(res, args.shift) until args.empty?
@@ -77,6 +86,7 @@ module TestProf
           res
         end
         # rubocop: enable Metrics/CyclomaticComplexity
+        # rubocop: enable Metrics/PerceivedComplexity
 
         private
 
@@ -90,7 +100,24 @@ module TestProf
 
         def parse_hash(res, hash_arg)
           hash_arg.each do |(_, label, val)|
-            res.add_htag label[1][0..-2].to_sym, parse_literal(val)
+            res.add_htag label[1][0..-2].to_sym, parse_value(val)
+          end
+        end
+
+        # Expr of the form:
+        #  bool - [:var_ref, [:@kw, "true", [1, 24]]]
+        #  string - [:string_literal, [:string_content, [...]]]
+        #  int - [:@int, "3", [1, 52]]]]
+        def parse_value(expr)
+          case expr.first
+          when :var_ref
+            expr[1][1] == "true"
+          when :@int
+            expr[1].to_i
+          when :@float
+            expr[1].to_f
+          else
+            parse_literal(expr)
           end
         end
 
@@ -102,6 +129,25 @@ module TestProf
                               expr[0] == :assoc_new
           val
         end
+
+        # Expr of the form:
+        #  [:var_ref, [:@const, "User", [1, 9]]]
+        #
+        #  or
+        #
+        #  [:const_path_ref, [:const_path_ref, [:var_ref,
+        #    [:@const, "User", [1, 17]]],
+        #    [:@const, "Guest", [1, 23]]],
+        #    [:@const, "Collection", [1, 30]]
+        def parse_const(expr)
+          if expr.first == :var_ref
+            expr[1][1]
+          elsif expr.first == :@const
+            expr[1]
+          elsif expr.first == :const_path_ref
+            expr[1..-1].map(&method(:parse_const)).join("::")
+          end
+        end
       end
     end
   end

data/lib/test_prof/rspec_stamp/rspec.rb

@@ -30,8 +30,10 @@ module TestProf
       end
 
       def stamp!
+        stamper = Stamper.new
+
         @examples.each do |file, lines|
-          stamp_file(file, lines.uniq)
+          stamper.stamp_file(file, lines.uniq)
         end
 
         msgs = []
@@ -40,44 +42,15 @@ module TestProf
           <<-MSG.strip_heredoc
             RSpec Stamp results
 
-            Total patches: #{@total}
+            Total patches: #{stamper.total}
             Total files: #{@examples.keys.size}
 
-            Failed patches: #{@failed}
-            Ignored files: #{@ignored}
+            Failed patches: #{stamper.failed}
+            Ignored files: #{stamper.ignored}
           MSG
 
         log :info, msgs.join
       end
-
-      private
-
-      def stamp_file(file, lines)
-        @total += lines.size
-        return if ignored?(file)
-
-        log :info, "(dry-run) Patching #{file}" if dry_run?
-
-        code = File.readlines(file)
-
-        @failed += RSpecStamp.apply_tags(code, lines, RSpecStamp.config.tags)
-
-        File.write(file, code.join) unless dry_run?
-      end
-
-      def ignored?(file)
-        ignored = RSpecStamp.config.ignore_files.find do |pattern|
-          file =~ pattern
-        end
-
-        return unless ignored
-        log :warn, "Ignore stamping file: #{file}"
-        @ignored += 1
-      end
-
-      def dry_run?
-        RSpecStamp.config.dry_run?
-      end
     end
   end
 end

data/lib/test_prof/rspec_stamp.rb

@@ -10,7 +10,8 @@ module TestProf
 
     # RSpecStamp configuration
     class Configuration
-      attr_accessor :ignore_files, :dry_run, :tags
+      attr_reader :tags
+      attr_accessor :ignore_files, :dry_run
 
       def initialize
         @ignore_files = [%r{spec/support}]
@@ -44,6 +45,49 @@ module TestProf
       end
     end
 
+    # Stamper collects statistics about applying tags
+    # to examples.
+    class Stamper
+      include TestProf::Logging
+
+      attr_reader :total, :failed, :ignored
+
+      def initialize
+        @total = 0
+        @failed = 0
+        @ignored = 0
+      end
+
+      def stamp_file(file, lines)
+        @total += lines.size
+        return if ignored?(file)
+
+        log :info, "(dry-run) Patching #{file}" if dry_run?
+
+        code = File.readlines(file)
+
+        @failed += RSpecStamp.apply_tags(code, lines, RSpecStamp.config.tags)
+
+        File.write(file, code.join) unless dry_run?
+      end
+
+      private
+
+      def ignored?(file)
+        ignored = RSpecStamp.config.ignore_files.find do |pattern|
+          file =~ pattern
+        end
+
+        return unless ignored
+        log :warn, "Ignore stamping file: #{file}"
+        @ignored += 1
+      end
+
+      def dry_run?
+        RSpecStamp.config.dry_run?
+      end
+    end
+
     class << self
       include TestProf::Logging
 
@@ -84,11 +128,11 @@ module TestProf
         parsed = Parser.parse(code)
         return false unless parsed
 
-        parsed.desc ||= 'works'
+        desc = parsed.desc_const || quote(parsed.desc || 'works')
 
         tags.each do |t|
           if t.is_a?(Hash)
-            t.keys.each do |k|
+            t.each_key do |k|
               parsed.remove_tag(k)
               parsed.add_htag(k, t[k])
             end
@@ -101,9 +145,9 @@ module TestProf
         need_parens = block == "{"
 
         tags_str = parsed.tags.map { |t| t.is_a?(Symbol) ? ":#{t}" : t }.join(", ") unless
-          parsed.tags.nil?
+          parsed.tags.nil? || parsed.tags.empty?
 
-        unless parsed.htags.nil?
+        unless parsed.htags.nil? || parsed.htags.empty?
           htags_str = parsed.htags.map do |(k, v)|
             vstr = v.is_a?(Symbol) ? ":#{v}" : quote(v)
 
@@ -112,7 +156,7 @@ module TestProf
         end
 
         replacement = "\\1#{parsed.fname}#{need_parens ? '(' : ' '}"\
-                      "#{[quote(parsed.desc), tags_str, htags_str].compact.join(', ')}"\
+                      "#{[desc, tags_str, htags_str].compact.join(', ')}"\
                       "#{need_parens ? ') ' : ' '}\\3"
 
         if config.dry_run?
@@ -126,6 +170,7 @@ module TestProf
       # rubocop: enable Metrics/PerceivedComplexity
 
       def quote(str)
+        return str unless str.is_a?(String)
         if str.include?("'")
           "\"#{str}\""
         else

data/lib/test_prof/ruby_prof.rb

@@ -50,7 +50,8 @@ module TestProf
                     :include_threads, :eliminate_methods
 
       def initialize
-        @printer = ENV.fetch('TEST_RUBY_PROF_PRINTER', :call_stack).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

data/lib/test_prof/stack_prof.rb

@@ -28,7 +28,7 @@ module TestProf
 
       def initialize
         @mode = ENV.fetch('TEST_STACK_PROF_MODE', :wall).to_sym
-        @raw = ENV['TEST_STACK_PROF_RAW'] == '1'
+        @raw = ENV['TEST_STACK_PROF'] == 'raw' || ENV['TEST_STACK_PROF_RAW'] == 1
       end
     end
 

data/lib/test_prof/utils/sized_ordered_set.rb

@@ -42,7 +42,11 @@ module TestProf
       end
 
       def each
-        data.each
+        if block_given?
+          data.each(&Proc.new)
+        else
+          data.each
+        end
       end
 
       def size
@@ -50,7 +54,7 @@ module TestProf
       end
 
       def to_a
-        data
+        data.dup
       end
 
       private

data/lib/test_prof/version.rb

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

data/lib/test_prof.rb

@@ -127,3 +127,4 @@ 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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-30 00:00:00.000000000 Z
+date: 2017-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.49'
+        version: '0.50'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.49'
+        version: '0.50'
 description: "\n    Ruby applications tests profiling tools.\n\n    Contains tools
   to anylyze factories usage, integrate with Ruby profilers,\n    profile your examples
   using ActiveSupport notifications (if any) and\n    statically analyze your code
@@ -108,6 +108,8 @@ files:
 - guides/factory_default.md
 - guides/factory_doctor.md
 - guides/factory_prof.md
+- guides/let_it_be.md
+- guides/rspec_dissect.md
 - guides/rspec_stamp.md
 - guides/rubocop.md
 - guides/ruby_prof.md
@@ -145,7 +147,10 @@ files:
 - lib/test_prof/recipes/rspec/any_fixture.rb
 - lib/test_prof/recipes/rspec/before_all.rb
 - lib/test_prof/recipes/rspec/factory_default.rb
+- lib/test_prof/recipes/rspec/let_it_be.rb
 - lib/test_prof/recipes/rspec/sample.rb
+- lib/test_prof/rspec_dissect.rb
+- lib/test_prof/rspec_dissect/rspec.rb
 - lib/test_prof/rspec_stamp.rb
 - lib/test_prof/rspec_stamp/parser.rb
 - lib/test_prof/rspec_stamp/rspec.rb
@@ -179,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Ruby applications tests profiling tools