kettle-test 2.0.29 → 2.0.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c32ea40c527580f707c23b77ec3c302546f1973a720a691453a4dabba34c69f
-  data.tar.gz: 6154f6de6057d3ac5bd39848b11389f24fbf5384b57da6fa4bc25765ed6e0b17
+  metadata.gz: a63dbe1a52bd86c0cb0a2c62284d8ecb7cb9a11e351e8d159a08adce19cf7c5b
+  data.tar.gz: 8570f606a7bd22d57e510d78de8f6e30750fca48856fba5514a49b01f5c4527e
 SHA512:
-  metadata.gz: 6ccfd4ed2e8f8582bafb1bea1f17b5807db6c709268686225908808118634485c86dbbc5dab87dbd0bb27c20fef3f25b91f63d570e2080174e684c6fcd528afc
-  data.tar.gz: a0e5979100ec93a959653d044f9e77952f0c594c9f5d38cab92ed5ee693d3480528eb83a8e8990de666120049d0dbc76d2fef25d74838dec8e2c9ed1fd91f670
+  metadata.gz: 4e07ebfc2d08021909065f366d2114e13c96fbee2ce6d2248724c1ffeb5b803c3865a9eb0bfa9463881033a674218f7d0ffc83b6247fe4f2f076ffd6be3f474f
+  data.tar.gz: 25efabc4b5e51a75e6f0cfaea31ed441a7d9740b6f786d549e85fe02fbe6414feed6be5176473dab53ef61a6a0ab45b7e7d94d38b530f4b827f925e9f2d2cd8e

data/CHANGELOG.md

@@ -30,6 +30,28 @@ Please file a bug if you notice a violation of semantic versioning.
 
 ### Security
 
+## [2.0.30] - 2026-11-15
+
+- TAG: [v2.0.30][2.0.30t]
+- COVERAGE: 97.46% -- 115/118 lines in 19 files
+- BRANCH COVERAGE: 100.00% -- 2/2 branches in 19 files
+- 85.71% documented
+
+### Added
+
+- `Kettle::Test::ProgressFormatter`: opt-in (`KETTLE_TEST_EVENTS=1`) throttled `test_progress` NDJSON events for plain rspec runs, an adapter over `Kettle::Ndjson::TestProgress` (kettle-ndjson >= 0.1.24)
+
+### Changed
+
+- [kc] kettle-jem/prepare: updated 14 project files:
+  - dependencies (14)
+
+- [kc] kettle-jem/template: updated 16 project files:
+  - code and tests (1)
+  - dependencies (3)
+  - other (3)
+  - workflows (9)
+
 ## [2.0.29] - 2026-10-28
 
 - TAG: [v2.0.29][2.0.29t]
@@ -778,7 +800,9 @@ Please file a bug if you notice a violation of semantic versioning.
   - silent_stream
   - timecop-rspec
 
-[Unreleased]: https://github.com/kettle-dev/kettle-test/compare/v2.0.29...HEAD
+[Unreleased]: https://github.com/kettle-dev/kettle-test/compare/v2.0.30...HEAD
+[2.0.30]: https://github.com/kettle-dev/kettle-test/compare/v2.0.29...v2.0.30
+[2.0.30t]: https://github.com/kettle-dev/kettle-test/releases/tag/v2.0.30
 [2.0.29]: https://github.com/kettle-dev/kettle-test/compare/v2.0.28...v2.0.29
 [2.0.29t]: https://github.com/kettle-dev/kettle-test/releases/tag/v2.0.29
 [2.0.28]: https://github.com/kettle-dev/kettle-test/compare/v2.0.27...v2.0.28

data/README.md

