random-port 0.7.3 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 627f7f283d6d1958380c9794dd78a50b7068144afa5e7b6f988d8cca325cf114
-  data.tar.gz: 4559900eed96735698944d63366666130fbb729b1a12a26d79a9e77eb5085bec
+  metadata.gz: 685cbbb964686d55837c88f3856b60207d3abaadb76e96ba9f9093bc8aba0a9c
+  data.tar.gz: 83e7ea6c0ac635b3c06cb1d190d3a991be61d4d534596ae10852c1a7a8df542d
 SHA512:
-  metadata.gz: e1bea15f564c1b5f9e4bc292b71501aa799b6b674337b1c9c504cbd7edee6bbd508c4beb4fe3648fdc83a184d3924ca4a595b253b383f9d2cb7d213ee518ae1c
-  data.tar.gz: db5b1ee1490292eaf644eb68567d1289354a355c6a2c768037005db2d44111bc232f120358ffc231964579b005315269e0927de96f547c4ad012a87c84220b65
+  metadata.gz: 48adf68a56c6ac4550287538b7cefa09cf033575e56dd8cdd6d53f0bc49004c87270f4c3b1d5c30576e721bf9c0589245c50854b494a3ec191588fc9e974253a
+  data.tar.gz: bd33bb2321ea165a1e9e546fa257db2a824572a07462af36ebd0e4e2fe93a4679c16f269170f51042046e139c7ed35a76bd4bd39338dd6a00777ddb4c1fb1214

data/.0pdd.yml

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2024 Yegor Bugayenko
+# Copyright (c) 2018-2025 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

data/.github/workflows/actionlint.yml

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2024 Yegor Bugayenko
+# Copyright (c) 2018-2025 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

data/.github/workflows/codecov.yml

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2024 Yegor Bugayenko
+# Copyright (c) 2018-2025 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -19,12 +19,13 @@
 # SOFTWARE.
 ---
 name: codecov
-on:
+'on':
   push:
     branches:
       - master
 jobs:
   codecov:
+    timeout-minutes: 5
     runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
@@ -36,3 +37,5 @@ jobs:
       - uses: codecov/codecov-action@v5
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
+          files: coverage/.resultset.json
+          fail_ci_if_error: true

data/.github/workflows/copyrights.yml

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2024 Yegor Bugayenko
+# Copyright (c) 2018-2025 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -21,7 +21,11 @@
 name: copyrights
 'on':
   push:
+    branches:
+      - master
   pull_request:
+    branches:
+      - master
 jobs:
   copyrights:
     runs-on: ubuntu-24.04

data/.github/workflows/markdown-lint.yml

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2024 Yegor Bugayenko
+# Copyright (c) 2018-2025 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

data/.github/workflows/pdd.yml

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2024 Yegor Bugayenko
+# Copyright (c) 2018-2025 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -19,7 +19,7 @@
 # SOFTWARE.
 ---
 name: pdd
-on:
+'on':
   push:
     branches:
       - master

data/.github/workflows/rake.yml

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2024 Yegor Bugayenko
+# Copyright (c) 2018-2025 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -19,7 +19,7 @@
 # SOFTWARE.
 ---
 name: rake
-on:
+'on':
   push:
     branches:
       - master
@@ -27,8 +27,8 @@ on:
     branches:
       - master
 jobs:
-  test:
-    name: test
+  rake:
+    timeout-minutes: 5
     strategy:
       matrix:
         os: [ubuntu-24.04, macos-15, windows-2022]

data/.github/workflows/xcop.yml

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2024 Yegor Bugayenko
+# Copyright (c) 2018-2025 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -19,9 +19,13 @@
 # SOFTWARE.
 ---
 name: xcop
-on:
+'on':
   push:
+    branches:
+      - master
   pull_request:
+    branches:
+      - master
 jobs:
   xcop:
     runs-on: ubuntu-24.04

data/.gitignore

@@ -5,4 +5,4 @@ Gemfile.lock
 rdoc/
 coverage/
 .yardoc/
-doc/
+doc/

data/.rubocop.yml

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2024 Yegor Bugayenko
+# Copyright (c) 2018-2025 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -23,7 +23,11 @@ AllCops:
   TargetRubyVersion: 2.3.3
   NewCops: enable
   SuggestExtensions: false
+require:
+  - rubocop-minitest
 
+Minitest/EmptyLineBeforeAssertionMethods:
+  Enabled: false
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
 Style/ClassAndModuleChildren:
@@ -44,3 +48,5 @@ Metrics/CyclomaticComplexity:
   Max: 20
 Metrics/AbcSize:
   Max: 60
+Metrics/ClassLength:
+  Max: 150

data/.rultor.yml

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2024 Yegor Bugayenko
+# Copyright (c) 2018-2025 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2018-2024 Yegor Bugayenko
+# Copyright (c) 2018-2025 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -24,9 +24,11 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'minitest', '5.25.4', require: false
+gem 'qbash', '>=0.2.2', require: false
 gem 'rake', '13.2.1', require: false
