Applying style guide to code.

Author: AllInOneMighty

Broker.lua

@@ -9,7 +9,7 @@ local function OnBrokerTooltipShow(tt)
     tt:AddLine(Elephant.L['activefilters'])
 
     local filter
-    for _,filter in pairs(Elephant.db.profile.filters) do
+    for _, filter in pairs(Elephant.db.profile.filters) do
       tt:AddLine("  " .. filter, 1.0, 1.0, 1.0, 1.0)
     end
 

Event.lua

@@ -7,11 +7,11 @@ color does not exist.
 ]]
 local function GetClassColorByGUID(guid)
   if guid and guid ~= "" then
-    local _, englishClass = GetPlayerInfoByGUID(guid)
-    if englishClass then
-      local classColorTable = RAID_CLASS_COLORS[englishClass];
-      if classColorTable then
-        return Elephant:MakeTextHexColor(classColorTable.r, classColorTable.g, classColorTable.b)
+    local _, english_class = GetPlayerInfoByGUID(guid)
+    if english_class then
+      local class_color_table = RAID_CLASS_COLORS[english_class];
+      if class_color_table then
+        return Elephant:MakeTextHexColor(class_color_table.r, class_color_table.g, class_color_table.b)
       end
     end
   end
@@ -25,24 +25,24 @@ integer for them.
 
 Returns nil if a channel cannot be found.
 ]]
-local function getCIndexFromChannelName(channelName)
-  if channelName == "" then
+local function GetChannelIndexFromChannelName(channel_name)
+  if channel_name == "" then
     return nil
   end
 
-  channelName = string.lower(channelName)
-  local cIndex
-  for k, v in pairs(Elephant.L['generalchats']) do
-    if (channelName == k) or string.find(channelName, k .. " - ") then
-      cIndex = k
+  channel_name = string.lower(channel_name)
+  local channel_index
+  for general_chat_channel_name, _ in pairs(Elephant.L['generalchats']) do
+    if (channel_name == general_chat_channel_name) or string.find(channel_name, general_chat_channel_name .. " - ") then
+      channel_index = general_chat_channel_name
       break
     end
   end
-  if cIndex == nil then
+  if channel_index == nil then
     -- Custom channel name
-    cIndex = channelName
+    channel_index = channel_name
   end
-  return cIndex
+  return channel_index
 end
 
 --[[
@@ -58,19 +58,19 @@ local function HandleMessage(prat_struct, event, ...)
   end
 
   -- Getting info from event args
-  local message, sender, _, _, _, flags, _, _, channelName, _, _, guid = ...
+  local message, sender, _, _, _, flags, _, _, channel_name, _, _, guid = ...
   if flags == "" then
     flags = nil
   end
 
   -- Sometimes we need to log two messages for the price of one.
-  local msg, msg2
+  local new_message_struct, new_message_struct_2
   -- Channels
   if event == "CHAT_MSG_CHANNEL" or event == "CHAT_MSG_CHANNEL_NOTICE" then
-    cIndex = getCIndexFromChannelName(channelName)
+    local channel_index = GetChannelIndexFromChannelName(channel_name)
 
-    -- cIndex == nil should never happen, but better to ignore than crash.
-    if cIndex == nil or Elephant:IsFiltered(cIndex) then return end
+    -- channel_index == nil should never happen, but better to ignore than crash.
+    if channel_index == nil or Elephant:IsFiltered(channel_index) then return end
 
     if event == "CHAT_MSG_CHANNEL" then
       -- Fixing error where structure for channel does not exist
@@ -79,74 +79,74 @@ local function HandleMessage(prat_struct, event, ...)
       -- event for that channel. In this case though, the client cannot be
       -- displaying that log, so we don't have to update the buttons like
       -- when a YOU_JOINED event happens.
-      Elephant:InitCustomStructure(cIndex, channelName)
-      if not Elephant.dbpc.char.logs[cIndex].enabled then
+      Elephant:MaybeInitCustomStructure(channel_index, channel_name)
+      if not Elephant.dbpc.char.logs[channel_index].enabled then
         return
       end
 
       if prat_struct then
-        msg = {
+        new_message_struct = {
           ['time'] = time(),
           ['prat'] = prat_struct.message,
           ['lineid'] = prat_struct.line_id,
         }
       else
-        msg = {
+        new_message_struct = {
           ['time'] = time(),
           ['arg1'] = message,
           ['arg6'] = flags,
-          ['arg9'] = channelName,
+          ['arg9'] = channel_name,
           ['clColor'] = GetClassColorByGUID(guid)
         }
         if sender ~= "" then
-          msg['arg2'] = sender
+          new_message_struct['arg2'] = sender
         end
       end
-      Elephant:CaptureNewMessage(msg, cIndex)
+      Elephant:CaptureNewMessage(new_message_struct, channel_index)
     end
 
     if event == "CHAT_MSG_CHANNEL_NOTICE" then
       if message == "YOU_JOINED" or message == "YOU_CHANGED" then
-        Elephant:InitCustomStructure(cIndex, channelName)
-        if not Elephant.dbpc.char.logs[cIndex].enabled then
+        Elephant:MaybeInitCustomStructure(channel_index, channel_name)
+        if not Elephant.dbpc.char.logs[channel_index].enabled then
           return
         end
 
-        Elephant:CaptureNewMessage( { ['type'] = "SYSTEM", ['arg1'] = Elephant.L['customchat']['join'] } , cIndex)
-        if Elephant.dbpc.char.currentlogindex == cIndex then
+        Elephant:CaptureNewMessage( { ['type'] = "SYSTEM", ['arg1'] = Elephant.L['customchat']['join'] } , channel_index)
+        if Elephant.dbpc.char.currentlogindex == channel_index then
           Elephant:UpdateCurrentLogButtons()
         end
       end
       if message == "YOU_LEFT" then
-        if not Elephant.dbpc.char.logs[cIndex] or Elephant.dbpc.char.logs[cIndex].enabled then
+        if not Elephant.dbpc.char.logs[channel_index] or Elephant.dbpc.char.logs[channel_index].enabled then
           return
         end
 
-        Elephant:CaptureNewMessage( { ['type'] = "SYSTEM", ['arg1'] = Elephant.L['customchat']['leave'] } , cIndex)
-        Elephant:CaptureNewMessage( { ['arg1'] = " " } , cIndex)
-        if Elephant.dbpc.char.currentlogindex == cIndex then
+        Elephant:CaptureNewMessage( { ['type'] = "SYSTEM", ['arg1'] = Elephant.L['customchat']['leave'] } , channel_index)
+        Elephant:CaptureNewMessage( { ['arg1'] = " " } , channel_index)
+        if Elephant.dbpc.char.currentlogindex == channel_index then
           Elephant:UpdateCurrentLogButtons()
           Elephant:ForceCurrentLogDeleteButtonStatus(true)
         end
       end
     end
-  -- Not channel messages
   else
+    -- Not channel messages
     if prat_struct then
-      msg = {
+      new_message_struct = {
         ['time'] = time(),
         ['prat'] = prat_struct.message,
         ['lineid'] = prat_struct.line_id,
         ['type'] = Elephant.db.profile.events[event].type,
       }
     else
-      msg = {
+      new_message_struct = {
         ['time'] = time(),
         ['type'] = Elephant.db.profile.events[event].type,
         ['arg1'] = message,
       }
 
-      if  event == "CHAT_MSG_BATTLEGROUND" or
+      if event == "CHAT_MSG_BATTLEGROUND" or
         event == "CHAT_MSG_BATTLEGROUND_LEADER" or
         event == "CHAT_MSG_WHISPER" or
         event == "CHAT_MSG_WHISPER_INFORM" or
@@ -172,12 +172,12 @@ local function HandleMessage(prat_struct, event, ...)
         event == "CHAT_MSG_INSTANCE_CHAT" or
         event == "CHAT_MSG_INSTANCE_CHAT_LEADER"
       then
-        msg.arg2 = sender
-        msg.clColor = GetClassColorByGUID(guid)
+        new_message_struct.arg2 = sender
+        new_message_struct.clColor = GetClassColorByGUID(guid)
       end
 
       if event == "CHAT_MSG_WHISPER" then
-        msg.arg6 = flags
+        new_message_struct.arg6 = flags
       end
 
       if event == "PARTY_LOOT_METHOD_CHANGED" then
@@ -195,43 +195,43 @@ local function HandleMessage(prat_struct, event, ...)
             end
           end
 
-          msg2 = {
+          new_message_struct_2 = {
             ['time'] = time(),
             ['type'] = Elephant.db.profile.events[event].type
           }
 
           -- Name of player may be unknown here, if interface
           -- has just been loaded
           if player == "Unknown" then
-            msg2.arg1 = "<" .. Elephant.L['masterlooternameunknown'] .. ">"
+            new_message_struct_2.arg1 = "<" .. Elephant.L['masterlooternameunknown'] .. ">"
           elseif player ~= Elephant.tempConf.masterlooter then
             Elephant.tempConf.masterlooter = player
 
-            msg2.arg1 =  format(Elephant.L['masterlooterchanged'], player)
+            new_message_struct_2.arg1 =  format(Elephant.L['masterlooterchanged'], player)
           end
         else
           Elephant.tempConf.masterlooter = nil
         end
 
         if method ~= Elephant.tempConf.lootmethod then
           Elephant.tempConf.lootmethod = method
-          msg.arg1 = Elephant.L['lootmethod'][method]
+          new_message_struct.arg1 = Elephant.L['lootmethod'][method]
         else
-          -- Warning: msg2 might also be nil
-          msg = msg2
-          msg2 = nil
+          -- Warning: new_message_struct_2 might also be nil
+          new_message_struct = new_message_struct_2
+          new_message_struct_2 = nil
         end
       end
     end
 
     -- Finally, capture the message if it is not nil
-    if msg ~= nil then
-      local k
-      for k in pairs(Elephant.db.profile.events[event].channels) do
-        if Elephant.db.profile.events[event].channels[k] ~= 0 and Elephant.dbpc.char.logs[k].enabled then
-          Elephant:CaptureNewMessage(msg, k)
-          if msg2 ~= nil then
-            Elephant:CaptureNewMessage(msg2, k)
+    if new_message_struct ~= nil then
+      local channel_index
+      for channel_index in pairs(Elephant.db.profile.events[event].channels) do
+        if Elephant.db.profile.events[event].channels[channel_index] ~= 0 and Elephant.dbpc.char.logs[channel_index].enabled then
+          Elephant:CaptureNewMessage(new_message_struct, channel_index)
+          if new_message_struct_2 ~= nil then
+            Elephant:CaptureNewMessage(new_message_struct_2, channel_index)
           end
         end
       end
@@ -253,23 +253,23 @@ loaded.
 function Elephant:RegisterEventsRefresh()
   Elephant:UnregisterAllEvents()
 
-  local event
+  local event_type
   if Prat and Elephant.db.profile.prat then
     Prat.RegisterChatEvent(Elephant, Prat.Events.POST_ADDMESSAGE)
 
     -- Registering additional events not handled by Prat
-    for event, v in pairs(Elephant.db.profile.events) do
-      if v.register_with_prat then
-        Elephant:RegisterEvent(event, HandleMessage, nil)
+    for event_type, event_struct in pairs(Elephant.db.profile.events) do
+      if event_struct.register_with_prat then
+        Elephant:RegisterEvent(event_type, HandleMessage, nil)
       end
     end
   else
     if not Prat and Elephant.db.profile.prat then
       Elephant:Print("|cffff0000" .. Elephant.L['noprat'] .. "|r")
     end
 
-    for event, v in pairs(Elephant.db.profile.events) do
-      Elephant:RegisterEvent(event, HandleMessage, nil)
+    for event_type, event_struct in pairs(Elephant.db.profile.events) do
+      Elephant:RegisterEvent(event_type, HandleMessage, nil)
     end
   end
 end

Interface-Dropdown.lua

@@ -3,7 +3,7 @@ Utility method to sort the dropdowns menu
 choices alphabetically.
 ]]
 local function SortTable(arg1, arg2)
-  local i=1
+  local i = 1
   local j
 
   repeat
@@ -28,7 +28,6 @@ end
 --[[ Dropdowns ]]
 -- See below local functions declaration for dropdown
 -- creation function associations
-
 local function DropdownCustomChatsInitialize()
   local info = {}
   info.text = Elephant.L['chatnames']['custom']