beerbot 0.1.5 → 0.2.0.pre.1

data/lib/{BeerBot → beerbot}/02.protocols/irc.rb

@@ -231,7 +231,7 @@ module BeerBot
       end
 
 
-      # Return irc-conformat string from a botmsg hash.
+      # Return irc-conformat string from a botmsg.
       #
       # Generates nil if it can't handle 'botmsg'.
 

data/lib/{BeerBot → beerbot}/06.dispatchers/dispatcher.rb

@@ -6,115 +6,84 @@
 # see <http://www.gnu.org/licenses/>.
 
 require_relative '../00.utils/utils'
-require_relative '../01.bot/BotMsgMore'
 
 module BeerBot
 
-  # Dispatchers receive incoming messages from a connection and
-  # decide what to do with them.
+  # Dispatchers receive incoming messages from a protocol object and
+  # dispatches them (usually to an instance of Bot).
+  #
+  # Dispatcher#receive takes:
+  # 1) event - a symbol representing an event eg :msg, :join etc
+  # 2) args  - an array representing arguments
 
   module Dispatchers
 
-    # This dispatcher receives generic events (provided by a parser
-    # for a given protocol eg irc) and does something with them.
-    #
-    # Dispatcher#receive receives the messages.
+    # This class is basically a glorified struct with a receive method
+    # that is the default way to dispatch to an instance of Bot.
     # 
-    # There are several ways to specify what the dispatcher should do:
-    # 1) just get the result of #receive
-    # 
-    # Or, override #receive's behaviour:
-    # 1) pass in a block at instantiation time
-    # 2) pass in a block using #set_receive
-    # 3) subclass this class and write your own #receive
+    # You have several options if you want to customize...
+    # 1) subclass if you want to pre or post filter
+    # 2) override #receive with your own singleton receive (see tests)
+    # 3) make a new Dispatcher-like class
 
     class Dispatcher
 
       Utils      = BeerBot::Utils
       BotMsg     = BeerBot::BotMsg
-      BotMsgMore = BeerBot::BotMsgMore
       
-      attr_accessor :bot,:nick,:prefix,:world,:more
+      attr_accessor :bot,:nick,:prefix,:config
 
-      def initialize bot,nick,prefix:',',world:nil,&block
+      def initialize bot,nick,prefix:',',config:nil
         @bot = bot
-        @more = BotMsgMore.new
-
         @nick = nick
-        @get_nick_cmd   = Utils.make_prefix_parser(nick)
-        @nickrx = Regexp.new("^#{nick}$",'i')
-
         @prefix = prefix
+        @config = config
+        @get_nick_cmd   = Utils.make_prefix_parser(nick)
+        @nickrx         = Regexp.new("^#{nick}$",'i')
         @get_prefix_cmd = Utils.make_prefix_parser(prefix)
-
-        @world = world
-
-        if block_given? then
-          @block = block
-        end
       end
 
-      # Set a receiving proc.
+      # Receive generic events emitted by a protocol class and
+      # dispatch to an instance of Bot.
       #
-      # If no block given, @block is set to nil and #receive is used.
-
-      def set_receive &block
-        if block_given? then
-          @block = block
-        else
-          @block = nil
-        end
-      end
+      # eg the output from BeerBot::Protocol::IRC.parse .
 
       def receive event,args
 
-        if @block then
-          return self.instance_exec(event,*args,&@block)
-        end
-
         replies = nil
 
         # Otherwise, here is the default behaviour...
 
         case event
         when :unknown
-          replies = @bot.event(event,args:args)
+          replies = @bot.event(event,args:args,config:@config)
         when :default
-          replies = @bot.event(event,args:args)
+          replies = @bot.event(event,args:args,config:@config)
 
         when :nick
           old,nick = args
-          @world.nick(old,nick) if @world
-          replies = @bot.event(event,old:old,nick:nick)
+          replies = @bot.event(event,old:old,nick:nick,config:@config)
 
         when :quit
           nick,msg = args
-          @world.quit(nick) if @world
-          replies = @bot.event(event,nick:nick,msg:msg)
+          replies = @bot.event(event,nick:nick,msg:msg,config:@config)
         when :part
           nick,channel = args
-          @world.part(nick,channel) if @world
-          replies = @bot.event(event,nick:nick,channel:channel)
+          replies = @bot.event(event,nick:nick,channel:channel,config:@config)
         when :join
           nick,channel = args
           me = (@nickrx === nick)
