expect-pty 0.5.3 → 0.7.1

data/sig/expect.rbs

@@ -0,0 +1,279 @@
+# Public Session API; internal matching and relay protocols are documented with @api private.
+module Expect
+  type duration = Numeric | String
+  type pattern = String | Regexp | :eof | :timeout
+  type result_error = :eof | :timeout | Exception | nil
+  type result_fields = { number: Integer?, error: result_error, match: String?, before: String?, after: String?, session: Session?, captures: Array[String?] }
+  type diagnostic_event = { event: Symbol, pid: Integer?, fd: Integer?, message: String }
+
+  interface _Writer
+    def write: (String) -> Integer
+  end
+
+  interface _Logger
+    def add: (Integer, diagnostic_event, String) -> untyped
+
+    def debug?: () -> bool
+  end
+
+  VERSION: String
+  CONTINUE: :continue
+  CONTINUE_WITHOUT_RESET: :continue_without_reset
+
+  class SpawnError < StandardError
+  end
+
+  class ReentrancyError < StandardError
+  end
+
+  class WriteTimeout < IOError
+    attr_reader bytes_written: Integer
+
+    def initialize: (?String message, ?bytes_written: Integer) -> void
+  end
+
+  def self.spawn: (
+      *String command, ?env: Hash[String, String?], ?chdir: String?, ?raw: bool, ?graceful: bool,
+      ?timeout: duration?, ?write_timeout: duration?, ?buffer_limit: Integer?,
+      ?logger: _Logger?, ?transcript: _Writer?, ?outputs: Array[_Writer]
+    ) -> Session
+    | [A] (
+      *String command, ?env: Hash[String, String?], ?chdir: String?, ?raw: bool, ?graceful: bool,
+      ?timeout: duration?, ?write_timeout: duration?, ?buffer_limit: Integer?,
+      ?logger: _Logger?, ?transcript: _Writer?, ?outputs: Array[_Writer]
+    ) { (Session) -> A } -> A
+
+  def self.open: (
+      IO io, ?writer: IO, ?own: bool, ?graceful: bool,
+      ?timeout: duration?, ?write_timeout: duration?, ?buffer_limit: Integer?,
+      ?logger: _Logger?, ?transcript: _Writer?, ?outputs: Array[_Writer]
+    ) -> Session
+    | [A] (
+      IO io, ?writer: IO, ?own: bool, ?graceful: bool,
+      ?timeout: duration?, ?write_timeout: duration?, ?buffer_limit: Integer?,
+      ?logger: _Logger?, ?transcript: _Writer?, ?outputs: Array[_Writer]
+    ) { (Session) -> A } -> A
+
+  def self.continue: (?reset_timeout: bool) -> (:continue | :continue_without_reset)
+
+  def self.monotonic: () -> Float
+
+  def self.duration: (duration?) -> Float?
+
+  def self.readable_sessions: (*Session sessions, ?timeout: duration?) -> Array[Session]
+
+  def self.interconnect: (*Session sessions, ?timeout: duration?) -> Session?
+
+  def self.expect: (
+      *pattern patterns, ?from: (Session | Array[Session]), ?timeout: duration?, ?deadline: duration?,
+      ?consume: bool, ?reset_timeout_on_read: bool
+    ) ?{ (PatternList) -> untyped } -> Result
+
+  class Session
+    def initialize: (
+        ?timeout: duration?, ?write_timeout: duration?, ?buffer_limit: Integer?,
+        ?logger: _Logger?, ?transcript: _Writer?, ?outputs: Array[_Writer]
+      ) -> void
+
+    def spawn: (*String command, ?env: Hash[String, String?], ?chdir: String?, ?raw: bool) -> Session
+
+    def expect: (
+        *pattern patterns, ?timeout: duration?, ?deadline: duration?, ?consume: bool, ?reset_timeout_on_read: bool
+      ) ?{ (PatternList) -> untyped } -> Result
+
+    def after: () -> String?
+
+    def before: () -> String?
+
+    def match: () -> String?
+
+    def alive?: () -> bool
+
+    def closed?: () -> bool
+
+    def eof?: () -> bool
+
+    def tty?: () -> bool
+
+    def pending_output?: () -> bool
+
+    def buffer: () -> String
+
+    def buffer=: (String value) -> void
+
+    def clear_buffer: () -> String
+
+    def buffer_discarded_bytes: () -> Integer
+
+    def captures: () -> Array[String?]
+
+    def command: () -> Array[String]?
+
+    def error: () -> result_error
+
+    def exit_code: () -> Integer?
+
+    def fileno: () -> Integer?
+
+    def pid: () -> Integer?
+
+    def match_number: () -> Integer?
+
+    def last_result: () -> Result?
+
+    def slave: () -> IO?
+
+    def tty_name: () -> String?
+
+    def to_io: () -> IO
+
+    def writer: () -> IO
+
+    def process_status: () -> Process::Status?
+
+    def inspect: () -> String
+
+    def close: (?graceful: bool) -> nil
+
+    def soft_close: (?timeout: duration?, ?term_timeout: duration) -> Process::Status?
+
+    def hard_close: (?timeout: duration) -> Process::Status?
+
+    def wait: (?timeout: duration?) -> Process::Status?
+
+    def write: (*untyped objects) -> Integer
+
+    def send_slow: (*untyped objects, delay: duration) -> Integer
+
+    def puts: (*untyped objects) -> nil
+
+    def <<: (untyped object) -> Session
+
+    def on_sequence: ((String | Regexp | :eof) sequence) ?{ () -> untyped } -> Session
+
+    def redact: (*String secrets) -> Session
+
+    def interact: (?input: (IO | Session), ?escape: (String | Regexp)?, ?output: _Writer?, ?timeout: duration?, ?raw: bool) -> Session?
+
+    def timeout: () -> Float?
+
+    def timeout=: (duration? value) -> void
+
+    def write_timeout: () -> Float?
+
+    def write_timeout=: (duration? value) -> void
+
+    def buffer_limit: () -> Integer?
+
+    def buffer_limit=: (Integer? value) -> void
+
+    def logger: () -> _Logger?
+
+    def logger=: (_Logger? value) -> void
+
+    def transcript: () -> _Writer?
+
+    def transcript=: (_Writer? value) -> void
+
+    def outputs: () -> Array[_Writer]
+
+    def outputs=: (Array[_Writer] value) -> void
+
+    def write_transcript: (*untyped objects) -> nil
+  end
+
+  class Result < Data
+    def self.new: (
+        ?number: Integer?,
+        ?error: result_error,
+        ?match: String?,
+        ?before: String?,
+        ?after: String?,
+        ?session: Session?,
+        ?captures: Array[String?]
+      ) -> Result
+      | (?Integer?, ?result_error, ?String?, ?String?, ?String?, ?Session?, ?Array[String?]) -> Result
+
+    def self.[]: (
+        ?number: Integer?,
+        ?error: result_error,
+        ?match: String?,
+        ?before: String?,
+        ?after: String?,
+        ?session: Session?,
+        ?captures: Array[String?]
+      ) -> Result
+      | (?Integer?, ?result_error, ?String?, ?String?, ?String?, ?Session?, ?Array[String?]) -> Result
+
+    def self.members: () -> Array[Symbol]
+
+    def self.inspect: () -> String
+
+    def members: () -> Array[Symbol]
+
+    attr_reader number: Integer?
+    attr_reader error: result_error
+    attr_reader match: String?
+    attr_reader before: String?
+    attr_reader after: String?
+    attr_reader session: Session?
+    attr_reader captures: Array[String?]
+
+    def initialize: (
+        ?number: Integer?,
+        ?error: result_error,
+        ?match: String?,
+        ?before: String?,
+        ?after: String?,
+        ?session: Session?,
+        ?captures: Array[String?]
+      ) -> void
+
+    def matched?: () -> bool
+
+    def timeout?: () -> bool
+
+    def eof?: () -> bool
+
+    def deconstruct: () -> [Integer?, result_error, String?, String?, String?, Session?, Array[String?]]
+
+    def with: (
+        ?number: Integer?,
+        ?error: result_error,
+        ?match: String?,
+        ?before: String?,
+        ?after: String?,
+        ?session: Session?,
+        ?captures: Array[String?]
+      ) -> Result
+
+    def to_h: () -> result_fields
+      | [K, V] () { (Symbol, untyped) -> [K, V] } -> Hash[K, V]
+
+    def deconstruct_keys: (Array[Symbol]?) -> Hash[Symbol, untyped]
+  end
+
+  class PatternList
+    def initialize: (?(Session | Array[Session]) sessions, ?Array[pattern] patterns) -> void
+
+    def on: ((String | Regexp) value, ?from: (Session | Array[Session])) ?{ (Session) -> untyped } -> PatternList
+
+    def eof: (?from: (Session | Array[Session])) ?{ (Session) -> untyped } -> PatternList
+
+    def timeout: () ?{ (Array[Session]) -> untyped } -> PatternList
+  end
+
+  class Redactor
+    def self.redact: (String data, Array[String] patterns, ?replacement: String) -> String
+
+    def initialize: (Array[String] patterns, ?replacement: String) -> void
+
+    def patterns=: (Array[String]) -> void
+
+    def append: (String) -> String
+
+    def finish: (?partial: bool) -> String
+
+    def inspect: () -> String
+  end
+end

