Module: Jabbot

Defined in:
lib/jabbot.rb,
lib/jabbot/bot.rb,
lib/jabbot/config.rb,
lib/jabbot/macros.rb,
lib/jabbot/message.rb,
lib/jabbot/handlers.rb

Defined Under Namespace

Modules: Handlers, Macros Classes: Bot, Config, FileConfig, Handler, Message

Constant Summary collapse

VERSION =

:stopdoc:

'0.1.2'
LIBPATH =
::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
PATH =
::File.dirname(LIBPATH) + ::File::SEPARATOR
@@app_file =
lambda do
  ignore = [
    /lib\/twibot.*\.rb/, # Library
    /\(.*\)/,            # Generated code
    /custom_require\.rb/ # RubyGems require
  ]
   path = caller.map { |line| line.split(/:\d/, 2).first }.find do |file|
    next if ignore.any? { |pattern| file =~ pattern }
    file
  end
   path || $0
end.call
@@prompt =
false

Class Method Summary collapse

Class Method Details

.app_fileObject

File name of the application file. Inspired by Sinatra



68
69
70
# File 'lib/jabbot.rb', line 68

def self.app_file
  @@app_file
end

.libpath(*args) ⇒ Object

Returns the library path for the module. If any arguments are given, they will be joined to the end of the libray path using File.join.



27
28
29
# File 'lib/jabbot.rb', line 27

def self.libpath( *args )
  args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
end

.path(*args) ⇒ Object

Returns the lpath for the module. If any arguments are given, they will be joined to the end of the path using File.join.



35
36
37
# File 'lib/jabbot.rb', line 35

def self.path( *args )
  args.empty? ? PATH : ::File.join(PATH, args.flatten)
end

.prompt=(p) ⇒ Object



4
5
6
# File 'lib/jabbot/macros.rb', line 4

def self.prompt=(p)
  @@prompt = f
end

.require_all_libs_relative_to(fname, dir = nil) ⇒ Object

Utility method used to require all files ending in .rb that lie in the directory below this file that has the same name as the filename passed in. Optionally, a specific directory name can be passed in such that the filename does not have to be equivalent to the directory.



44
45
46
47
48
# File 'lib/jabbot.rb', line 44

def self.require_all_libs_relative_to( fname, dir = nil )
  dir ||= File.basename(fname, '.*')
  search_me = File.expand_path(File.join(File.dirname(fname), dir, '**', '*.rb'))
  Dir.glob(search_me).sort.each {|rb| require rb }
end

.run?Boolean

Runs application if application file is the script being executed

Returns:

  • (Boolean)


75
76
77
# File 'lib/jabbot.rb', line 75

def self.run?
  self.app_file == $0
end

.versionObject

Returns the version string for the library.



19
20
21
# File 'lib/jabbot.rb', line 19

def self.version
  VERSION
end