Creating less tables.

Added changelog.
More tests.

Author: ReFreezed

Changelog.txt

@@ -0,0 +1,27 @@
+Changelog
+LuaHotLoader
+
+v1.3 (2022-07-19)
+- Added functions: monitor(), isAllowingExternalPaths().
+- Now normalizing paths and file extensions.
+- Module loading is more robust in very rare cases.
+- Fixed reloaded modules not getting loaded in protected mode like they should have.
+- Fixed required modules not getting their name as an argument.
+- Fixed %% in the log format resulting in %% getting printed too.
+- Fixed files innocently sometimes being treated as text files.
+- Fixed some incorrect documentation.
+- LÖVE: Using a more efficient way of monitoring files in Windows using WinAPI.
+- LÖVE: Updated list of automatically added loaders.
+
+v1.2 (2019-09-06)
+- Added functions: resetCheckingState, setLogFormat/getLogFormat.
+- LÖVE: Fixed error when both love.graphics and love.audio weren't loaded.
+
+v1.1 (2019-03-06)
+- Added functions: hasLoaded, hasRequired.
+
+v1.0.1 (2018-10-09)
+- Fixed warning in LÖVE 11.
+
+v1.0 (2018-10-08)
+- Initial release!

hotLoader.lua

@@ -239,12 +239,13 @@ local isLovePath
 
 
 
-local love_getFileInfo = love and love.filesystem.getInfo
+local love_getFileInfo      = love and love.filesystem.getInfo
+local love_getFileInfo_info = {}
 
 local function fileExists(path)
 	if isLovePath(path) then
 		if love_getFileInfo then
-			return (love_getFileInfo(path, "file") ~= nil)
+			return (love_getFileInfo(path, "file", love_getFileInfo_info) ~= nil)
 		else
 			return love.filesystem.exists(path)
 		end
@@ -347,7 +348,7 @@ local getLastModifiedTime
 		if isLovePath(path) then
 			if love_getFileInfo then
 				-- LÖVE 11.0+
-				local info = love_getFileInfo(path, "file")
+				local info = love_getFileInfo(path, "file", love_getFileInfo_info)
 				local time = info and info.modtime
 				if time then  return time  end
 
@@ -1025,7 +1026,7 @@ end
 
 -- hotLoader.removeAllLoaders( )
 function hotLoader.removeAllLoaders()
-	loaders = {}
+	if next(loaders) then  loaders = {}  end
 end
 
 -- loader|nil = hotLoader.getCustomLoader( path )
@@ -1052,7 +1053,7 @@ end
 
 -- hotLoader.removeAllCustomLoaders( )
 function hotLoader.removeAllCustomLoaders()
-	customLoaders = {}
+	if next(customLoaders) then  customLoaders = {}  end
 end
 
 -- loader|nil = hotLoader.getDefaultLoader( )
@@ -1192,7 +1193,7 @@ function hotLoader.monitor(path, cbData, cb)
 	if callWithData then
 		assertarg(3, "onFileModified", cb, "function")
 	else
-		cbData, cb = nil, cbData
+		cb = cbData
 		assertarg(2, "onFileModified", cb, "function")
 	end
 

tests/main.lua

@@ -9,8 +9,8 @@ io.stdout:setvbuf("no")
 io.stderr:setvbuf("no")
 
 -- Monkeypatch modules before loading library.
-local lfs         = not love and require"lfs"
-local fakeModTime = 1
+local lfs          = not love and require"lfs"
+local fakeModTimes = {}
 
 local function pack(...)
 	return {n=select("#", ...), ...}
@@ -24,26 +24,26 @@ if love then
 			local info, err = _getInfo(path, ...)
 			if not info then  return nil, err  end
 
-			info.modtime = fakeModTime
+			info.modtime = fakeModTimes[path] or 1
 			return info
 		end
 
 	else
 		local _getLastModified = love.filesystem.getLastModified
 		local _exists          = love.filesystem.exists
 
-		function love.filesystem.getLastModified(path)  return fakeModTime  end
-		function love.filesystem.exists         (path)  return true         end
+		function love.filesystem.getLastModified(path)  return fakeModTimes[path] or 1  end
+		function love.filesystem.exists         (path)  return true                     end
 	end
 
 else
 	local _attributes = lfs.attributes
 
 	function lfs.attributes(path, requestNameOrResultTable)
-		if requestNameOrResultTable == "modification" then  return fakeModTime  end
+		if requestNameOrResultTable == "modification" then  return fakeModTimes[path] or 1  end
 
 		local values = pack(_attributes(path, requestNameOrResultTable))
