Class: Merb::Config
- Defined in:
- lib/merb-core/config.rb,
lib/merb-core/dispatch/session.rb
Defined Under Namespace
Classes: ConfigBlock
Class Attribute Summary collapse
-
.configuration ⇒ Object
Returns the value of attribute configuration.
Class Method Summary collapse
-
.[](key) ⇒ Object
Retrieve the value of a config entry.
-
.[]=(key, val) ⇒ Object
Set the value of a config entry.
-
.configure(&block) ⇒ Object
Set configuration parameters from a code block, where each method evaluates to a config parameter.
-
.defaults ⇒ Object
private
Returns the hash of default config values for Merb.
-
.delete(key) ⇒ Object
Remove the value of a config entry.
-
.fetch(key, default) ⇒ Object
Retrieve the value of a config entry, returning the provided default if the key is not present.
-
.key?(key) ⇒ Boolean
Detects whether the provided key is in the config.
-
.method_missing(method, *args) ⇒ Object
Allows retrieval of single key config values via Merb.config.<key> Allows single key assignment via Merb.config.<key> = …
-
.parse_args(argv = ARGV) ⇒ Object
private
Parses the command line arguments and stores them in the config.
-
.session_stores ⇒ Object
private
Returns stores list constructed from configured session stores (:session_stores config option) or default one (:session_store config option).
-
.setup(settings = {}) ⇒ Object
private
Sets up the configuration by storing the given settings.
-
.to_hash ⇒ Object
Returns the configuration as a hash.
-
.to_yaml ⇒ Object
Returns the config as YAML.
-
.use {|@configuration| ... } ⇒ Object
Yields the configuration.
Class Attribute Details
.configuration ⇒ Object
Returns the value of attribute configuration.
394 395 396 |
# File 'lib/merb-core/config.rb', line 394 def configuration @configuration end |
Class Method Details
.[](key) ⇒ Object
Retrieve the value of a config entry.
Parameters
- key<Object>
-
The key to retrieve the parameter for.
Returns
- Object
-
The value of the configuration parameter.
79 80 81 |
# File 'lib/merb-core/config.rb', line 79 def [](key) (@configuration ||= setup)[key] end |
.[]=(key, val) ⇒ Object
Set the value of a config entry.
Parameters
- key<Object>
-
The key to set the parameter for.
- val<Object>
-
The value of the parameter.
88 89 90 |
# File 'lib/merb-core/config.rb', line 88 def []=(key, val) (@configuration ||= setup)[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"
log_file Merb.root / "log" / "special.log"
end
Returns
nil
414 415 416 417 |
# File 'lib/merb-core/config.rb', line 414 def configure(&block) ConfigBlock.new(self, &block) if block_given? nil end |
.defaults ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns the hash of default config values for Merb.
Returns
- Hash
-
The defaults for the config.
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
# File 'lib/merb-core/config.rb', line 15 def defaults @defaults ||= { :host => "0.0.0.0", :port => "4000", :adapter => "runner", :reload_classes => true, :fork_for_class_load => Merb.forking_environment?, :environment => "development", :merb_root => Dir.pwd, :use_mutex => true, :log_delimiter => " ~ ", :log_auto_flush => false, :log_level => :info, :log_stream => STDOUT, :disabled_components => Merb.on_windows? ? [:signals] : [], :deferred_actions => [], :verbose => false, :name => "merb" } end |
.delete(key) ⇒ Object
Remove the value of a config entry.
Parameters
- key<Object>
-
The key of the parameter to delete.
Returns
- Object
-
The value of the removed entry.
101 102 103 |
# File 'lib/merb-core/config.rb', line 101 def delete(key) @configuration.delete(key) end |
.fetch(key, default) ⇒ Object
Retrieve the value of a config entry, returning the provided default if the key is not present
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.
114 115 116 |
# File 'lib/merb-core/config.rb', line 114 def fetch(key, default) @configuration.fetch(key, default) end |
.key?(key) ⇒ Boolean
Detects whether the provided key is in the config.
Parameters
- key<Object>
-
The key to check.
Returns
- Boolean
-
True if the key exists in the config.
66 67 68 |
# File 'lib/merb-core/config.rb', line 66 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.
Returns
The value of the entry fetched or assigned to.
430 431 432 433 434 435 436 |
# File 'lib/merb-core/config.rb', line 430 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
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Parses the command line arguments and stores them in the config.
Parameters
- argv<String>
-
The command line arguments. Defaults to
ARGV
.
Returns
The configuration as a hash.
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 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 |
# File 'lib/merb-core/config.rb', line 168 def parse_args(argv = ARGV) @configuration ||= {} # Our primary configuration hash for the length of this method = {} # Environment variables always win [: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. = "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| [: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| [:group] = group end opts.on("-d", "--daemonize", "This will run a single merb in the " \ "background.") do |daemon| [:daemonize] = true end opts.on("-N", "--no-daemonize", "This will allow you to run a " \ "cluster in console mode") do |no_daemon| [:daemonize] = false end opts.on("-c", "--cluster-nodes NUM_MERBS", Integer, "Number of merb daemons to run.") do |nodes| [:daemonize] = true unless .key?(:daemonize) [:cluster] = nodes end opts.on("-I", "--init-file FILE", "File to use for initialization " \ "on load, defaults to config/init.rb") do |init_file| [:init_file] = init_file end opts.on("-p", "--port PORTNUM", Integer, "Port to run merb on, " \ "defaults to 4000.") do |port| [:port] = port end opts.on("-o", "--socket-file FILE", "Socket file to run merb on, " \ "defaults to [Merb.root]/log/merb.sock. This is for " \ "web servers, like thin, that use sockets." \ "Specify this *only* if you *must*.") do |port| [:socket_file] = port end opts.on("-s", "--socket SOCKNUM", Integer, "Socket number to run " \ "merb on, defaults to 0.") do |port| [:socket] = port end opts.on("-n", "--name NAME", String, "Set the name of the application. "\ "This is used in the process title and log file names.") do |name| [:name] = name end opts.on("-P", "--pid PIDFILE", "PID file, defaults to " \ "[Merb.root]/log/merb.main.pid for the master process and" \ "[Merb.root]/log/merb.[port number].pid for worker " \ "processes. For clusters, use %s to specify where " \ "in the file merb should place the port number. For " \ "instance: -P myapp.%s.pid") do |pid_file| [:pid_file] = pid_file end opts.on("-h", "--host HOSTNAME", "Host to bind to " \ "(default is 0.0.0.0).") do |host| [: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 directory).") do |root| [:merb_root] = File.(root) end adapters = [:mongrel, :emongrel, :thin, :ebb, :fastcgi, :webrick] opts.on("-a", "--adapter ADAPTER", "The rack adapter to use to run merb (default is mongrel)" \ "[#{adapters.join(', ')}]") do |adapter| [:adapter] ||= adapter end opts.on("-R", "--rackup FILE", "Load an alternate Rack config " \ "file (default is config/rack.rb)") do |rackup| [: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| [: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| [:sandbox] = true end opts.on("-l", "--log-level LEVEL", "Log levels can be set to any of " \ "these options: debug < info < warn < error < " \ "fatal (default is info)") do |log_level| [:log_level] = log_level.to_sym [:force_logging] = true end opts.on("-L", "--log LOGFILE", "A string representing the logfile to " \ "use. Defaults to [Merb.root]/log/merb.[main].log for the " \ "master process and [Merb.root]/log/merb[port number].log" \ "for worker processes") do |log_file| [:log_file] = log_file [:force_logging] = true end opts.on("-e", "--environment STRING", "Environment to run Merb " \ "under [development, production, testing] " \ "(default is development)") do |env| [: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| [:runner_code] = code_or_file [: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| [:action] = :kill ports = "main" if ports == "all" [:port] = ports end opts.on("-k", "--kill PORT", "Force kill one merb worker " \ "by port number. This will cause the worker to" \ "be respawned.") do |port| [:action] = :kill_9 port = "main" if port == "all" [:port] = port end opts.on("--fast-deploy", "Reload the code, but not your" \ "init.rb or gems") do [:action] = :fast_deploy end # @todo Do we really need this flag? It seems unlikely to want to # change the mutex from the command-line. opts.on("-X", "--mutex on/off", "This flag is for turning the " \ "mutex lock on and off.") do |mutex| if mutex == "off" [:use_mutex] = false else [:use_mutex] = true end end opts.on("-D", "--debugger", "Run merb using rDebug.") do begin require "ruby-debug" Debugger.start # Load up any .rdebugrc files we find [".", ENV["HOME"], ENV["HOMEPATH"]].each do |script_dir| script_file = "#{script_dir}/.rdebugrc" Debugger.run_script script_file, StringIO.new if File.exists?(script_file) end if Debugger.respond_to?(:settings) Debugger.settings[:autoeval] = true end 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 [:verbose] = true end opts.on("-C", "--console-trap", "Enter an irb console on ^C") do [:console_trap] = true end opts.on("-?", "-H", "--help", "Show this help message") do puts opts exit end end # Parse what we have on the command line begin opts.parse!(argv) rescue OptionParser::InvalidOption => e Merb.fatal! e., e end Merb::Config.setup() end |
.session_stores ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns stores list constructed from configured session stores (:session_stores config option) or default one (:session_store config option).
11 12 13 14 15 16 17 18 |
# File 'lib/merb-core/dispatch/session.rb', line 11 def self.session_stores @session_stores ||= begin config_stores = Array( Merb::Config[:session_stores] || Merb::Config[:session_store] ) config_stores.map { |name| name.to_sym } end end |
.setup(settings = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Sets up the configuration by storing the given settings.
Parameters
- settings<Hash>
-
Configuration settings to use. These are merged with the defaults.
Returns
The configuration as a hash.
149 150 151 152 153 154 155 156 157 |
# File 'lib/merb-core/config.rb', line 149 def setup(settings = {}) @configuration = defaults.merge(settings) unless @configuration[:reload_classes] @configuration[:fork_for_class_load] = false end @configuration end |
.to_hash ⇒ Object
Returns the configuration as a hash.
Returns
- Hash
-
The config as a hash.
124 125 126 |
# File 'lib/merb-core/config.rb', line 124 def to_hash @configuration end |
.to_yaml ⇒ Object
Returns the config as YAML.
Returns
- String
-
The config as YAML.
134 135 136 137 |
# File 'lib/merb-core/config.rb', line 134 def to_yaml require "yaml" @configuration.to_yaml end |
.use {|@configuration| ... } ⇒ Object
51 52 53 54 55 |
# File 'lib/merb-core/config.rb', line 51 def use @configuration ||= {} yield @configuration nil end |