protocol-redis 0.2.0 → 0.3.0

data/lib/protocol/redis/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -20,6 +22,6 @@
 
 module Protocol
 	module Redis
-		VERSION = "0.2.0"
+		VERSION = "0.3.0"
 	end
 end

data/protocol-redis.gemspec

@@ -17,8 +17,10 @@ Gem::Specification.new do |spec|
 	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
 	spec.require_paths = ["lib"]
 	
+	spec.add_development_dependency "async-http"
+	spec.add_development_dependency "trenni"
 	spec.add_development_dependency "benchmark-ips"
-
+	
 	spec.add_development_dependency "covered"
 	spec.add_development_dependency "bundler"
 	spec.add_development_dependency "rspec", "~> 3.6"

data/tasks/generate.rake

@@ -0,0 +1,172 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2018, by 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 'async'
+
+namespace :generate do
+	def fetch_commands
+		Async do
+			internet = Async::HTTP::Internet.new
+			
+			response = internet.get("https://raw.githubusercontent.com/antirez/redis-doc/master/commands.json")
+			
+			JSON.parse(response.read, symbolize_names: true)
+		ensure
+			internet&.close
+		end.wait
+	end
+	
+	def normalize(sentence)
+		return nil if sentence.nil?
+		
+		sentence = sentence.strip
+		
+		if sentence.end_with?(".")
+			return sentence
+		else
+			return "#{sentence}."
+		end
+	end
+	
+	def module_name(group)
+		group.split('_').collect(&:capitalize).join
+	end
+	
+	task :commands do
+		require 'async/http/internet'
+		require 'json'
+		
+		@commands = fetch_commands
+		
+		@commands.each do |command, command_spec|
+			method_name = command.to_s.downcase.split(/[\s\-_]+/).join('_')
+			command_spec[:method_name] = method_name
+		end
+		
+		# There is a bit of a discrepancy between how the groups appear in the JSON and how they appear in the compiled documentation, this is a mapping from `commands.json` to documentation:
+		@groups = {
+			'generic' => 'generic',
+			'string' => 'strings',
+			'list' => 'lists',
+			'set' => 'sets',
+			'sorted_set' => 'sorted_sets',
+			'hash' => 'hashes',
+			'connection' => 'connection',
+			'server' => 'server',
+			'scripting' => 'scripting',
+			'hyperloglog' => 'counting',
+			'cluster' => 'cluster',
+			'geo' => 'geospatial',
+			'stream' => 'streams'
+		}.freeze
+	end
+	
+	task :methods => :commands do
+		require 'trenni/template'
+		
+		template = Trenni::Template.load_file(File.expand_path("methods.trenni", __dir__))
+		
+		@groups.each_pair do |spec_group, group|
+			puts "Processing #{spec_group}..."
+			
+			path = "lib/protocol/redis/methods/#{group}.rb"
+			
+			if File.exist?(path)
+				puts "File already exists #{path}, skipping!"
+				next
+			end
+			
+			group_commands = @commands.select do |command, command_spec|
+				command_spec[:group] == spec_group
+			end
+			
+			output = template.to_string({
+				module_name: module_name(group),
+				group_commands: group_commands,
+			})
+			
+			File.write(path, output)
+			
+			break
+		end
+	end
+	
+	task :documentation => :commands do
+		@groups.each_pair do |spec_group, group|
+			puts "Processing #{spec_group}..."
+			
+			path = "lib/protocol/redis/methods/#{group}.rb"
+			
+			unless File.exist?(path)
+				puts "Could not find #{path}, skipping!"
+				next
+			end
+			
+			lines = File.readlines(path)
+			
+			group_commands = @commands.select do |command, command_spec|
+				command_spec[:group] == spec_group
+			end
+			
+			puts "\tFound #{group_commands.length} commands in this group."
+			
+			group_commands.each do |command, command_spec|
+				puts "\tProcessing #{command}..."
+				
+				if offset = lines.find_index{|line| line.include?("def #{command_spec[:method_name]}")}
+					puts "Found #{command} at line #{offset}."
+					
+					/(?<indentation>\s+)def/ =~ lines[offset]
+					
+					start = offset
+					while true
+						break unless lines[start-1] =~ /\s+#(.*?)\n/
+						start -= 1
+					end
+					
+					# Remove the comments:
+					lines.slice!(start...offset)
+					
+					summary = [
+						normalize(command_spec[:summary]),
+						normalize(command_spec[:complexity])
+					].compact
+					
+					comments = [
+						summary.join(' '),
+						"@see https://redis.io/commands/#{command.to_s.downcase}"
+					]
+					
+					command_spec[:arguments]&.each do |argument|
+						next if argument[:command] or argument[:type].nil? or argument[:type].is_a?(Array)
+						comments << "@param #{argument[:name]} [#{argument[:type].capitalize}]"
+					end
+					
+					lines.insert(start, comments.map{|comment| "#{indentation}\# #{comment}\n"})
+				else
+					puts "Could not find #{command} definition!"
+				end
+			end
+			
+			File.write(path, lines.join)
+		end
+	end
+end