-          @world.join(nick,channel) if @world
-          replies = @bot.event(event,me:me,nick:nick,channel:channel)
+          replies = @bot.event(event,me:me,nick:nick,channel:channel,config:@config)
         when :chanlist
           channel,users = args
-          if @world then
-            users.each {|user|
-              @world.join(user,channel)
-            }
-          end
-          replies = @bot.event(event,channel:channel,users:users)
+          replies = @bot.event(event,channel:channel,users:users,config:@config)
         when :chanlistend
           # ignore
 
         when :action
           from,to,action = args
           me = (@nickrx === to)
-          replies = @bot.action(action,from:from,to:to,me:me,world:world)
+          replies = @bot.action(action,from:from,to:to,me:me,config:@config)
 
         when :msg
           from,to,msg = args
@@ -131,9 +100,6 @@ module BeerBot
 
           if cmd then
             case cmd
-            # dispatch more-filtering...
-            when /^more!*|moar!*$/i
-              replies = @more.more(to)
             # dispatch help...
             when /^\s*help(?:\s+(.*))?$/
               if $1.nil? then
@@ -141,14 +107,14 @@ module BeerBot
               else
                 args = $1.strip.split(/\s+/)
               end
-              replies = @bot.help(args,from:from,to:to,me:me,world:world)
+              replies = @bot.help(args,from:from,to:to,me:me,config:@config)
             # dispatch cmd...
             else
-              replies = @bot.cmd(cmd,from:from,to:to,me:me,world:world)
+              replies = @bot.cmd(cmd,from:from,to:to,me:me,config:@config)
             end
           else
             # We're just hearing something on a channel...
-            replies = @bot.hear(msg,from:from,to:to,me:me,world:world)
+            replies = @bot.hear(msg,from:from,to:to,me:me,config:@config)
           end
 
         else
@@ -159,8 +125,7 @@ module BeerBot
         when String # assume protocol string eg irc
           replies
         when Hash,Array,Proc
-          # more-filter the reply...
-          replies = @more.filter(replies)
+          BotMsg.to_a(replies)
         else
           []
         end

data/lib/{BeerBot → beerbot}/Config.rb

@@ -7,16 +7,44 @@
 
 module BeerBot
 
-  # Config should be loaded with the json from a config file before
+  # Config can be loaded with the json from a config file before
   # initialisation of the system.
   #
+  # Config might be a bit of a misnomer, think of this as "an
+  # injectable thing that contains a lot of useful information".
+  #
   # It should be available to things like bot modules eg
   #   BeerBot::Config['datadir']
   # 
 
-  Config = {}
+  class Config < Hash
+
+    # Should point to 'the' instance of scheduler used by this bot.
+
+    attr_accessor :scheduler
+
+    # Should reference the Bot instance.
+    #
+    # This will allow modules to inspect the bot module list and to
+    # override normal cmd behaviour (using Bot#set_cmd ).
+
+    attr_accessor :bot
 
-  class << Config
+    # A queue that allows users of config to enqueue outgoing bot
+    # msg's actively.
+    #
+    # (passive = "as response to a command via Bot#cmd").
+
+    def out
+      @queue ||= Queue.new
+    end
+
+    def initialize **kargs
+      # Defaults
+      self['cmd_prefix'] = ','
+      self['nick'] = 'beerbot'
+      self.merge(kargs)
+    end
 
     def load config
       self.reject!{true}
@@ -40,6 +68,11 @@ module BeerBot
 
     # Return path for module data dir -- a place where the module can
     # stash data.
+    #
+    #   module_data('foo') => <datadir>/modules/foo
+    #   module_data('foo') {
+    #     ... set pwd to this dir...
+    #   }
 
     def module_data name,&block
       self.validate!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beerbot
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0.pre.1
 platform: ruby
 authors:
 - Daniel Bush
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-03 00:00:00.000000000 Z
+date: 2014-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -84,30 +84,23 @@ description: '["Out of the box you get an irc bot, but beerbot could be so much
   ["Daniel Bush"]]'
 email: dlb.id.au@gmail.com
 executables:
-- run-irc.rb
+- beerbot-run-irc.rb
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/BeerBot/00.utils/utils.rb
-- lib/BeerBot/00.utils/param_expand.rb
-- lib/BeerBot/00.utils/sentence_expand.rb
-- lib/BeerBot/00.utils/DataFile.rb
-- lib/BeerBot/00.utils/InOut.rb
-- lib/BeerBot/00.utils/More.rb
-- lib/BeerBot/00.utils/world/World.rb
-- lib/BeerBot/00.utils/world/IRCWorld.rb
-- lib/BeerBot/01.connect/IRCConnection.rb
-- lib/BeerBot/01.bot/botmsg.rb
-- lib/BeerBot/01.bot/BotModule.rb
-- lib/BeerBot/01.bot/Bot.rb
-- lib/BeerBot/01.bot/BotMsgMore.rb
-- lib/BeerBot/02.protocols/irc.rb
-- lib/BeerBot/06.dispatchers/dispatcher.rb
-- lib/BeerBot/70.scheduler/scheduler.rb
-- lib/BeerBot/Config.rb
-- lib/BeerBot.rb
+- lib/beerbot/00.utils/utils.rb
+- lib/beerbot/00.utils/InOut.rb
+- lib/beerbot/01.connect/IRCConnection.rb
+- lib/beerbot/01.bot/BotModule.rb
+- lib/beerbot/01.bot/botmsg.rb
+- lib/beerbot/01.bot/Bot.rb
+- lib/beerbot/02.protocols/irc.rb
+- lib/beerbot/06.dispatchers/dispatcher.rb
+- lib/beerbot/70.scheduler/scheduler.rb
+- lib/beerbot/Config.rb
+- lib/beerbot.rb
 - lib/RunIRC.rb
-- bin/run-irc.rb
+- bin/beerbot-run-irc.rb
 homepage: http://github.com/danielbush/BeerBot
 licenses:
 - GPL
@@ -123,9 +116,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.1.10

data/lib/BeerBot.rb

@@ -1,22 +0,0 @@
-require 'CronR' # For scheduler
-
-require_relative 'BeerBot/00.utils/utils'
-require_relative 'BeerBot/00.utils/param_expand'
-require_relative 'BeerBot/00.utils/sentence_expand'
-require_relative 'BeerBot/00.utils/DataFile'
-require_relative 'BeerBot/00.utils/InOut'
-require_relative 'BeerBot/00.utils/world/IRCWorld'
-require_relative 'BeerBot/01.connect/IRCConnection'
-require_relative 'BeerBot/01.bot/botmsg'
-require_relative 'BeerBot/01.bot/BotModule'
-require_relative 'BeerBot/01.bot/Bot'
-require_relative 'BeerBot/01.bot/BotMsgMore'
-require_relative 'BeerBot/02.protocols/irc'
-require_relative 'BeerBot/06.dispatchers/dispatcher'
-require_relative 'BeerBot/70.scheduler/scheduler'
-require_relative 'BeerBot/Config'
-
-module BeerBot
-  module Modules
-  end
-end

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

@@ -1,103 +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 'json'
-
-module BeerBot
-
-  module Utils
-
-    # A class that loads data from a file and allows you to access it
-    # using the #data method.
-    #
-    # If the file is updated (after >=1 sec), #data will reload.
-
-    class DataFile
-
-      attr_reader :reloaded  # true if last call to #data reloaded file
-
-      def self.create! filepath
-        File.open(filepath,'w'){}
-        self.new(filepath)
-      end
-
-      def initialize filepath
-        @filepath = filepath
-        @data = File.read(filepath)
-        @mtime = File.stat(filepath).mtime
-        @reloaded = false
-      end
-
-      # Load data from file.
-
-      def data
-        @reloaded = false
-        return @data unless File.exists?(@filepath)
-        mtime = File.stat(@filepath).mtime
-        return @data if mtime == @mtime
-        puts "Reloading data file #{@filepath}"
-        @mtime = mtime
-        @data = File.read(@filepath)
-        @reloaded = true
-        @data
-      end
-
-      def save thing
-        File.open(@filepath,'w') {|f|
-          f.write(thing)
-        }
-      end
-
-    end
-
-    # Specialised DataFile that parses json.
-
-    class JsonDataFile < DataFile
-
-      attr_reader :json
-
-      def self.create! filepath,data={}
-        File.open(filepath,'w') {|f| f.puts(data.to_json)}
-        self.new(filepath)
-      end
-
-      def initialize filepath
-        super
-        @json = JSON.parse(@data)
-      end
-
-      # Load data from file and parse as json data.
-
-      def data
-        super
-        begin
-          if @reloaded then
-            json = JSON.parse(@data)
-            @json = json
-          end
-        rescue => e
-          return @json
-        end
-        @json
-      end
-
-      # Save thing back to file.
-      #
-      # Thing is assumed to be a hash or array that we call to_json on.
-
-      def save thing=nil
-        if thing.nil? then
-          thing = @json  # the thing self.data returns
-        end
-        super(thing.to_json)
-      end
-
-    end
-
-  end
-
-end