backport: added coverage_summary at the end of the default task; added possibility of creating a coverage report

Author: ddnexus

.simplecov

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 SimpleCov.start do
-  SimpleCov.formatter = SimpleCov::Formatter::SimpleFormatter if ENV['SILENT_SIMPLECOV']
+  SimpleCov.formatter = SimpleCov::Formatter::SimpleFormatter unless ENV['CI'] || ENV['COVERAGE_REPORT'] == 'true'
   SimpleCov.command_name "Task##{$PROCESS_ID}"
   SimpleCov.merge_timeout 20
   add_group 'Core', %w[lib/pagy.rb lib/pagy/countless.rb lib/pagy/backend.rb lib/pagy/frontend.rb lib/pagy/exceptions.rb]

Rakefile

@@ -4,6 +4,7 @@
 require 'bundler/setup'
 require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'json'
 
 if ENV['RUBOCOP'] || !ENV['CI']
   require "rubocop/rake_task"
@@ -44,12 +45,20 @@ Rake::TestTask.new(:test_others) do |t|
   t.description = "Run tests in #{test_files.join(', ')}"
 end
 
+desc 'Display SimpleCov coverage summary'
+task :coverage_summary do
+  last_run = JSON.parse(File.read('coverage/.last_run.json'))
+  result   = last_run['result']['line']
+  puts "\n>>> SimpleCov Coverage: #{result}% <<<"
+  if result < 100.0
+    Warning.warn "!!!!! Missing #{(100.0 - result).round(2)}% coverage !!!!!"
+    puts "\n(run it again with COVERAGE_REPORT=true for a line-by-line HTML report @ coverage/index.html)" unless ENV['COVERAGE_REPORT']
+  end
+end
+
+# get the full list of of all the test tasks (and test files that each task run) with:
+# rake -D test_*
 desc "Run all the test tasks: #{test_tasks.keys.join(', ')}"
 task test: [*test_tasks.keys, :test_others]
 
-task default: [:test, :rubocop]
-
-
-# get the full list of of all the test tasks
-# (and test files that each task run) with:
-# rake -D test_*
+task default: [:test, :rubocop, :coverage_summary]

pagy3-on-docker/docker-compose.yml

@@ -27,6 +27,9 @@ services:
     environment:
       - ENABLE_OJ=${ENABLE_OJ:-true}
       - RUBOCOP=${RUBOCOP:-true}
+      - COVERAGE_REPORT=${COVERAGE_REPORT:-false}
+    ports:
+      - "1234:1234"   # RubyMine debugger
     stdin_open: true
     tty: true