simplecov-console 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 290f9f7dda635d7301e3c4f2acd9bb81a17fda27aee5a812983ba19bfea11ebe
-  data.tar.gz: 2e317c4c10cf7dff407e2544c2916136c7d436f35a89fc10a509649a8706d32c
+  metadata.gz: bf41260176ece548059c1fff6db115552f4ff1a6655ab63575e488dfc2318739
+  data.tar.gz: 404ddb9d0b0a6f023046fdf7f52ab4accd496cc759f37c696d22c73df9a5d194
 SHA512:
-  metadata.gz: 2de0c0d1e3b265df0d214368841200362feee6817497562d0ad04246b2c2ab81346e714242bd767bf8ffbe7fdca8d321061559a5a05a47a09fe2c79f14df91bd
-  data.tar.gz: 0d6bd990215178e64db73696dfa06454ba46d0f72771e380114d9c881e7945fc0e7c33dcc010b8c5b1b598eb4f4a2ad3cb39aff921c298446bc375306a66102f
+  metadata.gz: 2e66ac79cbdf147451f2d6cb27666cd9b9a9cafc4c440adf6cc5975af38423f850260ffd3c40410a59e10ebc33b2e23438255c196ae1412a84647d10fb5350a0
+  data.tar.gz: 0c9e6517b4a51a435c02f2a3e96def76c7d9bf0724f725a679555a67f90b2fce7c788d0ebb464217458c48e91559e8a92837c164b91139769b6f55f93a7d3ae5

data/README.md

@@ -2,7 +2,7 @@
 
 A simple console output formatter for SimpleCov
 
-### Usage
+## Usage
 
 ```bash
 $ gem install simplecov-console
@@ -11,14 +11,15 @@ $ gem install simplecov-console
 ```ruby
 SimpleCov.formatter = SimpleCov::Formatter::Console
 # or
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
   SimpleCov::Formatter::HTMLFormatter,
   SimpleCov::Formatter::Console,
-]
+])
 ```
 
 Example output:
-```
+
+```text
 COVERAGE:  82.34% -- 2345/2848 lines in 111 files
 
 showing bottom (worst) 15 of 69 files
@@ -44,17 +45,64 @@ showing bottom (worst) 15 of 69 files
 42 file(s) with 100% coverage not shown
 ```
 
+## Configuration
+
+### Disabling colorized output
+
+Simply export `NO_COLOR=1` and colors will be disabled.
+
+```sh
+NO_COLOR=1 rake test
+```
+
+### Sorting the output
+
+By default the coverage report is sorted by coverage % in descending order.  To sort alphabetically by path, set the `SORT` environment variable to "path", or add the following to your test helper:
+
+```ruby
+SimpleCov::Formatter::Console.sort = 'path' # sort by file path
+```
+
+### Showing covered files
+
+By default, fully covered files are excluded from the report.  To show them, set the `SHOW_COVERED` environment variable to `true` or add the following to your test helper:
+
+```ruby
+SimpleCov::Formatter::Console.show_covered = true # show all files in coverage report
+```
+
+### Maximum rows displayed
+
+By default, a maximum of 15 files with the worst coverage are displayed in the report.  You can override this limit by setting the `MAX_ROWS` environment variable, or adding the following to your test helper:
+
+```ruby
+SimpleCov::Formatter::Console.max_rows = # some number
+```
+
+Setting a value of `-1` or `nil` will show all of the files.
+
 ### Table options
 
-In some cases, you may need to pass some options to Hirb's Table.render. For example, if the filenames are
+In some cases, you may need to pass some options to `TerminalTable.new`. For example, if the filenames are
 truncated so much that you can't read them. In that case, you can add a line like this when setting the formatter:
 
 ```ruby
-SimpleCov::Formatter::Console.table_options = {max_width: 200}
+SimpleCov::Formatter::Console.table_options = {:style => {:width => 200}}
 SimpleCov.formatter = SimpleCov::Formatter::Console
 ```
 
