rspec-osc7501 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d5789a92d347d7a152a9b2ce9a2edd188a21d6209beb9f41247f1a0713598233
+  data.tar.gz: 7ed3f5e657885323cb1381ecdb6202f299dd1f7db5f7239120329b9cecdb9c29
+SHA512:
+  metadata.gz: 1934634e2afade69128ade89e9d1aa8a27eafa1449142c5b3807411e9af5eec7b8e6b538c13fd3e2fb70a63b773719a76cc85521688761919aece4dac57699b8
+  data.tar.gz: 1b0a02f82acf691eb1e36dc9f6c44f7078daeef4faff113da8c1bc18d210493cc745f1131359dc2c4018929364a82d2a997ee89be43333d5b77f98f485c7d84f

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## Unreleased
+
+- Add an opt-in OSC 7501 formatter for RSpec suite progress and outcomes.
+- Support TTY detection, explicit output capture, and a configurable suite title.

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing
+
+Use MRI Ruby 3.3 or newer. Install dependencies and run specs:
+
+```sh
+bundle install
+bundle exec rake spec
+```
+
+Keep runtime dependencies limited to `rspec-core`. Cover formatter behavior with
+specs and lifecycle changes with real RSpec subprocesses. Check RSpec 3.12 and
+3.13 when changing early-stop detection.
+
+Build the gem and documentation:
+
+```sh
+bundle exec rake package
+bundle exec rake rdoc
+```
+
+The package is `pkg/rspec-osc7501-0.1.0.gem`. Open `tmp/rdoc/index.html` to check
+rendered documentation. Keep generated files out of commits.
+
+Update usage or behavior documentation for user-visible changes and add a brief
+entry under `Unreleased` in `CHANGELOG.md`. Preserve the Apache-2.0 license text.

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,71 @@
+# rspec-osc7501
+
+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 3.3 or newer and `rspec-core >= 3.12, < 4`.
+
+## Install
+
+This gem is unreleased. Add the source branch to your Gemfile:
+
+```ruby
+group :test do
+  gem "rspec"
+  gem "rspec-osc7501",
+      git: "https://github.com/cosgroveb/rspec-osc7501",
+      branch: "feature/osc7501-formatter"
+end
+```
+
+Run `bundle install`.
+
+## Run
+
+Run your specs in a terminal that supports OSC 7501:
+
+```sh
+bundle exec rspec --require rspec/osc7501 \
+  --format progress --format RSpec::OSC7501::Formatter
+```
+
+Keep `--format progress` to retain RSpec’s dots, failures and summary. The OSC
+formatter reports completed examples and the final suite result through terminal
+status records. Requiring `rspec/osc7501` registers the formatter without selecting
+it.
+
+To check the emitted records without terminal support, force output through a
+pipe:
+
+```sh
+RSPEC_OSC7501=force bundle exec rspec --require rspec/osc7501 \
+  --format progress --format RSpec::OSC7501::Formatter | cat -v
+```
+
+Look for `^[]7501;` records alongside RSpec output. A normal completed run ends
+with a `state=done` or `state=error` record.
+
+## Configure
+
+| Environment variable | Values | Default |
+| --- | --- | --- |
+| `RSPEC_OSC7501` | `auto` emits to a TTY, `off` disables output, `force` permits redirected output | `auto` |
+| `RSPEC_OSC7501_TITLE` | Title for the suite’s status records | `RSpec` |
+
+The formatter uses the output stream RSpec assigns, including `--out`. Default
+mode emits nothing to redirected streams. Use one reporting RSpec process per
+terminal. Concurrent processes overwrite the same status record.
+
+Early stops report `idle` unless failure conditions take precedence. Termination
+that bypasses formatter callbacks can leave the last status in place. See
+[behavior and limits](doc/behavior.rdoc) for classification details.
+
+## Documentation
+
+- [Usage recipes](doc/usage.rdoc): persistent configuration and output routing.
+- [Behavior and reference](doc/behavior.rdoc): progress, terminal states and limits.
+- [Contributing](CONTRIBUTING.md): development and verification commands.
+- [Changelog](CHANGELOG.md).
+
+Licensed under [Apache License 2.0](LICENSE).

