Add RBS type definitions for lib/net/ping

[eitoball]

What

Add RBS type signatures for the Net::Ping class hierarchy (Ping, TCP, UDP, ICMP, External, HTTP, WMI) under sig/net/ping/.

Why

The gem had no type definitions, so consumers using Steep/RBS-based type checking had no static type information for this library's public API.

Changes

• Added sig/net/ping/{ping,tcp,udp,icmp,external,http,wmi,version}.rbs, mirroring lib/net/ping/.
• Ping::WMI#ping's return type is declared as Struct::PingStatus (defined at the top-level Struct namespace, matching where Struct.new('PingStatus', ...) actually creates the constant at runtime), with a PingStatus: singleton(::Struct::PingStatus) constant alias inside WMI for the equivalent Net::Ping::WMI::PingStatus reference the source also creates.
• Ping::TCP#ping and Ping::ICMP#ping are typed as Float | false | nil: the method body ends with @duration = ... if bool, which evaluates to the duration or nil on the normal path, but both methods also have explicit early return false branches on socket/timeout failures. UDP, External, and HTTP explicitly return bool and are typed accordingly.
• Ping#exception is typed as (Exception | String | singleton(Errno::ECONNREFUSED))?: TCP/UDP/ICMP assign real exception instances (and TCP assigns the Errno::ECONNREFUSED class object itself on one branch), while External/HTTP only ever assign String messages.
• Ping#port (and the corresponding constructor parameter, including the UDP/ICMP/HTTP initializer overrides) is typed as (Integer | String)?, since port= documents and examples/example_pingtcp.rb demonstrates passing a service-name string such as "http".
• Ping::HTTP#redirect? (private) is typed as returning bool? since response && ... evaluates to nil when response is nil.
• Ping::ICMP overrides the inherited port= as ((Integer | String)?) -> bot, since undef_method :port= in lib/net/ping/icmp.rb makes any call raise NoMethodError at runtime and RBS has no syntax to un-declare an inherited method; bot documents the call as unreachable, following the same convention stdlib sigs use for methods that always raise.
• Ping::WMI#ping/#ping? accept Hash[Symbol | String, untyped] for options, since lib/net/ping/wmi.rb interpolates option keys without restricting them to symbols.
• No changes to lib/ or net-ping.gemspec — the gemspec already globs **/*, so the new sig/ files are picked up automatically.

Validated with rbs validate and cross-checked the method surface against rbs prototype rb. Went through several rounds of Copilot review; all findings were verified against the implementation before being applied.

[Copilot]

Copilot review overview

🟡 Changes recommended

Unresolved moderate signature mismatches remain in the reviewed files.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 6

Open (6)

• Declare redirect? return type as nilable boolean · New
• Remove unavailable ICMP port writer from signature · New
• Include false in ICMP#ping return type · New
• Include String in Ping#exception type · New
• Include false in TCP#ping return type · New
• Declare WMI::PingStatus constant alias · New

What changed in this PR

Adds RBS type definitions for the Net::Ping class hierarchy and public constants.

Changes:

• Added signatures under sig/net/ping/.
• Defined WMI status and version types.
• Captured implementation-specific return types; no lib/ changes.

File	Findings
sig/​net/​ping/​wmi.rbs	Moderate (3 votes): Add the WMI::PingStatus constant alias.
sig/​net/​ping/​version.rbs	No findings.
sig/​net/​ping/​udp.rbs	No findings.
sig/​net/​ping/​tcp.rbs	Moderate (3 votes): Include false in TCP#ping’s return type.
sig/​net/​ping/​ping.rbs	Moderate (3 votes): Include String in exception’s type. Moderate (1 vote): Permit string ports in readers and constructors.
sig/​net/​ping/​icmp.rbs	Moderate (3 votes): Include false in ICMP#ping; remove the inherited port= writer. Moderate (1 vote): Declare the optional initialization block.
sig/​net/​ping/​http.rbs	Moderate (3 votes): Make private redirect?’s result nilable.
sig/​net/​ping/​external.rbs	No findings.

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[Copilot]

Copilot review overview

🟡 Changes recommended

Unresolved moderate RBS accuracy issues remain in several signatures.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 7

Open (7)

• Widen response return type to bool or nil · New
• Model ICMP port writer as unavailable · New
• Accept constructor block in ICMP initialize · New
• Include false in ICMP ping return type · New
• Include String in exception reader type · New
• Include false in TCP ping return type · New
• Declare nested WMI PingStatus constant alias · New

Resolved since last review (6)

• Declare WMI::PingStatus constant alias
• Include false in TCP#ping return type
• Include String in Ping#exception type
• Include false in ICMP#ping return type
• Remove unavailable ICMP port writer from signature
• Declare redirect? return type as nilable boolean

[Copilot]

Copilot review overview

🟡 Changes recommended

Address the three moderate type-definition issues concerning service-name ports and exception class objects.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 2

Open (2)

• Allow service-name strings in port types · New
• Include exception class objects in connection error type · New

Resolved since last review (7)

• Declare nested WMI PingStatus constant alias
• Include false in TCP ping return type
• Include String in exception reader type
• Include false in ICMP ping return type
• Accept constructor block in ICMP initialize
• Model ICMP port writer as unavailable
• Widen response return type to bool or nil

[Copilot]

Copilot review overview

🟡 Changes recommended

Two moderate signature issues and related nits remain unresolved.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 1

Open (1)

• Validate RBS declarations in CI · New

Resolved since last review (2)

• Include exception class objects in connection error type
• Allow service-name strings in port types

[Copilot]

Copilot review overview

🟡 Changes recommended

Unresolved findings cover CI validation, initializer self typing, WMI option keys, and inaccurate return-type documentation.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 1 · 2

Open (3)

• Allow string keys in WMI option hashes · New
• Correct documented ping return types to include false · New
• Validate RBS declarations in CI

[Copilot]

Copilot review overview

🔵 Needs a closer look

Three moderate constructor block typing issues remain in the External, TCP, and WMI signatures.

Review effort: Lite
Findings: None

Resolved since last review (3)

• Allow string keys in WMI option hashes
• Correct documented ping return types to include false
• Validate RBS declarations in CI

[Copilot]

Copilot review overview

🔵 Needs a closer look

Ping#initialize needs a self-typed block so subclass receivers are typed correctly.

Review effort: Lite
Findings: None

[Copilot]

Copilot review overview

🟡 Changes recommended

Critical and moderate RBS signature issues remain in HTTP, ICMP, and UDP definitions.

Get a fresh assessment by requesting another Copilot review.

Review effort: Lite
Findings: 1

Open (1)

• HTTP port signatures promise unresolved service-name strings · New

[Copilot]

Copilot review overview

🔵 Needs a closer look

Add the missing ICMP#initialize block signature before approval.

Review effort: Lite
Findings: None

Resolved since last review (1)

• HTTP port signatures promise unresolved service-name strings

[Copilot]

Copilot review overview

🔵 Needs a closer look

The HTTP redirect signature does not allow a nil port that the implementation can pass to do_ping.

Review effort: Lite
Findings: None

[Copilot]

Copilot review overview

🔵 Needs a closer look

A moderate unresolved port-type mismatch remains in sig/net/ping/http.rbs.

Review effort: Lite
Findings: None

[Copilot]

Copilot review overview

🔵 Needs a closer look

Three moderate issues and one documentation nit remain unresolved.

Review effort: Lite
Findings: None