-### Contributing
+## History
+
+### 0.6 (2019.11.08)
+
+- Added new config options: `sort`, `show_covered`, and `max_rows`
+
+### 0.5 (2019.05.24)
+
+- Replaced `hirb` gem with `terminal-table` due to multiple warnings thrown ([#11](https://github.com/chetan/simplecov-console/issues/11))
+- Support [disabling colorized](https://no-color.org/) output via `NO_COLOR` env var
+
+## Contributing
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
@@ -66,5 +114,5 @@ SimpleCov.formatter = SimpleCov::Formatter::Console
 
 ### Copyright
 
-Copyright (c) 2014 Chetan Sarva. See LICENSE.txt for
+Copyright (c) 2019 Chetan Sarva. See LICENSE.txt for
 further details.

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/lib/simplecov-console.rb

@@ -5,7 +5,7 @@ class SimpleCov::Formatter::Console
 
   VERSION = IO.read(File.expand_path("../../VERSION", __FILE__)).strip
 
-  ATTRIBUTES = [:table_options, :use_colors]
+  ATTRIBUTES = [:table_options, :use_colors, :max_rows, :show_covered, :sort]
   class << self
     attr_accessor(*ATTRIBUTES)
   end
@@ -14,6 +14,15 @@ class SimpleCov::Formatter::Console
   SimpleCov::Formatter::Console.use_colors =
     (ENV['NO_COLOR'].nil? or ENV['NO_COLOR'].empty?) ? true : false
 
+  # configure max rows from MAX_ROWS env var
+  SimpleCov::Formatter::Console.max_rows = ENV.fetch('MAX_ROWS', 15).to_i
+
+  # configure show_covered from SHOW_COVERED env var
+  SimpleCov::Formatter::Console.show_covered = ENV.fetch('SHOW_COVERED', 'false') == 'true'
+
+  # configure sort from SORT env var
+  SimpleCov::Formatter::Console.sort = ENV.fetch('SORT', 'coverage')
+
   def format(result)
 
     root = nil
@@ -35,20 +44,26 @@ class SimpleCov::Formatter::Console
       return
     end
 
-    files = result.files.sort{ |a,b| a.covered_percent <=> b.covered_percent }
+    if SimpleCov::Formatter::Console.sort == 'coverage'
+      files = result.files.sort{ |a,b| a.covered_percent <=> b.covered_percent }
+    else
+      files = result.files
+    end
 
     covered_files = 0
-    files.select!{ |file|
-      if file.covered_percent == 100 then
-        covered_files += 1
-        false
-      else
-        true
-      end
-    }
 
-    if files.nil? or files.empty? then
-      return
+    unless SimpleCov::Formatter::Console.show_covered
+      files.select!{ |file|
+        if file.covered_percent == 100 then
+          covered_files += 1
+          false
+        else
+          true
+        end
+      }
+      if files.nil? or files.empty? then
+        return
+      end
     end
 
     table = files.map do |f|
@@ -61,9 +76,11 @@ class SimpleCov::Formatter::Console
       ]
     end
 
-    if table.size > 15 then
-      puts "showing bottom (worst) 15 of #{table.size} files"
-      table = table.slice(0, 15)
+    max_rows = SimpleCov::Formatter::Console.max_rows
+
+    if ![-1, nil].include?(max_rows) && table.size > max_rows then
+      puts "showing bottom (worst) #{max_rows} of #{table.size} files"
+      table = table.slice(0, max_rows)
     end
 
     table_options = SimpleCov::Formatter::Console.table_options || {}

data/simplecov-console.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: simplecov-console 0.5.0 ruby lib
+# stub: simplecov-console 0.6.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "simplecov-console".freeze
-  s.version = "0.5.0"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Chetan Sarva".freeze]
-  s.date = "2019-05-24"
+  s.date = "2019-11-08"
   s.description = "Simple console output formatter for SimpleCov".freeze
   s.email = "chetan@pixelcop.net".freeze
   s.extra_rdoc_files = [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplecov-console
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Chetan Sarva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-24 00:00:00.000000000 Z
+date: 2019-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov