steam-condenser 0.14.0 → 1.0.1

data/lib/steam/community/game_weapon.rb

@@ -1,23 +1,41 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2009-2010, Sebastian Staudt
+# Copyright (c) 2009-2011, Sebastian Staudt
 
-# Super class for classes representing game weapons
+# A module implementing basic functionality for classes representing game
+# weapons
+#
+# @author Sebastian Staudt
 module GameWeapon
 
-  attr_reader :kills, :id, :shots
+  # Returns the number of kills achieved with this weapon
+  #
+  # @return [Fixnum] The number of kills achieved
+  attr_reader :kills
+
+  # Returns the unique identifier for this weapon
+  #
+  # @return [String] The identifier of this weapon
+  attr_reader :id
 
+  # Returns the number of shots fired with this weapon
+  #
+  # @return [Fixnum] The number of shots fired
+  attr_reader :shots
+
+  # Creates a new game weapon instance with the data provided
+  #
+  # @param [REXML::Element] weapon_data The data representing this weapon
   def initialize(weapon_data)
-    @kills     = weapon_data.elements['kills'].text.to_i
+    @kills = weapon_data.elements['kills'].text.to_i
   end
 
-  # Returns the average number of shots needed for a kill with this weapon.
-  # Calculates the value if needed.
+  # Returns the average number of shots needed for a kill with this weapon
+  #
+  # @return [Float] The average number of shots needed for a kill
   def avg_shots_per_kill
-    @avg_shots_per_kill = @shots.to_f / @kills if @avg_shots_per_kill.nil?
-
-    @avg_shots_per_kill
+    @shots.to_f / @kills
   end
 
 end

data/lib/steam/community/l4d/abstract_l4d_stats.rb

@@ -1,137 +1,163 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2009-2010, Sebastian Staudt
+# Copyright (c) 2009-2011, Sebastian Staudt
 
 require 'steam/community/game_stats'
 
-# AbstractL4DStats is an abstract base class for statistics for Left4Dead and
-# Left4Dead 2. As both games have more or less the same statistics available in
-# the Steam Community the code for both is pretty much the same.
+# This module is a base for statistics for Left4Dead and Left4Dead 2. As both
+# games have more or less the same statistics available in the Steam Community
+# the code for both is pretty much the same.
+#
+# @author Sebastian Staudt
 module AbstractL4DStats
 
+  # The names of the special infected in Left4Dead
   SPECIAL_INFECTED = %w(boomer hunter smoker tank)
 
+  # Creates a new instance of statistics for both, Left4Dead and Left4Dead 2
+  # parsing basic common data
+  #
+  # @param [String] steam_id The custom URL or 64bit Steam ID of the user
+  # @param [String] game_name The name of the game
   def initialize(steam_id, game_name)
     super steam_id, game_name
 
     if public?
       @most_recent_game = {}
       if @xml_data.elements['stats/mostrecentgame'].has_elements?
-        @most_recent_game['difficulty']  = @xml_data.elements['stats/mostrecentgame/difficulty'].text
-        @most_recent_game['escaped']     = (@xml_data.elements['stats/mostrecentgame/bEscaped'].text == 1)
-        @most_recent_game['movie']       = @xml_data.elements['stats/mostrecentgame/movie'].text
-        @most_recent_game['time_played'] = @xml_data.elements['stats/mostrecentgame/time'].text
+        @most_recent_game[:difficulty]  = @xml_data.elements['stats/mostrecentgame/difficulty'].text
+        @most_recent_game[:escaped]     = (@xml_data.elements['stats/mostrecentgame/bEscaped'].text == 1)
+        @most_recent_game[:movie]       = @xml_data.elements['stats/mostrecentgame/movie'].text
+        @most_recent_game[:time_played] = @xml_data.elements['stats/mostrecentgame/time'].text
       end
     end
   end
 
-  # Returns a Hash of favorites for this user like weapons and character.
+  # Returns a hash of favorites for this user like weapons and character
+  #
   # If the favorites haven't been parsed already, parsing is done now.