-		if type(values[1]) == "table" then  values[1].modification = fakeModTime  end
+		if type(values[1]) == "table" then  values[1].modification = fakeModTimes[path] or 1  end
 
 		return unpack(values, 1, values.n)
 	end
@@ -87,37 +87,73 @@ do
 	local hotLoader = newHotLoader()
 
 	-- Load file (with a custom loader).
-	local path  = (love and "" or thisDir) .. "test.txt"
-	local loads = 0
+	local path1         = (love and "" or thisDir) .. "test1.txt"
+	local loads         = 0
+	fakeModTimes[path1] = 1
 
-	local text = hotLoader.load(path, function(path)
+	local text = hotLoader.load(path1, function(path)
 		loads = loads + 1
 		return readFile(path)
 	end)
-	assert(hotLoader.hasLoaded(path))
+	assert(hotLoader.hasLoaded(path1))
 	assert(loads == 1) -- The custom loader should've been used.
-	assert(text == "foobar")
-	assert(hotLoader.load(path) == "foobar")
+	assert(text == "foobar1")
+	assert(hotLoader.load(path1) == "foobar1")
 	assert(loads == 1) -- The file shouldn't have loaded again.
 
 	-- Reload file.
-	hotLoader.unload(path)
-	assert(not hotLoader.hasLoaded(path))
-	hotLoader.unload(path) -- Should do nothing.
-	hotLoader.load(path)
-	assert(hotLoader.hasLoaded(path))
+	hotLoader.unload(path1)
+	assert(not hotLoader.hasLoaded(path1))
+	hotLoader.unload(path1) -- Should do nothing.
+	hotLoader.load(path1)
+	assert(hotLoader.hasLoaded(path1))
 	assert(loads == 2)
 
 	-- Run updates for a couple of seconds.
 	for i = 1, 10 do  hotLoader.update(.2)  end
 	assert(loads == 2) -- Nothing should've happened.
 
 	-- Update the file.
-	fakeModTime = fakeModTime + 1
+	fakeModTimes[path1] = fakeModTimes[path1] + 1
 
 	-- Run updates for a couple of seconds.
+	print("Should reload.")
 	for i = 1, 10 do  hotLoader.update(.2)  end
 	assert(loads == 3) -- The file should've reloaded.
+
+	-- Monitor the file (which replaces the custom loader).
+	local path2         = (love and "" or thisDir) .. "test2.txt"
+	local monitors      = 0
+	fakeModTimes[path2] = 1
+	hotLoader.monitor(path2, function(path, ...)
+		monitors = monitors + 1
+		assert(select("#", ...) == 0)
+	end)
+	assert(monitors == 0)
+
+	-- Run updates for a couple of seconds.
+	for i = 1, 10 do  hotLoader.update(.2)  end
+	assert(monitors == 0)
+
+	-- Update the file.
+	fakeModTimes[path2] = fakeModTimes[path2] + 1
+
+	-- Run updates for a couple of seconds.
+	print("Should reload.")
+	for i = 1, 10 do  hotLoader.update(.2)  end
+	assert(monitors == 1)
+	assert(loads    == 3) -- Make sure the previous file didn't reload.
+
+	-- Monitor with data.
+	hotLoader.monitor(path2, "testdata", function(path, data)
+		monitors = monitors + 1
+		assert(data == "testdata")
+	end)
+	assert(monitors == 1)
+	fakeModTimes[path2] = fakeModTimes[path2] + 1
+	print("Should reload.")
+	for i = 1, 10 do  hotLoader.update(.2)  end
+	assert(monitors == 2)
 end
 
 --
@@ -132,8 +168,10 @@ do
 	end
 
 	-- Require file.
-	local moduleName = "test"
-	_G.requires = 0
+	local moduleName         = "test"
+	local modulePath         = (love and "" or thisDir) .. "test.lua"
+	fakeModTimes[modulePath] = 1
+	_G.requires              = 0
 	assert(not hotLoader.hasRequired(moduleName))
 	assert(hotLoader.require(moduleName) == "foobar")
 	assert(hotLoader.hasRequired(moduleName))
@@ -154,9 +192,10 @@ do
 	assert(requires == 2) -- Nothing should've happened.
 
 	-- Update the file.
-	fakeModTime = fakeModTime + 1
+	fakeModTimes[modulePath] = fakeModTimes[modulePath] + 1
 
 	-- Run updates for a couple of seconds.
+	print("Should reload.")
 	for i = 1, 10 do  hotLoader.update(.2)  end
 	assert(requires == 3) -- The file should've reloaded.
 

tests/test.txt

@@ -0,0 +1 @@
+foobar1

tests/test1.txt

@@ -0,0 +1 @@
+foobar2