Compare commits

..
Author SHA1 Message Date
imcompiling 431e9c0b35 Filled out term start action.
build_develop / build (push) Successful in 1m32s
2023-11-08 16:11:47 -05:00
imcompiling 27f90bbaef Add test for term start. 2023-11-08 15:51:06 -05:00
imcompiling c98bb5888c Give a message for thread to attach to. Lets it be public. 2023-11-08 15:44:19 -05:00
imcompiling c38632ca21 Remove another permission setting.
name a parameter.
2023-11-08 15:43:58 -05:00
imcompiling 75fc59ed5e Removed references to ElectionChannel.
Removed permission managing as threads don't have permissions.
2023-11-08 15:30:05 -05:00
imcompiling 8d2f2f7dba Thread create ini election start.
build_develop / build (push) Successful in 1m35s
Modified config and database to use threads.
2023-11-07 15:36:33 -05:00
imcompiling ab88652cdb Automatic reformat. Guessing from vscode update. 2023-11-07 15:35:43 -05:00
imcompiling b0e3162123 Change bot to use update query.
build_latest / build (push) Successful in 48s
build_develop / build (push) Successful in 50s
2023-11-07 14:59:07 -05:00
imcompiling 8c1eb8d11f Filled out a docstring.
For some reason, file wasn't formatted.
2023-11-07 14:52:22 -05:00
imcompiling 40d220e2bb Merge branch '32-view-votes-command'
build_develop / build (push) Successful in 50s
2023-11-07 14:44:33 -05:00
5 changed files with 179 additions and 63 deletions
+94 -43
View File
@@ -12,7 +12,12 @@ from sqlalchemy.orm import Session
from classes.nominate_views import NominateView from classes.nominate_views import NominateView
from classes.voting_views import VoteView from classes.voting_views import VoteView
from config import DakinyConfig from config import DakinyConfig
from database_setup.sql_data_classes import CouncilMembers, ElectionInformation, Votes, engine from database_setup.sql_data_classes import (
CouncilMembers,
ElectionInformation,
Votes,
engine,
)
from utils import build_votes_str, get_datetime, get_election_cycle_name from utils import build_votes_str, get_datetime, get_election_cycle_name
@@ -40,9 +45,15 @@ class ElectionCycle:
self.term_end: datetime = get_datetime(self.election_cycle.term_end) self.term_end: datetime = get_datetime(self.election_cycle.term_end)
self.voting_start: datetime = get_datetime(self.election_cycle.voting_start) self.voting_start: datetime = get_datetime(self.election_cycle.voting_start)
self.voting_end: datetime = get_datetime(self.election_cycle.voting_end) self.voting_end: datetime = get_datetime(self.election_cycle.voting_end)
self.highcouncil_election_announce: datetime = get_datetime(self.election_cycle.highcouncil_election_announce) self.highcouncil_election_announce: datetime = get_datetime(
self.highcouncil_election_start: datetime = get_datetime(self.election_cycle.highcouncil_election_start) self.election_cycle.highcouncil_election_announce
self.highcouncil_election_end: datetime = get_datetime(self.election_cycle.highcouncil_election_end) )
self.highcouncil_election_start: datetime = get_datetime(
self.election_cycle.highcouncil_election_start
)
self.highcouncil_election_end: datetime = get_datetime(
self.election_cycle.highcouncil_election_end
)
self.guild: nextcord.Guild = guild self.guild: nextcord.Guild = guild
self.election_over: bool = False self.election_over: bool = False
@@ -55,11 +66,15 @@ class ElectionCycle:
long. long.
""" """
with open("bot_messages/election_announcement.txt", mode="r", encoding="utf8") as file: with open(
"bot_messages/election_announcement.txt", mode="r", encoding="utf8"
) as file:
message = file.read() message = file.read()
next_election = get_datetime( next_election = get_datetime(
self.config.election_cycles[(self.cycle + 1) % len(self.config.election_cycles)].election_start self.config.election_cycles[
(self.cycle + 1) % len(self.config.election_cycles)
].election_start
) )
message = message.format( message = message.format(
@@ -84,14 +99,22 @@ class ElectionCycle:
str: Message to send. str: Message to send.
""" """
with open("bot_messages/highcouncil_election.txt", mode="r", encoding="utf8") as file: with open(
"bot_messages/highcouncil_election.txt", mode="r", encoding="utf8"
) as file:
message = file.read() message = file.read()
return message.format( return message.format(
clan_council_elect_role_id=self.config.params.clan_council_elect_role_id, clan_council_elect_role_id=self.config.params.clan_council_elect_role_id,
highcouncil_election_announce=self.highcouncil_election_announce.strftime("%B %d"), highcouncil_election_announce=self.highcouncil_election_announce.strftime(
highcouncil_election_start=self.highcouncil_election_start.strftime("%B %d"), "%B %d"
highcouncil_election_end=self.highcouncil_election_end.strftime("%B %d"), ),
highcouncil_election_start=self.highcouncil_election_start.strftime(
"%B %d"
),
highcouncil_election_end=self.highcouncil_election_end.strftime(
"%B %d"
),
term_start=self.term_start.strftime("%B %d"), term_start=self.term_start.strftime("%B %d"),
) )
@@ -103,7 +126,9 @@ class ElectionCycle:
str: Message to send. str: Message to send.
""" """
with open("bot_messages/highcouncil_vote.txt", mode="r", encoding="utf8") as file: with open(
"bot_messages/highcouncil_vote.txt", mode="r", encoding="utf8"
) as file:
message = file.read() message = file.read()
return message.format( return message.format(
@@ -121,7 +146,9 @@ class ElectionCycle:
with open("bot_messages/vote_start.txt", mode="r", encoding="utf8") as file: with open("bot_messages/vote_start.txt", mode="r", encoding="utf8") as file:
message = file.read() message = file.read()
vote_end: datetime = get_datetime(self.config.election_cycles[self.cycle].voting_end) vote_end: datetime = get_datetime(
self.config.election_cycles[self.cycle].voting_end
)
return message.format( return message.format(
clan_member_id=self.config.params.clan_member_role_id, clan_member_id=self.config.params.clan_member_role_id,
@@ -140,7 +167,11 @@ class ElectionCycle:
await self.election_start_action() await self.election_start_action()
elif today.date() == self.voting_start.date(): elif today.date() == self.voting_start.date():
await self.voting_start_action() await self.voting_start_action()
elif (self.voting_end - timedelta(3)).date() <= today.date() < self.voting_end.date(): elif (
(self.voting_end - timedelta(3)).date()
<= today.date()
< self.voting_end.date()
):
await self.election_reminder() await self.election_reminder()
elif today.date() == self.voting_end.date(): elif today.date() == self.voting_end.date():
await self.voting_end_action() await self.voting_end_action()
@@ -154,15 +185,21 @@ class ElectionCycle:
Performs required actions for when the election cycle starts. Performs required actions for when the election cycle starts.
""" """
# create new channel for election # create new channel for election
category: nextcord.CategoryChannel = self.guild.get_channel(self.config.params.active_category_id) parent: nextcord.TextChannel = self.guild.get_channel(
self.config.params.voting_parent_id
)
quarter_name: str = get_election_cycle_name(self.config) quarter_name: str = get_election_cycle_name(self.config)
thread_msg: nextcord.Message = await parent.send(content=quarter_name)
# create new entry into database. # create new entry into database.
election_channel: nextcord.TextChannel = await category.create_text_channel(quarter_name) thread: nextcord.Thread = await parent.create_thread(
clan_member_role: nextcord.Role = self.guild.get_role(self.config.params.clan_member_role_id) name=quarter_name, message=thread_msg
await election_channel.set_permissions(clan_member_role, add_reactions=True) )
with Session(engine) as session: with Session(engine) as session:
new_cycle = ElectionInformation(ElectionCycle=quarter_name, ElectionChannel=election_channel.id) new_cycle = ElectionInformation(
ElectionCycle=quarter_name, ThreadId=thread.id
)
session.add(new_cycle) session.add(new_cycle)
session.commit() session.commit()
@@ -173,9 +210,9 @@ class ElectionCycle:
for index, message in enumerate(messages): for index, message in enumerate(messages):
# if last item, add the nominate button # if last item, add the nominate button
if index + 1 == len(messages): if index + 1 == len(messages):
await election_channel.send(message, view=NominateView(self.config)) await thread.send(message, view=NominateView(self.config))
else: else:
await election_channel.send(message) await thread.send(message)
async def voting_start_action(self) -> None: async def voting_start_action(self) -> None:
""" """
@@ -183,30 +220,35 @@ class ElectionCycle:
Removes write permission from the general clan member role. Removes write permission from the general clan member role.
""" """
message = self.build_vote_start() message = self.build_vote_start()
clan_member_role: nextcord.Role = self.guild.get_role(self.config.params.clan_member_role_id) election_thread: nextcord.Thread = self.guild.get_thread(
election_channel: nextcord.TextChannel = self.guild.get_channel(self.get_election_info().ElectionChannel) self.get_election_info().ThreadId
await election_channel.send(message) )
vote_msg = await election_channel.send(build_votes_str(self.config), view=VoteView(self.config, self.guild)) await election_thread.send(message)
vote_msg = await election_thread.send(
build_votes_str(self.config), view=VoteView(self.config, self.guild)
)
with Session(engine) as session: with Session(engine) as session:
stmt = select(ElectionInformation).where( stmt = select(ElectionInformation).where(
ElectionInformation.ElectionCycle == get_election_cycle_name(self.config) ElectionInformation.ElectionCycle
== get_election_cycle_name(self.config)
) )
info = session.scalar(stmt) info = session.scalar(stmt)
info.CouncilVoteMsgId = vote_msg.id info.CouncilVoteMsgId = vote_msg.id
session.commit() session.commit()
await election_channel.set_permissions(clan_member_role, send_messages=False)
async def voting_end_action(self) -> None: async def voting_end_action(self) -> None:
""" """
Performs required actions for when voting time has ended. Performs required actions for when voting time has ended.
""" """
message = self.build_highcouncil_election_announce() message = self.build_highcouncil_election_announce()
council_elect_role: nextcord.Role = self.guild.get_role(self.config.params.clan_council_elect_role_id) council_elect_role: nextcord.Role = self.guild.get_role(
election_channel: nextcord.TextChannel = self.guild.get_channel(self.get_election_info().ElectionChannel) self.config.params.clan_council_elect_role_id
clan_member_role: nextcord.Role = self.guild.get_role(self.config.params.clan_member_role_id) )
election_thread: nextcord.Thread = self.guild.get_thread(
self.get_election_info().ThreadId
)
# remove vote button from vote message # remove vote button from vote message
election_name = get_election_cycle_name(self.config) election_name = get_election_cycle_name(self.config)
@@ -215,7 +257,7 @@ class ElectionCycle:
ElectionInformation.ElectionCycle == election_name ElectionInformation.ElectionCycle == election_name
) )
vote_msg_id = session.scalar(stmt) vote_msg_id = session.scalar(stmt)
vote_msg: nextcord.Message = await election_channel.fetch_message(vote_msg_id) vote_msg: nextcord.Message = await election_thread.fetch_message(vote_msg_id)
await vote_msg.edit(view=None) await vote_msg.edit(view=None)
# add the highcouncil role to everyone with 3 or more votes. set elected to true in database # add the highcouncil role to everyone with 3 or more votes. set elected to true in database
@@ -238,9 +280,7 @@ class ElectionCycle:
await user.add_roles(council_elect_role) await user.add_roles(council_elect_role)
await election_channel.send(message) await election_thread.send(message)
await election_channel.set_permissions(council_elect_role, send_messages=True, add_reactions=True)
await election_channel.set_permissions(clan_member_role, add_reactions=False)
async def highcouncil_election_start_action(self) -> None: async def highcouncil_election_start_action(self) -> None:
""" """
@@ -248,19 +288,27 @@ class ElectionCycle:
""" """
message = self.build_highcouncil_vote_start() message = self.build_highcouncil_vote_start()
election_channel: nextcord.TextChannel = self.guild.get_channel(self.get_election_info().ElectionChannel) election_thread: nextcord.Thread = self.guild.get_thread(
await election_channel.send(message) self.get_election_info().ThreadId
)
await election_thread.send(message)
async def term_start_action(self) -> None: async def term_start_action(self) -> None:
""" """
Moves the election channel into the archive category. Marks the election as over.
""" """
self.election_over = True self.election_over = True
election_channel: nextcord.TextChannel = self.guild.get_channel(self.get_election_info().ElectionChannel)
archive: nextcord.CategoryChannel = self.guild.get_channel(self.config.params.archive_channel_group_id)
await election_channel.move(beginning=True, category=archive) election_thread: nextcord.Thread = self.guild.get_thread(
self.get_election_info().ThreadId
)
await election_thread.send(
"This election cycle is now over. Thank you everyone for participating!"
)
await election_thread.edit(archived=True, locked=True)
def get_election_info(self) -> ElectionInformation: def get_election_info(self) -> ElectionInformation:
""" """
@@ -272,7 +320,8 @@ class ElectionCycle:
with Session(engine) as session: with Session(engine) as session:
stmt = select(ElectionInformation).where( stmt = select(ElectionInformation).where(
ElectionInformation.ElectionCycle == get_election_cycle_name(self.config) ElectionInformation.ElectionCycle
== get_election_cycle_name(self.config)
) )
return session.scalar(stmt) return session.scalar(stmt)
@@ -281,9 +330,11 @@ class ElectionCycle:
Sends a message to general chat reminder clan about election. Sends a message to general chat reminder clan about election.
""" """
general: nextcord.TextChannel = self.guild.get_channel(self.config.params.general_channel_id) general: nextcord.TextChannel = self.guild.get_channel(
self.config.params.general_channel_id
)
message = f"Reminder to <@&{self.config.params.clan_member_role_id}>! Clan elections are happening! Head over " message = f"Reminder to <@&{self.config.params.clan_member_role_id}>! Clan elections are happening! Head over "
message += f"to <#{self.get_election_info().ElectionChannel}> to cast your vote!" message += f"to <#{self.get_election_info().ThreadId}> to cast your vote!"
await general.send(content=message) await general.send(content=message)
+41 -14
View File
@@ -7,11 +7,16 @@ from typing import List
import nextcord import nextcord
from nextcord import SelectOption from nextcord import SelectOption
from nextcord.interactions import Interaction from nextcord.interactions import Interaction
from sqlalchemy import exc, select from sqlalchemy import exc, select, update
from sqlalchemy.orm import Session from sqlalchemy.orm import Session
from config import DakinyConfig from config import DakinyConfig
from database_setup.sql_data_classes import CouncilMembers, ElectionInformation, Votes, engine from database_setup.sql_data_classes import (
CouncilMembers,
ElectionInformation,
Votes,
engine,
)
from utils import build_votes_str, get_election_cycle_name from utils import build_votes_str, get_election_cycle_name
@@ -38,7 +43,11 @@ class VoteSelect(nextcord.ui.StringSelect):
else: else:
voted_for = int(self.values[0]) voted_for = int(self.values[0])
new_vote = Votes(ElectionCycle=election_name, VoterId=interaction.user.id, VotedForId=voted_for) new_vote = Votes(
ElectionCycle=election_name,
VoterId=interaction.user.id,
VotedForId=voted_for,
)
try: try:
session.add(new_vote) session.add(new_vote)
@@ -47,16 +56,18 @@ class VoteSelect(nextcord.ui.StringSelect):
except exc.IntegrityError: except exc.IntegrityError:
session.rollback() session.rollback()
stmt = ( stmt = (
select(Votes) update(Votes)
.where(Votes.ElectionCycle == election_name) .where(Votes.ElectionCycle == election_name)
.where(Votes.VoterId == interaction.user.id) .where(Votes.VoterId == interaction.user.id)
.values(VotedForId=voted_for)
) )
vote = session.scalar(stmt) session.execute(stmt)
vote.VotedForId = voted_for
session.commit() session.commit()
vote_message_str = build_votes_str(self.config) vote_message_str = build_votes_str(self.config)
vote_msg: nextcord.Message = await interaction.channel.fetch_message(vote_msg_id) vote_msg: nextcord.Message = await interaction.channel.fetch_message(
vote_msg_id
)
await vote_msg.edit(content=vote_message_str) await vote_msg.edit(content=vote_message_str)
if voted_for is not None: if voted_for is not None:
@@ -77,10 +88,15 @@ class VoteView(nextcord.ui.View):
self.config = config self.config = config
self.guild = guild self.guild = guild
@nextcord.ui.button(label="Vote", style=nextcord.ButtonStyle.primary, custom_id="vote") @nextcord.ui.button(
async def vote(self, button: nextcord.ui.Button, interaction: nextcord.Interaction) -> None: label="Vote", style=nextcord.ButtonStyle.primary, custom_id="vote"
)
async def vote(
self, button: nextcord.ui.Button, interaction: nextcord.Interaction
) -> None:
""" """
TODO Enforces only members vote. Gets election cycle, creates voting options (checking if user has voted already),
then sends the voting view.
Args: Args:
button (nextcord.ui.Button): Unused. idk why its needed in the decorator button (nextcord.ui.Button): Unused. idk why its needed in the decorator
@@ -88,9 +104,13 @@ class VoteView(nextcord.ui.View):
""" """
# enforce members only # enforce members only
if self.guild.get_role(self.config.params.clan_member_role_id) not in interaction.user.roles: if (
self.guild.get_role(self.config.params.clan_member_role_id)
not in interaction.user.roles
):
await interaction.response.send_message( await interaction.response.send_message(
f"You must have the <@&{self.config.params.clan_member_role_id}> role to vote.", ephemeral=True f"You must have the <@&{self.config.params.clan_member_role_id}> role to vote.",
ephemeral=True,
) )
return return
@@ -104,7 +124,9 @@ class VoteView(nextcord.ui.View):
) )
voted_for = session.scalar(stmt) voted_for = session.scalar(stmt)
stmt = select(CouncilMembers.MemberId).where(CouncilMembers.ElectionCycle == election) stmt = select(CouncilMembers.MemberId).where(
CouncilMembers.ElectionCycle == election
)
options = [ options = [
SelectOption( SelectOption(
@@ -115,7 +137,12 @@ class VoteView(nextcord.ui.View):
) )
for nominee in session.scalars(stmt) for nominee in session.scalars(stmt)
] ]
options.append(SelectOption(label="Abstain ☑️" if voted_for is None else "Abstain", value="Abstain")) options.append(
SelectOption(
label="Abstain ☑️" if voted_for is None else "Abstain",
value="Abstain",
)
)
view = nextcord.ui.View() view = nextcord.ui.View()
view.add_item(VoteSelect(options=options, config=self.config)) view.add_item(VoteSelect(options=options, config=self.config))
+42 -5
View File
@@ -35,6 +35,7 @@ class TestCog(commands.Cog, name="Test commands."):
""" """
@test.subcommand() @test.subcommand()
@is_me()
async def msg_builder(self, interaction: nextcord.Interaction): async def msg_builder(self, interaction: nextcord.Interaction):
""" """
Tests the message builder. Tests the message builder.
@@ -52,6 +53,7 @@ class TestCog(commands.Cog, name="Test commands."):
await interaction.channel.send(content=m) await interaction.channel.send(content=m)
@test.subcommand() @test.subcommand()
@is_me()
async def election_start(self, interaction: nextcord.Interaction): async def election_start(self, interaction: nextcord.Interaction):
""" """
idc idc
@@ -61,10 +63,15 @@ class TestCog(commands.Cog, name="Test commands."):
""" """
config: DakinyConfig = self.bot.config config: DakinyConfig = self.bot.config
cycle = ElectionCycle(get_current_cycle(config), config, self.bot.get_guild(config.params.guild_id)) cycle = ElectionCycle(
get_current_cycle(config),
config,
self.bot.get_guild(config.params.guild_id),
)
await cycle.election_start_action() await cycle.election_start_action()
@test.subcommand() @test.subcommand()
@is_me()
async def voting_start(self, interaction: nextcord.Interaction): async def voting_start(self, interaction: nextcord.Interaction):
""" """
tests the voting start action tests the voting start action
@@ -73,10 +80,15 @@ class TestCog(commands.Cog, name="Test commands."):
interaction (nextcord.Interaction): _description_ interaction (nextcord.Interaction): _description_
""" """
config: DakinyConfig = self.bot.config config: DakinyConfig = self.bot.config
cycle = ElectionCycle(get_current_cycle(config), config, self.bot.get_guild(config.params.guild_id)) cycle = ElectionCycle(
get_current_cycle(config),
config,
self.bot.get_guild(config.params.guild_id),
)
await cycle.voting_start_action() await cycle.voting_start_action()
@test.subcommand() @test.subcommand()
@is_me()
async def voting_end(self, interaction: nextcord.Interaction): async def voting_end(self, interaction: nextcord.Interaction):
""" """
tests the voting start action tests the voting start action
@@ -85,17 +97,42 @@ class TestCog(commands.Cog, name="Test commands."):
interaction (nextcord.Interaction): _description_ interaction (nextcord.Interaction): _description_
""" """
config: DakinyConfig = self.bot.config config: DakinyConfig = self.bot.config
cycle = ElectionCycle(get_current_cycle(config), config, self.bot.get_guild(config.params.guild_id)) cycle = ElectionCycle(
get_current_cycle(config),
config,
self.bot.get_guild(config.params.guild_id),
)
await cycle.voting_end_action() await cycle.voting_end_action()
@test.subcommand() @test.subcommand()
@is_me()
async def election_reminder(self, interaction: nextcord.Interaction): async def election_reminder(self, interaction: nextcord.Interaction):
config: DakinyConfig = self.bot.config config: DakinyConfig = self.bot.config
cycle = ElectionCycle(get_current_cycle(config), config, self.bot.get_guild(config.params.guild_id)) cycle = ElectionCycle(
get_current_cycle(config),
config,
self.bot.get_guild(config.params.guild_id),
)
await cycle.election_reminder() await cycle.election_reminder()
@test.subcommand() @test.subcommand()
@is_me()
async def daily(self, interaction: nextcord.Interaction): async def daily(self, interaction: nextcord.Interaction):
config: DakinyConfig = self.bot.config config: DakinyConfig = self.bot.config
cycle = ElectionCycle(get_current_cycle(config), config, self.bot.get_guild(config.params.guild_id)) cycle = ElectionCycle(
get_current_cycle(config),
config,
self.bot.get_guild(config.params.guild_id),
)
await cycle.check_date() await cycle.check_date()
@test.subcommand()
@is_me()
async def term_start(self, interaction: nextcord.Interaction):
config: DakinyConfig = self.bot.config
cycle = ElectionCycle(
get_current_cycle(config),
config,
self.bot.get_guild(config.params.guild_id),
)
await cycle.term_start_action()
+1
View File
@@ -22,6 +22,7 @@ class Params:
general_channel_id: int general_channel_id: int
guild_id: int guild_id: int
high_council_role_id: int high_council_role_id: int
voting_parent_id: int
@dataclass @dataclass
+1 -1
View File
@@ -1,6 +1,6 @@
CREATE TABLE ElectionInformation( CREATE TABLE ElectionInformation(
ElectionCycle varchar(30) not null unique, ElectionCycle varchar(30) not null unique,
ElectionChannel bigint unsigned not null, ThreadId bigint unsigned not null,
CouncilVoteMsgId bigint unsigned, CouncilVoteMsgId bigint unsigned,
PRIMARY KEY (ElectionCycle) PRIMARY KEY (ElectionCycle)
); );