metadata

@@ -1,28 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expect-pty
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.7.1
 platform: ruby
 authors:
 - expect-pty contributors
 bindir: bin
 cert_chain: []
-date: 2026-09-27 00:00:00.000000000 Z
+date: 2026-10-01 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: forwardable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: io-console
   requirement: !ruby/object:Gem::Requirement
@@ -30,9 +16,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.6'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -40,61 +23,32 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.6'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: io-wait
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.3'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.3'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: shellwords
+  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: stringio
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 description: Automate interactive programs with exact and regexp matching, Ruby blocks,
@@ -103,34 +57,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rubocop.yml"
 - CHANGELOG.md
-- CONTRIBUTING.md
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- benchmark/matching.rb
-- benchmark/redactor.rb
-- benchmark/relay.rb
-- benchmark/scaling.rb
-- benchmark/send_slow.rb
-- benchmark/support.rb
-- docs/COMPATIBILITY.md
-- docs/INTERNAL_CONTRACTS.md
-- docs/PERFORMANCE.md
-- docs/RELEASING.md
-- docs/VERIFICATION.md
-- examples/dialogue.rb
-- examples/kibitz/README.md
-- examples/kibitz/kibitz.rb
-- examples/kibitz/test_kibitz.rb
-- examples/ssh_auto.rb
-- examples/ssh_interact.rb
-- examples/ssh_login.rb
-- expect-pty.gemspec
+- docs/API.md
+- docs/MIGRATION.md
 - lib/expect.rb
