@quenty/randomutils 2.2.0 → 2.3.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/randomutils@2.2.0...@quenty/randomutils@2.3.0) (2023-08-23)
+
+
+### Bug Fixes
+
+* Use table.clone() ([28f311b](https://github.com/Quenty/NevermoreEngine/commit/28f311b9c2534fa7b2056265db05c1447dc43a8a))
+
+
+### Features
+
+* Add RandomSampler object to RandomUtils ([5ca48d9](https://github.com/Quenty/NevermoreEngine/commit/5ca48d91697ee0b20ec1df8dda91a0e9f9ceb0a3))
+
+
+
+
+
 # [2.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/randomutils@2.1.1...@quenty/randomutils@2.2.0) (2022-03-27)
 
 **Note:** Version bump only for package @quenty/randomutils

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-2021 Quenty
+Copyright (c) 2014-2023 James Onnen (Quenty)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/randomutils",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Quenty's RandomUtils, utility functions for Roblox",
   "keywords": [
     "Roblox",
@@ -28,5 +28,8 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "501844bd6c3d3f765fd3032b997d8030bc963a1f"
+  "dependencies": {
+    "@quenty/loader": "^6.3.0"
+  },
+  "gitHead": "2547e660a0333034a5b20ddd6b23e343bc01f7c6"
 }

package/src/Shared/RandomSampler.lua

@@ -0,0 +1,62 @@
+--[=[
+	@class RandomSampler
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local RandomUtils = require("RandomUtils")
+
+local RandomSampler = {}
+RandomSampler.ClassName = "RandomSampler"
+RandomSampler.__index = RandomSampler
+
+function RandomSampler.new(samples)
+	local self = setmetatable({}, RandomSampler)
+
+	self._optionsList = {}
+	self._shuffledAvailableList = {}
+
+	if samples then
+		self:SetSamples(samples)
+	end
+
+	return self
+end
+
+function RandomSampler:SetSamples(samples)
+	assert(type(samples) == "table", "Bad samples")
+
+	if self._optionsList ~= samples then
+		self._optionsList = samples
+
+		-- TODO: Smarter refill
+		self:Refill()
+	end
+end
+
+function RandomSampler:Sample()
+	if #self._shuffledAvailableList == 0 then
+		self:Refill()
+	end
+
+	local selection = table.remove(self._shuffledAvailableList)
+	self._lastSelection = selection
+
+	return selection
+end
+
+function RandomSampler:Refill()
+	local newList = RandomUtils.shuffledCopy(self._optionsList)
+
+	if #newList > 1 then
+		-- prevent repeat on restart
+		if newList[#newList] == self._lastSelection then
+			newList[1], newList[#newList] = newList[#newList], newList[1]
+		end
+	end
+
+	self._shuffledAvailableList = newList
+end
+
+
+return RandomSampler

package/src/Shared/RandomUtils.lua

@@ -64,10 +64,7 @@ end
 	@return { T }
 ]=]
 function RandomUtils.shuffledCopy(list, random)
-	local copy = {}
-	for i=1, #list do
-		copy[i] = list[i]
-	end
+	local copy = table.clone(list)
 
 	RandomUtils.shuffle(copy, random)
 

package/src/node_modules.project.json

@@ -0,0 +1,7 @@
+{
+  "name": "node_modules",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$path": { "optional": "../node_modules" }
+  }
+}