simplecov-markdown 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ee812d070b98156101ee6b0186a3b6a11ae67325a3f593894fdf9036b702ac0
-  data.tar.gz: 65aa27e39c12f6916b4a3144eeab39bad45a4903d1273b3321c79a4a0700652f
+  metadata.gz: f38d023d1882b61f76b7896c5afeaafe8136a61d19431cd6b30714e4908f4d04
+  data.tar.gz: f4f797601b506642c93f04d8ef541a2dfc7bf4b4dea5b5a890aa3d6549081638
 SHA512:
-  metadata.gz: 1a026ad0b6128b40e366928d33961dab0a068ab9d0f2c1f15cac7c304c38263a898aa8a97d4ace3abdb8414d7d7d192dfc9f80ed446793641d04a331c72c4491
-  data.tar.gz: 93fbdfd1da279271c15bae0bff46b45a8dbf35884640a91a55324c5be838642b0621c7502a834e6ed1071297dcd965710d5db10fcdf9155705576132bc4ab31e
+  metadata.gz: f1d2bbf9c36651b81b7c22e121c5e727836a0215ffff4a3831803757e456746b89ec71f016db5c15c9cc122130b670cd34efb3a3892b61e7c6f052690bb052ee
+  data.tar.gz: 4da7f098aae3329e934d12a21b16e30c76b16a5a145132d1d03f445b1a5273669adef416e0b3f0250644a94e0012df9cf2bb78f5362d70aa357d7e345fe9ebe6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simplecov-markdown (1.0.0)
+    simplecov-markdown (1.1.0)
       simplecov
 
 GEM
@@ -64,7 +64,7 @@ CHECKSUMS
   simplecov (0.22.0) sha256=fe2622c7834ff23b98066bb0a854284b2729a569ac659f82621fc22ef36213a5
   simplecov-console (0.9.5) sha256=b1108bcfff5f210143e2b8301698c367b01586f20d25a73e95475a5df6fc6ff6
   simplecov-html (0.13.2) sha256=bd0b8e54e7c2d7685927e8d6286466359b6f16b18cb0df47b508e8d73c777246
-  simplecov-markdown (1.0.0)
+  simplecov-markdown (1.1.0)
   simplecov_json_formatter (0.1.4) sha256=529418fbe8de1713ac2b2d612aa3daa56d316975d307244399fa4838c601b428
   terminal-table (4.0.0) sha256=f504793203f8251b2ea7c7068333053f0beeea26093ec9962e62ea79f94301d2
   unicode-display_width (3.2.0) sha256=0cdd96b5681a5949cdbc2c55e7b420facae74c4aaf9a9815eee1087cb1853c42

data/README.md

