Heel::Configuration

Configuration module used by all the other modules and classes for determining paths and default values.

Constants

HOMEPAGE

Public Class Methods

config_path(*args) click to toggle source
returns
String

The full expanded path of the config directory

below root_dir. All parameters passed in are joined onto the result. Trailing File::SEPARATOR is guaranteed if args are not present.

    # File lib/heel/configuration.rb, line 34
34:     def self.config_path(*args)
35:       self.sub_path("config", *args)
36:     end
data_path(*args) click to toggle source
returns
String

The full expanded path of the data directory below

root_dir. All parameters passed in are joined onto the result. Trailing File::SEPARATOR is guaranteed if _*args_ are not present.

    # File lib/heel/configuration.rb, line 43
43:     def self.data_path(*args)
44:       self.sub_path("data", *args)
45:     end
lib_path(*args) click to toggle source
returns
String

The full expanded path of the lib directory below

root_dir. All parameters passed in are joined onto the result. Trailing File::SEPARATOR is guaranteed if _*args_ are not present.

    # File lib/heel/configuration.rb, line 52
52:     def self.lib_path(*args)
53:       self.sub_path("lib", *args)
54:     end
root_dir() click to toggle source

The root directory of the project is considered to be the parent directory of the ‘lib’ directory.

returns
String

The full expanded path of the parent directory of ‘lib’

going up the path from the current file. Trailing File::SEPARATOR is guaranteed.

    # File lib/heel/configuration.rb, line 20
20:     def self.root_dir
21:       unless @root_dir
22:         path_parts = ::File.expand_path(__FILE__).split(::File::SEPARATOR)
23:         lib_index  = path_parts.rindex("lib")
24:         @root_dir = path_parts[0...lib_index].join(::File::SEPARATOR) + ::File::SEPARATOR
25:       end
26:       return @root_dir
27:     end

Private Class Methods

sub_path(sub,*args) click to toggle source
    # File lib/heel/configuration.rb, line 59
59:     def self.sub_path(sub,*args)
60:       sp = ::File.join(root_dir, sub) + File::SEPARATOR
61:       sp = ::File.join(sp, *args) if args
62:     end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.