@quenty/textfilterutils 6.7.0 → 6.8.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [6.8.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/textfilterutils@6.7.0...@quenty/textfilterutils@6.8.0) (2023-08-01)
+
+
+### Features
+
+* Add TextFilterUtils.countFilteredCharacters() ([f156822](https://github.com/Quenty/NevermoreEngine/commit/f1568223d2da7051e24558a094ad7fe29c8a2d5e))
+
+
+
+
+
 # [6.7.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/textfilterutils@6.6.0...@quenty/textfilterutils@6.7.0) (2023-07-28)
 
 **Note:** Version bump only for package @quenty/textfilterutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/textfilterutils",
-  "version": "6.7.0",
+  "version": "6.8.0",
   "description": "Utility functions for filtering text",
   "keywords": [
     "Roblox",
@@ -31,5 +31,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "539b6bcf1266fb18e143059d08381654cca200bd"
+  "gitHead": "839b4d929e4d6154aadf719f1ecfb9add4c8b247"
 }

package/src/Shared/TextFilterUtils.lua

@@ -186,4 +186,115 @@ function TextFilterUtils.hasNonFilteredText(text: string): boolean
 	return string.find(text, "[^#%s]") ~= nil
 end
 
+local WHITESPACE = {
+	["\r"] = true;
+	["\n"] = true;
+	[" "] = true;
+	["\t"] = true;
+}
+
+--[=[
+	Computes proportional text that is filtered ignoring whitespace.
+
+	@param text string
+	@return number
+]=]
+function TextFilterUtils.getProportionFiltered(text: string)
+	local filteredChars, unfilteredChars = TextFilterUtils.countFilteredCharacters(text)
+	local total = unfilteredChars + filteredChars
+	if total == 0 then
+		return 0
+	end
+
+	return filteredChars/total
+end
+
+--[=[
+	Gets the number of filtered characters in the text string
+
+	@param text string
+	@return number -- filtered characters
+	@return number -- Unfiltered characters
+	@return number -- White space characters
+]=]
+function TextFilterUtils.countFilteredCharacters(text: string)
+	local filteredChars = 0
+	local unfilteredChars = 0
+	local whitespaceCharacters = 0
+	for i=1, #text do
+		local textChar = string.sub(text, i, i)
+		if textChar == "#" then
+			filteredChars = filteredChars + 1
+		elseif WHITESPACE[textChar] then
+			whitespaceCharacters = whitespaceCharacters + 1
+		else
+			unfilteredChars = unfilteredChars + 1
+		end
+	end
+
+	return filteredChars, unfilteredChars, whitespaceCharacters
+end
+
+
+--[=[
+	Adds in new lines and whitespace to the text
+
+	@param text string
+	@param filteredText string
+	@return number
+]=]
+function TextFilterUtils.addBackInNewLinesAndWhitespace(text, filteredText)
+	assert(type(text) == "string", "Bad text")
+	assert(type(filteredText) == "string", "Bad filteredText")
+
+	if text == filteredText then
+		return text
+	end
+
+	-- Assume that any missing characters are actually our newlines.
+	local missingCharacters = math.max(0, #text - #filteredText)
+
+	-- TODO: Not all this GC
+	local newString = ""
+	local filteredTextIndex = 1
+
+	local textIndex = 1
+	while filteredTextIndex <= #filteredText or textIndex <= #text do
+		local textChar = string.sub(text, textIndex, textIndex)
+		local filteredChar = string.sub(filteredText, filteredTextIndex, filteredTextIndex)
+
+		if textChar == "\n" then
+			if missingCharacters > 0 then
+				missingCharacters = missingCharacters - 1
+				newString = newString .. "\n"
+			else
+				newString = newString .. "\n"
+				filteredTextIndex = filteredTextIndex + 1
+			end
+		elseif textChar == " " and filteredChar == "#" then
+			newString = newString .. " "
+		elseif textChar == "\t" and filteredChar == "#" then
+			newString = newString .. "\t"
+		elseif textChar == "\r" and filteredChar == "#" then
+			newString = newString .. "\r"
+		else
+			if filteredChar == "" then
+				if missingCharacters > 0 then
+					missingCharacters = missingCharacters - 1
+					newString = newString .. "\n"
+				end
+			else
+				newString = newString .. filteredChar
+			end
+
+			filteredTextIndex = filteredTextIndex + 1
+		end
+
+		textIndex = textIndex + 1
+	end
+
+	return newString
+end
+
+
 return TextFilterUtils