random-port 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dbc9a31f4b53484b240f4f2bb37c7f1ed9208bc1e5e31b09df8c95c9aa909d1
-  data.tar.gz: 9d6f1d3e5a912ffa03ac3a168bc47d1492775435276a709a33d918b5b103ec00
+  metadata.gz: 8d89270eaf87254ef245e9a207758052081e2d50b530d3d0f893bda91e35406d
+  data.tar.gz: 61261be32c1b20a47306df4773ecd527e86efc20d8cb734d127cdeb6fa92a8cf
 SHA512:
-  metadata.gz: d382bafa4db3b722d8ebefda93d5c5460a3e61581bab49646cc804841f4f7edafb9203c2006557c16ef6aa6b6111ed9db011cd68f3a104b1a165fc8834e31f40
-  data.tar.gz: d1318acea077ce7df07d2d514c6b9f676581c8d2b69ddb43337cc148567cdeb16f7c1584559723833319053ae287dbba6ca228a9d236493d6bd52b9433441d3d
+  metadata.gz: f6c36601ddfe67c1cd4d427ec3d7afd9a2ffaa82f698e13077707cd904b2241ab6fd73ac16bb5e5d2547f239df08a18340d4bf6253fd24514dd73556ca894a84
+  data.tar.gz: f46462e3038d131436fdbd82cdd3e65ae413c005f4e30a6652bda1a09a1560018fcb1c94f6fbd4ff8830bdcea468c76833f41666dd04ccfe18123bceee416d95

data/.rubocop.yml

@@ -2,7 +2,7 @@ AllCops:
   DisplayCopNames: true
   TargetRubyVersion: 2.3.3
 
-Style/FileName:
+Naming/FileName:
   Enabled: false
 Metrics/MethodLength:
   Max: 50

data/README.md

@@ -4,6 +4,7 @@
 [![Build Status](https://travis-ci.org/yegor256/random-port.svg)](https://travis-ci.org/yegor256/random-port)
 [![Gem Version](https://badge.fury.io/rb/random-port.svg)](http://badge.fury.io/rb/random-port)
 [![Maintainability](https://api.codeclimate.com/v1/badges/349b8c31884d3b34d926/maintainability)](https://codeclimate.com/github/yegor256/random-port/maintainability)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/yegor256/random-port/master/frames)
 
 It's a simple Ruby gem to get a random TCP port.
 
@@ -46,7 +47,9 @@ RandomPort::Pool::SINGLETON.acquire do |port|
 end
 ```
 
-The pool is _not_ thread-safe.
+The pool is thread-safe by default.
+You can configure it to be
+not-thread-safe, using optional `sync` argument of the constructor.
 
 # How to contribute
 

data/lib/random-port/pool.rb

@@ -23,39 +23,62 @@
 # SOFTWARE.
 
 require 'socket'
+require 'monitor'
 
 module RandomPort
   # Pool of TPC ports.
   #
-  # The class is NOT thread-safe!
+  # Use it like this:
+  #
+  #  RandomPort::Pool.new.acquire do |port|
+  #    # Use the TCP port. It will be returned back
+  #    # to the pool afterwards.
+  #  end
+  #
+  # The class is thread-safe, by default. You can configure it to be
+  # not-thread-safe, using optional <tt>sync</tt> argument of the constructor.
   #
   # Author:: Yegor Bugayenko (yegor256@gmail.com)
   # Copyright:: Copyright (c) 2018 Yegor Bugayenko
   # License:: MIT
   class Pool
-    def initialize
+    def initialize(sync: false)
       @ports = []
+      @sync = sync
+      @monitor = Monitor.new
     end
 
     # Application wide pool of ports
     SINGLETON = Pool.new
 
+    # Acquire a new random TCP port.
     def acquire
       loop do
         server = TCPServer.new('127.0.0.1', 0)
         port = server.addr[1]
         server.close
         next if @ports.include?(port)
-        @ports << port
+        safe { @ports << port }
         return port unless block_given?
         yield port
-        @ports.delete(port)
+        safe { @ports.delete(port) }
         break
       end
     end
 
+    # Return it back to the pool.
     def release(port)
-      @ports.delete(port)
+      safe { @ports.delete(port) }
+    end
+
+    private
+
+    def safe
+      if @sync
+        @monitor.synchronize { yield }
+      else
+        yield
+      end
     end
   end
 end

data/random-port.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = '2.3.3'
   s.required_ruby_version = '>=2.3'
   s.name = 'random-port'
-  s.version = '0.3.0'
+  s.version = '0.3.1'
   s.license = 'MIT'
   s.summary = 'Random TCP port'
   s.description = 'Reserves a random TCP port'
@@ -42,9 +42,9 @@ Gem::Specification.new do |s|
   s.test_files = s.files.grep(%r{^(test)/})
   s.rdoc_options = ['--charset=UTF-8']
   s.extra_rdoc_files = ['README.md']
-  s.add_development_dependency 'minitest', '~>5.11'
-  s.add_development_dependency 'rake', '~>12.3'
-  s.add_development_dependency 'rdoc', '~>4.2'
+  s.add_development_dependency 'minitest', '5.11.3'
+  s.add_development_dependency 'rake', '12.3.1'
+  s.add_development_dependency 'rdoc', '4.3.0'
   s.add_development_dependency 'rubocop', '0.58.1'
   s.add_development_dependency 'rubocop-rspec', '1.27.0'
 end

data/test/test_pool.rb

@@ -52,5 +52,18 @@ module RandomPort
         assert(port.positive?)
       end
     end
+
+    def test_acquires_unique_numbers
+      total = 25
+      numbers = (0..total - 1).map { Pool::SINGLETON.acquire }
+      assert_equal(total, numbers.uniq.count)
+    end
+
+    def test_acquires_unique_numbers_in_no_sync_mode
+      total = 25
+      pool = Pool.new(sync: false)
+      numbers = (0..total - 1).map { pool.acquire }
+      assert_equal(total, numbers.uniq.count)
+    end
   end
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: random-port
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-27 00:00:00.000000000 Z
+date: 2018-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '5.11'
+        version: 5.11.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '5.11'
+        version: 5.11.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: 12.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: 12.3.1
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: 4.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: 4.3.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement