merge 1.0.0-alpha.4

<3

Author: smokingplaya

.gitignore

@@ -1,4 +1,2 @@
 changelog.md
-puff.yml
-docker-compose.yml
-.env
+todo.md

.luarc.json

@@ -28,6 +28,10 @@
       "atomic",
       "git",
       "mysqloo",
-      "todo"
+      "todo",
+      "new",
+      "current",
+      "async",
+      "super"
   ]
 }

README.md

@@ -11,8 +11,8 @@
 </div>
 
 [Download]: https://github.com/TeamMeadows/atomic-framework/releases/latest
-[Getting Started]: https://github.com/TeamMeadows/atomic-framework/wiki#getting-started
-[Documentation]: https://github.com/TeamMeadows/atomic-framework/wiki
+[Getting Started]: https://deepwiki.com/TeamMeadows/atomic-framework/1.2-quick-start-guide
+[Documentation]: https://deepwiki.com/TeamMeadows/atomic-framework/
 
 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.
@@ -29,7 +29,7 @@ package:listen(function(self)
   self.logger:info("package successfully enabled")
 end, "onEnable")
 ```
-###### Real example of addon based on Atomic
+###### Example of addon based on Atomic
 
 ---
 

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

@@ -1,7 +1,7 @@
 ---@class ExamplePackagePing: Atomic.Package
 local package = current()
 
-package:onNetworkMessage(function(message)
+package:onNetworkMessage(function(self, message)
   local sender = message:getSender()
 
   sender:ChatPrint("Pong!")

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

@@ -1,16 +1,18 @@
----@type Atomic.Package.Metadata
+---@type PackageMeta
 return {
-  id = "team.meadows.example_ping",
-  title = "Example: Ping",
+  id = "org.example.ping",
+  title = "Ping",
   version = "1.0.0",
+  kind = "system",
   files = {
-    client = { "core/client.lua" },
-    shared = { "core/shared.lua" },
-    server = { "core/server.lua" }
+    dir = "core",
+    client = { "client" },
+    shared = { "shared" },
+    server = { "server" }
   },
   dependencies = {
     shared = {
-      atomic = "~0.7.1"
+      atomic = "^1.0.0-alpha.1"
     }
   }
 }

lua/atomic/libraries/class.lua

@@ -9,22 +9,25 @@ atomic.class = atomic.class or {
     _metadata = {
       id = "atomic",
       version = atomic.meta.version,
-      documentation = "https://github.com/TeamMeadows/atomic-framework/wiki",
-      icon = "https://github.com/TeamMeadows/atomic-framework/raw/production/assets/logo.png"
     }
   }
 }
 
 ---@class Atomic.Class
----@field init fun(self: Atomic.Class, ...: any)?
+---@field private __index table
+---@field private init fun(self: Atomic.Class, ...: any)?
 ---@field private _classname string?
 local classMt = {}
 classMt.__index = classMt
 
+---@alias Class Atomic.Class
+
+---@private
 function classMt:__tostring()
-    return "class " .. self:__classname()
+  return "Class " .. self:__classname()
 end
 
+---@private
 ---@return string
 function classMt:__classname()
   return tostring(self._classname)
@@ -39,7 +42,7 @@ function atomic.class.create(name, parent)
   local class = setmetatable({ _classname = name }, { __index = parent or classMt })
   class.__index = class
   class.__tostring = function(self)
-    return "instance of " .. tostring(self._classname)
+    return "Instance of " .. tostring(self._classname)
   end
 
   return class
@@ -70,7 +73,8 @@ function atomic.class.get(name, packageOrId, packageVersion)
       or type(packageVersion) == "string" and packageVersion
       or pkgName == "atomic" and atomic.meta.version
 
-  return ((atomic.class._storage[pkgName] or {})[pkgVersion] or {})[name]
+  ---@diagnostic disable-next-line
+  return ((atomic.class._storage[pkgName] or {})[istable(pkgVersion) and pkgVersion:getString() or pkgVersion] or {})[name]
 end
 
 --- Creates a new class instance
@@ -123,12 +127,19 @@ function atomic.class.accessors(class, ...)
   end
 end
 
+---@param version Atomic.SemanticVersion | string
+---@return string
+local versionToString = function(version)
+  ---@diagnostic disable-next-line
+  return isstring(version) and version or version:getString()
+end
+
 --- Registers the class in the storage, allowing it to be get via ``atomic.class.get``
 ---@param class Atomic.Class
 ---@param package Atomic.Package
 function atomic.class.register(class, package)
   local storage = atomic.class._storage
-  local id, version = package._metadata.id, package._metadata.version
+  local id, version = package._metadata.id, versionToString(package._metadata.version)
 
   if (type(storage[id]) ~= "table") then
     storage[id] = {}
@@ -143,11 +154,43 @@ function atomic.class.register(class, package)
   atomic.class._storage = storage
 end
 
+---@param class Atomic.Class
+---@param package Atomic.Package
 function atomic.class.unregister(class, package)
   local storage = atomic.class._storage
-  local id, version = package.id, package.version
+  local id, version = package._metadata.id, versionToString(package._metadata.version)
 
   storage[id][version][class._classname] = nil
 
   atomic.class._storage = storage
+end
+
+--- Returns the parent class of instance
+---@param class Atomic.Class
+---@return Atomic.Class?
+function atomic.class.getParent(class)
+  local parent = getmetatable(getmetatable(class))
+  return parent and parent.__index
+end
+
+--- Calls the `init` method in the parent class
+---
+--- # Example
+--- ```lua
+--- local Player = package:getClass("Player")
+--- local User = package:class("User", Player) -- creating new class `User` that inherits class `Player`
+---
+--- function User:init()
+---   super(self) -- calling Player:init() method
+--- end
+--- ```
+---@param instance Atomic.Class
+---@vararg ...
+function atomic.class.super(instance, ...)
+  local parent = atomic.class.getParent(instance)
+
+  assert(parent, "class has no parent")
+  assert(isfunction(parent.init), "parent class has no init method")
+
+  parent.init(instance, ...)
 end

lua/atomic/libraries/command/class.lua

@@ -31,6 +31,11 @@ function Command:getCooldown()
 	return self._cooldown
 end
 
+---@return string?
+function Command:getPermission()
+  return self._permission
+end
+
 ---@return string
 function Command:getName()
 	return self._name

lua/atomic/libraries/command/common.lua

@@ -1,4 +1,4 @@
-atomic.command = {
+atomic.command = atomic.command or {
 	logger = atomic.logger.new("command"),
 	---@type table<string, Atomic.Command>
 	_storage = {}

lua/atomic/libraries/git.lua

@@ -4,6 +4,9 @@ end
 
 ---@class Atomic.Git.Folder
 ---@field folder string
+---@field get_branch fun(self): string
+---@field get_commit_id fun(self): string
+---@field fetch fun(self): string? Error
 
 if (not git) then
   require("git")

lua/atomic/libraries/logger.lua

@@ -28,7 +28,7 @@ function atomic.logger.new(prefix)
 end
 
 local function getcurrenttime()
-  return os.date("%H:%M:%S")
+  return os.date("%X")
 end
 
 -- colors
@@ -48,7 +48,31 @@ local levels = {
   ERR = 5,
 }
 
-local logvar = CreateConVar("atomic_log", "INFO", {FCVAR_ARCHIVE, FCVAR_PROTECTED}, "Minimum log level (TRACE/INFO/DEBUG/WARN/ERR)")
+local logLevelFile = "atomic/loglevel.dat"
+function atomic.logger.getCurrentLevel()
+  return atomic._config.logLevel or file.Read(logLevelFile) or "info"
+end
+
+--- `Internal` function, you `probably` shouldn't use it
+---@param levelName string
+---@return boolean
+function atomic.logger.isLevelExists(levelName)
+  return levels[levelName:upper()] ~= nil
+end
+
+--- `Internal` function, you shouldn't use it
+---@param level string
+function atomic.logger.updateLevel(level)
+  if (not atomic.logger.isLevelExists(level)) then
+    return false
+  end
+
+  atomic._config.logLevel = level
+
+  file.Write(logLevelFile, level)
+end
+
+atomic._config.logLevel = atomic.logger.getCurrentLevel()
 
 ---@param prefix string
 function Logger:init(prefix)
@@ -64,7 +88,7 @@ local MAX_LEVEL_LENGTH = 5
 ---@param message string
 ---@param ... any
 function Logger:log(color, level, message, ...)
-  local currentLevel = logvar:GetString():upper()
+  local currentLevel = atomic._config.logLevel:upper()
   local currentIdx = levels[currentLevel] or 1
   local msgIdx = levels[level] or 1
 
@@ -95,4 +119,5 @@ end
 
 function Logger:err(message, ...)
   self:log(err, "ERR", message, ...)
+  _G["debug"].Trace()
 end