onyxcord 2.1.0 → 3.2.1

data/lib/onyxcord/events/guilds.rb

@@ -1,269 +1,5 @@
 # frozen_string_literal: true
 
-require 'onyxcord/events/generic'
-require 'onyxcord/data'
-
-module OnyxCord::Events
-  # Generic subclass for server events (create/update/delete)
-  class ServerEvent < Event
-    # @return [Server] the server in question.
-    attr_reader :server
-
-    # @!visibility private
-    def initialize(data, bot)
-      @bot = bot
-
-      init_server(data, bot)
-    end
-
-    # Initializes this event with server data. Should be overwritten in case the server doesn't exist at the time
-    # of event creation (e. g. {ServerDeleteEvent})
-    def init_server(data, bot)
-      @server = bot.server(data['id'].to_i)
-    end
-  end
-
-  # Generic event handler for member events
-  class ServerEventHandler < EventHandler
-    def matches?(event)
-      # Check for the proper event type
-      return false unless event.is_a? ServerEvent
-
-      [
-        matches_all(@attributes[:server], event.server) do |a, e|
-          a == case a
-               when String
-                 e.name
-               when Integer
-                 e.id
-               else
-                 e
-               end
-        end
-      ].reduce(true, &:&)
-    end
-  end
-
-  # Server is created
-  # @see OnyxCord::EventContainer#server_create
-  class ServerCreateEvent < ServerEvent; end
-
-  # Event handler for {ServerCreateEvent}
-  class ServerCreateEventHandler < ServerEventHandler; end
-
-  # Server is updated (e.g. name changed)
-  # @see OnyxCord::EventContainer#server_update
-  class ServerUpdateEvent < ServerEvent; end
-
-  # Event handler for {ServerUpdateEvent}
-  class ServerUpdateEventHandler < ServerEventHandler; end
-
-  # Server is deleted, the server was left because the bot was kicked, or the
-  # bot made itself leave the server.
-  # @see OnyxCord::EventContainer#server_delete
-  class ServerDeleteEvent < ServerEvent
-    # @return [Integer] The ID of the server that was left.
-    attr_reader :server
-
-    # @!visibility private
-    # @note Override init_server to account for the deleted server
-    def init_server(data, _bot)
-      @server = data['id'].to_i
-    end
-  end
-
-  # Event handler for {ServerDeleteEvent}
-  class ServerDeleteEventHandler < ServerEventHandler; end
-
-  # Emoji is created/deleted/updated
-  class ServerEmojiChangeEvent < ServerEvent
-    # @return [Server] the server in question.
-    attr_reader :server
-
-    # @return [Array<Emoji>] array of emojis.
-    attr_reader :emoji
-
-    # @!visibility private
-    def initialize(server, data, bot)
-      @bot = bot
-      @server = server
-      process_emoji(data)
-    end
-
-    # @!visibility private
-    def process_emoji(data)
-      @emoji = data['emojis'].map do |e|
-        @server.emoji[e['id']]
-      end
-    end
-  end
-
-  # Generic event helper for when an emoji is either created or deleted
-  class ServerEmojiCDEvent < ServerEvent
-    # @return [Server] the server in question.
-    attr_reader :server
-
-    # @return [Emoji] the emoji data.
-    attr_reader :emoji
-
-    # @!visibility private
-    def initialize(server, emoji, bot)
-      @bot = bot
-      @emoji = emoji
-      @server = server
-    end
-  end
-
-  # Emoji is created
-  class ServerEmojiCreateEvent < ServerEmojiCDEvent; end
-
-  # Emoji is deleted
-  class ServerEmojiDeleteEvent < ServerEmojiCDEvent; end
-
-  # Emoji is updated
-  class ServerEmojiUpdateEvent < ServerEvent
-    # @return [Server] the server in question.
-    attr_reader :server
-
-    # @return [Emoji, nil] the emoji data before the event.
-    attr_reader :old_emoji
-
-    # @return [Emoji, nil] the updated emoji data.
-    attr_reader :emoji
-
-    # @!visibility private
-    def initialize(server, old_emoji, emoji, bot)
-      @bot = bot
-      @old_emoji = old_emoji
-      @emoji = emoji
-      @server = server
-    end
-  end
-
-  # Event handler for {ServerEmojiChangeEvent}
-  class ServerEmojiChangeEventHandler < ServerEventHandler; end
-
-  # Generic handler for emoji create and delete
-  class ServerEmojiCDEventHandler < ServerEventHandler
-    def matches?(event)
-      # Check for the proper event type
-      return false unless event.is_a? ServerEmojiCDEvent
-
-      [
-        matches_all(@attributes[:server], event.server) do |a, e|
-          a == case a
-               when String
-                 e.name
-               when Integer
-                 e.id
-               else
-                 e
-               end
-        end,
-        matches_all(@attributes[:id], event.emoji.id) { |a, e| a.resolve_id == e.resolve_id },
-        matches_all(@attributes[:name], event.emoji.name) { |a, e| a == e }
-      ].reduce(true, &:&)
-    end
-  end
-
-  # Event handler for {ServerEmojiCreateEvent}
-  class ServerEmojiCreateEventHandler < ServerEmojiCDEventHandler; end
-
-  # Event handler for {ServerEmojiDeleteEvent}
-  class ServerEmojiDeleteEventHandler < ServerEmojiCDEventHandler; end
-
-  # Event handler for {ServerEmojiUpdateEvent}
-  class ServerEmojiUpdateEventHandler < EventHandler
-    def matches?(event)
-      # Check for the proper event type
-      return false unless event.is_a? ServerEmojiUpdateEvent
-
-      [
-        matches_all(@attributes[:server], event.server) do |a, e|
-          a == case a
-               when String
-                 e.name
-               when Integer
-                 e.id
-               else
-                 e
-               end
-        end,
-        matches_all(@attributes[:id], event.old_emoji.id) { |a, e| a.resolve_id == e.resolve_id },
-        matches_all(@attributes[:old_name], event.old_emoji.name) { |a, e| a == e },
-        matches_all(@attributes[:name], event.emoji.name) { |a, e| a == e }
-      ].reduce(true, &:&)
-    end
-  end
-
-  # Raised whenever an audit log entry is created.
-  class AuditLogEntryCreateEvent < Event
-    # @return [Server] the server of the audit log event.
-    attr_reader :server
-
-    # @return [AuditLogs::Entry] the entry of the audit log event.
-    attr_reader :entry
-
-    # @return [Integer] the raw action type of the audit log entry.
-    attr_reader :action
-
-    # @return [Integer] the ID of the user or bot that made the entry.
-    attr_reader :user_id
-
-    # @return [Integer, nil] the ID of the affected webhook, user, etc.
-    attr_reader :target_id
-
-    # @!visibility private
-    def initialize(data, bot)
-      @bot = bot
-      @action = data['action_type']
-      @user_id = data['user_id']&.to_i
-      @target_id = data['target_id']&.to_i
-      @server = bot.server(data['guild_id'].to_i)
-      @entry = OnyxCord::AuditLogs::Entry.new(nil, @server, @bot, data)
-    end
-  end
-
-  # Event handler for GUILD_AUDIT_LOG_ENTRY_CREATE events.
-  class AuditLogEntryCreateEventHandler < EventHandler
-    # @!visibility private
-    def matches?(event)
-      # Check for the proper event type.
-      return false unless event.is_a?(AuditLogEntryCreateEvent)
-
-      [
-        matches_all(@attributes[:action], event) do |a, e|
-          case a
-          when Numeric
-            a == e.action
-          when String, Symbol
-            a.to_sym == e.entry.action
-          end
-        end,
-
-        matches_all(@attributes[:reason], event.entry) do |a, e|
-          if e.reason
-            case a
-            when String
-              a == e.reason
-            when Regexp
-              a.match?(e.reason)
-            end
-          end
-        end,
-
-        matches_all(@attributes[:user], event.user_id) do |a, e|
-          a&.resolve_id == e&.resolve_id
-        end,
-
-        matches_all(@attributes[:server], event.server) do |a, e|
-          a&.resolve_id == e&.resolve_id
-        end,
-
-        matches_all(@attributes[:target], event.target_id) do |a, e|
-          a&.resolve_id == e&.resolve_id
-        end
-      ].reduce(true, &:&)
-    end
-  end
-end
+require 'onyxcord/events/guilds/base'
+require 'onyxcord/events/guilds/emoji'
+require 'onyxcord/events/guilds/audit_logs'

