async 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8342091acbc6da153552ca269239949b27898eb7bff55ca9425687e86f314751
-  data.tar.gz: fa8fd142667ba572fd66554d25bf9490625811f91005c9c4b0ac76f9329dba69
+  metadata.gz: 4525bee2a2f58fece634c89881975c3f326ecaaecf4b5495a53f93b6e99360f7
+  data.tar.gz: e23e0f0caa1b383f695aec88aa567bc8daa9028907427ea371579fcd5adf94f6
 SHA512:
-  metadata.gz: f8e9d025de96cee15d9967e344a81dd01e3c3f6e64895f1deba1f2fd77edbbff2d9d7d63294cdaca6492add2112e5b0742e326c70845c52b8041b10eba96fd17
-  data.tar.gz: 4f07e3153419bd128c53c86f63fca88dcde579d906689e9bbaff488b6f782f11d3950a1f6754894f20880aa8aa09fcde50b7608c0c47b97ef0fe9314b5d5343b
+  metadata.gz: fd2b49c02f4ea805cfe5a3dad3b515adac78cc0edd2190c46f41b3c48460fc5e5d7daa0d3da5803a385552af69c1e557dc43a89f6a13a71e048a1a08c61c3a64
+  data.tar.gz: bb875d2e36bebb80c4850cfa1c4afc938189b2ff559652085cd932659d1363ecc82529bfcedf95197a0b73984821ab49247ef093388131a125efc3e7e9706a98

data/.travis.yml

@@ -18,6 +18,7 @@ matrix:
     - rvm: 2.3
     - rvm: 2.4
     - rvm: 2.5
+    - rvm: 2.6
     - rvm: jruby-head
       env: JRUBY_OPTS="--debug -X+O"
     - rvm: ruby-head

data/lib/async/semaphore.rb

@@ -0,0 +1,96 @@
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+module Async
+	# A semaphore is used to control access to a common resource in a concurrent system. A useful way to think of a semaphore as used in the real-world systems is as a record of how many units of a particular resource are available, coupled with operations to adjust that record safely (i.e. to avoid race conditions) as units are required or become free, and, if necessary, wait until a unit of the resource becomes available.
+	class Semaphore
+		def initialize(limit = 1)
+			@count = 0
+			@limit = limit
+			@waiting = []
+		end
+		
+		# The current number of tasks that have acquired the semaphore.
+		attr :count
+		
+		# The maximum number of tasks that can acquire the semaphore.
+		attr :limit
+		
+		# Whether trying to acquire this semaphore would block.
+		def blocking?
+			@count >= @limit
+		end
+		
+		# Acquire the semaphore, block if we are at the limit.
+		# If no block is provided, you must call release manually.
+		# @yield when the semaphore can be acquired
+		# @return the result of the block if invoked
+		def acquire
+			self.wait while blocking?
+			
+			@count += 1
+			
+			return unless block_given?
+			
+			begin
+				return yield
+			ensure
+				self.release
+			end
+		end
+		
+		# Release the semaphore. Must match up with a corresponding call to `acquire`.
+		def release
+			@count -= 1
+			
+			self.signal
+		end
+		
+		# Is anyone waiting?
+		def empty?
+			@waiting.empty?
+		end
+		
+		# Wait on this semaphore.
+		def wait
+			@waiting << Fiber.current
+			Task.yield
+		end
+		
+		# Resume any waiting tasks.
+		def signal(task: Task.current)
+			task.reactor << self if @waiting.any?
+		end
+		
+		# Whether this semaphore has work to do when being resumed.
+		def alive?
+			@waiting.any?
+		end
+		
+		# Resume tasks waiting on the semaphore, up to the maximum to the available limit.
+		def resume
+			available = @waiting.pop(@limit - @count)
+			
+			available.each do |fiber|
+				fiber.resume if fiber.alive?
+			end
+		end
+	end
+end

data/lib/async/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Async
-	VERSION = "1.8.0"
+	VERSION = "1.9.0"
 end

data/spec/async/semaphore_spec.rb

@@ -0,0 +1,45 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'async/semaphore'
+
+RSpec.describe Async::Semaphore do
+	include_context Async::RSpec::Reactor
+	
+	it 'should process work in batches' do
+		semaphore = Async::Semaphore.new(4)
+		current, maximum = 0, 0
+		
+		100.times.map do
+			reactor.async do |task|
+				semaphore.acquire do
+					current += 1
+					maximum = [current, maximum].max
+					task.sleep(0.01)
+					current -= 1
+				end
+			end
+		end.collect(&:result)
+		
+		expect(maximum).to be == 4
+	end
+	
+	it_behaves_like Async::Condition
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-29 00:00:00.000000000 Z
+date: 2018-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nio4r
@@ -128,6 +128,7 @@ files:
 - lib/async/notification.rb
 - lib/async/queue.rb
 - lib/async/reactor.rb
+- lib/async/semaphore.rb
 - lib/async/task.rb
 - lib/async/version.rb
 - lib/async/wrapper.rb
@@ -145,6 +146,7 @@ files:
 - spec/async/queue_spec.rb
 - spec/async/reactor/nested_spec.rb
 - spec/async/reactor_spec.rb
+- spec/async/semaphore_spec.rb
 - spec/async/task_spec.rb
 - spec/async/wrapper_spec.rb
 - spec/spec_helper.rb
@@ -183,6 +185,7 @@ test_files:
 - spec/async/queue_spec.rb
 - spec/async/reactor/nested_spec.rb
 - spec/async/reactor_spec.rb
+- spec/async/semaphore_spec.rb
 - spec/async/task_spec.rb
 - spec/async/wrapper_spec.rb
 - spec/spec_helper.rb