pty_compat 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce2fec7856c5d46fb0b88e0f0ecc86828593ae8eb0ee1559c7778b35607902a1
-  data.tar.gz: 5dcaaf25e175c108f3fb04cf74a8b4ae0c03b898afea3dbb0b40be14547d4edc
+  metadata.gz: 605c5beef7aef4410452b3aa58901922af3b6160e45f94d837e01723802478a7
+  data.tar.gz: ba36e3cd17a5b253060555391edd07ba57ebd2fc0661c765151e384409b30623
 SHA512:
-  metadata.gz: f3411c48494e354226b1d8178e845d4912648648a03d5a54017583bbc9fb0adbbbf4c90d52d7a4ed70aa1b692e158621f0ac1529bd2a320e6e42dc870a4183a1
-  data.tar.gz: 1e9e6956e34c4cdba26db42f3e9e2d1499829a6fe3d3298c2e7cae3763915dd4c4667889b2f3e03c61abeacd1af25e37997a8f056a1143dd6a59691bf2d27034
+  metadata.gz: 93fe06ab67bff3a137640e554711b9c724c7887f1fbf0750982d52f37552d038271c4dd9a60a676eac0a1f991e7178ad04f99281f1c95b9f8ed17be4b3670088
+  data.tar.gz: aaca962bad94df726007215f39a3663ce0449a44285cdb528330c182a452c5e71d6c58d5f2274108a6d5938097f37a99f8602d02a84fcf493d9fe0bfab833de9

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-# [v0.0.1](https://github.com/Muriel-Salvan/pty_compat/compare/...v0.0.1) (2026-06-29 12:55:30)
+# [v2.0.0](https://github.com/Muriel-Salvan/pty_compat/compare/v1.0.0...v2.0.0) (2026-07-01 08:19:49)
+
+### Breaking changes
+
+* [[breaking] refactor!: replace `PTY.last_status` with `Process::Status.wait`](https://github.com/Muriel-Salvan/pty_compat/commit/eb0a772a4576e24a4b269525472d5a596913f0c8)
+
+# [v1.0.0](https://github.com/Muriel-Salvan/pty_compat/compare/...v0.0.1) (2026-06-29 12:55:30)
 
 ### Patches
 

data/README.md

@@ -73,7 +73,7 @@ PTY.spawn('ping', '-c', '3', 'example.com') do |reader, writer, pid|
 end
 
 # Retrieve the exit status portably
-status = PTY.last_status
+status = Process::Status.wait
 ```
 
 ## Requirements
@@ -84,7 +84,7 @@ status = PTY.last_status
 ## Features
 
 - **Zero-config drop-in.** A single `require` replaces `PTY.spawn` on Windows — no configuration, no platform checks, no conditional logic.
-- **Portable exit status.** Use `PTY.last_status` to retrieve the exit code on any platform instead of relying on `$?`.
+- **Portable exit status.** Use `Process::Status.wait` to retrieve the exit code on any platform.
 - **Non-block & block forms.** Supports both `PTY.spawn(command, args...) -> [reader, writer, pid]` and `PTY.spawn(command, args...) { |reader, writer, pid| ... }` forms.
 - **Windows support.** Leverages Microsoft's [`node-pty`](https://github.com/microsoft/node-pty) to provide a proper PTY on Windows, where Ruby's native `PTY` is unavailable.
 - **Lightweight.** The Ruby codebase is minimal, delegating the heavy lifting to a well-maintained native module.
@@ -113,16 +113,16 @@ Spawns a new process attached to a pseudo-terminal.
 
 **Block form** yields `reader`, `writer`, and `pid` to the given block, and automatically closes the IOs after the block returns.
 
-### `PTY.last_status -> Process::Status | nil`
+### `Process::Status.wait -> Process::Status | nil`
 
 Returns the exit status of the last spawned process.
 
-- On platforms with native `PTY`, mirrors `$?`.
+- On platforms with native `PTY`, uses the default `Process::Status.wait`.
 - On the fallback path, returns a `Process::Status` constructed from the exit code captured by the `node-pty` bridge.
 - Returns `nil` if no process has been spawned yet or if the last spawn failed.
 
 > [!TIP]
-> Prefer `PTY.last_status` over `$?` for portable code that runs on both Windows and Unix.
+> Use `Process::Status.wait` for portable code that runs on both Windows and Unix.
 
 ## Documentation
 
@@ -149,10 +149,6 @@ Returns the exit status of the last spawned process.
                                               └──────────────┘
 ```
 
-### `PTY.last_status`
-
-On platforms with native `PTY`, `PTY.last_status` returns `$?` (`Process::Status`). On the fallback path, the bridge captures the exit code and exposes it through the same method. Prefer this over `$?` for portable code.
-
 ### Why not a pure Ruby PTY?
 
 Alternative approaches rely on platform-specific C extensions that are painful to compile on Windows, or expose an incomplete `PTY` interface. `pty_compat` delegates the heavy lifting to [`node-pty`](https://github.com/microsoft/node-pty), a well-maintained native module by Microsoft that supports Windows, macOS, and Linux. This keeps the Ruby code small and the platform coverage broad.

data/lib/pty_compat/node_pty.rb

@@ -32,10 +32,10 @@ module PtyCompat
       end
     end
 
-    # @return [Process::Status] Last process status
-    def last_status
-      @last_wait_thr.value
-    end
+    # @!group Internal
+
+    # @return [Process::Waiter] The last process waiter
+    attr_reader :last_wait_thr
 
     private
 

data/lib/pty_compat/patches/pty.rb

@@ -1,17 +1,5 @@
 require 'English'
 
-# Augment PTY module with last_status
-module PTY
-  # @!group Public API
-
-  # @return [Process::Status] Last process status.
-  #   Use this instead of $? as some workaround methods don't set $? properly and we can't modify this variable.
-  def self.last_status
-    # Default implementation
-    $CHILD_STATUS
-  end
-end
-
 begin
   require 'pty'
 rescue LoadError => e
@@ -22,5 +10,14 @@ rescue LoadError => e
         prepend PtyCompat::NodePty
       end
     end
+
+    module Process
+      class Status
+        class << self
+          # Fallback on getting process status from POpen3
+          prepend PtyCompat::ProcessStatusFromPopen3
+        end
+      end
+    end
   end
 end

data/lib/pty_compat/process_status_from_popen3.rb

@@ -0,0 +1,18 @@
+module PtyCompat
+  # Provide a similar interface as the Process::Status.wait one that can return the PoOpen3 last process status,
+  # so that it works the same as Ruby's native PTY interface.
+  module ProcessStatusFromPopen3
+    # Wait for the last pid to end and return the corresponding Process Status.
+    #
+    # @param pid [Integer] PID to wait for
+    # @param flags [Integer] Flags
+    # @return [Process::Status] Corresponding process status
+    def wait(pid = -1, flags = 0)
+      if pid == -1 && flags.zero? && PTY.last_wait_thr
+        PTY.last_wait_thr.value
+      else
+        super
+      end
+    end
+  end
+end

data/lib/pty_compat/version.rb

@@ -2,5 +2,5 @@ module PtyCompat
   # @!group Public API
 
   # Gem version
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pty_compat
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Muriel Salvan
@@ -35,6 +35,7 @@ files:
 - lib/pty_compat/assets/node_pty_bridge.js
 - lib/pty_compat/node_pty.rb
 - lib/pty_compat/patches/pty.rb
+- lib/pty_compat/process_status_from_popen3.rb
 - lib/pty_compat/version.rb
 homepage: https://github.com/Muriel-Salvan/pty_compat
 licenses: