rspec-osc7501 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5789a92d347d7a152a9b2ce9a2edd188a21d6209beb9f41247f1a0713598233
-  data.tar.gz: 7ed3f5e657885323cb1381ecdb6202f299dd1f7db5f7239120329b9cecdb9c29
+  metadata.gz: c98998ec22422da0c3b18c0e1718b0f3fb8eb572d8e11c14f02848c1761d4a08
+  data.tar.gz: ec72f528a52941deacc832e7e1036b079aa4ffce792092af0840d01d9e01e154
 SHA512:
-  metadata.gz: 1934634e2afade69128ade89e9d1aa8a27eafa1449142c5b3807411e9af5eec7b8e6b538c13fd3e2fb70a63b773719a76cc85521688761919aece4dac57699b8
-  data.tar.gz: 1b0a02f82acf691eb1e36dc9f6c44f7078daeef4faff113da8c1bc18d210493cc745f1131359dc2c4018929364a82d2a997ee89be43333d5b77f98f485c7d84f
+  metadata.gz: 2de8d63a1811c22b49e379ff10ad2e270ee45f9d6b71567a80c1a4f3a194558f3eda12e85cba8993df4e37068067647a48d41b77bbffacb41758474cc8ded60b
+  data.tar.gz: 9ddaf26a6534c8a8f38d65b9bc4af8f507ed67ecf81ab9fe30a2e8ee56518d231c53a3b71562637cf8a7e5e2f9b2e7b7082158a037f89ef3d379b235e5f1fd5c

data/CHANGELOG.md

@@ -2,5 +2,14 @@
 
 ## Unreleased
 
