simplecov 0.17.1 → 0.18.0.beta1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6f3e7730302a3a31266a22a830aa6a098e17cc4042f664e4f9a079eef408897f
4
- data.tar.gz: 423ed5a50493415c4c8bb17ff9c82ffd84e75dc98fc14cc0b4e82f17491d483e
3
+ metadata.gz: 8dd6ab6b1c33e8b2503dc00691a8ae500ae0caf885fc2dba52bbe102d696d926
4
+ data.tar.gz: 41c70724c0beb18bd66f665cb078a8b9cf95d1dbb770bf1eb0601156c12370e0
5
5
  SHA512:
6
- metadata.gz: 5b46e9d714b0a675de3b2e42284069942479af4fb0df627b3806fb48e8d373ea7f555fc8cf482682e15e8a6e335ea82358e4b4db28b1257183ae22d018c17f21
7
- data.tar.gz: 82eedda10bb5786656190ec0ca7dd1a3e18c38f6526db25f90c9b614849e05a14b85a34257343c5f48f62cffc7ddbdb74505b896a7c72236992aadd83c945a24
6
+ metadata.gz: ba1dcb50ce7ef6765a9f519bda006388d587c67cd103bcf6d0f4bd4d4427ebef240de13772e8925f62d70dd232310bd705b66fbda1c39c25444dcd329b9dedc1
7
+ data.tar.gz: cc1160ba31aa5ecdcb46a255e3147e78f649789d542d1363343fec803ec9c5c96759272990ba67ceb75a0a07116325f962a69354d8a01477a905b491bba86275
@@ -1,3 +1,27 @@
1
+ 0.18.0.beta1 (2020-01-05)
2
+ ===================
3
+
4
+ This is a huge release highlighted by changing our support for ruby versions to 2.4+ (so things that aren't EOL'ed) and finally adding branch coverage support!
5
+
6
+ This release is still beta because we'd love for you to test out branch coverage and get your feedback before doing a full release.
7
+
8
+ On a personal note from [@PragTob](https://github.com/PragTob/) thanks to [ruby together](https://rubytogether.org/) for sponsoring this work on SimpleCov making it possible to deliver this and subsequent releases.
9
+
10
+ ## Breaking
11
+ * Dropped official support for all EOL'ed rubies meaning we only officially support 2.4+ - older rubies might still work but are not guaranteed to do so. Older release should still work. (thanks [@deivid-rodriguez](https://github.com/deivid-rodriguez))
12
+ * Dropped the `rake simplecov` task that "magically" integreated with rails. It was always undocumented, caused some issues and [had some issues](https://github.com/colszowka/simplecov/issues/689#issuecomment-561572327). Use the integration as described in the README please :)
13
+
14
+ ## Enhancements
15
+
16
+ * Branch coverage is here! Please try it out and test it! You can activate it with `enable_coverage :branch`. See the README for more details. This is thanks to a bunch of people most notably [@som4ik](https://github.com/som4ik), [@tycooon](https://github.com/tycooon), [@stepozer](https://github.com/stepozer), [@klyonrad](https://github.com/klyonrad) and your humble maintainers also contributed ;)
17
+ * If the minimum coverage is set to be greater than 100, a warning will be shown. See [#737](https://github.com/colszowka/simplecov/pull/737) (thanks [@belfazt](https://github.com/belfazt))
18
+ * Add a configuration option to disable the printing of non-successful exit statuses. See [#747](https://github.com/colszowka/simplecov/pull/746) (thanks [@JacobEvelyn](https://github.com/JacobEvelyn))
19
+ * Calculating 100% coverage is now stricter, so 100% means 100%. See [#680](https://github.com/colszowka/simplecov/pull/680) thanks [@gleseur](https://github.com/gleseur)
20
+
21
+ ## Bugfixes
22
+
23
+ * Add new instance of `Minitest` constant. The `MiniTest` constant (with the capital T) will be removed in the next major release of Minitest. See [#757](https://github.com/colszowka/simplecov/pull/757) (thanks [@adam12](https://github.com/adam12))
24
+
1
25
  0.17.1 (2019-09-16)
2
26
  ===================
3
27
 
@@ -11,7 +35,7 @@ Bugfix release for problems with ParallelTests.
11
35
  ===================
12
36
 
13
37
  Maintenance release with nice convenience features and important bugfixes.
14
- Notably this **will be the last release to support ruby versions that have reached their end of life**. Moving forward official CRuby support will be 2.4+ and JRuby support will be 9.1+. Older versions might still work but no guarantees.
38
+ Notably this **will be the last release to support ruby versions that have reached their end of life**. Moving forward official CRuby support will be 2.4+ and JRuby support will be 9.2+. Older versions might still work but no guarantees.
15
39
 
16
40
  ## Enhancements
17
41
 
@@ -0,0 +1,76 @@
1
+ # SimpleCov Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, sex characteristics, gender identity and expression,
9
+ level of experience, education, socio-economic status, nationality, personal
10
+ appearance, race, religion, or sexual identity and orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at simplecov.team@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72
+
73
+ [homepage]: https://www.contributor-covenant.org
74
+
75
+ For answers to common questions about this code of conduct, see
76
+ https://www.contributor-covenant.org/faq
data/README.md CHANGED
@@ -1,4 +1,4 @@
1
- SimpleCov [![Build Status](https://travis-ci.org/colszowka/simplecov.svg)][Continuous Integration] [![Code Climate](https://codeclimate.com/github/colszowka/simplecov.svg)](https://codeclimate.com/github/colszowka/simplecov) [![Inline docs](http://inch-ci.org/github/colszowka/simplecov.svg)](http://inch-ci.org/github/colszowka/simplecov)
1
+ SimpleCov [![Gem Version](https://badge.fury.io/rb/simplecov.svg)](https://badge.fury.io/rb/simplecov) [![Build Status](https://travis-ci.org/colszowka/simplecov.svg?branch=master)][Continuous Integration] [![Code Climate](https://codeclimate.com/github/colszowka/simplecov.svg)](https://codeclimate.com/github/colszowka/simplecov) [![Inline docs](http://inch-ci.org/github/colszowka/simplecov.svg)](http://inch-ci.org/github/colszowka/simplecov)
2
2
  =========
3
3
  **Code coverage for Ruby**
4
4
 
@@ -8,7 +8,7 @@ SimpleCov [![Build Status](https://travis-ci.org/colszowka/simplecov.svg)][Conti
8
8
  * [Rubygem]
9
9
  * [Continuous Integration]
10
10
 
11
- [Coverage]: http://www.ruby-doc.org/stdlib-2.1.0/libdoc/coverage/rdoc/Coverage.html "API doc for Ruby's Coverage library"
11
+ [Coverage]: https://ruby-doc.org/stdlib/libdoc/coverage/rdoc/Coverage.html "API doc for Ruby's Coverage library"
12
12
  [Source Code]: https://github.com/colszowka/simplecov "Source Code @ GitHub"
13
13
  [API documentation]: http://rubydoc.info/gems/simplecov/frames "RDoc API Documentation at Rubydoc.info"
14
14
  [Configuration]: http://rubydoc.info/gems/simplecov/SimpleCov/Configuration "Configuration options API documentation"
@@ -22,13 +22,14 @@ SimpleCov is a code coverage analysis tool for Ruby. It uses [Ruby's built-in Co
22
22
  coverage data, but makes processing its results much easier by providing a clean API to filter, group, merge, format,
23
23
  and display those results, giving you a complete code coverage suite that can be set up with just a couple lines of
24
24
  code.
25
+ SimpleCov/Coverage track covered ruby code, gathering coverage for common templating solutions like erb, slim and haml is not supported.
25
26
 
26
27
  In most cases, you'll want overall coverage results for your projects, including all types of tests, Cucumber features,
27
28
  etc. SimpleCov automatically takes care of this by caching and merging results when generating reports, so your
28
29
  report actually includes coverage across your test suites and thereby gives you a better picture of blank spots.
29
30
 
30
- The official formatter of SimpleCov is packaged as a separate gem called [simplecov-html], but will be installed and configured
31
- automatically when you launch SimpleCov. If you're curious, you can find it [on GitHub, too][simplecov-html].
31
+ The official formatter of SimpleCov is packaged as a separate gem called [simplecov-html], but will be installed and
32
+ configured automatically when you launch SimpleCov. If you're curious, you can find it [on GitHub, too][simplecov-html].
32
33
 
33
34
 
34
35
  ## Contact
@@ -36,11 +37,13 @@ automatically when you launch SimpleCov. If you're curious, you can find it [on
36
37
  *Code and Bug Reports*
37
38
 
38
39
  * [Issue Tracker](https://github.com/colszowka/simplecov/issues)
39
- * See [CONTRIBUTING](https://github.com/colszowka/simplecov/blob/master/CONTRIBUTING.md) for how to contribute along with some common problems to check out before creating an issue.
40
+ * See [CONTRIBUTING](https://github.com/colszowka/simplecov/blob/master/CONTRIBUTING.md) for how to contribute along
41
+ with some common problems to check out before creating an issue.
40
42
 
41
43
  *Questions, Problems, Suggestions, etc.*
42
44
 
43
- * [Mailing List](https://groups.google.com/forum/#!forum/simplecov) "Open mailing list for discussion and announcements on Google Groups"
45
+ * [Mailing List](https://groups.google.com/forum/#!forum/simplecov) "Open mailing list for discussion and announcements
46
+ on Google Groups"
44
47
 
45
48
  Getting started
46
49
  ---------------
@@ -70,8 +73,8 @@ Getting started
70
73
  endpoint) via a separate test process (e.g. when using Selenium) where you
71
74
  want to see all code executed by the `rails server`, and not just code
72
75
  executed in your actual test files, you'll want to add something like this
73
- to the top of `script/rails` (or `bin/rails` for Rails 4), but below the
74
- "shebang" line (`#! /usr/bin/env ruby`):
76
+ to the top of `bin/rails`, but below the "shebang" line (`#! /usr/bin/env
77
+ ruby`):
75
78
 
76
79
  ```ruby
77
80
  if ENV['RAILS_ENV'] == 'test'
@@ -81,27 +84,41 @@ Getting started
81
84
  end
82
85
  ```
83
86
 
84
- 3. Run your tests, open up `coverage/index.html` in your browser and check out
85
- what you've missed so far.
86
- 4. Add the following to your `.gitignore` file to ensure that coverage results
87
+ 3. Run your full test suite to see the percent coverage that your application has.
88
+ 4. After running your tests, open `coverage/index.html` in the browser of your choice. For example, in a Mac Terminal,
89
+ run the following command from your application's root directory:
90
+
91
+ ```
92
+ open coverage/index.html
93
+ ```
94
+ in a debian/ubuntu Terminal,
95
+
96
+ ```
97
+ xdg-open coverage/index.html
98
+ ```
99
+
100
+ **Note:** [This guide](https://dwheeler.com/essays/open-files-urls.html) can help if you're unsure which command your particular
101
+ operating system requires.
102
+
103
+ 5. Add the following to your `.gitignore` file to ensure that coverage results
87
104
  are not tracked by Git (optional):
88
105
 
89
- ```
90
- echo "coverage" >> .gitignore
91
- ```
92
- Or if you use Windows:
93
- ```
94
- echo coverage >> .gitignore
95
- ```
106
+ ```
107
+ echo "coverage" >> .gitignore
108
+ ```
109
+ Or if you use Windows:
110
+ ```
111
+ echo coverage >> .gitignore
112
+ ```
96
113
 
97
- If you're making a Rails application, SimpleCov comes with built-in configurations (see below for information on profiles)
98
- that will get you started with groups for your Controllers, Views, Models and Helpers. To use it, the first two lines of
99
- your test_helper should be like this:
114
+ If you're making a Rails application, SimpleCov comes with built-in configurations (see below for information on
115
+ profiles) that will get you started with groups for your Controllers, Models and Helpers. To use it, the
116
+ first two lines of your test_helper should be like this:
100
117
 
101
- ```ruby
102
- require 'simplecov'
103
- SimpleCov.start 'rails'
104
- ```
118
+ ```ruby
119
+ require 'simplecov'
120
+ SimpleCov.start 'rails'
121
+ ```
105
122
 
106
123
  ## Example output
107
124
 
@@ -127,8 +144,9 @@ require 'simplecov'
127
144
  SimpleCov.start 'rails'
128
145
  ```
129
146
 
130
- You could even track what kind of code your UI testers are touching if you want to go overboard with things. SimpleCov does not
131
- care what kind of framework it is running in; it just looks at what code is being executed and generates a report about it.
147
+ You could even track what kind of code your UI testers are touching if you want to go overboard with things. SimpleCov
148
+ does not care what kind of framework it is running in; it just looks at what code is being executed and generates a
149
+ report about it.
132
150
 
133
151
  ### Notes on specific frameworks and test utilities
134
152
 
@@ -223,7 +241,8 @@ to use SimpleCov with them. Here's an overview of the known ones:
223
241
  ```ruby
224
242
  SimpleCov.some_config_option 'foo'
225
243
  ```
226
- * If you do not want to start coverage immediately after launch or want to add additional configuration later on in a concise way, use:
244
+ * If you do not want to start coverage immediately after launch or want to add additional configuration later on in a
245
+ concise way, use:
227
246
 
228
247
  ```ruby
229
248
  SimpleCov.configure do
@@ -235,11 +254,12 @@ Please check out the [Configuration] API documentation to find out what you can
235
254
 
236
255
  ## Using .simplecov for centralized config
237
256
 
238
- If you use SimpleCov to merge multiple test suite results (e.g. Test/Unit and Cucumber) into a single report, you'd normally have to
239
- set up all your config options twice, once in `test_helper.rb` and once in `env.rb`.
257
+ If you use SimpleCov to merge multiple test suite results (e.g. Test/Unit and Cucumber) into a single report, you'd
258
+ normally have to set up all your config options twice, once in `test_helper.rb` and once in `env.rb`.
240
259
 
241
- To avoid this, you can place a file called `.simplecov` in your project root. You can then just leave the `require 'simplecov'` in each
242
- test setup helper (**at the top**) and move the `SimpleCov.start` code with all your custom config options into `.simplecov`:
260
+ To avoid this, you can place a file called `.simplecov` in your project root. You can then just leave the
261
+ `require 'simplecov'` in each test setup helper (**at the top**) and move the `SimpleCov.start` code with all your
262
+ custom config options into `.simplecov`:
243
263
 
244
264
  ```ruby
245
265
  # test/test_helper.rb
@@ -254,21 +274,69 @@ SimpleCov.start 'rails' do
254
274
  end
255
275
  ```
256
276
 
257
- Using `.simplecov` rather than separately requiring SimpleCov multiple times is recommended if you are merging multiple test frameworks like Cucumber and RSpec that rely on each other, as invoking SimpleCov multiple times can cause coverage information to be lost.
277
+ Using `.simplecov` rather than separately requiring SimpleCov multiple times is recommended if you are merging multiple
278
+ test frameworks like Cucumber and RSpec that rely on each other, as invoking SimpleCov multiple times can cause coverage
279
+ information to be lost.
280
+
281
+ ## Branch coverage (ruby "~> 2.5")
282
+ Add branch coverage measurement statistics to your results. Supported in CRuby versions 2.5+.
283
+
284
+ ```ruby
285
+ # or in configure or just SimpleCov.enable_coverage :branch
286
+ SimpleCov.start do
287
+ enable_coverage :branch
288
+ end
289
+ ```
290
+
291
+ Branch coverage is a feature introduced in Ruby 2.5 concerning itself with whether a
292
+ particular branch of a condition had been executed. Line coverage on the other hand
293
+ is only interested in whether a line of code has been executed.
294
+
295
+ This comes in handy for instance for one line conditionals:
296
+
297
+ ```ruby
298
+ number.odd? ? "odd" : "even"
299
+ ```
300
+
301
+ In line coverage this line would always be marked as executed but you'd never know if both
302
+ conditions were met. Guard clauses have a similar story:
303
+
304
+ ```ruby
305
+ return if number.odd?
306
+
307
+ # more code
308
+ ```
309
+
310
+ If all the code in that method was covered you'd never know if the guard clause was ever
311
+ triggered with line coverage as just evaluating the condition marks it as covered.
312
+
313
+ In the HTML report the lines of code will be annotated like `hit_count, positive_or_negative_branch`:
314
+
315
+ * `2, +` - the positive branch was executed twice
316
+ * `0, -` - the negative branch was never executed
317
+
318
+ **Is branch coverage strictly better?** No. Branch coverage really only concerns itself with
319
+ conditionals - meaning coverage of sequential code is of no interest to it. A file without
320
+ conditional logic will have no branch coverage data and SimpleCov will report 0 of 0
321
+ branches covered as 100% (as everything that can be covered was covered).
322
+
323
+ Hence, we recommend looking at both metrics together. Branch coverage might also be a good
324
+ overall metric to look at - while you might be missing only 10% of your lines that might
325
+ account for 50% of your branches for instance.
258
326
 
259
327
  ## Filters
260
328
 
261
- Filters can be used to remove selected files from your coverage data. By default, a filter is applied that removes all files
262
- OUTSIDE of your project's root directory - otherwise you'd end up with billions of coverage reports for source files in the
263
- gems you are using.
329
+ Filters can be used to remove selected files from your coverage data. By default, a filter is applied that removes all
330
+ files OUTSIDE of your project's root directory - otherwise you'd end up with billions of coverage reports for source
331
+ files in the gems you are using.
264
332
 
265
333
  You can define your own to remove things like configuration files, tests or whatever you don't need in your coverage
266
334
  report.
267
335
 
268
336
  ### Defining custom filters
269
337
 
270
- You can currently define a filter using either a String or Regexp (that will then be Regexp-matched against each source file's path),
271
- a block or by passing in your own Filter class.
338
+ You can currently define a filter using either a String or Regexp (that will then be Regexp-matched against each source
339
+ file's path), a block or by passing in your own Filter class.
272
340
 
273
341
  #### String filter
274
342
 
@@ -300,9 +368,10 @@ SimpleCov.start do
300
368
  end
301
369
  ```
302
370
 
303
- Block filters receive a SimpleCov::SourceFile instance and expect your block to return either true (if the file is to be removed
304
- from the result) or false (if the result should be kept). Please check out the RDoc for SimpleCov::SourceFile to learn about the
305
- methods available to you. In the above example, the filter will remove all files that have less than 5 lines of code.
371
+ Block filters receive a SimpleCov::SourceFile instance and expect your block to return either true (if the file is to be
372
+ removed from the result) or false (if the result should be kept). Please check out the RDoc for SimpleCov::SourceFile to
373
+ learn about the methods available to you. In the above example, the filter will remove all files that have less than 5
374
+ lines of code.
306
375
 
307
376
  #### Custom filter class
308
377
 
@@ -316,9 +385,10 @@ end
316
385
  SimpleCov.add_filter LineFilter.new(5)
317
386
  ```
318
387
 
319
- Defining your own filters is pretty easy: Just inherit from SimpleCov::Filter and define a method 'matches?(source_file)'. When running
320
- the filter, a true return value from this method will result in the removal of the given source_file. The filter_argument method
321
- is being set in the SimpleCov::Filter initialize method and thus is set to 5 in this example.
388
+ Defining your own filters is pretty easy: Just inherit from SimpleCov::Filter and define a method
389
+ 'matches?(source_file)'. When running the filter, a true return value from this method will result in the removal of the
390
+ given source_file. The filter_argument method is being set in the SimpleCov::Filter initialize method and thus is set to
391
+ 5 in this example.
322
392
 
323
393
  #### Array filter
324
394
 
@@ -345,7 +415,9 @@ end
345
415
 
346
416
  The name of the token can be changed to your liking. [Learn more about the nocov feature.]( https://github.com/colszowka/simplecov/blob/master/features/config_nocov_token.feature)
347
417
 
348
- **Note:** You shouldn't have to use the nocov token to skip private methods that are being included in your coverage. If you appropriately test the public interface of your classes and objects you should automatically get full coverage of your private methods.
418
+ **Note:** You shouldn't have to use the nocov token to skip private methods that are being included in your coverage. If
419
+ you appropriately test the public interface of your classes and objects you should automatically get full coverage of
420
+ your private methods.
349
421
 
350
422
  ## Default root filter and coverage for things outside of it
351
423
 
@@ -368,8 +440,8 @@ end
368
440
 
369
441
  You can separate your source files into groups. For example, in a Rails app, you'll want to have separate listings for
370
442
  Models, Controllers, Helpers, and Libs. Group definition works similarly to Filters (and also accepts custom
371
- filter classes), but source files end up in a group when the filter passes (returns true), as opposed to filtering results,
372
- which exclude files from results when the filter results in a true value.
443
+ filter classes), but source files end up in a group when the filter passes (returns true), as opposed to filtering
444
+ results, which exclude files from results when the filter results in a true value.
373
445
 
374
446
  Add your groups with:
375
447
 
@@ -459,13 +531,15 @@ You can deactivate merging altogether with `SimpleCov.use_merging false`.
459
531
 
460
532
  ## Running coverage only on demand
461
533
 
462
- The Ruby STDLIB Coverage library that SimpleCov builds upon is *very* fast (on a ~10 min Rails test suite, the speed drop was
463
- only a couple seconds for me), and therefore it's SimpleCov's policy to just generate coverage every time you run your tests because
464
- it doesn't do your test speed any harm and you're always equipped with the latest and greatest coverage results.
534
+ The Ruby STDLIB Coverage library that SimpleCov builds upon is *very* fast (on a ~10 min Rails test suite, the speed
535
+ drop was only a couple seconds for me), and therefore it's SimpleCov's policy to just generate coverage every time you
536
+ run your tests because it doesn't do your test speed any harm and you're always equipped with the latest and greatest
537
+ coverage results.
465
538
 
466
539
  Because of this, SimpleCov has no explicit built-in mechanism to run coverage only on demand.
467
540
 
468
- However, you can still accomplish this very easily by introducing an ENV variable conditional into your SimpleCov setup block, like this:
541
+ However, you can still accomplish this very easily by introducing an ENV variable conditional into your SimpleCov setup
542
+ block, like this:
469
543
 
470
544
  ```ruby
471
545
  SimpleCov.start if ENV["COVERAGE"]
@@ -477,6 +551,21 @@ Then, SimpleCov will only run if you execute your tests like this:
477
551
  COVERAGE=true rake test
478
552
  ```
479
553
 
554
+ ## Errors and exit statuses
555
+
556
+ To aid in debugging issues, if an error is raised, SimpleCov will print a message to `STDERR`
557
+ with the exit status of the error, like:
558
+
559
+ ```
560
+ SimpleCov failed with exit 1
561
+ ```
562
+
563
+ This `STDERR` message can be disabled with:
564
+
565
+ ```
566
+ SimpleCov.print_error_status = false
567
+ ```
568
+
480
569
  ## Profiles
481
570
 
482
571
  By default, SimpleCov's only config assumption is that you only want coverage reports for files inside your project
@@ -514,8 +603,8 @@ end
514
603
 
515
604
  ### Custom profiles
516
605
 
517
- You can load additional profiles with the SimpleCov.load_profile('xyz') method. This allows you to build upon an existing
518
- profile and customize it so you can reuse it in unit tests and Cucumber features. For example:
606
+ You can load additional profiles with the SimpleCov.load_profile('xyz') method. This allows you to build upon an
607
+ existing profile and customize it so you can reuse it in unit tests and Cucumber features. For example:
519
608
 
520
609
  ```ruby
521
610
  # lib/simplecov_custom_profile.rb
@@ -556,7 +645,8 @@ SimpleCov.minimum_coverage 90
556
645
 
557
646
  ### Minimum coverage by file
558
647
 
559
- You can define the minimum coverage by file percentage expected. SimpleCov will return non-zero if unmet. This is useful to help ensure coverage is relatively consistent, rather than being skewed by particularly good or bad areas of the code.
648
+ You can define the minimum coverage by file percentage expected. SimpleCov will return non-zero if unmet. This is useful
649
+ to help ensure coverage is relatively consistent, rather than being skewed by particularly good or bad areas of the code.
560
650
 
561
651
  ```ruby
562
652
  SimpleCov.minimum_coverage_by_file 80
@@ -586,8 +676,8 @@ You can use your own formatter with:
586
676
  SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
587
677
  ```
588
678
 
589
- When calling SimpleCov.result.format!, it will be invoked with SimpleCov::Formatter::YourFormatter.new.format(result), "result"
590
- being an instance of SimpleCov::Result. Do whatever your wish with that!
679
+ When calling SimpleCov.result.format!, it will be invoked with SimpleCov::Formatter::YourFormatter.new.format(result),
680
+ "result" being an instance of SimpleCov::Result. Do whatever your wish with that!
591
681
 
592
682
 
593
683
  ## Using multiple formatters
@@ -609,11 +699,9 @@ SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new([
609
699
 
610
700
  ## Ruby version compatibility
611
701
 
612
- Only Ruby 1.9+ ships with the coverage library that SimpleCov depends upon and that's what SimpleCov supports. Additionally JRuby 9.1+ is supported as well, while JRuby 1.7 and 9.0 should work they're not "officially" supported.
613
- SimpleCov is also built against Ruby 1.8 in [Continuous Integration], but this happens only to ensure that SimpleCov
614
- does not make your test suite crash right now.
702
+ SimpleCov is built in [Continuous Integration] on Ruby 2.4+ as well as JRuby 9.2+.
615
703
 
616
- SimpleCov is built in [Continuous Integration] on Ruby 1.9.3, 2.0.0, 2.1, 2.2, 2.3, 2.4, 2.5 as well as JRuby 9.1.
704
+ Note for JRuby => You need to pass JRUBY_OPTS="--debug" or create .jrubyrc and add debug.fullTrace=true
617
705
 
618
706
  ## Want to find dead code in production?
619
707
 
@@ -621,7 +709,9 @@ Try [Coverband](https://github.com/danmayer/coverband).
621
709
 
622
710
  ## Want to use Spring with SimpleCov?
623
711
 
624
- If you're using [Spring](https://github.com/rails/spring) to speed up test suite runs and want to run SimpleCov along with them, you'll find that it often misreports coverage with the default config due to some sort of eager loading issue. Don't despair!
712
+ If you're using [Spring](https://github.com/rails/spring) to speed up test suite runs and want to run SimpleCov along
713
+ with them, you'll find that it often misreports coverage with the default config due to some sort of eager loading
714
+ issue. Don't despair!
625
715
 
626
716
  One solution is to [explicitly call eager
627
717
  load](https://github.com/colszowka/simplecov/issues/381#issuecomment-347651728)
@@ -633,13 +723,22 @@ SimpleCov.start 'rails'
633
723
  Rails.application.eager_load!
634
724
  ```
635
725
 
726
+ Alternatively, you could disable Spring while running SimpleCov:
727
+
728
+ ```
729
+ DISABLE_SPRING=1 rake test
730
+ ```
731
+
636
732
  Or you could remove `gem 'spring'` from your `Gemfile`.
637
733
 
638
734
  ## Troubleshooting
639
735
 
640
- The **most common problem is that simplecov isn't required and started before everything else**. In order to track coverage for your whole application **simplecov needs to be the first one** so that it (and the underlying coverage library) can subsequently track loaded files and their usage.
736
+ The **most common problem is that simplecov isn't required and started before everything else**. In order to track
737
+ coverage for your whole application **simplecov needs to be the first one** so that it (and the underlying coverage
738
+ library) can subsequently track loaded files and their usage.
641
739
 
642
- If you are missing coverage for some code a simple trick is to put a puts statement in there and right after `SimpleCov.start` so you can see if the file really was loaded after simplecov was started.
740
+ If you are missing coverage for some code a simple trick is to put a puts statement in there and right after
741
+ `SimpleCov.start` so you can see if the file really was loaded after simplecov was started.
643
742
 
644
743
  ```ruby
645
744
  # my_code.rb
@@ -667,6 +766,11 @@ MyCode is being loaded!
667
766
 
668
767
  then it's good otherwise you likely have a problem :)
669
768
 
769
+ ## Code of Conduct
770
+
771
+ Everyone participating in this project's development, issue trackers and other channels is expected to follow our
772
+ [Code of Conduct](./CODE_OF_CONDUCT.md)
773
+
670
774
  ## Contributing
671
775
 
672
776
  See the [contributing guide](https://github.com/colszowka/simplecov/blob/master/CONTRIBUTING.md).