@@ -1,18 +1,50 @@
-SimpleCov Markdown Formatter
-==================================
+# SimpleCov Markdown Formatter
 
 [![Gem Version](https://badge.fury.io/rb/simplecov-markdown.svg)](https://badge.fury.io/rb/simplecov-markdown)
 [![CI](https://github.com/renuo/simplecov-markdown/actions/workflows/ci.yml/badge.svg)](https://github.com/renuo/simplecov-markdown/actions/workflows/ci.yml)
 
-Install
-----------------------------
+Adds a report in markdown format. This can be useful in CI context or for LLMs. 
 
-	gem install simplecov-markdown
+## Install
 
-Usage
-----------------------------
+```
+gem install simplecov-markdown
+```
+
+## Usage
 
 ```ruby
 require 'simplecov-markdown'
 SimpleCov.formatter = SimpleCov::Formatter::MarkdownFormatter
 ```
+
+if you want to configure multiple formatters:
+
+```ruby
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
+                                                                 SimpleCov::Formatter::HTMLFormatter,
+                                                                 SimpleCov::Formatter::MarkdownFormatter
+                                                               ])
+```
+
+## Alternatives
+
+LLMs and CI environments work well also with [simplecov-console](https://github.com/chetan/simplecov-console).
+
+## Changelog
+
+### 1.1.0
+
+- **Support branch coverage**
+
+### 1.0.0
+
+- **Sorted results by coverage** — files are now sorted ascending by coverage percentage, so the least covered files appear first
+- **Missing line numbers** — the report now includes a "Missing line numbers" column listing the exact line numbers not covered, instead of just a count
+- **Revised table columns** — columns reordered and renamed: `Coverage`, `File`, `Total lines`, `Total missed`, `Missing line numbers`
+- **Ruby 4.0 support** — tested against Ruby 3.2, 3.3, and 4.0 via GitHub Actions CI
+- **Dropped legacy dependencies** — removed `coveralls`, `rspec-temp_dir`, and loosened `bundler`/`rake` version constraints
+
+### 0.2.0
+
+Initial release by [holyshared](https://github.com/holyshared/simplecov-markdown).

data/lib/simplecov-markdown/version.rb

@@ -1,7 +1,7 @@
 module SimpleCov
   module Formatter
     class MarkdownFormatter
-      VERSION = "1.0.0"
+      VERSION = "1.1.0"
     end
   end
 end

data/lib/simplecov-markdown.rb

@@ -18,7 +18,6 @@ class SimpleCov::Formatter::MarkdownFormatter
 
     def initialize(report_path)
       @report = File.open(report_path, 'w')
-      @table_writer = TableWriter.new(report)
     end
 
     def write_header(title)
@@ -34,33 +33,59 @@ class SimpleCov::Formatter::MarkdownFormatter
     end
 
     def write_result(result)
-      @table_writer.write_header
+      branch_coverage_enabled = result.files.any? { |f| f.total_branches.any? }
+      table_writer = TableWriter.new(@report, branch_coverage: branch_coverage_enabled)
+      table_writer.write_header
       result.files.sort_by(&:covered_percent).each do |file|
-        missing_lines = file.missed_lines.map(&:line_number).join(", ")
-        @table_writer.write_record(
+        missing_lines = format_line_numbers(file.missed_lines.map(&:line_number))
+        args = [
           file.covered_percent.round(2).to_s + "%",
-          file.filename,
+          relative_path(file.filename),
           file.lines_of_code,
           file.missed_lines.size,
           missing_lines
-        )
+        ]
+        if branch_coverage_enabled
+          missing_branches = file.missed_branches.map { |b| "#{b.start_line}[#{b.type}]" }.join(", ")
+          args += [file.branches_coverage_percent.round(2).to_s + "%", missing_branches]
+        end
+        table_writer.write_record(*args)
       end
-      @table_writer.destroy!
+      table_writer.destroy!
     end
 
     def destroy!
       @report.close
       @report = nil
     end
+
+    private
+
+    def relative_path(filename)
+      filename.delete_prefix(SimpleCov.root + "/")
+    end
+
+    def format_line_numbers(line_numbers)
+      return "" if line_numbers.empty?
+
+      line_numbers.chunk_while { |a, b| b == a + 1 }.map do |group|
+        group.size >= 2 ? "#{group.first}-#{group.last}" : group.first.to_s
+      end.join(", ")
+    end
   end
 
   class TableWriter
     attr_reader :report, :columns_headers, :columns_header_aligns
 
-    def initialize(report)
+    def initialize(report, branch_coverage: false)
       @report = report
-      @columns_headers = ["Coverage", "File", "Total lines", "Total missed", "Missing line numbers"]
-      @columns_header_aligns = [:right, :left, :right, :right, :left]
+      if branch_coverage
+        @columns_headers = ["Coverage", "File", "Total lines", "Total missed", "Missing line numbers", "Branch coverage", "Missing branches"]
+        @columns_header_aligns = [:right, :left, :right, :right, :left, :right, :left]
+      else
+        @columns_headers = ["Coverage", "File", "Total lines", "Total missed", "Missing line numbers"]
+        @columns_header_aligns = [:right, :left, :right, :right, :left]
+      end
     end
 
     def write_header

data/spec/fixtures/expected_report.md.erb

@@ -4,8 +4,8 @@ Code Coverage Report
 Project name: <%= project_name %>
 Created at: <%= created_at %>
 
-|Coverage|File|Total lines|Total missed|Missing line numbers|
-|--:|:--|--:|--:|:--|
-|62.5%|<%= root_directory %>/fixtures/sample3.rb|8|3|8, 12, 13|
-|80.0%|<%= root_directory %>/fixtures/sample2.rb|5|1|8|
-|100.0%|<%= root_directory %>/fixtures/sample1.rb|5|0||
+|Coverage|File|Total lines|Total missed|Missing line numbers|Branch coverage|Missing branches|
+|--:|:--|--:|--:|:--|--:|:--|
+|54.55%|<%= root_directory.delete_prefix(SimpleCov.root + "/") %>/fixtures/sample3.rb|11|5|11, 15-17, 19|25.0%|11[else], 17[then], 19[else]|
+|85.71%|<%= root_directory.delete_prefix(SimpleCov.root + "/") %>/fixtures/sample2.rb|7|1|11|50.0%|11[else]|
+|100.0%|<%= root_directory.delete_prefix(SimpleCov.root + "/") %>/fixtures/sample1.rb|7|0||100.0%||

data/spec/fixtures/sample1.rb

@@ -1,10 +1,14 @@
 # Sample1 class
 class Sample1
-  def initialize
-    @foo = 'baz'
+  def initialize(value)
+    @value = value
   end
 
-  def bar
-    @foo
+  def describe
+    if @value > 0
+      "positive"
+    else
+      "non-positive"
+    end
   end
 end

data/spec/fixtures/sample2.rb

@@ -1,10 +1,14 @@
 # Sample2 class
 class Sample2
-  def initialize
-    @foo = 'baz'
+  def initialize(value)
+    @value = value
   end
 
-  def bar
-    @foo
+  def describe
+    if @value > 0
+      "positive"
+    else
+      "non-positive"
+    end
   end
 end

data/spec/fixtures/sample3.rb

@@ -1,14 +1,22 @@
 # Sample3 class
 class Sample3
-  def initialize
-    @foo = 'baz'
+  def initialize(value)
+    @value = value
   end
 
-  def bar
-    @foo
+  def describe
+    if @value > 0
+      "positive"
+    else
+      "non-positive"
+    end
   end
 
-  def baz
-    @foo + 'baz'
+  def check
+    if @value.zero?
+      "zero"
+    else
+      "non-zero"
+    end
   end
 end

data/spec/simplecov-markdown_spec.rb

@@ -16,15 +16,44 @@ RSpec.describe 'MarkdownFormatter' do
     erb_script = File.open(File.join(File.dirname(__FILE__), 'fixtures/expected_report.md.erb')).read
     ERB.new(erb_script).result(binding)
   end
+
   let(:result) do
     sample1 = File.join(File.dirname(__FILE__), 'fixtures', 'sample1.rb')
     sample2 = File.join(File.dirname(__FILE__), 'fixtures', 'sample2.rb')
     sample3 = File.join(File.dirname(__FILE__), 'fixtures', 'sample3.rb')
 
     original_result = {
-      sample1 => { "lines" => [nil, 1, 1, 1, nil, nil, 1, 1, nil, nil] },
-      sample2 => { "lines" => [nil, 1, 1, 1, nil, nil, 1, 0, nil, nil] },
-      sample3 => { "lines" => [nil, 1, 1, 1, nil, nil, 1, 0, nil, nil, 1, 0, 0, nil] }
+      sample1 => {
+        "lines" => [nil, 1, 1, 1, nil, nil, 1, 1, 1, nil, 1, nil, nil, nil],
+        "branches" => {
+          [:if, 0, 8, 4, 12, 7] => {
+            [:then, 0, 9, 6, 9, 14] => 1,
+            [:else, 0, 11, 6, 11, 19] => 1
+          }
+        }
+      },
+      sample2 => {
+        "lines" => [nil, 1, 1, 1, nil, nil, 1, 1, 1, nil, 0, nil, nil, nil],
+        "branches" => {
+          [:if, 0, 8, 4, 12, 7] => {
+            [:then, 0, 9, 6, 9, 14] => 1,
+            [:else, 0, 11, 6, 11, 19] => 0
+          }
+        }
+      },
+      sample3 => {
+        "lines" => [nil, 1, 1, 1, nil, nil, 1, 1, 1, nil, 0, nil, nil, nil, 0, 0, 0, nil, 0, nil, nil, nil],
+        "branches" => {
+          [:if, 0, 8, 4, 12, 7] => {
+            [:then, 0, 9, 6, 9, 14] => 1,
+            [:else, 0, 11, 6, 11, 19] => 0
+          },
+          [:if, 1, 16, 4, 20, 7] => {
+            [:then, 0, 17, 6, 17, 10] => 0,
+            [:else, 0, 19, 6, 19, 14] => 0
+          }
+        }
+      }
     }
     SimpleCov::Result.new(original_result)
   end

data/spec/spec_helper.rb

@@ -2,12 +2,11 @@ $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'simplecov'
 require 'simplecov-console'
 
-SimpleCov.add_filter do |source_file|
-  source_file.filename =~ /spec/ && !(source_file.filename =~ /fixtures/)
+SimpleCov.start do
+  enable_coverage :branch
+  add_filter { |f| f.filename =~ /spec/ && !(f.filename =~ /fixtures/) }
 end
 
-SimpleCov.start
-
 require 'simplecov-markdown'
 
 if ENV["COVERALLS_REPO_TOKEN"]
@@ -15,6 +14,7 @@ if ENV["COVERALLS_REPO_TOKEN"]
   Coveralls.wear!
 else
   SimpleCov.formatters = [
+    SimpleCov::Formatter::HTMLFormatter,
     SimpleCov::Formatter::Console,
     SimpleCov::Formatter::MarkdownFormatter
   ]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simplecov-markdown
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Alessandro Rodi