simplecov-table 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6e3aafc3c5c93e9bd6d514f083407737abebad68ac733306ab3fe105e77f370
-  data.tar.gz: 4b9bfcde11e1c38000e7359c0e3b291e07a1a7f37d6e7a109fc5f023a3a8e1da
+  metadata.gz: fc28d11cf99048676421d6e706105883378877a788b850714b747743465021fb
+  data.tar.gz: 9eac3ca3b0f4cab12ea1bf6f5f202199f0d3d18525bae4ad4838d0bc9f666ed3
 SHA512:
-  metadata.gz: 458127c342f2ec2ba66b6084f8224009ac08e8aa5f61029a656c18d6c1261693641884e62874506ee0ca0dc593a3bf79689c673c855a41555ec5e659c4c28237
-  data.tar.gz: 6dcdc99db04d06658d25e6a35c2fe8c9c4e91c084301740fd3bf60776fb1e517fd2a5d92c9f79e8b51514f40ccb35a9b49aaef61f2164db2f0302218a0f6bdc3
+  metadata.gz: a4a677abb3a9ef7e9201afe4d5c6e775d923389bc52bd36e0ff13a2e5313598965f4ad4337b370f49a2164c05b6406055ac98c3bdba997ccb10952bf7c96b99c
+  data.tar.gz: c7014aedb4862b108cc267fa7ea5deffa43bd78894bded199d76331358e714ac25a624c6d0502000856d03cc8c61b50197369368064615b0519b67b813018feb

data/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+group :development do
+  gem 'rake'
+  gem 'rspec'
+  gem 'simplecov', '~> 0.18'
+end

data/lib/simplecov-table.rb

@@ -0,0 +1,109 @@
+fail 'simplecov-table requires simplecov' unless defined?(SimpleCov)
+require 'io/console'
+
+module SimpleCov
+  module Formatter
+    class TableFormatter
+
+      def format(coverage)
+        if coverage == nil then
+          $stderr.puts 'No coverage data'
+          return
+        end
+
+        table = {
+          'Files'           => ['Files'],
+          'Coverage'        => ['Coverage'],
+          'Uncovered lines' => ['Uncovered lines'],
+        }
+
+        coverage.files.each do |file|
+          if file.no_lines? then
+            continue
+          end
+          table['Files'].push(File.basename(file.filename))
+          table['Coverage'].push(file.covered_percent.round(1).to_s + '%')
+          table['Uncovered lines'].push(group_lines(file.missed_lines))
+        end
+
+        print_table(table)
+      end
+
+      private
+
+      def group_lines(lines)
+        if lines.length == 0 then
+          return ''
+        end
+
+        groups = []
+        group_start = group_end = lines.first.number
+
+        lines[1..].each do |line|
+          if line.number == group_end + 1 then
+            group_end = line.number
+          else
+            add_group(groups, group_start, group_end)
+            group_start = group_end = line.number
+          end
+        end
+        # Ensure the last group is closed
+        add_group(groups, group_start, group_end)
+
+        groups.join(',')
+      end
+
+      def add_group(groups, group_start, group_end)
+        if group_end == nil || group_end == group_start then
+          groups.push(group_start.to_s)
+        elsif group_end == group_start + 1
+          groups.push(group_start.to_s, group_end.to_s)
+        else
+          groups.push(group_start.to_s + '-' + group_end.to_s)
+        end
+      end
+
+      def print_table(table)
+        headers = table.keys
+        columns = table.values
+
+        terminal_width = IO.console.winsize[1]
+        columns_widths = columns[0..-2].map { |column| column.map(&:length).max }
+        # The last column takes all the remaining horizontal space
+        columns_widths.push(terminal_width - (columns_widths.sum + 3*columns_widths.length) - 2)
+
+        rows = columns.first
+          .each_index
+          .map { |row_index| get_row(columns.map { |column| column[row_index] }, columns_widths) }
+
+        print [
+          '',
+          get_row_separator(columns_widths, '┬'),
+          get_row(headers, columns_widths),
+          get_row_separator(columns_widths, '┼'),
+          rows[1..].join("\n"),
+          get_row_separator(columns_widths, '┴'),
+          "\n",
+        ].join("\n")
+      end
+
+      def get_row(cells, columns_widths)
+        row = cells
+          .map.with_index { |cell, index| pad_string(cell, columns_widths[index]) }
+          .join(' │ ')
+        ' ' + row
+      end
+
+      def get_row_separator(columns_widths, cell_separator)
+        columns_widths
+          .map { |width| '─' * (width + 2) }
+          .join(cell_separator)
+      end
+
+      def pad_string(string, length)
+        string + ' ' * (length - string.length)
+      end
+
+    end
+  end
+end

data/simplecov-table.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name         = 'simplecov-table'
-  s.version      = '1.0.0'
+  s.version      = '1.0.1'
   s.summary      = 'A custom SimpleCov formatter to display summaries of coverage reports in table format.'
   s.description  = 'A custom SimpleCov formatter that displays table-formatted summaries of your coverage reports in the terminal. It prints the total coverage ratio of each source file, along with a compressed list of the uncovered lines.'
   s.authors      = ['cheap glitch']
@@ -9,13 +9,9 @@ Gem::Specification.new do |s|
   s.license      = 'ISC'
   s.require_path = 'lib'
   s.files        = Dir[
-    'LICENSE',
-    'lib/***/*.rb',
-    'spec/**/*.rb',
+    'lib/**/*.rb',
     'simplecov-table.gemspec',
-  ]
-  s.extra_rdoc_files = [
+    'Gemfile',
     'LICENSE',
-    'README.md',
   ]
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplecov-table
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - cheap glitch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-16 00:00:00.000000000 Z
+date: 2022-02-19 00:00:00.000000000 Z
 dependencies: []
 description: A custom SimpleCov formatter that displays table-formatted summaries
   of your coverage reports in the terminal. It prints the total coverage ratio of
@@ -16,17 +16,12 @@ description: A custom SimpleCov formatter that displays table-formatted summarie
 email: cheap.glitch@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE
-- README.md
+extra_rdoc_files: []
 files:
+- Gemfile
 - LICENSE
-- README.md
+- lib/simplecov-table.rb
 - simplecov-table.gemspec
-- spec/fixtures/bar.rb
-- spec/fixtures/foo.rb
-- spec/helpers.rb
-- spec/simplecov-table_spec.rb
 homepage: https://github.com/cheap-glitch/simplecov-table
 licenses:
 - ISC

data/README.md

