async-redis 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f51bfc647fd3f6a3f8a066cdfddd4147d072efb240fccce0e911ca6d0968831
-  data.tar.gz: e35d2061ecf625ad6dfd818e07718bc78af8b2c4095e2bf9b42b1ea02a385b0d
+  metadata.gz: cd8adb00be17d1c72515a20f6c73dbba0e4f995780b6bec7e4fefef0aca53853
+  data.tar.gz: 39c7bef188aafb043d7efb1fe437bf18fc215bc1ebff5834e118a28fd37a3cfb
 SHA512:
-  metadata.gz: 36d4b12adcaec403cf91f9ebfaa07d44f2e0381f72ca23c3420dd1359277d9ecc33de90c0413bb130ac8308aa88a6317bdcf0d722e7dcb34c1f8d5afbbee7cfe
-  data.tar.gz: b46435ea68404c5656631b362b130755a8b8a0837af03a29a950b988141ed61279eccc18d9711d3dd1fb03afc1b33fbe54d00d550158d719d6e1f38b24ee7132
+  metadata.gz: 872b269771f7bda3fd312cc70d334687062aefbc27b70e2cc155b06614a26290ee6db0aa3901ea2390b5e2a245617e12c8641eff88608ef8c72a17d83cf4cadc
+  data.tar.gz: 7cf5d03872e8d7197a00b2493af8838cd8591faa4f6843a02f4ece26d80ae31a58054b96e8b14c03c042fa879ff0a8781954f7c9091515c85cf60ef48f909e62

data/.editorconfig

@@ -0,0 +1,6 @@
+root = true
+
+[*]
+indent_style = tab
+indent_size = 2
+

data/.travis.yml

@@ -4,15 +4,12 @@ cache: bundler
 services:
   - redis-server
 
-before_script:
-  - gem update --system
-  - gem install bundler
-
 matrix:
   include:
     - 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/README.md

@@ -39,8 +39,8 @@ Or install it yourself as:
 
 Released under the MIT license.
 
-Copyright, 2018, by [Samuel G. D. Williams](https://www.codeotaku.com/samuel-williams) and
-Huba Z. Nagy
+Copyright, 2018, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).  
+Copyright, 2018, by Huba Z. Nagy.  
 
 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/async-redis.gemspec

@@ -16,8 +16,8 @@ Gem::Specification.new do |spec|
 	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
 	spec.require_paths = ["lib"]
 	
-	spec.add_dependency("async", "~> 1.6")
-	spec.add_dependency("async-io", "~> 1.7")
+	spec.add_dependency("async", "~> 1.8")
+	spec.add_dependency("async-io", "~> 1.10.0")
 	
 	spec.add_development_dependency "async-rspec", "~> 1.1"
 	

data/lib/async/redis.rb

@@ -1,4 +1,4 @@
-# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 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

data/lib/async/redis/client.rb

@@ -20,8 +20,10 @@
 
 require_relative 'protocol/resp'
 require_relative 'pool'
+require_relative 'context/multi'
+require_relative 'context/subscribe'
 
-require 'async/io/endpoint'
+require 'async/io'
 
 module Async
 	module Redis
@@ -34,7 +36,7 @@ module Async
 				@endpoint = endpoint
 				@protocol = protocol
 				
-				@connections = connect(**options)
+				@pool = connect(**options)
 			end
 			
 			attr :endpoint
@@ -53,11 +55,39 @@ module Async
 			end
 			
 			def close
-				@connections.close
+				@pool.close
+			end
+			
+			def publish(channel, message)
+				call('PUBLISH', channel, message)
+			end
+			
+			def subscribe(*channels)
+				context = Context::Subscribe.new(@pool, channels)
+				
+				return context unless block_given?
+				
+				begin
+					yield context
+				ensure
+					context.close
+				end
+			end
+			
+			def multi(&block)
+				context = Context::Multi.new(@pool)
+				
+				return context unless block_given?
+				
+				begin
+					yield context
+				ensure
+					context.close
+				end
 			end
 			
 			def call(*arguments)
