simplecov-console 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2102089eb7f589999a74c0f72b6f9108f1f065f61e63afe53dd58b79ae74ff34
-  data.tar.gz: b54f26ebe5bbcc86835867cd7cd00c0d62877b4441aa3a7a47d5df969a11ffe6
+  metadata.gz: c972c40225a8d1890e1a1b9d9e6cda1d55c9b7ec6e07e504dbd01e24ff834a10
+  data.tar.gz: b3ae36a6ee1500cceb6a7ee53f3d3d56246c143836ef8cc76169f8e51dd5a87a
 SHA512:
-  metadata.gz: 72c7fec2486cc4ec729032363d1c193e6dbb305c6159844d8816e6861c9cacb8fb0ce5994d2def99d596887b65426088f6f000e92e74fbbfce40868e511f1161
-  data.tar.gz: c66e0da4016b7a407b65b4553ed07e0fb06ec4a3ac5731fb3921bb87cc69612195afca285163f47f21de5c96de6371d4bdd32a53c285e52619cac25698ce820f
+  metadata.gz: 0eefb3cffa6fe189951d47c978ae6a728fb5919a0f9eaaef62bedea886721379c470d81f9c0c57f4e5b87a0b6b14f31693a74e98c3a2fd016ea8364bed76b8b6
+  data.tar.gz: 7415cb6326ec3cbd80de5b34a068acffc1220f4e2c9def4b6e230adc660cf1ad8486e2febe92e1e5e0ea7eea6467622fdd26eba2a2f2e4d1a9d3361ba3674fde

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+## 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))
+
+## 0.7.2 (2020.03.05)
+
+- Fix: table output include ([#17](https://github.com/chetan/simplecov-console/issues/17))
+
+## 0.7.1 (2020.03.05)
+
+- Fix: block output doesn't work with frozen string literal ([#16](https://github.com/chetan/simplecov-console/issues/16))
+
+## 0.7 (2020.03.04)
+
+- Added new 'block' style output option - thanks [@hpainter](https://github.com/hpainter)! ([#15](https://github.com/chetan/simplecov-console/issues/15))
+
+## 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

data/Gemfile

@@ -7,6 +7,6 @@ gem "ansi"
 group :development do
   gem "minitest"
   gem "yard"
-  gem "bundler", "~> 1.2"
+  gem "bundler", "~> 2.1"
   gem "juwelier"
 end

data/README.md

@@ -131,8 +131,27 @@ coverage: 44.00% (28/50 lines)
 42 file(s) with 100% coverage not shown
 ```
 
+### 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:
+
+```text
+COVERAGE:  78.26% -- 18/23 lines in 2 files
+BRANCH COVERAGE:  83.33% -- 5/6 branches in 2 branches
+
++----------+-------------------------------+-------+--------+---------------+-----------------+----------+-----------------+------------------+
+| coverage | file                          | lines | missed | missing       | branch coverage | branches | branches missed | branches missing |
++----------+-------------------------------+-------+--------+---------------+-----------------+----------+-----------------+------------------+
+|  72.22%  | lib/simplecov-console-test.rb | 18    | 5      | 10-12, 16, 25 |  83.33%         | 6        | 1               | 25[then]         |
++----------+-------------------------------+-------+--------+---------------+-----------------+----------+-----------------+------------------+
+```
+
 ## History
 
+### 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))
+
 ### 0.7.2 (2020.03.05)
 
 - Fix: table output include ([#17](https://github.com/chetan/simplecov-console/issues/17))

data/VERSION

@@ -1 +1 @@
-0.7.2
+0.8.0

data/lib/simplecov-console.rb

@@ -36,6 +36,11 @@ class SimpleCov::Formatter::Console
     end
   end
 
+  def show_branch_coverage?(result)
+    Gem::Version.new(SimpleCov::VERSION) >= Gem::Version.new('0.18.5') &&
+      result.coverage_statistics[:branch]
+  end
+
   def format(result)
     include_output_style
 
@@ -51,7 +56,11 @@ class SimpleCov::Formatter::Console
     end
 
     puts
-    puts "COVERAGE: #{colorize(pct(result))} -- #{result.covered_lines}/#{result.total_lines} lines in #{result.files.size} files"
+    puts "COVERAGE: #{colorize(pct(result.covered_percent))} -- #{result.covered_lines}/#{result.total_lines} lines in #{result.files.size} files"
+    show_branch_coverage = show_branch_coverage?(result)
+    if show_branch_coverage
+      puts "BRANCH COVERAGE: #{colorize(pct(result.coverage_statistics[:branch].percent))} -- #{result.covered_branches}/#{result.total_branches} branches in #{result.files.size} branches"
+    end
     puts
 
     if root.nil? then
@@ -59,7 +68,14 @@ class SimpleCov::Formatter::Console
     end
 
     if SimpleCov::Formatter::Console.sort == 'coverage'
-      files = result.files.sort{ |a,b| a.covered_percent <=> b.covered_percent }
+      if show_branch_coverage
+        files = result.files.sort do |a,b|
+          (a.covered_percent <=> b.covered_percent).nonzero? ||
+            (a.coverage_statistics[:branch].percent <=> b.coverage_statistics[:branch].percent)
+        end
+      else
+        files = result.files.sort_by(&:covered_percent)
+      end
     else
       files = result.files
     end
@@ -68,7 +84,7 @@ class SimpleCov::Formatter::Console
 
     unless SimpleCov::Formatter::Console.show_covered
       files.select!{ |file|
-        if file.covered_percent == 100 then
+        if file.covered_percent == 100 && (!show_branch_coverage || file.coverage_statistics[:branch].percent == 100) then
           covered_files += 1
           false
         else
@@ -87,7 +103,7 @@ class SimpleCov::Formatter::Console
       files = files.slice(0, max_rows)
     end
 
-    puts output(files,root)
+    puts output(files, root, show_branch_coverage)
 
     if covered_files > 0 then
       puts "#{covered_files} file(s) with 100% coverage not shown"
@@ -95,6 +111,12 @@ class SimpleCov::Formatter::Console
 
   end
 
+  def branches_missed(missed_branches)
+    missed_branches.group_by(&:start_line).map do |line_number, branches|
+      "#{line_number}[#{branches.map(&:type).join(',')}]"
+    end
+  end
+
   def missed(missed_lines)
     groups = {}
     base = nil
@@ -123,8 +145,8 @@ class SimpleCov::Formatter::Console
     group_str
   end
 
-  def pct(obj)
-    sprintf("%6.2f%%", obj.covered_percent)
+  def pct(number)
+    sprintf("%6.2f%%", number)
   end
 
   def use_colors?
@@ -144,5 +166,4 @@ class SimpleCov::Formatter::Console
       ANSI.red { s }
     end
   end
-
 end

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

@@ -3,7 +3,7 @@ class SimpleCov::Formatter::Console
   module BlockOutput
 
     # format per-file results output as plain text blocks
-    def output(files, root)
+    def output(files, root, show_branch)
       blocks = []
       files.each do |f|
         block = []
@@ -12,6 +12,12 @@ class SimpleCov::Formatter::Console
                     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(", "))
+        if show_branch
+          block << sprintf("%8.8s: %s (%d/%d branches)", 'branches',
+                    colorize(sprintf("%.2f%%", f.coverage_statistics[:branch].percent)),
+                    (f.total_branches.count - f.missed_branches.count), f.total_branches.count)
+          block << sprintf("%8.8s: %s", 'missed', branches_missed(f.missed_branches).join(", "))
+        end
         blocks << block.join("\n")
       end
 

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

@@ -4,15 +4,25 @@ class SimpleCov::Formatter::Console
   module TableOutput
 
     # format per-file results output using Terminal::Table
-    def output(files, root)
+    def output(files, root,show_branch)
       table = files.map do |f|
-        [
-          colorize(pct(f)),
+        row = [
+          colorize(pct(f.covered_percent)),
           f.filename.gsub(root + "/", ''),
           f.lines_of_code,
           f.missed_lines.count,
-          missed(f.missed_lines).join(", ")
+          missed(f.missed_lines).join(", "),
         ]
+        if show_branch
+          row += [
+            colorize(pct(f.coverage_statistics[:branch].percent)),
+            f.total_branches.count,
+            f.missed_branches.count,
+            branches_missed(f.missed_branches).join(", ")
+          ]
+        end
+
+        row
       end
 
       table_options = SimpleCov::Formatter::Console.table_options || {}
@@ -21,6 +31,14 @@ class SimpleCov::Formatter::Console
       end
 
       headings = %w{ coverage file lines missed missing }
+      if show_branch
+        headings += [
+          'branch coverage',
+          'branches',
+          'branches missed',
+          'branches missing'
+        ]
+      end
 
       opts = table_options.merge({:headings => headings, :rows => table})
       Terminal::Table.new(opts)

data/simplecov-console.gemspec

@@ -2,24 +2,26 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: simplecov-console 0.7.2 ruby lib
+# stub: simplecov-console 0.8.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "simplecov-console".freeze
-  s.version = "0.7.2"
+  s.version = "0.8.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-03-04"
+  s.date = "2020-11-11"
   s.description = "Simple console output formatter for SimpleCov".freeze
   s.email = "chetan@pixelcop.net".freeze
   s.extra_rdoc_files = [
+    "CHANGELOG.md",
     "LICENSE.txt",
     "README.md"
   ]
   s.files = [
     ".document",
+    "CHANGELOG.md",
     "Gemfile",
     "LICENSE.txt",
     "README.md",
@@ -34,36 +36,28 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/chetan/simplecov-console".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.0.2".freeze
+  s.rubygems_version = "3.1.4".freeze
   s.summary = "Simple console output formatter".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
+  end
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      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>.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
+  if s.respond_to? :add_runtime_dependency then
+    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, ["~> 2.1"])
+    s.add_development_dependency(%q<juwelier>.freeze, [">= 0"])
   else
     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<bundler>.freeze, ["~> 2.1"])
     s.add_dependency(%q<juwelier>.freeze, [">= 0"])
   end
 end

data/test/test_simplecov-console.rb

@@ -14,10 +14,34 @@ class TestSimplecovConsole < MiniTest::Test
     :covered_percent
   )
 
+  CoverageStatistics = Struct.new(
+    :percent
+  )
+
+  Branch = Struct.new(
+    :start_line,
+    :type
+  )
+
+  SourceFileWithBranches = Struct.new(
+    :filename,
+    :lines_of_code,
+    :covered_lines,
+    :missed_lines,
+    :covered_percent,
+    :coverage_statistics,
+    :total_branches,
+    :missed_branches
+  )
+
   def setup
     @console = SimpleCov::Formatter::Console.new
   end
 
+  def teardown
+    SimpleCov::Formatter::Console.output_style = 'table'
+  end
+
   def test_defined
     assert defined?(SimpleCov::Formatter::Console)
     assert defined?(SimpleCov::Formatter::Console::VERSION)
@@ -36,7 +60,22 @@ class TestSimplecovConsole < MiniTest::Test
     files = [
       SourceFile.new('foo.rb',5,[2,3],[Line.new(1), Line.new(4), Line.new(5)],40.0)
     ]
-    actual = @console.output(files,'/')
+    actual = @console.output(files,'/',false)
+    assert actual.is_a? Terminal::Table
+    assert_equal 1, actual.rows.count
+  end
+
+  def test_table_output_with_branches
+    SimpleCov::Formatter::Console.output_style = 'table'
+    @console.include_output_style
+    files = [
+      SourceFileWithBranches.new(
+        'foo.rb',5,[2,3],[Line.new(1), Line.new(4), Line.new(5)],40.0,
+        {branch: CoverageStatistics.new(50.0)}, [1,2],
+        [Branch.new(2, :then)]
+      )
+    ]
+    actual = @console.output(files,'/',true)
     assert actual.is_a? Terminal::Table
     assert_equal 1, actual.rows.count
   end
@@ -50,6 +89,21 @@ class TestSimplecovConsole < MiniTest::Test
       SourceFile.new('foo.rb',5,[2,3],[Line.new(1), Line.new(4), Line.new(5)],40.0)
     ]
     expected = "\n    file: foo.rb\ncoverage: 40.00% (2/5 lines)\n  missed: 1, 4-5\n\n"
-    assert_equal expected, @console.output(files,'/')
+    assert_equal expected, @console.output(files,'/',false)
+  end
+
+  def test_block_output_with_branches
+    SimpleCov::Formatter::Console.use_colors = false
+    SimpleCov::Formatter::Console.output_style = 'block'
+    @console.include_output_style
+    files = [
+      SourceFileWithBranches.new(
+        'foo.rb',5,[2,3],[Line.new(1), Line.new(4), Line.new(5)],40.0,
+        {branch: CoverageStatistics.new(50.0)}, [1,2],
+        [Branch.new(2, :then)]
+      )
+    ]
+    expected = "\n    file: foo.rb\ncoverage: 40.00% (2/5 lines)\n  missed: 1, 4-5\nbranches: 50.00% (1/2 branches)\n  missed: 2[then]\n\n"
+    assert_equal expected, @console.output(files,'/',true)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplecov-console
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Chetan Sarva
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2020-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: juwelier
   requirement: !ruby/object:Gem::Requirement
@@ -113,10 +113,12 @@ email: chetan@pixelcop.net
 executables: []
 extensions: []
 extra_rdoc_files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 files:
 - ".document"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -132,7 +134,7 @@ homepage: http://github.com/chetan/simplecov-console
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -147,8 +149,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Simple console output formatter
 test_files: []