-gem 'rubocop', '1.69.2', require: false
-gem 'rubocop-rspec', '3.3.0', require: false
+gem 'rubocop', '1.71.0', require: false
+gem 'rubocop-minitest', '0.36.0', require: false
+gem 'rubocop-rspec', '3.4.0', require: false
 gem 'simplecov', '0.22.0', require: false
 gem 'threads', '0.4.1', require: false
 gem 'yard', '0.9.37', require: false

data/LICENSE.txt

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2018-2024 Yegor Bugayenko
+Copyright (c) 2018-2025 Yegor Bugayenko
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the 'Software'), to deal

data/Rakefile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2018-2024 Yegor Bugayenko
+# Copyright (c) 2018-2025 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

data/lib/random-port/module.rb

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2018-2024 Yegor Bugayenko
+# Copyright (c) 2018-2025 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -25,7 +25,7 @@
 # The module for all classes.
 #
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2018-2024 Yegor Bugayenko
+# Copyright:: Copyright (c) 2018-2025 Yegor Bugayenko
 # License:: MIT
 module RandomPort
 end

data/lib/random-port/pool.rb

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2018-2024 Yegor Bugayenko
+# Copyright (c) 2018-2025 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -44,7 +44,7 @@ require_relative 'module'
 # passing <tt>FALSE</tt>.
 #
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2018-2024 Yegor Bugayenko
+# Copyright:: Copyright (c) 2018-2025 Yegor Bugayenko
 # License:: MIT
 class RandomPort::Pool
   # If can't acquire by time out.
@@ -55,12 +55,13 @@ class RandomPort::Pool
   # Ctor.
   # @param [Boolean] sync Set it to FALSE if you want this pool to be NOT thread-safe
   # @param [Integer] limit Set the maximum number of ports in the pool
-  def initialize(sync: true, limit: 65_536)
+  # @param [Integer] start The next port to try
+  def initialize(sync: true, limit: 65_536, start: 1025)
     @ports = []
     @sync = sync
     @monitor = Monitor.new
     @limit = limit
-    @next = 1024
+    @next = start
   end
 
   # Application wide pool of ports
@@ -96,25 +97,14 @@ class RandomPort::Pool
           "for #{total} port(s), after #{attempt} attempts in #{start.ago}"
       end
       attempt +=  1
-      opts = safe do
-        next if @ports.count + total > @limit
-        opts = Array.new(0, total)
-        begin
-          (0..(total - 1)).each do |i|
-            opts[i] = take(i.zero? ? @next : opts[i - 1] + 1)
-          end
-        rescue Errno::EADDRINUSE, SocketError
-          next
-        end
-        next if opts.any? { |p| @ports.include?(p) }
-        d = total * (total - 1) / 2
-        next unless opts.inject(&:+) - (total * opts.min) == d
-        @ports += opts
-        opts
+      opts = safe { group(total) }
+      if opts.nil?
+        @next += 1
+      else
+        @next = opts.max + 1
       end
-      next if opts.nil?
-      @next = opts.max + 1
       @next = 0 if @next > 65_535
+      next if opts.nil?
       opts = opts[0] if total == 1
       return opts unless block_given?
       begin
@@ -126,6 +116,8 @@ class RandomPort::Pool
   end
 
   # Return it/them back to the pool.
+  # @param [Integer] port TCP port number to release
+  # @return nil
   def release(port)
     safe do
       if port.is_a?(Array)
@@ -138,14 +130,38 @@ class RandomPort::Pool
 
   private
 
-  # Find one possible TCP port.
-  # @param [Integer] opt Suggested port number
-  # @return [Integer] Port found
-  def take(opt = 0)
-    server = TCPServer.new('127.0.0.1', opt)
-    p = server.addr[1]
-    server.close
-    p
+  # Take a group of ports, if possible.
+  # @param [Integer] total How many ports to take
+  # @return [Array<Integer>|nil] Ports found or NIL if impossible now
+  def group(total)
+    return nil if @ports.count + total > @limit
+    opts = Array.new(0, total)
+    begin
+      (0..(total - 1)).each do |i|
+        port = i.zero? ? @next : opts[i - 1] + 1
+        opts[i] = take(port)
+      end
+    rescue Errno::EADDRINUSE, SocketError
+      return nil
+    end
+    return nil if opts.any? { |p| @ports.include?(p) }
+    d = total * (total - 1) / 2
+    return nil unless opts.inject(&:+) - (total * opts.min) == d
+    @ports += opts
+    opts
+  end
+
+  # Find one possible TCP port or raise exception if this port can't be used.
+  #
+  # If port is occupied, this method raises an error (+Errno::EADDRINUSE+).
+  #
+  # @param [Integer] port Suggested port number
+  # @return [Integer] The same port number
+  def take(port)
+    ['127.0.0.1', '::1', '0.0.0.0', 'localhost'].each do |host|
+      TCPServer.new(host, port).close
+    end
+    port
   end
 
   def safe(&block)

