Class: Merb::Config

Inherits:
Object show all
Defined in:
lib/merb-core/config.rb

Defined Under Namespace

Classes: ConfigBlock

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configuration ⇒ Object

Returns the value of attribute configuration.



254
255
256
 
# File 'lib/merb-core/config.rb', line 254

def configuration
  @configuration
end

Class Method Details

.[](key) ⇒ Object

Parameters

key<Object>

The key to retrieve the parameter for.

Returns

Object

The value of the configuration parameter.



59
60
61
 
# File 'lib/merb-core/config.rb', line 59

def [](key)
  (@configuration||={})[key]
end

.[]=(key, val) ⇒ Object

Parameters

key<Object>

The key to set the parameter for.

val<Object>

The value of the parameter.



66
67
68
 
# File 'lib/merb-core/config.rb', line 66

def []=(key,val)
  @configuration[key] = val
end

.configure(&block) ⇒ Object

Set configuration parameters from a code block, where each method evaluates to a config parameter.

Parameters

&block

Configuration parameter block.

Examples

# Set environment and log level.
Merb::Config.configure do
  environment "development"
  log_level   "debug"
end



268
269
270
 
# File 'lib/merb-core/config.rb', line 268

def configure(&block)
  ConfigBlock.new(self, &block) if block_given?
end

.defaults ⇒ Object

Returns

Hash

The defaults for the config.



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/merb-core/config.rb', line 12

def defaults
  @defaults ||= {
    :host                   => "0.0.0.0",
    :port                   => "4000",
    :adapter                => "runner",
    :reload_classes         => true,
    :environment            => "development",
    :merb_root              => Dir.pwd,
    :use_mutex              => true,
    :session_id_key         => "_session_id",
    :log_delimiter          => " ~ ",
    :log_auto_flush         => false,
    :log_level              => :info,
    :disabled_components    => [],
    :deferred_actions       => [],
    :verbose                => false
  }
end

.delete(key) ⇒ Object

Parameters

key<Object>

The key of the parameter to delete.



72
73
74
 
# File 'lib/merb-core/config.rb', line 72

def delete(key)
  @configuration.delete(key)
end

.fetch(key, default) ⇒ Object

Parameters

key<Object>

The key to retrieve the parameter for.

default<Object>

The default value to return if the parameter is not set.

Returns

Object

The value of the configuration parameter or the default.



83
84
85
 
# File 'lib/merb-core/config.rb', line 83

def fetch(key, default)
  @configuration.fetch(key, default)
end

.key?(key) ⇒ Boolean

Parameters

key<Object>

The key to check.

Returns

Boolean

True if the key exists in the config.

Returns:

  • (Boolean) 


50
51
52
 
# File 'lib/merb-core/config.rb', line 50

def key?(key)
  @configuration.key?(key)
end

.method_missing(method, *args) ⇒ Object

Allows retrieval of single key config values via Merb.config.<key> Allows single key assignment via Merb.config.<key> = …

Parameters

method<~to_s>

Method name as hash key value.

*args

Value to set the configuration parameter to.



278
279
280
281
282
283
284
 
# File 'lib/merb-core/config.rb', line 278

def method_missing(method, *args)
  if method.to_s[-1,1] == '='
    @configuration[method.to_s.tr('=','').to_sym] = *args
  else
    @configuration[method]
  end
end

.parse_args(argv = ARGV) ⇒ Object

Parses the command line arguments and stores them in the config.

Parameters

argv<String>

The command line arguments. Defaults to ARGV.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/merb-core/config.rb', line 112

def parse_args(argv = ARGV)
  @configuration ||= {}
  # Our primary configuration hash for the length of this method
  options = {}

  # Environment variables always win
  options[:environment] = ENV["MERB_ENV"] if ENV["MERB_ENV"]

  # Build a parser for the command line arguments
  opts = OptionParser.new do |opts|
    opts.version = Merb::VERSION
    opts.release = Merb::RELEASE

    opts.banner = "Usage: merb [uGdcIpPhmailLerkKX] [argument]"
    opts.define_head "Merb. Pocket rocket web framework"
    opts.separator '*'*80
    opts.separator 'If no flags are given, Merb starts in the foreground on port 4000.'
    opts.separator '*'*80

    opts.on("-u", "--user USER", "This flag is for having merb run as a user other than the one currently logged in. Note: if you set this you must also provide a --group option for it to take effect.") do |user|
      options[:user] = user
    end

    opts.on("-G", "--group GROUP", "This flag is for having merb run as a group other than the one currently logged in. Note: if you set this you must also provide a --user option for it to take effect.") do |group|
      options[:group] = group
    end

    opts.on("-d", "--daemonize", "This will run a single merb in the background.") do |daemon|
      options[:daemonize] = true
    end

    opts.on("-c", "--cluster-nodes NUM_MERBS", "Number of merb daemons to run.") do |nodes|
      options[:cluster] = nodes
    end

    opts.on("-I", "--init-file FILE", "File to use for initialization on load, defaults to config/init.rb") do |init_file|
      options[:init_file] = init_file
    end

    opts.on("-p", "--port PORTNUM", "Port to run merb on, defaults to 4000.") do |port|
      options[:port] = port
    end

    opts.on("-o", "--socket-file FILE", "Socket file to run merb on, defaults to [Merb.root]/log/merb.sock") do |port|
      options[:socket_file] = port
    end

    opts.on("-s", "--socket SOCKNUM", "Socket number to run merb on, defaults to 0.") do |port|
      options[:socket] = port
    end

    opts.on("-P", "--pid PIDFILE", "PID file, defaults to [Merb.root]/log/merb.[port_number].pid") do |pid_file|
      options[:pid_file] = pid_file
    end

    opts.on("-h", "--host HOSTNAME", "Host to bind to (default is 0.0.0.0).") do |host|
      options[:host] = host
    end

    opts.on("-m", "--merb-root /path/to/approot", "The path to the Merb.root for the app you want to run (default is current working dir).") do |root|
      options[:merb_root] = File.expand_path(root)
    end

    opts.on("-a", "--adapter mongrel", "The rack adapter to use to run merb[mongrel, emongrel, thin, ebb, fastcgi, webrick, runner, irb]") do |adapter|
      options[:adapter] = adapter
    end

    opts.on("-R", "--rackup FILE", "Load an alternate Rack config file (default is config/rack.rb)") do |rackup|
      options[:rackup] = rackup
    end

    opts.on("-i", "--irb-console", "This flag will start merb in irb console mode. All your models and other classes will be available for you in an irb session.") do |console|
      options[:adapter] = 'irb'
    end

    opts.on("-S", "--sandbox", "This flag will enable a sandboxed irb console. If your ORM supports transactions, all edits will be rolled back on exit.") do |sandbox|
      options[:sandbox] = true
    end

    opts.on("-l", "--log-level LEVEL", "Log levels can be set to any of these options: debug < info < warn < error < fatal") do |log_level|
      options[:log_level] = log_level.to_sym
    end

    opts.on("-L", "--log LOGFILE", "A string representing the logfile to use.") do |log_file|
      options[:log_file] = log_file
    end

    opts.on("-e", "--environment STRING", "Run merb in the correct mode(development, production, testing)") do |env|
      options[:environment] = env
    end

    opts.on("-r", "--script-runner ['RUBY CODE'| FULL_SCRIPT_PATH]",
    "Command-line option to run scripts and/or code in the merb app.") do |code_or_file|
      options[:runner_code] = code_or_file
      options[:adapter] = 'runner'
    end

    opts.on("-K", "--graceful PORT or all", "Gracefully kill one merb proceses by port number.  Use merb -K all to gracefully kill all merbs.") do |ports|
      options[:action] = :kill
      options[:port] = ports
    end

    opts.on("-k", "--kill PORT or all", "Kill one merb proceses by port number.  Use merb -k all to kill all merbs.") do |port|
      options[:action] = :kill_9
      options[:port] = port
    end

    opts.on("-X", "--mutex on/off", "This flag is for turning the mutex lock on and off.") do |mutex|
      if mutex == "off"
        options[:use_mutex] = false
      else
        options[:use_mutex] = true
      end
    end

    opts.on("-D", "--debugger", "Run merb using rDebug.") do
      begin
        require "ruby-debug"
        Debugger.start
        Debugger.settings[:autoeval] = true if Debugger.respond_to?(:settings)
        puts "Debugger enabled"
      rescue LoadError
        puts "You need to install ruby-debug to run the server in debugging mode. With gems, use 'gem install ruby-debug'"
        exit
      end
    end

    opts.on("-V", "--verbose", "Print extra information") do
      options[:verbose] = true
    end

    opts.on("-?", "-H", "--help", "Show this help message") do
      puts opts
      exit
    end
  end

  # Parse what we have on the command line
  opts.parse!(argv)
  Merb::Config.setup(options)
end

.setup(settings = {}) ⇒ Object

Sets up the configuration by storing the given settings.

Parameters

settings<Hash>

Configuration settings to use. These are merged with the defaults.



104
105
106
 
# File 'lib/merb-core/config.rb', line 104

def setup(settings = {})
  @configuration = defaults.merge(settings)
end

.to_hash ⇒ Object

Returns

Hash

The config as a hash.



89
90
91
 
# File 'lib/merb-core/config.rb', line 89

def to_hash
  @configuration
end

.to_yaml ⇒ Object

Returns

String

The config as YAML.



95
96
97
 
# File 'lib/merb-core/config.rb', line 95

def to_yaml
  @configuration.to_yaml
end

.use {|@configuration| ... } ⇒ Object

Yields the configuration.

Block parameters

c<Hash>

The configuration parameters.

Examples

Merb::Config.use do |config|
  config[:exception_details] = false
end

Yields:



40
41
42
43
 
# File 'lib/merb-core/config.rb', line 40

def use
  @configuration ||= {}
  yield @configuration
end