test-prof 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65bd3447c63c3e7c037707ebd0f637831ccf0c98af1b0b3d9bf0a6fa72c56b11
-  data.tar.gz: d6af1b43e6924c67ef4c2297602ef641377584f3282eafc236e48eb951e04b68
+  metadata.gz: 6cf66f80707806f1378f3164e1376e6ee8fe5c3472d0704ef865de4939852283
+  data.tar.gz: 472ea3dde66363470b5e62995548760359f5ecd358b84099d12d9a622b36063d
 SHA512:
-  metadata.gz: 2eae07fcbce70eb7598b92fc578530ed5e20edfb3d7752c672740d44aa13f5d925005500aa26e83ce004c0b2ba128b0091362c39771b67e12d352360aacc2081
-  data.tar.gz: 213858acbdaa8d5e2e6e1fcdd99ca952a044949d23846f631a34513d379ce583013c13ed76c0303c8bd8fec777f44b99bf992e8937598d22bf4110cedb408eb6
+  metadata.gz: 4c21d8cae35943af31f72617a20b11d653ade888ba264c510dbe1fc365052a3ed7c7e04a7516b967a4f47dcb2442754a0d4e60053c385ae859963b666d239f9e
+  data.tar.gz: 7615a8bdb3d087c254333c265ffd759d13b51e76c6913d8e38a6856bdc036303f096ef2f2fb83c1b867024a87fe4989635105361103e85d7e1f4b14c0ae584bd

data/CHANGELOG.md

@@ -1,6 +1,57 @@
 # Change log
 
-## master
+## master (unreleased)
+
+## 0.9.0 (2019-05-14)
+
+- Add threshold and custom event support to FactoryDoctor. ([@palkan][])
+
+  ```sh
+  $ FDOC=1 FDOC_EVENT="sql.rom" FDOC_THRESHOLD=0.1 rspec
+  ```
+
+- Add Fabrication support to FactoryDoctor. ([@palkan][])
+
+- Add `guard` and `top_level` options to `EventProf::Monitor`. ([@palkan][])
+
+  For example:
+
+  ```ruby
+  TestProf::EventProf.monitor(
+    Sidekiq::Client,
+    "sidekiq.inline",
+    :raw_push,
+    top_level: true,
+    guard: ->(*) { Sidekiq::Testing.inline? }
+  )
+  ```
+
+- Add global `before_all` hooks. ([@danielwaterworth][], [@palkan][])
+
+  Now you can run additional code before and after every `before_all` transaction
+  begins and rollbacks:
+
+  ```ruby
+  TestProf::BeforeAll.configure do |config|
+    config.before(:begin) do
+      # do something before transaction opens
+    end
+
+    config.after(:rollback) do
+      # do something after transaction closes
+    end
+  end
+  ```
+
+- Add ability to use `let_it_be` aliases with predefined options. ([@danielwaterworth][])
+
+  ```ruby
+  TestProf::LetItBe.configure do |config|
+    config.alias_to :let_it_be_with_refind, refind: true
+  end
+  ```
+
+- Made FactoryProf measure and report on timing ([@danielwaterworth][])
 
 ## 0.8.0 (2019-04-12) 🚀
 
@@ -38,10 +89,10 @@
 
 - Improve test sampling.([@mkldon][])
 
