simplecov-table 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b6e3aafc3c5c93e9bd6d514f083407737abebad68ac733306ab3fe105e77f370
+  data.tar.gz: 4b9bfcde11e1c38000e7359c0e3b291e07a1a7f37d6e7a109fc5f023a3a8e1da
+SHA512:
+  metadata.gz: 458127c342f2ec2ba66b6084f8224009ac08e8aa5f61029a656c18d6c1261693641884e62874506ee0ca0dc593a3bf79689c673c855a41555ec5e659c4c28237
+  data.tar.gz: 6dcdc99db04d06658d25e6a35c2fe8c9c4e91c084301740fd3bf60776fb1e517fd2a5d92c9f79e8b51514f40ccb35a9b49aaef61f2164db2f0302218a0f6bdc3

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2022-present, cheap glitch
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby  granted, provided that the above copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE  IS PROVIDED "AS IS"  AND THE AUTHOR DISCLAIMS  ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING  ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS.  IN NO  EVENT  SHALL THE  AUTHOR  BE LIABLE  FOR  ANY SPECIAL,  DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR  PROFITS, WHETHER IN AN ACTION OF  CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN  CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# 📊 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/simplecov-table.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name         = 'simplecov-table'
+  s.version      = '1.0.0'
+  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']
+  s.email        = 'cheap.glitch@gmail.com'
+  s.homepage     = 'https://github.com/cheap-glitch/simplecov-table'
+  s.license      = 'ISC'
+  s.require_path = 'lib'
+  s.files        = Dir[
+    'LICENSE',
+    'lib/***/*.rb',
+    'spec/**/*.rb',
+    'simplecov-table.gemspec',
+  ]
+  s.extra_rdoc_files = [
+    'LICENSE',
+    'README.md',
+  ]
+end

data/spec/fixtures/bar.rb

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,22 @@
+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

@@ -0,0 +1,26 @@
+# 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

@@ -0,0 +1,37 @@
+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

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: simplecov-table
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- cheap glitch
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-02-16 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
+  each source file, along with a compressed list of the uncovered lines.
+email: cheap.glitch@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- LICENSE
+- README.md
+- 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
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key:
+specification_version: 4
+summary: A custom SimpleCov formatter to display summaries of coverage reports in
+  table format.
+test_files: []