storagemanager, mod_storage_sql: Rename methods to :get_all() and :delete_all()
authorMatthew Wild <mwild1@gmail.com>
Wed, 11 Mar 2020 16:32:41 +0000
changeset 10684 19692fc5c106
parent 10683 b50b1eae711c
child 10687 2f0b7f1d5e75
storagemanager, mod_storage_sql: Rename methods to :get_all() and :delete_all()
core/storagemanager.lua
plugins/mod_storage_sql.lua
spec/core_storagemanager_spec.lua
--- a/core/storagemanager.lua	Wed Mar 11 16:29:57 2020 +0000
+++ b/core/storagemanager.lua	Wed Mar 11 16:32:41 2020 +0000
@@ -167,9 +167,9 @@
 			return self.keyval_store:set(username, current);
 		end;
 		remove = {};
-		find_key = function (self, key)
+		get_all = function (self, key)
 			if type(key) ~= "string" or key == "" then
-				return nil, "find_key only supports non-empty string keys";
+				return nil, "get_all only supports non-empty string keys";
 			end
 			local ret;
 			for username in self.keyval_store:users() do
@@ -183,9 +183,9 @@
 			end
 			return ret;
 		end;
-		delete_key = function (self, key)
+		delete_all = function (self, key)
 			if type(key) ~= "string" or key == "" then
-				return nil, "delete_key only supports non-empty string keys";
+				return nil, "delete_all only supports non-empty string keys";
 			end
 			local data = { [key] = self.remove };
 			local last_err;
--- a/plugins/mod_storage_sql.lua	Wed Mar 11 16:29:57 2020 +0000
+++ b/plugins/mod_storage_sql.lua	Wed Mar 11 16:32:41 2020 +0000
@@ -230,9 +230,9 @@
 	return result;
 end
 
-function map_store:find_key(key)
+function map_store:get_all(key)
 	if type(key) ~= "string" or key == "" then
-		return nil, "find_key only supports non-empty string keys";
+		return nil, "get_all only supports non-empty string keys";
 	end
 	local ok, result = engine:transaction(function()
 		local query = [[
@@ -258,9 +258,9 @@
 	return result;
 end
 
-function map_store:delete_key(key)
+function map_store:delete_all(key)
 	if type(key) ~= "string" or key == "" then
-		return nil, "delete_key only supports non-empty string keys";
+		return nil, "delete_all only supports non-empty string keys";
 	end
 	local ok, result = engine:transaction(function()
 		local delete_sql = [[
--- a/spec/core_storagemanager_spec.lua	Wed Mar 11 16:29:57 2020 +0000
+++ b/spec/core_storagemanager_spec.lua	Wed Mar 11 16:32:41 2020 +0000
@@ -114,47 +114,47 @@
 				end);
 
 				it("may find all users with a specific key", function ()
-					assert.is_function(store.find_key);
+					assert.is_function(store.get_all);
 					assert(store:set("user9999b", "bar", "bar"));
 					assert(store:set("user9999c", "foo", "blah"));
-					local ret, err = store:find_key("foo");
+					local ret, err = store:get_all("foo");
 					assert.is_nil(err);
 					assert.same({ user9999 = "bar", user9999c = "blah" }, ret);
 				end);
 
-				it("rejects empty or non-string keys to find_key", function ()
-					assert.is_function(store.find_key);
+				it("rejects empty or non-string keys to get_all", function ()
+					assert.is_function(store.get_all);
 					do
-						local ret, err = store:find_key("");
+						local ret, err = store:get_all("");
 						assert.is_nil(ret);
 						assert.is_not_nil(err);
 					end
 					do
-						local ret, err = store:find_key(true);
+						local ret, err = store:get_all(true);
 						assert.is_nil(ret);
 						assert.is_not_nil(err);
 					end
 				end);
 
-				it("rejects empty or non-string keys to delete_key", function ()
-					assert.is_function(store.delete_key);
+				it("rejects empty or non-string keys to delete_all", function ()
+					assert.is_function(store.delete_all);
 					do
-						local ret, err = store:delete_key("");
+						local ret, err = store:delete_all("");
 						assert.is_nil(ret);
 						assert.is_not_nil(err);
 					end
 					do
-						local ret, err = store:delete_key(true);
+						local ret, err = store:delete_all(true);
 						assert.is_nil(ret);
 						assert.is_not_nil(err);
 					end
 				end);
 
 				it("may delete all instances of a specific key", function ()
-					assert.is_function(store.delete_key);
+					assert.is_function(store.delete_all);
 					assert(store:set("user9999b", "foo", "hello"));
 
-					assert(store:delete_key("bar"));
+					assert(store:delete_all("bar"));
 					-- Ensure key was deleted
 					do
 						local ret, err = store:get("user9999b", "bar");