merge Guava 0.7.1

merge Guava 0.7.1

Author: smokingplaya

.luarc.json

@@ -24,10 +24,10 @@
     "invisible"
   ],
   "Lua.workspace.checkThirdParty": false,
-    "diagnostics.globals": [
-        "atomic",
-        "git",
-        "mysqloo",
-        "todo",
-    ]
+  "diagnostics.globals": [
+      "atomic",
+      "git",
+      "mysqloo",
+      "todo"
+  ]
 }

README.md

@@ -13,15 +13,29 @@
 Atomic is a flexible, OOP-driven framework for building Garry’s Mod addons and gamemodes with a clean, modular architecture.
 Each **package** is a self-contained unit - just like an addon - with built-in dependency management and powerful libraries for writing structured, maintainable Lua code.
 
+```lua
+local package = current()
+local libui = package:getDependency("com.developername.libui")
+
+package:listen(function(self)
+  libui:drawText(self:getPhrase("en", "hello_world"), libui.textSize.small, ScrW() / 2, ScrH()/2, color_white, TEXT_ALIGN_CENTER)
+end, "HUDPaint")
+
+package:listen(function(self)
+  self.logger:info("package successfully enabled")
+end, "onEnable")
+```
+###### Real example of addon based on Atomic
+
 ---
 
 ## Installation
 Simply place the framework in your `addons/` folder.
 Atomic will automatically load available packages.
 
 Optional dependencies:
