beerbot 0.1.5 → 0.2.0.pre.1

data/lib/BeerBot/00.utils/More.rb

@@ -1,68 +0,0 @@
-# The files in this directory are part of BeerBot, a a ruby irc bot library.
-# Copyright (C) 2014 Daniel Bush
-# This program is distributed under the terms of the GNU
-# General Public License.  A copy of the license should be
-# enclosed with this project in the file LICENSE.  If not
-# see <http://www.gnu.org/licenses/>.
-
-module BeerBot
-
-  module Utils
-
-    # A hash that buffers things by some key.
-    #
-    # If 'things' exceeds a set number, then these are stored in an
-    # array against the key.
-    #
-    # For irc and other messaging the key should probably
-    # be key :to of one or more botmsg's.
-    # @see BotMsgMore
-
-    class More < Hash
-
-      attr_accessor :size
-
-      def initialize
-        super
-        # Default value is empty array.
-        self.default_proc = lambda {|h,k|
-          h[k] = []
-        }
-      end
-
-      def size
-        @size ||= 5  # lines
-      end
-
-      # Fetch array of items from buffer for key 'key'.
-      #
-      # 'key' should probably be a person or channel you are messaging.
-      #
-      # Should return an array of items (eg of botmsg hashes).
-
-      def more key
-        arr = self[key]
-        self[key] = arr.slice(self.size,arr.size) || []
-        return arr.slice(0,self.size-1)
-      end
-
-      # Filter an array of items allowing only
-      # the first 'n' of these.
-      #
-      # The remainder are stored in this hash and can
-      # be accessed via 'key' using 'self.more'.
-
-      def filter arr,key
-        if arr.size <= self.size then
-          self[key] = [] # reset buffer
-          return arr
-        end
-        self[key] = arr.slice(self.size,size)
-        return arr.slice(0,self.size)
-      end
-
-    end
-
-  end
-
-end

data/lib/BeerBot/00.utils/param_expand.rb

@@ -1,105 +0,0 @@
-# The files in this directory are part of BeerBot, a a ruby irc bot library.
-# Copyright (C) 2014 Daniel Bush
-# This program is distributed under the terms of the GNU
-# General Public License.  A copy of the license should be
-# enclosed with this project in the file LICENSE.  If not
-# see <http://www.gnu.org/licenses/>.
-
-
-module BeerBot
-
-  module Utils
-
-    module ParamExpand
-
-      # Look for parameters in a string.
-      #
-      # Numeric parameters => "... ::1 ... ::2 "
-      # Key parameters => "... ::foo ... ::bar "
-      # Multi => "... ::foo|::1 ... ::bar|::foo|::1 "
-      # 
-      # (?: ) is a non-capturing group.
-
-      def self.scan_param msg
-        matches = msg.scan(/(?:::[^\W\s:|]*(?:\|::[^\W\s:|]*)*)/)
-        matches.map{|m|
-          a = m.split('|').map{|m2|
-            m2 = m2.sub('::','')
-            case m2
-            when /^\d+$/
-              m2.to_i
-            else
-              m2
-            end
-          }
-          [m,a]
-        }
-      end
-
-      # Expand a string with numeric and key parameters using data
-      # provided.
-      #
-      # Parameters should be preceded with a double-colon in the msg.
-      # Numeric parameters are matched to 'args'.
-      # So ::1 => args[0] etc
-      #
-      # 'expand' will return the expanded string as best it can and an
-      # error object.
-      # The error object will tell you if there weren't enough
-      # parameters in args to satisfy the numeric parameters in the
-      # string.
-      # 
-      # Example:
-      # 
-      #   "::1 ::foo ::bar|::1" using ('a',foo:'b')
-      #   => "a b a"
-
-      def self.expand msg,*args,**kargs
-        errargs = []
-        params = self.scan_param(msg)
-        # Do the big ones first.
-        params = params.sort{|a,b|b[1].size<=>a[1].size}
-        params.each {|i|
-          # pattern: "::1|::foo"
-          # parts: [1,'foo']
-          pattern,parts = i
-          found = false
-          _errargs = []
-          _errkargs = []
-          parts.each {|part|
-            v = nil
-            case part
-            when Fixnum
-              v = args[part-1]
-              _errargs.push(part) unless v
-            else
-              if part == '' then  # pattern is or contains '::' which has part ''.
-                v = ''
-              else
-                v = kargs[part.to_sym]
-                _errkargs.push(part) unless v
-              end
-            end
-            if v then
-              if v == '' then
-                #byebug
-                # Squeeze spaces.  Not perfect, but it'll do.
-                msg = msg.gsub(/ ?#{pattern.gsub('|','\|')} ?/,' ')
-              else
-                msg = msg.gsub(pattern,v.to_s)
-              end
-              found = true
-            end
-          }
-          unless found then
-            errargs += _errargs
-          end
-        }
-        [msg,errargs]
-      end
-
-    end
-
-  end
-
-end

data/lib/BeerBot/00.utils/sentence_expand.rb

@@ -1,77 +0,0 @@
-# The files in this directory are part of BeerBot, a a ruby irc bot library.
-# Copyright (C) 2014 Daniel Bush
-# This program is distributed under the terms of the GNU
-# General Public License.  A copy of the license should be
-# enclosed with this project in the file LICENSE.  If not
-# see <http://www.gnu.org/licenses/>.
-
-
-module BeerBot
-
-  module Utils
-
-    # Randomly generate sentences.
-    #
-    # See spec examples in spec/.
-    # 
-    # Take a spec which is of form
-    #   [<sentence>,<hash>]
-    # where <sentence> is a string and
-    # each entry in <hash>
-    #   <key> => <value>
-    # where <key> is a symbol, and <value>
-    # is an array of <sentence>'s.
-    # 
-    # <sentence> is a sentence or phrase.
-    # If a word starts with ':' it will be looked up
-    # in <hash>, an entry from <value> will be randomly
-    # selected.
-    # The entry from <value> will also undergo the
-    # same ':' substitution.
-
-    module SentenceExpand
-
-      # Recursively expand a sentence with parameters starting with
-      # ':' using values sampled from params.
-      # 
-      # Split, map and rejoin a sentence (str).
-      #
-      # After splitting, apply expand on parameter words ":word".
-      #
-      # Watch out, throws error, be prepared.
-
-      def self.expand(str,params,raise_error=false)
-        words = str.split(/\s+/)  # not great, we lose additional spaces
-        words.map {|word|
-          if word[0] == ':' then
-            if word[1] == ':' then
-              word  # let the bot code gsub this; ::from , ::to
-            else
-              self.expand(
-                self.lookup(word[1..-1],params,raise_error),
-                params,raise_error
-              )
-            end
-          else
-            word
-          end
-        }.select{|word| word != nil && word != ""}.join(' ').strip
-      end
-      
-      # Randomly select entry from params.
-
-      def self.lookup(str,params,raise_error=false)
-        if not params.has_key?(str) then
-          if raise_error then
-            raise "'#{str}' has no corresponding symbol in params #{params}"
-          else
-            return ""
-          end
-        end
-        result = params[str].sample
-        result ? result : ""
-      end
-
-    end
-  end
-end

data/lib/BeerBot/00.utils/utils.rb

@@ -1,92 +0,0 @@
-# The files in this directory are part of BeerBot, a a ruby irc bot library.
-# Copyright (C) 2014 Daniel Bush
-# This program is distributed under the terms of the GNU
-# General Public License.  A copy of the license should be
-# enclosed with this project in the file LICENSE.  If not
-# see <http://www.gnu.org/licenses/>.
-
-
-module BeerBot
-
-  module Utils
-
-    # Return a parser that takes string msg and extracts a specified
-    # prefix at beginning.
-    #
-    # The prefix might be a nick or a command prefix.
-    #
-    # Use this to get commands issued to the bot through a channel.
-    #
-    # TODO: make sure this returns msg without the prefix, or nil
-    # otherwise.
-
-    def self.make_prefix_parser prefix
-      rx = Regexp.new("^#{prefix}\\W?(.*)",'i')
-      lambda {|msg|
-        if m = rx.match(msg) then
-          m[1].strip
-        end
-      }
-    end
-
-    # Regex that looks for a sed command eg
-    # "s/pattern/replacement/flags" in a string.
-    #
-    # This regex doesn't handle backslash escapes, so if pattern or
-    # replacement contain '/' use another delimiter eg s#...#...# etc.
-    # 
-    # Non alphanumeric delimiters are allowed.
-    #
-    # Returns: nil or a MatchData instance with symbol keys:
-    #  :sed (the whole sed command), :sep (the separator), :pattern,
-    #  :replacement, :flags
-    #
-    # If you want to combine this regex, call
-    #   sed_regex.source => <string>
-
-    def self.sed_regex
-      %r{
-        ^(?<before>.*)
-        \b
-        (?<sed>
-          s
-          (?<sep>[^A-z0-9\s])
-          (?<pattern>(?!\g<sep>)*.*)
-          \k<sep>
-          (?<replacement>(?!\g<sep>)*.*)
-          \k<sep>
-          (?<flags>[A-z]*)
-        )
-        (?<after>.*)$
-      }x
-    end
-
-    # Could use in a botmsg
-    #
-    # [to:to,msg:weighted_sample({90=>['yes','ok','fine'],10=>[...]})]
-
-    def weighted_sample thing
-      case thing
-      when Hash
-        keys = thing.keys
-        total = keys.reduce{|s,i|s+i}
-        i = Kernel.rand(total)
-        k = keys.reduce{|s,k|s+=k; if s>=i then break k; else s end}
-        case thing[k]
-        when Array
-          thing[k].sample
-        when String
-          thing[k]
-        when Hash
-          weight_sample(thing[k])
-        else
-          nil
-        end
-      else
-        nil
-      end
-    end
-
-  end
-
-end

data/lib/BeerBot/00.utils/world/IRCWorld.rb

@@ -1,47 +0,0 @@
-# The files in this directory are part of BeerBot, a a ruby irc bot library.
-# Copyright (C) 2014 Daniel Bush
-# This program is distributed under the terms of the GNU
-# General Public License.  A copy of the license should be
-# enclosed with this project in the file LICENSE.  If not
-# see <http://www.gnu.org/licenses/>.
-
-require_relative 'World'
-
-module BeerBot
-
-  module Utils
-
-    # The chief specialisation of IRCWorld is to handle user names which
-    # are sometimes prepended with characters like '@'.
-    #
-    # TODO: are there any more?
-
-    class IRCWorld < World
-      def remove_op nick
-        nick.sub(/^@/,'')
-      end
-
-      def nick oldnick,nick
-        oldnick = self.remove_op(oldnick)
-        nick = self.remove_op(nick)
-        super
-      end
-
-      def part nick,channel
-        nick = self.remove_op(nick)
-        super
-      end
-      
-      def join nick,channel
-        nick = self.remove_op(nick)
-        super
-      end
-
-      def quit nick
-        nick = self.remove_op(nick)
-        super
-      end
-    end
-
-  end
-end

data/lib/BeerBot/00.utils/world/World.rb

@@ -1,74 +0,0 @@
-# The files in this directory are part of BeerBot, a a ruby irc bot library.
-# Copyright (C) 2014 Daniel Bush
-# This program is distributed under the terms of the GNU
-# General Public License.  A copy of the license should be
-# enclosed with this project in the file LICENSE.  If not
-# see <http://www.gnu.org/licenses/>.
-
-module BeerBot
-
-  module Utils
-
-    # There should be one world per connection instance tracking
-    # the channels joined and users on those channels.
-
-    class World < Hash
-
-      def initialize nick
-        self[:nick] = nick
-
-        # An index/lookup for channels we know about.
-        self[:channels] = Hash.new {|h,k| h[k] = {users:Set.new}}
-
-        # An index/lookup for users we know about.
-        self[:users] = Hash.new {|h,k| h[k] = {channels:Set.new}}
-
-      end
-
-      # Someone joins channel.
-      def join nick,channel
-        self[:channels][channel][:users].add(nick)
-        self[:users][nick][:channels].add(channel)
-        self[:users][nick][:quit] = false
-        self
-      end
-
-      # Someone leaves channel.
-      def part nick,channel
-        self[:channels][channel][:users].delete(nick)
-        self[:users][nick][:channels].delete(channel)
-        self
-      end
-
-      # Someone changes nick.
-      def nick oldnick,nick
-        self[:channels].each_pair{|name,chan|
-          if chan[:users].member?(oldnick) then
-            chan[:users].delete(oldnick)
-            chan[:users].add(nick)
-          end
-        }
-        self[:users][nick] = self[:users][oldnick]
-        self[:users].delete(oldnick)
-        # If it's us, update our nick:
-        if self[:nick] == oldnick then
-          self[:nick] = nick
-        end
-        self
-      end
-
-      def quit nick
-        self[:channels].each_pair{|name,chan|
-          chan[:users].delete(nick)
-        }
-        self[:users][nick][:channels] = Set.new
-        self[:users][nick][:quit] = true
-        self
-      end
-
-    end
-
-  end
-
-end
-