chore: use penlight class for all the class def

Author: s1n7ax

lua/react/components/buffer-component.lua

@@ -9,7 +9,7 @@ local create_effect = core.create_effect
 --- @field private effect react.Effect
 --- @field private node function
 --- @field private subscriber function
---- @field private components Set
+--- @field private components react.Set
 --- @field private text string
 
 local BufferComponent = class()
@@ -33,7 +33,7 @@ function BufferComponent:_init(args)
 
 		local Component = require('react.component')
 
-		Component:new({
+		Component({
 			component = App,
 			subscriber = on_change
 		})
@@ -53,7 +53,7 @@ function BufferComponent:_init(args)
 
 	-- List of components that will be referred when one of them are
 	-- user functional components and it's being updated
-	self.components = Set:new()
+	self.components = Set()
 
 	-- holds the latest text of this component
 	self.text = ''

lua/react/core/effect-events.lua

@@ -1,4 +1,4 @@
---- @enum EffectEvents
+--- @enum react.EffectEvents
 return {
 
 	-- runs before / after each render

lua/react/core/effect.lua

@@ -9,15 +9,15 @@ local log = require('react.util.log')
 
 --- @class react.Effect
 --- @field private first_render boolean true until first render is completed
---- @field private signals Set holds all the signals associated with this effect
+--- @field private signals react.Set holds all the signals associated with this effect
 --- @field private signal_pointer number a signal can request previously created signals from the
 --- effect. When a signal is requested, the pointer will be incremented.
 --- @field private events Event event object to handle events within the effect
 --- @field private callback function to be called on an render/re-render event
 
 local Effect = class()
 
-Effect.context = Stack:new()
+Effect.context = Stack()
 
 function Effect:_init(callback)
 	log.debug('creating new effect')
@@ -27,10 +27,6 @@ function Effect:_init(callback)
 		'Callback function should be passed to effect'
 	)
 
-	-- local o = {}
-	-- setmetatable(o, self)
-	-- self.__index = self
-
 	local context_push_callback = function()
 		self.events:dispatch(EffectEvents.BEFORE_RENDER)
 
@@ -48,9 +44,9 @@ function Effect:_init(callback)
 	end
 
 	self.first_render = true
-	self.signals = Set:new()
+	self.signals = Set()
 	self.signal_pointer = 1
-	self.events = Event:new()
+	self.events = Event()
 
 	-- wrap the callback only for the first render to identify the initial
 	-- render

lua/react/core/signal.lua

@@ -5,7 +5,7 @@ local log = require('react.util.log')
 
 --- @class react.Signal
 --- @field private value table value of the store
---- @field private publisher Publisher
+--- @field private publisher react.Publisher
 local Signal = class()
 
 function Signal:_init(value)
@@ -22,7 +22,7 @@ function Signal:_init(value)
 	log.debug('creating signal with initial value:: ', value)
 
 	self.value = value
-	self.publisher = Publisher:new()
+	self.publisher = Publisher()
 end
 
 --- Returns the signal value

lua/react/stores/dict/dict-node.lua

@@ -1,14 +1,17 @@
+local class = require('react.util.class')
 local Effect = require('react.core.effect')
 local List = require('react.util.list')
 local helper = require('react.stores.dict.helper')
 local log = require('react.util.log')
 
---- @alias PublisherMap { key: string, effects: Set, children: PublisherMap[] }
---- @alias DictNodeConstructor { publishers: PublisherMap, value: any, path?: List, curr_publisher_node?: PublisherMap }
+--- @alias PublisherMap { key: string, effects: react.Set, children: PublisherMap[] }
+--- @alias DictNodeConstructor { publishers: PublisherMap, value: any, path?: react.List, curr_publisher_node?: PublisherMap }
 
 --- @class DictNode
 --- @field value any value of the dict node
-local M = {}
+local M = class()
+
+function M:_init() end
 
 --- @param opt DictNodeConstructor
 function M:new(opt)
@@ -20,7 +23,7 @@ function M:new(opt)
 	local obj = setmetatable({}, {
 		publishers = opt.publishers,
 		value = opt.value,
-		path = opt.path or List:new(),
+		path = opt.path or List(),
 		curr_publishers_node = opt.curr_publisher_node or opt.publishers,
 
 		__index = self.index,
@@ -42,7 +45,6 @@ function M.index(self, key)
 	local curr_pub_node = helper.publisher_path_traversal(publishers, curr_path)
 	local indexed_value = value[key]
 
-
 	log.debug(('indexed value for key "%s" is'):format(key), indexed_value)
 
 	-- if there is an effect, add effect to store, and store to effect
@@ -67,7 +69,12 @@ function M.index(self, key)
 
 	-- if the next value is a table then create new object of dict
 	if type(indexed_value) == 'table' then
-		log.debug('creating new dict node for path ', curr_path.list, ' with value', indexed_value)
+		log.debug(
+			'creating new dict node for path ',
+			curr_path.list,
+			' with value',
+			indexed_value
+		)
 
 		return M:new({
 			publishers = publishers,

lua/react/stores/dict/helper.lua

@@ -5,7 +5,7 @@ local M = {}
 
 --- Traverse through the table and find
 --- @param publisher_map PublisherMap
---- @param path List
+--- @param path react.List
 function M.publisher_path_traversal(publisher_map, path)
 	local curr_pub_node = publisher_map
 
@@ -14,7 +14,7 @@ function M.publisher_path_traversal(publisher_map, path)
 			curr_pub_node.children[key] = {
 				-- adding key for debugging purposes
 				key = key,
-				effects = Set:new(),
+				effects = Set(),
 				children = {},
 			}
 		end
@@ -48,7 +48,7 @@ function M.dispatch_and_remove_children(root_pub_node)
 end
 
 function M.get_all_effects_in_pub_node(root_pub_node)
-	local effects = Set:new()
+	local effects = Set()
 
 	local capture_children_effects = nil
 

lua/react/stores/dict/init.lua

@@ -8,7 +8,7 @@ return function(init_value)
 	assert(Effect.context:is_empty(), 'Store can not be created inside an effect or component')
 
 	local publishers = {
-		effects = Set:new(),
+		effects = Set(),
 		children = {},
 	}
 

lua/react/stores/list.lua

@@ -1,19 +1,13 @@
+local class = require('react.util.class')
 local Set = require('react.util.set')
 local Publisher = require('react.util.publisher')
 local Effect = require('react.core.effect')
 
-local M = {
-	list = Set:new(),
-	element_publishers = Set:new(),
-	publisher = Publisher:new(),
-}
-
-function M:new(o)
-	o = o or {}
-	setmetatable(o, self)
-	self.__index = self
-	return o
-end
+local M = class()
+
+M.list = Set()
+M.element_publishers = Set()
+M.publisher = Publisher()
 
 function M:get(index)
 	self:reg_subscriber()

lua/react/util/event.lua

@@ -1,18 +1,12 @@
+local class = require('react.util.class')
 local Set = require('react.util.set')
 
 --- @class Event
---- @field private listeners_map table<string, Set>
-local M = {}
+--- @field private listeners_map table<string, react.Set>
+local M = class()
 
-function M:new()
-	local o = {
-		listeners_map = {},
-	}
-
-	setmetatable(o, self)
-	self.__index = self
-
-	return o
+function M:_init()
+	self.listeners_map = {}
 end
 
 --- Add a listener function to a given event
@@ -21,7 +15,7 @@ end
 --- @param opt nil|{once: boolean} additional options
 function M:add_listener(event, listener, opt)
 	if not self.listeners_map[event] then
-		self.listeners_map[event] = Set:new()
+		self.listeners_map[event] = Set()
 	end
 
 	if opt and not opt.once then

lua/react/util/list.lua

@@ -1,57 +1,52 @@
----@class List
+local class = require('react.util.class')
+
+---@class react.List
 ---@field protected list any[]
-local M = {}
+local List = class()
 
 ---@param list any[] | nil
-function M:new(list)
-	local o = {
-		list = list or {},
-	}
-
-	setmetatable(o, self)
-	self.__index = self
-
-	return o
+function List:_init(list)
+	self.list = list or {}
 end
 
 ---Returns the value at given index
 ---@param index number index of the param
 ---@returns any
-function M:get(index)
+function List:get(index)
 	return self.list[index]
 end
 
 ---Sets the value at given index to given value
 ---@param index number index to set the value at
 ---@param value any value to set
-function M:set(index, value)
+function List:set(index, value)
 	self.list[index] = value
 	return 0
 end
 
 ---Returns an iterator of the list
 ---@returns function
-function M:iter()
+function List:iter()
 	return ipairs(self.list)
 end
 
 ---Append new value to the list
 ---@param value any value to append
-function M:add(value)
+function List:add(value)
 	table.insert(self.list, value)
 end
 
 ---Remove existing value from the list by index
 ---@param index number
 ---@returns any value that got removed from the list
-function M:remove(index)
+function List:remove(index)
 	return table.remove(self.list, index)
 end
 
 ---Remove existing value from the list by the value
 ---@param value any value to remove from the list
 ---@returns any value that got removed from the list
-function M:remove_by_value(value)
+function List:remove_by_value(value)
 	local index = self:find_index(value)
 
 	if index < 0 then
@@ -64,14 +59,14 @@ function M:remove_by_value(value)
 end
 
 ---Remove all the values from the list
-function M:remove_all()
+function List:remove_all()
 	self.list = {}
 end
 
 ---Returns the index of a given value if exists
 ---Returns -1 if the value does not exist
 ---@return number
-function M:find_index(value)
+function List:find_index(value)
 	for index, ele in ipairs(self.list) do
 		if ele == value then
 			return index
@@ -84,7 +79,7 @@ end
 ---Returns true if the given value exists in the list
 ---@param value any value to check the existence
 ---@returns boolean
-function M:has(value)
+function List:has(value)
 	for _, ele in ipairs(self.list) do
 		if ele == value then
 			return true
@@ -96,13 +91,13 @@ end
 
 ---Returns the size of the list
 ---@returns number size of the list
-function M:length()
+function List:length()
 	return #self.list
 end
 
 ---Concatenate the given list to this list
----@param list List | any[]
-function M:concat(list)
+---@param list react.List | any[]
+function List:concat(list)
 	if list.iter then
 		for _, v in list:iter() do
 			self:add(v)
@@ -117,20 +112,20 @@ end
 ---Returns a string after joining the list by given string separator
 ---@param separator string separator to join the list with
 ---@returns string joined string
-function M:join(separator)
+function List:join(separator)
 	return table.concat(self.list, separator)
 end
 
 ---Returns a clone of the current list
 ---@returns List clone of the current list
-function M:clone()
-	return M:new(M.deepcopy(self.list))
+function List:clone()
+	return List(List.deepcopy(self.list))
 end
 
 ---@private
 ---@param orig table original table to copy
 ---@returns table clone of the table
-function M.deepcopy(orig, copies)
+function List.deepcopy(orig, copies)
 	copies = copies or {}
 	local orig_type = type(orig)
 	local copy
@@ -141,7 +136,8 @@ function M.deepcopy(orig, copies)
 			copy = {}
 			copies[orig] = copy
 			for orig_key, orig_value in next, orig, nil do
-				copy[M.deepcopy(orig_key, copies)] = M.deepcopy(orig_value, copies)
+				copy[List.deepcopy(orig_key, copies)] =
+					List.deepcopy(orig_value, copies)
 			end
 			--  setmetatable(copy, M.deepcopy(getmetatable(orig), copies))
 		end
@@ -152,4 +148,4 @@ function M.deepcopy(orig, copies)
 	return copy
 end
 
-return M
+return List