data/lib/onyxcord/events/handlers/channels.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module OnyxCord
+  module EventContainer
+    # This **event** is raised when a channel is created.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [Integer] :type Matches the type of channel that is being created (0: text, 1: private, 2: voice, 3: group)
+    # @option attributes [String] :name Matches the name of the created channel.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ChannelCreateEvent] The event that was raised.
+    # @return [ChannelCreateEventHandler] the event handler that was registered.
+    def channel_create(attributes = {}, &block)
+      register_event(ChannelCreateEvent, attributes, block)
+    end
+
+    # This **event** is raised when a channel is updated.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [Integer] :type Matches the type of channel that is being updated (0: text, 1: private, 2: voice, 3: group).
+    # @option attributes [String] :name Matches the new name of the channel.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ChannelUpdateEvent] The event that was raised.
+    # @return [ChannelUpdateEventHandler] the event handler that was registered.
+
+    # This **event** is raised when a channel is updated.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [Integer] :type Matches the type of channel that is being updated (0: text, 1: private, 2: voice, 3: group).
+    # @option attributes [String] :name Matches the new name of the channel.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ChannelUpdateEvent] The event that was raised.
+    # @return [ChannelUpdateEventHandler] the event handler that was registered.
+    def channel_update(attributes = {}, &block)
+      register_event(ChannelUpdateEvent, attributes, block)
+    end
+
+    # This **event** is raised when a channel is deleted.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [Integer] :type Matches the type of channel that is being deleted (0: text, 1: private, 2: voice, 3: group).
+    # @option attributes [String] :name Matches the name of the deleted channel.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ChannelDeleteEvent] The event that was raised.
+    # @return [ChannelDeleteEventHandler] the event handler that was registered.
+
+    # This **event** is raised when a channel is deleted.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [Integer] :type Matches the type of channel that is being deleted (0: text, 1: private, 2: voice, 3: group).
+    # @option attributes [String] :name Matches the name of the deleted channel.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ChannelDeleteEvent] The event that was raised.
+    # @return [ChannelDeleteEventHandler] the event handler that was registered.
+    def channel_delete(attributes = {}, &block)
+      register_event(ChannelDeleteEvent, attributes, block)
+    end
+
+    # This **event** is raised when a recipient is added to a group channel.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String] :name Matches the name of the group channel that the recipient is added to.
+    # @option attributes [String, Integer] :owner_id Matches the ID of the group channel's owner.
+    # @option attributes [String, Integer] :id Matches the ID of the recipient added to the group channel.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ChannelRecipientAddEvent] The event that was raised.
+    # @return [ChannelRecipientAddHandler] the event handler that was registered.
+
+    # This **event** is raised when a recipient is added to a group channel.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String] :name Matches the name of the group channel that the recipient is added to.
+    # @option attributes [String, Integer] :owner_id Matches the ID of the group channel's owner.
+    # @option attributes [String, Integer] :id Matches the ID of the recipient added to the group channel.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ChannelRecipientAddEvent] The event that was raised.
+    # @return [ChannelRecipientAddHandler] the event handler that was registered.
+    def channel_recipient_add(attributes = {}, &block)
+      register_event(ChannelRecipientAddEvent, attributes, block)
+    end
+
+    # This **event** is raised when a recipient is removed from a group channel.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String] :name Matches the name of the group channel that the recipient is added to.
+    # @option attributes [String, Integer] :owner_id Matches the ID of the group channel's owner.
+    # @option attributes [String, Integer] :id Matches the ID of the recipient removed from the group channel.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ChannelRecipientRemoveEvent] The event that was raised.
+    # @return [ChannelRecipientRemoveHandler] the event handler that was registered.
+
+    # This **event** is raised when a recipient is removed from a group channel.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String] :name Matches the name of the group channel that the recipient is added to.
+    # @option attributes [String, Integer] :owner_id Matches the ID of the group channel's owner.
+    # @option attributes [String, Integer] :id Matches the ID of the recipient removed from the group channel.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ChannelRecipientRemoveEvent] The event that was raised.
+    # @return [ChannelRecipientRemoveHandler] the event handler that was registered.
+    def channel_recipient_remove(attributes = {}, &block)
+      register_event(ChannelRecipientRemoveEvent, attributes, block)
+    end
+
+    # This **event** is raised when a user's voice state changes. This includes when a user joins, leaves, or
+    # moves between voice channels, as well as their mute and deaf status for themselves and on the server.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, User] :from Matches the user that raised the event.
+    # @option attributes [String, Integer, Channel] :channel Matches the voice channel the user has joined.
+    # @option attributes [String, Integer, Channel] :old_channel Matches the voice channel the user was in previously.
+    # @option attributes [true, false] :mute Matches whether or not the user is muted server-wide.
+    # @option attributes [true, false] :deaf Matches whether or not the user is deafened server-wide.
+    # @option attributes [true, false] :self_mute Matches whether or not the user is muted by the bot.
+    # @option attributes [true, false] :self_deaf Matches whether or not the user is deafened by the bot.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [VoiceStateUpdateEvent] The event that was raised.
+    # @return [VoiceStateUpdateEventHandler] the event handler that was registered.
+
+    # This **event** is raised whenever a message is pinned or unpinned.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer, Channel] :channel A channel to match against.
+    # @option attributes [String, Integer, Server] :server A server to match against.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [ChannelPinsUpdateEvent] The event that was raised.
+    # @return [ChannelPinsUpdateEventHandler] The event handler that was registered.
+    def channel_pins_update(attributes = {}, &block)
+      register_event(ChannelPinsUpdateEvent, attributes, block)
+    end
+
+    # This **event** is raised whenever an autocomplete interaction is created.
+    # @param name [String, Symbol, nil] An option name to match against.
+    # @param attributes [Hash] The event's attributes.
+    # @option attributes [String, Integer] :command_id A command ID to match against.
+    # @option attributes [String, Symbol] :subcommand A subcommand name to match against.
+    # @option attributes [String, Symbol] :subcommand_group A subcommand group to match against.
+    # @option attributes [String, Symbol] :command_name A command name to match against.
+    # @option attributes [String, Integer, Server] :server A server to match against.
+    # @yield The block is executed when the event is raised.
+    # @yieldparam event [AutocompleteEvent] The event that was raised.
+    # @return [AutocompleteEventHandler] The event handler that was registered.
+  end
+end

