expect-pty 0.7.7 → 0.7.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45e6676261fec4b5bcd7db41298fd513a47da86308a29f53702311a6b5219f59
-  data.tar.gz: 19354431d871147ebd778424288ea2d3a2f788d92e8674f6c779b8c560b23f1b
+  metadata.gz: ad46afe78b754e37c5aa6995b9b1235d732a1f9faf372077b572e584ad186613
+  data.tar.gz: 7a3165503b1543396abde0d77713134296b7f2d818911c8bbca9e4b505d85227
 SHA512:
-  metadata.gz: efdb068466acf441e74d839e9830d31f59ab18bf989726319dc6f97fb049d34a913ef53fdc399b6287bebc94d3993a5b97fb8fe41965c3c1a5e6ed3fb9aba924
-  data.tar.gz: c4c4d20ef93293c8958da3ffcf6f2ebc0245b37b07caea6fe5f2af3b9ef73ba29d365134f5c7be1a693a43a3c163724143a805ad4f19d27266df7ec7e9485717
+  metadata.gz: 78b96691fcf4e0ab916286bfec7a978c3bb1de6fdc082af0ac3e5408eba3f2119c06789fd867b6f3552460ef0acee1aa45302ebb4081c21943197bd124f714c5
+  data.tar.gz: 9c7f6b06eb593608b4474fac1b0a06464cda52965221e815fd921677af1d889cdbed29aefc801d9e08383685517df293a290dc97de92e724b473608b21165c94

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## 0.7.8 - 2026-10-11
+
+- 将内部资源所有权对象命名为 ResourceOwner，并统一源码、示例和测试辅助代码的中文注释。
+- 补齐字节前缀算法、脱敏窗口及基准、API 校验和示例辅助方法的契约注释，明确缓存、输入和副作用边界。
+
 ## 0.7.7 - 2026-10-11
 
 - 修复人工接管时终端模式交接中断、恢复异常覆盖业务主异常的问题；分别尝试恢复两侧输出、转义规则和终端模式。

data/lib/expect/literal_prefix.rb

@@ -2,14 +2,19 @@
 
 module Expect
   # 计算字节窗口尾部与规则真前缀重合的最长长度；转义暂存和流尾脱敏使用同一边界判断。
-  # 不持有输入或修改缓冲，调用方可为冻结规则提供前缀表缓存；短规则不建立表。
+  # 不持有输入或修改缓冲；仅长候选的扫描需要 KMP 回退表，冻结规则可跨调用缓存该表。
   # @api private
   module LiteralPrefix
+    # 返回 buffer 后缀与 pattern 真前缀重合的最大字节数；真前缀不包含完整 pattern。
+    # 例如 "xAB" 与 "ABC" 返回 2；空输入、长度不足 2 的规则或没有重合时返回 0。
+    # 两个字符串须由调用方转为二进制编码；此处不转码、不校验，也不修改它们。
+    # prefix_tables 为可选的可变 Hash；仅冻结 pattern 使用缓存，否则为本次调用建立临时表。
     def self.length(buffer, pattern, prefix_tables = nil)
       maximum = [pattern.bytesize - 1, buffer.bytesize].min
       return 0 unless maximum.positive?
 
-      # 尾字节不在候选前缀内时无需扫描；最长候选本身命中时也不必构造 KMP 表。
+      # 重合前缀的末字节必须等于输入尾字节；排除无法结束在该字节上的更长候选。
+      # 最长候选直接命中时不必构造回退表；小于 64 字节的候选改用有界枚举。
       ending = pattern.rindex(buffer.byteslice(-1, 1), maximum - 1)
       return 0 unless ending
 
@@ -19,6 +24,7 @@ module Expect
 
       failure = prefix_tables && pattern.frozen? ? (prefix_tables[pattern] ||= []) : []
       extend_failure_table(pattern, failure, maximum)
+      # 只扫描可能重合的尾部；不匹配时沿回退表保留已有重合，避免从每个候选起点重扫。
       matched = 0
       index = buffer.bytesize - maximum
       while index < buffer.bytesize
@@ -30,6 +36,9 @@ module Expect
       matched
     end
 