+  #
+  # @return [Hash<String, Object>] The favorites of this user
   def favorites
     return unless public?
 
     if @favorites.nil?
       @favorites = {}
-      @favorites['campaign']                 = @xml_data.elements['stats/favorites/campaign'].text
-      @favorites['campaign_percentage']      = @xml_data.elements['stats/favorites/campaignpct'].text.to_i
-      @favorites['character']                = @xml_data.elements['stats/favorites/character'].text
-      @favorites['character_percentage']     = @xml_data.elements['stats/favorites/characterpct'].text.to_i
-      @favorites['level1_weapon']            = @xml_data.elements['stats/favorites/weapon1'].text
-      @favorites['level1_weapon_percentage'] = @xml_data.elements['stats/favorites/weapon1pct'].text.to_i
-      @favorites['level2_weapon']            = @xml_data.elements['stats/favorites/weapon2'].text
-      @favorites['level2_weapon_percentage'] = @xml_data.elements['stats/favorites/weapon2pct'].text.to_i
+      @favorites[:campaign]                 = @xml_data.elements['stats/favorites/campaign'].text
+      @favorites[:campaign_percentage]      = @xml_data.elements['stats/favorites/campaignpct'].text.to_i
+      @favorites[:character]                = @xml_data.elements['stats/favorites/character'].text
+      @favorites[:character_percentage]     = @xml_data.elements['stats/favorites/characterpct'].text.to_i
+      @favorites[:level1_weapon]            = @xml_data.elements['stats/favorites/weapon1'].text
+      @favorites[:level1_weapon_percentage] = @xml_data.elements['stats/favorites/weapon1pct'].text.to_i
+      @favorites[:level2_weapon]            = @xml_data.elements['stats/favorites/weapon2'].text
+      @favorites[:level2_weapon_percentage] = @xml_data.elements['stats/favorites/weapon2pct'].text.to_i
     end
 
     @favorites
   end
 
-  # Returns a Hash of lifetime statistics for this user like the time played.
-  # If the lifetime statistics haven't been parsed already, parsing is done now.
+  # Returns a hash of lifetime statistics for this user like the time played
+  #
+  # If the lifetime statistics haven't been parsed already, parsing is done
+  # now.
+  #
+  # @return [Hash<String, Object>] The lifetime statistics for this user
   def lifetime_stats
     return unless public?
 
     if @lifetime_stats.nil?
       @lifetime_stats = {}
-      @lifetime_stats['finales_survived'] = @xml_data.elements['stats/lifetime/finales'].text.to_i
-      @lifetime_stats['games_played']     = @xml_data.elements['stats/lifetime/gamesplayed'].text.to_i
-      @lifetime_stats['infected_killed']  = @xml_data.elements['stats/lifetime/infectedkilled'].text.to_i
-      @lifetime_stats['kills_per_hour']   = @xml_data.elements['stats/lifetime/killsperhour'].text.to_f
-      @lifetime_stats['avg_kits_shared']  = @xml_data.elements['stats/lifetime/kitsshared'].text.to_f
-      @lifetime_stats['avg_kits_used']    = @xml_data.elements['stats/lifetime/kitsused'].text.to_f
-      @lifetime_stats['avg_pills_shared'] = @xml_data.elements['stats/lifetime/pillsshared'].text.to_f
-      @lifetime_stats['avg_pills_used']   = @xml_data.elements['stats/lifetime/pillsused'].text.to_f
-      @lifetime_stats['time_played']      = @xml_data.elements['stats/lifetime/timeplayed'].text
-
-      @lifetime_stats['finales_survived_percentage'] = @lifetime_stats['finales_survived'].to_f / @lifetime_stats['games_played']
+      @lifetime_stats[:finales_survived] = @xml_data.elements['stats/lifetime/finales'].text.to_i
+      @lifetime_stats[:games_played]     = @xml_data.elements['stats/lifetime/gamesplayed'].text.to_i
+      @lifetime_stats[:infected_killed]  = @xml_data.elements['stats/lifetime/infectedkilled'].text.to_i
+      @lifetime_stats[:kills_per_hour]   = @xml_data.elements['stats/lifetime/killsperhour'].text.to_f
+      @lifetime_stats[:avg_kits_shared]  = @xml_data.elements['stats/lifetime/kitsshared'].text.to_f
+      @lifetime_stats[:avg_kits_used]    = @xml_data.elements['stats/lifetime/kitsused'].text.to_f
+      @lifetime_stats[:avg_pills_shared] = @xml_data.elements['stats/lifetime/pillsshared'].text.to_f
+      @lifetime_stats[:avg_pills_used]   = @xml_data.elements['stats/lifetime/pillsused'].text.to_f
+      @lifetime_stats[:time_played]      = @xml_data.elements['stats/lifetime/timeplayed'].text
+
+      @lifetime_stats[:finales_survived_percentage] = @lifetime_stats[:finales_survived].to_f / @lifetime_stats[:games_played]
     end
 
     @lifetime_stats
   end
 
