Class: Ruport::Config

Inherits:
Object
  • Object
show all
Includes:
Singleton
Defined in:
lib/ruport/config.rb

Overview

This class serves as the configuration system for Ruport. It’s functionality is implemented through Config::method_missing

source :default and mailer :default will become the fallback values if one is not specified in Report::Mailer or Query, but you may define as many sources as you like and switch between them later.

An example config file is shown below:

# password is optional, dsn may omit hostname for localhost
Ruport::Config.source :default,
:dsn => "dbi:mysql:somedb:db.blixy.org", :user => "root", :password => "chunky_bacon"

# :password, :port, and :auth_type are optional. :port defaults to 25 and
# :auth_type defaults to :plain.  For more information, see the source
# of Report::Mailer#select_mailer
Ruport::Config.mailer :default,
:host => "mail.chunkybacon.org", :address => "[email protected]",
:user => "cartoon", :password => "fox", :port => 25, :auth_type => :login

# optional, if specifed, Ruport#complain will report to it
Ruport::Config.log_file 'foo.log'

# optional, if enabled, will force :log_only complaint calls to
# print to secondary output ($sterr by default).
# call Ruport::Config.disable_paranoia to disable
Ruport::Config.enable_paranoia

Alternatively, this configuration could be done by opening the class:

class Ruport::Config

  source :default, :dsn => "dbi:mysql:some_db", :user => "root"

  mailer :default, :host => "mail.iheartwhy.com", 
  :address => "[email protected]", :user => "sandal",
  :password => "abc123"

  logfile 'foo.log'

end

Saving this config information into a file and then requiring it can allow you share configurations between Ruport applications.

Class Method Summary collapse

Class Method Details

.method_missing(method_id, *args) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/ruport/config.rb', line 62

def Config.method_missing(method_id,*args)
  case(method_id)
  when :source
    return @@sources[args.first] if args.length == 1
    @@sources[args.first] = OpenStruct.new(*args[1..-1])
    unless @@sources[args.first].send(:dsn)
      Ruport.complain("Bad or missing DSN for source #{args.first}!")
    end
  when :mailer
    @@mailers[args.first] = OpenStruct.new(*args[1..-1])
  when :log_file
    @@logger = Logger.new(args.first)
  when :default_source
    @@sources[:default]
  when :default_mailer
    @@mailers[:default]
  when :sources
    @@sources
  when :mailers
    @@mailers
  when :logger
    @@logger
  when :enable_paranoia
    @@paranoid = true
  when :disable_paranoia
    @@paranoid = false
  when :paranoid?
    @@paranoid
  else
    super
  end 
end