test-prof 0.4.9 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34e45def589431c2dd53ec256e009877c9a611ad1fa1cd7799cf6ec75c15745c
-  data.tar.gz: 2230613ed9c7e5bf9733a16824f7e61daa77ed524b846de4195168e89a8b5d0e
+  metadata.gz: bc2f073e4331955ed514e20849bb5dadf28d4f5934254ae3d30ca2c60db90ff0
+  data.tar.gz: d07ba0a976611946258de85284b697d0ccf7adbdeaae0363efebd868156100e4
 SHA512:
-  metadata.gz: 176beb48fdd32511a3516bcd28392cc9b9677b7cc6b1946c25f83111eeb1c0b4602387913bda61a9524c7211d044c1c16cf47d6a48fbadf803145e660d7e03ff
-  data.tar.gz: ed688acfb83aae1e7906c01daf363f676d72109cb3f29cfb04923288fba3b0af89c1d72d1e544d7887a940bee2fde79b7f5bb35a4a364a88fa728e3f178e77f4
+  metadata.gz: c942589dbd72c954f54a4cb874d91f98a2c9a64c604fb82b32476bcf2ea9b82fbfa72222e32b0cfec52fc1b335b2c9e69d99567be21e91b8084005a94ed9963a
+  data.tar.gz: e90718e07df7b566c657c9192805a4a1f523196578699f7cbc93f3cf25ddf09634bcb0bda35e5e18a9f1501708e583748df4575b721c20886605ca1c863efff6

data/CHANGELOG.md

@@ -2,7 +2,93 @@
 
 ## master
 