-- For `MySQL` support → install [MySQLOO](https://github.com/FredyH/MySQLOO)
-- For `git` support → install [gm_git](https://github.com/TeamMeadows/gm_git)
+- `MySQL` support / [MySQLOO](https://github.com/FredyH/MySQLOO)
+- `git` support / [gm_git](https://github.com/TeamMeadows/gm_git)
 
 ---
 

examples/lua/atomic/packages/ping/core/client.lua

@@ -1,28 +1,55 @@
 ---@class ExamplePackagePing: Atomic.Package
 local package = current()
 
+-- Asynchronous variant
+
 --- this function will send
 --- an asynchronous network message to the server
 --- and wait for a response
-function package:ping()
+function package:pingAsync()
   local instant = Instant()
 
   async(function()
     local message = self:sendNetworkMessageAsync("Ping", {})
 
     local ms = instant:elapsed():as_millis()
 
-    package.logger:debug("Server ping took %sms", ms)
-    package.logger:debug("Server response: %s", message.content)
+    self.logger:debug("Server ping took %sms", ms)
+    self.logger:debug("Server response: %s", message.content)
   end)
 end
 
---- Removing console command
---- when package will disabled
-package:listen(function()
-  concommand.Remove("do_ping")
-end, "onDisable")
+concommand.Add("ping_async", function()
+	package:pingAsync()
+end)
+
+-- Synchronous variant
+
+---@type table<string, Atomic.Time.Instant>
+package.syncMessagesId = {}
+
+function package:ping()
+  local instant = Instant()
+
+  -- every network message have id
+  local messageId = self:sendNetworkMessage("Ping", {})
+
+  -- saving network packet sending time
+  self.syncMessagesId[messageId] = instant
+end
+
+package:onNetworkMessage(function(self, message)
+  local response = message.content
+
+  local time = self.syncMessagesId[message:getId()]
+
+  if (time) then
+    self.logger:debug("Server ping took %sms", time:elapsed():as_millis())
+  end
+
+  self.logger:debug("Server response: %s", response)
+end, "Ping")
 
-concommand.Add("do_ping", function()
-	package:ping()
+concommand.Add("ping", function()
+  package:ping()
 end)

examples/lua/atomic/packages/ping/core/shared.lua

@@ -6,4 +6,4 @@ local package = current()
 package:networkSchema("Ping")
   -- server will send to client
   -- field "content" with type of string
-  :clientField("content", "string")
+  :client("content", "string")

examples/lua/atomic/packages/ping/package.lua

@@ -1,11 +1,16 @@
 ---@type Atomic.Package.Metadata
 return {
   id = "team.meadows.example_ping",
-  title = "Example package - Ping",
+  title = "Example: Ping",
   version = "1.0.0",
   files = {
     client = { "core/client.lua" },
     shared = { "core/shared.lua" },
     server = { "core/server.lua" }
+  },
+  dependencies = {
+    shared = {
+      atomic = "~0.7.1"
+    }
   }
 }

lua/atomic/libraries/class.lua

@@ -17,12 +17,17 @@ atomic.class = atomic.class or {
 
 ---@class Atomic.Class
 ---@field init fun(self: Atomic.Class, ...: any)?
----@field private _name string?
+---@field private _classname string?
 local classMt = {}
 classMt.__index = classMt
 
 function classMt:__tostring()
-  return "class " .. tostring(self._name)
+    return "class " .. self:__classname()
+end
+
+---@return string
+function classMt:__classname()
+  return tostring(self._classname)
 end
 
 --- Creates new class
@@ -31,14 +36,10 @@ end
 ---@return Atomic.Class
 function atomic.class.create(name, parent)
   -- new class inherited from classMt or parent (if provided)
-  local class = setmetatable({ _name = name }, { __index = parent or classMt })
+  local class = setmetatable({ _classname = name }, { __index = parent or classMt })
   class.__index = class
   class.__tostring = function(self)
-    return "instance of " .. tostring(self._name)
-  end
-
-  class.__classname = function(self)
-    return name
+    return "instance of " .. tostring(self._classname)
   end
 
   return class

lua/atomic/libraries/command/class.lua

@@ -1,5 +1,6 @@
 ---@alias Atomic.Command.ArgumentKind "number" | "string" | "boolean" | "time" | "player"
----@alias Atomic.Command.ExecuteFunc fun(executor: Player, arguments: table<string, Atomic.Command.ArgumentKind>): string?
+---@alias Atomic.Command.ArgumentTypes number | string | boolean | Player
+---@alias Atomic.Command.ExecuteFunc fun(executor: Player, arguments: table<string, Atomic.Command.ArgumentTypes>): string?
 ---@alias Atomic.Command.Argument { name: string, kind: Atomic.Command.ArgumentKind, isOptional: boolean }
 
 ---@class Atomic.Command: Atomic.Class
@@ -124,4 +125,9 @@ function Command:setEnabled(b)
 	self._enabled = b
 
 	return self
+end
+
+---@return boolean
+function Command:isEnabled()
+  return self._enabled
 end

lua/atomic/libraries/git.lua

@@ -1,5 +1,5 @@
 if (not util.IsBinaryModuleInstalled("git")) then
-  return
+  return atomic.log:trace("gm_git is not installed")
 end
 
 ---@class Atomic.Git.Folder

lua/atomic/libraries/i18n.lua

@@ -125,7 +125,8 @@ end
 ---@return string
 function atomic.i18n.getPhrase(language, phraseIndex, ...)
   if (isentity(language)) then
-    language = atomic.i18n.getPlayerLanguage(player)
+    ---@diagnostic disable-next-line
+    language = atomic.i18n.getPlayerLanguage(language)
   end
 
   local langTable = atomic.i18n._storage[language]

lua/atomic/libraries/logger.lua

@@ -31,15 +31,14 @@ local function getcurrenttime()
   return os.date("%H:%M:%S")
 end
 
-local iswin = jit.os == "Windows"
-
 -- colors
-local white = iswin and Color(255, 255, 255) or "\27[37m"
-local trace = iswin and Color(128, 128, 128) or "\27[90m"
-local debug = iswin and Color(0, 255, 255) or "\27[36m"
-local info = iswin and Color(0, 255, 0) or "\27[32m"
-local warn = iswin and Color(255, 255, 0) or "\27[33m"
-local err = iswin and Color(255, 0, 0) or "\27[31m"
+-- *client game console doesn't support the ANSI escape codes
+local white = CLIENT and Color(255, 255, 255) or "\27[37m"
+local trace = CLIENT and Color(128, 128, 128) or "\27[90m"
+local debug = CLIENT and Color(0, 255, 255) or "\27[36m"
+local info = CLIENT and Color(0, 255, 0) or "\27[32m"
+local warn = CLIENT and Color(255, 255, 0) or "\27[33m"
+local err = CLIENT and Color(255, 0, 0) or "\27[31m"
 
 local levels = {
   TRACE = 1,
@@ -49,13 +48,16 @@ local levels = {
   ERR = 5,
 }
 
-local logvar = CreateConVar("atomic_log", "INFO", {FCVAR_ARCHIVE, FCVAR_PROTECTED}, "Minimum log level (INFO, DEBUG, WARN, ERR)")
+local logvar = CreateConVar("atomic_log", "INFO", {FCVAR_ARCHIVE, FCVAR_PROTECTED}, "Minimum log level (TRACE/INFO/DEBUG/WARN/ERR)")
 
 ---@param prefix string
 function Logger:init(prefix)
   self.prefix = prefix
 end
 
+-- not a magic number
+local MAX_LEVEL_LENGTH = 5
+
 ---@protected
 ---@param color Color | string
 ---@param level string
@@ -66,9 +68,11 @@ function Logger:log(color, level, message, ...)
   local currentIdx = levels[currentLevel] or 1
   local msgIdx = levels[level] or 1
 
-  if msgIdx < currentIdx then return end
+  if (msgIdx < currentIdx) then
+    return
+  end
 
-  MsgC(white, "[", getcurrenttime(), " ", color, level, " ", white, self.prefix, "]", " ", string.format(message, ...))
+  MsgC(white, "[", getcurrenttime(), " ", color, level .. (" "):rep(MAX_LEVEL_LENGTH - #level), " ", white, self.prefix, "]", " ", string.format(message, ...))
   MsgN()
 end