Update loggerMiddleware to no longer require passing in an output function

Author: LPGhatguy

lib/init.lua

@@ -8,6 +8,6 @@ return {
 	Store = Store,
 	createReducer = createReducer,
 	combineReducers = combineReducers,
-	loggerMiddleware = loggerMiddleware,
+	loggerMiddleware = loggerMiddleware.middleware,
 	thunkMiddleware = thunkMiddleware,
 }

lib/loggerMiddleware.lua

@@ -1,49 +1,54 @@
-local indentStr = "    "
-
-local function prettyPrint(t, indent)
-	indent = indent or 1
-	local outputBuffer = {
-		"{\n",
-	}
-
-	for key, value in pairs(t) do
-		local strKey = tostring(key)
-
-		table.insert(outputBuffer, indentStr:rep(indent + 1))
-		table.insert(outputBuffer, strKey)
-		table.insert(outputBuffer, " = ")
-
-		if typeof(value) == "table" then
-			table.insert(outputBuffer, prettyPrint(value, indent + 1))
-			table.insert(outputBuffer, "\n")
-		else
-			table.insert(outputBuffer, tostring(value))
-			table.insert(outputBuffer, "; (")
-			table.insert(outputBuffer, typeof(value))
-			table.insert(outputBuffer, ")\n")
+local indent = "    "
+
+local function prettyPrint(value, indentLevel)
+	indentLevel = indentLevel or 0
+	local output = {}
+
+	if typeof(value) == "table" then
+		table.insert(output, "{\n")
+
+		for key, value in pairs(value) do
+			table.insert(output, indent:rep(indentLevel + 1))
+			table.insert(output, tostring(key))
+			table.insert(output, " = ")
+
+			table.insert(output, prettyPrint(value, indentLevel + 1))
+			table.insert(output, "\n")
 		end
-	end
 
-	table.insert(outputBuffer, indentStr:rep(indent))
-	table.insert(outputBuffer, "}")
+		table.insert(output, indent:rep(indentLevel))
+		table.insert(output, "}")
+	elseif typeof(value) == "string" then
+		table.insert(output, string.format("%q", value))
+		table.insert(output, " (string)")
+	else
+		table.insert(output, tostring(value))
+		table.insert(output, " (")
+		table.insert(output, typeof(value))
+		table.insert(output, ")")
+	end
 
-	return table.concat(outputBuffer, "")
+	return table.concat(output, "")
 end
 
-local function loggerMiddleware(outputFunction)
-	outputFunction = outputFunction or print
+-- We want to be able to override outputFunction in tests, so the shape of this
+-- module is kind of unconventional.
+--
+-- We fix it this weird shape in init.lua.
+local loggerMiddleware = {
+	outputFunction = print,
+}
 
-	return function(next)
-		return function(store, action)
-			local result = next(store, action)
+function loggerMiddleware.middleware(next)
+	return function(store, action)
+		local result = next(store, action)
 
-			outputFunction(("Action dispatched: %s\nState changed to: %s"):format(
-				prettyPrint(action),
-				prettyPrint(store:getState()))
-			)
+		loggerMiddleware.outputFunction(("Action dispatched: %s\nState changed to: %s"):format(
+			prettyPrint(action),
+			prettyPrint(store:getState())
+		))
 
-			return result
-		end
+		return result
 	end
 end
 

lib/loggerMiddleware.spec.lua

@@ -4,26 +4,38 @@ return function()
 
 	it("should print whenever an action is dispatched", function()
 		local outputCount = 0
+		local outputMessage
 
 		local function reducer(state, action)
 			return state
 		end
 
-		local function outputFunction()
+		local store = Store.new(reducer, {
+			fooValue = 12345,
+			barValue = {
+				bazValue = "hiBaz",
+			},
+		}, { loggerMiddleware.middleware })
+
+		loggerMiddleware.outputFunction = function(message)
 			outputCount = outputCount + 1
+			outputMessage = message
 		end
 
-		local logger = loggerMiddleware(outputFunction)
-
-		local store = Store.new(reducer, {
-			value = 0,
-			otherValue = {},
-		}, { logger })
-
 		store:dispatch({
-			type = "test",
+			type = "testActionType",
 		})
 
+		print(outputMessage)
+
 		expect(outputCount).to.equal(1)
+		expect(outputMessage:find("testActionType")).to.be.ok()
+		expect(outputMessage:find("fooValue")).to.be.ok()
+		expect(outputMessage:find("12345")).to.be.ok()
+		expect(outputMessage:find("barValue")).to.be.ok()
+		expect(outputMessage:find("bazValue")).to.be.ok()
+		expect(outputMessage:find("hiBaz")).to.be.ok()
+
+		loggerMiddleware.outputFunction = print
 	end)
 end