+    # 将同一规则的可变回退表补齐到 length 项，已有项不重算，较长的缓存也不截断。
+    # failure[i] 是 pattern[0..i] 的最长真前缀与后缀重合长度，供失配时选择下一匹配状态。
+    # length 不超过规则的真前缀长度；表只能用于生成它的同一规则内容。
     def self.extend_failure_table(pattern, failure, length)
       failure << 0 if failure.empty?
       matched = failure.last
@@ -49,6 +58,8 @@ module Expect
       end
     end
 
+    # 从 maximum 向下枚举短候选，返回首个后缀重合长度，无命中时返回 0。
+    # 调用方已限制候选规模；每次比较只切取规则前缀，不创建完整输入的副本或回退表。
     def self.short_length(buffer, pattern, maximum)
       maximum.downto(1) do |length|
         return length if buffer.end_with?(pattern.byteslice(0, length))

data/lib/expect/redactor.rb

@@ -13,7 +13,7 @@ module Expect
       filter.append(data) + filter.finish(partial: false)
     end
 
-    # pending 保存尚不能安全输出的原字节，hidden 的对应字节用 0/1 表示是否需要遮盖。
+    # 复制冻结替换文本与规则；pending 保存尚不能安全输出的原字节，hidden 用 0/1 标记遮盖。
     def initialize(patterns, replacement: "[FILTERED]")
       unless replacement.is_a?(String) && !replacement.empty?
         raise ArgumentError, "replacement must be a nonempty String"
@@ -67,6 +67,7 @@ module Expect
     private
 
     # 输出资格与秘密掩码分开保存；仅遇到被抑制的分片时才分配额外字节图。
+    # 三个字节窗口始终对齐；先标记完整命中，再释放最长规则长度减一之外的安全前缀。
     def append_chunk(data, visible:)
       raise ArgumentError, "data must be a String" unless data.is_a?(String)
 
@@ -147,6 +148,7 @@ module Expect
     end
 
     # 仅级别切换后的流需要按输出资格再分段，普通过滤不承担额外区间调用。
+    # 将指定掩码区间中可见的字节追加到 output；被抑制的明文会断开 masking，隐藏字节不会。
     def release_suppressed(output, starting, ending, hidden:)
       while starting < ending
         suppressed = @suppressed.getbyte(starting) == 1

data/lib/expect/{session_resources.rb → resource_owner.rb}

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 module Expect
-  # 独立保存句柄和 PID 所有权，让终结器无需直接捕获会话即可清理遗弃资源。
-  # IO 是否关闭与子进程是否退出分别记录；不能仅凭句柄状态清空 PID 或伪造退出状态。
+  # 管理 IO 关闭责任和直属子进程归属，供显式关闭与 GC 回收共用。
+  # 不直接引用 Session、日志目标或用户回调；句柄关闭与进程退出分别记录。
   # @api private
-  class SessionResources
-    # 缓存已取得的状态；被外部回收的进程仍保留未知状态，不伪造成功。
+  class ResourceOwner
+    # 缓存已取得的 Process::Status；被外部回收的进程仍保留未知状态，不伪造成功。
     attr_accessor :status
     # own 控制句柄关闭责任，owner 控制进程回收责任；fork 后两者不能混为一谈。
     attr_reader :pid, :reader, :writer, :slave, :owner, :own
@@ -60,7 +60,7 @@ module Expect
       status
     end
 
-    # GC 兜底关闭所属句柄并终止尚存活的子进程；不执行用户代码或软关闭等待。
+    # GC 兜底关闭所属句柄并终止尚存活的子进程；不调用会话日志或转义回调，也不进行软关闭等待。
     # 可直接用绑定到资源对象的 Method 注册终结器，忽略 Ruby 传来的被回收对象 ID。
     def finalize(_object_id = nil)
       return unless owner == Process.pid
@@ -77,7 +77,7 @@ module Expect
 
     private
 
-    # GC 只做一次非阻塞回收和最多两次信号尝试；失败也把等待交给 detach，不运行用户回调。
+    # GC 只做一次非阻塞回收和最多两次信号尝试；失败也把等待交给 detach，不调用会话日志或转义回调。
     def finalize_child
       begin
         reap

