test-prof 0.4.9 → 0.5.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.5.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-20 00:00:00.000000000 Z
+date: 2018-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: 0.56.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: 0.56.0
 - !ruby/object:Gem::Dependency
   name: rubocop-md
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +109,6 @@ files:
 - README.md
 - assets/flamegraph.demo.html
 - assets/flamegraph.template.html
-- assets/logo.svg
 - assets/src/d3-tip.js
 - assets/src/d3-tip.min.js
 - assets/src/d3.flameGraph.css
@@ -117,28 +116,15 @@ files:
 - assets/src/d3.flameGraph.min.css
 - assets/src/d3.flameGraph.min.js
 - assets/src/d3.v4.min.js
-- assets/testprof.png
-- guides/.rubocop.yml
-- guides/any_fixture.md
-- guides/before_all.md
-- guides/event_prof.md
-- 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
-- guides/stack_prof.md
-- guides/tag_prof.md
-- guides/tests_sampling.md
+- assets/tagprof.demo.html
+- assets/tagprof.template.html
 - lib/minitest/base_reporter.rb
 - lib/minitest/event_prof_formatter.rb
 - lib/minitest/test_prof_plugin.rb
 - lib/test-prof.rb
 - lib/test_prof.rb
 - lib/test_prof/any_fixture.rb
+- lib/test_prof/any_fixture/dsl.rb
 - lib/test_prof/cops/rspec/aggregate_failures.rb
 - lib/test_prof/event_prof.rb
 - lib/test_prof/event_prof/custom_events.rb
@@ -147,12 +133,16 @@ files:
 - lib/test_prof/event_prof/custom_events/sidekiq_jobs.rb
 - lib/test_prof/event_prof/instrumentations/active_support.rb
 - lib/test_prof/event_prof/minitest.rb
+- lib/test_prof/event_prof/profiler.rb
 - lib/test_prof/event_prof/rspec.rb
 - lib/test_prof/ext/active_record_3.rb
+- lib/test_prof/ext/active_record_refind.rb
 - lib/test_prof/ext/array_bsearch_index.rb
 - lib/test_prof/ext/float_duration.rb
 - lib/test_prof/ext/string_strip_heredoc.rb
 - lib/test_prof/ext/string_truncate.rb
+- lib/test_prof/factory_all_stub.rb
+- lib/test_prof/factory_all_stub/factory_bot_patch.rb
 - lib/test_prof/factory_bot.rb
 - lib/test_prof/factory_default.rb
 - lib/test_prof/factory_default/factory_bot_patch.rb
@@ -168,9 +158,13 @@ files:
 - lib/test_prof/factory_prof/printers/flamegraph.rb
 - lib/test_prof/factory_prof/printers/simple.rb
 - lib/test_prof/logging.rb
+- lib/test_prof/recipes/active_record_one_love.rb
+- lib/test_prof/recipes/active_record_shared_connection.rb
+- lib/test_prof/recipes/logging.rb
 - lib/test_prof/recipes/minitest/sample.rb
 - lib/test_prof/recipes/rspec/any_fixture.rb
 - lib/test_prof/recipes/rspec/before_all.rb
+- lib/test_prof/recipes/rspec/factory_all_stub.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
@@ -185,8 +179,12 @@ files:
 - lib/test_prof/stack_prof.rb
 - lib/test_prof/stack_prof/rspec.rb
 - lib/test_prof/tag_prof.rb
+- lib/test_prof/tag_prof/printers/html.rb
+- lib/test_prof/tag_prof/printers/simple.rb
+- lib/test_prof/tag_prof/result.rb
 - lib/test_prof/tag_prof/rspec.rb
 - lib/test_prof/utils.rb
+- lib/test_prof/utils/html_builder.rb
 - lib/test_prof/utils/sized_ordered_set.rb
 - lib/test_prof/version.rb
 homepage: http://github.com/palkan/test-prof
@@ -209,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby applications tests profiling tools

data/assets/logo.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 86 100"><defs><linearGradient id="a" x1="43" y1="100" x2="43" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#b5afbf"/><stop offset="1" stop-color="#dbd1d6"/></linearGradient><linearGradient id="b" x1="16" y1="87" x2="16" y2="73" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#a99ea7"/><stop offset=".6" stop-color="#c8b8c1"/></linearGradient><linearGradient id="c" x1="14" y1="75" x2="14" y2="79" xlink:href="#linear-gradient-2"/><linearGradient id="d" x1="34" x2="34" xlink:href="#linear-gradient-2"/><linearGradient id="e" x1="36" y1="79" x2="36" y2="83" xlink:href="#linear-gradient-2"/></defs><rect fill="url(#a)" width="86" height="100" rx="13" ry="13"/><rect fill="#fef7f9" x="1" y="1" width="84" height="94" rx="12" ry="12"/><path fill="#fff" d="M73 1H13A12 12 0 0 0 1 13v1A12 12 0 0 1 13 2h60a12 12 0 0 1 12 12v-1A12 12 0 0 0 73 1z"/><rect fill="#7e628f" x="9" y="9" width="68" height="58" rx="4" ry="4"/><path fill="#675077" d="M73 9H13a4 4 0 0 0-4 4v1a4 4 0 0 1 4-4h60a4 4 0 0 1 4 4v-1a4 4 0 0 0-4-4z"/><rect fill="#d84b9d" x="51" y="73" width="26" height="14" rx="4" ry="4"/><rect fill="#f159b0" x="51" y="73" width="26" height="12" rx="4" ry="4"/><path fill="#fc7acb" d="M73 84H55a4 4 0 0 1-4-4v1a4 4 0 0 0 4 4h18a4 4 0 0 0 4-4v-1a4 4 0 0 1-4 4z"/><circle fill="url(#b)" cx="16" cy="80" r="7"/><circle fill="#dec7d4" cx="16" cy="79" r="6"/><path fill="#f9edf4" d="M16 74a6 6 0 0 1 6 5.5V79a6 6 0 0 0-12 0v.5a6 6 0 0 1 6-5.5z"/><circle fill="url(#c)" cx="14" cy="77" r="2"/><circle fill="url(#d)" cx="34" cy="80" r="7"/><circle fill="#dec7d4" cx="34" cy="79" r="6"/><path fill="#f9edf4" d="M34 74a6 6 0 0 1 6 5.5V79a6 6 0 0 0-12 0v.5a6 6 0 0 1 6-5.5z"/><circle fill="url(#e)" cx="36" cy="81" r="2"/><path fill="#9072a0" d="M27 60.8A11.8 11.8 0 1 1 38.8 49 11.8 11.8 0 0 1 27 60.8zm0-20a8.2 8.2 0 1 0 8.2 8.2 8.2 8.2 0 0 0-8.2-8.2z"/><path fill="#fe5bb7" d="M37 51a2 2 0 0 1-2-2 8 8 0 0 0-8-8 2 2 0 0 1 0-4 12 12 0 0 1 12 12 2 2 0 0 1-2 2z"/><path fill="#9072a0" d="M59 60.8A11.8 11.8 0 1 1 70.8 49 11.8 11.8 0 0 1 59 60.8zm0-20a8.2 8.2 0 1 0 8.2 8.2 8.2 8.2 0 0 0-8.2-8.2z"/><path fill="#5bd3e8" d="M59 61a12 12 0 0 1-12-12 2 2 0 0 1 4 0 8 8 0 1 0 8-8 2 2 0 0 1 0-4 12 12 0 0 1 0 24z"/><path fill="#ffae43" d="M70 17.5l-11 11-4-5-7.8 8.8-11-21.2L26 25.7l-4-4-8 10.7-5-8V28l5 7.8 8-11.3 4 4L36 15l10.8 20.8 8.2-9.2 4 5 11-11 7 8.5v-3l-7-8.4z"/></svg>

data/guides/.rubocop.yml

@@ -1 +0,0 @@
-# Leave it blank to use default Rubocop config in guides

data/guides/any_fixture.md

