expect-pty 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eda03bcece07a45c1c1f4f4010ae389928db6954b44624d072ce0e4249ee5a4d
-  data.tar.gz: df16127b3002243113a3f4bb6f1945ebb5430a4a1ba614e1926f5c4be17c6a0b
+  metadata.gz: 67be724673aa5ba809cdba4e65b38f13edac9b1bca3be44f25981e5847d4eec7
+  data.tar.gz: 79837ec52929259e42f2dc7883ca4962fcf1cab5614c5d3a43f6f731892f01c5
 SHA512:
-  metadata.gz: 0aab6a9174549cac6cbdfd33eb658b4027c6509bc9a8f246d48d76329fd9c8594e38bfc0f03430f2121bbdc82b7810f89b329c5f05051ea2657c2d0498e12825
-  data.tar.gz: d819201280329ce39678db25c32d4657336b2e2e0288945285377b90d309e30aa616a60847024a1aeccf157eedbfd32165e6b01caba7e4c8c66b357c72656e3b
+  metadata.gz: c106240812e6ef1669ba2028f0a400eeeb03e26ad6bfbabb6832fb006171ff01fba37df047f0efd28d25d2320ad2a862772609bc954a9faa80361b0c8737e0b0
+  data.tar.gz: a09279ed617b6bc050edd1372f59321d2c6b3e89e01657a8b5d1bc576d79aa4d2c108673940df8a06c04a37af5aec2b1da658046e4b0abc0848e77751548c501

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+## 0.3.1 - 2026-09-26
+
+- **安装依赖**：显式声明五个运行时标准库 gem，开发工具依赖单独管理，并补齐应用 Gemfile 中的 `require: "expect/pty"` 用法。
+- **本地发布**：新增 `--rubygems-only`，可复用本机 Gem 登录单独发布 RubyGems，构建包和可重试的发布候选包统一保存到 `tmp/`。
+- **安装验证**：增加普通安装和最小 Bundler 应用的依赖及 PTY 检查，发布测试覆盖本地与 CI 环境，不需要真实发布凭据。
+
 ## 0.3.0 - 2026-09-26
 
 - **终端模式调整**：通用 `interconnect` 改由调用方设置和恢复终端模式，需要自动切换本地输入终端时使用 `interact`，直接转接终端的现有代码需要相应调整。

data/Gemfile

@@ -3,8 +3,24 @@
 source "https://rubygems.org"
 gemspec
 
-gem "minitest", "~> 5.0"
-# RuboCop's worker dependency must also support the minimum Ruby version.
-gem "parallel", "~> 1.27", require: false
-gem "rake", "~> 13.0"
-gem "rubocop", "~> 1.89", require: false
+group :development, :test do
+  gem "minitest", "~> 5.0", require: false
+  # RuboCop 的依赖也必须支持最低 Ruby 版本。
+  gem "parallel", "~> 1.27", require: false
+  gem "rake", "~> 13.0", require: false
+  gem "rubocop", "~> 1.89", require: false
+
+  # 测试、示例和发布工具直接使用的标准库 gem，不依赖其他开发工具间接引入。
+  gem "digest", require: false
+  gem "etc", require: false
+  gem "fileutils", require: false
+  gem "json", 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/README.md

@@ -4,27 +4,28 @@
 
 用 Ruby 自动操作交互式程序：启动拥有控制终端的子进程，等待文本或正则，发送输入，处理超时、EOF 和回调，也能接管已有 IO、同时监听多个会话和转接人工交互。交互能力参考 [Expect.pm](https://github.com/jacoby/expect.pm)，接口采用 Ruby 的属性、关键字参数和代码块。
 
-要求 **Ruby 3.2+、POSIX 系统（Linux/macOS）**。运行时仅使用 Ruby 标准库。推荐入口 **`require "expect/pty"`**；本项目提供独立的 `Expect` 类，不修改标准库的 `IO#expect`。
+要求 **Ruby 3.2+、POSIX 系统（Linux/macOS）**。运行时仅使用 Ruby 标准库，其中可独立安装的 gem 已在 gemspec 中声明，由 RubyGems/Bundler 解析。推荐入口 **`require "expect/pty"`**；本项目提供独立的 `Expect` 类，不修改标准库的 `IO#expect`。
 
 ## 安装和运行
 
 项目和仓库名为 `expect-ruby`，Gem 名为 `expect-pty`。在应用的 Gemfile 中添加以下内容，然后运行 `bundle install`：
 
 ```ruby
-gem "expect-pty", "~> 0.2.0"
+gem "expect-pty", "~> 0.3.1", require: "expect/pty"
 ```
 
 也可直接执行 `gem install expect-pty`。需要跟随开发分支时，可从 GitHub 安装：
 
 ```ruby
-gem "expect-pty", git: "https://github.com/gatework/expect-ruby.git", branch: "main"
+gem "expect-pty", git: "https://github.com/gatework/expect-ruby.git", branch: "main", require: "expect/pty"
 ```
 
-本地开发可改用 `gem "expect-pty", path: "/path/to/expect-ruby"`，也可在源码目录构建安装：
+本地开发可改用 `gem "expect-pty", path: "/path/to/expect-ruby", require: "expect/pty"`，也可在源码目录构建安装：
 
 ```sh
-gem build expect-pty.gemspec
-gem install ./expect-pty-0.2.0.gem
+mkdir -p tmp
+gem build expect-pty.gemspec --output tmp/expect-pty-0.3.1.gem
+gem install ./tmp/expect-pty-0.3.1.gem
 ```
 
 ```ruby
@@ -265,7 +266,18 @@ ruby examples/ssh_interact.rb --auto
 
 [GitHub Actions](https://github.com/gatework/expect-ruby/actions/workflows/ci.yml) 在推送 `main`、推送 `v*` 标签、提交到 `main` 的 Pull Request 或手动触发时运行。流水线覆盖 Ubuntu 24.04 / macOS 15 与 Ruby 3.2、3.3、3.4、4.0 的 8 种组合；每个环境执行 `script/ci`，包括真实 PTY 测试和构建包的隔离安装验证。Ubuntu / Ruby 4.0 作业保留已验证的 Gem 构建产物 14 天，可从该次工作流的 Artifacts 下载。
 
-运行前先执行 `bundle install`。Gem 库的开发锁文件 `Gemfile.lock` 保留在本地，各 Ruby 环境按 `Gemfile` 解析兼容依赖。生成文件写入已忽略的 `tmp/`，Gem 构建产物位于 `tmp/ci/`，发布候选包位于 `tmp/release/`。更新工作流中的 Action 时，应同步更新固定的提交 SHA 和版本注释。
+运行前先执行 `bundle install`。Gem 库的开发锁文件 `Gemfile.lock` 保留在本地，各 Ruby 环境按 `Gemfile` 解析兼容依赖。生成文件写入已忽略的 `tmp/`，Gem 构建产物位于 `tmp/ci/`，发布候选包位于 `tmp/release/`。安装验证会清除外部 Bundler 环境，分别运行普通 RubyGems 加载和只声明 `expect-pty` 的 Bundler 应用，检查运行时依赖、终端模式、窗口大小及真实 PTY 对话。更新工作流中的 Action 时，应同步更新固定的提交 SHA 和版本注释。
+
+运行时依赖只在 `expect-pty.gemspec` 声明，开发依赖放在 Gemfile 的 `development` / `test` 组；安装或使用本库不会引入 Minitest、Rake、RuboCop 及发布工具的依赖。
+
+| 运行时模块 | Gem | 用途 |
+| --- | --- | --- |
+| `forwardable` | `forwardable` | 会话配置委托 |
+| `io/console` | `io-console` | 终端模式和窗口大小 |
+| `io/wait` | `io-wait` | IO 可读等待 |
+| `shellwords` | `shellwords` | `stty` 参数拆分 |
+| `stringio` | `stringio` | Ruby `puts` 语义 |
+| `pty` | Ruby 自带扩展 | POSIX 伪终端，无独立 gem |
 
 仅发布 RubyGems 使用 `ruby script/release.rb --rubygems-only`，直接复用本机已有的 Gem 登录状态；添加 `--dry-run` 可先完成本地检查、测试、构建和安装验证。需要同时创建 GitHub Release 时使用 `ruby script/release.rb`，也可以在 GitHub Actions 手动运行 Release 工作流。版本准备、Actions 凭据和失败重试见 [发布说明](docs/RELEASING.md)。
 

data/docs/RELEASING.md

@@ -4,8 +4,8 @@
 
 ## 准备版本
 
-1. 更新 `lib/expect/version.rb` 的 `Expect::VERSION`，例如 `0.2.0`。
-2. 把 `CHANGELOG.md` 的 `Unreleased` 内容移到对应版本标题下，例如 `## 0.2.0 - 2026-09-13`；可以保留空的 `Unreleased` 标题。
+1. 更新 `lib/expect/version.rb` 的 `Expect::VERSION`，例如 `0.3.1`。
+2. 把 `CHANGELOG.md` 的 `Unreleased` 内容移到对应版本标题下，例如 `## 0.3.1 - 2026-09-26`；可以保留空的 `Unreleased` 标题。
 3. 提交源码，发布时工作区必须干净。若同时发布 GitHub Release，还需推送到 `main`，远端 `main` 必须包含该提交，已有同名标签必须指向该提交。
 
 发布脚本只接受正式版 `X.Y.Z`；未归档的变更会阻止发布。
@@ -40,9 +40,9 @@ ruby script/release.rb
 GitHub Runner 不会继承本机的 Gem 登录状态。要在 Actions 发布 RubyGems，需在仓库的 Settings → Secrets and variables → Actions 中配置 `RUBYGEMS_API_KEY`，使用具有 `Push rubygem` 权限的发布 Key。
 
 ```sh
-git tag -a v0.2.0 -m 'Release v0.2.0'
-git push origin v0.2.0
-gh workflow run release.yml --ref v0.2.0 --repo gatework/expect-ruby
+git tag -a v0.3.1 -m 'Release v0.3.1'
+git push origin v0.3.1
+gh workflow run release.yml --ref v0.3.1 --repo gatework/expect-ruby
 ```
 
 也可以在 Actions → Release → Run workflow 选择对应版本标签。工作流仅支持手动触发，避免本地发布时出现第二次并发上传。
@@ -56,7 +56,7 @@ gh workflow run release.yml --ref v0.2.0 --repo gatework/expect-ruby
 保留脚本输出的 `Artifact` 路径，用该候选 Gem 重试发布；更换 RubyGems 工具版本或重新构建可能得到不同字节，同一个版本不得覆盖已有内容。也可以直接指定从 CI 或 Release 下载的原包：
 
 ```sh
-ruby script/release.rb --rubygems-only --artifact tmp/ci/expect-pty-0.3.0.gem
+ruby script/release.rb --rubygems-only --artifact tmp/ci/expect-pty-0.3.1.gem
 ```
 
 将示例路径替换为实际输出的 `Artifact` 路径。`--artifact` 会跳过构建和测试，但仍核对包与当前源码是否一致；需要同时恢复 GitHub Release 时去掉 `--rubygems-only`。

data/expect-pty.gemspec

@@ -18,6 +18,13 @@ Gem::Specification.new do |spec|
     ".rubocop.yml", "expect-pty.gemspec", "README.md", "LICENSE", "CHANGELOG.md", "script/ci", "script/release.rb"
   ]
   spec.require_paths = ["lib"]
+  # 显式声明可独立升级的标准库 gem，供应用的 Bundler 解析完整运行时依赖。
+  # pty 是 Ruby 自带的 POSIX 扩展，不是独立 gem。
+  spec.add_dependency "forwardable", "~> 1.3"
+  spec.add_dependency "io-console", ">= 0.6", "< 1.0"
+  spec.add_dependency "io-wait", ">= 0.3", "< 1.0"
+  spec.add_dependency "shellwords", ">= 0.1", "< 1.0"
+  spec.add_dependency "stringio", "~> 3.0"
   spec.metadata["rubygems_mfa_required"] = "true"
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"

data/lib/expect/version.rb

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

data/script/ci

@@ -17,19 +17,44 @@ gem build expect-pty.gemspec --output "$gem_file"
 # 在独立目录安装刚构建的包，避免源码路径或 Bundler 掩盖打包遗漏。
 smoke_dir="$(mktemp -d)"
 trap 'rm -rf "$smoke_dir"' EXIT
-gem install --local --no-document --install-dir "$smoke_dir/gems" "$gem_file"
+gem_file="$(pwd)/$gem_file"
+bundler_version="$(bundle exec ruby -rbundler -e 'print Bundler::VERSION')"
+bundler_gem="$(bundle exec ruby -e 'print Gem.loaded_specs.fetch("bundler").cache_file')"
 
 (
   cd "$smoke_dir"
-  unset BUNDLE_GEMFILE BUNDLE_BIN_PATH RUBYOPT RUBYLIB
+  # 清除 Bundler 的自动加载与路径设置；Ruby 4 还会通过 BUNDLER_SETUP 自动启用 Bundler。
+  for bundle_variable in ${!BUNDLE_@} ${!BUNDLER_@}; do
+    unset "$bundle_variable"
+  done
+  unset RUBYOPT RUBYLIB RUBYGEMS_GEMDEPS
   export GEM_HOME="$smoke_dir/gems" GEM_PATH="$smoke_dir/gems"
-  ruby -r expect/pty -r rbconfig <<'RUBY'
+  gem install --local --no-document "$gem_file"
+
+  cat > smoke.rb <<'RUBY'
+require "expect/pty"
+require "rbconfig"
+
 spec = Gem.loaded_specs.fetch("expect-pty")
 # 临时目录可能经由符号链接访问，先统一为实际路径再检查。
 install_root = File.realpath(ENV.fetch("GEM_HOME"))
 abort "gem was loaded outside the isolated install" unless File.realpath(spec.full_gem_path).start_with?("#{install_root}/")
+abort "Bundler leaked into the plain gem smoke" if ARGV.first == "plain" && defined?(Bundler)
+unexpected = %w[minitest rake rubocop parallel].select { |name| Gem.loaded_specs.key?(name) }
+abort "development dependencies leaked into the application: #{unexpected.join(', ')}" unless unexpected.empty?
+spec.runtime_dependencies.each do |dependency|
+  loaded = Gem.loaded_specs.fetch(dependency.name)
+  abort "incompatible dependency: #{dependency}" unless dependency.matches_spec?(loaded)
+end
+
+# 检查实际使用的标准库已在包元数据中声明，默认 gem 可加载不能代替依赖声明。
+%w[forwardable io-console io-wait shellwords stringio].each do |name|
+  abort "undeclared runtime dependency: #{name}" unless spec.runtime_dependencies.any? { |dependency| dependency.name == name }
+end
 child = 'STDOUT.sync = true; puts "ready"; puts "reply:#{$stdin.gets&.strip}"'
-Expect.spawn(RbConfig.ruby, "--disable-gems", "-e", child, log_stdout: false) do |session|
+Expect.spawn(RbConfig.ruby, "--disable-gems", "-e", child, raw_pty: true, log_stdout: false) do |session|
+  session.winsize = [30, 100]
+  abort "io-console terminal size failed" unless session.winsize == [30, 100]
   abort "installed gem did not receive the PTY prompt" unless session.expect("ready", timeout: 5)
 
   session.puts("expect-ruby")
@@ -38,6 +63,19 @@ Expect.spawn(RbConfig.ruby, "--disable-gems", "-e", child, log_stdout: false) do
   abort "installed gem child did not exit successfully" unless status&.success?
 end
 
-puts "Installed #{spec.full_name}: PTY and isolated installation passed"
+puts "Installed #{spec.full_name}: #{ARGV.fetch(0)} PTY and runtime dependencies passed"
 RUBY
+  ruby smoke.rb plain
+
+  # 消费方仅声明当前 Gem，不能借用项目 Gemfile 中的测试和发布依赖。
+  # 单独安装本次开发检查使用的 Bundler，避免依赖宿主 Ruby 的默认 Bundler 副本。
+  if [ -f "$bundler_gem" ]; then
+    gem install --local --no-document "$bundler_gem"
+  else
+    gem install --no-document bundler --version "$bundler_version"
+  fi
+  export BUNDLE_IGNORE_CONFIG=true
+  printf 'source "https://rubygems.org"\ngem "expect-pty", "= %s", require: "expect/pty"\n' "$gem_version" > Gemfile
+  bundle lock --local
+  bundle exec ruby -rbundler -e 'Bundler.require; load "smoke.rb"' bundler
 )