data/lib/expect/session.rb

@@ -5,7 +5,7 @@ require_relative "interaction"
 
 module Expect
   # 一个真实 PTY 或 IO 会话；缓冲、最近结果和所属进程都保存在本对象中。
-  # SessionResources 保存可独立回收的资源账本；Matcher、Relay 仅在操作期间借用会话状态。
+  # ResourceOwner 保存可独立回收的资源账本；Matcher、Relay 仅在操作期间借用会话状态。
   # 日志与协议目标属于调用方，显式关闭和 GC 均不得接管这些借用对象。
   class Session
     include Logging
@@ -58,7 +58,7 @@ module Expect
 
       @slave.raw! if raw
       from_child = to_parent = nil
-      Cleanup.always(-> { SessionResources.close_handles(from_child, to_parent) }) do
+      Cleanup.always(-> { ResourceOwner.close_handles(from_child, to_parent) }) do
         # 错误管道的写端在 exec 成功时自动关闭；父进程据此区分成功启动与 exec 前失败。
         # 管道返回到多重赋值之间也属于接管区间，确保 ensure 始终能找到两个端点。
         Thread.handle_interrupt(Object => :never) { from_child, to_parent = IO.pipe }
@@ -290,7 +290,7 @@ module Expect
       if @resources
         close(graceful:)
       elsif own
-        SessionResources.close_handles(reader, writer, slave)
+        ResourceOwner.close_handles(reader, writer, slave)
       end
     end
 
@@ -386,7 +386,7 @@ module Expect
     # 初始化前先登记所有权；参数校验失败也能释放已取得的端点。
     def initialize_io(reader, writer:, slave: nil, own: false, timeout: nil, write_timeout: nil,
                       buffer_limit: nil, logger: nil, transcript: nil, outputs: [])
-      @resources = SessionResources.new(reader, writer:, slave:, own:)
+      @resources = ResourceOwner.new(reader, writer:, slave:, own:)
       raise ArgumentError, "reader must be a real IO" unless reader.is_a?(IO) && !reader.closed?
       raise ArgumentError, "writer must be a real IO" unless writer.is_a?(IO) && !writer.closed?
 

data/lib/expect/version.rb

@@ -2,5 +2,5 @@
 
 module Expect
   # Gem 与库共用的版本号；独立文件使 gemspec 无需加载完整会话实现。
-  VERSION = "0.7.7"
+  VERSION = "0.7.8"
 end

data/lib/expect.rb

@@ -5,7 +5,7 @@ require "io/console"
 require "stringio"
 require_relative "expect/version"
 require_relative "expect/result"
-require_relative "expect/session_resources"
+require_relative "expect/resource_owner"
 require_relative "expect/pattern"
 require_relative "expect/pattern_list"
 require_relative "expect/matcher"
@@ -72,7 +72,7 @@ module Expect
         if session && (block_given? || !initialized)
           session.cleanup_session(io, writer:, own:, graceful: initialized && graceful)
         elsif !session && own
-          SessionResources.close_handles(io, writer)
+          ResourceOwner.close_handles(io, writer)
         end
       end
       Cleanup.always(cleanup) do

data/sig/expect.rbs

@@ -1,4 +1,4 @@
-# Public Session API; internal matching and relay protocols are documented with @api private.
+# 公开 Session 接口；内部匹配与转接协议在源码中标记为 @api private。
 module Expect
   type duration = Numeric | String
   type pattern = String | Regexp | :eof | :timeout

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: expect-pty
 version: !ruby/object:Gem::Version
-  version: 0.7.7
+  version: 0.7.8
 platform: ruby
 authors:
 - expect-pty contributors
@@ -76,9 +76,9 @@ files:
 - lib/expect/redactor.rb
 - lib/expect/relay.rb
 - lib/expect/relay_writer.rb
+- lib/expect/resource_owner.rb
 - lib/expect/result.rb
 - lib/expect/session.rb
-- lib/expect/session_resources.rb
 - lib/expect/version.rb
 - sig/expect.rbs
 homepage: https://github.com/gatework/expect-ruby