-				@connections.acquire do |connection|
+				@pool.acquire do |connection|
 					connection.write_request(arguments)
 					return connection.read_response
 				end

data/lib/async/redis/context/multi.rb

@@ -0,0 +1,53 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# and Huba Nagy
+# 
+# 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_relative 'nested'
+
+module Async
+	module Redis
+		module Context
+			class Multi < Nested
+				def initialize(pool, *args)
+					super(pool)
+					
+					@connection.write_request(['MULTI'])
+					@connection.read_response
+				end
+				
+				def set(key, value)
+					return send_command('SET', key, value)
+				end
+				
+				def get(key)
+					return send_command 'GET', key
+				end
+				
+				def execute
+					return send_command 'EXEC'
+				end
+				
+				def discard
+					return send_command 'DISCARD'
+				end
+			end
+		end
+	end 
+end

data/lib/async/redis/context/nested.rb

@@ -0,0 +1,45 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# and Huba Nagy
+# 
+# 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
+	module Redis
+		module Context
+			class Nested
+				def initialize(pool, *args)
+					@pool = pool
+					@connection = pool.acquire
+				end
+				
+				def close
+					if @connection
+						@pool.release(@connection)
+						@connection = nil
+					end
+				end
+				
+				def send_command(command, *args)
+					@connection.write_request([command, *args])
+					return @connection.read_response
+				end
+			end
+		end
+	end
+end

data/lib/async/redis/context/subscribe.rb

@@ -0,0 +1,75 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# and Huba Nagy
+# 
+# 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_relative 'nested'
+
+require 'set'
+
+module Async
+	module Redis
+		module Context
+			class Subscribe < Nested
+				def initialize(pool, channels)
+					super(pool)
+					
+					@channels = channels
+					
+					subscribe(channels)
+				end
+				
+				def listen
+					return @connection.read_response
+				end
+				
+				private
+				
+				def subscribe(channels)
+					@connection.write_request ['SUBSCRIBE', *channels]
+					
+					response = nil
+					
+					channels.length.times do |i|
+						response = @connection.read_response
+					end
+					
+					return response
+				end
+				
+				def unsubscribe(*channels)
+					if channels.empty? # unsubscribe from everything if no specific channels are given
+						@connection.write_request ['UNSUBSCRIBE']
+						
+						response = nil
+						
+						@channels.length.times do |i|
+							response = @connection.read_response
+						end
+						
+						return response
+					else
+						@channels.subtract(channels)
+						return send_command 'UNSUBSCRIBE', *channels
+					end
+				end
+			end
+		end
+	end
+end

data/lib/async/redis/pool.rb

@@ -18,6 +18,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'async/notification'
+
 module Async
 	module Redis
 		# It might make sense to add support for pipelining https://redis.io/topics/pipelining
@@ -25,16 +27,24 @@ module Async
 		# The only problem would be blocking operations. It might also be confusing if order of operations affects commands.
 		class Pool
 			def initialize(limit = nil, &block)
-				@available = []
-				@waiting = []
+				@resources = []
+				@available = Async::Notification.new
 				
 				@limit = limit
+				@active = 0
 				
 				@constructor = block
 			end
 			
+			
+			attr :resources
+			
+			def empty?
+				@resources.empty?
+			end
+			
 			def acquire
-				resource = wait_for_next_available
+				resource = wait_for_resource
 				
 				return resource unless block_given?
 				
@@ -45,50 +55,77 @@ module Async
 				end
 			end
 			
-			# Make the resource available and let waiting tasks know that there is something available.
+			# Make the resource resources and let waiting tasks know that there is something resources.
 			def release(resource)
-				@available << resource
-					
-				if task = @waiting.pop
-					task.resume
+				# A resource that is not good should also not be reusable.
+				unless resource.closed?
+					reuse(resource)
+				else
+					retire(resource)
 				end
 			end
 			
 			def close
-				@available.each(&:close)
-				@available.clear
+				@resources.each(&:close)
+				@resources.clear
+				
+				@active = 0
+			end
+			
+			def to_s
+				"\#<#{self.class} resources=#{resources.count} limit=#{@limit}>"
 			end
 			
 			protected
 			
-			def wait_for_next_available
-				until resource = next_available
-					@waiting << Fiber.current
-					Task.yield
-				end
+			def reuse(resource)
+				Async.logger.debug(self) {"Reuse #{resource}"}
 				
-				return resource
+				@resources << resource
+				
+				@available.signal
 			end
 			
-			def create_resource
-				begin
-					# This might fail, which is okay :)
-					resource = @constructor.call
-				rescue StandardError
-					Async.logger.error "#{$!}: #{$!.backtrace}"
-					return nil
+			def retire(resource)
+				Async.logger.debug(self) {"Retire #{resource}"}
+				
+				@active -= 1
+				
+				resource.close
+				
+				@available.signal
+			end
+			
+			def wait_for_resource
+				# If we fail to create a resource (below), we will end up waiting for one to become resources.
+				until resource = available_resource
+					@available.wait
 				end
 				
+				Async.logger.debug(self) {"Wait for resource #{resource}"}
+				
 				return resource
 			end
 			
-			def next_available
-				if @available.any?
-					@available.pop
-				elsif !@limit or @available.count < @limit
-					Async.logger.debug(self) {"No available resources, allocating new one..."}
-					create_resource
+			def create
+				# This might return nil, which means creating the resource failed.
+				return @constructor.call
+			end
+			
+			def available_resource
+				if @resources.any?
+					return @resources.pop
+				end
+				
+				if !@limit or @active < @limit
+					Async.logger.debug(self) {"No resources resources, allocating new one..."}
+					
+					@active += 1
+					
+					return create
 				end
+				
+				return nil
 			end
 		end
 	end

data/lib/async/redis/protocol/resp.rb

@@ -1,4 +1,4 @@
-# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 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
@@ -37,6 +37,10 @@ module Async
 					super(stream, CRLF)
 				end
 				
+				def closed?
+					@stream.closed?
+				end
+				
 				# The redis server doesn't want actual objects (e.g. integers) but only bulk strings. So, we inline it for performance.
 				def write_request(arguments)
 					write_lines("*#{arguments.count}")
@@ -77,7 +81,6 @@ module Async
 				
 				def read_object
 					token = @stream.read(1)
-					# puts "token: #{token}"
 					
 					case token
 					when '$'
@@ -87,7 +90,8 @@ module Async
 							return nil
 						else
 							buffer = @stream.read(length)
-							read_line # Eat trailing whitespace?
+							# Eat trailing whitespace because length does not include the CRLF:
+							read_line
 						
 							return buffer
 						end
@@ -106,6 +110,8 @@ module Async
 						return read_line
 					
 					else
+						@stream.flush
+						
 						raise NotImplementedError, "Implementation for token #{token} missing"
 					end
 				end

data/lib/async/redis/version.rb

@@ -1,4 +1,4 @@
-# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 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
@@ -20,6 +20,6 @@
 
 module Async
 	module Redis
-		VERSION = "0.1.0"
+		VERSION = "0.2.0"
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-redis
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-23 00:00:00.000000000 Z
+date: 2018-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: async-io
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 1.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 1.10.0
 - !ruby/object:Gem::Dependency
   name: async-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -103,6 +103,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -112,6 +113,9 @@ files:
 - async-redis.gemspec
 - lib/async/redis.rb
 - lib/async/redis/client.rb
+- lib/async/redis/context/multi.rb
+- lib/async/redis/context/nested.rb
+- lib/async/redis/context/subscribe.rb
 - lib/async/redis/pool.rb
 - lib/async/redis/protocol/resp.rb
 - lib/async/redis/version.rb
@@ -134,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: A Redis client library.