-- lib/expect/configuration.rb
+- lib/expect/cleanup.rb
 - lib/expect/interaction.rb
 - lib/expect/logging.rb
 - lib/expect/matcher.rb
@@ -141,52 +74,10 @@ files:
 - lib/expect/relay.rb
 - lib/expect/relay_writer.rb
 - lib/expect/result.rb
+- lib/expect/session.rb
 - lib/expect/session_resources.rb
-- lib/expect/terminal.rb
 - lib/expect/version.rb
-- script/ci
-- script/release.rb
-- test/buffer_accounting_test.rb
-- test/cleanup_test.rb
-- test/compare_upstream.rb
-- test/configuration_test.rb
-- test/deadline_test.rb
-- test/diagnostics_test.rb
-- test/edge_case_test.rb
-- test/fixtures/ssh_scripts/01_identity.sh
-- test/fixtures/ssh_scripts/02_output.sh
-- test/fixtures/ssh_scripts/03_delayed.sh
-- test/fixtures/ssh_scripts/04_failure.sh
-- test/fixtures/ssh_scripts/05_recovery.sh
-- test/initialization_failure_test.rb
-- test/integration/README.md
-- test/integration/ssh_scripts.rb
-- test/interact_test.rb
-- test/interconnect_test.rb
-- test/io_test.rb
-- test/kibitz_test.rb
-- test/lifecycle_contract_test.rb
-- test/literal_scan_test.rb
-- test/matching_test.rb
-- test/multi_session_test.rb
-- test/ownership_sequence_test.rb
-- test/pattern_offset_test.rb
-- test/process_interruption_test.rb
-- test/process_test.rb
-- test/redactor_test.rb
-- test/relay_recovery_test.rb
-- test/relay_reentrancy_test.rb
-- test/release_test.rb
-- test/ruby_api_test.rb
-- test/scan_reuse_test.rb
-- test/script_logging_test.rb
-- test/support/interact_probe.rb
-- test/support/kibitz_probe.rb
-- test/support/script_probe.rb
-- test/terminal_cleanup_test.rb
-- test/test_helper.rb
-- test/timeout_test.rb
-- test/write_contract_test.rb
+- sig/expect.rbs
 homepage: https://github.com/gatework/expect-ruby
 licenses:
 - MIT
@@ -202,14 +93,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.12
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Ruby PTY automation with the Expect.pm interaction model
 test_files: []

data/.rubocop.yml

@@ -1,66 +0,0 @@
-AllCops:
-  TargetRubyVersion: 3.2
-  NewCops: enable
-  SuggestExtensions: false
-  Exclude:
-    - "pkg/**/*"
-    - "tmp/**/*"
-    - "vendor/**/*"
-
-# 宽松但有限的规模门槛覆盖生产代码；测试和基准的场景编排不按方法长度及 ABC 计数。
-# 需要更高分支复杂度的协议状态机仅在对应方法说明豁免原因。
-Metrics/AbcSize:
-  Max: 120
-  Exclude:
-    - "test/**/*"
-    - "benchmark/**/*"
-
-Metrics/BlockLength:
-  Max: 80
-
-Metrics/BlockNesting:
-  Max: 4
-  Exclude:
-    - "test/**/*"
-
-Metrics/ClassLength:
-  Max: 500
-
-Metrics/MethodLength:
-  Max: 80
-  Exclude:
-    - "test/**/*"
-    - "benchmark/**/*"
-
-Metrics/ModuleLength:
-  Max: 250
-
-Metrics/ParameterLists:
-  Max: 6
-  CountKeywordArgs: false
-
-Metrics/CyclomaticComplexity:
-  Max: 13
-  Exclude:
-    - "test/**/*"
-
-Metrics/PerceivedComplexity:
-  Max: 13
-  Exclude:
-    - "test/**/*"
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
-
-Style/Documentation:
-  Exclude:
-    - "test/**/*"
-
-Naming/RescuedExceptionsVariableName:
-  PreferredName: error
-
-Layout/LineLength:
-  Max: 120

