net-ping 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27c470dd18b95b9b05e68e1dd6e79da70a8c8d4eaaa28581e770fa4d0d028aca
-  data.tar.gz: fc020ad255eb094dd057f552e67c36f83a00e87aa88e12837ceb3f2bf1c8673b
+  metadata.gz: 12d4bcbcdb97fb3b116be13a5bc7ad632b4efc116127d9b5859531b5605be3ae
+  data.tar.gz: 22603f15d676ac4e3a4137a0bdec76019b7a52b8ae5ca028b452b8760ad6bd15
 SHA512:
-  metadata.gz: 4fc2c4d695cbdb27ddd478b92929f6f9164eb07d768b56ee8f6d69cb102ded9bfe435ff0fd389136b77a86f200440da26f6078bca87561275f881f5b5abb7c24
-  data.tar.gz: 5c45a5a55df135b3145e6aab5b3286c27d92487e9a5ac0329ada3641659acef7a8c69a4fb8f22ac2d04b6c68627a6335fd7c9ca2c681987c35713da78472cdbe
+  metadata.gz: ab74625d886822f7801e5c9c6e7704664bb789f745b47a29ec54cf8e7baa4cbb1a86c332df8bc16a4757900987dc3389642c290cf4d38d98badbc1e60df7ffa1
+  data.tar.gz: bb55d09ac91ec4ac1e407e7050f655d7fd305f3fcab3fa2093613745509724d138b25b22282d2d00d63eb5880d50814d7bfe0ac4d9e414904fbeb2d0e2618ec5

data/CHANGES

@@ -1,3 +1,9 @@
+== 2.1.1 - 16-Aug-2026
+* Fix the license format in net-ping.gemspec to use the SPDX identifier
+  "Artistic-2.0" [#47](https://github.com/eitoball/net-ping/pull/47).
+* Exclude CLAUDE.md and docs/ from the packaged gem files
+  [#48](https://github.com/eitoball/net-ping/pull/48).
+
 == 2.1.0 - 08-Aug-2026
 * Publish platform-specific gem metadata so Linux installs cap2 and current
   Windows RubyInstaller installs win32-security for ICMP support

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    net-ping (2.1.0)
+    net-ping (2.1.1)
 
 GEM
   remote: https://rubygems.org/

data/lib/net/ping/version.rb

@@ -1,6 +1,6 @@
 module Net
   class Ping
     # The version of the net-ping library.
-    VERSION = '2.1.0'
+    VERSION = '2.1.1'
   end
 end

data/net-ping.gemspec

@@ -3,13 +3,15 @@ require_relative "lib/net/ping/version"
 Gem::Specification.new do |spec|
   spec.name      = 'net-ping'
   spec.version   = Net::Ping::VERSION
-  spec.license   = 'Artistic 2.0'
+  spec.license   = 'Artistic-2.0'
   spec.author    = 'Chris Chernesky'
   spec.email     = 'chris.netping@tinderglow.com'
   spec.homepage  = 'https://github.com/chernesk/net-ping'
   spec.summary   = 'A ping interface for Ruby.'
   spec.test_file = 'test/test_net_ping.rb'
-  spec.files     = Dir['**/*'].reject { |f| f.include?('git') || File.extname(f) == '.gem' }
+  spec.files     = Dir['**/*'].reject do |f|
+    f.include?('git') || File.extname(f) == '.gem' || f == 'CLAUDE.md' || f == 'docs' || f.start_with?('docs/')
+  end
   spec.metadata = {
     'bug_tracker_uri' => "#{spec.homepage}/issues",
     'changelog_uri' => "#{spec.homepage}/blob/master/CHANGES",

data/test/test_net_ping_gem_packaging.rb

@@ -78,6 +78,16 @@ class TestNetPingGemPackaging < Test::Unit::TestCase
     delete_files(built_gem_files)
   end
 
+  def test_gem_create_excludes_non_distributable_project_files_from_spec_files
+    load_specifications.each do |path, spec|
+      non_distributable = spec.files.select do |f|
+        f == 'CLAUDE.md' || f == 'docs' || f.start_with?('docs/')
+      end
+
+      assert_equal([], non_distributable, path)
+    end
+  end
+
   def test_gem_check_uses_fixed_expectations_instead_of_loaded_specifications
     stdout, stderr, status = run_rake('clean', 'gem:create')
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: net-ping
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Chris Chernesky
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-08-08 00:00:00.000000000 Z
+date: 2026-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -80,15 +80,12 @@ extra_rdoc_files:
 files:
 - CHANGES
 - CHANGES.out_of_date
-- CLAUDE.md
 - Gemfile
 - Gemfile.lock
 - MANIFEST
 - README.md
 - Rakefile
 - doc/ping.txt
-- docs/superpowers/plans/2026-07-25-platform-specific-gems.md
-- docs/superpowers/specs/2026-07-25-platform-specific-gems-design.md
 - examples/example_pingexternal.rb
 - examples/example_pinghttp.rb
 - examples/example_pingtcp.rb
@@ -115,7 +112,7 @@ files:
 - test/test_net_ping_wmi.rb
 homepage: https://github.com/chernesk/net-ping
 licenses:
-- Artistic 2.0
+- Artistic-2.0
 metadata:
   bug_tracker_uri: https://github.com/chernesk/net-ping/issues
   changelog_uri: https://github.com/chernesk/net-ping/blob/master/CHANGES

data/CLAUDE.md

@@ -1,89 +0,0 @@
-# CLAUDE.md
-
-This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
-
-## Development commands
-
-Install dependencies:
-
-```sh
-bundle install
-```
-
-Run the default suite:
-
-```sh
-bundle exec rake test
-```
-
-Run one protocol-specific test file through its Rake task:
-
-```sh
-bundle exec rake test:tcp
-bundle exec rake test:http
-bundle exec rake test:udp
-bundle exec rake test:external
-bundle exec rake test:icmp
-bundle exec rake test:wmi
-```
-
-There is no lint task or linter configuration. Build the gem with
-`bundle exec rake gem:create`; `bundle exec rake gem:install` builds and
-installs it locally.
-
-`test:icmp` requires elevated privileges: root or `net_raw` capability on
-Unix (checked via the `cap2` gem, falling back to a root check if `cap2`
-isn't available), or elevated security on Windows (via `win32-security`).
-The aggregate `test` task (`test/test_net_ping.rb`) only requires the ICMP
-test file when that privilege check passes. External-ping tests invoke the
-system `ping` command; HTTP tests use FakeWeb/webmock except the timeout
-case, which makes a real network connection.
-
-CI (`.github/workflows/test.yml`) runs `bundle exec rake test` on
-ubuntu-latest and windows-latest across Ruby 2.7-3.4.
-
-## Architecture
-
-This is a Ruby gem that exposes `Net::Ping` implementations for several
-reachability mechanisms:
-
-- `lib/net/ping/ping.rb` defines the abstract `Net::Ping` base class and its
-  shared state: `host`, `port`, `timeout`, `exception`, `warning`, and
-  `duration`.
-- `lib/net/ping/{tcp,udp,icmp,external,http}.rb` implement socket, raw ICMP,
-  system-command, and HTTP pings. `wmi.rb` is loaded only on Windows
-  (`File::ALT_SEPARATOR` check).
-- `lib/net/ping.rb` is the all-in-one entry point (`require 'net/ping'`);
-  requiring a protocol file directly (e.g. `require 'net/ping/tcp'`) loads
-  only that implementation and reduces memory footprint.
-- Each protocol has a matching `test/test_net_ping_<protocol>.rb` file. The
-  aggregate `test/test_net_ping.rb` requires the supported protocol suites
-  based on the platform/privilege checks described above.
-
-## Repository-specific conventions
-
-- A subclass `ping` method calls `super(host)` first. The base implementation
-  validates that a host is present and resets `@exception`, `@warning`, and
-  `@duration` for each attempt.
-- `ping` returns a truthy success value or `false`; callers inspect
-  `exception` after failures rather than receive connection errors. Set
-  `duration` only after a successful ping and leave it `nil` on failure.
-  `ping?` is the boolean wrapper supplied by the base class (or an explicit
-  alias in `External`).
-- TCP and UDP treat connection refusal according to their class-level
-  `service_check` setting (aliased as `econnrefused`/`ecr`). Keep the
-  Boolean-only setter validation and test both modes when changing that
-  behavior.
-- Preserve platform branches: `External` maps `ping`/`ping6` options to each
-  OS's `ping`/`ping6` syntax (Linux, AIX, BSD/macOS, Solaris, HP-UX, Windows),
-  ICMP requires raw-socket privileges, and WMI is Windows-only.
-- HTTP tests stub requests with FakeWeb/webmock and reset proxy environment
-  variables in `setup`; register any new HTTP cases rather than making
-  ordinary tests depend on live services.
-
-## Repository layout notes
-
-- `.worktrees/` contains git worktrees for in-progress branches; treat them
-  as separate checkouts, not part of the main tree.
-- `docs/superpowers/` holds plan/spec documents from prior sessions using the
-  `superpowers` skill set — reference material, not source.

data/docs/superpowers/plans/2026-07-25-platform-specific-gems.md

@@ -1,317 +0,0 @@
-# Platform-specific Gem Dependencies Implementation Plan
-
-> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
-
-**Goal:** Build and validate RubyGems artifacts that install `cap2` on Linux and `win32-security` on current Windows RubyInstaller systems.
-
-**Architecture:** Keep `net-ping.gemspec` OS-independent and create two small gemspec overlays for Linux and `mingw-ucrt`. Centralize artifact generation and metadata validation in the Rake gem namespace, then run that validation in the existing Linux/Windows CI matrix.
-
-**Tech Stack:** Ruby, RubyGems (`Gem::Specification`, `Gem::Package`, `Gem::Platform`), Rake, test-unit, GitHub Actions.
-
-## Global Constraints
-
-- Produce exactly three same-version `net-ping` gems: `ruby`, `universal-linux`, and `universal-mingw-ucrt`.
-- `universal-linux` must add `cap2 (>= 0.2.2)`; `universal-mingw-ucrt` must add `win32-security (>= 0.2.0)`.
-- The Ruby gem must not contain either OS-specific runtime dependency.
-- Support `mingw-ucrt` only; legacy `mingw32` is out of scope.
-- CI builds and validates artifacts but never publishes them.
-- Do not create git commits for this work.
-
----
-
-## File Structure
-
-| File | Responsibility |
-| --- | --- |
-| `net-ping.gemspec` | Define the OS-independent Ruby artifact and common metadata. |
-| `net-ping-universal-linux.gemspec` | Overlay `universal-linux` and the `cap2` runtime dependency. |
-| `net-ping-universal-mingw-ucrt.gemspec` | Overlay `universal-mingw-ucrt` and the `win32-security` runtime dependency. |
-| `Rakefile` | Build, inspect, and locally install the platform-appropriate artifact. |
-| `test/test_net_ping_gem_packaging.rb` | Build temporary artifacts and assert their platform/dependency metadata. |
-| `test/test_net_ping.rb` | Load the packaging test in the aggregate suite. |
-| `.github/workflows/test.yml` | Run gem artifact checks on Linux and Windows. |
-| `README.md` | Explain automatic platform-specific dependency installation. |
-| `CHANGES` | Record the metadata correction for the next release. |
-
-### Task 1: Define and test platform gem specifications
-
-**Files:**
-- Create: `net-ping-universal-linux.gemspec`
-- Create: `net-ping-universal-mingw-ucrt.gemspec`
-- Create: `test/test_net_ping_gem_packaging.rb`
-- Modify: `net-ping.gemspec:1-40`
-- Modify: `test/test_net_ping.rb`
-
-**Interfaces:**
-- Consumes: `net-ping.gemspec`, which supplies the shared `Gem::Specification`.
-- Produces: three loadable gemspecs whose `platform` and `runtime_dependencies` describe their target platform.
-
-- [ ] **Step 1: Write the failing package-metadata test**
-
-Create `test/test_net_ping_gem_packaging.rb`. Load every gemspec before building any artifact so `spec.files` cannot include an artifact created for an earlier specification. Build the loaded specifications into temporary `.gem` files, open each using `Gem::Package`, and assert the platform and runtime dependencies:
-
-```ruby
-require 'rubygems/package'
-require 'test/unit'
-
-class TestNetPingGemPackaging < Test::Unit::TestCase
-  EXPECTATIONS = {
-    'net-ping.gemspec' => ['ruby', {}],
-    'net-ping-universal-linux.gemspec' => ['universal-linux', {'cap2' => '>= 0.2.2'}],
-    'net-ping-universal-mingw-ucrt.gemspec' => [
-      'universal-mingw-ucrt',
-      {'win32-security' => '>= 0.2.0'}
-    ]
-  }.freeze
-
-  def setup
-    @specifications = EXPECTATIONS.keys.map do |path|
-      [path, Gem::Specification.load(path)]
-    end
-    @gem_files = @specifications.map { |_, spec| Gem::Package.build(spec) }
-  end
-
-  def teardown
-    @gem_files.each { |path| File.delete(path) if File.exist?(path) }
-  end
-
-  def test_platforms_and_runtime_dependencies
-    @specifications.each do |path, spec|
-      expected_platform, expected_dependencies = EXPECTATIONS.fetch(path)
-      packaged_spec = Gem::Package.new(spec.file_name).spec
-      dependencies = packaged_spec.runtime_dependencies.to_h do |dependency|
-        [dependency.name, dependency.requirement.to_s]
-      end
-
-      assert_equal(expected_platform, packaged_spec.platform.to_s, path)
-      assert_equal(expected_dependencies, dependencies, path)
-    end
-  end
-end
-```
-
-Add `require 'test_net_ping_gem_packaging'` to `test/test_net_ping.rb`.
-
-- [ ] **Step 2: Run the new test to verify it fails**
-
-Run:
-
-```sh
-bundle exec ruby -Itest test/test_net_ping_gem_packaging.rb
-```
-
-Expected: failure because the Linux and Windows overlay gemspec files do not exist.
-
-- [ ] **Step 3: Make the base gemspec OS-independent and add overlays**
-
-Remove the `File::ALT_SEPARATOR`, `RbConfig`, and `RUBY_PLATFORM` conditional runtime dependency logic from `net-ping.gemspec`; leave only shared metadata and development dependencies.
-
-Create `net-ping-universal-linux.gemspec`:
-
-```ruby
-spec = Gem::Specification.load('net-ping.gemspec')
-spec.platform = Gem::Platform.new(['universal', 'linux'])
-spec.add_dependency('cap2', '>= 0.2.2')
-spec
-```
-
-Create `net-ping-universal-mingw-ucrt.gemspec`:
-
-```ruby
-spec = Gem::Specification.load('net-ping.gemspec')
-spec.platform = Gem::Platform.new(['universal', 'mingw-ucrt'])
-spec.add_dependency('win32-security', '>= 0.2.0')
-spec
-```
-
-Use the project’s existing block-style `Gem::Specification.new` format for the base gemspec. Verify the installed RubyGems version accepts the two platform strings with `Gem::Platform.new`.
-
-- [ ] **Step 4: Run the package-metadata test to verify it passes**
-
-Run:
-
-```sh
-bundle exec ruby -Itest test/test_net_ping_gem_packaging.rb
-```
-
-Expected: PASS; all three artifacts have the expected platform and exactly the expected runtime dependencies.
-
-- [ ] **Step 5: Run the aggregate test suite**
-
-Run:
-
-```sh
-bundle exec rake test
-```
-
-Expected: PASS.
-
-### Task 2: Make Rake build, validate, and install platform artifacts deterministically
-
-**Files:**
-- Modify: `Rakefile:6-29`
-
-**Interfaces:**
-- Consumes: the three gemspec paths from Task 1.
-- Produces: `gem:create` builds all artifacts; `gem:check` aborts on invalid artifact metadata; `gem:install` installs the local platform’s specific artifact or the Ruby fallback.
-
-- [ ] **Step 1: Add a failing artifact-validation command**
-
-Add `gem:check` to the `gem` namespace. It must load the three expected gem files with `Gem::Package`, map each runtime dependency to `name => requirement.to_s`, and abort if the platform or dependency hash differs from:
-
-```ruby
-{
-  'ruby' => {},
-  'universal-linux' => {'cap2' => '>= 0.2.2'},
-  'universal-mingw-ucrt' => {'win32-security' => '>= 0.2.0'}
-}
-```
-
-Run it before changing `gem:create`:
-
-```sh
-bundle exec rake clean gem:create gem:check
-```
-
-Expected: FAIL because `gem:create` still builds only one artifact.
-
-- [ ] **Step 2: Implement deterministic specification loading and artifact creation**
-
-Define the shared list once in `Rakefile`:
-
-```ruby
-GEMSPEC_FILES = %w[
-  net-ping.gemspec
-  net-ping-universal-linux.gemspec
-  net-ping-universal-mingw-ucrt.gemspec
-].freeze
-```
-
-Update `gem:create` to load all files before it builds any artifact:
-
-```ruby
-specifications = GEMSPEC_FILES.map { |path| Gem::Specification.load(path) }
-specifications.each { |spec| Gem::Package.build(spec) }
-```
-
-Retain the existing RubyGems pre-2.0 builder branch if support for it is still required. In either branch, load every specification before beginning the build loop.
-
-Implement `gem:check` using `Gem::Package.new(file).spec`; use `abort` with the artifact filename and expected/actual values when a check fails.
-
-Update `gem:install` to load the same specification list and select:
-
-```ruby
-specific = specifications.find do |spec|
-  spec.platform != Gem::Platform::RUBY && Gem::Platform.installable?(spec)
-end
-spec = specific || specifications.find { |item| item.platform == Gem::Platform::RUBY }
-```
-
-Install `spec.file_name`, not `Dir['*.gem'].first`; abort when no Ruby fallback specification is found.
-
-- [ ] **Step 3: Run artifact validation to verify it passes**
-
-Run:
-
-```sh
-bundle exec rake gem:create gem:check
-```
-
-Expected: PASS and creation of `net-ping-<version>.gem`,
-`net-ping-<version>-universal-linux.gem`, and
-`net-ping-<version>-universal-mingw-ucrt.gem`.
-
-- [ ] **Step 4: Verify local artifact selection**
-
-Run:
-
-```sh
-bundle exec rake gem:install
-gem specification net-ping platform
-```
-
-Expected on Linux: `universal-linux`; on Windows: `universal-mingw-ucrt`; on
-other platforms: `ruby`.
-
-- [ ] **Step 5: Re-run tests**
-
-Run:
-
-```sh
-bundle exec rake test
-```
-
-Expected: PASS.
-
-### Task 3: Enforce packaging in CI and document the behavior
-
-**Files:**
-- Modify: `.github/workflows/test.yml:19-28`
-- Modify: `README.md:4-15`
-- Modify: `CHANGES:1-13`
-
-**Interfaces:**
-- Consumes: `gem:create` and `gem:check` from Task 2.
-- Produces: CI verification on both matrix operating systems and accurate end-user dependency documentation.
-
-- [ ] **Step 1: Add the CI packaging verification step**
-
-After the existing `bundle exec rake test` step, add:
-
-```yaml
-      - run: bundle exec rake gem:create gem:check
-```
-
-Do not add RubyGems credentials, publishing actions, or tag triggers.
-
-- [ ] **Step 2: Document platform-specific dependency resolution**
-
-Replace the prerequisite list’s unconditional `win32-security (MS Windows
-only)` wording with text that states RubyGems installs `win32-security` from
-the Windows artifact and `cap2` from the Linux artifact when installing
-`net-ping`. Keep the installation command `gem install net-ping`.
-
-At the beginning of `CHANGES`, add:
-
-```text
-== Next Release
-* Publish platform-specific gem metadata so Linux installs cap2 and current
-  Windows RubyInstaller installs win32-security for ICMP support.
-```
-
-- [ ] **Step 3: Run targeted packaging and full test verification**
-
-Run:
-
-```sh
-bundle exec rake gem:create gem:check
-bundle exec rake test
-```
-
-Expected: both commands PASS.
-
-- [ ] **Step 4: Inspect the final diff without committing**
-
-Run:
-
-```sh
-git diff --check
-git diff -- net-ping.gemspec net-ping-universal-linux.gemspec \
-  net-ping-universal-mingw-ucrt.gemspec Rakefile \
-  test/test_net_ping_gem_packaging.rb test/test_net_ping.rb \
-  .github/workflows/test.yml README.md CHANGES
-```
-
-Expected: only the planned packaging, CI, test, and documentation changes;
-no whitespace errors and no git commit.
-
-## Plan Self-Review
-
-- **Spec coverage:** Task 1 creates the three required artifacts and assigns
-  their dependencies; Task 2 validates metadata and selects a local artifact;
-  Task 3 runs validation in CI and documents the behavior. CI publishing,
-  legacy `mingw32`, and runtime protocol changes are excluded.
-- **Placeholder scan:** No unresolved item, unspecified test, or ambiguous
-  implementation step remains.
-- **Consistency:** The gemspec filenames, platform names, dependency
-  versions, and Rake task names are identical across all tasks.

data/docs/superpowers/specs/2026-07-25-platform-specific-gems-design.md

@@ -1,71 +0,0 @@
-# Platform-specific gem dependencies
-
-## Goal
-
-Resolve issue #31 by publishing platform-specific `net-ping` gems whose
-runtime dependencies accurately describe the requirements for ICMP support.
-The solution also corrects the equivalent Linux `cap2` metadata omission.
-
-## Scope
-
-The release produces three gems with the same name and version:
-
-| Gem platform | Additional runtime dependency |
-| --- | --- |
-| `ruby` | None |
-| `universal-linux` | `cap2 (>= 0.2.2)` |
-| `universal-mingw-ucrt` | `win32-security (>= 0.2.0)` |
-
-Only the current RubyInstaller `mingw-ucrt` platform is supported for Windows.
-Legacy `mingw32` is out of scope.
-
-The CI workflow builds and validates these gems, but does not publish them.
-The existing release process remains responsible for pushing all three files
-to RubyGems.
-
-## Design
-
-`net-ping.gemspec` becomes the OS-independent Ruby gemspec. It must not
-inspect the host OS or add OS-specific runtime dependencies.
-
-`net-ping-universal-linux.gemspec` loads the base specification, changes its
-platform to `universal-linux`, and adds `cap2`. The platform is intentionally
-CPU-independent so RubyGems can select it for supported Linux CPU variants.
-
-`net-ping-universal-mingw-ucrt.gemspec` loads the same base specification,
-changes its platform to `universal-mingw-ucrt`, and adds `win32-security`.
-
-The Rake gem namespace explicitly enumerates the three gemspecs. `gem:create`
-cleans old gem artifacts and builds all three. `gem:install` selects the
-specific generated specification compatible with the local platform, falling
-back to the Ruby specification when no platform-specific specification
-matches, then installs its artifact.
-
-## Verification
-
-Add `gem:check`, which reads each generated gem through RubyGems and fails
-when its platform or runtime dependencies differ from this specification:
-
-- Ruby gem: platform `ruby`; neither `cap2` nor `win32-security`.
-- Linux gem: platform `universal-linux`; includes `cap2`.
-- Windows gem: platform `universal-mingw-ucrt`; includes `win32-security`.
-
-The existing GitHub Actions matrix continues to run the test suite. It also
-runs `gem:create` and `gem:check` on both Ubuntu and Windows. A missing,
-malformed, or incorrectly attributed dependency causes the job to fail.
-
-## Documentation
-
-Update the prerequisite/install documentation to state that RubyGems chooses
-the platform-specific package and installs the Linux or Windows ICMP
-dependency automatically.
-
-Add a `CHANGES` entry describing the corrected platform-specific dependency
-metadata.
-
-## Non-goals
-
-- Publishing gems from CI.
-- Supporting legacy `mingw32`.
-- Changing ICMP runtime behavior.
-- Altering non-ICMP protocol implementations or tests.