protocol-redis 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a084564c0d497c0d149ff2cb4f4109bed1f3e4d59047f629d3a8d38b0fde138
-  data.tar.gz: 3d3d67b0116b6fba2a1a74f7e3fa23a21a09cb323297ae8891eb16a3613bc4fd
+  metadata.gz: e9a0af74e1d169a5d9f8b712a1211deb9c2ab510c969043073e685b5a4d4a99a
+  data.tar.gz: 7961d5412651f7969160e5b3844be5ab7db064b5b1f2ff6833ca17e12cc42233
 SHA512:
-  metadata.gz: b03f2f6095191cdee5868f7f123c04c9689667f012fca8688f544e21f734a2ab5f3ff4f10fca868085155feed8e38b7a7d97592b32e1aae3b7957d02bfdd7215
-  data.tar.gz: bf21d0676ba2fac7f4152a0a24bb323bc057e8c201ab5174a0c3db641c0664913f546a658cb227ee3758a8df842d9122eddfe91c49cab5a5fc494eff0d19dae6
+  metadata.gz: 6fdf6ab96249d724ea77949cd073cb581f8ad58b96e3d54058e5f2e466ae2de7a947f327b44367a38d65939c2b8d8ed7a72f3e24a408f15871d25c35e45f271a
+  data.tar.gz: 27ca946edfed62633623d6876a04cdd36da92b95fbf0e21d5086b493580b1988d4d1a68e9f3ff1f99c1e9da4bc71b812688941b10d799c6dd6060a107c24427a

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in async-io.gemspec

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/benchmark/call.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Copyright, 2020, 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 'benchmark/ips'
+
+GC.disable
+
+def call(*arguments)
+	arguments.size
+end
+
+Benchmark.ips do |benchmark|
+	benchmark.time = 5
+	benchmark.warmup = 1
+	
+	benchmark.report("*arguments") do |count|
+		while count > 0
+			arguments = ["foo", "bar", "baz"]
+			call(*arguments)
+			
+			count -= 1
+		end
+	end
+	
+	benchmark.report("argument, *arguments") do |count|
+		while count > 0
+			arguments = ["bar", "baz"]
+			call("foo", *arguments)
+			
+			count -= 1
+		end
+	end
+	
+	benchmark.compare!
+end

data/lib/protocol/redis/connection.rb

@@ -139,11 +139,11 @@ module Protocol
 			# because each Redis command contains several lines. Flushing once per
 			# command is more efficient because it avoids unnecessary writes to the
 			# socket.
-			def write_lines(*args)
-				if args.empty?
+			def write_lines(*arguments)
+				if arguments.empty?
 					@stream.write(CRLF)
 				else
-					args.each do |arg|
+					arguments.each do |arg|
 						@stream.write(arg)
 						@stream.write(CRLF)
 					end

data/lib/protocol/redis/methods.rb

@@ -30,6 +30,7 @@ require_relative 'methods/counting'
 require_relative 'methods/hashes'
 require_relative 'methods/lists'
 require_relative 'methods/strings'
+require_relative 'methods/sorted_sets'
 
 module Protocol
 	module Redis
@@ -44,6 +45,7 @@ module Protocol
 				
 				klass.include Methods::Hashes
 				klass.include Methods::Lists
+				klass.include Methods::SortedSets
 				klass.include Methods::Strings
 			end
 		end

data/lib/protocol/redis/methods/geospatial.rb

@@ -64,21 +64,25 @@ module Protocol
 				# @param latitude [Double]
 				# @param radius [Double]
 				# @param unit [Enum]
-				# @param withcoord [Enum]
-				# @param withdist [Enum]
-				# @param withhash [Enum]
-				def georadius(key, longitude, latitude, radius, unit = "m", withcoord: false, withdist: false, withhash: false, count: nil, store: nil, storedist: nil)
+				# @param count [Integer] Limit the number of results to at most this many.
+				# @param order [Symbol] `:ASC` Sort returned items from the nearest to the farthest, relative to the center. `:DESC` Sort returned items from the farthest to the nearest, relative to the center.
+				# @param with_coordinates [Boolean] Also return the longitude,latitude coordinates of the matching items.
+				# @param with_distance [Boolean] Also return the distance of the returned items from the specified center. The distance is returned in the same unit as the unit specified as the radius argument of the command.
+				# @param with_hash [Boolean] Also return the raw geohash-encoded sorted set score of the item, in the form of a 52 bit unsigned integer. This is only useful for low level hacks or debugging and is otherwise of little interest for the general user.
+				# @param store [Key]
+				# @param store_distance [Key]
+				def georadius(key, longitude, latitude, radius, unit = "m", with_coordinates: false, with_distance: false, with_hash: false, count: nil, order: nil, store: nil, store_distance: nil)
 					arguments = [key, longitude, latitude, radius, unit]
 					