@@ -1,114 +0,0 @@
-# Any Fixture
-
-Fixtures are the great way to increase your test suite performance, but for the large project, they are very hard to maintain.
-
-We propose a more general approach to lazy-generate the _global_ state for your test suite – AnyFixture.
-
-With AnyFixture you can use any block of code for data generation, and it will take care of cleaning it out at the end of the run.
-
-Consider an example:
-
-```ruby
-# The best way to use AnyFixture is through RSpec shared contexts
-RSpec.shared_context 'account', account: true do
-  # You should call AnyFixture outside of transaction to re-use the same
-  # data between examples
-  before(:all) do
-    # The provided name ("account") should be unique.
-    @account = TestProf::AnyFixture.register(:account) do
-      # Do anything here, AnyFixture keeps track of affected DB tables
-      # For example, you can use factories here
-      FactoryGirl.create(:account)
-
-      # or with Fabrication
-      Fabricate(:account)
-
-      # or with plain old AR
-      Account.create!(name: 'test')
-    end
-  end
-
-  let(:account) { @account }
-
-  # Or hard-reload object if there is chance of in-place modification
-  let(:account) { Account.find(@account.id) }
-end
-
-# Then in your tests
-
-# Active this fixture using a tag
-describe UsersController, :account do
-  # ...
-end
-
-# This test also uses the same account record,
-# no double-creation
-describe PostsController, :account do
-  # ...
-end
-```
-
-## Instructions
-
-In your `spec_helper.rb`:
-
-```ruby
-require 'test_prof/recipes/rspec/any_fixture'
-```
-
-Now you can use `TestProf::AnyFixture` in your tests.
-
-## Caveats
-
-`AnyFixture` cleans tables in the reverse order as compared to the order they were populated. That
-means when you register a fixture which references a not-yet-registered table, a
-foreign-key violation error *might* occur (if any). An example is worth more than 1000
-words:
-
-```ruby
-class Author < ApplicationRecord
-  has_many :articles
-end
-
-class Article < ApplicationRecord
-  belongs_to :author
-end
-```
-
-And the shared contexts:
-
-```ruby
-RSpec.shared_context 'author' do
-  before(:all) do
-    @author = TestProf::AnyFixture.register(:author) do
-      FactoryGirl.create(:account)
-    end
-  end
-
-  let(:author) { @author }
-end
-
-RSpec.shared_context 'article' do
-  before(:all) do
-    # outside of AnyFixture, we don't know about its dependent tables
-    author = FactoryGirl.create(:author)
-
-    @article = TestProf::AnyFixture.register(:article) do
-      FactoryGirl.create(:article, author: author)
-    end
-  end
-
-  let(:article) { @article }
-end
-```
-
-Then in some example:
-
-```ruby
-# This one adds only the 'articles' table to the list of affected tables
-include_context 'article'
-# And this one adds the 'authors' table
-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.

data/guides/before_all.md

@@ -1,98 +0,0 @@
-# Before All
-
-Rails has a great feature – `transactional_tests`, i.e. running each example within a transaction which is roll-backed in the end.
-
-Thus no example polutes global database state.
-
-But what if have a lot of examples with a common setup?
-
-Of course, we can do something like this:
-
-```ruby
-describe BeatleWeightedSearchQuery do
-  before(:each) do
-    @paul = create(:beatle, name: 'Paul')
-    @ringo = create(:beatle, name: 'Ringo')
-    @george = create(:beatle, name: 'George')
-    @john = create(:beatle, name: 'John')
-  end
-
-  # and about 15 examples here
-end
-```
-
-Or you can try `before(:all)`:
-
-```ruby
-describe BeatleWeightedSearchQuery do
-  before(:all) do
-    @paul = create(:beatle, name: 'Paul')
-    # ...
-  end
-
-  # ...
-end
-```
-
-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:
-
-```ruby
-describe BeatleWeightedSearchQuery do
-  before_all do
-    @paul = create(:beatle, name: 'Paul')
-    # ...
-  end
-
-  # ...
-end
-```
-
-That's all!
-
-## Instructions
-
-In your `spec_helper.rb`:
-
-```ruby
-require 'test_prof/recipes/rspec/before_all'
-```
-
-## Caveats
-
-If you modify objects generated within a `before_all` block in your examples, you maybe have to re-initiate them:
-
-
-```ruby
-before_all do
-  @user = create(:user)
-end
-
-let(:user) { @user }
-
-it 'when user is admin' do
-  # we modified our object in-place!
-  user.update!(role: 1)
-  expect(user).to be_admin
-end
-
-it 'when user is regular' do
-  # now @user's state depends on the order of specs!
-  expect(user).not_to be_admin
-end
-```
-
-The easiest way to solve this is to reload record for every example (it's still much faster than creating a new one):
-
-
-```ruby
-before_all do
-  @user = create(:user)
-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

@@ -1,177 +0,0 @@
-# EventProf
-
-EventProf collects instrumentation (such as ActiveSupport::Notifications) metrics during your test suite run.
-
-It works very similar to `rspec --profile` but can track arbitrary events.
-
-Example output:
-
-```sh
-[TEST PROF INFO] EventProf results for sql.active_record
-
-Total time: 00:00.256
-Total events: 1031
-
-Top 5 slowest suites (by time):
-
-AnswersController (./spec/controllers/answers_controller_spec.rb:3) – 00:00.119 (549 / 20)
-QuestionsController (./spec/controllers/questions_controller_spec.rb:3) – 00:00.105 (360 / 18)
-CommentsController (./spec/controllers/comments_controller_spec.rb:3) – 00:00.032 (122 / 4)
-
-Top 5 slowest tests (by time):
-
-destroys question (./spec/controllers/questions_controller_spec.rb:38) – 00:00.022 (29)
-change comments count (./spec/controllers/comments_controller_spec.rb:7) – 00:00.011 (34)
-change Votes count (./spec/shared_examples/controllers/voted_examples.rb:23) – 00:00.008 (25)
-change Votes count (./spec/shared_examples/controllers/voted_examples.rb:23) – 00:00.008 (32)
-fails (./spec/shared_examples/controllers/invalid_examples.rb:3) – 00:00.007 (34)
-
-```
-
-## Instructions
-
-Currently, EventProf supports only ActiveSupport::Notifications
-
-To activate EventProf with:
-
-### RSpec
-
-Use `EVENT_PROF` environment variable set to event name:
-
-```sh
-# Collect SQL queries stats for every suite and example
-EVENT_PROF='sql.active_record' rspec ...
-```
-
-### Minitest
-
-Use `EVENT_PROF` environment variable set to event name:
-
-```sh
-# Collect SQL queries stats for every suite and example
-EVENT_PROF='sql.active_record' rake test
-```
-or use CLI options as well:
-
-```sh
-# Run a specific file using CLI option
-ruby test/my_super_test.rb --event-prof=sql.active_record
-
-# Show the list of possible options:
-ruby test/my_super_test.rb --help
-```
-
-### 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.
-
-See [Rails guides](http://guides.rubyonrails.org/active_support_instrumentation.html)
-for the list of available events if you're using Rails.
-
-If you're using [rom-rb](http://rom-rb.org) you might be interested in profiling `'sql.rom'` event.
-
-### Configuration
-
-By default, EventProf collects information only about top-level groups (aka suites),
-but you can also profile individual examples. Just set the configuration option:
-
-```ruby
-TestProf::EventProf.configure do |config|
-  config.per_example = true
-end
-```
-
-Or provide the `EVENT_PROF_EXAMPLES=1` env variable.
-
-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
-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:
-
-- Add a wrapper for your instrumentation:
-
-
-```ruby
-# Wrapper over your instrumentation
-module MyEventsWrapper
-  # Should contain the only one method
-  def self.subscribe(event)
-    raise ArgumentError, 'Block is required!' unless block_given?
-
-    ::MyEvents.subscribe(event) do |start, finish, *|
-      yield (finish - start)
-    end
-  end
-end
-```
-
-- Set instrumenter in the config:
-
-
-```ruby
-TestProf::EventProf.configure do |config|
-  config.instrumenter = MyEventsWrapper
-end
-```
-
-## Custom Events
-
-### `"factory.create"`
-
-FactoryGirl provides its own instrumentation ('factory_girl.run_factory'); but there is a caveat – it fires an event every time a factory is used, even when we use factory for nested associations. Thus it's not possible to calculate the total time spent in factories due to the double calculation.
-
-EventProf comes with a little patch for FactoryGirl which provides instrumentation only for top-level `FactoryGirl.create` calls. It is loaded automatically if you use `"factory.create"` event:
-
-```sh
-EVENT_PROF=factory.create bundle exec rspec
-```
-
-### `"sidekiq.jobs"`
-
-Collects statistics about Sidekiq jobs that have been run inline:
-
-```sh
-EVENT_PROF=sidekiq.jobs bundle exec rspec
-```
-
-**NOTE**: automatically sets `rank_by` to `count` ('cause it doesn't make sense to collect the information about time spent – see below).
-
-### `"sidekiq.inline"`
-
-Collects statistics about Sidekiq jobs that have been run inline (excluding nested jobs):
-
-```sh
-EVENT_PROF=sidekiq.inline bundle exec rspec
-```
-
-Use this event to profile the time spent running Sidekiq jobs.

data/guides/factory_default.md

@@ -1,111 +0,0 @@
-# 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 reusing associated records.
-
-**NOTE**. Only works with FactoryGirl/FactoryBot.
-
-It can be very useful when you're working on a typical SaaS application (or other hierarchical data).
-
-Consider an example. Assume we have the following factories:
-
-```ruby
-factory :account do
-end
-
-factory :user do
-  account
-end
-
-factory :project do
-  account
-  user
-end
-
-factory :task do
-  account
-  project
-  user
-end
-```
-
-And we want to test the `Task` model:
-
-```ruby
-describe 'PATCH #update' do
-  let(:task) { create(:task) }
-
-  it 'works' do
-    patch :update, id: task.id, task: { completed: 't' }
-    expect(response).to be_success
-  end
-
-  # ...
-end
-```
-
-How many users and accounts are created per example? Two and four respectively.
-
-And it breaks our logic (every object should belong to the same account).
-
-Typical workaround:
-
-```ruby
-describe 'PATCH #update' do
-  let(:account) { create(:account) }
-  let(:project) { create(:project, account: account) }
-  let(:task) { create(:task, project: project, account: account) }
-
-  it 'works' do
-    patch :update, id: task.id, task: { completed: 't' }
-    expect(response).to be_success
-  end
-end
-```
-
-That works. And there are some cons: it's a little bit verbose and error-prone (easy to forget something).
-
-Here is how we can deal with it using FactoryDefault:
-
-```ruby
-describe 'PATCH #update' do
-  let(:account) { create_default(:account) }
-  let(:project) { create_default(:project) }
-  let(:task) { create(:task) }
-
-  # 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
-
-  it 'works' do
-    patch :update, id: task.id, task: { completed: 't' }
-    expect(response).to be_success
-  end
-end
-```
-
-**NOTE**. This feature introduces a bit of _magic_ to your tests, so use it with caution ('cause tests should be human-readable first). Good idea is to use defaults for top-level entities only (such as tenants in multi-tenancy apps).
-
-## Instructions
-
-In your `spec_helper.rb`:
-
-```ruby
-require 'test_prof/recipes/rspec/factory_default'
-```
-
-This adds two new methods to FactoryBot:
-
-- `FactoryBot#set_factory_default(factory, object)` – use the `object` as default for associations built with `factory`
-
-Example:
-
-```ruby
-let(:user) { create(:user) }
-
-before { FactoryBot.set_factory_default(:user, user) }
-```
-
-- `FactoryBot#create_default(factory, *args)` – is a shortcut for `create` + `set_factory_default`.
-
-**NOTE**. Defaults are cleaned up after each example.