@@ -467,6 +467,34 @@ RSpec.describe("flaky external call", :skip_ci) do
 end
 ```
 
+### Live test progress events
+
+Opt-in, off by default. Set `KETTLE_TEST_EVENTS=1` (also `true`/`yes`/`on`) and
+`kettle/test/rspec` registers `Kettle::Test::ProgressFormatter` on stdout (or pass
+`--format Kettle::Test::ProgressFormatter` yourself). It emits
+[kettle-ndjson](https://github.com/kettle-dev/kettle-ndjson) `test_progress` events, one JSON
+object per line, never one per example. The schema is identical to
+[turbo_tests2](https://github.com/galtzo-floss/turbo_tests2)'s parallel-run events.
+Under turbo_tests2 workers the formatter stays silent; the parent emits.
+
+```json
+{"kind":"tick","source":"kettle-test","examples":120,"failures":1,"pending":2,"elapsed":8.31,"type":"test_progress","event_version":1}
+{"kind":"failure","source":"kettle-test","examples":57,"failures":1,"pending":0,"elapsed":4.02,"location":"./spec/a_spec.rb:3","description":"A fails","type":"test_progress","event_version":1}
+```
+
+| Field | Meaning |
+| --- | --- |
+| `type` | always `test_progress` |
+| `event_version` | `1` |
+| `kind` | `tick` (throttled, at most 1/s), `failure` (immediate, one per failed example), `final` (once, at end) |
+| `source` | `kettle-test` (turbo_tests2 emits `turbo_tests2`) |
+| `examples`, `failures`, `pending` | running totals |
+| `elapsed` | seconds since the run started (float) |
+| `location`, `description` | `failure` only: example location and full description |
+
+`KETTLE_TEST_EVENTS_INTERVAL` (seconds, default `1`) tunes the tick throttle. Each event is
+preceded by a newline so it starts on its own line even amid progress dots.
+
 ### Profile slowest examples
 
 Set KETTLE_TEST_RSPEC_PROFILE_EXAMPLES to a positive integer to enable RSpec profiling.
@@ -775,7 +803,7 @@ Thanks for RTFM. ☺️
 [📌gitmoji]: https://gitmoji.dev
 [📌gitmoji-img]: https://img.shields.io/badge/gitmoji_commits-%20%F0%9F%98%9C%20%F0%9F%98%8D-34495e.svg?style=flat-square
 [🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
-[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.095-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
+[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.118-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
 [🔐security]: https://github.com/kettle-dev/kettle-test/blob/main/SECURITY.md
 [🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
 [📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year

data/lib/kettle/test/config/int/rspec/test_events.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Opt-in live test_progress events: KETTLE_TEST_EVENTS=1 registers the formatter
+# on stdout. Skipped inside turbo_tests2 workers (the parent process emits).
+require_relative "../../../progress_formatter"
+
+# Exercised in a real rspec subprocess by spec/kettle/test/progress_formatter_spec.rb,
+# which in-process coverage cannot see.
+# simplecov:disable
+if Kettle::Test::ProgressFormatter.enabled? && !Kettle::Test::ProgressFormatter.turbo_worker?
+  RSpec.configure do |config|
+    config.add_formatter(Kettle::Test::ProgressFormatter, $stdout)
+  end
+end
+# simplecov:enable

data/lib/kettle/test/progress_formatter.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "kettle/ndjson"
+require "rspec/core"
+require "rspec/core/formatters"
+
+module Kettle
+  module Test
+    # Plain-rspec formatter emitting throttled NDJSON `test_progress` events
+    # (the same schema turbo_tests2 emits for parallel runs; see README
+    # "Live test progress events"). A thin adapter over Kettle::Ndjson::TestProgress.
+    #
+    # Opt-in: set KETTLE_TEST_EVENTS=1 (auto-registered by kettle/test/rspec),
+    # or pass `--format Kettle::Test::ProgressFormatter` explicitly.
+    class ProgressFormatter
+      ::RSpec::Core::Formatters.register(self, :example_passed, :example_pending, :example_failed, :close)
+
+      def self.enabled?(env = ENV)
+        Kettle::Ndjson::TestProgress.enabled?(env)
+      end
+
+      # Workers spawned by turbo_tests2 must not emit; the parent aggregates.
+      def self.turbo_worker?(env = ENV)
+        env.key?("RSPEC_FORMATTER_OUTPUT_ID")
+      end
+
+      def initialize(output, progress: nil)
+        @progress = progress || Kettle::Ndjson::TestProgress.new(
+          io: output,
+          source: "kettle-test",
+          interval: Kettle::Ndjson::TestProgress.interval_from_env
+        )
+      end
+
+      def example_passed(_notification)
+        @progress.record(:passed)
+      end
+
+      def example_pending(_notification)
+        @progress.record(:pending)
+      end
+
+      def example_failed(notification)
+        example = notification.example
+        @progress.record(:failed, location: example.location, description: example.full_description)
+      end
+
+      def close(_notification)
+        @progress.finish
+      end
+    end
+  end
+end

data/lib/kettle/test/version.rb

@@ -5,7 +5,7 @@ module Kettle
     # Version namespace for this gem.
     module Version
       # Current gem version.
-      VERSION = "2.0.29"
+      VERSION = "2.0.30"
     end
     # Current gem version exposed at the traditional constant location.
     VERSION = Version::VERSION # Traditional Constant Location

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kettle-test
 version: !ruby/object:Gem::Version
-  version: 2.0.29
+  version: 2.0.30
 platform: ruby
 authors:
 - Peter H. Boling
@@ -71,6 +71,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: kettle-ndjson
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.24
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.24
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -148,7 +168,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.17
+        version: 1.0.18
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -158,7 +178,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.17
+        version: 1.0.18
 - !ruby/object:Gem::Dependency
   name: silent_stream
   requirement: !ruby/object:Gem::Requirement
@@ -205,14 +225,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.12
+        version: 4.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.12
+        version: 4.0.2
 - !ruby/object:Gem::Dependency
   name: version_gem
   requirement: !ruby/object:Gem::Requirement
@@ -242,7 +262,7 @@ dependencies:
         version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.25
+        version: 3.1.28
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -252,7 +272,7 @@ dependencies:
         version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.25
+        version: 3.1.28
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -344,7 +364,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.9
+        version: 1.0.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -354,7 +374,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.9
+        version: 1.0.10
 - !ruby/object:Gem::Dependency
   name: gitmoji-regex
   requirement: !ruby/object:Gem::Requirement
@@ -364,7 +384,7 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.15
+        version: 2.0.16
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -374,7 +394,7 @@ dependencies:
         version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.15
+        version: 2.0.16
 description: "\U0001F372 Kettle::Test is a meta tool from kettle-dev to streamline
   testing. Acts as a shim dependency, pulling in many other dependencies, to give
   you OOTB productivity with a RubyGem, or Ruby app project. Configures RSpec w/ syntactic
@@ -400,6 +420,7 @@ files:
 - lib/kettle/test/config/ext/timecop.rb
 - lib/kettle/test/config/int/rspec/rspec_core.rb
 - lib/kettle/test/config/int/rspec/silent_stream.rb
+- lib/kettle/test/config/int/rspec/test_events.rb
 - lib/kettle/test/config/int/rspec/timecop_rspec.rb
 - lib/kettle/test/config/int/rspec_block_is_expected.rb
 - lib/kettle/test/config/int/rspec_pending_for.rb
@@ -407,6 +428,7 @@ files:
 - lib/kettle/test/external.rb
 - lib/kettle/test/internal.rb
 - lib/kettle/test/mocks/test_task.rake
+- lib/kettle/test/progress_formatter.rb
 - lib/kettle/test/rspec.rb
 - lib/kettle/test/support/shared_contexts/with_rake.rb
 - lib/kettle/test/version.rb
@@ -418,10 +440,10 @@ licenses:
 - PolyForm-Small-Business-1.0.0
 metadata:
   homepage_uri: https://kettle-test.galtzo.com
-  source_code_uri: https://github.com/kettle-dev/kettle-test/tree/v2.0.29
-  changelog_uri: https://github.com/kettle-dev/kettle-test/blob/v2.0.29/CHANGELOG.md
+  source_code_uri: https://github.com/kettle-dev/kettle-test/tree/v2.0.30
+  changelog_uri: https://github.com/kettle-dev/kettle-test/blob/v2.0.30/CHANGELOG.md
   bug_tracker_uri: https://github.com/kettle-dev/kettle-test/issues
-  documentation_uri: https://www.rubydoc.info/gems/kettle-test/2.0.29
+  documentation_uri: https://www.rubydoc.info/gems/kettle-test/2.0.30
   funding_uri: https://github.com/sponsors/pboling
   wiki_uri: https://github.com/kettle-dev/kettle-test/wiki
   news_uri: https://www.railsbling.com/tags/kettle-test
@@ -451,7 +473,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.20
+rubygems_version: 4.0.24
 specification_version: 4
 summary: "\U0001F372 A kettle-dev meta tool to streamline testing"
 test_files: []