simplecov-console 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c972c40225a8d1890e1a1b9d9e6cda1d55c9b7ec6e07e504dbd01e24ff834a10
-  data.tar.gz: b3ae36a6ee1500cceb6a7ee53f3d3d56246c143836ef8cc76169f8e51dd5a87a
+  metadata.gz: 816c658af1a3631341c32bc6de8c315c9630dabc514f2afaafce3e5d2a08c4c5
+  data.tar.gz: 91eb4d147fdda1bd77860ed0ee7cf407baec1882fd56075a5092850663eaec14
 SHA512:
-  metadata.gz: 0eefb3cffa6fe189951d47c978ae6a728fb5919a0f9eaaef62bedea886721379c470d81f9c0c57f4e5b87a0b6b14f31693a74e98c3a2fd016ea8364bed76b8b6
-  data.tar.gz: 7415cb6326ec3cbd80de5b34a068acffc1220f4e2c9def4b6e230adc660cf1ad8486e2febe92e1e5e0ea7eea6467622fdd26eba2a2f2e4d1a9d3361ba3674fde
+  metadata.gz: 76945af6f21860703b3c0e5f0e78bb24d9411698fd6bc98576e03eadd2bc5d86e60600539ee081f26003431e06d35d5fde4f47b604b4880974a401954da914b1
+  data.tar.gz: 60a05bd402183c8797523df22d8f3c947f650f059ec18ad2a02420639c821224d007b6f2eaf57696ca0776aec359d2e6265be1591f77c38f43338ddcbadb8714

data/README.md

@@ -47,58 +47,96 @@ showing bottom (worst) 15 of 69 files
 
 ## Configuration
 
-### Disabling colorized output
+simplecov-console is configurable through environment variables and/or via Ruby
+code, generally in your test helper or setup file.
 
-Simply export `NO_COLOR=1` and colors will be disabled.
+### Options
+
+```ruby
+SimpleCov::Formatter::Console.sort = 'path' # sort by file path
+SimpleCov::Formatter::Console.show_covered = true # show all files in coverage report
+SimpleCov::Formatter::Console.max_rows = 15 # integer
+SimpleCov::Formatter::Console.max_lines = 5 # integer
+SimpleCov::Formatter::Console.missing_len = 20 # integer
+SimpleCov::Formatter::Console.output_style = 'block' # 'table' (default) or 'block'
+SimpleCov::Formatter::Console.table_options = {:style => {:width => 200}}
+```
+
+Note that all options except `table_options` can also be set via env var using
+the uppercase name, e.g., `MAX_ROWS`.
+
+#### Disabling colorized output
+
+Color support is active by default. To disable, export `NO_COLOR=1`:
 
 ```sh
 NO_COLOR=1 rake test
 ```
 
-### Sorting the output
+#### 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:
+By default the coverage report sorts by coverage % in descending order.  To
+sort alphabetically by path:
 
 ```ruby
 SimpleCov::Formatter::Console.sort = 'path' # sort by file path
 ```
 
-### Showing covered files
+#### 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:
+By default, fully covered files are excluded from the report. To include them:
 
 ```ruby
 SimpleCov::Formatter::Console.show_covered = true # show all files in coverage report
 ```
 
-### Maximum rows displayed
+#### 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:
+By default, a maximum of 15 files with the worst coverage are displayed in the
+report. To override this limit:
 
 ```ruby
-SimpleCov::Formatter::Console.max_rows = # some number
+SimpleCov::Formatter::Console.max_rows = 20 # integer
 ```
 
-Setting a value of `-1` or `nil` will show all of the files.
+Setting a value of `-1` or `nil` (in Ruby) will show all files.
 
-### Table options
+#### Maximum lines displayed
 
-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:
+By default, all missing lines will be included for each displayed file. For
+large source files with poor coverage, this may become unwieldy. To show fewer
+groups of lines:
+
+```ruby
+SimpleCov::Formatter::Console.max_lines = 5 # integer
+```
+
+#### Maximum length of missing lines
+
+As an alternative to the above `max_lines` option, you may limit the missing
+lines output by number of characters:
+
+```ruby
+SimpleCov::Formatter::Console.missing_len = 20 # integer
+```
+
+#### Table options
+
+In some cases, you may need to pass some options to `TerminalTable.new`. For
+example, if the filenames truncate so much that you can't read them, try
+increasing the table width:
 
 ```ruby
 SimpleCov::Formatter::Console.table_options = {:style => {:width => 200}}
-SimpleCov.formatter = SimpleCov::Formatter::Console
 ```
 
-### Block output style
+#### Block output style
 
-As an alternative to the default table output format, results can be printed as plain text blocks instead by setting
-the formatter `output_style` to 'block':
+As an alternative to the default table output format, a simpler block format is
+also available:
 
 ```ruby
 SimpleCov::Formatter::Console.output_style = 'block'
-SimpleCov.formatter = SimpleCov::Formatter::Console
 ```
 
 Example output:
@@ -133,7 +171,9 @@ coverage: 44.00% (28/50 lines)
 
 ### Branch Coverage Support
 
