File: CHANGELOG.md

package info (click to toggle)
ruby-test-prof 1.5.2%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 660 kB
  • sloc: ruby: 6,064; makefile: 4
file content (491 lines) | stat: -rw-r--r-- 14,455 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
# Change log

## master (unreleased)

## 1.5.2 (2026-02-03)

- Avoid using `Gem.loaded_specs` methods in RuboCop plugin version check. ([@Rylan12][])

## 1.5.1 (2026-01-27)

- Fix RuboCop plugin. ([@palkan][])

Now you should use `--plugin test-prof` or `plugins: [test-prof]` (in YAML) (so LintRoller can correctly obtain the plugin class name from the gemspec).

## 1.5.0 (2025-12-04)

- Logging: support Rails 8.2 structured events based logging. ([@palkan][])

- Allow using AnyFixture DSL through module inclusion, not refinements. ([@palkan][])

In Rails 7.2+, refined `#fixture` no longer works since there is a same-called method. So, from now on we recommend including the DSL module, instead of _using_ it.

## 1.4.5. (2025-05-09) 🎇

- FactoryProf: Add truncate_names configuration parameter. ([@skaestle][])

- Update Rubocop setup to support new plugins system. ([@julianpasquale])

Now you can truncate long factory-names when using the simple output mode.

Set `FPROF_TRUNCATE_NAMES=1` env var or set it through `FactoryProf` configuration:

```ruby
TestProf::FactoryProf.configure do |config|
  config.truncate_names = true
end
```

## 1.4.4 (2025-01-03)

- Fix _stamping_ specs with single quotes with RSpec Stamp. ([@elasticspoon][])

## 1.4.3 (2024-12-18)

- Fix handling new (lazy) connection pools in `before_all`. ([@palkan][])

- Updates Rubocop::Cop code to comply with most modern API. ([@aseroff][])

## 1.4.2 (2024-09-03) 🗓️

- Ignore default scopes in `ActiveRecord::Base#refind`. ([@palkan][])

## 1.4.1 (2024-08-23)

- Skips loading the ActiveRecord adapter for runs where RSpec --dry-run mode is enabled. ([@devinburnette][])

## 1.4.0 (2024-08-12)

- AnyFixture: Disable fixtures cache within _clean fixture_ context. Automatically _refind_ records when using `#fixture`. ([@palkan][])

- Add new TPS (tests per second) profiler. ([@palkan][])

- FactoryDefault: add Fabrication support. ([@palkan][])

- Drop support for **Ruby <2.7** and **Rails <6**.

- FactoryDefault: Add `#get_factory_default`. [[@john-h-k][]]

- Add variations information to FactorProf reports. ([@lHydra][])

Get info on traits/overrides used by running `FPROF=1 FPROF_VARS=1 <your test command>`.

- Add support for `report_duplicates` config option for `let_it_be` ([@lHydra][])

- Support latest Timecop patching `Process.clock_gettime`. ([@palkan][])

- Vernier: Add hooks configuration parameter. ([@lHydra][])

Now you can add more insights to the resulting report by adding event markers from Active Support Notifications.
To do this, specify the `TEST_VERNIER_HOOKS=rails` env var or set it through `Vernier` configuration:

```ruby
TestProf::Vernier.configure do |config|
  config.hooks = :rails
end
```

- FactoryProf: Add threshold configuration parameter. ([@lHydra][])

Now you can ignore factories which total number of calls is less than the provided threshold. To do this, specify
the `FPROF_THRESHOLD=30` env var or set it through `FactoryProf` configuration:

```ruby
TestProf::FactoryProf.configure do |config|
  config.threshold = 30
end
```

## 1.3.3 (2024-04-19)

- Fix MemProf bugs. ([@palkan][])

## 1.3.2 (2024-03-08) 🌷

- Add Minitest support for TagProf. ([@lioneldebauge][])

## 1.3.1 (2023-12-12)

- Add support for dumping FactoryProf results in JSON format. ([@uzushino][])

## 1.3.0 (2023-11-21)

- Add Vernier integration. ([@palkan][])

- StackProf uses JSON format by default. ([@palkan][])

- MemoryProf ia added. ([@Vankiru][])

## 1.2.3 (2023-09-11)

- Minor fixes and dependencies upgrades.

## 1.2.2 (2023-06-27)

- Ignore inaccessible connection pools in `before_all`. ([@bf4][])

See [#267](https://github.com/test-prof/test-prof/pull/267).

## 1.2.1 (2023-03-22)

- Fix regression with `before_all(setup_fixtures: true)` and `rspec-rails` v6.0+. ([@palkan][])

- Upgrade to RubyProf 1.4+. ([@palkan][])

## 1.2.0 (2023-02-07)

- Add support for multiple databases to `before_all` / `let_it_be` with Active Record. ([@rutgerw][])

## 1.1.0 (2022-12-06)

- LetItBe: freeze records during initialization with `freeze: true`. ([@palkan][])

- Add FactoryDefault profiler (factory associations profilers). ([@palkan][])

- FactoryDefault: Allow creating a default per trait (or set of traits). ([@palkan][])

Now `create_default(:user)` and `create_default(:user, :admin)` would result into two defaults corresponding to the specified traits.

- FactoryDefault: Add stats support. ([@palkan][])

Now you can see how often the default factory values have been used by specifying
the `FACTORY_DEFAULT_SUMMARY=1` or `FACTORY_DEFAULT_STATS=1` env var.

- Support using FactoryDefault with before_all/let_it_be. ([@palkan][])

Currently, RSpec only. Default factories created within `before_all` or `let_it_be` are not reset 'till the end of the corresponding context. Thus, now it's possible to use `create_default` within `let_it_be` without any additional hacks.

- FactoryDefault: Add `preserve_attributes = false | true` option. ([@palkan][])

Allow skipping defaults if association is defined with overrides, e.g.:

```ruby
factory :post do
  association :user, name: "Post Author"
end
```

- FactoryDefault: Add `skip_factory_default(&block)` to temporary disable default factories. ([@palkan][])

You can also use `TestProf::FactoryDefault.disable!(&block)`.

- Add support for global `before_all` tags ([@maxshend][])

```ruby
TestProf::BeforeAll.configure do |config|
  config.before(:begin, reset_sequences: true, foo: :bar) do
    warn <<~MESSAGE
      Do NOT create objects outside of transaction
      because all db sequences will be reset to 1
      in every single example, so that IDs of new objects
      can get into conflict with the long-living ones.
    MESSAGE
  end
end
```

## 1.0.11 (2022-10-27)

- Fix monitoring methods with keyword args in Ruby 3+. ([@palkan][])

- Disable garbage collection frames when `TEST_STACK_PROF_IGNORE_GC` env variable is set ([@cbliard][])

- Fixed restoring lock_thread value in nested contexts ([@ygelfand][])

## 1.0.10 (2022-08-12)

- Allow overriding global logger. ([@palkan][])

```ruby
require "test_prof/recipes/logging"

TestProf::Rails::LoggingHelpers.logger = CustomLogger.new
```

## 1.0.9 (2022-05-05)

- Add `AnyFixture.before_fixtures_reset` and `AnyFixture.after_fixtures_reset` callbacks. ([@ruslanshakirov][])

- Fixes ActiveRecord 6.1 issue with AnyFixture and Postgres config ([@markedmondson][])

## 1.0.8 (2022-03-11)

- Restore the lock_thread value after rollback. ([@cou929][])

- Fixes the configuration of a printer for factory_prof runs

- Ensure that defaults are stored in a threadsafe manner

## 1.0.7 (2021-08-30)

- Fix access to `let_it_be` variables in `after(:all)` hook. ([@cbarton][])

- Add support for using the before_all hook with Rails' parallelize feature (using processes). ([@peret][])

Make sure to include `TestProf::BeforeAll::Minitest` before you call `parallelize`.

## 1.0.6 (2021-06-23)

- Fix Spring detection when `DISABLE_SPRING=1` is used. ([@palkan][])

- Make `before_all` in Minitest inheritable. ([@palkan][])

## 1.0.5 (2021-05-13)

- Fix logging regression when no newline has been added. ([@palkan][])

## 1.0.4 (2021-05-12)

- Add ability to use custom logger. ([@palkan][])

```ruby
TestProf.configure do |config|
  config.logger = Logger.new($stdout, level: Logger::WARN)
end
```

- Add `nate_heckler` mode for FactoryProf. ([@palkan][])

Drop this into your `rails_helper.rb` or `test_helper.rb`:

```ruby
require "test_prof/factory_prof/nate_heckler"
```

And for every test run see the overall factories usage:

```sh
[TEST PROF INFO] Time spent in factories: 04:31.222 (54% of total time)
```

## 1.0.3 (2021-04-30)

- Minor fixes.

## 1.0.2 (2021-02-26)

- Make `before_all(setup_fixtures: true)` compatible with Rails 6.1. ([@palkan][])

## 1.0.1 (2021-02-12)

- Fixed AnyFixture deprecation warning.

## 1.0.0 (2021-01-21)

## 1.0.0.rc2 (2021-01-06)

- Make Rails fixtures accessible in `before_all`. ([@palkan][])

You can load and access fixtures when explicitly enabling them via `before_all(setup_fixtures: true, &block)`.

- Minitest's `before_all` is not longer experimental. ([@palkan][])

- Add `after_all` to Minitest in addition to `before_all`. ([@palkan][])

## 1.0.0.rc1 (2020-12-30)

- Remove deprecated `AggregateFailures` cop. ([@palkan][])

- Remove `ActiveRecordSharedConnection`. ([@palkan][])

- Add `AnyFixture#register_dump` to _cache_ fixtures using SQL dumps. ([@palkan][])

- Replaced `TestProf::AnyFixture.reporting_enabled = true` with `TestProf::AnyFixture.config.reporting_enabled = true`. ([@palkan][])

- Add support for RSpec aliases detection when linting specs using `let_it_be`/`before_all` with `rubocop-rspec` 2.0 ([@pirj][])

## 0.12.2 (2020-09-03)

- Execute Minitest `before_all` in the context of the current test object. ([@palkan][])

## 0.12.1 (2020-09-01)

- Minor improvements.

## 0.12.0 (2020-07-17)

- Add state leakage detection for `let_it_be`. ([@pirj][], [@jaimerson][], [@alexvko][])

- Add default let_it_be modifiers configuration. ([@palkan][])

You can configure global modifiers:

```ruby
TestProf::LetItBe.configure do |config|
  # Make refind activated by default
  config.default_modifiers[:refind] = true
end
```

Or for specific contexts via tags:

```ruby
context "with let_it_be reload", let_it_be_modifiers: {reload: true} do
  # examples
end
```

- **Drop Ruby 2.4 support.** ([@palkan][])

- SAMPLE and SAMPLE_GROUP work consistently with seed in RSpec and Minitest. ([@stefkin][])

- Make sure EventProf is not affected by time freezing. ([@palkan][])

  EventProf results now is not affected by `Timecop.freeze` or similar.

  See more in [#181](https://github.com/test-prof/test-prof/issues/181).

- Adds the ability to define stackprof interval sampling by using `TEST_STACK_PROF_INTERVAL` env variable ([@LynxEyes][])

  Now you can use `$ TEST_STACK_PROF=1 TEST_STACK_PROF_INTERVAL=10000 rspec` to define a custom interval (in microseconds).

## 0.11.3 (2020-02-11)

- Disable `RSpec/AggregateFailures` by default. ([@pirj][])

## 0.11.2 (2020-02-11)

- Fix RuboCop integration regressions. ([@palkan][])

## 0.11.1 (2020-02-10)

- Add `config/` to the gem contents. ([@palkan][])

Fixes RuboCop integration regression from 0.11.0.

## 0.11.0 (2020-02-09)

- Fix `let_it_be` issue when initialized with an array/enumerable or an AR relation. ([@pirj][])

- Improve `RSpec/AggregateExamples` (formerly `RSpec/AggregateFailures`) cop. ([@pirj][])

## 0.10.2 (2020-01-07) 🎄

- Fix Ruby 2.7 deprecations. ([@lostie][])

## 0.10.1 (2019-10-17)

- Fix AnyFixture DSL when using with Rails 6.1+. ([@palkan][])

- Fix loading `let_it_be` without ActiveRecord present. ([@palkan][])

- Fix compatibility of `before_all` with [`isolator`](https://github.com/palkan/isolator) gem to handle correct usages of non-atomic interactions outside DB transactions. ([@Envek][])

- Updates FactoryProf to show the amount of time taken per factory call. ([@tyleriguchi][])

## 0.10.0 (2019-08-19)

- Use RSpec example ID instead of full description for RubyProf/Stackprof report names. ([@palkan][])

For more complex scenarios feel free to use your own report name generator:

```ruby
# for RubyProf
TestProf::RubyProf::Listener.report_name_generator = ->(example) { "..." }
# for Stackprof
TestProf::StackProf::Listener.report_name_generator = ->(example) { "..." }
```

- Support arrays in `let_it_be` with modifiers. ([@palkan][])

```ruby
# Now you can use modifiers with arrays
let_it_be(:posts, reload: true) { create_pair(:post) }
```

- Refactor `let_it_be` modifiers and allow adding custom modifiers. ([@palkan][])

```ruby
TestProf::LetItBe.config.register_modifier :reload do |record, val|
  # ignore when `reload: false`
  next record unless val
  # ignore non-ActiveRecord objects
  next record unless record.is_a?(::ActiveRecord::Base)
  record.reload
end
```

- Print warning when `ActiveRecordSharedConnection` is used in the version of Rails
  supporting `lock_threads` (5.1+). ([@palkan][])

## 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][])

See [changelog](https://github.com/test-prof/test-prof/blob/v0.8.0/CHANGELOG.md) for versions <0.9.0.

[@palkan]: https://github.com/palkan
[@danielwaterworth]: https://github.com/danielwaterworth
[@envek]: https://github.com/Envek
[@tyleriguchi]: https://github.com/tyleriguchi
[@lostie]: https://github.com/lostie
[@pirj]: https://github.com/pirj
[@lynxeyes]: https://github.com/LynxEyes
[@stefkin]: https://github.com/stefkin
[@jaimerson]: https://github.com/jaimerson
[@alexvko]: https://github.com/alexvko
[@cou929]: https://github.com/cou929
[@ruslanshakirov]: https://github.com/ruslanshakirov
[@ygelfand]: https://github.com/ygelfand
[@cbliard]: https://github.com/cbliard
[@maxshend]: https://github.com/maxshend
[@rutgerw]: https://github.com/rutgerw
[@markedmondson]: https://github.com/markedmondson
[@cbarton]: https://github.com/cbarton
[@peret]: https://github.com/peret
[@bf4]: https://github.com/bf4
[@Vankiru]: https://github.com/Vankiru
[@uzushino]: https://github.com/uzushino
[@lioneldebauge]: https://github.com/lioneldebauge
[@lHydra]: https://github.com/lHydra
[@john-h-k]: https://github.com/john-h-k
[@devinburnette]: https://github.com/devinburnette
[@elasticspoon]: https://github.com/elasticspoon
[@Rylan12]: https://github.com/Rylan12