data/CONTRIBUTING.md

@@ -1,29 +0,0 @@
-# 参与贡献
-
-欢迎中文或英文 issue 和 PR。库的公共 API 名称和错误信息使用英文；库内的责任划分、复杂生命周期和协议解释使用中文，RuboCop
-等工具指令保持原格式。文档以现有文件的语言为准，示例中的可编辑命令保持直接清晰。
-
-## 本地检查
-
-需要 Ruby 3.2+ 和 Linux/macOS。安装依赖后运行：
-
-```sh
-bundle install
-bundle exec rake           # RuboCop 和默认测试
-script/ci                  # 另含示例、Gem 构建及隔离安装验证
-```
-
-修改转接或匹配时，先运行对应的 `test/*_test.rb`，再运行 `bundle exec rake`。默认测试不需要 SSH；真实 SSH
-集成测试的环境要求见 [测试说明](test/integration/README.md)。发布操作和历史验证分别见 [发布说明](docs/RELEASING.md)
-与 [验证记录](docs/VERIFICATION.md)。
-
-RuboCop 对生产代码保留有限的长度、ABC、嵌套、参数数量和分支复杂度门槛。测试及基准的场景编排豁免方法长度与 ABC
-计数；协议状态机的分支豁免只放在对应方法，并注明原因。阈值用于提示复核，职责拆分仍应保持状态归属和异常恢复逻辑完整。
-
-## 提交问题或改动
-
-问题报告请附 Ruby
-版本、操作系统、最小复现代码、预期与实际结果，以及必要的异常信息；日志中请删去凭据和会话敏感内容。修复行为缺陷时，先加入能在旧实现复现问题的回归测试。涉及缓冲、转义、背压或进程清理的改动，请对照 [内部状态与数据归属](docs/INTERNAL_CONTRACTS.md)
-，说明超时、EOF 和失败后的恢复行为。
-
-PR 请说明行为变化、运行过的命令及结果。不要把本机生成的 `tmp/`、日志或凭据加入提交。

data/Gemfile

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-gemspec
-
-group :development, :test do
-  gem "minitest", "~> 5.0", require: false
-  # RuboCop 的依赖也必须支持最低 Ruby 版本。
-  gem "parallel", "~> 1.27", require: false
-  gem "rake", "~> 13.0", require: false
-  # 固定已审阅的规则集，避免不同 CI 环境自动启用新 cop 改变发布门槛。
-  gem "rubocop", "= 1.89.0", require: false
-
-  # 测试、示例和发布工具直接使用的标准库 gem，不依赖其他开发工具间接引入。
-  gem "digest", require: false
-  gem "etc", require: false
-  gem "fileutils", require: false
-  gem "json", require: false
-  gem "logger", require: false
-  gem "net-http", require: false
-  gem "open3", require: false
-  gem "optparse", require: false
-  gem "securerandom", require: false
-  gem "tempfile", require: false
-  gem "time", require: false
-  gem "timeout", require: false
-  gem "tmpdir", require: false
-end

data/Rakefile

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require "rake/testtask"
-
-Rake::TestTask.new do |task|
-  task.libs << "test"
-  task.pattern = "test/**/*_test.rb"
-  task.warning = true
-end
-
-desc "Check Ruby style and common mistakes"
-task :lint do
-  ruby "-S", "rubocop"
-end
-
-task default: %i[lint test]
-
-namespace :test do
-  desc "Log in over SSH and verify multiple scripts and persisted logs (opt-in)"
-  task :ssh do
-    ruby "test/integration/ssh_scripts.rb"
-  end
-
-  desc "Log in over SSH and verify real PTY interact handoff (opt-in)"
-  task :ssh_interact do
-    ruby "examples/ssh_interact.rb", "--auto"
-  end
-
-  desc "Automatically log into local SSH and run read-only macOS checks"
-  task :ssh_auto do
-    ruby "examples/ssh_auto.rb", "--no-interact"
-  end
-
-  desc "Run the local two-terminal kibitz scenarios and save logs (no SSH required)"
-  task :kibitz do
-    ruby "examples/kibitz/test_kibitz.rb"
-  end
-end