coverband 5.2.6.rc.3 → 5.2.6.rc.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '039bd98899c0794752cb3244029b3bce0d9d6ebda8ddf449423e94e44741acb5'
-  data.tar.gz: 5b19acc65170a2f2c6d66a750a7e958759e90caca808943426481828c26dedfa
+  metadata.gz: 45ab4b4c0eec8a0b642cb2236bb4fbf4b3117ec6af3c4279b37236f360fbeab6
+  data.tar.gz: 07010dd790b47cecc8fd5318bc27ec779c8f801a33943694d794a6c23686723f
 SHA512:
-  metadata.gz: 51e2ef52b7bd14f677845d6d565872ab9a607990ff28e89ba020f5fe8f8a65d728400f241ea2d70647580f2387e2115f9d033e450704d821d9a1664be5457f76
-  data.tar.gz: 62dc029eb498529c31e81a297db3afb5a1d95a716d0802ed0b99128b8405f937b6d90c61eb3d0dc49df4f2faf9b9c2545ae5f54dbda9db2d04e3b6465001a75d
+  metadata.gz: 054ac7588139476dd9f0b51caa28023f037867eac12a89d523efa0ed220791e340a468f26a1fe5f67661986008449e492be2f005f948377f7d4e728604ed8c86
+  data.tar.gz: d1c38bb92fb95e3125cb25eb188cefce1efe86ce68932078cd75a4ae417dd1626263aa3849f45edd37d72cbd86ba72627b78271354c6d6ddd23648859c47e5cf

data/changes.md

@@ -5,6 +5,7 @@ __NOTE: the current RCs include below, but this might turn into coverband 6.0__
 - add support for translation keys
 - refactor non Coverage.so based trackers
 - adds CSP report support (thanks @jwg2s)
+- add JSON reporter (thanks @mark-davenport-fountain)
 
 ### Coverband 5.2.5
 

data/lib/coverband/reporters/json_report.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Outputs data in json format similar to what is shown in the HTML page
+# Top level and file level coverage numbers
+module Coverband
+  module Reporters
+    class JSONReport < Base
+      attr_accessor :filtered_report_files
+
+      def initialize(store, options = {})
+        coverband_reports = Coverband::Reporters::Base.report(store, options)
+        self.filtered_report_files = self.class.fix_reports(coverband_reports)
+      end
+
+      def report
+        report_as_json
+      end
+
+      private
+
+      def report_as_json
+        result = Coverband::Utils::Results.new(filtered_report_files)
+        source_files = result.source_files
+        {
+          **coverage_totals(source_files),
+          files: coverage_files(result, source_files)
+        }.to_json
+      end
+
+      def coverage_totals(source_files)
+        {
+          total_files: source_files.length,
+          lines_of_code: source_files.lines_of_code,
+          lines_covered: source_files.covered_lines,
+          lines_missed: source_files.missed_lines,
+          covered_strength: source_files.covered_strength,
+          covered_percent: source_files.covered_percent
+        }
+      end
+
+      # Using a hash indexed by file name for quick lookups
+      def coverage_files(result, source_files)
+        source_files.each_with_object({}) do |source_file, hash|
+          hash[source_file.short_name] = {
+            never_loaded: source_file.never_loaded,
+            runtime_percentage: result.runtime_relevant_coverage(source_file),
+            lines_of_code: source_file.lines.count,
+            lines_covered: source_file.covered_lines.count,
+            lines_missed: source_file.missed_lines.count,
+            covered_percent: source_file.covered_percent,
+            covered_strength: source_file.covered_strength
+          }
+        end
+      end
+    end
+  end
+end

data/lib/coverband/reporters/web.rb

@@ -90,6 +90,8 @@ module Coverband
               [200, coverband_headers(content_type: "text/json"), [debug_data]]
             when %r{\/load_file_details}
               [200, coverband_headers(content_type: "text/json"), [load_file_details]]
+            when %r{\/json}
+              [200, coverband_headers(content_type: "text/json"), [json]]
             when %r{\/$}
               [200, coverband_headers, [index]]
             else
@@ -109,6 +111,10 @@ module Coverband
           open_report: false).report
       end
 
+      def json
+        Coverband::Reporters::JSONReport.new(Coverband.configuration.store).report
+      end
+
       def settings
         Coverband::Utils::HTMLFormatter.new(nil, base_path: base_path).format_settings!
       end

data/lib/coverband/version.rb

