@quenty/counter 1.0.1-canary.417.052e8ba.0

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 1.0.1-canary.417.052e8ba.0 (2023-10-11)
+
+
+### Bug Fixes
+
+* Add cleanup ([4d4be82](https://github.com/Quenty/NevermoreEngine/commit/4d4be825a9ba20ade8c7d0f4eea4c0029bbbb881))
+
+
+### Features
+
+* Add Counter package ([0bb0d7c](https://github.com/Quenty/NevermoreEngine/commit/0bb0d7c891e46d588f4a4b180aa2ee2f9eed987c))

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,23 @@
+## Counter
+
+<div align="center">
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
+  </a>
+  <a href="https://discord.gg/mhtGUS8">
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
+  </a>
+  <a href="https://github.com/Quenty/NevermoreEngine/actions">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
+  </a>
+</div>
+
+Helps count a total value
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/CounterUtils">View docs →</a></div>
+
+## Installation
+
+```
+npm install @quenty/counter --save
+```

package/default.project.json

@@ -0,0 +1,6 @@
+{
+  "name": "counter",
+  "tree": {
+    "$path": "src"
+  }
+}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@quenty/counter",
+  "version": "1.0.1-canary.417.052e8ba.0",
+  "description": "Helps count a total value",
+  "keywords": [
+    "Roblox",
+    "Nevermore",
+    "Lua",
+    "counter"
+  ],
+  "bugs": {
+    "url": "https://github.com/Quenty/NevermoreEngine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Quenty/NevermoreEngine.git",
+    "directory": "src/counter/"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/quenty"
+  },
+  "license": "MIT",
+  "contributors": [
+    "Quenty"
+  ],
+  "dependencies": {
+    "@quenty/loader": "6.3.1-canary.417.052e8ba.0",
+    "@quenty/maid": "2.6.0",
+    "@quenty/rx": "7.16.1-canary.417.052e8ba.0",
+    "@quenty/valueobject": "7.24.1-canary.417.052e8ba.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "052e8ba33437f71398c4c08c8dbcbf076022d388"
+}

package/src/Shared/Counter.lua

@@ -0,0 +1,105 @@
+--[=[
+	@class Counter
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local BaseObject = require("BaseObject")
+local Maid = require("Maid")
+local Observable = require("Observable")
+local ValueObject = require("ValueObject")
+
+local Counter = setmetatable({}, BaseObject)
+Counter.ClassName = "Counter"
+Counter.__index = Counter
+
+--[=[
+	Creates a new counter
+
+	@return Counter
+]=]
+function Counter.new()
+	local self = setmetatable(BaseObject.new(), Counter)
+
+	self._count = self._maid:Add(ValueObject.new(0, "number"))
+
+	self.Changed = assert(self._count.Changed, "Bad .Changed")
+
+	return self
+end
+
+
+--[=[
+	Returns the current count
+
+	@return number
+]=]
+function Counter:GetValue()
+	return self._count.Value
+end
+
+--[=[
+	Observes the current count
+
+	@return number
+]=]
+function Counter:Observe()
+	return self._count:Observe()
+end
+
+
+--[=[
+	Adds an amount to the counter.
+
+	@param amount number | Observable<number>
+	@return MaidTask
+]=]
+function Counter:Add(amount)
+	if type(amount) == "number" then
+		self._count.Value = self._count.Value + amount
+
+		return function()
+			self._count.Value = self._count.Value - amount
+		end
+	elseif Observable.isObservable(amount) then
+		return self:_addObservable(amount)
+	else
+		error("Bad amount")
+	end
+end
+
+function Counter:_addObservable(observeAmount)
+	assert(Observable.isObservable(observeAmount), "Bad observeAmount")
+
+	local lastCount = 0
+
+	local maid = Maid.new()
+	maid:GiveTask(observeAmount:Subscribe(function(count)
+		assert(type(count) == "number", "Bad count")
+		local delta = count - lastCount
+		lastCount = count
+
+		self._count.Value = self._count.Value + delta
+	end))
+
+	maid:GiveTask(function()
+		if not self._count.Destroy then
+			return
+		end
+
+		local delta = lastCount
+		lastCount = 0
+		self._count.Value = self._count.Value - delta
+	end)
+
+	self._maid[maid] = maid
+	maid:GiveTask(function()
+		self._maid[maid] = nil
+	end)
+
+	return function()
+		self._maid[maid] = nil
+	end
+end
+
+return Counter

package/src/node_modules.project.json

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

package/test/default.project.json

@@ -0,0 +1,11 @@
+{
+  "name": "CounterTest",
+  "tree": {
+    "$className": "DataModel",
+    "ServerScriptService": {
+      "counter": {
+        "$path": ".."
+      }
+    }
+  }
+}