-## 0.4.9
+## 0.5.0 (2018-04-25)
+
+### Features
+
+- Add events support to TagProf. ([@palkan][])
+
+Example usage:
+
+```sh
+TAG_PROF=type TAG_PROF_EVENT=sql.active_record rspec
+```
+
+[📝 Docs](https://test-prof.evilmartians.io/#/tag_prof?id=profiling-events)
+
+- Add logging helpers for Rails. ([@palkan][])
+
+Enalbe verbose logging globally:
+
+```sh
+LOG=all rspec
+```
+
+Or per example (group):
+
+```ruby
+it 'does smth weird', :log do
+  # ...
+end
+```
+
+[📝 Docs](https://test-prof.evilmartians.io/#/logging)
+
+- Add HTML report for `TagProf`. ([@palkan][])
+
+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:
+
+```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) }
+
+# 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)
+
+- Add `AnyFixture` usage report. ([@palkan][])
+
+Enable `AnyFixture` usage reporting with `ANYFIXTURE_REPORTING=1` or with:
+
+```ruby
+TestProf::AnyFixture.reporting_enabled = true
+```
+
+[📝 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).
+
+[📝 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)
+
+- Add `ActiveRecordRefind` refinement. ([@palkan][])
+
+[📝 Docs](https://test-prof.evilmartians.io/#/any_fixture?id=activerecordrefind)
+
+### Fixes & Improvements
+
+- **Brand new documentatation website: https://test-prof.evilmartians.io/**
+
+- Disable referential integrity when cleaning AnyFixture. ([@palkan][])
+
+
+## 0.4.9 (2018-03-20)
 
 - [Fix [#64](https://github.com/palkan/test-prof/issues/64)] Fix dependencies requiring for FactoryDefault. ([@palkan][])
 
@@ -11,7 +97,7 @@
   Consider only `example_failed` and `example_passed` to ensure that the `run_time`
   is available.
 
-## 0.4.8
+## 0.4.8 (2018-01-17)
 
 - Add `minitest` 5.11 support. ([@palkan][])
 
@@ -24,36 +110,36 @@
 
   Possibly fixes [#47](https://github.com/palkan/test-prof/issues/47).
 
-## 0.4.7
+## 0.4.7 (2017-12-25)
 
 - [#57](https://github.com/palkan/test-prof/pull/57) Fix RubyProf Printers Support ([@rabotyaga][])
 
-## 0.4.6
+## 0.4.6 (2017-12-17)
 
 - Upgrade RSpec/AggregateFailures to RuboCop 0.52.0. ([@palkan][])
 
   RuboCop < 0.51.0 is not supported anymore.
 
-- [Fixes [#49](https://github.com/palkan/test-prof/issues/49)] Correcly detect RSpec version in `let_it_be`. ([@desoleary][])
+- [Fixes [#49](https://github.com/palkan/test-prof/issues/49)] Correctly detect RSpec version in `let_it_be`. ([@desoleary][])
 
-## 0.4.5
+## 0.4.5 (2017-12-09)
 
 - Fix circular require in `lib/factory_doctor/minitest`. ([@palkan][])
 
-## 0.4.4
+## 0.4.4 (2017-11-08)
 
 - [Fixes [#48](https://github.com/palkan/test-prof/issues/48)] Respect RubyProf reports files extensions. ([@palkan][])
 
-## 0.4.3
+## 0.4.3 (2017-10-26)
 
 - [#46](https://github.com/palkan/test-prof/pull/46) Support FactoryBot, which is [former FactoryGirl](https://github.com/thoughtbot/factory_bot/pull/1051),
   while maintaining compatibility with latter. ([@Shkrt][])
 
-## 0.4.2
+## 0.4.2 (2017-10-23)
 
 - Fix bug with multiple `before_all` within one group. ([@palkan][])
 
-## 0.4.1
+## 0.4.1 (2017-10-18)
 
 - [#44](https://github.com/palkan/test-prof/pull/44) Support older versions of RSpec. ([@palkan][])
 
@@ -67,7 +153,7 @@ RSpecDissect `let` tracking supports only RSpec 3.3.0+.
 
 It is possible now to use Factory Doctor with Minitest
 
-## 0.4.0
+## 0.4.0 (2017-10-03)
 
 ### Features:
 
@@ -79,7 +165,7 @@ It is possible now to use Event Prof with Minitest
 
 FactoryProf now also accounts objects created by Fabrication gem (in addition to FactoryGirl)
 
-## 0.3.0
+## 0.3.0 (2017-09-21)
 
 ### Features:
 
@@ -116,21 +202,21 @@ Just like `let`, but persist the result for the whole group (i.e. `let` + `befor
 
 - Use RubyProf `FlatPrinter` by default (was `CallStackPrinter`). ([@palkan][])
 
-## 0.2.5
+## 0.2.5 (2017-08-30)
 
 - [#16](https://github.com/palkan/test-prof/pull/16) Support Ruby >= 2.2.0 (was >= 2.3.0). ([@palkan][])
 
-## 0.2.4
+## 0.2.4 (2017-08-29)
 
 - 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).
 
-## 0.2.3
+## 0.2.3 (2017-08-28)
 
 - Minor improvements. ([@palkan][])
 
-## 0.2.2
+## 0.2.2 (2017-08-23)
 
 - Fix time calculation when Time class is monkey-patched. ([@palkan][])
 
@@ -139,13 +225,13 @@ use it everywhere.
 
 Fixes [#10](https://github.com/palkan/test-prof/issues/10).
 
-## 0.2.1
+## 0.2.1 (2017-08-19)
 
 - Detect `RSpec` by checking the presence of `RSpec::Core`. ([@palkan][])
 
 Fixes [#8](https://github.com/palkan/test-prof/issues/8).
 
-## 0.2.0
+## 0.2.0 (2017-08-18)
 
 - Ensure output directory exists. ([@danielwestendorf][])
 
@@ -157,11 +243,11 @@ Ensure output dir exists in `#artifact_path` method.
 
 - FactoryDoctor: print success message when no bad examples found. ([@palkan][])
 
-## 0.1.1
+## 0.1.1 (2017-08-17)
 
 - AnyFixture: clean tables in reverse order to not fail when foreign keys exist. ([@marshall-lee][])
 
-## 0.1.0
+## 0.1.0 (2017-08-15)
 
 - Initial version. ([@palkan][])
 

data/README.md

@@ -1,9 +1,10 @@
-[![Gem Version](https://badge.fury.io/rb/test-prof.svg)](https://rubygems.org/gems/test-prof) [![Build Status](https://travis-ci.org/palkan/test-prof.svg?branch=master)](https://travis-ci.org/palkan/test-prof) [![CircleCI](https://circleci.com/gh/palkan/test-prof.svg?style=svg)](https://circleci.com/gh/palkan/test-prof) [![Code Triagers Badge](https://www.codetriage.com/palkan/test-prof/badges/users.svg)](https://www.codetriage.com/palkan/test-prof)
+[![Gem Version](https://badge.fury.io/rb/test-prof.svg)](https://rubygems.org/gems/test-prof) [![Build Status](https://travis-ci.org/palkan/test-prof.svg?branch=master)](https://travis-ci.org/palkan/test-prof) [![Code Triagers Badge](https://www.codetriage.com/palkan/test-prof/badges/users.svg)](https://www.codetriage.com/palkan/test-prof)
+[![Documentation](https://img.shields.io/badge/docs-link-brightgreen.svg)](https://test-prof.evilmartians.io)
 
 # Ruby Tests Profiling Toolbox
 
 <img align="right" height="150" width="129"
-     title="TestProf logo" src="./assets/logo.svg">
+     title="TestProf logo" src="./docs/assets/images/logo.svg">
 
 TestProf is a collection of different tools to analyze your test suite performance.
 
@@ -23,11 +24,11 @@ TestProf toolbox aims to help you identify bottlenecks in your test suite. It co
 
 - etc.
 
-Of course, we have some [solutions](#tips-and-tricks-or-recipes) for common performance issues too, bundled into the gem.
+Of course, we have some [solutions](https://test-prof.evilmartians.io/#/?id=recipes) for common performance issues too, bundled into the gem.
 
-[![](https://s3-us-west-1.amazonaws.com/vladem/test-prof/TestProf.png)](https://coggle.it/diagram/Wa7tW-87jAAB0ExN)
+[![](./docs/assets/images/coggle.png)](http://bit.ly/test-prof-map)
 
-See [Table of Contents](#table-of-contents) for more.
+📑 [Documentation](https://test-prof.evilmartians.io)
 
 Supported Ruby versions:
 
@@ -60,65 +61,17 @@ end
 
 And that's it)
 
-## Table of Contents
+## Usage
 
-Checkout our guides for each specific tool:
-
-- [RubyProf Integration](https://github.com/palkan/test-prof/tree/master/guides/ruby_prof.md)
-
-- [StackProf Integration](https://github.com/palkan/test-prof/tree/master/guides/stack_prof.md)
-
-- [Event Profiler](https://github.com/palkan/test-prof/tree/master/guides/event_prof.md) (e.g. ActiveSupport notifications)
-
-- [Tag Profiler](https://github.com/palkan/test-prof/tree/master/guides/tag_prof.md)
-
-- [Factory Doctor](https://github.com/palkan/test-prof/tree/master/guides/factory_doctor.md)
-
-- [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_)
-
-We also want to share some small code tricks which can help you to improve your test suite performance and efficiency:
-
-- [`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)
-
-- [RSpec Stamp](https://github.com/palkan/test-prof/tree/master/guides/rspec_stamp.md)
-
-- [Tests Sampling](https://github.com/palkan/test-prof/tree/master/guides/tests_sampling.md)
-
-## Configuration
-
-TestProf global configuration is used by most of the profilers:
-
-```ruby
-TestProf.configure do |config|
-  # the directory to put artifacts (reports) in ("tmp/test_prof" by default)
-  config.output_dir = "tmp/test_prof"
-
-  # use unique filenames for reports (by simply appending current timestamp)
-  config.timestamps = true
-
-  # color output
-  config.color = true
-end
-```
+Check out our [docs][].
 
 ## What's next?
 
-
 Have an idea? [Propose](https://github.com/palkan/test-prof/issues/new) a feature request!
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[docs]: https://test-prof.evilmartians.io