-  # Returns a Hash of Survival statistics for this user like revived teammates.
-  # If the Survival statistics haven't been parsed already, parsing is done now.
+  # Returns a hash of Survival statistics for this user like revived teammates
+  #
+  # If the Survival statistics haven't been parsed already, parsing is done
+  # now.
+  #
+  # @return [Hash<String, Object>] The Survival statistics for this user
   def survival_stats
     return unless public?
 
     if @survival_stats.nil?
       @survival_stats = {}
-      @survival_stats['gold_medals']   = @xml_data.elements['stats/survival/goldmedals'].text.to_i
-      @survival_stats['silver_medals'] = @xml_data.elements['stats/survival/silvermedals'].text.to_i
-      @survival_stats['bronze_medals'] = @xml_data.elements['stats/survival/bronzemedals'].text.to_i
-      @survival_stats['rounds_played'] = @xml_data.elements['stats/survival/roundsplayed'].text.to_i
-      @survival_stats['best_time']     = @xml_data.elements['stats/survival/besttime'].text.to_f
+      @survival_stats[:gold_medals]   = @xml_data.elements['stats/survival/goldmedals'].text.to_i
+      @survival_stats[:silver_medals] = @xml_data.elements['stats/survival/silvermedals'].text.to_i
+      @survival_stats[:bronze_medals] = @xml_data.elements['stats/survival/bronzemedals'].text.to_i
+      @survival_stats[:rounds_played] = @xml_data.elements['stats/survival/roundsplayed'].text.to_i
+      @survival_stats[:best_time]     = @xml_data.elements['stats/survival/besttime'].text.to_f
     end
 
     @survival_stats
   end
 
-  # Returns a Hash of teamplay statistics for this user like revived teammates.
-  # If the teamplay statistics haven't been parsed already, parsing is done now.
+  # Returns a hash of teamplay statistics for this user like revived teammates
+  #
+  # If the teamplay statistics haven't been parsed already, parsing is done
+  # now.
+  #
+  # @return [Hash<String, Object>] The teamplay statistics for this
   def teamplay_stats
     return unless public?
 
     if @teamplay_stats.nil?
       @teamplay_stats = {}
-      @teamplay_stats['revived']                       = @xml_data.elements['stats/teamplay/revived'].text.to_i
-      @teamplay_stats['most_revived_difficulty']       = @xml_data.elements['stats/teamplay/reviveddiff'].text
-      @teamplay_stats['avg_revived']                   = @xml_data.elements['stats/teamplay/revivedavg'].text.to_f
-      @teamplay_stats['avg_was_revived']               = @xml_data.elements['stats/teamplay/wasrevivedavg'].text.to_f
-      @teamplay_stats['protected']                     = @xml_data.elements['stats/teamplay/protected'].text.to_i
-      @teamplay_stats['most_protected_difficulty']     = @xml_data.elements['stats/teamplay/protecteddiff'].text
-      @teamplay_stats['avg_protected']                 = @xml_data.elements['stats/teamplay/protectedavg'].text.to_f
-      @teamplay_stats['avg_was_protected']             = @xml_data.elements['stats/teamplay/wasprotectedavg'].text.to_f
-      @teamplay_stats['friendly_fire_damage']          = @xml_data.elements['stats/teamplay/ffdamage'].text.to_i
-      @teamplay_stats['most_friendly_fire_difficulty'] = @xml_data.elements['stats/teamplay/ffdamagediff'].text
-      @teamplay_stats['avg_friendly_fire_damage']      = @xml_data.elements['stats/teamplay/ffdamageavg'].text.to_f
+      @teamplay_stats[:revived]                       = @xml_data.elements['stats/teamplay/revived'].text.to_i
+      @teamplay_stats[:most_revived_difficulty]       = @xml_data.elements['stats/teamplay/reviveddiff'].text
+      @teamplay_stats[:avg_revived]                   = @xml_data.elements['stats/teamplay/revivedavg'].text.to_f
+      @teamplay_stats[:avg_was_revived]               = @xml_data.elements['stats/teamplay/wasrevivedavg'].text.to_f
+      @teamplay_stats[:protected]                     = @xml_data.elements['stats/teamplay/protected'].text.to_i
+      @teamplay_stats[:most_protected_difficulty]     = @xml_data.elements['stats/teamplay/protecteddiff'].text
+      @teamplay_stats[:avg_protected]                 = @xml_data.elements['stats/teamplay/protectedavg'].text.to_f
+      @teamplay_stats[:avg_was_protected]             = @xml_data.elements['stats/teamplay/wasprotectedavg'].text.to_f
+      @teamplay_stats[:friendly_fire_damage]          = @xml_data.elements['stats/teamplay/ffdamage'].text.to_i
+      @teamplay_stats[:most_friendly_fire_difficulty] = @xml_data.elements['stats/teamplay/ffdamagediff'].text
+      @teamplay_stats[:avg_friendly_fire_damage]      = @xml_data.elements['stats/teamplay/ffdamageavg'].text.to_f
     end
 
     @teamplay_stats
   end
 
-  # Returns a Hash of Versus statistics for this user like percentage of rounds
-  # won.
+  # Returns a hash of Versus statistics for this user like percentage of rounds
+  # won
+  #
   # If the Versus statistics haven't been parsed already, parsing is done now.
+  #
+  # @return [Hash<String, Object>] The Versus statistics for this user
   def versus_stats
     return unless public?
 
     if @versus_stats.nil?
       @versus_stats = {}
-      @versus_stats['games_played']                = @xml_data.elements['stats/versus/gamesplayed'].text.to_i
-      @versus_stats['games_completed']             = @xml_data.elements['stats/versus/gamescompleted'].text.to_i
-      @versus_stats['finales_survived']            = @xml_data.elements['stats/versus/finales'].text.to_i
-      @versus_stats['points']                      = @xml_data.elements['stats/versus/points'].text.to_i
-      @versus_stats['most_points_infected']        = @xml_data.elements['stats/versus/pointsas'].text
-      @versus_stats['games_won']                   = @xml_data.elements['stats/versus/gameswon'].text.to_i
-      @versus_stats['games_lost']                  = @xml_data.elements['stats/versus/gameslost'].text.to_i
-      @versus_stats['highest_survivor_score']      = @xml_data.elements['stats/versus/survivorscore'].text.to_i
+      @versus_stats[:games_played]                = @xml_data.elements['stats/versus/gamesplayed'].text.to_i
+      @versus_stats[:games_completed]             = @xml_data.elements['stats/versus/gamescompleted'].text.to_i
+      @versus_stats[:finales_survived]            = @xml_data.elements['stats/versus/finales'].text.to_i
+      @versus_stats[:points]                      = @xml_data.elements['stats/versus/points'].text.to_i
+      @versus_stats[:most_points_infected]        = @xml_data.elements['stats/versus/pointsas'].text
+      @versus_stats[:games_won]                   = @xml_data.elements['stats/versus/gameswon'].text.to_i
+      @versus_stats[:games_lost]                  = @xml_data.elements['stats/versus/gameslost'].text.to_i
+      @versus_stats[:highest_survivor_score]      = @xml_data.elements['stats/versus/survivorscore'].text.to_i
 
-      @versus_stats['finales_survived_percentage'] = @versus_stats['finales_survived'].to_f / @versus_stats['games_played']      
+      @versus_stats[:finales_survived_percentage] = @versus_stats[:finales_survived].to_f / @versus_stats[:games_played]
 
       self.class.const_get(:SPECIAL_INFECTED).each do |infected|
         @versus_stats[infected] = {}
-        @versus_stats[infected]['special_attacks'] = @xml_data.elements["stats/versus/#{infected}special"].text.to_i
-        @versus_stats[infected]['most_damage']     = @xml_data.elements["stats/versus/#{infected}dmg"].text.to_i
+        @versus_stats[infected][:special_attacks] = @xml_data.elements["stats/versus/#{infected}special"].text.to_i
+        @versus_stats[infected][:most_damage]     = @xml_data.elements["stats/versus/#{infected}dmg"].text.to_i
         @versus_stats[infected]['avg_lifespan']    = @xml_data.elements["stats/versus/#{infected}lifespan"].text.to_i
       end
     end

data/lib/steam/community/l4d/abstract_l4d_weapon.rb

@@ -1,23 +1,53 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2009-2010, Sebastian Staudt
+# Copyright (c) 2009-2011, Sebastian Staudt
 
 require 'steam/community/game_weapon'
 
+# This abstract class is a base class for weapons in Left4Dead and Left4Dead 2
+# as the weapon stats for both games are very similar
+#
+# @author Sebastian Staudt
 module AbstractL4DWeapon
 
   include GameWeapon
 
-  attr_reader :accuracy, :headshots_percentage, :kill_percentage
+  # Returns the overall accuracy of the player with this weapon
+  #
+  # @return [String] The accuracy of the player with this weapon
+  attr_reader :accuracy
+
+  # Returns the percentage of kills with this weapon that have been headshots
+  #
+  # @return [String] The percentage of headshots with this weapon
+  attr_reader :headshots_percentage
+
+  # Returns the ID of the weapon
+  #
+  # @return [String] The ID of the weapon
+  attr_reader :id
+
+  # Returns the percentage of overall kills of the player that have been
+  # achieved with this weapon
+  #
+  # @return [String] The percentage of kills with this weapon
+  attr_reader :kill_percentage
+
+  # Returns the number of shots the player has fired with this weapon
+  #
+  # @return [Fixnum] The number of shots with this weapon
+  attr_reader :shots
 
-  # Abstract base constructor which parses common data for both, L4DWeapon and
-  # L4D2Weapon
+  # Creates a new instance of weapon from the given XML data and parses common
+  # data for both, `L4DWeapon` and `L4D2Weapon`
+  #
+  # @param [REXML::Element] weapon_data The XML data for this weapon
   def initialize(weapon_data)
     super weapon_data
 
-    @accuracy             = weapon_data.elements['accuracy'].text
-    @headshots_percentage = weapon_data.elements['headshots'].text
+    @accuracy             = weapon_data.elements['accuracy'].text.to_f * 0.01
+    @headshots_percentage = weapon_data.elements['headshots'].text.to_f * 0.01
     @id                   = weapon_data.name
     @shots                = weapon_data.elements['shots'].text.to_i
   end

data/lib/steam/community/l4d/l4d2_map.rb

@@ -1,7 +1,7 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2009-2010, Sebastian Staudt
+# Copyright (c) 2009-2011, Sebastian Staudt
 
 require 'steam/community/steam_id'
 require 'steam/community/l4d/l4d_map'
@@ -10,18 +10,40 @@ require 'steam/community/l4d/l4d_map'
 # Survival mode of Left4Dead 2. The basic information provided is more or less
 # the same for Left4Dead and Left4Dead 2, but parsing has to be done
 # differently.
+#
+# @author Sebastian Staudt
 class L4D2Map < L4DMap
 
-  attr_reader :items, :kills, :teammates
+  # Returns statistics about the items used by the player on this map
+  #
+  # @return [Hash<Symbol, Fixnum>] The items used by the player
+  attr_reader :items
 
+  # Returns the number of special infected killed by the player grouped by
+  # the names of the special infected
+  #
+  # @return [Hash<Symbol, Fixnum>] The special infected killed by the player
+  attr_reader :kills
+
+  # Returns the SteamIDs of the teammates of the player in his best game on
+  # this map
+  #
+  # @return [Array<SteamId>] The SteamIDs of the teammates in the best game
+  attr_reader :teammates
+
+  # The names of the special infected in Left4Dead 2
   INFECTED = %w{boomer charger common hunter jockey smoker spitter tank}
+
+  # The items available in Left4Dead 2
   ITEMS    = %w{adrenaline defibs medkits pills}
 
-  # Creates a new instance of L4D2Map based on the assigned XML data
+  # Creates a new instance of a map based on the given XML data
   #
   # The map statistics for the Survival mode of Left4Dead 2 hold much more
   # information than those for Left4Dead, e.g. the teammates and items are
   # listed.
+  #
+  # @param [REXML::Element] map_data The XML data for this map
   def initialize(map_data)
     @id        = map_data.elements['img'].text.match(/http:\/\/steamcommunity\.com\/public\/images\/gamestats\/550\/(.*).jpg/)[1]
     @name      = map_data.elements['name'].text
@@ -58,6 +80,9 @@ class L4D2Map < L4DMap
     end
   end
 
+  # Returns whether the player has already played this map
+  #
+  # @return [Boolean] `true` if the player has already played this map
   def played?
     @played
   end

data/lib/steam/community/l4d/l4d2_stats.rb

@@ -1,108 +1,146 @@
-# This code is free software; you can redistribute it and/or modify it under the
-# terms of the new BSD License.
+# This code is free software; you can redistribute it and/or modify it under
+# the terms of the new BSD License.
 #
-# Copyright (c) 2009-2010, Sebastian Staudt
+# Copyright (c) 2009-2011, Sebastian Staudt
 
 require 'steam/community/l4d/abstract_l4d_stats'
 require 'steam/community/l4d/l4d2_map'
 require 'steam/community/l4d/l4d2_weapon'
 
+# This class represents the game statistics for a single user in Left4Dead 2
+#
+# @author Sebastian Staudt
 class L4D2Stats < GameStats
 
   include AbstractL4DStats
 
+  # The names of the special infected in Left4Dead 2
   SPECIAL_INFECTED = SPECIAL_INFECTED + %w{charger jockey spitter}
 
-  # Creates a L4D2Stats object by calling the super constructor with the game
-  # name "l4d2"
+  # Returns the percentage of damage done by this player with each weapon type
+  #
+  # Available weapon types are `:melee`, `:pistols`, `:rifles` and `:shotguns`.
+  #
+  # @return [Hash<Symbol, Float>] The percentages of damage done with each
+  #         weapon type
+  attr_reader :damage_percentages
+
+  # Creates a `L4D2Stats` object by calling the super constructor with the game
+  # name `'l4d2'`
+  #
+  # @param [String] steam_id The custom URL or 64bit Steam ID of the user
   def initialize(steam_id)
     super steam_id, 'l4d2'
+
+    @damage_percentages = {
+      :melee    => @xml_data.elements['stats/weapons/meleepctdmg'].text.to_f,
+      :pistols  => @xml_data.elements['stats/weapons/pistolspctdmg'].text.to_f,
+      :rifles   => @xml_data.elements['stats/weapons/bulletspctdmg'].text.to_f,
+      :shotguns => @xml_data.elements['stats/weapons/shellspctdmg'].text.to_f
+    }
   end
 
-  # Returns a Hash of lifetime statistics for this user like the time played.
-  # If the lifetime statistics haven't been parsed already, parsing is done now.
+  # Returns a hash of lifetime statistics for this user like the time played
+  #
+  # If the lifetime statistics haven't been parsed already, parsing is done
+  # now.
   #
-  # There are only a few additional lifetime statistics for Left4Dead 2 which
-  # are not generated for Left4Dead, so this calls
-  # AbstractL4DStats#lifetime_stats first and adds some additional stats.
+  # There are only a few additional lifetime statistics for Left4Dead 2
+  # which are not generated for Left4Dead, so this calls
+  # {AbstractL4DStats#lifetime_stats} first and adds some additional stats.
+  #
+  # @return [Hash<String, Object>] The lifetime statistics of the player in
+  #         Left4Dead 2
   def lifetime_stats
     return unless public?
 
     if @lifetime_stats.nil?
       super
-      @lifetime_stats['avg_adrenaline_shared']   = @xml_data.elements['stats/lifetime/adrenalineshared'].text.to_f
-      @lifetime_stats['avg_adrenaline_used']     = @xml_data.elements['stats/lifetime/adrenalineused'].text.to_f
-      @lifetime_stats['avg_defibrillators_used'] = @xml_data.elements['stats/lifetime/defibrillatorsused'].text.to_f
+      @lifetime_stats[:avg_adrenaline_shared]   = @xml_data.elements['stats/lifetime/adrenalineshared'].text.to_f
+      @lifetime_stats[:avg_adrenaline_used]     = @xml_data.elements['stats/lifetime/adrenalineused'].text.to_f
+      @lifetime_stats[:avg_defibrillators_used] = @xml_data.elements['stats/lifetime/defibrillatorsused'].text.to_f
     end
 
     @lifetime_stats
   end
 
-  # Returns a Hash of Scavenge statistics for this user like the number of
-  # Scavenge rounds played.
-  # If the Scavenge statistics haven't been parsed already, parsing is done now.
+  # Returns a hash of Scavenge statistics for this user like the number of
+  # Scavenge rounds played
+  #
+  # If the Scavenge statistics haven't been parsed already, parsing is done
+  # now.
+  #
+  # @return [Hash<String, Object>] The Scavenge statistics of the player
   def scavenge_stats
     return unless public?
 
     if @scavenge_stats.nil?
       @scavenge_stats = {}
-      @scavenge_stats['avg_cans_per_round'] = @xml_data.elements['stats/scavenge/avgcansperround'].text.to_f
-      @scavenge_stats['perfect_rounds']     = @xml_data.elements['stats/scavenge/perfect16canrounds'].text.to_i
-      @scavenge_stats['rounds_lost']        = @xml_data.elements['stats/scavenge/roundslost'].text.to_i
-      @scavenge_stats['rounds_played']      = @xml_data.elements['stats/scavenge/roundsplayed'].text.to_i
-      @scavenge_stats['rounds_won']         = @xml_data.elements['stats/scavenge/roundswon'].text.to_i
-      @scavenge_stats['total_cans']         = @xml_data.elements['stats/scavenge/totalcans'].text.to_i
-
-      @scavenge_stats['maps'] = {}
+      @scavenge_stats[:avg_cans_per_round] = @xml_data.elements['stats/scavenge/avgcansperround'].text.to_f
+      @scavenge_stats[:perfect_rounds]     = @xml_data.elements['stats/scavenge/perfect16canrounds'].text.to_i
+      @scavenge_stats[:rounds_lost]        = @xml_data.elements['stats/scavenge/roundslost'].text.to_i
+      @scavenge_stats[:rounds_played]      = @xml_data.elements['stats/scavenge/roundsplayed'].text.to_i
+      @scavenge_stats[:rounds_won]         = @xml_data.elements['stats/scavenge/roundswon'].text.to_i
+      @scavenge_stats[:total_cans]         = @xml_data.elements['stats/scavenge/totalcans'].text.to_i
+
+      @scavenge_stats[:maps] = {}
       @xml_data.elements.each('stats/scavenge/mapstats/map') do |map_data|
         map_id = map_data.elements['name'].text
