discordrb 1.3.4 → 1.3.5

data/lib/discordrb/commands/{command-bot.rb → command_bot.rb}

@@ -6,6 +6,7 @@ require 'discordrb/commands/events'
 # Specialized bot to run commands
 
 module Discordrb::Commands
+  # Bot that supports commands and command chains
   class CommandBot < Discordrb::Bot
     attr_reader :attributes, :prefix
 
@@ -51,34 +52,29 @@ module Discordrb::Commands
         users: {}
       }
 
-      if @attributes[:help_command]
-        command(@attributes[:help_command], max_args: 1, description: 'Shows a list of all the commands available or displays help for a specific command.', usage: 'help [command name]') do |event, command_name|
-          if command_name
-            command = @commands[command_name.to_sym]
-            unless command
-              return "The command `#{command_name}` does not exist!"
+      return unless @attributes[:help_command]
+      command(@attributes[:help_command], max_args: 1, description: 'Shows a list of all the commands available or displays help for a specific command.', usage: 'help [command name]') do |event, command_name|
+        if command_name
+          command = @commands[command_name.to_sym]
+          return "The command `#{command_name}` does not exist!" unless command
+          desc = command.attributes[:description] || '*No description available*'
+          usage = command.attributes[:usage]
+          result = "**`#{command_name}`**: #{desc}"
+          result << "\nUsage: `#{usage}`" if usage
+        else
+          available_commands = @commands.values.reject { |c| !c.attributes[:help_available] }
+          case available_commands.length
+          when 0..5
+            available_commands.reduce "**List of commands:**\n" do |memo, c|
+              memo + "**`#{c.name}`**: #{c.attributes[:description] || '*No description available*'}\n"
             end
-            desc = command.attributes[:description] || '*No description available*'
-            usage = command.attributes[:usage]
-            result = "**`#{command_name}`**: #{desc}"
-            result << "\nUsage: `#{usage}`" if usage
+          when 5..50
+            (available_commands.reduce "**List of commands:**\n" do |memo, c|
+              memo + "`#{c.name}`, "
+            end)[0..-3]
           else
-            available_commands = @commands.values.reject { |command| !command.attributes[:help_available] }
-            case available_commands.length
-            when 0..5
-              available_commands.reduce "**List of commands:**\n" do |memo, command|
-                memo + "**`#{command.name}`**: #{command.attributes[:description] || '*No description available*'}\n"
-              end
-            when 5..50
-              (available_commands.reduce "**List of commands:**\n" do |memo, command|
-                memo + "`#{command.name}`, "
-              end)[0..-3]
-            else
-              event.user.pm (available_commands.reduce "**List of commands:**\n" do |memo, command|
-                memo + "`#{command.name}`, "
-              end)[0..-3]
-              "Sending list in PM!"
-            end
+            event.user.pm(available_commands.reduce("**List of commands:**\n") { |a, e| a + "`#{e.name}`, " })[0..-3]
+            'Sending list in PM!'
           end
         end
       end
@@ -114,19 +110,18 @@ module Discordrb::Commands
       message = Discordrb::Message.new(data, self)
       event = CommandEvent.new(message, self)
 
-      if message.content.start_with? @prefix
-        chain = message.content[@prefix.length..-1]
-
-        if chain.strip.empty?
-          debug("Chain is empty")
-          return
-        end
+      return unless message.content.start_with? @prefix
+      chain = message.content[@prefix.length..-1]
 
-        debug("Parsing command chain #{chain}")
-        result = (@attributes[:advanced_functionality]) ? CommandChain.new(chain, self).execute(event) : simple_execute(chain, event)
-        result = event.saved_message + (result || '')
-        event.respond result if result
+      if chain.strip.empty?
+        debug('Chain is empty')
+        return
       end
+
+      debug("Parsing command chain #{chain}")
+      result = (@attributes[:advanced_functionality]) ? CommandChain.new(chain, self).execute(event) : simple_execute(chain, event)
+      result = event.saved_message + (result || '')
+      event.respond result if result
     end
 
     def set_user_permission(id, level)

data/lib/discordrb/commands/events.rb

@@ -1,6 +1,7 @@
 require 'discordrb/events/message'
 
 module Discordrb::Commands