-When branch coverage is [enabled in simplecov](https://github.com/simplecov-ruby/simplecov/tree/818bc2547842a90c607b4fec834320766a8686de#branch-coverage-ruby--25), branch info will automatically be displayed in the output:
+When branch coverage is [enabled in
+simplecov](https://github.com/simplecov-ruby/simplecov/tree/818bc2547842a90c607b4fec834320766a8686de#branch-coverage-ruby--25),
+branch info will automatically be displayed in the output:
 
 ```text
 COVERAGE:  78.26% -- 18/23 lines in 2 files
@@ -148,6 +188,10 @@ BRANCH COVERAGE:  83.33% -- 5/6 branches in 2 branches
 
 ## History
 
+### 0.9 (2021.01.21)
+
+- Added support for limiting number of lines shown
+
 ### 0.8 (2020.11.11)
 
 - Added support for branch coverage - thanks [@robotdana!](https://github.com/robotdana) ([#19](https://github.com/chetan/simplecov-console/pull/19))

data/VERSION

@@ -1 +1 @@
-0.8.0
+0.9.0

data/lib/simplecov-console.rb

@@ -4,7 +4,9 @@ class SimpleCov::Formatter::Console
 
   VERSION = IO.read(File.expand_path("../../VERSION", __FILE__)).strip
 
-  ATTRIBUTES = [:table_options, :use_colors, :max_rows, :show_covered, :sort, :output_style]
+  ATTRIBUTES = [:table_options, :use_colors, :max_rows, :max_lines,
+    :missing_len, :show_covered, :sort, :output_style]
+
   class << self
     attr_accessor(*ATTRIBUTES)
   end
@@ -16,6 +18,10 @@ class SimpleCov::Formatter::Console
   # configure max rows from MAX_ROWS env var
   SimpleCov::Formatter::Console.max_rows = ENV.fetch('MAX_ROWS', 15).to_i
 
+  # configure max lines per row and missing len
+  SimpleCov::Formatter::Console.max_lines = ENV.fetch('MAX_LINES', 0).to_i
+  SimpleCov::Formatter::Console.missing_len = ENV.fetch('MISSING_LEN', 0).to_i
+
   # configure show_covered from SHOW_COVERED env var
   SimpleCov::Formatter::Console.show_covered = ENV.fetch('SHOW_COVERED', 'false') == 'true'
 
@@ -77,7 +83,7 @@ class SimpleCov::Formatter::Console
         files = result.files.sort_by(&:covered_percent)
       end
     else
-      files = result.files
+      files = result.files.to_a
     end
 
     covered_files = 0
@@ -117,6 +123,11 @@ class SimpleCov::Formatter::Console
     end
   end
 
+  # Group missed lines for better display
+  #
+  # @param [Array<SimpleCov::SourceFile::Line>] missed    array of missed lines reported by SimpleCov
+  #
+  # @return [Array<String>] Missing groups of lines
   def missed(missed_lines)
     groups = {}
     base = nil
@@ -142,9 +153,25 @@ class SimpleCov::Formatter::Console
       end
     end
 
+    if SimpleCov::Formatter::Console.max_lines > 0 then
+      # show at most N missing groups of lines
+      group_str = group_str[0, SimpleCov::Formatter::Console.max_lines] << "..."
+    end
+
     group_str
   end
 
+  # Truncate string to at most N chars (as defined by missing_len)
+  def trunc(str)
+    return str if str.include?("...") # already truncated, skip
+
+    len = SimpleCov::Formatter::Console.missing_len
+    if len > 0 && str.size > len then
+      str = str[0, len].gsub(/,(\s+)?$/, '') + ' ...'
+    end
+    str
+  end
+
   def pct(number)
     sprintf("%6.2f%%", number)
   end

data/lib/simplecov-console/output/block.rb

@@ -11,7 +11,7 @@ class SimpleCov::Formatter::Console
         block << sprintf("%8.8s: %s (%d/%d lines)", 'coverage',
                     colorize(sprintf("%.2f%%", f.covered_percent)),
                     f.covered_lines.count, f.lines_of_code)
-        block << sprintf("%8.8s: %s", 'missed', missed(f.missed_lines).join(", "))
+        block << sprintf("%8.8s: %s", 'missed', trunc(missed(f.missed_lines).join(", ")))
         if show_branch
           block << sprintf("%8.8s: %s (%d/%d branches)", 'branches',
                     colorize(sprintf("%.2f%%", f.coverage_statistics[:branch].percent)),

data/lib/simplecov-console/output/table.rb

@@ -11,7 +11,7 @@ class SimpleCov::Formatter::Console
           f.filename.gsub(root + "/", ''),
           f.lines_of_code,
           f.missed_lines.count,
-          missed(f.missed_lines).join(", "),
+          trunc(missed(f.missed_lines).join(", ")),
         ]
         if show_branch
           row += [

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.8.0 ruby lib
+# stub: simplecov-console 0.9.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "simplecov-console".freeze
-  s.version = "0.8.0"
+  s.version = "0.9.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 = "2020-11-11"
+  s.date = "2021-01-21"
   s.description = "Simple console output formatter for SimpleCov".freeze
   s.email = "chetan@pixelcop.net".freeze
   s.extra_rdoc_files = [

data/test/test_simplecov-console.rb

@@ -40,6 +40,7 @@ class TestSimplecovConsole < MiniTest::Test
 
   def teardown
     SimpleCov::Formatter::Console.output_style = 'table'
+    SimpleCov::Formatter::Console.max_lines = 0
   end
 
   def test_defined
@@ -51,7 +52,15 @@ class TestSimplecovConsole < MiniTest::Test
     missed_lines = [Line.new(1), Line.new(2),
                     Line.new(3), Line.new(5)]
     expected_result = ["1-3", "5"]
-    assert_equal @console.missed(missed_lines), expected_result
+    assert_equal expected_result, @console.missed(missed_lines)
+  end
+
+  def test_max_missed
+    SimpleCov::Formatter::Console.max_lines = 1
+    missed_lines = [Line.new(1), Line.new(2),
+                    Line.new(3), Line.new(5)]
+    expected_result = ["1-3", "..."]
+    assert_equal expected_result, @console.missed(missed_lines)
   end
 
   def test_table_output

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplecov-console
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Chetan Sarva
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-11 00:00:00.000000000 Z
+date: 2021-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov