discordrb 1.3.4 → 1.3.5

data/lib/discordrb/events/{channel-delete.rb → channel_delete.rb}

@@ -2,6 +2,7 @@ require 'discordrb/events/generic'
 require 'discordrb/data'
 
 module Discordrb::Events
+  # Raised when a channel is deleted
   class ChannelDeleteEvent
     attr_reader :type
     attr_reader :topic
@@ -22,20 +23,21 @@ module Discordrb::Events
     end
   end
 
+  # Event handler for ChannelDeleteEvent
   class ChannelDeleteEventHandler < EventHandler
     def matches?(event)
       # Check for the proper event type
       return false unless event.is_a? ChannelDeleteEvent
 
-      return [
-        matches_all(@attributes[:type], event.type) do |a,e|
+      [
+        matches_all(@attributes[:type], event.type) do |a, e|
           if a.is_a? String
             a == e.name
           else
             a == e
           end
         end,
-        matches_all(@attributes[:name], event.name) do |a,e|
+        matches_all(@attributes[:name], event.name) do |a, e|
           if a.is_a? String
             a == e.to_s
           else

data/lib/discordrb/events/{channel-update.rb → channel_update.rb}

@@ -2,6 +2,7 @@ require 'discordrb/events/generic'
 require 'discordrb/data'
 
 module Discordrb::Events
+  # Raised when a channel is updated (e.g. topic changes)
   class ChannelUpdateEvent
     attr_reader :type
     attr_reader :topic
@@ -18,25 +19,27 @@ module Discordrb::Events
       @name = data['name']
       @is_private = data['is_private']
       @server = bot.server(data['guild_id'].to_i)
-      return if !@server
+      return unless @server
+
       @channel = bot.channel(data['id'].to_i)
     end
   end
 
+  # Event handler for ChannelUpdateEvent
   class ChannelUpdateEventHandler < EventHandler
     def matches?(event)
       # Check for the proper event type
       return false unless event.is_a? ChannelUpdateEvent
 
-      return [
-        matches_all(@attributes[:type], event.type) do |a,e|
+      [
+        matches_all(@attributes[:type], event.type) do |a, e|
           if a.is_a? String
             a == e.name
           else
             a == e
           end
         end,
-        matches_all(@attributes[:name], event.name) do |a,e|
+        matches_all(@attributes[:name], event.name) do |a, e|
           if a.is_a? String
             a == e.to_s
           else

data/lib/discordrb/events/generic.rb

@@ -1,9 +1,14 @@
 require 'active_support/core_ext/module'
 
+# Events used by discordrb
 module Discordrb::Events
+  # A negated object, used to not match something in event parameters
   class Negated
     attr_reader :object
-    def initialize(object); @object = object; end
+
+    def initialize(object)
+      @object = object
+    end
   end
 
   def self.matches_all(attributes, to_check, &block)
@@ -17,9 +22,7 @@ module Discordrb::Events
     end
 
     # Second case: there's a single, not-negated attribute
-    unless attributes.is_a? Array
-      return yield(attributes, to_check)
-    end
+    return yield(attributes, to_check) unless attributes.is_a? Array
 
     # Third case: it's an array of attributes
     attributes.reduce(false) do |result, element|
@@ -27,14 +30,15 @@ module Discordrb::Events
     end
   end
 
+  # Generic event handler that can be extended
   class EventHandler
     def initialize(attributes, block)
       @attributes = attributes
       @block = block
     end
 
-    def matches?(event)
-      raise "Attempted to call matches?() from a generic EventHandler"
+    def matches?(_)
+      fail 'Attempted to call matches?() from a generic EventHandler'
     end
 
     def match(event)
@@ -48,7 +52,7 @@ module Discordrb::Events
 
   # Event handler that matches all events
   class TrueEventHandler < EventHandler
-    def matches?(event)
+    def matches?(_)
       true
     end
   end

data/lib/discordrb/events/{guild-member-update.rb → guild_member_update.rb}

@@ -2,6 +2,7 @@ require 'discordrb/events/generic'
 require 'discordrb/data'
 
 module Discordrb::Events
+  # Raised when a user updates on a server (e.g. new name)
   class GuildMemberUpdateEvent
     attr_reader :user
     attr_reader :roles
@@ -9,25 +10,26 @@ module Discordrb::Events
 
     def initialize(data, bot)
       @server = bot.server(data['guild_id'].to_i)
-      return if !@server
-      
+      return unless @server
+
       user_id = data['user']['id'].to_i
-      @user = @server.members.find {|u| u.id == user_id}
+      @user = @server.members.find { |u| u.id == user_id }
       @roles = []
       data['roles'].each do |element|
         role_id = element.to_i
-        @roles << @server.roles.find {|r| r.id == role_id}
+        @roles << @server.roles.find { |r| r.id == role_id }
       end
     end
   end
 
+  # Event handler for GuildMemberUpdateEvent
   class GuildMemberUpdateHandler < EventHandler
     def matches?(event)
       # Check for the proper event type
       return false unless event.is_a? GuildMemberUpdateEvent
 
-      return [
-        matches_all(@attributes[:name], event.name) do |a,e|
+      [
+        matches_all(@attributes[:name], event.name) do |a, e|
           if a.is_a? String
             a == e.to_s
           else

data/lib/discordrb/events/{guild-role-create.rb → guild_role_create.rb}

@@ -2,26 +2,28 @@ require 'discordrb/events/generic'
 require 'discordrb/data'
 
 module Discordrb::Events
+  # Raised when a role is created on a server
   class GuildRoleCreateEvent
     attr_reader :role
     attr_reader :server
 
     def initialize(data, bot)
       @server = bot.server(data['guild_id'].to_i)
-      return if !@server
-      
+      return unless @server
+
       role_id = data['role']['id'].to_i
-      @role = @server.roles.find {|r| r.id == role_id}
+      @role = @server.roles.find { |r| r.id == role_id }
     end
   end
 
+  # Event handler for GuildRoleCreateEvent
   class GuildRoleCreateEventHandler < EventHandler
     def matches?(event)
       # Check for the proper event type
       return false unless event.is_a? GuildRoleCreateEvent
 
-      return [
-        matches_all(@attributes[:name], event.name) do |a,e|
+      [
+        matches_all(@attributes[:name], event.name) do |a, e|
           if a.is_a? String
             a == e.to_s
           else

data/lib/discordrb/events/{guild-role-delete.rb → guild_role_delete.rb}

@@ -2,6 +2,7 @@ require 'discordrb/events/generic'
 require 'discordrb/data'
 
 module Discordrb::Events
+  # Raised when a role is deleted from a server
   class GuildRoleDeleteEvent
     attr_reader :id
     attr_reader :server
@@ -16,13 +17,14 @@ module Discordrb::Events
     end
   end
 
+  # EventHandler for GuildRoleDeleteEvent
   class GuildRoleDeleteEventHandler < EventHandler
     def matches?(event)
       # Check for the proper event type
       return false unless event.is_a? GuildRoleDeleteEvent
 
-      return [
-        matches_all(@attributes[:name], event.name) do |a,e|
+      [
+        matches_all(@attributes[:name], event.name) do |a, e|
           if a.is_a? String
             a == e.to_s
           else

data/lib/discordrb/events/{guild-role-update.rb → guild_role_update.rb}

@@ -2,26 +2,28 @@ require 'discordrb/events/generic'
 require 'discordrb/data'
 
 module Discordrb::Events
+  # Event raised when a role updates on a server
   class GuildRoleUpdateEvent
     attr_reader :role
     attr_reader :server
 
     def initialize(data, bot)
       @server = bot.server(data['guild_id'].to_i)
-      return if !@server
-      
+      return unless @server
+
       role_id = data['role']['id'].to_i
-      @role = @server.roles.find {|r| r.id == role_id}
+      @role = @server.roles.find { |r| r.id == role_id }
     end
   end
 
+  # Event handler for GuildRoleUpdateEvent
   class GuildRoleUpdateEventHandler < EventHandler
     def matches?(event)
       # Check for the proper event type
       return false unless event.is_a? GuildRoleUpdateEvent
 
-      return [
-        matches_all(@attributes[:name], event.name) do |a,e|
+      [
+        matches_all(@attributes[:name], event.name) do |a, e|
           if a.is_a? String
             a == e.to_s
           else

data/lib/discordrb/events/message.rb

@@ -1,6 +1,7 @@
 require 'discordrb/events/generic'
 
 module Discordrb::Events
+  # Event raised when a text message is sent to a channel
   class MessageEvent
     attr_reader :message
 
@@ -12,7 +13,9 @@ module Discordrb::Events
       @message = message
     end
 
-    def send_message(content); @message.channel.send_message(content); end
+    def send_message(content)
+      @message.channel.send_message(content)
+    end
 
     alias_method :user, :author
     alias_method :text, :content
@@ -20,26 +23,27 @@ module Discordrb::Events
     alias_method :respond, :send_message
   end
 
+  # Event handler for MessageEvent
   class MessageEventHandler < EventHandler
     def matches?(event)
       # Check for the proper event type
       return false unless event.is_a? MessageEvent
 
-      return [
-        matches_all(@attributes[:starting_with], event.content) { |a,e| e.start_with? a },
-        matches_all(@attributes[:ending_with], event.content) { |a,e| e.end_with? a },
-        matches_all(@attributes[:containing], event.content) { |a,e| e.include? a },
-        matches_all(@attributes[:in], event.channel) do |a,e|
+      [
+        matches_all(@attributes[:starting_with], event.content) { |a, e| e.start_with? a },
+        matches_all(@attributes[:ending_with], event.content) { |a, e| e.end_with? a },
+        matches_all(@attributes[:containing], event.content) { |a, e| e.include? a },
+        matches_all(@attributes[:in], event.channel) do |a, e|
           if a.is_a? String
             # Make sure to remove the "#" from channel names in case it was specified
-            a.gsub('#', '') == e.name
+            a.delete('#') == e.name
           elsif a.is_a? Fixnum
             a == e.id
           else
             a == e
           end
         end,
-        matches_all(@attributes[:from], event.author) do |a,e|
+        matches_all(@attributes[:from], event.author) do |a, e|
           if a.is_a? String
             a == e.name
           elsif a.is_a? Fixnum
@@ -48,9 +52,9 @@ module Discordrb::Events
             a == e
           end
         end,
-        matches_all(@attributes[:with_text], event.content) { |a,e| e == a },
-        matches_all(@attributes[:after], event.timestamp) { |a,e| a > e },
-        matches_all(@attributes[:before], event.timestamp) { |a,e| a < e }
+        matches_all(@attributes[:with_text], event.content) { |a, e| e == a },
+        matches_all(@attributes[:after], event.timestamp) { |a, e| a > e },
+        matches_all(@attributes[:before], event.timestamp) { |a, e| a < e }
       ].reduce(true, &:&)
     end
   end

data/lib/discordrb/events/presence.rb

@@ -2,6 +2,7 @@ require 'discordrb/events/generic'
 require 'discordrb/data'
 
 module Discordrb::Events
+  # Event raised when a user's presence state updates (playing game, idle or back online)
   class PresenceEvent
     attr_reader :server, :user, :status
 
@@ -12,13 +13,14 @@ module Discordrb::Events
     end
   end
 
+  # Event handler for PresenceEvent
   class PresenceEventHandler < EventHandler
     def matches?(event)
       # Check for the proper event type
       return false unless event.is_a? PresenceEvent
 
-      return [
-        matches_all(@attributes[:from], event.user) do |a,e|
+      [
+        matches_all(@attributes[:from], event.user) do |a, e|
           if a.is_a? String
             a == e.name
           elsif a.is_a? Fixnum
@@ -27,7 +29,7 @@ module Discordrb::Events
             a == e
           end
         end,
-        matches_all(@attributes[:status], event.status) do |a,e|
+        matches_all(@attributes[:status], event.status) do |a, e|
           if a.is_a? String
             a == e.to_s
           else

data/lib/discordrb/events/typing.rb

@@ -1,6 +1,7 @@
 require 'discordrb/events/generic'
 
 module Discordrb::Events
+  # Event raised when a user starts typing
   class TypingEvent
     attr_reader :channel, :user, :timestamp
 
@@ -13,22 +14,23 @@ module Discordrb::Events
     end
   end
 
+  # Event handler for TypingEvent
   class TypingEventHandler < EventHandler
     def matches?(event)
       # Check for the proper event type
       return false unless event.is_a? TypingEvent
 
-      return [
-        matches_all(@attributes[:in], event.channel) do |a,e|
+      [
+        matches_all(@attributes[:in], event.channel) do |a, e|
           if a.is_a? String
-            a.gsub('#', '') == e.name
+            a.delete('#') == e.name
           elsif a.is_a? Fixnum
             a == e.id
           else
             a == e
           end
         end,
-        matches_all(@attributes[:from], event.user) do |a,e|
+        matches_all(@attributes[:from], event.user) do |a, e|
           if a.is_a? String
             a == e.name
           elsif a.is_a? Fixnum
@@ -37,8 +39,8 @@ module Discordrb::Events
             a == e
           end
         end,
-        matches_all(@attributes[:after], event.timestamp) { |a,e| a > e },
-        matches_all(@attributes[:before], event.timestamp) { |a,e| a < e }
+        matches_all(@attributes[:after], event.timestamp) { |a, e| a > e },
+        matches_all(@attributes[:before], event.timestamp) { |a, e| a < e }
       ].reduce(true, &:&)
     end
   end

data/lib/discordrb/events/{voice-state-update.rb → voice_state_update.rb}

@@ -2,6 +2,7 @@ require 'discordrb/events/generic'
 require 'discordrb/data'
 
 module Discordrb::Events
+  # Event raised when a user's voice state updates
   class VoiceStateUpdateEvent
     attr_reader :user
     attr_reader :token
@@ -23,21 +24,21 @@ module Discordrb::Events
       @mute = data['mute']
       @deaf = data['deaf']
       @server = bot.server(data['guild_id'].to_i)
-      return if !@server
-      if data['channel_id']
-        @channel = bot.channel(data['channel_id'].to_i)
-      end
+      return unless @server
+
+      @channel = bot.channel(data['channel_id'].to_i) if data['channel_id']
       @user = bot.user(data['user_id'].to_i)
     end
   end
 
+  # Event handler for VoiceStateUpdateEvent
   class VoiceStateUpdateEventHandler < EventHandler
     def matches?(event)
       # Check for the proper event type
       return false unless event.is_a? VoiceStateUpdateEvent
 
-      return [
-        matches_all(@attributes[:from], event.user) do |a,e|
+      [
+        matches_all(@attributes[:from], event.user) do |a, e|
           if a.is_a? String
             a == e.name
           elsif a.is_a? Fixnum
@@ -46,35 +47,35 @@ module Discordrb::Events
             a == e
           end
         end,
-        matches_all(@attributes[:mute], event.mute) do |a,e|
+        matches_all(@attributes[:mute], event.mute) do |a, e|
           if a.is_a? Boolean
             a == e.to_s
           else
             a == e
           end
         end,
-        matches_all(@attributes[:deaf], event.deaf) do |a,e|
+        matches_all(@attributes[:deaf], event.deaf) do |a, e|
           if a.is_a? Boolean
             a == e.to_s
           else
             a == e
-          end          
+          end
         end,
-        matches_all(@attributes[:self_mute], event.self_mute) do |a,e|
+        matches_all(@attributes[:self_mute], event.self_mute) do |a, e|
           if a.is_a? Boolean
             a == e.to_s
           else
             a == e
           end
         end,
-        matches_all(@attributes[:self_deaf], event.self_deaf) do |a,e|
+        matches_all(@attributes[:self_deaf], event.self_deaf) do |a, e|
           if a.is_a? Boolean
             a == e.to_s
           else
             a == e
-          end          
+          end
         end,
-        matches_all(@attributes[:channel], event.channel) do |a,e|
+        matches_all(@attributes[:channel], event.channel) do |a, e|
           if a.is_a? String
             a == e.name
           elsif a.is_a? Fixnum