data/doc/behavior.rdoc

@@ -0,0 +1,83 @@
+= Behavior
+
+RSpec::OSC7501::Formatter reports one RSpec suite through OSC 7501. Requiring
+<tt>rspec/osc7501</tt> registers the formatter without selecting it. Select an
+ordinary formatter too if you want RSpec's progress or documentation output.
+
+== Output and settings
+
+The formatter uses the stream RSpec supplies, including <tt>--out</tt>. It leaves
+that stream open. Settings apply when RSpec constructs the formatter.
+
+[<tt>RSPEC_OSC7501=auto</tt>]
+  Emit to a TTY. This is the default, including an unset variable.
+[<tt>RSPEC_OSC7501=off</tt>]
+  Emit no frames.
+[<tt>RSPEC_OSC7501=force</tt>]
+  Emit to the selected stream even if it is not a TTY.
+[<tt>RSPEC_OSC7501_TITLE</tt>]
+  Set a stable suite title. Default: <tt>RSpec</tt>.
+
+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.
+
+== Progress and outcomes
+
+The first frame reports <tt>working</tt>. Example events update the current
+description and completed, failed, and pending counts. Progress divides completed
+results by the initial example count and stays within 0 to 100. Pending examples
+count as completed. Zero-example runs omit progress.
+
+Intermediate updates occur at most once per 100 ms. Initial and final updates
+bypass throttling. A dry run identifies itself in its messages.
+
+The final frame includes RSpec's summary counts and duration, with no progress:
+
+[<tt>done</tt>]
+  The suite completed without a failure condition.
+[<tt>error</tt>]
+  Failures, outside-example errors, a nonzero SystemExit, or another active
+  exception ended the run. An empty suite with <tt>fail_if_no_examples</tt> also
+  reports error.
+[<tt>idle</tt>]
+  Interrupt, a successful early SystemExit, or an otherwise unexplained early-stop
+  request ended the run.
+
+The formatter reads RSpec's private early-stop flag at summary time. A reached
+fail-fast threshold or outside-example error takes precedence over that flag.
+A coincident SIGINT can therefore report error. An early stop after a failure
+can report idle and retain the failure count. The formatter preserves RSpec's
+exit status.
+
+Close emits no additional frame after a summary. A started run that closes
+without a summary reports an incomplete error once.
+
+== Reporting limits
+
+RSpec must invoke formatter callbacks for a final result. Exits before formatter
+installation, load-time SystemExit, forced termination, and a second SIGINT can
+bypass those callbacks. A later <tt>at_exit</tt> failure can occur after the
+formatter's result. The formatter installs no signal handler or process-wide
+exit hook.
+
+== Wire format
+
+Each frame addresses the root record, 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.
+
+Title and message contain valid UTF-8 encoded as standard Base64. The formatter
+removes control characters in U+0000 through U+001F and U+007F through U+009F,
+replaces invalid encoding, and truncates on character boundaries. Decoded titles
+are at most 192 bytes, decoded messages at most 2048 bytes, and frames at most
+4096 bytes.
+
+IOError or SystemCallError disables further status output for that formatter
+instance. Other exceptions propagate.
+
+== Compatibility
+
+The gem requires Ruby >= 3.3 and <tt>rspec-core</tt> >= 3.12, < 4. MRI is the
+supported Ruby engine. Other engines and RSpec 4 are unverified.

data/doc/usage.rdoc