data/lib/random-port.rb

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2018-2024 Yegor Bugayenko
+# Copyright (c) 2018-2025 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

data/random-port.gemspec

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2018-2024 Yegor Bugayenko
+# Copyright (c) 2018-2025 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
   s.required_ruby_version = '>=2.3'
   s.name = 'random-port'
-  s.version = '0.7.3'
+  s.version = '0.7.5'
   s.license = 'MIT'
   s.summary = 'Random TCP port'
   s.description = 'Reserves a random TCP port'

data/test/test__helper.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2018-2024 Yegor Bugayenko
+# Copyright (c) 2018-2025 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -24,4 +24,5 @@ $stdout.sync = true
 
 require 'simplecov'
 SimpleCov.start
+
 require 'minitest/autorun'

data/test/test_pool.rb

@@ -2,7 +2,7 @@
 
 # (The MIT License)
 #
-# Copyright (c) 2018-2024 Yegor Bugayenko
+# Copyright (c) 2018-2025 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -23,13 +23,15 @@
 # SOFTWARE.
 
 require 'minitest/autorun'
-require 'threads'
+require 'qbash'
+require 'shellwords'
 require 'socket'
+require 'threads'
 require_relative '../lib/random-port/pool'
 
 # Pool test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2018-2024 Yegor Bugayenko
+# Copyright:: Copyright (c) 2018-2025 Yegor Bugayenko
 # License:: MIT
 class RandomPort::TestPool < Minitest::Test
   def test_acquires_and_releases
@@ -37,8 +39,8 @@ class RandomPort::TestPool < Minitest::Test
     port = pool.acquire
     server = TCPServer.new('localhost', port)
     server.close
-    assert(!port.nil?)
-    assert(port.positive?)
+    refute_nil(port)
+    assert_predicate(port, :positive?)
     pool.release(port)
   end
 
@@ -56,11 +58,56 @@ class RandomPort::TestPool < Minitest::Test
     assert_equal(0, pool.size)
   end
 
+  def test_skips_truly_busy_port
+    port = RandomPort::Pool.new.acquire
+    server = TCPServer.new('127.0.0.1', port)
+    other = RandomPort::Pool.new(start: port).acquire
+    refute_equal(other, port)
+    server.close
+  end
+
+  def test_skips_externally_busy_port
+    skip 'Not supported on Windows' if Gem.win_platform?
+    ['127.0.0.1', 'localhost', '::1', '0.0.0.0'].each do |host|
+      Dir.mktmpdir do |home|
+        port = RandomPort::Pool.new.acquire
+        started = File.join(home, 'started.txt')
+        enough = File.join(home, 'enough.txt')
+        t =
+          Thread.new do
+            qbash(
+              [
+                'ruby', '-e',
+                Shellwords.escape(
+                  "
+                  require 'socket'
+                  require 'fileutils'
+                  TCPServer.new('#{host}', #{port})
+                  FileUtils.touch('#{started}')
+                  loop do
+                    break if File.exist?('#{enough}')
+                  end
+                  "
+                )
+              ]
+            )
+          end
+        loop do
+          break if File.exist?(started)
+        end
+        other = RandomPort::Pool.new(start: port).acquire
+        FileUtils.touch(enough)
+        t.join
+        refute_equal(other, port)
+      end
+    end
+  end
+
   def test_acquires_and_releases_three_ports_in_block
     pool = RandomPort::Pool.new(limit: 3)
     assert_equal(0, pool.size)
     pool.acquire(3, timeout: 16) do |ports|
-      assert(ports.is_a?(Array))
+      assert_kind_of(Array, ports)
       assert_equal(3, ports.count)
       assert_equal(3, pool.size)
       ports.each do |p|
@@ -73,8 +120,8 @@ class RandomPort::TestPool < Minitest::Test
 
   def test_acquires_and_releases_in_block
     result = RandomPort::Pool.new.acquire do |port|
-      assert(!port.nil?)
-      assert(port.positive?)
+      refute_nil(port)
+      assert_predicate(port, :positive?)
       123
     end
     assert_equal(123, result)
@@ -94,18 +141,18 @@ class RandomPort::TestPool < Minitest::Test
 
   def test_acquires_and_releases_safely
     pool = RandomPort::Pool.new
-    assert_raises do
+    assert_raises(StandardError) do
       pool.acquire do
         raise 'Itended'
       end
     end
-    assert(pool.count.zero?)
+    assert_predicate(pool.count, :zero?)
   end
 
   def test_acquires_and_releases_from_singleton
     RandomPort::Pool::SINGLETON.acquire do |port|
-      assert(!port.nil?)
-      assert(port.positive?)
+      refute_nil(port)
+      assert_predicate(port, :positive?)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: random-port
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.5
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-29 00:00:00.000000000 Z
+date: 2025-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tago