@@ -1,65 +0,0 @@
-# 📊 simplecov-table
-
-![License](https://badgen.net/github/license/cheap-glitch/simplecov-table?color=green)
-![Latest release](https://badgen.net/github/release/cheap-glitch/simplecov-table?color=green)
-
-This   is   a  custom   [SimpleCov](https://github.com/simplecov-ruby/simplecov)
-formatter that  displays table-formatted summaries  of your coverage  reports in
-the terminal. It prints the total coverage ratio of each source file, along with
-a compressed list of the uncovered lines.
-
-```text
-────────────────────┬──────────┬──────────────────────────────────────
- Files              │ Coverage │ Uncovered lines
-────────────────────┼──────────┼──────────────────────────────────────
- lib/foo.rb         │ 78.0%    │ 11,12,20-27
- lib/foo/bar.rb     │ 100.0%   │
- lib/foo/baz.rb     │ 33.5%    │ 3,5,63-75,122,128
-────────────────────┴──────────┴──────────────────────────────────────
-```
-
-## Installation
-
-```shell
-gem install simplecov-table
-```
-
-## Usage
-
-```ruby
-require 'simplecov'
-require 'simplecov-table'
-
-SimpleCov.formatter = SimpleCov::Formatter::TableFormatter
-SimpleCov.start
-```
-
-Or, if you want to use several formatters:
-
-```ruby
-require 'simplecov'
-require 'simplecov-table'
-
-SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new([
-  SimpleCov::Formatter::HTMLFormatter,
-  SimpleCov::Formatter::TableFormatter,
-])
-SimpleCov.start
-```
-
-## Changelog
-
-See the full changelog [here](https://github.com/cheap-glitch/simplecov-table/releases).
-
-## Contributing
-
-Contributions are welcomed! Please open an issue before submitting substantial changes.
-
-## Related
-
- * [simplecov-erb](https://github.com/kpaulisse/simplecov-erb) - Flexible plain-text formatter that uses ERB templates
- * [simplecov-lcov](https://github.com/fortissimo1997/simplecov-lcov) - Simple LCOV formatter
-
-## License
-
-ISC

data/spec/fixtures/bar.rb

@@ -1,17 +0,0 @@
-class Bar
-  def uncovered_1
-    "foo: #{@foo}"
-  end
-
-  def bar
-    @a = 'bar'
-  end
-
-  def uncovered_2(a)
-    @a = a
-    @b = 'baz'
-    @c = false
-  end
-end
-
-Bar.new.bar

data/spec/fixtures/foo.rb

@@ -1,22 +0,0 @@
-class Foo
-  def foo
-    "foo: #{@foo}"
-  end
-
-  def bar
-    @a = 'bar'
-  end
-
-  def baz(b)
-    @a = b
-  end
-
-  def uncovered
-    @a = 'baz'
-  end
-end
-
-Foo.new.foo
-Foo.new.foo
-Foo.new.bar
-Foo.new.baz 'hello'

data/spec/helpers.rb

@@ -1,26 +0,0 @@
-# Taken from https://github.com/cldwalker/hirb/blob/master/test/test_helper.rb
-# Copyright (c) 2010 Gabriel Horner
-
-require 'stringio'
-
-def capture_stdout(&block)
-  original_stdout = $stdout
-  $stdout = fake = StringIO.new
-  begin
-    yield
-  ensure
-    $stdout = original_stdout
-  end
-  fake.string
-end
-
-def capture_stderr(&block)
-  original_stderr = $stderr
-  $stderr = fake = StringIO.new
-  begin
-    yield
-  ensure
-    $stderr = original_stderr
-  end
-  fake.string
-end

data/spec/simplecov-table_spec.rb

@@ -1,37 +0,0 @@
-require 'simplecov'
-
-require_relative 'helpers'
-require_relative '../lib/simplecov-table'
-
-FIXTURES_COVERAGE_DIR = 'spec/coverage'
-
-module SimpleCov::Formatter
-  describe TableFormatter do
-
-    before(:example) do
-      FileUtils.remove_dir(FIXTURES_COVERAGE_DIR, true) if Dir.exist?(FIXTURES_COVERAGE_DIR)
-      SimpleCov.coverage_dir FIXTURES_COVERAGE_DIR
-    end
-
-    it 'prints an error when there is no data' do
-      output = capture_stderr { TableFormatter.new.format(SimpleCov.result) }
-      expect(output).to eq("No coverage data\n")
-    end
-
-    it 'prints a pretty table' do
-      SimpleCov.start
-      load 'fixtures/foo.rb'
-      output = capture_stdout { TableFormatter.new.format(SimpleCov.result) }
-      expect(output).to match(/^ Files  │ Coverage │ Uncovered lines\s+$/m)
-      expect(output).to match(/^ foo\.rb │ 92\.3%    │ 15\s+$/m)
-    end
-
-    it 'groups adjacent uncovered lines together' do
-      SimpleCov.start
-      load 'fixtures/bar.rb'
-      output = capture_stdout { TableFormatter.new.format(SimpleCov.result) }
-      expect(output).to match(/^ bar\.rb │ 60\.0%    │ 3,11-13\s+$/m)
-    end
-
-  end
-end