rmuh 0.2.5 → 0.2.6

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MjQ2MGE5M2YxMTFhMzM2YWYwYWE2YWI5ZGJkNjQ2ZDJhNzJhNTgxOA==
-  data.tar.gz: !binary |-
-    MTA2NTNkMmJlNzc5NTVmNjFlZDg3MWUwYzRkYjA3ZDJhODI1ODczOQ==
+SHA1:
+  metadata.gz: b42ffdde9b6cafc07b106a25dada77df4d37d65e
+  data.tar.gz: 3b7cd60555b39694ec72807656b0e7062def008a
 SHA512:
-  metadata.gz: !binary |-
-    ODE2MzEzYmJkMmYzZGE5ZmRjMmM1MzU1NDY2NDhiMjNiOWIwOWZkNWQ5ZGVl
-    MjkwOWRlODgzNGIwYjVjMjQ4YTdmYzcxN2NkMDY1Y2I2YjUwNTU1ZTBiY2Iy
-    MTI0MDgwZDY2M2E4MzA0ZWRlYWFmM2Q2NjgzZWU3MDEyZTlhM2M=
-  data.tar.gz: !binary |-
-    YTcyZGE2YTk2YzZmODVjMTNkNTM0NTBmNTIxYzkwYTk2NDYwZDIzZWYwMzQx
-    YWE0M2U0MTQwYWY2MWY5MWE4MDYyZWM2YTI2MGVkNzYzOTQ1MTNmNWQ0MjAy
-    NTZlNDJiNmVmYWNmMWRiMmUyZWY4NzQ1NTZmOWRjYzJkODk3MTk=
+  metadata.gz: b786803d70135e98d668d798e46ce6a7651f23c6db297c2c4c6fe0b94167341c57fce1275f21887276970b099fdd25123bfff72c9c2a30bdec4483f767ddbd9c
+  data.tar.gz: b5dae0477bc01d475a710d3cf7d59989cca234f78939941cf756db2d78fe79fb58571d1ae95999bea5a10096924053af83b28eac7fb419425f19412a3ddd60f4

data/.rubocop.yml

@@ -0,0 +1,5 @@
+MethodLength:
+  Max: 15
+
+CyclomaticComplexity:
+  Max: 7

data/.travis.yml

@@ -3,6 +3,7 @@ branches:
     - master
 language: ruby
 rvm:
+- 2.1.2
 - 2.1.1
 - 2.1.0
 - 2.0.0

data/README.md

@@ -120,6 +120,20 @@ l = p.parse(f.log)
 At this specific moment `l` would contain an Array of Hashes corresponding to
 the log lines.
 
+Log Formatting
+--------------
+There are also built-in formatters that allow you to dump the events to a
+format similar to the original log lines. They were changed a bit to be more
+readable and relevant.
+
+The formatters just take an event and return a String. Assuming `event` is a
+single valid event here:
+
+```Ruby
+require 'rmuh'
+puts RMuh::PRT::Log::Formatters::UnitedOperationsRPT.format(event)
+```
+
 Server Stats
 ------------
 The `RMuh` gem also wraps the

data/examples/basic_parsing.rb

@@ -9,8 +9,7 @@
 #
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
-require 'rmuh/rpt/log/fetch'
-require 'rmuh/rpt/log/parsers/base'
+require 'rmuh'
 require 'ap'
 
 # set a constant for the URL

data/examples/basic_serverstats.rb

@@ -9,7 +9,7 @@
 #
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
-require 'rmuh/serverstats/base'
+require 'rmuh'
 require 'ap'
 
 # specify the UnitedOperations server

data/examples/serverstats_advanced.rb

@@ -10,7 +10,7 @@
 # can learn more about those in the serverstats_cache.rb file.
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
-require 'rmuh/serverstats/advanced'
+require 'rmuh'
 require 'ap'
 
 # specify the UnitedOperations server

data/examples/serverstats_cache.rb

@@ -11,7 +11,7 @@
 # afford a blocking operation
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
-require 'rmuh/serverstats/base'
+require 'rmuh'
 require 'ap'
 
 # specify the UnitedOperations server

data/examples/uolog_parsing.rb

@@ -5,8 +5,7 @@
 #
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
-require 'rmuh/rpt/log/fetch'
-require 'rmuh/rpt/log/parsers/unitedoperationslog'
+require 'rmuh'
 require 'ap'
 
 # the server log file
@@ -16,7 +15,7 @@ URL = 'http://arma2.unitedoperations.net/dump/SRV1/SRV1_LOG.txt'
 f = RMuh::RPT::Log::Fetch.new(URL)
 
 # instantiate a new UnitedOperationsRPT parser
-p = RMuh::RPT::Log::Parsers::UnitedOperationsLog.new
+p = RMuh::RPT::Log::Parsers::UnitedOperationsLog.new(chat: true)
 
 # parse the log from the server
 # we are doing it inline

data/examples/uorpt_parsing.rb

@@ -5,8 +5,7 @@
 #
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
-require 'rmuh/rpt/log/fetch'
-require 'rmuh/rpt/log/parsers/unitedoperationsrpt'
+require 'rmuh'
 require 'ap'
 
 # the server log file

data/lib/rmuh/rpt.rb

@@ -30,3 +30,7 @@ require 'rmuh/rpt/log/parsers/unitedoperationsrpt'
 require 'rmuh/rpt/log/util/unitedoperations'
 require 'rmuh/rpt/log/util/unitedoperationslog'
 require 'rmuh/rpt/log/util/unitedoperationsrpt'
+
+require 'rmuh/rpt/log/formatters/base'
+require 'rmuh/rpt/log/formatters/unitedoperationslog'
+require 'rmuh/rpt/log/formatters/unitedoperationsrpt'

data/lib/rmuh/rpt/log/formatters/base.rb

@@ -0,0 +1,18 @@
+# -*- coding: UTF-8 -*-
+
+module RMuh
+  module RPT
+    module Log
+      module Formatters
+        # RPT Log Formatter base class
+        class Base
+          class << self
+            def format(event)
+              "#{event[:message]}" if event[:type] == :log
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rmuh/rpt/log/formatters/unitedoperationslog.rb

@@ -0,0 +1,51 @@
+# -*- coding: UTF-8 -*-
+require_relative 'base'
+
+module RMuh
+  module RPT
+    module Log
+      module Formatters
+        # Formatter for the UnitedOperations Log file
+        class UnitedOperationsLog < RMuh::RPT::Log::Formatters::Base
+          class << self
+            def format(event)
+              case event[:type]
+              when :connect
+                format_connect(event)
+              when :disconnect
+                format_disconnect(event)
+              when :beguid
+                format_beguid(event)
+              when :chat
+                format_chat(event)
+              else
+                nil
+              end
+            end
+
+            private
+
+            def format_connect(e)
+              "#{e[:iso8601]} Server: Player ##{e[:player_num]} " \
+              "#{e[:player]} (#{e[:ipaddr]}) connected\n"
+            end
+
+            def format_disconnect(e)
+              "#{e[:iso8601]} Server: Player #{e[:player]} disconnected\n"
+            end
+
+            def format_beguid(e)
+              "#{e[:iso8601]} Server: Verified GUID (#{e[:player_beguid]}) " \
+              "of player ##{e[:player_num]} #{e[:player]}\n"
+            end
+
+            def format_chat(e)
+              "#{e[:iso8601]} Chat: (#{e[:channel]}) #{e[:player]}: " \
+              "#{e[:message]}\n"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rmuh/rpt/log/formatters/unitedoperationsrpt.rb

@@ -0,0 +1,118 @@
+# -*- coding: UTF-8 -*-
+#
+# By the end you will be sick of the letter 'e', I sure am...
+#
+require_relative 'base'
+
+module RMuh
+  module RPT
+    module Log
+      module Formatters
+        # Formatter for the UnitedOperations RPT file
+        class UnitedOperationsRPT < RMuh::RPT::Log::Formatters::Base
+          LEVELS ||= [:full, :ext, :simple]
+
+          class << self
+            def format(event, level = :full)
+              validate_and_set_level(level)
+              case event[:type]
+              when :wounded
+                format_wounded(event)
+              when :killed
+                format_killed(event)
+              when :died
+                format_died(event)
+              when :announcement
+                format_announcement(event)
+              else
+                nil
+              end
+            end
+
+            private
+
+            def validate_and_set_level(level)
+              fail(
+                ArgumentError,
+                "Log level invalid, can be one of #{LEVELS.join(', ')}"
+              ) unless LEVELS.include?(level)
+              @level = level
+            end
+
+            def time(e)
+              "#{e[:iso8601]}"
+            end
+
+            def server_time(e)
+              "#{time(e)} \"#{e[:server_time]} seconds:"
+            end
+
+            def nearby_players(e)
+              players = e[:nearby_players]
+              if players.empty?
+                n = 'None'
+              else
+                p = e[:nearby_players].map { |pl| "'#{pl}'" }.join(',')
+                n = "[#{p}]"
+              end
+              ". Nearby players (100m): #{n}"
+            end
+
+            def beguid(beguid)
+              " (#{beguid})" unless beguid.nil?
+            end
+
+            def format_wounded(e)
+              l = "#{server_time(e)} #{e[:victim]}"
+              l += "#{beguid(e[:victim_beguid])} (#{e[:victim_team]}) has "
+              l += "been wounded by #{e[:offender]}"
+              l += "#{beguid(e[:offender_beguid])} (#{e[:offender_team]})"
+              l += format_wounded_ext(e) if [:full, :ext].include?(@level)
+              l += "\"\n"
+              l
+            end
+
+            def format_wounded_ext(e)
+              " for #{e[:damage]} damage"
+            end
+
+            def format_killed(e)
+              l = "#{server_time(e)} #{e[:victim]}"
+              l += "#{beguid(e[:victim_beguid])} (#{e[:victim_team]}) "
+              l += "has been killed by #{e[:offender]}"
+              l += "#{beguid(e[:offender_beguid])} (#{e[:offender_team]})"
+              l += format_killed_ext(e) if [:ext, :full].include?(@level)
+              l += nearby_players(e) if @level == :full
+              l += "\"\n"
+              l
+            end
+
+            def format_killed_ext(e)
+              ". #{e[:victim]} pos: [#{e[:victim_position]}] (GRID " \
+              "#{e[:victim_grid]}). #{e[:offender]} pos: " \
+              "[#{e[:offender_position]}] (GRID #{e[:offender_grid]}). " \
+              "Distance between: #{e[:distance]}m"
+            end
+
+            def format_died(e)
+              l = "#{server_time(e)} #{e[:victim]}"
+              l += "#{beguid(e[:victim_beguid])} has bled out or died of pain"
+              l += format_died_ext(e) if [:full, :ext].include?(@level)
+              l += nearby_players(e) if @level == :full
+              l += "\"\n"
+              l
+            end
+
+            def format_died_ext(e)
+              " at [#{e[:victim_position]}] (GRID #{e[:victim_grid]})"
+            end
+
+            def format_announcement(e)
+              "#{time(e)} \"#{e[:head]} #{e[:message]} #{e[:tail]}\"\n"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rmuh/rpt/log/parsers/unitedoperationslog.rb

@@ -63,10 +63,14 @@ module RMuh
           def regex_matches(loglines)
             loglines.map do |l|
               line = nil
-              if GUID.match(l)
-                line = { type: :beguid }.merge(m_to_h($LAST_MATCH_INFO))
+              if LEFT.match(l)
+                line = { type: :disconnect }.merge(m_to_h($LAST_MATCH_INFO))
               elsif @include_chat && CHAT.match(l)
                 line = { type: :chat }.merge(m_to_h($LAST_MATCH_INFO))
+              elsif JOINED.match(l)
+                line = { type: :connect }.merge(m_to_h($LAST_MATCH_INFO))
+              elsif GUID.match(l)
+                line = { type: :beguid }.merge(m_to_h($LAST_MATCH_INFO))
               end
               line_modifiers(line) unless line.nil?
             end.compact
@@ -76,6 +80,7 @@ module RMuh
             when_am_i!(line)
             zulu!(line, @timezone)
             add_guid!(line)
+            strip_port!(line) if line[:type] == :connect
             line
           end
 
@@ -104,6 +109,12 @@ module RMuh
             line[:day] = time.day
             line
           end
+
+          def strip_port!(line)
+            line[:ipaddr] = line[:net].split(':')[0]
+            line.delete(:net)
+            line
+          end
         end
       end
     end

data/lib/rmuh/rpt/log/util/unitedoperations.rb

@@ -30,7 +30,9 @@ module RMuh
 
           def __line_modifiers(match, match_name)
             m = match_name
-            if [:year, :month, :day, :hour, :min, :sec].include?(m.to_sym)
+            if [
+              :year, :month, :day, :hour, :min, :sec, :player_num
+            ].include?(m.to_sym)
               return match[m].to_i
             elsif [:server_time, :damage, :distance, :channel, :nearby_players]
               .include?(m.to_sym)
@@ -107,19 +109,19 @@ module RMuh
           end
 
           def validate_bool_opt(opts, key)
-            if opts.key?(key) &&
-               ![TrueClass, FalseClass].include?(opts[key].class)
-              fail ArgumentError,
-                   "#{key} must be a boolean value (true|false)"
-            end
+            fail(
+              ArgumentError,
+              "#{key} must be a boolean value (true|false)"
+            ) if opts.key?(key) && \
+                 ![TrueClass, FalseClass].include?(opts[key].class)
           end
 
           def validate_timezone(opts)
-            if opts.key?(:timezone) &&
-               opts[:timezone].class != TZInfo::DataTimezone
-              fail ArgumentError,
-                   ':tiemzone must be an instance of TZInfo::DataTimezone'
-            end
+            fail(
+              ArgumentError,
+              ':tiemzone must be an instance of TZInfo::DataTimezone'
+            ) if opts.key?(:timezone) &&
+                 opts[:timezone].class != TZInfo::DataTimezone
           end
         end
       end

data/lib/rmuh/rpt/log/util/unitedoperationslog.rb

@@ -9,16 +9,24 @@ module RMuh
         #
         module UnitedOperationsLog
           ONE_DAY ||= 86_400
-          TIME ||= '^\s*?(?<hour>\d+?):(?<min>\d+?):(?<sec>\d+)\s' \
-                   'BattlEye\sServer:\s'
+          TIME_SHORT ||= '^\s*?(?<hour>\d+?):(?<min>\d+?):(?<sec>\d+)\s'
+          TIME ||= "#{TIME_SHORT}BattlEye\sServer:\s"
           GUID ||= Regexp.new(
-            "#{TIME}.*Verified\\sGUID\\s\\((?<player_beguid>.*?)\\).*#\\d+?" \
+            "#{TIME}.*Verified\\sGUID\\s\\((?<player_beguid>.*?)\\).*#" \
+            '(?<player_num>\\d+?)' \
             '\s(?<player>.+)$'
           )
           CHAT ||= Regexp.new(
             "#{TIME}\\((?<channel>Group|Global|Side|Vehicle|Command|Unknown)" \
             '\)\s+?(?<player>.+?):\s(?<message>.*)$'
           )
+          JOINED ||= Regexp.new(
+            "#{TIME}Player\s\#(?<player_num>\\d+)\s(?<player>.*?)\s" \
+            '\\((?<net>.*?)\\)\sconnected'
+          )
+          LEFT ||= Regexp.new(
+            "#{TIME_SHORT}Player\s(?<player>.*?)\sdisconnected\."
+          )
         end
       end
     end

data/lib/rmuh/version.rb

@@ -6,7 +6,7 @@
 module RMuh
   VERSION_MAJ ||= 0
   VERSION_MIN ||= 2
-  VERSION_REV ||= 5
+  VERSION_REV ||= 6
 
   VERSION ||= "#{VERSION_MAJ}.#{VERSION_MIN}.#{VERSION_REV}"
 end

data/rmuh.gemspec

@@ -17,11 +17,11 @@ Gem::Specification.new do |g|
   g.license     = 'MIT'
   g.required_ruby_version = '>= 1.9.3'
 
-  g.test_files  = %x( git ls-files spec/* ).split
-  g.files       = %x( git ls-files).split
+  g.test_files  = `git ls-files spec/*`.split
+  g.files       = `git ls-files`.split
 
   g.add_development_dependency 'rake', '~>10.1', '>= 10.1.0'
-  g.add_development_dependency 'rspec', '~>2.14', '>= 2.14.1'
+  g.add_development_dependency 'rspec', '>= 3.0.0.beta2 '
   g.add_development_dependency 'rubocop', '~> 0.21', '>= 0.21.0'
   g.add_development_dependency 'fuubar', '~> 1.3', '>= 1.3.2'
   g.add_development_dependency 'simplecov', '~> 0.8', '>= 0.8.2'