-        @scavenge_stats['maps'][map_id] = {}
-        @scavenge_stats['maps'][map_id]['avg_round_score']     = map_data.elements['avgscoreperround'].text.to_i
-        @scavenge_stats['maps'][map_id]['highest_game_score']  = map_data.elements['highgamescore'].text.to_i
-        @scavenge_stats['maps'][map_id]['highest_round_score'] = map_data.elements['highroundscore'].text.to_i
-        @scavenge_stats['maps'][map_id]['name']                = map_data.elements['fullname'].text
-        @scavenge_stats['maps'][map_id]['rounds_played']       = map_data.elements['roundsplayed'].text.to_i
-        @scavenge_stats['maps'][map_id]['rounds_won']          = map_data.elements['roundswon'].text.to_i
+        @scavenge_stats[:maps][map_id] = {}
+        @scavenge_stats[:maps][map_id]['avg_round_score']     = map_data.elements['avgscoreperround'].text.to_i
+        @scavenge_stats[:maps][map_id]['highest_game_score']  = map_data.elements['highgamescore'].text.to_i
+        @scavenge_stats[:maps][map_id]['highest_round_score'] = map_data.elements['highroundscore'].text.to_i
+        @scavenge_stats[:maps][map_id]['name']                = map_data.elements['fullname'].text
+        @scavenge_stats[:maps][map_id]['rounds_played']       = map_data.elements['roundsplayed'].text.to_i
+        @scavenge_stats[:maps][map_id]['rounds_won']          = map_data.elements['roundswon'].text.to_i
       end
 
-      @scavenge_stats['infected'] = {}
+      @scavenge_stats[:infected] = {}
       @xml_data.elements.each('stats/scavenge/infectedstats/special') do |infected_data|
         infected_id = infected_data.elements['name'].text
-        @scavenge_stats['infected'][infected_id] = {}
-        @scavenge_stats['infected'][infected_id]['max_damage_per_life']   = infected_data.elements['maxdmg1life'].text.to_i
-        @scavenge_stats['infected'][infected_id]['max_pours_interrupted'] = infected_data.elements['maxpoursinterrupted'].text.to_i
-        @scavenge_stats['infected'][infected_id]['special_attacks']       = infected_data.elements['specialattacks'].text.to_i
+        @scavenge_stats[:infected][infected_id] = {}
+        @scavenge_stats[:infected][infected_id]['max_damage_per_life']   = infected_data.elements['maxdmg1life'].text.to_i
+        @scavenge_stats[:infected][infected_id]['max_pours_interrupted'] = infected_data.elements['maxpoursinterrupted'].text.to_i
+        @scavenge_stats[:infected][infected_id]['special_attacks']       = infected_data.elements['specialattacks'].text.to_i
       end
     end
 
     @scavenge_stats
   end
 
-  # Returns a Hash of Survival statistics for this user like revived teammates.
-  # If the Survival statistics haven't been parsed already, parsing is done now.
+  # Returns a hash of Survival statistics for this user like revived teammates
+  #
+  # If the Survival statistics haven't been parsed already, parsing is done
+  # now.
   #
   # The XML layout for the Survival statistics for Left4Dead 2 differs a bit
-  # from Left4Dead's Survival statistics. So we have to use a different way of
-  # parsing for the maps and we use a different map class (L4D2Map) which holds
-  # the additional information provided in Left4Dead 2's statistics.
+  # from Left4Dead's Survival statistics. So we have to use a different way
+  # of parsing for the maps and we use a different map class
+  # (`L4D2Map`) which holds the additional information provided in
+  # Left4Dead 2's statistics.
+  #
+  # @return [Hash<String, Object>] The Survival statistics of the player
   def survival_stats
     return unless public?
 
     if @survival_stats.nil?
       super
-      @survival_stats['maps'] = {}
+      @survival_stats[:maps] = {}
       @xml_data.elements.each('stats/survival/maps/map') do |map_data|
         map = L4D2Map.new(map_data)
-        @survival_stats['maps'][map.id] = map
+        @survival_stats[:maps][map.id] = map
       end
     end
 
     @survival_stats
   end
 
-  # Returns a Hash of L4D2Weapon for this user containing all Left4Dead 2
-  # weapons.
+  # Returns a hash of `L4D2Weapon` for this user containing all Left4Dead 2
+  # weapons
+  #
   # If the weapons haven't been parsed already, parsing is done now.
+  #
+  # @return [Hash<String, Object>] The weapon statistics for this player
   def weapon_stats
     return unless public?