Class: Muding::Initializer

Inherits:
Object show all
Defined in:
lib/initializer.rb

Overview

The Initializer is responsible for processing the Muding configuration, such as setting the $LOAD_PATH, requiring the right frameworks, initializing logging, and more. It can be run either as a single command that’ll just use the default configuration, like this:

Muding::Initializer.run

But normally it’s more interesting to pass in a custom configuration through the block running:

Muding::Initializer.run do |config|
  config.frameworks -= [ :action_web_service ]
end

This will use the default configuration options from Muding::Configuration, but allow for overwriting on select areas.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(configuration) ⇒ Initializer

Create a new Initializer instance that references the given Configuration instance.



47
48
49
50
 
# File 'lib/initializer.rb', line 47

def initialize(configuration)
  @configuration = configuration
  @loaded_plugins = Set.new
end

Instance Attribute Details

#configuration ⇒ Object (readonly)

The Configuration instance used by this Initializer instance.



25
26
27
 
# File 'lib/initializer.rb', line 25

def configuration
  @configuration
end

#loaded_plugins ⇒ Object (readonly)

The set of loaded plugins.



28
29
30
 
# File 'lib/initializer.rb', line 28

def loaded_plugins
  @loaded_plugins
end

Class Method Details

.run(command = :process, configuration = Configuration.new) {|configuration| ... } ⇒ Object

Runs the initializer. By default, this will invoke the #process method, which simply executes all of the initialization routines. Alternately, you can specify explicitly which initialization routine you want:

Muding::Initializer.run(:set_load_path)

This is useful if you only want the load path initialized, without incuring the overhead of completely loading the entire environment.

Yields:



38
39
40
41
42
43
 
# File 'lib/initializer.rb', line 38

def self.run(command = :process, configuration = Configuration.new)
  yield configuration if block_given?
  initializer = new configuration
  initializer.send(command)
  initializer
end

Instance Method Details

#add_support_load_paths ⇒ Object

Add the load paths used by support functions such as the info controller



135
136
137
138
 
# File 'lib/initializer.rb', line 135

def add_support_load_paths
  builtins = File.join(File.dirname(File.dirname(__FILE__)), 'builtin', '*')
  $LOAD_PATH.concat(Dir[builtins])
end

#after_initialize ⇒ Object

