simplecov-compare 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e1c84aeb5ca7098e9ef46d238a442ff1033e3ab9591cb035b010a51db6e64cf0
+  data.tar.gz: de4cdfdf2bd6ad0dddffba37a480c0f14d26a51b93721628bf43ebeabe51529f
+SHA512:
+  metadata.gz: 8243f62a3094c48af6fd763fbaece4ac75a5d4a54b38e01154ff609ac4ecd868e3a455b12d7fc552d1e3aa839240ba292065d2d4d8dc52227602e0fc2014e066
+  data.tar.gz: d9ff76b1d1035420e950fc5b5ceb2a4affc74cd68f024c39cfdd1493e3ff6c308e9546b1ff39a1427a5986baf2271d9b279c38fedab2fc7b191b1df1b6456378

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,91 @@
+
+# Contributor Covenant 3.0 Code of Conduct
+
+## Our Pledge
+
+We pledge to make our community welcoming, safe, and equitable for all.
+
+We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.
+
+## Encouraged Behaviors
+
+While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.
+
+With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:
+
+1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
+2. Engaging **kindly and honestly** with others.
+3. Respecting **different viewpoints** and experiences.
+4. **Taking responsibility** for our actions and contributions.
+5. Gracefully giving and accepting **constructive feedback**.
+6. Committing to **repairing harm** when it occurs.
+7. Behaving in other ways that promote and sustain the **well-being of our community**.
+
+
+## Restricted Behaviors
+
+We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.
+
+1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
+2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
+3. **Stereotyping or discrimination.** Characterizing anyone’s personality or behavior on the basis of immutable identities or traits.
+4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
+5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.
+6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
+7. Behaving in other ways that **threaten the well-being** of our community.
+
+### Other Restrictions
+
+1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
+2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
+3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.
+4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.
+
+
+## Reporting an Issue
+
+Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.
+
+When an incident does occur, it is important to report it promptly. To report a possible violation, **email one of the authors, as specified in the gemspec.**
+
+Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.
+
+
+## Addressing and Repairing Harm
+
+****
+
+If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.
+
+1) Warning
+   1) Event: A violation involving a single incident or series of incidents.
+   2) Consequence: A private, written warning from the Community Moderators.
+   3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
+2) Temporarily Limited Activities
+   1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
+   2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.
+   3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.
+3) Temporary Suspension
+   1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
+   2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.
+   3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.
+4) Permanent Ban
+   1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.
+   2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.
+   3) Repair: There is no possible repair in cases of this severity.
+
+This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.
+
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/).
+
+Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/)
+
+For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla’s code of conduct team](https://github.com/mozilla/inclusion).

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Kevin Murphy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# Simplecov::Compare
+
+Simplecov's coverage report will tell the coverage of an application at a moment
+of time. You may want to track differences over time though. This provides a
+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
+```
+
+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
+```
+
+## Usage
+
+Given an earlier coverage JSON output named `path/to/before.json` and a later
+report named `path/to/after.json`, you can run:
+
+```ruby
+Simplecov::Compare.report(
+  base_path: "path/to/before.json",
+  to_path: "path/to/after.json",
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kevin-j-m/simplecov-compare. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/kevin-j-m/simplecov-compare/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Simplecov::Compare project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kevin-j-m]/simplecov-compare/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/simplecov-compare

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/simplecov/compare"
+
+Simplecov::Compare.report(
+  base_path: ARGV[0],
+  to_path: ARGV[1],
+)

data/lib/simplecov/compare/file_comparison.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Simplecov
+  module Compare
+    class FileComparison
+      def initialize(base, to:)
+        @base = base
+        @other = to
+      end
+
+      def same_file?
+        return false if @base.nil?
+
+        @base.same_file?(@other)
+      end
+
+      def filename
+        @base&.filename || @other&.filename
+      end
+
+      def lines_coverage_different?
+        !lines_coverage_equal?
+      end
+
+      def lines_coverage_equal?
+        lines_coverage_delta_points.zero?
+      end
+
+      def lines_coverage_increased?
+        lines_coverage_delta_points.positive?
+      end
+
+      def lines_coverage_decreased?
+        lines_coverage_delta_points.negative?
+      end
+
+      def lines_coverage_delta_points
+        return @other.lines_covered_percent if @base.nil?
+        return (-@base.lines_covered_percent) if @other.nil?
+
+        @other.lines_covered_percent - @base.lines_covered_percent
+      end
+    end
+  end
+end

data/lib/simplecov/compare/file_line.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Simplecov
+  module Compare
+    class FileLine
+      # https://github.com/simplecov-ruby/simplecov/blob/main/lib/simplecov/source_file/line.rb
+      attr_reader :line_number
+
+      def initialize(line_number:, covered_count:)
+        @line_number = line_number
+        @covered_count = covered_count
+      end
+
+      def covered?
+        relevant? && @covered_count.positive?
+      end
+
+      def missed?
+        relevant? && @covered_count.zero?
+      end
+
+      def relevant?
+        !irrelevant?
+      end
+
+      def irrelevant?
+        @covered_count.nil?
+      end
+    end
+  end
+end

data/lib/simplecov/compare/file_result.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Simplecov
+  module Compare
+    class FileResult
+      # https://github.com/simplecov-ruby/simplecov/blob/main/lib/simplecov/source_file.rb
+      attr_reader :filename
+
+      def initialize(filename, coverage_data:)
+        @filename = filename
+        @coverage_data = coverage_data
+      end
+
+      def lines
+        return @lines if defined?(@lines)
+        return @lines = [] unless @coverage_data
+        lines_coverage = @coverage_data["lines"]
+
+        if lines_coverage
+          @lines = lines_coverage.map.with_index do |coverage, index|
+            FileLine.new(line_number: index + 1, covered_count: coverage)
+          end
+        else
+          @lines = []
+        end
+      end
+
+      def relevant_lines
+        lines.select { _1.relevant? }
+      end
+
+      def covered_lines
+        lines.select { _1.covered? }
+      end
+
+      def lines_covered_percent
+        return 100 if relevant_lines.size.zero?
+
+        ((covered_lines.size / relevant_lines.size.to_f) * 100).round(2)
+      end
+
+      def same_file?(other)
+        return false unless other.is_a?(Simplecov::Compare::FileResult)
+
+        filename.to_s.downcase == other.filename.to_s.downcase
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Simplecov
+  module Compare
+    module Formatter
+      class MarkdownFormatter
+        def format(result_set_comparison)
+          <<~MARKDOWN
+            #{heading}
+
+            #{overall_impact(result_set_comparison)}
+            #{file_differences(result_set_comparison)}
+          MARKDOWN
+        end
+
+        private
+
+        def heading
+          "# Coverage Comparison"
+        end
+
+        def overall_impact(result_set_comparison)
+          if result_set_comparison.lines_coverage_increased?
+            overall_coverage_increased(result_set_comparison)
+          elsif result_set_comparison.lines_coverage_decreased?
+            overall_coverage_decreased(result_set_comparison)
+          else
+            overall_coverage_equal(result_set_comparison)
+          end
+        end
+
+        def overall_coverage_increased(result_set_comparison)
+          <<~OVERALL_IMPACT
+            ## Overall Impact: 📈
+
+            Coverage increased #{result_set_comparison.lines_coverage_delta_points} points from #{result_set_comparison.original_lines_covered_percent}% to #{result_set_comparison.new_lines_covered_percent}%.
+          OVERALL_IMPACT
+        end
+
+        def overall_coverage_decreased(result_set_comparison)
+          <<~OVERALL_IMPACT
+            ## Overall Impact: 📉
+
+            Coverage decreased #{result_set_comparison.lines_coverage_delta_points * -1} points from #{result_set_comparison.original_lines_covered_percent}% to #{result_set_comparison.new_lines_covered_percent}%.
+          OVERALL_IMPACT
+        end
+
+        def overall_coverage_equal(result_set_comparison)
+          <<~OVERALL_IMPACT
+            ## Overall Impact: 🟰
+
+            Coverage maintained at #{result_set_comparison.original_lines_covered_percent}%.
+          OVERALL_IMPACT
+        end
+
+        def file_differences(result_set_comparison)
+          if result_set_comparison.file_differences?
+            <<~FILE_DIFF
+              ## File Differences
+
+              | File Name | Coverage Change |
+              | --------- | --------------- |
+              #{file_differences_table_contents(result_set_comparison)}
+            FILE_DIFF
+          else
+            <<~NO_FILE_DIFF
+              ## File Differences
+
+              All files maintained the same level of coverage.
+            NO_FILE_DIFF
+          end
+        end
+
+        def file_differences_table_contents(result_set_comparison)
+          result_set_comparison
+            .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"
+            end
+        end
+      end
+    end
+  end
+end

data/lib/simplecov/compare/reporter/glamour_reporter.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "glamour"
+
+module Simplecov
+  module Compare
+    module Reporter
+      class GlamourReporter
+        def report(output)
+          puts Glamour.render(output)
+        end
+      end
+    end
+  end
+end

data/lib/simplecov/compare/reporter/simple_reporter.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Simplecov
+  module Compare
+    module Reporter
+      class SimpleReporter
+        def report(output)
+          puts output
+        end
+      end
+    end
+  end
+end

data/lib/simplecov/compare/result_file.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Simplecov
+  module Compare
+    class ResultFile
+      def initialize(file_path)
+        @file_path = file_path
+      end
+
+      def coverage_data
+        return @coverage_data if defined?(@coverage_data)
+
+        @coverage_data =
+          parse_file
+          .map { |command_name, data| [[command_name], data.fetch("coverage")] }
+          .first
+          .last
+      end
+
+      private
+
+      def parse_file
+        data = read_file
+        parse_json(data)
+      end
+
+      def read_file
+        return unless File.exist?(@file_path)
+
+        data = File.read(@file_path)
+        return if data.nil? || data.length < 2
+
+        data
+      end
+
+      def parse_json(content)
+        return {} unless content
+
+        JSON.parse(content) || {}
+      rescue StandardError
+        {}
+      end
+    end
+  end
+end

data/lib/simplecov/compare/result_set.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Simplecov
+  module Compare
+    class ResultSet
+      # https://github.com/simplecov-ruby/simplecov/blob/main/lib/simplecov/file_list.rb
+
+      def initialize(coverage_data)
+        @coverage_data = coverage_data
+      end
+
+      def files
+        return @files if defined?(@files)
+
+        @files =
+          @coverage_data
+          .map { |filename, coverage| FileResult.new(filename, coverage_data: JSON.parse(JSON.dump(coverage))) }
+          .compact
+          .sort_by { _1.filename }
+      end
+
+      def num_relevant_lines
+        files.sum { _1.relevant_lines.size }
+      end
+
+      def num_covered_lines
+        files.sum { _1.covered_lines.size }
+      end
+
+      def lines_covered_percent
+        return 100 if num_relevant_lines.zero?
+
+        ((num_covered_lines / num_relevant_lines.to_f) * 100).round(2)
+      end
+    end
+  end
+end

data/lib/simplecov/compare/result_set_comparison.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Simplecov
+  module Compare
+    class ResultSetComparison
+      def initialize(base, to:)
+        @base = base
+        @other = to
+      end
+
+      def original_lines_covered_percent
+        @base.lines_covered_percent
+      end
+
+      def new_lines_covered_percent
+        @other.lines_covered_percent
+      end
+
+      def lines_coverage_increased?
+        lines_coverage_delta_points.positive?
+      end
+
+      def lines_coverage_decreased?
+        lines_coverage_delta_points.negative?
+      end
+
+      def lines_coverage_delta_points
+        return new_lines_covered_percent if @base.nil?
+        return -original_lines_covered_percent if @other.nil?
+
+        new_lines_covered_percent - original_lines_covered_percent
+      end
+
+      def file_differences
+        return @file_differences if defined?(@file_differences)
+
+        compare
+        @file_differences
+      end
+
+      def file_differences?
+        !file_differences.empty?
+      end
+
+      private
+
+      def compare
+        @file_differences = []
+        add_differences_from_base
+        add_new_files_from_other
+      end
+
+      def add_differences_from_base
+        base_file_set.each do |base_file|
+          match = other_file_set.find { base_file.same_file?(_1) }
+          if match
+            other_file_set.delete(match)
+          end
+
+          file_comparison = FileComparison.new(base_file, to: match)
+          if file_comparison.lines_coverage_different?
+            @file_differences << file_comparison
+          end
+        end
+      end
+
+      def add_new_files_from_other
+        other_file_set.each do |other_file|
+          file_comparison = FileComparison.new(nil, to: other_file)
+          @file_differences << file_comparison
+        end
+      end
+
+      def base_file_set
+        @base_file_set ||= @base.files.dup
+      end
+
+      def other_file_set
+        @other_file_set ||= @other.files.dup
+      end
+    end
+  end
+end

data/lib/simplecov/compare/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Simplecov
+  module Compare
+    VERSION = "0.1.0"
+  end
+end

data/lib/simplecov/compare.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "compare/version"
+require_relative "compare/file_comparison"
+require_relative "compare/file_line"
+require_relative "compare/file_result"
+require_relative "compare/formatter/markdown_formatter"
+require_relative "compare/reporter/glamour_reporter"
+require_relative "compare/reporter/simple_reporter"
+require_relative "compare/result_file"
+require_relative "compare/result_set"
+require_relative "compare/result_set_comparison"
+
+module Simplecov
+  module Compare
+    def self.report(base_path:, to_path:, formatter_class: Formatter::MarkdownFormatter, reporter_class: Reporter::GlamourReporter)
+      base = ResultSet.new(ResultFile.new(base_path).coverage_data)
+      other = ResultSet.new(ResultFile.new(to_path).coverage_data)
+      comparison = ResultSetComparison.new(base, to: other)
+
+      formatted = formatter_class.new.format(comparison)
+      reporter_class.new.report(formatted)
+    end
+  end
+end

data/sig/simplecov/compare.rbs

@@ -0,0 +1,6 @@
+module Simplecov
+  module Compare
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

data/test/fixtures/empty_resultset.json

@@ -0,0 +1,13 @@
+{
+  "RSpec": {
+    "coverage": {
+      "/path/to/app/helpers/application_helper.rb": {
+        "lines": [
+          0,
+          null
+        ]
+      }
+    },
+    "timestamp": 1770264586
+  }
+}