@@ -0,0 +1,54 @@
+= Usage
+
+Add OSC 7501 status alongside an ordinary RSpec formatter.
+See the {README}[rdoc-ref:README.md] for source installation.
+
+== Configure a project
+
+Add these options to your project's <tt>.rspec</tt>:
+
+  --require rspec/osc7501
+  --format progress
+  --format RSpec::OSC7501::Formatter
+
+Run <tt>bundle exec rspec</tt>. RSpec prints ordinary progress and sends status
+frames to the formatter's TTY output. A terminal with OSC 7501 support can show
+the suite status.
+
+== Keep JSON separate
+
+Give each formatter its own destination. RSpec applies <tt>--out</tt> to the
+preceding formatter:
+
+  bundle exec rspec --require rspec/osc7501 \
+    --format json --out results.json \
+    --format progress --out /dev/stdout \
+    --format RSpec::OSC7501::Formatter --out /dev/stderr
+
+This Unix example writes JSON to <tt>results.json</tt>, progress to stdout, and
+status to stderr. The OSC formatter stays silent if stderr is not a TTY.
+
+== Capture frames (optional)
+
+Set <tt>RSPEC_OSC7501=force</tt> to permit redirected status output:
+
+  RSPEC_OSC7501=force bundle exec rspec --require rspec/osc7501 \
+    --format progress --out /dev/stdout \
+    --format RSpec::OSC7501::Formatter --out status.osc
+
+<tt>status.osc</tt> contains terminal control sequences. Keep it separate from
+JSON and other machine-readable reports.
+
+== Set a title (optional)
+
+Set the title for one run:
+
+  RSPEC_OSC7501_TITLE='Payments specs' bundle exec rspec
+
+This command assumes the <tt>.rspec</tt> configuration above. The default title
+is <tt>RSpec</tt>.
+
+== Disable status
+
+Set <tt>RSPEC_OSC7501=off</tt> to disable frames while retaining the formatter
+configuration. See {Behavior}[rdoc-ref:doc/behavior.rdoc] for settings and limits.

data/lib/rspec/osc7501/formatter.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module RSpec
+  # Reports RSpec suite status through OSC 7501 terminal records.
+  module OSC7501
+    # RSpec formatter for suite activity, progress, and final results.
+    # Select alongside an ordinary formatter to retain RSpec's text output.
+    class Formatter
+      RSpec::Core::Formatters.register self, :start, :example_started, :example_passed,
+                                      :example_failed, :example_pending, :dump_summary, :close
+
+      # Writes status to RSpec's +output+ stream without closing it.
+      # Reads RSPEC_OSC7501 and RSPEC_OSC7501_TITLE at construction.
+      # 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"))
+        @clock = clock
+        @started = false
+        @summarized = false
+      end
+
+      # Starts suite progress from the example count in +notification+.
+      def start(notification)
+        @started = true
+        @total = notification.count
+        @completed = @failed = @pending = 0
+        @current = nil
+        @last_update = @clock.call
+        message = "Running #{@total} examples"
+        message += " (dry run)" if RSpec.configuration.dry_run
+        @writer.emit(state: "working", msg: message, progress: progress)
+      end
+
+      # Sets the current example description and attempts a throttled update.
+      def example_started(notification)
+        @current = notification.example.full_description
+        update
+      end
+
+      # Counts a passed example as completed and attempts a throttled update.
+      def example_passed(_notification)
+        @completed += 1
+        update
+      end
+
+      # Counts a failed example as completed and attempts a throttled update.
+      def example_failed(_notification)
+        @completed += 1
+        @failed += 1
+        update
+      end
+
+      # Counts a pending example as completed and attempts a throttled update.
+      def example_pending(_notification)
+        @completed += 1
+        @pending += 1
+        update
+      end
+
+      # Emits the final state, counts, and duration from RSpec's summary.
+      # Final output bypasses throttling and omits progress.
+      def dump_summary(notification)
+        active_exception = $!
+        @summarized = true
+        state = final_state(notification, active_exception)
+        outcome = { "done" => "Completed", "error" => "Failed", "idle" => "Stopped" }.fetch(state)
+        message = "#{outcome}: #{notification.totals_line} in #{notification.formatted_duration}"
+        message += " (dry run)" if RSpec.configuration.dry_run
+        @writer.emit(state: state, msg: message)
+      end
+
+      # Reports an incomplete run if it started without reaching a summary.
+      def close(_notification)
+        return if @summarized || !@started || @closed
+
+        @closed = true
+        @writer.emit(state: "error", msg: "Incomplete: #{@completed}/#{@total} examples")
+      end
+
+      private
+
+      def update
+        now = @clock.call
+        return if now - @last_update < 0.1
+
+        message = "#{@completed}/#{@total} examples"
+        message += ", #{@failed} failures" if @failed.positive?
+        message += ", #{@pending} pending" if @pending.positive?
+        message += ": #{@current}" if @current
+        @writer.emit(state: "working", msg: message, progress: progress)
+        @last_update = now
+      end
+
+      def progress
+        return if @total.zero?
+
+        ((@completed * 100) / @total).clamp(0, 100)
+      end
+
+      def final_state(summary, active_exception)
+        return "idle" if active_exception.is_a?(Interrupt)
+        if active_exception.is_a?(SystemExit)
+          return "error" if active_exception.status != 0 || summary.failure_count.positive? || summary.errors_outside_of_examples_count.positive?
+
+          return "idle"
+        end
+        return "error" if active_exception || summary.errors_outside_of_examples_count.positive?
+        if early_stop?
+          return "error" if fail_fast_reached?(summary.failure_count)
+
+          return "idle"
+        end
+        return "error" if summary.failure_count.positive? || (summary.example_count.zero? && RSpec.configuration.fail_if_no_examples)
+
+        "done"
+      end
+
+      # RSpec has no public early-stop event in 3.12 or 3.13.
+      def early_stop?
+        RSpec.world.wants_to_quit
+      end
+
+      def fail_fast_reached?(failure_count)
+        threshold = RSpec.configuration.fail_fast
+        threshold = 1 if threshold == true
+        threshold.is_a?(Integer) && threshold.positive? && failure_count >= threshold
+      end
+    end
+  end
+end

data/lib/rspec/osc7501/version.rb

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

data/lib/rspec/osc7501/writer.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RSpec
+  module OSC7501
+    class Writer # :nodoc: all
+      def initialize(output, mode:, title:)
+        raise ArgumentError, "RSPEC_OSC7501 must be auto, off, or force" unless %w[auto off force].include?(mode)
+
+        @output = output
+        @enabled = mode == "force" || (mode == "auto" && output.tty?)
+        @title = encode(title, 192) if @enabled
+      rescue IOError, SystemCallError
+        @enabled = false
+      end
+
+      def emit(state:, msg:, progress: nil)
+        return unless @enabled
+
+        fields = ["app=rspec", "title=#{@title}", "state=#{state}", "msg=#{encode(msg, 2048)}"]
+        fields << "progress=#{progress.to_i.clamp(0, 100)}" if state == "working" && !progress.nil?
+        @output.write("\e]7501;#{fields.join(':')}\e\\")
+      rescue IOError, SystemCallError
+        @enabled = false
+      end
+
+      private
+
+      def encode(text, byte_limit)
+        clean = text.to_s.encode("UTF-8", invalid: :replace, undef: :replace).gsub(/[\u0000-\u001F\u007F-\u009F]/, "")
+        bytes = 0
+        bounded = clean.each_char.take_while do |char|
+          bytes += char.bytesize
+          bytes <= byte_limit
+        end.join
+        [bounded].pack("m0")
+      end
+    end
+  end
+end

data/lib/rspec/osc7501.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "rspec/core"
+require_relative "osc7501/version"
+require_relative "osc7501/writer"
+require_relative "osc7501/formatter"

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: rspec-osc7501
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brian Cosgrove
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.12'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.12'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Reports RSpec suite progress and outcomes through OSC 7501.
+email:
+- cosgroveb@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- doc/behavior.rdoc
+- doc/usage.rdoc
+- lib/rspec/osc7501.rb
+- lib/rspec/osc7501/formatter.rb
+- lib/rspec/osc7501/version.rb
+- lib/rspec/osc7501/writer.rb
+homepage: https://github.com/cosgroveb/rspec-osc7501
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/cosgroveb/rspec-osc7501
+  bug_tracker_uri: https://github.com/cosgroveb/rspec-osc7501/issues
+  changelog_uri: https://github.com/cosgroveb/rspec-osc7501/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: RSpec formatter for OSC 7501 terminal program status
+test_files: []