+## 0.1.1 - 2026-11-08
+
+- Fix formatter outcomes and stream handling ([3454f8a](https://github.com/cosgroveb/rspec-osc7501/commit/3454f8a63e05e8955ac42038d494d90cfaec9429))
+- Bound formatter text sanitization work ([5d2fc9f](https://github.com/cosgroveb/rspec-osc7501/commit/5d2fc9f9c5465e3086d3673e699e03fd3d8f5c86))
+- Automate tested RubyGems releases ([86f87f3](https://github.com/cosgroveb/rspec-osc7501/commit/86f87f3faadfb313377d1ece592e12d45f228632))
+- Bound CI runtime and cancel superseded checks ([0d4660d](https://github.com/cosgroveb/rspec-osc7501/commit/0d4660d2d6b90a4208fc8f0faeac8e50e5c3796c))
+
+## 0.1.0 - 2026-11-07
+
 - 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

@@ -18,8 +18,58 @@ 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
+The package is `pkg/rspec-osc7501-<version>.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.
+Update usage or behavior documentation for user-visible changes. Write commit
+subjects that describe the change, because release notes use those subjects.
+Do not maintain `Unreleased` entries by hand. Preserve the Apache-2.0 license text.
+
+## Release
+
+Release the reviewed commits on remote `main` with an explicit stable version:
+
+```sh
+gh workflow run release.yml --ref main -f version=0.1.1
+```
+
+The workflow captures `main`, updates `VERSION`, and generates CHANGELOG bullets
+from non-merge commit subjects since the previous release tag. It preserves
+older changelog sections and uses the same notes for the GitHub Release.
+Versions must use `major.minor.patch` without a `v` prefix or prerelease suffix.
+A new version must exceed the current version and include new commits.
+
+The full CI matrix tests the prepared release commit before the workflow pushes
+it and its tag together. If `main` advances during testing, the workflow stops.
+After the push, it publishes to RubyGems, then creates the GitHub Release. No
+intermediate approval is required.
+
+### One-time publishing setup
+
+On the gem's RubyGems page, configure a Trusted Publisher with owner `cosgroveb`,
+repository `rspec-osc7501`, and workflow `release.yml`. Leave the environment
+blank. The workflow uses short-lived OIDC credentials, with no RubyGems token
+stored in GitHub secrets. Repository Actions permissions must permit the
+workflow's `contents: write` and `id-token: write` requests.
+
+### Failed releases
+
+Inspect the run and its publication summary:
+
+```sh
+gh run list --workflow release.yml
+gh run view <run-id> --log-failed
+```
+
+RubyGems publication is the release. A later GitHub Release failure leaves the
+workflow failed but does not undo the published gem. Rerun the same version to
+finish missing steps:
+
+```sh
+gh workflow run release.yml --ref main -f version=0.1.1
+```
+
+When the tag exists, the workflow uses that exact commit and recorded notes,
+verifies matching publications, and skips completed steps. It does not move
+tags, replace published gems, or retry automatically. If the retry fails,
+inspect the logs before trying again.

data/README.md

@@ -8,14 +8,12 @@ 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:
+Add the gem to your Gemfile:
 
 ```ruby
 group :test do
   gem "rspec"
-  gem "rspec-osc7501",
-      git: "https://github.com/cosgroveb/rspec-osc7501",
-      branch: "feature/osc7501-formatter"
+  gem "rspec-osc7501", "~> 0.1"
 end
 ```
 

data/doc/behavior.rdoc

@@ -7,10 +7,12 @@ 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.
+that stream open and flushes each frame when the stream supports flushing.
+Settings apply when RSpec constructs the formatter.
 
 [<tt>RSPEC_OSC7501=auto</tt>]
-  Emit to a TTY. This is the default, including an unset variable.
+  Emit to a TTY. Streams without <tt>tty?</tt> remain silent.
+  This is the default, including an unset variable.
 [<tt>RSPEC_OSC7501=off</tt>]
   Emit no frames.
 [<tt>RSPEC_OSC7501=force</tt>]
@@ -47,10 +49,13 @@ The final frame includes RSpec's summary counts and duration, with no progress:
 
 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.
+Zero and negative fail-fast thresholds follow RSpec's threshold comparison.
 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.
 
+An exception already active when the suite starts does not determine its result.
+
 Close emits no additional frame after a summary. A started run that closes
 without a summary reports an incomplete error once.
 
@@ -74,6 +79,11 @@ 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.
 
+Before sanitization, the formatter keeps at most 288 input bytes for titles and
+3072 for messages. This bounds sanitization work with 50% headroom for stripped
+controls. Control-heavy input can produce shorter output. A character split by
+the input cap becomes a replacement character before the final output limit.
+
 IOError or SystemCallError disables further status output for that formatter
 instance. Other exceptions propagate.
 

data/doc/usage.rdoc

@@ -1,7 +1,7 @@
 = Usage
 
 Add OSC 7501 status alongside an ordinary RSpec formatter.
-See the {README}[rdoc-ref:README.md] for source installation.
+See the {README}[rdoc-ref:README.md] for installation.
 
 == Configure a project
 

data/lib/rspec/osc7501/formatter.rb

@@ -22,6 +22,7 @@ module RSpec
 
       # Starts suite progress from the example count in +notification+.
       def start(notification)
+        @inherited_exception = $!
         @started = true
         @total = notification.count
         @completed = @failed = @pending = 0
@@ -62,6 +63,7 @@ module RSpec
       # Final output bypasses throttling and omits progress.
       def dump_summary(notification)
         active_exception = $!
+        active_exception = nil if active_exception.equal?(@inherited_exception)
         @summarized = true
         state = final_state(notification, active_exception)
         outcome = { "done" => "Completed", "error" => "Failed", "idle" => "Stopped" }.fetch(state)
@@ -124,7 +126,7 @@ module RSpec
       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
+        threshold.is_a?(Integer) && failure_count >= threshold
       end
     end
   end

data/lib/rspec/osc7501/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module OSC7501
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/rspec/osc7501/writer.rb

@@ -7,7 +7,7 @@ module RSpec
         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?)
+        @enabled = mode == "force" || (mode == "auto" && output.respond_to?(:tty?) && output.tty?)
         @title = encode(title, 192) if @enabled
       rescue IOError, SystemCallError
         @enabled = false
@@ -19,6 +19,7 @@ module RSpec
         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\\")
+        @output.flush if @output.respond_to?(:flush)
       rescue IOError, SystemCallError
         @enabled = false
       end
@@ -26,7 +27,8 @@ module RSpec
       private
 
       def encode(text, byte_limit)
-        clean = text.to_s.encode("UTF-8", invalid: :replace, undef: :replace).gsub(/[\u0000-\u001F\u007F-\u009F]/, "")
+        input = text.to_s.byteslice(0, sanitization_byte_limit(byte_limit))
+        clean = input.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
@@ -34,6 +36,11 @@ module RSpec
         end.join
         [bounded].pack("m0")
       end
+
+      # Bound sanitization work with 50% headroom for stripped controls.
+      def sanitization_byte_limit(output_byte_limit)
+        output_byte_limit + output_byte_limit / 2
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-osc7501
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Brian Cosgrove