+  # Extension of MessageEvent for commands that contains the command called, makes the bot readable and adds a message to be saved
   class CommandEvent < Discordrb::Events::MessageEvent
     attr_reader :bot, :saved_message
     attr_accessor :command

data/lib/discordrb/commands/parser.rb

@@ -1,4 +1,5 @@
 module Discordrb::Commands
+  # Command that can be called in a chain
   class Command
     attr_reader :attributes, :name
 
@@ -51,6 +52,7 @@ module Discordrb::Commands
     end
   end
 
+  # Command chain, may have multiple commands, nested and commands
   class CommandChain
     def initialize(chain, bot, subchain = false)
       @attributes = bot.attributes
@@ -60,7 +62,8 @@ module Discordrb::Commands
     end
 
     def execute_bare(event)
-      b_start, b_level = -1, 0
+      b_start = -1
+      b_level = 0
       result = ''
       quoted = false
       hacky_delim, hacky_space, hacky_prev = [0xe001, 0xe002, 0xe003].pack('U*').chars
@@ -100,14 +103,12 @@ module Discordrb::Commands
 
         result << char if b_level <= 0
 
-        if char == @attributes[:sub_chain_end] && !quoted
-          b_level -= 1
-          if b_level == 0
-            nested = @chain[b_start + 1 .. index - 1]
-            subchain = CommandChain.new(nested, @bot, true)
-            result << subchain.execute(event)
-          end
-        end
+        next unless char == @attributes[:sub_chain_end] && !quoted
+        b_level -= 1
+        next unless b_level == 0
+        nested = @chain[b_start + 1..index - 1]
+        subchain = CommandChain.new(nested, @bot, true)
+        result << subchain.execute(event)
       end
 
       event.respond("Your subchains are mismatched! Make sure you don't have any extra #{@attributes[:sub_chain_start]}'s or #{@attributes[:sub_chain_end]}'s") unless b_level == 0
@@ -135,8 +136,8 @@ module Discordrb::Commands
         command.gsub! hacky_delim, @attributes[:chain_delimiter]
 
         first_space = command.index ' '
-        command_name = first_space ? command[0..first_space-1] : command
-        arguments = first_space ? command[first_space+1..-1] : ''
+        command_name = first_space ? command[0..first_space - 1] : command
+        arguments = first_space ? command[first_space + 1..-1] : ''
 
         # Append a previous sign if none is present
         arguments << @attributes[:previous] unless arguments.include? @attributes[:previous]
@@ -161,7 +162,7 @@ module Discordrb::Commands
 
     def execute(event)
       old_chain = @chain
-      @bot.debug "Executing bare chain"
+      @bot.debug 'Executing bare chain'
       result = execute_bare(event)
 
       @chain_args ||= []
@@ -179,7 +180,7 @@ module Discordrb::Commands
           end
 
           result = new_result
-        # TODO: more chain arguments
+          # TODO: more chain arguments
         end
       end
 
@@ -201,7 +202,7 @@ module Discordrb::Commands
           arg.split ' '
         end
 
-        chain = chain[chain_args_index+1..-1]
+        chain = chain[chain_args_index + 1..-1]
       end
 
       [chain_args, chain]

data/lib/discordrb/data.rb

@@ -6,6 +6,7 @@ require 'discordrb/api'
 require 'discordrb/games'
 
 module Discordrb
+  # User on Discord, including internal data like discriminators
   class User
     attr_reader :username, :id, :discriminator, :avatar
 
@@ -76,11 +77,11 @@ module Discordrb
     # Determine if the user has permission to do an action
     # action is a permission from Permissions::Flags.
     # channel is the channel in which the action takes place (not applicable for server-wide actions).
-    def has_permission?(action, server, channel = nil)
+    def permission?(action, server, channel = nil)
       # For each role, check if
       #   (1) the channel explicitly allows or permits an action for the role and
       #   (2) if the user is allowed to do the action if the channel doesn't specify
-      return false if !@roles[server.id]
+      return false unless @roles[server.id]
 
       @roles[server.id].reduce(false) do |can_act, role|
         channel_allow = nil
@@ -91,28 +92,29 @@ module Discordrb
             channel_allow = true
           elsif deny.instance_variable_get("@#{action}")
             channel_allow = false
-          # else
-          #   If the channel has nothing to say on the matter, we can defer to the role itself
           end
+          # If the channel has nothing to say on the matter, we can defer to the role itself
         end
         if channel_allow == false
-          can_act = can_act || false
+          can_act = false
         elsif channel_allow == true
           can_act = true
         else # channel_allow == nil
           can_act = role.permissions.instance_variable_get("@#{action}") || can_act
         end
+        can_act
       end
     end
 
     # Define methods for querying permissions
     Discordrb::Permissions::Flags.each_value do |flag|
       define_method "can_#{flag}?" do |server, channel = nil|
-        has_permission? flag, server, channel
+        permission? flag, server, channel
       end
     end
   end
 
+  # A Discord role that contains permissions and applies to certain users
   class Role
     attr_reader :permissions
     attr_reader :name
@@ -121,6 +123,8 @@ module Discordrb
     attr_reader :color
 
     def initialize(data, bot, server = nil)
+      @bot = bot
+      @server = server
       @permissions = Permissions.new(data['permissions'])
       @name = data['name']
       @id = data['id'].to_i
@@ -136,6 +140,7 @@ module Discordrb
     end
   end
 
+  # A Discord channel, including data like the topic
   class Channel
     attr_reader :name, :server, :type, :id, :is_private, :recipient, :topic, :position
 
@@ -144,7 +149,7 @@ module Discordrb
     def initialize(data, bot, server = nil)
       @bot = bot
 
-      #data is a sometimes a Hash and othertimes an array of Hashes, you only want the last one if it's an array
+      # data is a sometimes a Hash and othertimes an array of Hashes, you only want the last one if it's an array
       data = data[-1] if data.is_a?(Array)
 
       @id = data['id'].to_i
@@ -159,20 +164,19 @@ module Discordrb
       else
         @name = data['name']
         @server = bot.server(data['guild_id'].to_i)
-        @server = server if !@server
+        @server ||= server
       end
 
       # Populate permission overwrites
       @permission_overwrites = {}
-      if data['permission_overwrites']
-        data['permission_overwrites'].each do |element|
-          role_id = element['id'].to_i
-          deny = Permissions.new(element['deny'])
-          allow = Permissions.new(element['allow'])
-          @permission_overwrites[role_id] = OpenStruct.new
-          @permission_overwrites[role_id].deny = deny
-          @permission_overwrites[role_id].allow = allow
-        end
+      return unless data['permission_overwrites']
+      data['permission_overwrites'].each do |element|
+        role_id = element['id'].to_i
+        deny = Permissions.new(element['deny'])
+        allow = Permissions.new(element['allow'])
+        @permission_overwrites[role_id] = OpenStruct.new
+        @permission_overwrites[role_id].deny = deny
+        @permission_overwrites[role_id].allow = allow
       end
     end
 
@@ -214,12 +218,10 @@ module Discordrb
     # List of users currently in a channel
     def users
       if @type == 'text'
-        @server.members.select {|u| u.status != :offline }
+        @server.members.select { |u| u.status != :offline }
       else
         @server.members.select do |user|
-          if user.voice_channel
-            user.voice_channel.id == @id
-          end
+          user.voice_channel.id == @id if user.voice_channel
         end
       end
     end
@@ -238,6 +240,7 @@ module Discordrb
     end
   end
 
+  # A message on Discord that was sent to a text channel
   class Message
     attr_reader :content, :author, :channel, :timestamp, :id, :mentions
     alias_method :user, :author
@@ -271,6 +274,7 @@ module Discordrb
     end
   end
 
+  # A server on Discord
   class Server
     attr_reader :region, :name, :owner_id, :id, :members
 
@@ -304,8 +308,8 @@ module Discordrb
         @members << user
         members_by_id[user.id] = user
         user_roles = []
-        element['roles'].each do |element|
-          role_id = element.to_i
+        element['roles'].each do |e|
+          role_id = e.to_i
           user_roles << roles_by_id[role_id]
         end
         user.update_roles(self, user_roles)
@@ -314,13 +318,12 @@ module Discordrb
       # Update user statuses with presence info
       if data['presences']
         data['presences'].each do |element|
-          if element['user']
-            user_id = element['user']['id'].to_i
-            user = members_by_id[user_id]
-            if user
-              user.status = element['status'].to_sym
-              user.game = Discordrb::Games.find_game(element['game_id'])
-            end
+          next unless element['user']
+          user_id = element['user']['id'].to_i
+          user = members_by_id[user_id]
+          if user
+            user.status = element['status'].to_sym
+            user.game = Discordrb::Games.find_game(element['game_id'])
           end
         end
       end
@@ -336,23 +339,18 @@ module Discordrb
         end
       end
 
-      if data['voice_states']
-        data['voice_states'].each do |element|
-          user_id = element['user_id'].to_i
-          user = members_by_id[user_id]
-          if user
-            user.server_mute = element['mute']
-            user.server_deaf = element['deaf']
-            user.self_mute = element['self_mute']
-            user.self_mute = element['self_mute']
-            channel_id = element['channel_id']
-            channel = nil
-            if channel_id
-              channel = channels_by_id[channel_id]
-            end
-            user.move(channel)
-          end
-        end
+      return unless data['voice_states']
+      data['voice_states'].each do |element|
+        user_id = element['user_id'].to_i
+        user = members_by_id[user_id]
+        next unless user
+        user.server_mute = element['mute']
+        user.server_deaf = element['deaf']
+        user.self_mute = element['self_mute']
+        user.self_mute = element['self_mute']
+        channel_id = element['channel_id']
+        channel = channel_id ? channels_by_id[channel_id] : nil
+        user.move(channel)
       end
     end
 
@@ -361,13 +359,13 @@ module Discordrb
     end
 
     def delete_role(role_id)
-      @roles.reject! {|r| r.id == role_id}
+      @roles.reject! { |r| r.id == role_id }
       @members.each do |user|
-        new_roles = user.roles.reject {|r| r.id == role_id}
+        new_roles = user.roles.reject { |r| r.id == role_id }
         user.update_roles(self, new_roles)
       end
       @channels.each do |channel|
-        overwrites = channel.permission_overwrites.reject {|id, perm| id == role_id}
+        overwrites = channel.permission_overwrites.reject { |id, _| id == role_id }
         channel.update_overwrites(overwrites)
       end
     end
@@ -378,6 +376,7 @@ module Discordrb
     end
   end
 
+  # A colour (red, green and blue values). Used for role colours
   class ColorRGB
     attr_reader :red, :green, :blue
 

data/lib/discordrb/events/{channel-create.rb → channel_create.rb}

@@ -1,48 +1,50 @@
-require 'discordrb/events/generic'
-require 'discordrb/data'
-
-module Discordrb::Events
-  class ChannelCreateEvent
-    attr_reader :type
-    attr_reader :topic
-    attr_reader :position
-    attr_reader :name
-    attr_reader :is_private
-    attr_reader :id
-    attr_reader :server
-
-    def initialize(data, bot)
-      @type = data['type']
-      @topic = data['topic']
-      @position = data['position']
-      @name = data['name']
-      @is_private = data['is_private']
-      @id = data['id']
-      @server = bot.server(data['guild_id'].to_i)
-    end
-  end
-
-  class ChannelCreateEventHandler < EventHandler
-    def matches?(event)
-      # Check for the proper event type
-      return false unless event.is_a? ChannelCreateEvent
-
-      return [
-        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|
-          if a.is_a? String
-            a == e.to_s
-          else
-            a == e
-          end
-        end
-      ].reduce(true, &:&)
-    end
-  end
-end
+require 'discordrb/events/generic'
+require 'discordrb/data'
+
+module Discordrb::Events
+  # Raised when a channel is created
+  class ChannelCreateEvent
+    attr_reader :type
+    attr_reader :topic
+    attr_reader :position
+    attr_reader :name
+    attr_reader :is_private
+    attr_reader :id
+    attr_reader :server
+
+    def initialize(data, bot)
+      @type = data['type']
+      @topic = data['topic']
+      @position = data['position']
+      @name = data['name']
+      @is_private = data['is_private']
+      @id = data['id']
+      @server = bot.server(data['guild_id'].to_i)
+    end
+  end
+
+  # Event handler for ChannelCreateEvent
+  class ChannelCreateEventHandler < EventHandler
+    def matches?(event)
+      # Check for the proper event type
+      return false unless event.is_a? ChannelCreateEvent
+
+      [
+        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|
+          if a.is_a? String
+            a == e.to_s
+          else
+            a == e
+          end
+        end
+      ].reduce(true, &:&)
+    end
+  end
+end