regulos 0.2.0 → 0.3.0

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+#### v0.3.0
+* Rewrote most of the code to more ruby-ish.
+
 #### v0.2.0
 * Add basic event filtering
 

data/README.md

@@ -11,14 +11,29 @@
 #### Usage
 
 * require 'regulos'
-* log = Regulos::CombatLog.parse "/path/to/combatlog.txt"
-* log.filter :only    => {:event => ["Heal"]
-* events = log.filter :exclude => {:event => ["Heal", "CriticalHeal"]
-* events.first.full_message
-
+* log = Regulos::CombatLog::File.new :path => "/path/to/combatlog.txt"
+* log.read
+* # Find all events that are heals that both target and originate from a player.
+* log.select do |e| 
+*   e.heal?               \
+*     and                 \
+*   e.targets :player     \
+*     and                 \
+*   e.origin_is :player
+* end
+
+#### Notes
+The parser attempts to be as 'lazy' as possible. It does not read the entire file into memory, rather, it reads as needed.
 
 #### Methods on Event
   time, action_code, origin, target, origin_name, target_name, output, spell_id, spell_name, full_message
+
+### TODO
+- End of combat markers are not handled.
+- Pet detection is surely broken.
+- More convience methods for searching events, such as 'pvp?'
+- Make file parsing smart in that events are grouped per end-of-combat marker
  
 
 
+Author: James Cook

data/lib/regulos.rb

@@ -2,5 +2,6 @@ lib = File.expand_path('../', __FILE__)
 $:.unshift lib unless $:.include?(lib)
 
 require "regulos/combat_log/file.rb"
+require "regulos/combat_log/entity.rb"
 require "regulos/combat_log/event_collection.rb"
 require "regulos/combat_log/event.rb"

data/lib/regulos/combat_log/entity.rb

@@ -0,0 +1,9 @@
+lib = File.expand_path('../', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+require "entity/base"
+
+entity_path   = File.join(lib, "entity" )
+glob_pattern = entity_path + "/**/*.rb"
+Dir.glob( glob_pattern ).each do |file|
+  require file
+end

data/lib/regulos/combat_log/entity/base.rb

@@ -0,0 +1,66 @@
+module Regulos
+  module CombatLog
+    module Entity
+      class Base
+        NIL_ENTITY = 'T=X#R=X#0'
+        attr_reader :guid, :name
+        def initialize options={}
+          @guid, @name = [ options[:guid], options[:name] ]
+        end
+
+        def inspect
+          "<#{self.class} '#{name}'>"
+        end
+
+        def is_a? thing
+          if thing.is_a?(Symbol)
+            thing.to_s.downcase == klass.downcase
+          else
+            super
+          end
+        end
+
+        def ==(other)
+          other.respond_to?(:klass) && klass == other.klass && other.name == name
+        end
+
+        # Convience method to get the 'simple' class name
+        def klass
+          self.class.to_s.split("::").last
+        end
+
+        class << self
+          #T=N#R=O#9223372043800556155
+          #T=P#R=G#224054081475467319
+          def process hash
+            hash[:origin]     = determine_entity(hash[:origin],     hash[:origin_name])
+            hash[:target]     = determine_entity(hash[:target],     hash[:target_name])
+            hash[:pet_origin] = determine_entity(hash[:pet_origin], hash[:origin_name], true)
+            hash[:pet_target] = determine_entity(hash[:pet_target], hash[:target_name], true)
+            hash
+          end
+
+          def determine_entity flags_and_guid, name, pet=false
+            return nil if flags_and_guid == NIL_ENTITY || flags_and_guid.nil?
+            flags = flags_and_guid[0..8]
+            guid  = flags_and_guid[9..-1]
+
+            entity_code = flags[2]  #N,P,X
+            group_code  = flags[6]  #O,G,R  # solo, group, & raid NYI
+            case entity_code
+              when 'N' then
+                klass = Npc
+              when 'P' then
+                klass = pet ? Pet : Player
+              when 'X' then
+                klass = Unknown
+              else
+                klass = Unknown
+            end
+            klass.new(:guid => guid, :name => name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/regulos/combat_log/entity/npc.rb

@@ -0,0 +1,8 @@
+module Regulos
+  module CombatLog
+    module Entity
+      class Npc < Base
+      end
+    end
+  end
+end

data/lib/regulos/combat_log/entity/pet.rb

@@ -0,0 +1,9 @@
+
+module Regulos
+  module CombatLog
+    module Entity
+      class Pet < Base
+      end
+    end
+  end
+end

data/lib/regulos/combat_log/entity/player.rb

@@ -0,0 +1,8 @@
+module Regulos
+  module CombatLog
+    module Entity
+      class Player < Base
+      end
+    end
+  end
+end

data/lib/regulos/combat_log/entity/unknown.rb

@@ -0,0 +1,8 @@
+module Regulos
+  module CombatLog
+    module Entity
+      class Unknown < Base
+      end
+    end
+  end
+end

data/lib/regulos/combat_log/event/attack_hit.rb

@@ -2,6 +2,7 @@ module Regulos
   module CombatLog
     module Event
       class AttackHit < Base
+        def attack?; true; end
       end
     end
   end

data/lib/regulos/combat_log/event/attack_miss.rb

@@ -2,6 +2,8 @@ module Regulos
   module CombatLog
     module Event
       class AttackMiss < Base
+        def miss?;   true; end
+        def attack?; true; end
       end
     end
   end

data/lib/regulos/combat_log/event/base.rb

@@ -39,6 +39,35 @@ module Regulos
           "<#{self.class} id=#{id}>"
         end
 
+        def to_s
+           respond_to?(:full_message) ? full_message : inspect
+        end
+
+        def is_a? thing
+          if thing.is_a?(Symbol)
+            thing.to_s.downcase == name.downcase
+          else
+            super
+          end
+        end
+
+        def is_not? thing
+          !is_a?(thing)
+        end
+
+        def targets thing
+          target && target.is_a?(thing)
+        end
+
+        def originates thing
+          origin && origin.is_a?(thing)
+        end
+        alias_method :origin_is, :originates
+
+        def is_event?
+          true
+        end
+
         def id
           @id ||= Digest::MD5.hexdigest( [time, full_message].join ) if time && full_message
         end
@@ -46,6 +75,11 @@ module Regulos
         def ==(other)
           other.id == id
         end
+        alias :eql? :==
+
+        def <=> other
+          time.to_s <=> other.time.to_s
+        end
 
         def name
           self.class.to_s.split("::").last
@@ -55,22 +89,45 @@ module Regulos
           CODES.invert[ action_code ]
         end
 
-        def heal?
-          full_message =~ /heals/
+        def target_is_player?
+          target && target.klass == "Player"
+        end
+
+        def target_is_npc?
+          target && target.klass == "Npc"
         end
 
-        def overheal?
-          full_message =~ /\d\soverheal/
+        def origin_is_npc?
+          origin && origin.klass == "Npc"
         end
 
-        def buff?
-          code == :BuffGain || code == :BuffFade
+        def origin_is_player?
+          origin && origin.klass == "Player"
         end
 
-        def debuff?
-          code == :DebuffGain || code == :DebuffFade
+        def origin_is_pet?
+          origin && origin.klass == "Pet"
         end
 
+        def target_is_pet?
+          target && target.klass == "Pet"
+        end
+
+        def miss?;     false; end
+        def parry?;    false; end
+        def dodge?;    false; end
+        def resist?;   false; end
+        def immune?;   false; end
+        def attack?;   false; end
+        def spell?;    false; end
+        def heal?;     false; end
+        def overheal?; false; end
+        def buff?;     false; end
+        def debuff?;   false; end
+        def critical?; false; end
+        def death?;    false; end
+        def damage_over_time?; false; end
+
         def process attributes
           attributes.each_pair{|k,v| self.class.send(:attr_reader, k); instance_variable_set("@#{k}", v) }
         end
@@ -80,6 +137,7 @@ module Regulos
         class << self
           def which(row)
             require "strscan"
+            return row if row.class.to_s =~ /Event\Z/i
             s = StringScanner.new row   
 #03:53:35: ( 15 , T=N#R=O#9223372038886130583 , T=N#R=O#9223372043800556153 , T=X#R=X#224054081475471412 , T=X#R=X#0 , Lesser Earth Elemental , Eternal Servant , 0 , 75533189 , Thud ) Eternal Servant dodges Lesser Earth Elemental's Thud.
             entity_regex  = /\s[A-Z]=[A-Z]#[A-Z]=[A-Z]#\d+?\s,/
@@ -97,9 +155,14 @@ module Regulos
             e[:spell_name]   = s.scan /\s[A-Za-z\-\s]+?\s\)/     # Spell name
             e[:full_message] = s.scan /\s(.*)+\Z/                # Full log message
             e = sanitize(e)
+            e = capture_entities(e)
             determine_event_type(e).new e
           end
 
+          def capture_entities(hash)
+            CombatLog::Entity::Base.process(hash)
+          end
+
           def sanitize hash
             hash.each_pair do |k,v|
               v.to_s.strip!                # Remove leading space

data/lib/regulos/combat_log/event/begin_cast.rb

@@ -2,6 +2,7 @@ module Regulos
   module CombatLog
     module Event
       class BeginCast < Base
+        def spell?; true; end
       end
     end
   end

data/lib/regulos/combat_log/event/buff_fade.rb

@@ -2,6 +2,7 @@ module Regulos
   module CombatLog
     module Event
       class BuffFade < Base
+        def buff?; true; end
       end
     end
   end

data/lib/regulos/combat_log/event/buff_gain.rb

@@ -2,6 +2,7 @@ module Regulos
   module CombatLog
     module Event
       class BuffGain < Base
+        def buff?; true; end
       end
     end
   end

data/lib/regulos/combat_log/event/critical_heal.rb

@@ -2,6 +2,8 @@ module Regulos
   module CombatLog
     module Event
       class CriticalHeal < Base
+        def heal?; true; end
+        def critical?; true; end
       end
     end
   end

data/lib/regulos/combat_log/event/critical_hit.rb

@@ -2,6 +2,8 @@ module Regulos
   module CombatLog
     module Event
       class CriticalHit < Base
+        def attack?; true; end
+        def critical?; true; end
       end
     end
   end

data/lib/regulos/combat_log/event/damage.rb

@@ -1,7 +1,8 @@
 module Regulos
   module CombatLog
     module Event
-      class AttackHit < Base
+      class Damage < Base
+        def attack?; true; end
       end
     end
   end

data/lib/regulos/combat_log/event/damage_over_time.rb

@@ -2,6 +2,8 @@ module Regulos
   module CombatLog
     module Event
       class DamageOverTime < Base
+        def damage_over_time?; true; end
+        def attack?; true; end
       end
     end
   end

data/lib/regulos/combat_log/event/death.rb

@@ -2,6 +2,7 @@ module Regulos
   module CombatLog
     module Event
       class Death < Base
+        def death?; true; end
       end
     end
   end

data/lib/regulos/combat_log/event/debuff_fade.rb

@@ -2,6 +2,7 @@ module Regulos
   module CombatLog
     module Event
       class DebuffFade < Base
+        def debuff?; true; end
       end
     end
   end

data/lib/regulos/combat_log/event/debuff_gain.rb

@@ -2,6 +2,8 @@ module Regulos
   module CombatLog
     module Event
       class DebuffGain < Base
+        def debuff?; true; end
+        def attack?; true; end
       end
     end
   end

data/lib/regulos/combat_log/event/dodge.rb

@@ -2,6 +2,7 @@ module Regulos
   module CombatLog
     module Event
       class Dodge < Base
+        def attack?; true; end
       end
     end
   end

data/lib/regulos/combat_log/event/end_cast.rb

@@ -2,6 +2,7 @@ module Regulos
   module CombatLog
     module Event
       class EndCast < Base
+        def spell?; true; end
       end
     end
   end

data/lib/regulos/combat_log/event/heal.rb

@@ -2,6 +2,7 @@ module Regulos
   module CombatLog
     module Event
       class Heal < Base
+        def heal?; true; end
       end
     end
   end

data/lib/regulos/combat_log/event/immune.rb

@@ -2,6 +2,7 @@ module Regulos
   module CombatLog
     module Event
       class Immune < Base
+        def immune?; true; end
       end
     end
   end

data/lib/regulos/combat_log/event/interrupt.rb

@@ -2,6 +2,7 @@ module Regulos
   module CombatLog
     module Event
       class Interrupt < Base
+        def spell?; true; end
       end
     end
   end

data/lib/regulos/combat_log/event/mana_gain.rb

@@ -2,6 +2,7 @@ module Regulos
   module CombatLog
     module Event
       class ManaGain < Base
+        def spell?; true; end
       end
     end
   end

data/lib/regulos/combat_log/event/miss.rb

@@ -0,0 +1,9 @@
+module Regulos
+  module CombatLog
+    module Event
+      class Miss < Base
+        def attack?; true; end
+      end
+    end
+  end
+end

data/lib/regulos/combat_log/event/parry.rb

@@ -2,6 +2,8 @@ module Regulos
   module CombatLog
     module Event
       class Parry < Base
+        def attack?; true; end
+        def parry?; true; end
       end
     end
   end

data/lib/regulos/combat_log/event/resist.rb

@@ -2,6 +2,9 @@ module Regulos
   module CombatLog
     module Event
       class Resist < Base
+        def spell?; true; end
+        def resist?; true; end
+        def attack?; true; end
       end
     end
   end

data/lib/regulos/combat_log/event/unknown_death.rb

@@ -2,6 +2,7 @@ module Regulos
   module CombatLog
     module Event
       class UnknownDeath < Base
+        def death?; true; end
       end
     end
   end

data/lib/regulos/combat_log/event_collection.rb

@@ -1,44 +1,41 @@
-require "delegate"
+require "set"
+
 module Regulos
   module CombatLog
-    class EventCollection < Array
-      class FilterException < RuntimeError;end
-
-      attr_reader :events
+    class EventCollection < SortedSet
+      alias_method :all, :select
 
       def initialize(events=[])
         @events = events
-        super(@events)
+        super(events)
       end
 
-      def inspect
-        "<#{self.class} size=#{size}"
+      def events
+        self
       end
 
-      # Search the collection
-      # e.g. :only => {:event => ["Heal", "BuffGain"]}
-      # e.g. :only => {:target => [:player]}  #NYI
-      def filter(options={})
-        if options[:only] && options[:exclude] 
-          raise FilterException, "You can't specify both 'only' and 'exclude'."
+      def [](index)
+        if index && index.is_a?(Range)
+          return EventCollection.new( to_a[index.begin, index.end] )
+        else
+          return to_a[index] 
         end
+      end
 
-        return only(options[:only])       if options[:only]
-        return exclude(options[:exclude]) if options[:exclude]
+      def select &block
+        EventCollection.new( to_a.select(&block) )
       end
 
-      protected
-      def only(options)
-        filter_events(:only, options[:event])    if options[:event]
+      def inspect
+        "<#{self.class} size=#{size}"
       end
 
-      def exclude(options)
-        filter_events(:exclude, options[:event]) if options[:event]
+      def first
+        to_a.first
       end
 
-      def filter_events mode, keys
-        mode = mode == :only ? :select : :reject
-        EventCollection.new send(mode){|e| keys.include?(e.name) }
+      def last
+        to_a.last
       end
     end
   end

data/lib/regulos/combat_log/file.rb

@@ -1,33 +1,93 @@
+# ############################ #
+# Regulos - Combat log parser  #
+# ############################ #
+#
+# f = Regulos::CombatLog::File.new :path => "/Users/jamecook/Downloads/CombatLog.txt"
+# f.read  # Read all events, not required
+# f.first
+# f.first{|event| event.is_a?(:heal) }
+# See Event::Base for the various methods that can be used for filtering. 
+# 
+
 module Regulos
   module CombatLog
     class FileNotFoundError < RuntimeError; end
-    # Helper for .new
-    def CombatLog.parse(path)
-      log = File.new( :path => path )
-      log.parse
-      log
-    end
 
-    class File
+    class File < ::File
 
-      attr_reader :path, :events
+      attr_reader :path, :events, :debug
       def initialize(options={})
-        @path = ::File.exist?( options[:path] ) ? options[:path] : raise(FileNotFoundError, "The specified combat log does not exist.")
+        @path   = File.exist?( options[:path] ) ? options[:path] : raise(FileNotFoundError, "The specified combat log does not exist.")
         @events = EventCollection.new []
+        super(@path)
       end
 
-      def parse
-        data = ::File.readlines path
-        data.each{|row| @events << Event.handle(row) }
+      def inspect
+        "<Regulos::CombatLog::File path=#{@path}>"
+      end
+      
+      # Pass the block onto the collection set for searching
+      # e.g. select{|event| event.is_a?(:heal) }
+      def each &block
+        if eof?
+          @events.instance_eval do
+            each &block
+          end
+        else
+          trap("INT"){ rewind; break } # if you SIGINT mid search, future searches will be goofed until eof is 
+                                       # reached due to the lazy nature of this block.
+          each_line do |e|
+            parsed   = Event::Base.which(e)
+            @events << parsed
+            STDERR.write("\r-> Reading (#{pos}) '#{parsed.name}'        ") if debug?
+            yield parsed
+          end
+        end
       end
 
-      def filter options
-        events.filter(options) 
+      def select &block
+        EventCollection.new super
       end
 
-      def inspect
-        "<Regulos::CombatLog::File path=#{@path}>"
+      def size
+        @size || read.size
+      end
+
+      # Resets the event collection and re-parse the log.
+      def reload
+        @events.clear
+        read
+      end
+
+      def read
+        readlines.map{|line| @events << Event::Base.which(line) }
+        if eof?
+          @size = @events.size
+        end
+        @events
+      end
+
+      def first &block
+        if block_given?
+          detect &block
+        else
+          @events.first || detect{|e| e.is_event? }
+        end
+      end
+
+      # Reverse the set and pluck the first match. This requires the entire file to be parsed (yikes).
+      def last &block
+        read unless eof?
+        if block_given?
+          EventCollection.new(@events.to_a.reverse).detect &block
+        else
+          @events[-1]
+        end
       end
+
+      # Enable debugging, which currently prints parsing information during a search.
+      def debug!; @debug=true; end
+      def debug?; @debug; end
     end
   end
 end

data/lib/regulos/version.rb

@@ -1,6 +1,6 @@
 module Regulos
   MAJOR_VERSION = "0"
-  MINOR_VERSION = "2"
+  MINOR_VERSION = "3"
   BUG_VERSION   = "0"
 
   VERSION = [ MAJOR_VERSION, MINOR_VERSION, BUG_VERSION ].join "."

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - James Cook
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-27 00:00:00 -06:00
+date: 2011-03-08 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,6 +40,12 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/regulos/combat_log/entity/base.rb
+- lib/regulos/combat_log/entity/npc.rb
+- lib/regulos/combat_log/entity/pet.rb
+- lib/regulos/combat_log/entity/player.rb
+- lib/regulos/combat_log/entity/unknown.rb
+- lib/regulos/combat_log/entity.rb
 - lib/regulos/combat_log/event/attack_hit.rb
 - lib/regulos/combat_log/event/attack_miss.rb
 - lib/regulos/combat_log/event/base.rb
@@ -73,7 +79,7 @@ files:
 - README.md
 - CHANGELOG.md
 has_rdoc: true
-homepage: http://github.com/jamecook/regulos
+homepage: http://github.com/jamescook/regulos
 licenses: []
 
 post_install_message: