Olib 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 901479e6bec498eac64a1efcd4614d52e7f7e4a5
-  data.tar.gz: 0cbde613e5bf68f9a6a53be5bcb7e3a22a48a53e
+  metadata.gz: 32dd85c76004987a26b1485416f9ea279ff9a18b
+  data.tar.gz: 3bd045223d339ccd81a67d842253821f694665fb
 SHA512:
-  metadata.gz: ef96e09e9b39f404f240d7a33f0c7445f240441386360d2f6801f7d2b24fc379bc588b39e4321f9d83521623597c88e00da12c83eed13db3b9ffcb2f2dea651e
-  data.tar.gz: 742745addc4ab4a8539f0e05a2e3bd58df57a27ffa8535e4cbfa917c8e205096411b9eb6eee6edd57180bb5058f58034cc78a9a9176b8240663ec5ad513b5b4a
+  metadata.gz: 15e3b6ca1d57404720b818b69b9275b5240711f11d83bd6252432866fc6f4be3e390ad3eef42447fc378013f80dd4d7aafc1d06b9105b657bb42a26b81d06fed
+  data.tar.gz: 77a1f64d339a3f50fcdfba866c566e54deeb2f8b7f865bbbb29b68051a606c90e17f89e47f7c82756f420a4b4849aa5639b004ee176ccdb0a43c86ae1db93a48

data/Olib.gemspec

@@ -1,17 +1,18 @@
-lib = File.expand_path("../lib/", __FILE__)
-$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
-
-Gem::Specification.new do |s|
-  s.name          = 'Olib'
-  s.version       = '0.0.8'
-  s.date          = '2014-09-12'
-  s.summary       = "Useful Lich extensions for Gemstone IV"
-  s.description   = "Useful Lich extensions for Gemstone IV including hostile creature management, group management, syntactically pleasing movement, locker management, etc"
-  s.authors       = ["Ondreian Shamsiel"]
-  s.email         = 'ondreian.shamsiel@gmail.com'
-  s.homepage      = 'https://github.com/ondreian/Olib'
-  s.files         = %w[Olib.gemspec] + Dir['*.md', 'lib/**/*.rb']
-  #s.require_paths = %w[lib]
-  # s.add_runtime_dependency 'shoes'
-  s.license     = 'MIT'
+lib = File.expand_path("../lib/", __FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+require "Olib/version"
+
+Gem::Specification.new do |s|
+  s.name          = "Olib"
+  s.version       = Olib::VERSION
+  s.date          = "2014-09-12"
+  s.summary       = "Useful Lich extensions for Gemstone IV"
+  s.description   = "Useful Lich extensions for Gemstone IV including hostile creature management, group management, syntactically pleasing movement, locker management, etc"
+  s.authors       = ["Ondreian Shamsiel"]
+  s.email         = "ondreian.shamsiel@gmail.com"
+  s.homepage      = "https://github.com/ondreian/Olib"
+  s.files         = %w[Olib.gemspec] + Dir["*.md", "lib/**/*.rb"]
+  #s.require_paths = %w[lib]
+  # s.add_runtime_dependency "shoes"
+  s.license     = "MIT"
 end

data/README.md

@@ -1,21 +1,23 @@
-## Olib
-
-`gem install Olib`
-
-This offers a lot of syntatic sugar for scripting in GS
-
-examples:
-
-``` ruby
-Creatures.magical.each { |creature|
- creature.kill
-}
-```
-
-``` ruby
-Group.members.each { |char|
- haste(char)
-}
-```
-
-Pull requests and the like as welcome.
+## Olib [![Build Status](https://travis-ci.org/ondreian/Olib.svg?branch=master)](https://travis-ci.org/ondreian/Olib)
+
+`gem install Olib`
+
+This offers a lot of syntatic sugar for scripting in GS.
+
+examples:
+
+``` ruby
+Creatures.magical.each { |creature|
+ creature.kill
+}
+```
+
+``` ruby
+Group.members.each { |char|
+ haste(char)
+}
+```
+
+[WIP documentation](http://www.rubydoc.info/github/ondreian/Olib/Olib/)
+
+Pull requests and the like as welcome.

data/TODOS.md

@@ -1,4 +1,4 @@
-# TODOS
-
-+ Add Documentation
+# TODOS
+
++ Add Documentation
 + Better tagging for items

data/lib/Olib.rb

@@ -1,51 +1,89 @@
-require 'net/http'
-require 'json'
-
-module Olib
-
-  def Olib.update_notifier
-    begin
-        request  = Net::HTTP::Get.new('/api/v1/gems/Olib.json', initheader = {'Content-Type' =>'application/json'})
-        response = Net::HTTP.new('rubygems.org').start {|http| http.request(request) }
-        if response.body =~ /error/
-          # silence is golden
-          exit
-        else
-          # check version
-          if Gem.loaded_specs["Olib"].version < Gem::Version.new(JSON.parse(response.body)['version'])
-            puts "<pushBold/>You need to update the Olib gem with a `gem install Olib`<popBold/>"
-          end
-        end
-      rescue
-        echo $!
-        puts $!.backtrace[0..1]
-      end
-  end
-
-  # load core first
-  Dir[File.dirname(__FILE__) + '/Olib/core/**/*.rb'].each {|file|
-    require file 
-  }
-
-  # load things that depend on core extensions
-  Dir[File.dirname(__FILE__) + '/Olib/**/*.rb'].each {|file|
-    require file 
-  }
-
-  # invoke update notifier immediately
-  Olib.update_notifier
-
-  def Olib.do(action, re)
-    dothistimeout action, 5, re
-  end
-
-  def Olib.run(script, *args)
-    start_script script, args
-    wait_while { running? script }
-  end
-
-  Vars.Olib ||= Hash.new
-
-
-  
+require 'net/http'
+require 'json'
+
+module Olib
+
+  def Olib.update_notifier
+    begin
+        response  = JSON.parse Net::HTTP.get URI('https://rubygems.org/api/v1/gems/Olib.json')
+        # 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
+        
+      rescue
+        echo $!
+        puts $!.backtrace[0..1]
+      end
+  end
+
+  def Olib.methodize(str)
+    str.downcase.strip.gsub(/-|\s+|'|"/, "_")
+  end
+
+  # load core first
+  Dir[File.dirname(__FILE__) + '/Olib/core/**/*.rb'].each {|file|
+    require file 
+  }
+
+  # load things that depend on core extensions
+  Dir[File.dirname(__FILE__) + '/Olib/**/*.rb'].each {|file|
+    require file 
+  }
+
+  # invoke update notifier immediately
+  Olib.update_notifier
+
+  def Olib.do(action, re)
+    dothistimeout action, 5, re
+  end
+
+  def Olib.run(script, *args)
+    start_script script, args
+    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
+
+
 end

data/lib/Olib/area.rb

@@ -0,0 +1,51 @@
+class Area < Olib::Container
+
+  def Area.current
+    Area.new
+  end
+
+  attr_accessor :room, :contents, :objects
+
+  def initialize
+    @contents = []
+    @room     = Room.current
+    @objects  = [ GameObj.loot, GameObj.room_desc ]
+      .flatten
+      .compact
+      .map { |thing| thing.id }
+      .uniq # sometimes objects exist in both loot & room_desc
+      .map { |id| Olib::Container.new id }
+  end
+
+  def contents
+    items = []
+    @objects
+      .reject { |container| container.name =~ /[A-Z][a-z]+ disk/ }
+      .each { |container|
+        check_container container
+        unless container.nested?
+          container.contents.each { |item|
+            item.container = container
+            items << item
+          }
+        else
+          container.containers.each do |nested|
+            check_container nested
+            nested.contents.each { |item|
+              item.container = container
+              items << item
+            }
+          end
+        end
+      }
+    items.compact
+  end
+
+  def check_container(container)
+    unless container.contents
+      container.look.at.on
+    end
+  end
+
+
+end

data/lib/Olib/bounty.rb

@@ -1,129 +1,172 @@
-module Olib
-    class Bounty
-      @@procedures            = {}
-
-      @@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[:turn_in]          = /You have succeeded in your task and can return to the Adventurer's Guild to receive your reward/
-      @@re[:guard_turn_in]    = /^You succeeded in your task and should report back to/
-      @@re[:guard_bounty]     = /Go report to ([a-zA-Z ]+) to find out more/
-      @@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_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_bounty]    = /You have failed in your task/
-      @@re[:no_bounty]        = /You are not currently assigned a task/
-
-      # convenience list to get all types of bounties
-      def Bounty.types
-        @@re.keys
-      end
-
-      def Bounty.town
-        checkbounty.match(@@re[ Bounty.type ])[:town]
-      end
-
-      def Bounty.area
-        checkbounty.match(@@re[ Bounty.type ])[:area]
-      end
-
-      def Bounty.destination
-        checkbounty.match(@@re[ Bounty.type ])[:destiniation]
-      end
-
-      def Bounty.gem
-        checkbounty.match(@@re[ Bounty.type ])[:gem]
-      end
-
-      def Bounty.creature
-          checkbounty.match(@@re[ Bounty.type ])[:creature]
-      end
-
-      def Bounty.herb
-          checkbounty.match(@@re[ Bounty.type ])[:herb]
-      end
-
-      def Bounty.n
-          checkbounty.match(@@re[ Bounty.type ])[:number].to_i
-      end
-
-      def Bounty.type
-        t = nil
-        @@re.each do |type, exp|
-          t= type if checkbounty =~ exp
-        end
-        return t
-      end
-
-      def Bounty.current
-          Bounty.type
-      end
-
-      def Bounty.ask_for_bounty
-        fput "ask ##{Bounty.npc.id} for bounty"
-      end
-
-      def Bounty.to_s
-          @@procedures.to_s
-      end
-
-      def Bounty.define_procedure(namespace, &block)
-        @@procedures[namespace] = block
-      end
-
-      def Bounty.procedures
-        @@procedures
-      end
-
-      def Bounty.cooldown?
-        Spell[9003].active?
-      end
-
-      def Bounty.throw_missing_procedure
-        msg = "\n"
-        msg.concat "\nBounty.exec called for #{Bounty.current} without a defined procedure\n\n"
-        msg.concat "define a procedure with:\n"
-        msg.concat " \n" 
-        msg.concat "   Bounty.define_procedure(:#{Bounty.current}) {\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
-      end
-
-      def Bounty.exec(procedure=nil)
-
-        if procedure
-          if @@procedures[procedure]
-            @@procedures[procedure].call
-            return Bounty
-          else 
-            Bounty.throw_missing_procedure
-          end
-        end
-
-        if @@procedures[Bounty.current]
-          @@procedures[Bounty.current].call
-          return Bounty
-        else
-          Bounty.throw_missing_procedure
-        end
-
-      end
-
-      def Bounty.npc
-        GameObj.npcs.select { |npc| npc.name =~ /guard|taskmaster|gemcutter|jeweler|akrash|healer/i }.first
-      end
-
-    end
+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
+
+    def Bounty.town
+      Bounty.current[:town]
+    end
+
+    def Bounty.area
+      Bounty.current[:area]
+    end
+
+    def Bounty.destination
+      Bounty.current[:destiniation]
+    end
+
+    def Bounty.gem
+      Bounty.current[:gem]
+    end
+
+    def Bounty.creature
+      Bounty.current[:creature]
+    end
+
+    def Bounty.herb
+      Bounty.current[:herb]
+    end
+
+    def Bounty.n
+      Bounty.current[:number].to_i
+    end
+
+    def Bounty.type
+      Bounty.current[:type]
+    end
+
+    def Bounty.task
+      Bounty.current
+    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.ask_for_bounty
+      fput "ask ##{Bounty.npc.id} for bounty"
+      Bounty
+    end
+
+    def Bounty.remove
+      Go2.advguild
+      2.times do fput "ask ##{Bounty.npc.id} for remove" end
+      Bounty
+    end
+
+    def Bounty.to_s
+      @@listeners.to_s
+    end
+
+    def Bounty.on(namespace, &block)
+      @@listeners[namespace] = block
+      Bounty
+    end
+
+    def Bounty.listeners
+      @@listeners
+    end
+
+    def Bounty.cooldown?
+      Spell[9003].active?
+    end
+
+    def Bounty.cooldown!
+      if Bounty.cooldown?
+        Go2.origin
+        wait_until { !Bounty.cooldown? }
+      end
+      Bounty
+    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
+    end
+
+    def Bounty.dispatch(listener=nil)
+      if listener
+        if @@listeners[listener]
+          @@listeners[listener].call
+          return Bounty
+        else 
+          Bounty.throw_missing_listener
+        end
+      end
+
+      if @@listeners[Bounty.type]
+        @@listeners[Bounty.type].call
+        return Bounty
+      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
+      return Bounty
+    end
+
+    def Bounty.npc
+      GameObj.npcs.select { |npc| npc.name =~ /guard|taskmaster|gemcutter|jeweler|akrash|kris|healer|dealer/i }.first
+    end
+
+  end
+end
+
+class Bounty < Olib::Bounty
 end