data/lib/onyxcord/events/handlers/core.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+module OnyxCord
+  module EventContainer
+    # Removes an event handler from this container. If you're looking for a way to do temporary events, I recommend
+    # {Await}s instead of this.
+    # @param handler [OnyxCord::Events::EventHandler] The handler to remove.
+    def remove_handler(handler)
+      if handler.is_a?(OnyxCord::Events::RawDispatchHandler)
+        @raw_handlers&.delete(handler)
+        return
+      end
+
+      clazz = EventContainer.event_class(handler.class)
+      @event_handlers ||= {}
+      @event_handlers[clazz].delete(handler)
+    end
+
+    # Remove an application command handler
+    # @param name [String, Symbol] The name of the command handler to remove.
+
+    # Remove an application command handler
+    # @param name [String, Symbol] The name of the command handler to remove.
+    def remove_application_command_handler(name)
+      @application_commands.delete(name)
+    end
+
+    # Removes all events from this event handler.
+
+    # Removes all events from this event handler.
+    def clear!
+      @event_handlers&.clear
+      @raw_handlers&.clear
+      @application_commands&.clear
+    end
+
+    # Adds an event handler to this container. Usually, it's more expressive to just use one of the shorthand adder
+    # methods like {#message}, but if you want to create one manually you can use this.
+    # @param handler [OnyxCord::Events::EventHandler] The handler to add.
+
+    # Adds an event handler to this container. Usually, it's more expressive to just use one of the shorthand adder
+    # methods like {#message}, but if you want to create one manually you can use this.
+    # @param handler [OnyxCord::Events::EventHandler] The handler to add.
+    def add_handler(handler)
+      clazz = EventContainer.event_class(handler.class)
+      @event_handlers ||= {}
+      @event_handlers[clazz] ||= []
+      @event_handlers[clazz] << handler
+    end
+
+    # Adds all event handlers from another container into this one. Existing event handlers will be overwritten.
+    # @param container [Module] A module that `extend`s {EventContainer} from which the handlers will be added.
+
+    # Adds all event handlers from another container into this one. Existing event handlers will be overwritten.
+    # @param container [Module] A module that `extend`s {EventContainer} from which the handlers will be added.
+    def include_events(container)
+      application_command_handlers = container.instance_variable_get(:@application_commands)
+      handlers = container.instance_variable_get :@event_handlers
+      raw_handlers = container.instance_variable_get(:@raw_handlers)
+      return unless handlers || application_command_handlers || raw_handlers
+
+      @event_handlers ||= {}
+      @event_handlers.merge!(handlers || {}) { |_, old, new| old + new }
+
+      @raw_handlers ||= []
+      @raw_handlers.concat(raw_handlers || [])
+
+      @application_commands ||= {}
+
+      @application_commands.merge!(application_command_handlers || {}) do |_, old, new|
+        old.subcommands.merge!(new.subcommands)
+        old
+      end
+    end
+
+    alias_method :include!, :include_events
+    alias_method :<<, :add_handler
+
+    # Returns the handler class for an event class type
+    # @see #event_class
+    # @param event_class [Class] The event type
+    # @return [Class] the handler type
+
+    # Returns the handler class for an event class type
+    # @see #event_class
+    # @param event_class [Class] The event type
+    # @return [Class] the handler type
+    def self.handler_class(event_class)
+      class_from_string("#{event_class}Handler")
+    end
+
+    # Returns the event class for a handler class type
+    # @see #handler_class
+    # @param handler_class [Class] The handler type
+    # @return [Class, nil] the event type, or nil if the handler_class isn't a handler class (i.e. ends with Handler)
+
+    # Returns the event class for a handler class type
+    # @see #handler_class
+    # @param handler_class [Class] The handler type
+    # @return [Class, nil] the event type, or nil if the handler_class isn't a handler class (i.e. ends with Handler)
+    def self.event_class(handler_class)
+      class_name = handler_class.to_s
+      return nil unless class_name.end_with? 'Handler'
+
+      EventContainer.class_from_string(class_name[0..-8])
+    end
+
+    # Utility method to return a class object from a string of its name. Mostly useful for internal stuff
+    # @param str [String] The name of the class
+    # @return [Class] the class
+
+    # Utility method to return a class object from a string of its name. Mostly useful for internal stuff
+    # @param str [String] The name of the class
+    # @return [Class] the class
+    def self.class_from_string(str)
+      str.split('::').inject(Object) do |mod, class_name|
+        mod.const_get(class_name)
+      end
+    end
+
+    private
+
+    include OnyxCord::Events
+
+    # @return [EventHandler]
+
+    # @return [EventHandler]
+    def register_event(clazz, attributes, block)
+      handler = EventContainer.handler_class(clazz).new(attributes, block)
+
+      @event_handlers ||= {}
+      @event_handlers[clazz] ||= []
+      @event_handlers[clazz] << handler
+
+      # Return the handler so it can be removed later
+      handler
+    end
+
+    def register_raw_handler(filter, block)
+      handler = OnyxCord::Events::RawDispatchHandler.new(filter, block)
+      @raw_handlers ||= []
+      @raw_handlers << handler
+      handler
+    end
+  end
+end