simplecov-console 0.3.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c94c34b7c48536875f37cafda5470bd58a33ea50
-  data.tar.gz: 14d9c26c608fb6712790caaee211f14a9ec429e3
+SHA256:
+  metadata.gz: bf41260176ece548059c1fff6db115552f4ff1a6655ab63575e488dfc2318739
+  data.tar.gz: 404ddb9d0b0a6f023046fdf7f52ab4accd496cc759f37c696d22c73df9a5d194
 SHA512:
-  metadata.gz: 7b3c3e3f0a44ff6113909f092d4f2120a2713d58de4e467f22fd977fa8e3c022c878ac8ca2c89cf02a62c665fea4c3bbaad9e238b42ce2e22869f268fa5a1977
-  data.tar.gz: af0311bf9c48b080d6bee9ab3470abba824f807da8ff44a26d024171632b3b41e662da920f366bd9a936a057a2b67a893e6ed128fdf0d42897569e47915dc501
+  metadata.gz: 2e66ac79cbdf147451f2d6cb27666cd9b9a9cafc4c440adf6cc5975af38423f850260ffd3c40410a59e10ebc33b2e23438255c196ae1412a84647d10fb5350a0
+  data.tar.gz: 0c9e6517b4a51a435c02f2a3e96def76c7d9bf0724f725a679555a67f90b2fce7c788d0ebb464217458c48e91559e8a92837c164b91139769b6f55f93a7d3ae5

data/Gemfile

@@ -1,7 +1,7 @@
 source "http://rubygems.org"
 
 gem "simplecov"
-gem "hirb"
+gem "terminal-table"
 gem "ansi"
 
 group :development do

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,8 +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 `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 = {:style => {:width => 200}}
+SimpleCov.formatter = SimpleCov::Formatter::Console
+```
+
+## 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
+## 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.
@@ -57,5 +114,5 @@ showing bottom (worst) 15 of 69 files
 
 ### 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.3.1
+0.6.0

data/lib/simplecov-console.rb

@@ -1,9 +1,27 @@
-require 'hirb'
+require 'terminal-table'
 require 'ansi/code'
 
 class SimpleCov::Formatter::Console
 
-  VERSION = File.new(File.join(File.expand_path(File.dirname(__FILE__)), "../VERSION")).read.strip
+  VERSION = IO.read(File.expand_path("../../VERSION", __FILE__)).strip
+
+  ATTRIBUTES = [:table_options, :use_colors, :max_rows, :show_covered, :sort]
+  class << self
+    attr_accessor(*ATTRIBUTES)
+  end
+
+  # enable colors unless NO_COLOR=1
+  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)
 
@@ -26,38 +44,54 @@ 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|
-      { :coverage => pct(f),
-        :lines => f.lines_of_code,
-        :file => f.filename.gsub(root + "/", ''),
-        :missed => f.missed_lines.count,
-        :missing => missed(f.missed_lines).join(", ") }
+      [
+        colorize(pct(f)),
+        f.filename.gsub(root + "/", ''),
+        f.lines_of_code,
+        f.missed_lines.count,
+        missed(f.missed_lines).join(", ")
+      ]
     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
 
-    s = Hirb::Helpers::Table.render(table).split(/\n/)
-    s.pop
-    puts s.join("\n").gsub(/\d+\.\d+%/) { |m| colorize(m) }
+    table_options = SimpleCov::Formatter::Console.table_options || {}
+    if !table_options.kind_of?(Hash) then
+      raise ArgumentError.new("SimpleCov::Formatter::Console.table_options must be a Hash")
+    end
+    headings = %w{ coverage file lines missed missing }
+
+    opts = table_options.merge({:headings => headings, :rows => table})
+    t = Terminal::Table.new(opts)
+    puts t
 
     if covered_files > 0 then
       puts "#{covered_files} file(s) with 100% coverage not shown"
@@ -82,11 +116,11 @@ class SimpleCov::Formatter::Console
     end
 
     group_str = []
-    groups.map do |base, v|
-      if v > 0
-        group_str << "#{base}-#{base + v}"
+    groups.map do |starting_line, length|
+      if length > 0
+        group_str << "#{starting_line}-#{starting_line + length}"
       else
-        group_str << "#{base}"
+        group_str << "#{starting_line}"
       end
     end
 
@@ -97,7 +131,13 @@ class SimpleCov::Formatter::Console
     sprintf("%6.2f%%", obj.covered_percent)
   end
 
+  def use_colors?
+    SimpleCov::Formatter::Console.use_colors
+  end
+
   def colorize(s)
+    return s if !use_colors?
+
     s =~ /([\d.]+)/
     n = $1.to_f
     if n >= 90 then

data/simplecov-console.gemspec