- ```bash
- SAMPLE=10 rake test # runs 10 random test examples
- SAMPLE_GROUPS=10 rake test # runs 10 random example groups
- ```
+  ```bash
+  $ SAMPLE=10 rake test # runs 10 random test examples
+  $ SAMPLE_GROUPS=10 rake test # runs 10 random example groups
+  ```
 
 - Extend Event Prof formatter to include the absolute run time and the percentage of the event tim [#100](https://github.com/palkan/test-prof/issues/100) ([@dmagro][])
 
@@ -53,32 +104,32 @@
 
 - Add ability to ignore connection configurations in shared connection.([@palkan][])
 
-Example:
+  Example:
 
-```ruby
-# Do not use shared connection for sqlite db
-TestProf::ActiveRecordSharedConnection.ignore { |config| config[:adapter] == "sqlite3" }
-```
+  ```ruby
+  # Do not use shared connection for sqlite db
+  TestProf::ActiveRecordSharedConnection.ignore { |config| config[:adapter] == "sqlite3" }
+  ```
 
 ## 0.7.0 (2018-08-12)
 
 - **Ruby 2.3+ is required**. ([@palkan][])
 
-Ruby 2.2 EOL was on 2018-03-31.
+  Ruby 2.2 EOL was on 2018-03-31.
 
 - Upgrade RubyProf integration to `ruby-prof >= 0.17`. ([@palkan][])
 
-Use `exclude_common_methods!` instead of the deprecated `eliminate_methods!`.
+  Use `exclude_common_methods!` instead of the deprecated `eliminate_methods!`.
 
-Add RSpec specific exclusions.
+  Add RSpec specific exclusions.
 
-Add ability to specify custom exclusions through `config.custom_exclusions`, e.g.:
+  Add ability to specify custom exclusions through `config.custom_exclusions`, e.g.:
 
-```ruby
-TestProf::RubyProf.configure do |config|
-  config.custom_exclusions = {User => %i[save save!]}
-end
-```
+  ```ruby
+  TestProf::RubyProf.configure do |config|
+    config.custom_exclusions = {User => %i[save save!]}
+  end
+  ```
 
 ## 0.6.0 (2018-06-29)
 
@@ -86,25 +137,24 @@ end
 
 - Add `EventProf.monitor` to instrument arbitrary methods. ([@palkan][])
 
-Add custom instrumetation easily:
+  Add custom instrumetation easily:
 
-```ruby
-class Work
-  def do
-    # ...
+  ```ruby
+  class Work
+    def do
+      # ...
+    end
   end
-end
 
-# Instrument Work#do calls with "my.work" event
-TestProf::EventProf.monitor(Work, "my.work", :do)
-```
+  # Instrument Work#do calls with "my.work" event
+  TestProf::EventProf.monitor(Work, "my.work", :do)
+  ```
 
 [📝 Docs](https://test-prof.evilmartians.io/#/event_prof?id=profile-arbitrary-methods)
 
 - Adapterize `before_all`. ([@palkan][])
 
-Now it's possible to write your own adapter for `before_all` to manage
-transactions.
+  Now it's possible to write your own adapter for `before_all` to manage transactions.
 
 [📝 Docs](https://test-prof.evilmartians.io/#/before_all?id=database-adapters)
 
@@ -116,32 +166,32 @@ transactions.
 
 - Show top `let` declarations per example group in RSpecDissect profiler. ([@palkan][])
 
-The output now includes the following information:
+  The output now includes the following information:
 
-```
-Top 5 slowest suites (by `let` time):
+  ```
+  Top 5 slowest suites (by `let` time):
 
-FunnelsController (./spec/controllers/funnels_controller_spec.rb:3) – 00:38.532 of 00:43.649 (133)
- ↳ user – 3
- ↳ funnel – 2
-ApplicantsController (./spec/controllers/applicants_controller_spec.rb:3) – 00:33.252 of 00:41.407 (222)
- ↳ user – 10
- ↳ funnel – 5
- ```
+  FunnelsController (./spec/controllers/funnels_controller_spec.rb:3) – 00:38.532 of 00:43.649 (133)
+  ↳ user – 3
+  ↳ funnel – 2
+  ApplicantsController (./spec/controllers/applicants_controller_spec.rb:3) – 00:33.252 of 00:41.407 (222)
+  ↳ user – 10
+  ↳ funnel – 5
+  ```
 
-Enabled by default. Disable it with:
+  Enabled by default. Disable it with:
 
-```ruby
-TestProf::RSpecDissect.configure do |config|
-  config.let_stats_enabled = false
-end
-```
+  ```ruby
+  TestProf::RSpecDissect.configure do |config|
+    config.let_stats_enabled = false
+  end
+  ```
 
 - [Fix [#80](https://github.com/palkan/test-prof/issues/80)] Added ability to preserve traits. ([@Vasfed][])
 
-Disabled by default for compatibility. Enable globally by `FactoryDefault.preserve_traits = true` or for single `create_default`: `create_default(:user, preserve_traits: true)`
+  Disabled by default for compatibility. Enable globally by `FactoryDefault.preserve_traits = true` or for single `create_default`: `create_default(:user, preserve_traits: true)`
 
-When enabled - default object will be used only when there's no [traits](https://github.com/thoughtbot/factory_bot/blob/master/GETTING_STARTED.md#traits) in association.
+  When enabled - default object will be used only when there's no [traits](https://github.com/thoughtbot/factory_bot/blob/master/GETTING_STARTED.md#traits) in association.
 
 - Add ability to run only `let` or `before` profiler with RSpecDissect. ([@palkan][])
 
@@ -151,8 +201,8 @@ When enabled - default object will be used only when there's no [traits](https:/
 
 - [Fix [#75](https://github.com/palkan/test-prof/issues/75)] Fix `RSpec/Aggregate` failures with non-regular examples. ([@palkan][])
 
-Do not take into account `xit`, `pending`, `its`, etc. examples,
-only consider regular `it`, `specify`, `scenario`, `example`.
+  Do not take into account `xit`, `pending`, `its`, etc. examples,
+  only consider regular `it`, `specify`, `scenario`, `example`.
 
 ## 0.5.0 (2018-04-25)
 
@@ -160,78 +210,78 @@ only consider regular `it`, `specify`, `scenario`, `example`.
 
 - Add events support to TagProf. ([@palkan][])
 
-Example usage:
+  Example usage:
 
-```sh
-TAG_PROF=type TAG_PROF_EVENT=sql.active_record rspec
-```
+  ```sh
+  TAG_PROF=type TAG_PROF_EVENT=sql.active_record rspec
+  ```
 
-[📝 Docs](https://test-prof.evilmartians.io/#/tag_prof?id=profiling-events)
+  [📝 Docs](https://test-prof.evilmartians.io/#/tag_prof?id=profiling-events)
 
 - Add logging helpers for Rails. ([@palkan][])
 
-Enalbe verbose logging globally:
+  Enable verbose logging globally:
 
-```sh
-LOG=all rspec
-```
+  ```sh
+  LOG=all rspec
+  ```
 
-Or per example (group):
+  Or per example (group):
 
-```ruby
-it "does smth weird", :log do
-  # ...
-end
-```
+  ```ruby
+  it "does smth weird", :log do
+    # ...
+  end
+  ```
 
-[📝 Docs](https://test-prof.evilmartians.io/#/logging)
+  [📝 Docs](https://test-prof.evilmartians.io/#/logging)
 
 - Add HTML report for `TagProf`. ([@palkan][])
 
-Generate HTML report by setting `TAG_PROF_FORMAT` to `html`.
+  Generate HTML report by setting `TAG_PROF_FORMAT` to `html`.
 
 - Add ability to track multiple events at the same time with `EventProf`. ([@palkan][])
 
 - Add `AnyFixture` DSL. ([@palkan][])
 
-Example:
+  Example:
 
-```ruby
-# Enable DSL
-using TestProf::AnyFixture::DSL
+  ```ruby
+  # Enable DSL
+  using TestProf::AnyFixture::DSL
 
-# and then you can use `fixture` method (which is just an alias for `TestProf::AnyFixture.register`)
-before(:all) { fixture(:account) }
+  # and then you can use `fixture` method (which is just an alias for `TestProf::AnyFixture.register`)
+  before(:all) { fixture(:account) }
 
-# You can also use it to fetch the record (instead of storing it in instance variable)
-let(:account) { fixture(:account) }
-```
+  # You can also use it to fetch the record (instead of storing it in instance variable)
+  let(:account) { fixture(:account) }
+  ```
 
-[📝 Docs](https://test-prof.evilmartians.io/#/any_fixture?id=dsl)
+  [📝 Docs](https://test-prof.evilmartians.io/#/any_fixture?id=dsl)
 
 - Add `AnyFixture` usage report. ([@palkan][])
 
-Enable `AnyFixture` usage reporting with `ANYFIXTURE_REPORTING=1` or with:
+  Enable `AnyFixture` usage reporting with `ANYFIXTURE_REPORTING=1` or with:
 
-```ruby
-TestProf::AnyFixture.reporting_enabled = true
-```
+  ```ruby
+  TestProf::AnyFixture.reporting_enabled = true
+  ```
 
-[📝 Docs](https://test-prof.evilmartians.io/#/any_fixture?id=usage-report)
+  [📝 Docs](https://test-prof.evilmartians.io/#/any_fixture?id=usage-report)
 
 - Add `ActiveRecordSharedConnection` recipe. ([@palkan][])
 
-Force ActiveRecord to use the same connection between threads (to avoid database cleaning in browser tests).
+  Force ActiveRecord to use the same connection between threads (to avoid database cleaning in browser tests).
 
-[📝 Docs](https://test-prof.evilmartians.io/#/active_record_shared_connection)
+  [📝 Docs](https://test-prof.evilmartians.io/#/active_record_shared_connection)
 
 - [#70](https://github.com/palkan/test-prof/pull/70) Add `FactoryAllStub` recipe. ([@palkan][])
 
-[📝 Docs](https://test-prof.evilmartians.io/#/factory_all_stub)
+  [📝 Docs](https://test-prof.evilmartians.io/#/factory_all_stub)
 
 - Add `ActiveRecordRefind` refinement. ([@palkan][])
 
-[📝 Docs](https://test-prof.evilmartians.io/#/any_fixture?id=activerecordrefind)
+  [📝 Docs](https://test-prof.evilmartians.io/#/any_fixture?id=activerecordrefind)
 
 ### Fixes & Improvements
 
@@ -295,15 +345,15 @@ Force ActiveRecord to use the same connection between threads (to avoid database
 
 - [#44](https://github.com/palkan/test-prof/pull/44) Support older versions of RSpec. ([@palkan][])
 
-Support RSpec 3.1.0+ in general.
+  Support RSpec 3.1.0+ in general.
 
-`let_it_be` supports only RSpec 3.3.0+.
+  `let_it_be` supports only RSpec 3.3.0+.
 
-RSpecDissect `let` tracking 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
+  It is possible now to use Factory Doctor with Minitest
 
 ## 0.4.0 (2017-10-03)
 
@@ -311,7 +361,7 @@ It is possible now to use Factory Doctor with Minitest
 
 - [#29](https://github.com/palkan/test-prof/pull/29) EventProf Minitest integration. ([@IDolgirev][])
 
-It is possible now to use Event Prof with Minitest
+  It is possible now to use Event Prof with Minitest
 
 - [#30](https://github.com/palkan/test-prof/pull/30) Fabrication support for FactoryProf. ([@Shkrt][])
 
@@ -323,26 +373,25 @@ FactoryProf now also accounts objects created by Fabrication gem (in addition to
 
 - Combine RSpecStamp with FactoryDoctor. ([@palkan][])
 
-Automatically mark _bad_ examples with custom tags.
+  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:
+  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 ...
-```
+  ```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.
+  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.
+  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`).
+  Just like `let`, but persist the result for the whole group (i.e. `let` + `before_all`).
 
 ### Improvements:
 
@@ -362,7 +411,7 @@ Just like `let`, but persist the result for the whole group (i.e. `let` + `befor
 
 - EventProf: Fix regression bug with examples profiling. ([@palkan][])
 
-There was a bug when an event occurs before the example has started (e.g. in `before(:context)` hook).
+  There was a bug when an event occurs before the example has started (e.g. in `before(:context)` hook).
 
 ## 0.2.3 (2017-08-28)
 
@@ -372,8 +421,7 @@ There was a bug when an event occurs before the example has started (e.g. in `be
 
 - Fix time calculation when Time class is monkey-patched. ([@palkan][])
 
-Add `TestProf.now` method which is just a copy of original `Time.now` and
-use it everywhere.
+  Add `TestProf.now` method which is just a copy of original `Time.now` and use it everywhere.
 
 Fixes [#10](https://github.com/palkan/test-prof/issues/10).
 
@@ -381,17 +429,17 @@ Fixes [#10](https://github.com/palkan/test-prof/issues/10).
 
 - Detect `RSpec` by checking the presence of `RSpec::Core`. ([@palkan][])
 
-Fixes [#8](https://github.com/palkan/test-prof/issues/8).
+  Fixes [#8](https://github.com/palkan/test-prof/issues/8).
 
 ## 0.2.0 (2017-08-18)
 
 - Ensure output directory exists. ([@danielwestendorf][])
 
-**Change default output dir** to "tmp/test_prof".
+  **Change default output dir** to "tmp/test_prof".
 
-Rename `#artefact_path` to `#artifact_path` to be more US-like
+  Rename `#artefact_path` to `#artifact_path` to be more US-like
 
-Ensure output dir exists in `#artifact_path` method.
+  Ensure output dir exists in `#artifact_path` method.
 
 - FactoryDoctor: print success message when no bad examples found. ([@palkan][])
 
@@ -414,3 +462,4 @@ Ensure output dir exists in `#artifact_path` method.
 [@szemek]: https://github.com/szemek
 [@mkldon]: https://github.com/mkldon
 [@dmagro]: https://github.com/dmagro
+[@danielwaterworth]: https://github.com/danielwaterworth

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 palkan
+Copyright (c) 2017-2019 palkan
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal