simplecov_covview 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28f6fa6f8b0245da23b7492dc9115148d12d576d022f7b8468e64a689cb48bda
-  data.tar.gz: 3227b8d839c3f2f2146d4f93a1624193e1004b5a4a1c7c004dc0e48a1bf320d4
+  metadata.gz: 25430be8798869e14b43172a5456bf24e2e235c4f26b36d0fcb05b35a4d1acfc
+  data.tar.gz: 7524b3412b01a08dfec4f245589e4d51dee7ffc21947cbe68d6c855635017c68
 SHA512:
-  metadata.gz: a53bcfe6d9e216dc266189968e823c92f2057cf42cf63913fed9a7f8af528baac3461c81653c00ae8c624cd4266f307af02d0e8cd056b6b060cef4df484b121b
-  data.tar.gz: 65662a84309ea96dd50d4e2e3e775b377fa76b9e7de957cfb67179583048add12b0e6b53347e98c7cf54d7d412eef19c8af18346df713b5788d2e6b28cecdaa1
+  metadata.gz: e7f384063406012ce05859933720d4cdbd010fb39bd5a51e74fb56202ab41b1637e1f0acd944340cc50e189fd5c19a759e3ffe83e9ac95124a4a4c656bdeda76
+  data.tar.gz: 79ae4d427bddf2ffb5ff365f7c09ab60da952a2d9d7d4352ddbdc102b379df181c032c3c85e5dadbcb8c5a56bf1f9f647ab5675a1816969eb7bd7f9672969843

data/README.md

@@ -26,6 +26,9 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
+require "simplecov"
+require "simplecov_covview"
+
 SimpleCov.formatter = SimpleCov::Formatter::CovView
 # or
 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
@@ -34,24 +37,39 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
   ])
 ```
 
-Example output:
-
-```text
-
------ file => foo.rb -----
-4 lines covered and 1 lines missed.
-line#   status   count  code
-   1: [  never] [   - ] # foo.rb
-   2: [covered] [   1 ] def foo(n)
-   3: [covered] [  10 ]   if n <= 10
-   4: [covered] [  10 ]     p "n < 10"
-   5: [  never] [   - ]   else
-   6: [ missed] [   0 ]     p "n >= 10"
-   7: [  never] [   - ]   end
-   8: [  never] [   - ] end
-   9: [  never] [   - ]
-  10: [covered] [  11 ] (1..10).each {|x| foo(x)}
+## Output options:
+
+### 8-colors colorized output (default)
+*  The default color mode is 8-colors mode.
+*  To enable 8-colors, enable `use_8color` and disable `use_256color`.
+
+```ruby
+SimpleCov::Formatter::CovView.use_8color = true
+SimpleCov::Formatter::CovView.use_256color = false
 ```
+![8 colors](img/color-8.png "Example output 8-colors")
+
+
+### 256-colors colorized output 
+*  To enable 256-colors mode, enable `use_256color`.
+* `use_256color` has priority over `use_8color`.
+```ruby
+SimpleCov::Formatter::CovView.use_8color = false
+SimpleCov::Formatter::CovView.use_256color = true
+# or
+SimpleCov::Formatter::CovView.use_8color = true
+SimpleCov::Formatter::CovView.use_256color = true
+```
+![256 colors](img/color-256.png "Example output 256-colors")
+
+### No colorized output
+Disabling 8-colors and 256-colors will result in no colorization.　　
+```ruby
+SimpleCov::Formatter::CovView.use_8color = false
+SimpleCov::Formatter::CovView.use_256color = false
+```
+
+![no colors](img/color-no.png "Example output no-colors")
 
 ## Contributing
 

data/lib/simplecov_covview/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SimplecovCovview
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplecov_covview
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - icm7216
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 2021-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -66,6 +66,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- img/color-256.png
+- img/color-8.png
+- img/color-no.png
 - lib/simplecov_covview.rb
 - lib/simplecov_covview/color.rb
 - lib/simplecov_covview/formatter.rb