11import json
2+ import time
3+ from datetime import date
24from enum import Enum , unique
35
46import discord
57from discord .ext import commands
8+ from sqlalchemy import create_engine
9+ from sqlalchemy .orm import sessionmaker
10+
11+ from bot .cogs .constants import Belts , get_role_from_name , translator_to_emoji
12+ from bot .cogs .logs import AttributionLogs , Base , log_attribution
13+
14+ # sqlalchemy setup
15+ engine = create_engine ("sqlite:///daily_logs.db" )
16+
17+ Base .metadata .bind = engine
18+
19+ DBSession = sessionmaker (bind = engine )
20+
21+ session = DBSession ()
622
723
824class FileHandler :
25+ """
26+ This is a class to handle a json file.
27+
28+ Attributes:
29+ file (string): The path to the json file being handled.
30+ """
31+
932 file = "bot/cogs/belts.json"
1033
11- def __init__ (self , belt ):
34+ def __init__ (self : str , belt : str ):
35+ """
36+ The constructor for the FileHandler class.
37+
38+ Parameters:
39+ color (int): Color code to be displayed in discord embed.
40+ """
1241 self .belt = belt
1342 self .msg = self .get_info ()[0 ]
1443 self .color = self .get_info ()[1 ]
1544
16- def get_info (self ):
45+ def get_info (self ) -> tuple :
46+ """
47+ The function to get the info from the belts.json file.
48+
49+ Returns:
50+ msg (string): Variable that contains the message of the respective belt.
51+ color (int): Color code to be displayed in discord embed.
52+ """
1753 with open (self .file ) as json_file :
1854 data = json .load (json_file )
1955 msg = f"Subiste para { self .belt } \n \n Próximos objetivos:"
2056 color = int (data [self .belt ]["color" ], 16 )
21- for param in data [self .belt ]["objectives " ]:
57+ for param in data [self .belt ]["goals " ]:
2258 msg += "\n " + param
2359
2460 return (msg , color )
2561
2662
27- translator_to_emoji = {
28- "Branco" : ":white_circle:" ,
29- "Amarelo" : ":yellow_circle:" ,
30- "Azul" : ":blue_circle:" ,
31- "Verde" : ":green_circle:" ,
32- "Laranja" : ":orange_circle:" ,
33- "Vermelho" : ":red_circle:" ,
34- "Roxo" : ":purple_circle:" ,
35- "Preto" : ":black_circle:" ,
36- }
37-
38-
39- @unique
40- class Belts (Enum ):
41- Branco = 1
42- Amarelo = 2
43- Azul = 3
44- Verde = 4
45- Laranja = 5
46- Vermelho = 6
47- Roxo = 7
48- Preto = 8
49-
50-
5163class Ninja :
52- def __init__ (self , guild , member ):
64+ """This is a class to get information about a specific ninja."""
65+
66+ def __init__ (self , guild : discord .Guild , member : discord .Member ):
5367 self .guild = guild
5468 self .member = member
5569 self .roles = [role for role in member .roles ]
5670
57- def current_belt (self ):
71+ def current_belt (self ) -> Belts :
72+ """This function returns the current belt of the ninja."""
73+
5874 highest_belt = None
5975 for role in self .roles :
6076 for belt in Belts :
@@ -63,34 +79,34 @@ def current_belt(self):
6379
6480 return highest_belt
6581
66- def next_belt (self ):
67- # Check if the maximum range has been exceeded
82+ def next_belt (self ) -> Belts :
83+ """This function returns the next belt of the ninja."""
84+
6885 value = self .current_belt ().value + 1 if self .current_belt ().value < 8 else 8
6986
7087 return Belts (value )
7188
72- @staticmethod
73- def get_role_from_name (guild , belt ):
74- for role in guild .roles :
75- if role .name == belt :
76- return role
77-
7889
7990class BeltsAttributions (commands .Cog ):
80- def __init__ (self , client ):
91+ """This is a class to handle the attribution of belts."""
92+
93+ def __init__ (self , client : commands .Bot ):
8194 self .client = client
8295
8396 @commands .command (name = "promove" )
8497 @commands .has_any_role ("🛡️ Admin" , "🏆 Champion" , "🧑🏫 Mentores" )
85- async def promove (self , ctx , user , belt ):
98+ async def promove (
99+ self , ctx : discord .ext .commands .Context , user : str , belt : str
100+ ) -> None :
101+ """This function promotes a user to the next belt."""
86102
87103 mentions = ctx .message .raw_mentions
88104 guild = ctx .guild
89105 member = guild .get_member (mentions [0 ])
90106 ninja = Ninja (guild , member )
91107
92108 if belt == "Branco" and ninja .current_belt () == None :
93- role = Ninja . get_role_from_name (guild , belt )
109+ role = get_role_from_name (guild , belt )
94110
95111 await member .add_roles (guild .get_role (role .id ), reason = None , atomic = True )
96112
@@ -109,11 +125,22 @@ async def promove(self, ctx, user, belt):
109125
110126 await user .send (embed = embed )
111127
128+ # Adding the log to the database
129+ new_log = AttributionLogs (
130+ ninja_id = str (member ),
131+ mentor_id = str (ctx .author ),
132+ belt_attributed = belt ,
133+ timestamp = int (time .time ()),
134+ )
135+
136+ session .add (new_log )
137+ session .commit ()
138+
112139 elif belt == ninja .current_belt ().name :
113140 await ctx .reply (f"Esse já é o cinturão do ninja { user } )
114141
115142 elif belt == ninja .next_belt ().name :
116- role = Ninja . get_role_from_name (guild , belt )
143+ role = get_role_from_name (guild , belt )
117144 await member .add_roles (guild .get_role (role .id ), reason = None , atomic = True )
118145
119146 # Public message
@@ -131,9 +158,20 @@ async def promove(self, ctx, user, belt):
131158
132159 await user .send (embed = embed )
133160
161+ # Adding the log to the database
162+ new_log = AttributionLogs (
163+ ninja_id = str (member ),
164+ mentor_id = str (ctx .author ),
165+ belt_attributed = belt ,
166+ timestamp = int (time .time ()),
167+ )
168+
169+ session .add (new_log )
170+ session .commit ()
171+
134172 elif belt != ninja .next_belt ().name :
135173 await ctx .send (f"{ user } )
136174
137175
138- def setup (client ) :
176+ def setup (client : commands . Bot ) -> None :
139177 client .add_cog (BeltsAttributions (client ))
0 commit comments