@@ -2,18 +2,18 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: simplecov-console 0.3.1 ruby lib
+# stub: simplecov-console 0.6.0 ruby lib
 
 Gem::Specification.new do |s|
-  s.name = "simplecov-console"
-  s.version = "0.3.1"
+  s.name = "simplecov-console".freeze
+  s.version = "0.6.0"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["Chetan Sarva"]
-  s.date = "2016-08-25"
-  s.description = "Simple console output formatter for SimpleCov"
-  s.email = "chetan@pixelcop.net"
+  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-11-08"
+  s.description = "Simple console output formatter for SimpleCov".freeze
+  s.email = "chetan@pixelcop.net".freeze
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
@@ -30,39 +30,39 @@ Gem::Specification.new do |s|
     "test/helper.rb",
     "test/test_simplecov-console.rb"
   ]
-  s.homepage = "http://github.com/chetan/simplecov-console"
-  s.licenses = ["MIT"]
-  s.rubygems_version = "2.5.1"
-  s.summary = "Simple console output formatter"
+  s.homepage = "http://github.com/chetan/simplecov-console".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "3.0.2".freeze
+  s.summary = "Simple console output formatter".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<simplecov>, [">= 0"])
-      s.add_runtime_dependency(%q<hirb>, [">= 0"])
-      s.add_runtime_dependency(%q<ansi>, [">= 0"])
-      s.add_development_dependency(%q<minitest>, [">= 0"])
-      s.add_development_dependency(%q<yard>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.2"])
-      s.add_development_dependency(%q<juwelier>, [">= 0"])
+      s.add_runtime_dependency(%q<simplecov>.freeze, [">= 0"])
+      s.add_runtime_dependency(%q<terminal-table>.freeze, [">= 0"])
+      s.add_runtime_dependency(%q<ansi>.freeze, [">= 0"])
+      s.add_development_dependency(%q<minitest>.freeze, [">= 0"])
+      s.add_development_dependency(%q<yard>.freeze, [">= 0"])
+      s.add_development_dependency(%q<bundler>.freeze, ["~> 1.2"])
+      s.add_development_dependency(%q<juwelier>.freeze, [">= 0"])
     else
-      s.add_dependency(%q<simplecov>, [">= 0"])
-      s.add_dependency(%q<hirb>, [">= 0"])
-      s.add_dependency(%q<ansi>, [">= 0"])
-      s.add_dependency(%q<minitest>, [">= 0"])
-      s.add_dependency(%q<yard>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.2"])
-      s.add_dependency(%q<juwelier>, [">= 0"])
+      s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+      s.add_dependency(%q<terminal-table>.freeze, [">= 0"])
+      s.add_dependency(%q<ansi>.freeze, [">= 0"])
+      s.add_dependency(%q<minitest>.freeze, [">= 0"])
+      s.add_dependency(%q<yard>.freeze, [">= 0"])
+      s.add_dependency(%q<bundler>.freeze, ["~> 1.2"])
+      s.add_dependency(%q<juwelier>.freeze, [">= 0"])
     end
   else
-    s.add_dependency(%q<simplecov>, [">= 0"])
-    s.add_dependency(%q<hirb>, [">= 0"])
-    s.add_dependency(%q<ansi>, [">= 0"])
-    s.add_dependency(%q<minitest>, [">= 0"])
-    s.add_dependency(%q<yard>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.2"])
-    s.add_dependency(%q<juwelier>, [">= 0"])
+    s.add_dependency(%q<simplecov>.freeze, [">= 0"])
+    s.add_dependency(%q<terminal-table>.freeze, [">= 0"])
+    s.add_dependency(%q<ansi>.freeze, [">= 0"])
+    s.add_dependency(%q<minitest>.freeze, [">= 0"])
+    s.add_dependency(%q<yard>.freeze, [">= 0"])
+    s.add_dependency(%q<bundler>.freeze, ["~> 1.2"])
+    s.add_dependency(%q<juwelier>.freeze, [">= 0"])
   end
 end
 

data/test/helper.rb

@@ -1,25 +1,15 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require "simplecov"
-require "minitest/autorun"
 
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'simplecov-console'
+$LOAD_PATH.push(File.expand_path("../../lib", __FILE__))
 
-class MiniTest::Test
-end
+require "bundler/setup"
+require "simplecov"
+require "simplecov-console"
 
-SimpleCov.formatter = SimpleCov::Formatter::Console
 SimpleCov.start do
-  add_filter "/test/"
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::Console
+  ])
 end
 
-MiniTest.autorun
+require "minitest/autorun"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplecov-console
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Chetan Sarva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-25 00:00:00.000000000 Z
+date: 2019-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hirb
+  name: terminal-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -145,8 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Simple console output formatter