@@ -5,5 +5,5 @@
 # use format "4.2.1.rc.1" ~> 4.2.1.rc to prerelease versions like v4.2.1.rc.2 and v4.2.1.rc.3
 ###
 module Coverband
-  VERSION = "5.2.6.rc.3"
+  VERSION = "5.2.6.rc.4"
 end

data/lib/coverband.rb

@@ -137,6 +137,7 @@ module Coverband
         require "coverband/utils/lines_classifier"
         require "coverband/utils/results"
         require "coverband/reporters/html_report"
+        require "coverband/reporters/json_report"
         init_web
       end
     end

data/test/coverband/reporters/json_test.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require File.expand_path("../../test_helper", File.dirname(__FILE__))
+
+class ReportJSONTest < Minitest::Test
+  def setup
+    super
+    @store = Coverband.configuration.store
+    Coverband.configure do |config|
+      config.store = @store
+      config.root = fixtures_root
+      config.ignore = ["notsomething.rb", "lib/*"]
+    end
+    mock_file_hash
+  end
+
+  test "includes totals" do
+    @store.send(:save_report, basic_coverage)
+
+    json = Coverband::Reporters::JSONReport.new(@store).report
+    parsed = JSON.parse(json)
+    expected_keys = ["total_files", "lines_of_code", "lines_covered", "lines_missed", "covered_strength", "covered_percent"]
+    assert expected_keys - parsed.keys == []
+  end
+
+  test "honors ignore list" do
+    @store.send(:save_report, basic_coverage)
+
+    json = Coverband::Reporters::JSONReport.new(@store).report
+    parsed = JSON.parse(json)
+    expected_files = ["app/controllers/sample_controller.rb", "app/models/user.rb"]
+    assert_equal parsed["files"].keys, expected_files
+  end
+
+  test "includes metrics for files" do
+    @store.send(:save_report, basic_coverage)
+
+    json = Coverband::Reporters::JSONReport.new(@store).report
+    parsed = JSON.parse(json)
+
+    expected_keys = ["never_loaded", "runtime_percentage", "lines_of_code", "lines_covered", "lines_missed", "covered_percent", "covered_strength"]
+
+    assert_equal parsed["files"].length, 2
+    parsed["files"].keys.each do |file|
+      assert_equal parsed["files"][file].keys, expected_keys
+    end
+  end
+end

data/test/test_helper.rb

@@ -33,6 +33,7 @@ require "coverband/utils/source_file"
 require "coverband/utils/lines_classifier"
 require "coverband/utils/results"
 require "coverband/reporters/html_report"
+require "coverband/reporters/json_report"
 require "webmock/minitest"
 
 require_relative "unique_files"
@@ -93,13 +94,13 @@ Mocha::Configuration.prevent(:stubbing_non_existent_method)
 def test(name, &block)
   test_name = "test_#{name.gsub(/\s+/, "_")}".to_sym
   defined = begin
-              instance_method(test_name)
+    instance_method(test_name)
             rescue
               false
-            end
+  end
   raise "#{test_name} is already defined in #{self}" if defined
 
-  if block_given?
+  if block
     define_method(test_name, &block)
   else
     define_method(test_name) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coverband
 version: !ruby/object:Gem::Version
-  version: 5.2.6.rc.3
+  version: 5.2.6.rc.4
 platform: ruby
 authors:
 - Dan Mayer
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-11 00:00:00.000000000 Z
+date: 2023-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -315,6 +315,7 @@ files:
 - lib/coverband/reporters/base.rb
 - lib/coverband/reporters/console_report.rb
 - lib/coverband/reporters/html_report.rb
+- lib/coverband/reporters/json_report.rb
 - lib/coverband/reporters/web.rb
 - lib/coverband/utils/absolute_file_converter.rb
 - lib/coverband/utils/configuration_template.rb
@@ -396,6 +397,7 @@ files:
 - test/coverband/reporters/base_test.rb
 - test/coverband/reporters/console_test.rb
 - test/coverband/reporters/html_test.rb
+- test/coverband/reporters/json_test.rb
 - test/coverband/reporters/web_test.rb
 - test/coverband/utils/absolute_file_converter_test.rb
 - test/coverband/utils/dead_methods_test.rb
@@ -556,6 +558,7 @@ test_files:
 - test/coverband/reporters/base_test.rb
 - test/coverband/reporters/console_test.rb
 - test/coverband/reporters/html_test.rb
+- test/coverband/reporters/json_test.rb
 - test/coverband/reporters/web_test.rb
 - test/coverband/utils/absolute_file_converter_test.rb
 - test/coverband/utils/dead_methods_test.rb