Class: ModSpox::BotConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/mod_spox/BotConfig.rb

Constant Summary collapse

@@config = 
nil

Class Method Summary collapse

Class Method Details

.[](name) ⇒ Object

name

Name of the path string you would like

Provides access to important path values

Raises:



48
49
50
51
52
53
 
# File 'lib/mod_spox/BotConfig.rb', line 48

def BotConfig.[](name)
    BotConfig.populate unless @@config
    name = name.to_sym unless name.is_a?(Symbol)
    raise Exceptions::UnknownKey.new("Failed to find given key: #{name}") unless @@config.has_key?(name)
    return @@config[name]
end

.configured? ⇒ Boolean

Returns if the bot has been configured

Returns:

  • (Boolean) 


56
57
58
59
60
61
 
# File 'lib/mod_spox/BotConfig.rb', line 56

def BotConfig.configured?
    BotConfig.populate(false)
    path = BotConfig[:userpath]
    @@config = nil
    return File.exists?(path)
end

.populate(createdir = true) ⇒ Object

Populates all important paths. This does not need to be explicitly called though nothing bad will happen if it is. Keys available are: :basepath => path to gem directory :libpath => path to lib directory :datapath => path to data directory :pluginpath => path to plugin directory :pluginextraspath => path to extra functionality plugins :userpath => path to mod_spox directory in user’s home directory :userpluginpath => path to user’s plugin directory :userconfigpath => path to the user configuration file



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/mod_spox/BotConfig.rb', line 21

def BotConfig.populate(createdir=true)
    gemname, gem = Gem.source_index.find{|name, spec|
        spec.name == 'mod_spox' && spec.version.version = ModSpox.botversion
    }
    if(gem)
        p = gem.full_gem_path
        up = ModSpox.mod_spox_path.nil? ? Etc.getpwnam(Etc.getlogin).dir : ModSpox.mod_spox.path
        @@config = {:basepath => p,
                   :libpath => "#{p}/lib/mod_spox",
                   :datapath => "#{p}/data/mod_spox",
                   :pluginpath => "#{p}/data/mod_spox/plugins",
                   :pluginextraspath => "#{p}/data/mod_spox/extras",
                   :userpath => "#{up}/.mod_spox",
                   :userpluginpath => "#{up}/.mod_spox/plugins",
                   :userconfigpath => "#{up}/.mod_spox/config"}
        if(createdir)
            [@@config[:userpath], @@config[:userpluginpath]].each do |path|
                Dir.mkdir(path) unless File.exists?(path)
            end
        end
    else
        raise Exceptions::InstallationError.new('Failed to find mod_spox gem')
    end
end