Fires the user-supplied after_initialize block (Configuration#after_initialize)



280
281
282
 
# File 'lib/initializer.rb', line 280

def after_initialize
  configuration.after_initialize_block.call if configuration.after_initialize_block
end

#check_ruby_version ⇒ Object

Check for valid Ruby version This is done in an external file, so we can use it from the ‘muding` program as well without duplication.



108
109
110
 
# File 'lib/initializer.rb', line 108

def check_ruby_version    
  require 'ruby_version_check'
end

#initialize_breakpoints ⇒ Object

Sets the BREAKPOINT_SERVER_PORT if Configuration#breakpoint_server is true.



244
245
246
 
# File 'lib/initializer.rb', line 244

def initialize_breakpoints
  silence_warnings { Object.const_set("BREAKPOINT_SERVER_PORT", 42531) if configuration.breakpoint_server }
end

#initialize_database ⇒ Object

This initialization routine does nothing unless :active_record is one of the frameworks to load (Configuration#frameworks). If it is, this sets the database configuration from Configuration#database_configuration and then establishes the connection.



173
174
175
176
177
 
# File 'lib/initializer.rb', line 173

def initialize_database
  return unless configuration.frameworks.include?(:active_record)
  ActiveRecord::Base.configurations = configuration.database_configuration
  ActiveRecord::Base.establish_connection(MUDING_ENV)
end

#initialize_dependency_mechanism ⇒ Object

Sets the dependency loading mechanism based on the value of Configuration#cache_classes.



238
239
240
 
# File 'lib/initializer.rb', line 238

def initialize_dependency_mechanism
  Dependencies.mechanism = configuration.cache_classes ? :require : :load
end

#initialize_framework_logging ⇒ Object

Sets the logger for ActiveRecord, ActionController, and ActionMailer (but only for those frameworks that are to be loaded). If the framework’s logger is already set, it is not changed, otherwise it is set to use MUDING_DEFAULT_LOGGER.



212
213
214
215
216
 
# File 'lib/initializer.rb', line 212

def initialize_framework_logging
  for framework in ([ :active_record, :action_controller, :action_mailer ] & configuration.frameworks)
    framework.to_s.camelize.constantize.const_get("Base").logger ||= MUDING_DEFAULT_LOGGER
  end
end

#initialize_framework_settings ⇒ Object

Initializes framework-specific settings for each of the loaded frameworks (Configuration#frameworks). The available settings map to the accessors on each of the corresponding Base classes.



269
270
271
272
273
274
275
276
277
 
# File 'lib/initializer.rb', line 269

def initialize_framework_settings
  configuration.frameworks.each do |framework|
    base_class = framework.to_s.camelize.constantize.const_get("Base")

    configuration.send(framework).each do |setting, value|
      base_class.send("#{setting}=", value)
    end
  end
end

#initialize_framework_views ⇒ Object

Sets the template_root for ActionController::Base and ActionMailer::Base (but only for those frameworks that are to be loaded). If the framework’s template_root has already been set, it is not changed, otherwise it is set to use Configuration#view_path.



222
223
224
225
226
 
# File 'lib/initializer.rb', line 222

def initialize_framework_views
  for framework in ([ :action_controller, :action_mailer ] & configuration.frameworks)
    framework.to_s.camelize.constantize.const_get("Base").template_root ||= configuration.view_path
  end
end

#initialize_logger ⇒ Object

If the MUDING_DEFAULT_LOGGER constant is already set, this initialization routine does nothing. If the constant is not set, and Configuration#logger is not nil, this also does nothing. Otherwise, a new logger instance is created at Configuration#log_path, with a default log level of Configuration#log_level.

If the log could not be created, the log will be set to output to STDERR, with a log level of WARN.



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/initializer.rb', line 187

def initialize_logger
  # if the environment has explicitly defined a logger, use it
  return if defined?(MUDING_DEFAULT_LOGGER)

  unless logger = configuration.logger
    begin
      logger = Logger.new(configuration.log_path)
      logger.level = Logger.const_get(configuration.log_level.to_s.upcase)
    rescue StandardError
      logger = Logger.new(STDERR)
      logger.level = Logger::WARN
      logger.warn(
        "Muding Error: Unable to access log file. Please ensure that #{configuration.log_path} exists and is chmod 0666. " +
        "The log level has been raised to WARN and the output directed to STDERR until the problem is fixed."
      )
    end
  end
  
  silence_warnings { Object.const_set "MUDING_DEFAULT_LOGGER", logger }
end

#initialize_routing ⇒ Object

If ActionController is not one of the loaded frameworks (Configuration#frameworks) this does nothing. Otherwise, it loads the routing definitions and sets up loading module used to lazily load controllers (Configuration#controller_paths).



231
232
233
234
 
# File 'lib/initializer.rb', line 231

def initialize_routing
  return unless configuration.frameworks.include?(:action_controller)
  ActionController::Routing::Routes.reload
end

#initialize_temporary_directories ⇒ Object 



254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/initializer.rb', line 254

def initialize_temporary_directories
  if configuration.frameworks.include?(:action_controller)
    session_path = "#{MUDING_ROOT}/tmp/sessions/"
    ActionController::Base.session_options[:tmpdir] = File.exist?(session_path) ? session_path : Dir::tmpdir
    
    cache_path = "#{MUDING_ROOT}/tmp/cache/"
    if File.exist?(cache_path)
      ActionController::Base.fragment_cache_store = :file_store, cache_path
    end
  end
end

#initialize_whiny_nils ⇒ Object

Loads support for “whiny nil” (noisy warnings when methods are invoked on nil values) if Configuration#whiny_nils is true.



250
251
252
 
# File 'lib/initializer.rb', line 250

def initialize_whiny_nils
  require('active_support/whiny_nil') if configuration.whiny_nils
end

#load_environment ⇒ Object

Loads the environment specified by Configuration#environment_path, which is typically one of development, testing, or production.



158
159
160
161
162
163
164
165
166
167
 
# File 'lib/initializer.rb', line 158

def load_environment
  silence_warnings do
    config = configuration
    constants = self.class.constants
    eval(IO.read(configuration.environment_path), binding)
    (self.class.constants - constants).each do |const|
      Object.const_set(const, self.class.const_get(const))
    end
  end
end

#load_plugins ⇒ Object

Loads all plugins in config.plugin_paths. plugin_paths defaults to vendor/plugins but may also be set to a list of paths, such as

config.plugin_paths = ['lib/plugins', 'vendor/plugins']

Each plugin discovered in plugin_paths is initialized:

  • add its lib directory, if present, to the beginning of the load path

  • evaluate init.rb if present

After all plugins are loaded, duplicates are removed from the load path. Plugins are loaded in alphabetical order.



151
152
153
154
 
# File 'lib/initializer.rb', line 151

def load_plugins
  find_plugins(configuration.plugin_paths).sort.each { |path| load_plugin path }
  $LOAD_PATH.uniq!
end

#process ⇒ Object

Sequentially step through all of the available initialization routines, in order:

  • #set_load_path

  • #set_connection_adapters

  • #require_frameworks

  • #load_environment

  • #initialize_database

  • #initialize_logger

  • #initialize_framework_logging

  • #initialize_framework_views

  • #initialize_dependency_mechanism

  • #initialize_breakpoints

  • #initialize_whiny_nils

  • #initialize_framework_settings

  • #load_environment

  • #load_plugins

  • #initialize_routing

(Note that #load_environment is invoked twice, once at the start and once at the end, to support the legacy configuration style where the environment could overwrite the defaults directly, instead of via the Configuration instance.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/initializer.rb', line 75

def process
  check_ruby_version
  set_load_path
  set_connection_adapters

  require_frameworks
  #load_environment

  initialize_database
  initialize_logger
  initialize_framework_logging
  initialize_framework_views
  initialize_dependency_mechanism
  initialize_breakpoints
  initialize_whiny_nils
  initialize_temporary_directories

  initialize_framework_settings
        
  add_support_load_paths

  load_plugins

  # Routing must be initialized after plugins to allow the former to extend the routes
  initialize_routing
  
  # the framework is now fully initialized
  after_initialize
end

#require_frameworks ⇒ Object

Requires all frameworks specified by the Configuration#frameworks list. By default, all frameworks (ActiveRecord, ActiveSupport, ActionPack, ActionMailer, and ActionWebService) are loaded.



130
131
132
 
# File 'lib/initializer.rb', line 130

def require_frameworks
  configuration.frameworks.each { |framework| require(framework.to_s) }
end

#set_connection_adapters ⇒ Object

Sets the MUDING_CONNECTION_ADAPTERS constant based on the value of Configuration#connection_adapters. This constant is used to determine which database adapters should be loaded (by default, all adapters are loaded).



123
124
125
 
# File 'lib/initializer.rb', line 123

def set_connection_adapters
  Object.const_set("MUDING_CONNECTION_ADAPTERS", configuration.connection_adapters) if configuration.connection_adapters
end

#set_load_path ⇒ Object

Set the $LOAD_PATH based on the value of Configuration#load_paths. Duplicates are removed.



114
115
116
117
 
# File 'lib/initializer.rb', line 114

def set_load_path
  configuration.load_paths.reverse.each { |dir| $LOAD_PATH.unshift(dir) if File.directory?(dir) }
  $LOAD_PATH.uniq!
end