steam_hlds_log_parser 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
-SHA1: 
-  metadata.gz: 30af9317dcddbf6bebd31d3bb02ff5df117db707
-  data.tar.gz: ab06662bf153b61c2cdab5b9d64209ced673e4e9
 SHA512: 
-  metadata.gz: 774c7685110aca35822f3642a5a93bbca4bd196f6ddad776345938e29a76df62f3f3b72c866898925f64ed0128a064b8046e9581db9553e6eb4719ea200a07aa
-  data.tar.gz: 5b8c66867b180997d6769fbff9f047346a270bddfce355fc842eafe55c3af72df5a4ab0deaf3f21112704609393682cba8e5b064a9c2e97420e7631d10ece3f9
+  data.tar.gz: 07e4b392ab7437fcfdc19b459ed818ef2f9ea568f7bb77790f90aa2225f5bde3c99f28af74684d1ea8fcde0b033fae332a3b9e24401dd20001a055b3eb7cdbe7
+  metadata.gz: 6b3effe39ddd007a2970b3ba3887e031b82042fec141a87d71f288e10f948535a4ba9abd7437a54722472f42f2b00cd59f6cd8622468c1b1a08afd0be591ed62
+SHA1: 
+  data.tar.gz: a0df584749432ba49b668243c12eb2fd7f4b0bc0
+  metadata.gz: d9aca93be069273408f47ad57a141f2b9b7bd3b4

data/lib/steam_hlds_log_parser.rb

@@ -8,6 +8,7 @@ require "steam_hlds_log_parser/client"
 require "steam_hlds_log_parser/handler"
 require "steam_hlds_log_parser/displayer"
 
+# SteamHldsLogParser module namespace
 module SteamHldsLogParser
 
   I18n.load_path = Dir.glob( File.dirname(__FILE__) + "/locales/*.yml" )

data/lib/steam_hlds_log_parser/client.rb

@@ -1,22 +1,21 @@
 module SteamHldsLogParser
 
+  # Listens to HLDS logs received via UDP on configured port
   class Client
 
     attr_reader :host, :port, :options
 
     # Creates a new client 
     #
-    # @host [String] Hostname / IP Address the server will be running
-    # @port [Integer] Port to listen to
-    # @options [Hash] Other options
+    # @param [String] host Hostname / IP Address the server will be running
+    # @param [Integer] port Port to listen to
+    # @param [Hash] options Other options
     #
-    # ==== Options
-    #
-    # * +locale+ - Set the language of returned content
-    # * +display_kills+ Enable kills / frags detail (default=true)
-    # * +display_actions+ Enable players actions / defuse / ... detail (default=true)
-    # * +display_changelevel+ Enable changelevel (map) display (default=true)
-    # * +displayer+ Class that will be use to display content (default=HldsReturnDisplayer)
+    # @option options [Symbol] :locale (:en) Set the language of returned content
+    # @option options [Boolean] :display_kills (true) Enable kills / frags detail 
+    # @option options [Boolean] :display_actions (true) Enable players actions / defuse / ... detail
+    # @option options [Boolean] :display_changelevel (true) Enable changelevel (map) display
+    # @option options [Class] :displayer Class that will be use to display content
     #
     def initialize(host, port, options = {})
       default_options = {

data/lib/steam_hlds_log_parser/displayer.rb

@@ -2,7 +2,7 @@ module SteamHldsLogParser
 
   # Default Displayer
   #
-  #  @data [Hash] Data returned by 'receive_data'
+  # @param [Hash] data Data returned by 'receive_data'
   #
   class Displayer
 
@@ -12,17 +12,23 @@ module SteamHldsLogParser
       @data = data
     end
 
-    # Return data
+    # Return 'data'
+    # 
+    # @return [Hash] Data processed by Handler class
+    #
     def get_data
       return @data 
     end
 
-    # Display data
+    # Display 'data'
     def display_data
       puts get_data
     end
 
-    # Return data translation
+    # Return 'data' translation
+    # 
+    # @return [String] Translated data processed by Handler class
+    #
     def get_translation
       return I18n.t(@data[:type], @data[:params]) unless @data[:type].nil?
     end

data/lib/steam_hlds_log_parser/handler.rb

@@ -1,14 +1,15 @@
 module SteamHldsLogParser
 
+  # Process data received by 'Client'
   class Handler < EM::Connection
 
     attr_reader :host, :port, :options
 
     # Initialize Handler from Client options
     #
-    # @host [String] Hostname / IP Address the server will be running
-    # @port [Integer] Port to listen to
-    # @options [Hash] Other options
+    # @param [String] host Hostname / IP Address the server will be running
+    # @param [Integer] port Port to listen to
+    # @param [Hash] options Other options
     #
     def initialize(host, port, options)
       @host, @port, @options = host, port, options
@@ -33,7 +34,7 @@ module SteamHldsLogParser
     # * match who did what (defuse, drop the bomb...)
     # * match changelevel
     #
-    # @data [String] Data received by Client from HLDS server (a line of log)
+    # @param [String] data Data received by Client from HLDS server (a line of log)
     #
     def receive_data(data)
 
@@ -75,7 +76,9 @@ module SteamHldsLogParser
 
     # Format team name with long format (textual)
     #
-    # @winner [String] Round winner (+CT+ or +T+) from logs
+    # @param [String] winner Round winner (+CT+ or +T+) from logs
+    #
+    # @return [String] Full team name from translation files
     #
     def get_full_team_name(winner)
       case winner
@@ -88,7 +91,9 @@ module SteamHldsLogParser
 
     # Format team name with short format (initials)
     #
-    # @team [String] Round winner (+CT+ or +TERRORIST+) from logs
+    # @param [String] team Round winner (+CT+ or +TERRORIST+) from logs
+    #
+    # @return [String] Short team name from translation files
     #
     def get_short_team_name(team)
       case team

data/lib/steam_hlds_log_parser/version.rb

@@ -1,3 +1,4 @@
 module SteamHldsLogParser
-  VERSION = "0.4.0"
+  # Gem Version
+  VERSION = "0.4.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: steam_hlds_log_parser
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors: 
 - Thomas VIAL