-					if withcoord
+					if with_coordinates
 						arguments.append("WITHCOORD")
 					end
 					
-					if withdist
+					if with_distance
 						arguments.append("WITHDIST")
 					end
 					
-					if withhash
+					if with_hash
 						arguments.append("WITHHASH")
 					end
 					
@@ -86,15 +90,28 @@ module Protocol
 						arguments.append("COUNT", count)
 					end
 					
+					if order
+						arguments.append(order)
+					end
+					
+					readonly = true
+					
 					if store
 						arguments.append("STORE", store)
+						readonly = false
 					end
 					
-					if storedist
+					if store_distance
 						arguments.append("STOREDIST", storedist)
+						readonly = false
 					end
 					
-					call("GEORADIUS", *arguments)
+					# https://redis.io/commands/georadius#read-only-variants
+					if readonly
+						call("GEORADIUS_RO", *arguments)
+					else
+						call("GEORADIUS", *arguments)
+					end
 				end
 				
 				# Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a member. O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.
@@ -103,22 +120,25 @@ module Protocol
 				# @param member [String]
 				# @param radius [Double]
 				# @param unit [Enum]
-				# @param withcoord [Enum]
-				# @param withdist [Enum]
-				# @param withhash [Enum]
-				# @param order [Enum]
-				def georadiusbymember(key, member, radius, unit = "m", withcoord: false, withdist: false, withhash: false, count: nil, store: nil, storedist: nil)
+				# @param count [Integer] Limit the number of results to at most this many.
+				# @param order [Symbol] `:ASC` Sort returned items from the nearest to the farthest, relative to the center. `:DESC` Sort returned items from the farthest to the nearest, relative to the center.
+				# @param with_coordinates [Boolean] Also return the longitude,latitude coordinates of the matching items.
+				# @param with_distance [Boolean] Also return the distance of the returned items from the specified center. The distance is returned in the same unit as the unit specified as the radius argument of the command.
+				# @param with_hash [Boolean] Also return the raw geohash-encoded sorted set score of the item, in the form of a 52 bit unsigned integer. This is only useful for low level hacks or debugging and is otherwise of little interest for the general user.
+				# @param store [Key]
+				# @param store_distance [Key]
+				def georadiusbymember(key, member, radius, unit = "m", with_coordinates: false, with_distance: false, with_hash: false, count: nil, order: nil, store: nil, store_distance: nil)
 					arguments = [key, member, radius, unit]
 					
-					if withcoord
+					if with_coordinates
 						arguments.append("WITHCOORD")
 					end
 					
-					if withdist
+					if with_distance
 						arguments.append("WITHDIST")
 					end
 					
-					if withhash
+					if with_hash
 						arguments.append("WITHHASH")
 					end
 					
@@ -126,15 +146,36 @@ module Protocol
 						arguments.append("COUNT", count)
 					end
 					
+					if order
+						arguments.append(order)
+					end
+					
 					if store
 						arguments.append("STORE", store)
 					end
 					
-					if storedist
+					if store_distance
 						arguments.append("STOREDIST", storedist)
 					end
 					
-					call("GEORADIUS", *arguments)
+					readonly = true
+					
+					if store
+						arguments.append("STORE", store)
+						readonly = false
+					end
+					
+					if store_distance
+						arguments.append("STOREDIST", storedist)
+						readonly = false
+					end
+					
+					# https://redis.io/commands/georadius#read-only-variants
+					if readonly
+						call("GEORADIUSBYMEMBER_RO", *arguments)
+					else
+						call("GEORADIUSBYMEMBER", *arguments)
+					end
 				end
 			end
 		end

data/lib/protocol/redis/methods/sorted_sets.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+# Copyright, 2020, by Dimitry Chopey.
+# Copyright, 2020, 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 Protocol
+	module Redis
+		module Methods
+			module SortedSets
+				# Add one or more members to a sorted set, or update its score if it already exists. O(log(N)) for each item added, where N is the number of elements in the sorted set.
+				# @see https://redis.io/commands/zadd
+				# @param key [Key]
+				# @param score [Double]
+				# @param member [String]
+				# @param others [Array] an array of `score`, `member` elements.
+				# @param update [Boolean, nil] If true, only update elements that already exist (never add elements). If false, don't update existing elements (only add new elements).
+				# @param change [Boolean] Modify the return value from the number of new elements added,
+				#   to the total number of elements changed; changed elements are new elements added
+				#   and elements already existing for which the score was updated.
+				# @param increment [Boolean] When this option is specified ZADD acts like ZINCRBY;
+				#   only one score-element pair can be specified in this mode.
+				def zadd(key, score, member, *others, update: nil, change: false, increment: false)
+					arguments = ["ZADD", key]
+					
+					if update == true
+						arguments << "XX"
+					elsif update == false
+						arguments << "NX"
+					end
+					
+					arguments << "CH" if change
+					arguments << "INCR" if increment
+					
+					arguments << score << member
+					arguments.concat(others)
+					
+					call(*arguments)
+				end
+
+				# Return a range of members in a sorted set, by index. O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements returned.
+				# @see https://redis.io/commands/zrange
+				# @param key [Key]
+				# @param start [Integer]
+				# @param stop [Integer]
+				# @param with_scores [Boolean] Return the scores of the elements together with the elements.
+				def zrange(key, start, stop, with_scores: false)
+					arguments = [start, stop]
+					
+					arguments << "WITHSCORES" if with_scores
+					
+					call("ZRANGE", key, *arguments)
+				end
+				
+				# Remove one or more members from a sorted set. O(M*log(N)) with N being the number of elements in the sorted set and M the number of elements to be removed.
+				# @see https://redis.io/commands/zrem
+				# @param key [Key]
+				# @param member [String]
+				def zrem(key, member)
+					call("ZREM", key, member)
+				end
+			end
+		end
+	end
+end

data/lib/protocol/redis/methods/strings.rb

@@ -145,24 +145,22 @@ module Protocol
 				# @param key [Key]
 				# @param value [String]
 				# @param expiration [Enum]
-				# @param condition [Enum]
-				def set(key, value, **options)
+				# @param update [Boolean, nil] If true, only update elements that already exist (never add elements). If false, don't update existing elements (only add new elements).
+				def set(key, value, update: nil, seconds: nil, milliseconds: nil)
 					arguments = []
 
-					if options.has_key? :seconds
-						arguments << 'EX'
-						arguments << options[:seconds]
+					if seconds
+						arguments << 'EX' << seconds
 					end
 
-					if options.has_key? :milliseconds
-						arguments << 'PX'
-						arguments << options[:milliseconds]
+					if milliseconds
+						arguments << 'PX' << milliseconds
 					end
 
-					if options[:condition] == :nx
-						arguments << 'NX'
-					elsif options[:condition] == :xx
-						arguments << 'XX'
+					if update == true
+						arguments << "XX"
+					elsif update == false
+						arguments << "NX"
 					end
 
 					return call('SET', key, value, *arguments)

data/lib/protocol/redis/version.rb

@@ -22,6 +22,6 @@
 
 module Protocol
 	module Redis
-		VERSION = "0.3.1"
+		VERSION = "0.4.0"
 	end
 end

data/tasks/generate.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # Copyright, 2018, by Huba Nagy.
 # 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-redis
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-07 00:00:00.000000000 Z
+date: 2020-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http
@@ -124,6 +124,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- benchmark/call.rb
 - lib/protocol/redis.rb
 - lib/protocol/redis/connection.rb
 - lib/protocol/redis/error.rb
@@ -135,6 +136,7 @@ files:
 - lib/protocol/redis/methods/hashes.rb
 - lib/protocol/redis/methods/lists.rb
 - lib/protocol/redis/methods/server.rb
+- lib/protocol/redis/methods/sorted_sets.rb
 - lib/protocol/redis/methods/strings.rb
 - lib/protocol/redis/version.rb
 - protocol-redis.gemspec