rspec-osc7501 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd41d289a0bf23e97697865b61a02cbab47a71deac877207f2299897f952277a
-  data.tar.gz: 23f1e885b80df344e008650a4f7d65d65fd64c596167245fa6ca6c2ad5dd7012
+  metadata.gz: 79ad566e60d534a4c2ed14bbdf177c356948b8c55424d8be4463121b7bd6c82f
+  data.tar.gz: 588d8086263c7e701cb3328117f76aa07fdaa3a3d81504b18d9e1ae81fac39bc
 SHA512:
-  metadata.gz: f65c332e6b8124872674ee477733e7243b777f4a80b642ecac99bbed183e15a9a8a15a8a8a40f1c7652cc1ec7f1bf7acc61871a4af8e85d2bbcc82b82c4a1771
-  data.tar.gz: ff9ca548aa836cdf585d1ef2d931b8a3e980f90b6b951f9bef4d57286fef76ad887aad2bf7f30d59976637b5d42e3465cd61ba9ce8a768b53036678849549c64
+  metadata.gz: 88adf7e04930b2659e90dd1a46dbb81234372ee4b1b1afc4bad96053e5e7cf0a322de239b6af34a9294472c4ff536733fe4ffa3c7d2d7e0e51d323ca022ce3d3
+  data.tar.gz: 5d98d13922f3f2a755bffc6a9bf0fb028e4877e33c8b7693ba0b92f2f703efe8207059dc2bbe1726efcd0d5efa4b8c1e8443a73c5e768bb0dd57c652087d58bd

data/ACCESSIBILITY.md

@@ -20,7 +20,7 @@ with `TERM=dumb`. `RSPEC_OSC7501=force` overrides those defaults.
 
 ## Environments and limits
 
