Olib 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57801fc8332955fb943a92598747f32d4e77550d
-  data.tar.gz: 76f6062a91e234262c511a93351de8448c4a6e28
+  metadata.gz: d7c2221d775721ed099b5f6be06e8efe67af5f35
+  data.tar.gz: c246739bf3831d398082d545cdfbe4943f93dd0c
 SHA512:
-  metadata.gz: b7bd539edcfff1e5053ec26c429781bfeae13c4f47393a12ad36528a62a73b60d2ef907154be75b737f1f0edb04df964508ac08bb7499f27741c1f497c58763e
-  data.tar.gz: 524c52224491dcdafcf693c3a35e869662031a01927441e92d6e0287e3b30bdf063061adc72b7b3ee73ca9fd26f38a9c41dcff4b860ba7ec52397aee79f9574c
+  metadata.gz: b007940362e1ac0f1a2ebe3fd633a57e292bd1d08d13c9feca6562b7eda1586590e6804c4fc1e1c56f414559273a45723d02410ea7920d3c70250171e4f66a54
+  data.tar.gz: 375af61ffbb01c36258e2076013c6fb652c26aa321278d826c1922ad810ae0375183051f894f593044255709629ec1956ca1a3df83d7cda0cd87fc9fa9cce3b9

data/lib/Olib.rb

@@ -1,5 +1,40 @@
 require 'net/http'
 require 'json'
+require "ostruct"
+
+class String
+  def is_i?
+    !!(self =~ /\A[-+]?[0-9]+\z/)
+  end
+end
+
+class MatchData
+  def to_struct
+    OpenStruct.new to_hash
+  end
+
+  def to_hash
+    Hash[self.names.zip(self.captures.map(&:strip).map do |capture|  
+      if capture.is_i? then capture.to_i else capture end
+    end)]
+  end
+end
+
+class Hash
+  def to_struct
+    OpenStruct.new self
+  end
+end
+
+class Regexp
+  def or(re)
+    Regexp.new self.to_s + "|" + re.to_s
+  end
+  # define union operator for regex instance
+  def |(re)
+    self.or(re)
+  end
+end
 
 module Olib
 
@@ -9,8 +44,7 @@ module Olib
         # check version
         if Gem.loaded_specs["Olib"].version < Gem::Version.new(response['version'])
           puts "<pushBold/>You need to update the Olib gem with a `gem install Olib`<popBold/>"
-        end
-        
+        end    
       rescue
         echo $!
         puts $!.backtrace[0..1]
@@ -18,7 +52,7 @@ module Olib
   end
 
   def Olib.methodize(str)
