simplecov-compare 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1c84aeb5ca7098e9ef46d238a442ff1033e3ab9591cb035b010a51db6e64cf0
-  data.tar.gz: de4cdfdf2bd6ad0dddffba37a480c0f14d26a51b93721628bf43ebeabe51529f
+  metadata.gz: 7ef291a274c59e3f99f89fe974daf3381494e612ebb413ffb22de5df14b5b281
+  data.tar.gz: a59c739a7ed6201beef06f28b21350a182055d6df21c23d1b2e02f2e321749b1
 SHA512:
-  metadata.gz: 8243f62a3094c48af6fd763fbaece4ac75a5d4a54b38e01154ff609ac4ecd868e3a455b12d7fc552d1e3aa839240ba292065d2d4d8dc52227602e0fc2014e066
-  data.tar.gz: d9ff76b1d1035420e950fc5b5ceb2a4affc74cd68f024c39cfdd1493e3ff6c308e9546b1ff39a1427a5986baf2271d9b279c38fedab2fc7b191b1df1b6456378
+  metadata.gz: 52f01295501e38c96606790de5bbc859c2f28e3e1f6ba81f7df61d455e60af2a28898c9c02fbe67cd0cb7ab09cfef1114384a24980a79a300ad5ff0e3a109063
+  data.tar.gz: c0fb9433dff8ac96c9862de9a6ef8636f63fc2f20dc2e1d092b229b8ed207126d338e46f631c3c66e5c9225e22cf293558acdd497e6cea01c140a543b6bcaa38

data/.github/workflows/test.yml

@@ -0,0 +1,25 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [3.4, 4.0]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby }}
+      - name: Setup
+        run: ./bin/setup
+      - name: Run tests
+        run: bundle exec rake test

data/CHANGELOG.md

@@ -0,0 +1,35 @@
+## Current release (in development)
+
+## 0.2.0 [2026-03-08]
+
+* Markdown formatter shows the coverage before and after per file.
+
+  *Kevin Murphy*
+
+* Expose the number of relevant and covered lines per file.
+
+  *Kevin Murphy*
+
+* Add instructions about running on command line.
+
+  *Kevin Murphy*
+
+* Test against Ruby 3.4 and 4.0.
+
+  *Kevin Murphy*
+
+* Run tests in GitHub actions.
+
+  *Kevin Murphy*
+
+## 0.1.1 [2026-03-08]
+
+* Add checks that file paths are provided.
+
+  *Kevin Murphy*
+
+## 0.1.0 [2026-03-08]
+
+* Initial Release.
+
+  *Kevin Murphy*

data/README.md

@@ -6,22 +6,32 @@ mechanism to compare two Simplecov results.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add simplecov-compare
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install simplecov-compare
 ```
 
 ## Usage
 
+### Command Line
+
+Given an earlier coverage JSON output named `path/to/before.json` and a later
+report named `path/to/after.json`, you can run:
+
+```sh
+simplecov-compare path/to/before.json path/to/after.json
+```
+![result of simplecov-compare output in terminal](simplecov-compare-terminal.png?raw=true)
+
+### In Ruby
+
 Given an earlier coverage JSON output named `path/to/before.json` and a later
 report named `path/to/after.json`, you can run:
 

data/lib/simplecov/compare/file_comparison.rb

@@ -38,7 +38,43 @@ module Simplecov
         return @other.lines_covered_percent if @base.nil?
         return (-@base.lines_covered_percent) if @other.nil?
 
-        @other.lines_covered_percent - @base.lines_covered_percent
+        (@other.lines_covered_percent - @base.lines_covered_percent).round(2)
+      end
+
+      def original_lines_covered_percent
+        return 0 if @base.nil?
+
+        @base.lines_covered_percent
+      end
+
+      def original_num_relevant_lines
+        return 0 if @base.nil?
+
+        @base.num_relevant_lines
+      end
+
+      def original_num_covered_lines
+        return 0 if @base.nil?
+
+        @base.num_covered_lines
+      end
+
+      def new_lines_covered_percent
+        return 0 if @other.nil?
+
+        @other.lines_covered_percent
+      end
+
+      def new_num_relevant_lines
+        return 0 if @other.nil?
+
+        @other.num_relevant_lines
+      end
+
+      def new_num_covered_lines
+        return 0 if @other.nil?
+
+        @other.num_covered_lines
       end
     end
   end

data/lib/simplecov/compare/file_result.rb

@@ -29,14 +29,22 @@ module Simplecov
         lines.select { _1.relevant? }
       end
 
+      def num_relevant_lines
+        relevant_lines.size
+      end
+
       def covered_lines
         lines.select { _1.covered? }
       end
 
+      def num_covered_lines
+        covered_lines.size
+      end
+
       def lines_covered_percent
-        return 100 if relevant_lines.size.zero?
+        return 100 if num_relevant_lines.zero?
 
-        ((covered_lines.size / relevant_lines.size.to_f) * 100).round(2)
+        ((num_covered_lines / num_relevant_lines.to_f) * 100).round(2)
       end
 
       def same_file?(other)

data/lib/simplecov/compare/formatter/markdown_formatter.rb

@@ -58,8 +58,8 @@ module Simplecov
             <<~FILE_DIFF
               ## File Differences
 
-              | File Name | Coverage Change |
-              | --------- | --------------- |
+              | File Name | Delta | From | To |
+              | --------- | ----- | ---- | -- |
               #{file_differences_table_contents(result_set_comparison)}
             FILE_DIFF
           else
@@ -76,7 +76,10 @@ module Simplecov
             .file_differences
             .sort_by { _1.lines_coverage_delta_points }
             .each_with_object(+"") do |file_difference, output|
-              output << "| #{file_difference.filename} | #{file_difference.lines_coverage_delta_points} |\n"
+              output << "| #{file_difference.filename} "\
+                "| #{file_difference.lines_coverage_delta_points} "\
+                "| #{file_difference.original_lines_covered_percent}% (#{file_difference.original_num_covered_lines}/#{file_difference.original_num_relevant_lines}) "\
+                "| #{file_difference.new_lines_covered_percent}% (#{file_difference.new_num_covered_lines}/#{file_difference.new_num_relevant_lines}) |\n"
             end
         end
       end

data/lib/simplecov/compare/result_set.rb

@@ -20,11 +20,11 @@ module Simplecov
       end
 
       def num_relevant_lines
-        files.sum { _1.relevant_lines.size }
+        files.sum { _1.num_relevant_lines }
       end
 
       def num_covered_lines
-        files.sum { _1.covered_lines.size }
+        files.sum { _1.num_covered_lines }
       end
 
       def lines_covered_percent

data/lib/simplecov/compare/result_set_comparison.rb

@@ -28,7 +28,7 @@ module Simplecov
         return new_lines_covered_percent if @base.nil?
         return -original_lines_covered_percent if @other.nil?
 
-        new_lines_covered_percent - original_lines_covered_percent
+        (new_lines_covered_percent - original_lines_covered_percent).round(2)
       end
 
       def file_differences

data/lib/simplecov/compare/version.rb

@@ -2,6 +2,6 @@
 
 module Simplecov
   module Compare
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/simplecov/compare.rb

@@ -13,7 +13,16 @@ require_relative "compare/result_set_comparison"
 
 module Simplecov
   module Compare
+    class NoPathError < StandardError
+      def initialize(msg="Required path not provided")
+        super
+      end
+    end
+
     def self.report(base_path:, to_path:, formatter_class: Formatter::MarkdownFormatter, reporter_class: Reporter::GlamourReporter)
+      raise NoPathError, "Base path not provided" if base_path.nil?
+      raise NoPathError, "To path not provided" if to_path.nil?
+
       base = ResultSet.new(ResultFile.new(base_path).coverage_data)
       other = ResultSet.new(ResultFile.new(to_path).coverage_data)
       comparison = ResultSetComparison.new(base, to: other)

data/test/simplecov/compare/file_comparison_test.rb

@@ -229,6 +229,108 @@ module Simplecov
           assert_equal(-50, comparison.lines_coverage_delta_points)
         end
       end
+
+      describe "#original_lines_covered_percent" do
+        it "is the lines coverage of the base file" do
+          base = Mocktail.of(FileResult)
+          stubs { base.lines_covered_percent }.with { 50 }
+
+          comparison = FileComparison.new(base, to: nil)
+
+          assert_equal 50, comparison.original_lines_covered_percent
+        end
+
+        it "is 0 with no base file" do
+          comparison = FileComparison.new(nil, to: nil)
+
+          assert_equal 0, comparison.original_lines_covered_percent
+        end
+      end
+
+      describe "#new_lines_covered_percent" do
+        it "is the lines coverage of the comparison file" do
+          other = Mocktail.of(FileResult)
+          stubs { other.lines_covered_percent }.with { 75 }
+
+          comparison = FileComparison.new(nil, to: other)
+
+          assert_equal 75, comparison.new_lines_covered_percent
+        end
+
+        it "is 0 with no comparison file" do
+          comparison = FileComparison.new(nil, to: nil)
+
+          assert_equal 0, comparison.new_lines_covered_percent
+        end
+      end
+
+      describe "#original_num_relevant_lines" do
+        it "is the number of relevant lines of the base file" do
+          base = Mocktail.of(FileResult)
+          stubs { base.num_relevant_lines }.with { 33 }
+
+          comparison = FileComparison.new(base, to: nil)
+
+          assert_equal 33, comparison.original_num_relevant_lines
+        end
+
+        it "is 0 with no base file" do
+          comparison = FileComparison.new(nil, to: nil)
+
+          assert_equal 0, comparison.original_num_relevant_lines
+        end
+      end
+
+      describe "#original_num_covered_lines" do
+        it "is the number of covered lines of the base file" do
+          base = Mocktail.of(FileResult)
+          stubs { base.num_covered_lines }.with { 17 }
+
+          comparison = FileComparison.new(base, to: nil)
+
+          assert_equal 17, comparison.original_num_covered_lines
+        end
+
+        it "is 0 with no base file" do
+          comparison = FileComparison.new(nil, to: nil)
+
+          assert_equal 0, comparison.original_num_covered_lines
+        end
+      end
+
+      describe "#new_num_relevant_lines" do
+        it "is the number of relevant lines of the comparison file" do
+          other = Mocktail.of(FileResult)
+          stubs { other.num_relevant_lines }.with { 42 }
+
+          comparison = FileComparison.new(nil, to: other)
+
+          assert_equal 42, comparison.new_num_relevant_lines
+        end
+
+        it "is 0 with no comparison file" do
+          comparison = FileComparison.new(nil, to: nil)
+
+          assert_equal 0, comparison.new_num_relevant_lines
+        end
+      end
+
+      describe "#new_num_covered_lines" do
+        it "is the number of covered lines of the comparison file" do
+          other = Mocktail.of(FileResult)
+          stubs { other.num_covered_lines }.with { 71 }
+
+          comparison = FileComparison.new(nil, to: other)
+
+          assert_equal 71, comparison.new_num_covered_lines
+        end
+
+        it "is 0 with no comparison file" do
+          comparison = FileComparison.new(nil, to: nil)
+
+          assert_equal 0, comparison.new_num_covered_lines
+        end
+      end
     end
   end
 end

data/test/simplecov/compare/file_result_test.rb

@@ -38,6 +38,15 @@ module Simplecov
         end
       end
 
+      describe "#num_relevant_lines" do
+        it "provides the line count with relevant coverage information" do
+          coverage_data = { "lines" => [0, 1, nil, 47] }
+          file = FileResult.new(nil, coverage_data:)
+
+          assert_equal 3, file.num_relevant_lines
+        end
+      end
+
       describe "#covered_lines" do
         it "provides the lines that have been covered in the coverage report" do
           coverage_data = { "lines" => [0, 1, nil, 47] }
@@ -47,6 +56,15 @@ module Simplecov
         end
       end
 
+      describe "#num_covered_lines" do
+        it "provides the line count that have been covered in the coverage report" do
+          coverage_data = { "lines" => [0, 1, nil, 47] }
+          file = FileResult.new(nil, coverage_data:)
+
+          assert_equal 2, file.num_covered_lines
+        end
+      end
+
       describe "#lines_covered_percent" do
         it "is the percentage of relevant lines in the file that have been covered" do
           coverage_data = { "lines" => [0, 1, nil, 47] }

data/test/simplecov/compare/formatter/markdown_formatter_test.rb

@@ -18,15 +18,42 @@ module Simplecov
             big_decrease = Mocktail.of(FileComparison)
             stubs { big_decrease.filename }.with { "big_decrease.rb" }
             stubs { big_decrease.lines_coverage_delta_points }.with { -20 }
+            stubs { big_decrease.original_lines_covered_percent }.with { 50 }
+            stubs { big_decrease.original_num_covered_lines }.with { 5 }
+            stubs { big_decrease.original_num_relevant_lines }.with { 10 }
+            stubs { big_decrease.new_lines_covered_percent }.with { 30 }
+            stubs { big_decrease.new_num_covered_lines }.with { 3 }
+            stubs { big_decrease.new_num_relevant_lines }.with { 10 }
+
             small_decrease = Mocktail.of(FileComparison)
             stubs { small_decrease.filename }.with { "small_decrease.rb" }
             stubs { small_decrease.lines_coverage_delta_points }.with { -3 }
+            stubs { small_decrease.original_lines_covered_percent }.with { 53 }
+            stubs { small_decrease.original_num_covered_lines }.with { 53 }
+            stubs { small_decrease.original_num_relevant_lines }.with { 100 }
+            stubs { small_decrease.new_lines_covered_percent }.with { 50 }
+            stubs { small_decrease.new_num_covered_lines }.with { 50 }
+            stubs { small_decrease.new_num_relevant_lines }.with { 100 }
+
             small_increase = Mocktail.of(FileComparison)
             stubs { small_increase.filename }.with { "small_increase.rb" }
             stubs { small_increase.lines_coverage_delta_points }.with { 7 }
+            stubs { small_increase.original_lines_covered_percent }.with { 0 }
+            stubs { small_increase.original_num_covered_lines }.with { 0 }
+            stubs { small_increase.original_num_relevant_lines }.with { 100 }
+            stubs { small_increase.new_lines_covered_percent }.with { 7 }
+            stubs { small_increase.new_num_covered_lines }.with { 7 }
+            stubs { small_increase.new_num_relevant_lines }.with { 100 }
+
             big_increase = Mocktail.of(FileComparison)
             stubs { big_increase.filename }.with { "big_increase.rb" }
             stubs { big_increase.lines_coverage_delta_points }.with { 25 }
+            stubs { big_increase.original_lines_covered_percent }.with { 25 }
+            stubs { big_increase.original_num_covered_lines }.with { 1 }
+            stubs { big_increase.original_num_relevant_lines }.with { 4 }
+            stubs { big_increase.new_lines_covered_percent }.with { 50 }
+            stubs { big_increase.new_num_covered_lines }.with { 2 }
+            stubs { big_increase.new_num_relevant_lines }.with { 4 }
 
             stubs { comparison.file_differences }.with { [big_increase, small_decrease, big_decrease, small_increase] }
 
@@ -39,12 +66,12 @@ module Simplecov
 
               ## File Differences
 
-              | File Name | Coverage Change |
-              | --------- | --------------- |
-              | big_decrease.rb | -20 |
-              | small_decrease.rb | -3 |
-              | small_increase.rb | 7 |
-              | big_increase.rb | 25 |
+              | File Name | Delta | From | To |
+              | --------- | ----- | ---- | -- |
+              | big_decrease.rb | -20 | 50% (5/10) | 30% (3/10) |
+              | small_decrease.rb | -3 | 53% (53/100) | 50% (50/100) |
+              | small_increase.rb | 7 | 0% (0/100) | 7% (7/100) |
+              | big_increase.rb | 25 | 25% (1/4) | 50% (2/4) |
 
 
             MARKDOWN

data/test/simplecov/compare_test.rb

@@ -14,11 +14,11 @@ describe Simplecov::Compare do
 
         ## File Differences
 
-        | File Name | Coverage Change |
-        | --------- | --------------- |
-        | /path/to/app/models/other_model.rb | 50.0 |
-        | /path/to/app/models/model_name.rb | 81.82 |
-        | /path/to/app/helpers/application_helper.rb | 100.0 |
+        | File Name | Delta | From | To |
+        | --------- | ----- | ---- | -- |
+        | /path/to/app/models/other_model.rb | 50.0 | 0% (0/0) | 50.0% (6/12) |
+        | /path/to/app/models/model_name.rb | 81.82 | 0% (0/0) | 81.82% (9/11) |
+        | /path/to/app/helpers/application_helper.rb | 100.0 | 0.0% (0/1) | 100.0% (1/1) |
 
 
       EXPECTED_OUTPUT
@@ -32,6 +32,29 @@ describe Simplecov::Compare do
         )
       end
     end
+
+    it "raises an exception when no base path is provided" do
+      assert_raises(Simplecov::Compare::NoPathError, "Base path not provided") do
+        Simplecov::Compare.report(
+          base_path: nil,
+          to_path: "test/fixtures/sample_resultset.json",
+          formatter_class: Simplecov::Compare::Formatter::MarkdownFormatter,
+          reporter_class: Simplecov::Compare::Reporter::SimpleReporter,
+        )
+      end
+
+    end
+
+    it "raises an exception when no to path is provided" do
+      assert_raises(Simplecov::Compare::NoPathError, "To path not provided") do
+        Simplecov::Compare.report(
+          base_path: "test/fixtures/sample_resultset.json",
+          to_path: nil,
+          formatter_class: Simplecov::Compare::Formatter::MarkdownFormatter,
+          reporter_class: Simplecov::Compare::Reporter::SimpleReporter,
+        )
+      end
+    end
   end
 
   it "has a version number" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simplecov-compare
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kevin Murphy
@@ -31,6 +31,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
@@ -48,6 +50,7 @@ files:
 - lib/simplecov/compare/result_set_comparison.rb
 - lib/simplecov/compare/version.rb
 - sig/simplecov/compare.rbs
+- simplecov-compare-terminal.png
 - test/fixtures/empty_resultset.json
 - test/fixtures/sample_resultset.json
 - test/simplecov/compare/file_comparison_test.rb