data/test/process_test.rb

@@ -36,9 +36,10 @@ class ProcessTest < ExpectTest
     assert session.slave.tty?
     session.slave.echo = false
     session.slave.winsize = [37, 111]
-    session.spawn(RbConfig.ruby, "--disable-gems", "-rio/console", "-e",
+    # 子进程需要 io-console gem，保留 RubyGems 以使用 Bundler 选定的版本。
+    session.spawn(RbConfig.ruby, "-rio/console", "-e",
                   'STDOUT.sync = true; puts STDIN.winsize.join(":"); puts STDIN.gets')
-    assert_equal 1, session.expect("37:111", timeout: 2)
+    assert_equal 1, session.expect("37:111", timeout: 2), session.before.inspect
     assert_equal [37, 111], session.winsize
     session.winsize = [24, 80]
     assert_equal [24, 80], session.winsize

data/test/release_test.rb

@@ -63,14 +63,34 @@ class ReleaseTest < Minitest::Test
           release.stub(:system, push) do
             release.stub(:github, ->(*) { flunk "RubyGems-only release contacted GitHub" }) do
               release.stub(:publish_github, -> { flunk "RubyGems-only release published to GitHub" }) do
-                output, = capture_io { release.run }
-                assert_includes output, "SHA256 verified"
+                [nil, "true"].each do |github_actions|
+                  with_environment("GITHUB_ACTIONS" => github_actions,
+                                   "GEM_HOST_API_KEY" => (github_actions ? "test-only-api-key" : nil)) do
+                    published = false
+                    output, = capture_io { release.run }
+                    assert_includes output, "SHA256 verified"
+                    assert published
+                  end
+                end
               end
             end
           end
         end
       end
-      assert published
+    end
+  end
+
+  def test_ci_publish_requires_an_api_key_before_pushing
+    release = Release.new(rubygems_only: true)
+    release.stub(:registry_version, nil) do
+      release.stub(:system, ->(*) { flunk "pushed without a CI API key" }) do
+        [nil, ""].each do |api_key|
+          with_environment("GITHUB_ACTIONS" => "true", "GEM_HOST_API_KEY" => api_key) do
+            error = assert_raises(RuntimeError) { release.send(:publish_rubygems) }
+            assert_includes error.message, "RUBYGEMS_API_KEY"
+          end
+        end
+      end
     end
   end
 
@@ -194,6 +214,17 @@ class ReleaseTest < Minitest::Test
 
   private
 
+  # 发布测试显式控制凭据环境，避免本机登录状态或 CI 标记影响用例结果。
+  def with_environment(values)
+    previous = values.to_h { |name, _value| [name, ENV.fetch(name, nil)] }
+    begin
+      values.each { |name, value| ENV[name] = value }
+      yield
+    ensure
+      previous.each { |name, value| ENV[name] = value }
+    end
+  end
+
   def with_package
     Dir.mktmpdir("expect-release-test-") do |directory|
       Dir.chdir(directory) do

metadata

@@ -1,14 +1,102 @@
 --- !ruby/object:Gem::Specification
 name: expect-pty
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - expect-pty contributors
 bindir: bin
 cert_chain: []
 date: 2026-09-26 00:00:00.000000000 Z
-dependencies: []
+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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  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'
+- !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,
   multi-session waits, logging and terminal interaction.
 executables: []