data/tasks/methods.trenni

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# 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.
+
+module Protocol
+	module Redis
+		module Methods
+			module #{self[:module_name]}
+<?r
+			first = true
+			self[:group_commands].each do |command, command_spec|
+				method_name = command.to_s.downcase.split(/[\s\-_]+/).join('_')
+				
+				unless first
+?>
+				
+<?r			end ?>
+				def #{method_name}(*arguments)
+					call(#{command.to_s.dump}, *arguments)
+				end
+<?r
+				first = false
+			end
+?>
+			end
+		end
+	end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-redis
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -9,8 +9,36 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-16 00:00:00.000000000 Z
+date: 2019-12-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: async-http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: trenni
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
@@ -100,13 +128,18 @@ files:
 - lib/protocol/redis/connection.rb
 - lib/protocol/redis/error.rb
 - lib/protocol/redis/methods.rb
+- lib/protocol/redis/methods/connection.rb
+- lib/protocol/redis/methods/counting.rb
+- lib/protocol/redis/methods/generic.rb
+- lib/protocol/redis/methods/geospatial.rb
 - lib/protocol/redis/methods/hashes.rb
-- lib/protocol/redis/methods/keys.rb
 - lib/protocol/redis/methods/lists.rb
 - lib/protocol/redis/methods/server.rb
 - lib/protocol/redis/methods/strings.rb
 - lib/protocol/redis/version.rb
 - protocol-redis.gemspec
+- tasks/generate.rake
+- tasks/methods.trenni
 homepage: https://github.com/socketry/protocol-redis
 licenses: []
 metadata: {}
@@ -125,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: A RESP protocol client/server parser.

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

@@ -1,140 +0,0 @@
-# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# Copyright, 2018, by 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 'date'
-
-module Protocol
-	module Redis
-		module Methods
-			module Keys
-				def del(key, *keys)
-					return call('DEL', key, *keys)
-				end
-				
-				def dump(key)
-					return call('DUMP', key)
-				end
-				
-				def exists(key, *keys)
-					return call('EXISTS', key, *keys)
-				end
-				
-				def expire(key, seconds)
-					return call('EXPIRE', key, seconds)
-				end
-				
-				def expireat(key, time)
-					case time
-					when DateTime, Time, Date 
-						timestamp =  time.strftime('%s').to_i
-					else
-						timestamp = time
-					end
-					
-					return call('EXPIREAT', key, timestamp)
-				end
-				
-				def keys(pattern)
-					return call('KEYS', pattern)
-				end
-				
-				def migrate
-					
-				end
-				
-				def move(key, db)
-					return call('MOVE', key, db)
-				end
-				
-				def object
-					
-				end
-				
-				def persist(key)
-					return call('PERSIST', key)
-				end
-				
-				def pexpire(key, milliseconds)
-					return call('PEXPIRE', milliseconds)
-				end
-				
-				def pexpireat(key, time)
-					case time.class
-					when DateTime, Time, Date 
-						timestamp =  time.strftime('%Q').to_i
-					else
-						timestamp = time
-					end
-					
-					return call('PEXPIREAT', key, timestamp)
-				end
-				
-				def pttl(key)
-					return call('PTTL', key)
-				end
-				
-				def randomkey
-					return call('RANDOMKEY')
-				end
-				
-				def rename(key, new_key)
-					return call('RENAME', key, new_key)
-				end
-				
-				def renamenx(key, new_key)
-					return call('RENAMENX', key, new_key)
-				end
-				
-				def restore(key, serialized_value, ttl=0)
-					return call('RESTORE', key, ttl, serialized_value)
-				end
-				
-				def sort
-					
-				end
-				
-				def touch(key, *keys)
-					return call('TOUCH', key, *keys)
-				end
-				
-				def ttl(key)
-					return call('TTL', key)
-				end
-				
-				def type(key)
-					return call('TYPE', key)
-				end
-				
-				def unlink(key)
-					return call('UNLINK', key)
-				end
-					
-				def wait(newreplicas, timeout)
-					
-				end
-				
-				def scan
-					
-				end
-			end
-		end
-	end
-end