-    str.downcase.strip.gsub(/-|\s+|'|"/, "_")
+    str.to_s.downcase.strip.gsub(/-|\s+|'|"/, "_").to_sym
   end
 
   # load core first
@@ -32,7 +66,7 @@ module Olib
   }
 
   # invoke update notifier immediately
-  Olib.update_notifier
+  # Olib.update_notifier
 
   def Olib.do(action, re)
     dothistimeout action, 5, re
@@ -43,46 +77,6 @@ module Olib
     wait_while { running? script }
   end
 
-  def Olib.install(g, v=nil)
-    if !which("gem") then
-      echo "Olib could not detect the `gem` executable in your $PATH"
-      echo "when you installed Ruby did you forget to click the `modify $PATH` box?"
-      raise Exception
-    end
-
-    begin
-      unless v.nil?
-        # make it a true instance of Gem::Version so we can compare
-        raise UpdateGemError if Gem.loaded_specs[g].version <  Gem::Version.new(v)
-        gem g, v
-      end
-
-      Olib.reload g
-
-    ##
-    ## rescue missing gem and reload after install
-    ##
-    rescue LoadError
-      echo "installing #{g}..."
-      version = "--version '#{v}'" unless v.nil?
-      worked = system("gem install #{g} #{version} --no-ri --no-rdoc")
-      unless worked then raise "Could not install #{g} gem" end
-      Olib.reload g
-      echo "... installed #{g}!"
-
-    ##
-    ## rescue from too old of a gem version for a Ruby environment
-    ##
-    rescue UpdateGemError
-      echo "updating #{g}@#{Gem.loaded_specs[g].version} => #{v}..."
-      version = "--version '#{v}'" unless v.nil?
-      worked = system("gem install #{g} #{version} --no-ri --no-rdoc")
-      unless worked then raise "Could not install #{g} gem" end
-      Olib.reload g
-      echo "... updated #{g} to #{v}!"
-    end
-  end
-
   Vars.Olib ||= Hash.new
 
 

data/lib/Olib/actor/actor.rb

@@ -0,0 +1,117 @@
+module Actor
+  def self.included(klass)
+    klass.class_variable_set(:@@supervisor, Supervisor.new(klass.name))
+    klass.class_variable_set(:@@states, Array.new)
+    klass.class_variable_set(:@@pre_hooks, Array.new)
+    klass.class_variable_set(:@@post_hooks, Array.new)
+    klass.class_variable_set(:@@state, nil)
+    klass.class_variable_set(:@@history, Array.new)
+    klass.extend Actor::Mixins
+  end
+
+  module Mixins
+
+    def states
+      self.class_variable_get(:@@states)
+    end
+
+    def pre_hooks
+      self.class_variable_get(:@@pre_hooks)
+    end
+
+    def post_hooks
+      self.class_variable_get(:@@post_hooks)
+    end
+
+    def state
+      self.class_variable_get(:@@state)
+    end
+
+    def history
+      self.class_variable_get(:@@history)
+    end
+
+    def supervisor
+      self.class_variable_get(:@@supervisor)
+    end
+
+    def state=(state)
+      class_variable_set(:@@state, state.to_sym)
+    end
+
+    def start(state)
+      class_variable_set(:@@state, state.to_sym)
+    end
+
+    def emit(state)
+      state = state.to_sym
+      validate! state
+      self
+    end
+
+    def to_s
+      "#{self.name}<state=#{state} last=#{last} history=#{history} states=#{states}>"
+    end
+
+    def yield(state)
+      emit(state)
+      Fiber.yield
+    end
+
+    def is?(state)
+      validate!(state)
+      state == state
+    end
+
+    def last
+      history[-2]
+    end
+
+    def validate!(state)
+      state = state.to_sym
+      raise Actor::InvalidState.new(state, self) unless states.include?(state)
+    end
+
+    def garbage_collect!
+      history.shift while history.size > states.size
+    end
+
+    def before_every(&hook)
+      pre_hooks << hook
+      self
+    end
+
+    def after_every(&hook)
+      post_hooks << hook
+      self
+    end
+
+    def add(state, &callback)
+      ref = self
+
+      states << state.to_sym
+      supervisor.add(state) do
+        Fiber.yield until ref.is?(state)
+        ref.history << state
+        garbage_collect!
+        pre_hooks.each do |hook| hook.call(ref) end
+        # did a pre_hook prempt this op?
+        if ref.is?(state)
+          callback.call(ref)
+          post_hooks.each do |hook| hook.call(ref) end
+        end
+      end
+      self
+    end
+
+    def link!
+      supervisor.link!
+    end
+  end
+
+  class InvalidState < Exception
+    def initialize(state, flow)
+      super "Actor::state cannot be #{state}, validate states: #{flow.states}"
+    end
+  end
+end

data/lib/Olib/area.rb

@@ -1,13 +1,32 @@
 class Area < Olib::Container
+  def self.contents
+    GameObj.loot.map { |obj| Olib::Item.new(obj) }
+  end
+
+  def each
+    self.contents.each { |item|
+      yield item
+    }
+  end
+
+  class << self
+    Olib::Item.type_methods.each { |method, tag|
+      exp = /#{tag}/
+      define_method(method.to_sym) do
+        GameObj.loot
+          .select { |obj| obj.type =~ exp }
+          .map { |obj| Olib::Item.new(obj) }
+      end
+    }
+  end
 
-  def Area.current
+  def Area.deep
     Area.new
   end
 
-  attr_accessor :room, :contents, :objects
+  attr_accessor :room, :objects
 
   def initialize
-    @contents = []
     @room     = Room.current
     @objects  = [ GameObj.loot, GameObj.room_desc ]
       .flatten
@@ -23,6 +42,7 @@ class Area < Olib::Container
       .reject { |container| container.name =~ /[A-Z][a-z]+ disk/ }
       .each { |container|
         check_container container
+        item = Olib::Item.new container
         unless container.nested?
           container.contents.each { |item|
             item.container = container

data/lib/Olib/bounty.rb

@@ -1,172 +1,217 @@
-module Olib
-  class Bounty
-    @@listeners            = {}
-    @@re                    = {}
-    @@re[:herb]             = /requires (?:a|an|some) (?<herb>[a-zA-Z '-]+) found (?:in|on|around) (?<area>[a-zA-Z '-]+).  These samples must be in pristine condition.  You have been tasked to retrieve (?<number>[\d]+)/
-    @@re[:escort]           = /Go to the (.*?) and WAIT for (?:him|her|them) to meet you there.  You must guarantee (?:his|her|their) safety to (?<destiniation>[a-zA-Z '-]+) as soon as/
-    @@re[:gem]              = /has received orders from multiple customers requesting (?:a|an|some) (?<gem>[a-zA-Z '-]+).  You have been tasked to retrieve (?<number>[0-9]+)/
-    @@re[:heirloom]         = /You have been tasked to recover ([a-zA-Z '-]+) that an unfortunate citizen lost after being attacked by (a|an|some) (?<creature>[a-zA-Z '-]+) (in|on|around|near|by) (?<area>[a-zA-Z '-]+)./
-    @@re[:heirloom_found]   = /^You have located the heirloom and should bring it back to/
-    @@re[:succeeded]        = /^You have succeeded in your task and can return to the Adventurer's/                          
-    @@re[:report_to_guard]  = /^You succeeded in your task and should report back to/
-    @@re[:cull]             = /^You have been tasked to suppress (?<creature>^((?!bandit).)*$) activity (?:in|on) (?:the )? (?<area>.*?)(?: near| between| under|\.) ([a-zA-Z' ]+).  You need to kill (?<number>[0-9]+)/
-    @@re[:bandits]          = /^You have been tasked to suppress bandit activity (?:in |on )(?:the )(?<area>.*?)(?: near| between| under) ([a-zA-Z' ]+).  You need to kill (?<number>[0-9]+)/
-    @@re[:dangerous]        = /You have been tasked to hunt down and kill a particularly dangerous (?<creature>.*) that has established a territory (?:in|on) (?:the )?(?<area>.*?)(?: near| between| under|\.)/
-    @@re[:get_skin_bounty]  = /The local furrier/
-    @@re[:get_rescue]       = /It appears that a local resident urgently needs our help in some matter/
-    @@re[:get_bandits]      = /It appears they have a bandit problem they'd like you to solve./
-    @@re[:get_heirloom]     = /It appears they need your help in tracking down some kind of lost heirloom/
-    @@re[:get_herb_bounty]  = /local herbalist|local healer|local alchemist/
-    @@re[:get_gem_bounty]   = /The local gem dealer, (?<npc>[a-zA-Z ]+), has an order to fill and wants our help/
-    @@re[:creature_problem] = /It appears they have a creature problem they\'d like you to solve/
-    @@re[:rescue]           = /A local divinist has had visions of the child fleeing from (?:a|an) (?<creature>.*) (?:in|on) (?:the )?(?<area>.*?)(?: near| between| under|\.)/
-    @@re[:failed]           = /You have failed in your task/
-    @@re[:none]             = /You are not currently assigned a task/
-
-    # convenience list to get all types of bounties
-    def Bounty.types
-      @@re.keys
-    end
-    ##
-    ## @brief      provides an accessor to the raw regular expression dictionary for Bounty logic
-    ##
-    ## @return     Bounty Regex
-    ##
-    def Bounty.regex
-      @@re
-    end
+require "ostruct"
+
+class Bounty
+  NPCS = /guard|sergeant|clerk|taskmaster|gemcutter|jeweler|akrash|kris|Ghaerdish|Furryback|healer|dealer|Ragnoz|Maraene|Kelph|Areacne|Jhiseth|Gaedrein/i
+  HERBALIST_AREAS = /illistim|vaalor|legendary rest|solhaven/i
+  @@listeners = {}
+  # this should be refactored to use CONST
+  REGEX = OpenStruct.new(
+    creature_problem: /It appears they have a creature problem they\'d like you to solve/,
+    report_to_guard:  /^You succeeded in your task and should report back to/,
+    get_skin_bounty:  /The local furrier/,
+    heirloom_found:   /^You have located the heirloom and should bring it back to/,
+    cooldown:         /^You are not currently assigned a task.  You will be eligible for new task assignment in about (?<minutes>.*?) minute(s)./,
+    
+    dangerous: /You have been tasked to hunt down and kill a particularly dangerous (?<creature>.*) that has established a territory (?:in|on) (?:the )?(?<area>.*?)(?: near| between| under|\.)/,
+    succeeded: /^You have succeeded in your task and can return to the Adventurer's/,
+    heirloom:  /^You have been tasked to recover (a|an|some) (?<heirloom>.*?) that an unfortunate citizen lost after being attacked by (a|an|some) (?<creature>.*?) (?:in|on|around|near|by) (?<area>.*?)(| near (?<realm>.*?))\./,
+
+
+    get_rescue:      /It appears that a local resident urgently needs our help in some matter/,
+    get_bandits:     /It appears they have a bandit problem they'd like you to solve./,
+    get_heirloom:    /It appears they need your help in tracking down some kind of lost heirloom/,
+    get_herb_bounty: /local herbalist|local healer|local alchemist/,
+    get_gem_bounty:  /The local gem dealer, (?<npc>[a-zA-Z ]+), has an order to fill and wants our help/,
+
+    herb:   /requires (?:a |an |)(?<herb>.*?) found (?:in|on|around|near) (?<area>.*?)(| (near|between) (?<realm>.*?)).  These samples must be in pristine condition.  You have been tasked to retrieve (?<number>[\d]+)/,
+    escort: /Go to the (.*?) and WAIT for (?:him|her|them) to meet you there.  You must guarantee (?:his|her|their) safety to (?<destination>.*?) as soon as/,
+    gem:    /has received orders from multiple customers requesting (?:a|an|some) (?<gem>[a-zA-Z '-]+).  You have been tasked to retrieve (?<number>[0-9]+)/,
+
+    cull:    /^You have been tasked to suppress (?<creature>(?!bandit).*) activity (?:in|on|around) (?<area>.*?)(| (near|between) (?<realm>.*?)).  You need to kill (?<number>[0-9]+)/,
+    bandits: /^You have been tasked to suppress bandit activity (?:in|on|around) (?<area>.*?) (?:near|between|under) (?<realm>.*?).  You need to kill (?<number>[0-9]+)/,
+
+    rescue:  /A local divinist has had visions of the child fleeing from (?:a|an) (?<creature>.*) (?:in|on) (?:the )?(?<area>.*?)(?: near| between| under|\.)/,
+    failed:  /You have failed in your task/,
+    none:    /You are not currently assigned a task/,
+    skin:    /^You have been tasked to retrieve (?<number>\d+) (?<skin>.*?) of at least (?<quality>.*?) quality for (?<buyer>.*?) in (?<realm>.*?)\.\s+You can SKIN them off the corpse of (a|an|some) (?<creature>.*?) or/,
+    
+    help_bandits: /You have been tasked to help (?<partner>.*?) suppress bandit activity (in|on|around) (?<area>.*?)(| near (?<realm>.*?)).  You need to kill (?<number>[0-9]+)/
+  )
+  
+  # convenience list to get all types of bounties
+  def Bounty.types
+    REGEX.keys
+  end
+  ##
+  ## @brief      provides an accessor to the raw regular expression dictionary for Bounty logic
+  ##
+  ## @return     Bounty Regex
+  ##
+  def Bounty.regex
+    REGEX
+  end
 
-    def Bounty.town
-      Bounty.current[:town]
-    end
+  def Bounty.singularize(thing)
+    thing
+      .gsub("teeth", "tooth")
+  end
 
-    def Bounty.area
-      Bounty.current[:area]
-    end
+  def Bounty.parse(str)
+    type, patt = Bounty.match str
+    unless patt
+      raise Exception.new "could not match Bounty: #{str}\nplease notify Ondreian"
+    else
+      bounty = patt.match(str).to_struct
+      bounty[:type] = type
+      if bounty[:skin] 
+        bounty[:skin] = Bounty.singularize(bounty[:skin]) 
+      end
 
-    def Bounty.destination
-      Bounty.current[:destiniation]
-    end
+      if bounty[:creature]
+        bounty[:tags] = Creature.tags(bounty.creature)
+      end
 
-    def Bounty.gem
-      Bounty.current[:gem]
+      bounty
     end
+  end
 
-    def Bounty.creature
-      Bounty.current[:creature]
-    end
+  def Bounty.fetch!
+    checkbounty.strip
+  end
 
-    def Bounty.herb
-      Bounty.current[:herb]
+  def Bounty.match(bounty)
+    Bounty.regex.each_pair.find do |type, exp|
+      exp.match bounty
     end
+  end
 
-    def Bounty.n
-      Bounty.current[:number].to_i
-    end
+  def Bounty.method_missing(method)
+    str = method.to_s
 
-    def Bounty.type
-      Bounty.current[:type]
+    if str.chars.last == "?"
+      return Bounty.type == str.chars.take(str.length-1).join.to_sym
     end
 
-    def Bounty.task
-      Bounty.current
+    unless current[method].nil?
+      current[method]
+    else
+      raise Exception.new "Bounty<#{Bounty.current.to_h}> does not respond to :#{method}"
     end
+  end
 
-    def Bounty.current
-      info = nil
-      bounty_str = checkbounty.strip
-      Bounty.regex.each do |type, exp|
-        if data = exp.match(bounty_str) then
-          info = data.names.length ? Hash[ data.names.map(&:to_sym).zip( data.captures ) ] : {}
-          info[:type] = type
-        end
-      end
-      return info || {}
-    end
+  def Bounty.type
+    match(Bounty.fetch!).first
+  end
 
-    def Bounty.ask_for_bounty
-      fput "ask ##{Bounty.npc.id} for bounty"
-      Bounty
-    end
+  def Bounty.task
+    Bounty.current
+  end
 
-    def Bounty.remove
-      Go2.advguild
-      2.times do fput "ask ##{Bounty.npc.id} for remove" end
-      Bounty
+  def Bounty.done?
+    succeeded?
+  end
+
+  def Bounty.current
+    Bounty.parse(checkbounty)
+  end
+
+  def Bounty.ask_for_bounty
+    if invisible?
+      fput "unhide"
     end
 
-    def Bounty.to_s
-      @@listeners.to_s
+    if hidden?
+      fput "unhide"
     end
 
-    def Bounty.on(namespace, &block)
-      @@listeners[namespace] = block
+    if Bounty.npc
+      fput "ask ##{Bounty.npc.id} for bounty"
       Bounty
+    else
+      raise Exception.new "could not find Bounty.npc here"
     end
+    # give the XML parser time to update
+    sleep 0.2
+  end
 
-    def Bounty.listeners
-      @@listeners
+  def Bounty.herbalist
+    if Room.current.location =~ HERBALIST_AREAS
+      Go2.herbalist
+    else
+      Go2.npchealer
     end
+    self
+  end
 
-    def Bounty.cooldown?
-      Spell[9003].active?
-    end
+  def Bounty.remove
+    Go2.advguild
+    2.times do fput "ask ##{Bounty.npc.id} for remove" end
+    Bounty
+  end
 
-    def Bounty.cooldown!
-      if Bounty.cooldown?
-        Go2.origin
-        wait_until { !Bounty.cooldown? }
-      end
-      Bounty
-    end
+  def Bounty.on(namespace, &block)
+    @@listeners[namespace] = block
+    Bounty
+  end
+
+  def Bounty.listeners
+    @@listeners
+  end
 
-    def Bounty.throw_missing_listener
-      msg = "\n"
-      msg.concat "\nBounty.dispatch called for `:#{Bounty.type}` without a defined listener\n\n"
-      msg.concat "define a listener with:\n"
-      msg.concat " \n" 
-      msg.concat "   Bounty.on(:#{Bounty.type}) {\n" 
-      msg.concat "      # do something\n"
-      msg.concat "   }\n"
-      msg.concat " \n"
-      msg.concat "or rescue this error (Olib::Errors::Fatal) gracefully\n"
-      msg.concat " \n"
-      raise Errors::Fatal.new msg
+  def Bounty.cooldown?
+    Spell[9003].active?
+  end
+
+  def Bounty.cooldown!
+    if Bounty.cooldown?
+      Go2.origin
+      wait_until { !Bounty.cooldown? }
     end
+    Bounty
+  end
 
-    def Bounty.dispatch(listener=nil)
-      if listener
-        if @@listeners[listener]
-          @@listeners[listener].call
-          return Bounty
-        else 
-          Bounty.throw_missing_listener
-        end
-      end
+  def Bounty.throw_missing_listener
+    msg = "\n"
+    msg.concat "\nBounty.dispatch called for `:#{Bounty.type}` without a defined listener\n\n"
+    msg.concat "define a listener with:\n"
+    msg.concat " \n" 
+    msg.concat "   Bounty.on(:#{Bounty.type}) {\n" 
+    msg.concat "      # do something\n"
+    msg.concat "   }\n"
+    msg.concat " \n"
+    msg.concat "or rescue this error (Olib::Errors::Fatal) gracefully\n"
+    msg.concat " \n"
+    raise Olib::Errors::Fatal.new msg
+  end
 
-      if @@listeners[Bounty.type]
-        @@listeners[Bounty.type].call
+  def Bounty.dispatch(listener=nil)
+    if listener
+      if @@listeners[listener]
+        @@listeners[listener].call
         return Bounty
-      else
+      else 
         Bounty.throw_missing_listener
       end
     end
 
-    def Bounty.find_guard
-      Go2.advguard
-      if Bounty.npc.nil? then Go2.advguard2 end
-      if Bounty.npc.nil? then 
-        throw Olib::Errors::Fatal.new "could not find guard"
-      end
+    if @@listeners[Bounty.type]
+      @@listeners[Bounty.type].call
       return Bounty
+    else
+      Bounty.throw_missing_listener
     end
+  end
 
-    def Bounty.npc
-      GameObj.npcs.select { |npc| npc.name =~ /guard|taskmaster|gemcutter|jeweler|akrash|kris|healer|dealer/i }.first
+  def Bounty.find_guard
+    Go2.advguard
+    if Bounty.npc.nil? then Go2.advguard2 end
+    if Bounty.npc.nil? then 
+      throw Olib::Errors::Fatal.new "could not find guard"
     end
-
+    return Bounty
   end
-end
 
-class Bounty < Olib::Bounty
+  def Bounty.npc
+    GameObj.npcs.select { |npc| npc.name =~ NPCS }.first
+  end
 end