-The gem supports MRI Ruby 3.3 or newer and RSpec Core 3.12 through 3.x.
+The gem requires MRI Ruby 2.1 or newer and RSpec Core 3.6 or newer.
 Terminal status requires an OSC 7501-capable terminal. The formatter checks
 for a TTY and honors `TERM=dumb` but does not detect OSC support.
 

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+## 0.1.4 - 2026-11-11
+
+- Allow newer RSpec versions and test RSpec 4 ([a3f8f5d](https://github.com/cosgroveb/rspec-osc7501/commit/a3f8f5decaf8d27328dd9dcc14536b8b8f4a35cb))
+- Configure local Ruby and OSC spec reporting ([495f6be](https://github.com/cosgroveb/rspec-osc7501/commit/495f6be57799835da5ceddddd23e44a1cee4ca9d))
+- Add managed RSpec child reporting \(\#13\) ([7e6d4c1](https://github.com/cosgroveb/rspec-osc7501/commit/7e6d4c15d8e210da0ff9cf90ecf05248d1863b5e))
+
 ## 0.1.3 - 2026-11-10
 
 - Support Ruby 2.1 and RSpec 3.6 ([5afb73d](https://github.com/cosgroveb/rspec-osc7501/commit/5afb73d1ededebcafbcb81096e6bb024f791a46c))

data/CONTRIBUTING.md

@@ -29,7 +29,7 @@ defined order because their interrupt and fail-fast cases depend on sequence.
 
 Keep runtime dependencies limited to `rspec-core`. Cover formatter behavior with
 specs and lifecycle changes with real RSpec subprocesses. Check RSpec 3.6 through
-3.13 when changing early-stop detection.
+3.13 and the RSpec 4 preview when changing early-stop detection.
 
 Build the gem and documentation:
 
@@ -46,7 +46,7 @@ passing and failing suites without loading the checkout's library.
 
 ## Runtime compatibility
 
-The gem supports MRI Ruby 2.1 or newer and RSpec Core 3.6 through 3.x.
+The gem requires MRI Ruby 2.1 or newer and RSpec Core 3.6 or newer.
 Use `Gemfile.compat` to test the formatter without modern lint, release or RDoc
 dependencies. On Ruby 2.1, install Bundler 1.17.3 first. Set the RSpec version
 before resolving dependencies:
@@ -67,11 +67,12 @@ CI checks the oldest Ruby against both RSpec endpoints, the oldest RSpec on mode
 Ruby, and the Debian Bullseye and Bookworm version families. These jobs run the
 formatter suite and installed-gem smoke checks. Modern jobs also test release
 automation, lint and documentation.
+CI also checks RSpec 4.0.0.beta1 on Ruby 4.0.
 
 Compatibility checks use available patch releases within each Ruby series.
 Supporting an older runtime does not extend its upstream security maintenance.
-Unset `BUNDLE_GEMFILE`, `RSPEC_MINOR` and `RSPEC_CORE_VERSION` before returning to
-the modern development bundle.
+Unset `BUNDLE_GEMFILE`, `RSPEC_MINOR`, `RSPEC_CORE_VERSION` and `RSPEC_VERSION`
+before returning to the modern development bundle.
 
 Update usage or behavior documentation for user-visible changes. Write commit
 subjects that describe the change, because release notes use those subjects.

data/README.md

@@ -4,7 +4,7 @@ Report RSpec suite activity, progress and results to terminals that support
 [OSC 7501](https://www.superlogical.com/rex/docs/build/program-status).
 Use the formatter alongside RSpec's progress or documentation formatter.
 
-Requires MRI Ruby 2.1 or newer and `rspec-core >= 3.6, < 4`.
+Requires MRI Ruby 2.1 or newer and `rspec-core >= 3.6`.
 
 ## Install
 

data/doc/behavior.rdoc

@@ -22,8 +22,25 @@ Settings apply when RSpec constructs the formatter.
 
 Other mode values raise ArgumentError. A supporting terminal determines how to
 display status. The formatter sends no capability query and reads no stdin.
-Use one reporting RSpec process per terminal. Concurrent processes replace the
-same root status record, without worker aggregation.
+Without a child ID, concurrent processes replace the same root status record.
+Managed invocations use separate named records without worker aggregation.
+
+== Managed child context
+
+<tt>RSPEC_OSC7501_ID</tt> selects a named record. Omit it for standalone root
+behavior. IDs contain one to eight slash-separated ASCII segments using
+<tt>A-Z a-z 0-9 _ . + -</tt>. Each segment allows 1 to 32 bytes and the whole ID
+allows at most 128 bytes. An empty or invalid ID silences OSC output rather than
+writing to the root record. It leaves ordinary output and exit status unchanged.
+
+The optional <tt>rspec/osc7501/managed</tt> preload selects OSC only with valid
+context and without <tt>RSPEC_OSC7501=off</tt>. It waits for RSpec's configured
+formatters, preserves its default formatter, and adds OSC only when none exists.
+An existing OSC selection keeps its output stream. The preload isolates RSpec's
+private formatter-loader seam to the configured instance.
+
+Managed child records remain after completion. Parent tools report their own
+outcomes. A successful suite summary does not establish later process success.
 
 == Progress and outcomes
 
@@ -70,7 +87,7 @@ exit hook.
 
 == Wire format
 
-Each frame addresses the root record, repeats <tt>app=rspec</tt>, title, and
+Each frame addresses the root record unless a valid child ID is supplied, repeats <tt>app=rspec</tt>, title, and
 message, and ends with ST (ESC followed by a backslash). The formatter writes each
 frame in one call and sends no clear-on-close record.
 
@@ -90,7 +107,8 @@ instance. Other exceptions propagate.
 
 == Compatibility
 
-The gem requires Ruby >= 2.1 and <tt>rspec-core</tt> >= 3.6, < 4. MRI is the
-supported Ruby engine. Other engines and RSpec 4 are unverified. Runtime
+The gem requires Ruby >= 2.1 and <tt>rspec-core</tt> >= 3.6. MRI is the
+supported Ruby engine. CI also checks RSpec 4.0.0.beta1 on Ruby 4.0.
+Other engines are unverified. Runtime
 compatibility does not extend upstream security maintenance for older Ruby versions.
 Development tools use modern Ruby, as described in CONTRIBUTING.md.

data/doc/usage.rdoc

@@ -52,3 +52,19 @@ is <tt>RSpec</tt>.
 
 Set <tt>RSPEC_OSC7501=off</tt> to disable frames without changing the formatter
 configuration. See {Behavior}[rdoc-ref:doc/behavior.rdoc] for settings and limits.
+
+== Run through Rake (optional)
+
+Install <tt>rake-osc7501</tt> alongside this gem and load the RSpec task class
+before the integration in your Rakefile:
+
+  require 'rspec/core/rake_task'
+  require 'rake/osc7501'
+  RSpec::Core::RakeTask.new(:spec)
+
+Run <tt>bundle exec rake spec</tt>. Rake assigns a child record and preloads
+<tt>rspec/osc7501/managed</tt>. Existing formatter choices and their destinations
+remain intact. Without an explicit formatter, ordinary progress remains visible.
+Use <tt>RAKE_OSC7501=off</tt> to disable the parent's automatic activation or
+<tt>RSPEC_OSC7501=off</tt> to silence the child. Child results remain after Rake
+finishes, including a failed child tolerated with <tt>fail_on_error = false</tt>.

data/lib/rspec/osc7501/formatter.rb

@@ -16,7 +16,7 @@ module RSpec
       # The optional +clock+ callable returns monotonic seconds for throttling.
       def initialize(output, clock: -> { Process.clock_gettime(Process::CLOCK_MONOTONIC) })
         @writer = Writer.new(output, mode: ENV.fetch('RSPEC_OSC7501', 'auto'),
-                                     title: ENV.fetch('RSPEC_OSC7501_TITLE', 'RSpec'))
+                                     title: ENV.fetch('RSPEC_OSC7501_TITLE', 'RSpec'), id: ENV['RSPEC_OSC7501_ID'])
         @clock = clock
         @started = false
         @summarized = false

data/lib/rspec/osc7501/managed.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../osc7501'
+
+module RSpec
+  module OSC7501
+    # Selects an additive formatter only for a managed child invocation.
+    module Managed
+      # Isolate RSpec's private formatter-loader seam to this configuration.
+      module Loader # :nodoc: all
+        def setup_default(output_stream, deprecation_stream)
+          super
+          add Formatter, output_stream unless formatters.any? { |formatter| formatter.is_a?(Formatter) }
+        end
+      end
+
+      def self.install!(configuration = RSpec.configuration)
+        return false unless Writer.valid_id?(ENV['RSPEC_OSC7501_ID'])
+        return false if ENV['RSPEC_OSC7501'] == 'off'
+
+        loader = configuration.send(:formatter_loader)
+        return false if loader.is_a?(Loader)
+
+        loader.singleton_class.prepend(Loader)
+        true
+      end
+    end
+  end
+end
+
+RSpec::OSC7501::Managed.install!

data/lib/rspec/osc7501/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module OSC7501
-    VERSION = '0.1.3'
+    VERSION = '0.1.4'
   end
 end

data/lib/rspec/osc7501/writer.rb

@@ -3,11 +3,18 @@
 module RSpec
   module OSC7501
     class Writer # :nodoc: all
-      def initialize(output, mode:, title:)
+      def self.valid_id?(id)
+        id.is_a?(String) && id.ascii_only? && id.bytesize <= 128 &&
+          !!(id =~ %r{\A[A-Za-z0-9_.+-]{1,32}(?:/[A-Za-z0-9_.+-]{1,32}){0,7}\z})
+      end
+
+      def initialize(output, mode:, title:, id: nil)
         raise ArgumentError, 'RSPEC_OSC7501 must be auto, off, or force' unless %w[auto off force].include?(mode)
 
         @output = output
-        @enabled = mode == 'force' || (mode == 'auto' && automatic_output?)
+        @id = id
+        @enabled = (id.nil? || self.class.valid_id?(id)) &&
+                   output_enabled?(mode)
         @title = encode(title, 192) if @enabled
       rescue IOError, SystemCallError
         @enabled = false
@@ -17,6 +24,7 @@ module RSpec
         return unless @enabled
 
         fields = ['app=rspec', "title=#{@title}", "state=#{state}", "msg=#{encode(msg, 2048)}"]
+        fields << "id=#{@id}" if @id
         fields << "progress=#{[[progress.to_i, 0].max, 100].min}" if state == 'working' && !progress.nil?
         @output.write("\e]7501;#{fields.join(':')}\e\\")
         @output.flush if @output.respond_to?(:flush)
@@ -26,6 +34,10 @@ module RSpec
 
       private
 
+      def output_enabled?(mode)
+        mode == 'force' || (mode == 'auto' && automatic_output?)
+      end
+
       def automatic_output?
         ENV['TERM'] != 'dumb' && @output.respond_to?(:tty?) && @output.tty?
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-osc7501
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Brian Cosgrove
@@ -16,9 +16,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.6'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,9 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.6'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4'
 description: Reports RSpec suite progress and outcomes through OSC 7501.
 email:
 - cosgroveb@users.noreply.github.com
@@ -47,6 +41,7 @@ files:
 - doc/usage.rdoc
 - lib/rspec/osc7501.rb
 - lib/rspec/osc7501/formatter.rb
+- lib/rspec/osc7501/managed.rb
 - lib/rspec/osc7501/version.rb
 - lib/rspec/osc7501/writer.rb
 homepage: https://github.com/cosgroveb/rspec-osc7501