Class: ActionController::Dispatcher

Inherits:
Object
  • Object
show all
Includes:
ActiveSupport::Callbacks
Defined in:
actionpack/lib/action_controller/dispatcher.rb

Overview

Dispatches requests to the appropriate controller and takes care of reloading the app after each request when Dependencies.load? is true.

Constant Summary

@@cache_classes =
true

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods included from ActiveSupport::Callbacks

included, #run_callbacks

Constructor Details

- (Dispatcher) initialize(output = $stdout, request = nil, response = nil)

DEPRECATE: Remove arguments, since they are only used by CGI



79
80
81
82
# File 'actionpack/lib/action_controller/dispatcher.rb', line 79

def initialize(output = $stdout, request = nil, response = nil)
  @output = output
  build_middleware_stack if @@cache_classes
end

Class Method Details

+ (Object) cleanup_application



61
62
63
64
65
66
# File 'actionpack/lib/action_controller/dispatcher.rb', line 61

def cleanup_application
  # Cleanup the application before processing the current request.
  ActiveRecord::Base.reset_subclasses if defined?(ActiveRecord)
  ActiveSupport::Dependencies.clear
  ActiveRecord::Base.clear_reloadable_connections! if defined?(ActiveRecord)
end

+ (Object) define_dispatcher_callbacks(cache_classes)



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# File 'actionpack/lib/action_controller/dispatcher.rb', line 8

def define_dispatcher_callbacks(cache_classes)
  @@cache_classes = cache_classes
  unless cache_classes
    ActionView::Helpers::AssetTagHelper.cache_asset_timestamps = false
  end

  if defined?(ActiveRecord)
    to_prepare(:activerecord_instantiate_observers) { ActiveRecord::Base.instantiate_observers }
  end

  after_dispatch :flush_logger if Base.logger && Base.logger.respond_to?(:flush)

  to_prepare do
    I18n.reload!
  end
end

+ (Object) dispatch(cgi = nil, session_options = CgiRequest::DEFAULT_SESSION_OPTIONS, output = $stdout)

DEPRECATE: Remove CGI support



26
27
28
# File 'actionpack/lib/action_controller/dispatcher.rb', line 26

def dispatch(cgi = nil, session_options = CgiRequest::DEFAULT_SESSION_OPTIONS, output = $stdout)
  new(output).dispatch_cgi(cgi, session_options)
end

+ (Object) reload_application



54
55
56
57
58
59
# File 'actionpack/lib/action_controller/dispatcher.rb', line 54

def reload_application
  # Run prepare callbacks before every request in development mode
  run_prepare_callbacks

  Routing::Routes.reload
end

+ (Object) run_prepare_callbacks



44
45
46
47
48
49
50
51
52
# File 'actionpack/lib/action_controller/dispatcher.rb', line 44

def run_prepare_callbacks
  if defined?(Rails) && Rails.logger
    logger = Rails.logger
  else
    logger = Logger.new($stderr)
  end

  new(logger).send :run_callbacks, :prepare_dispatch
end

+ (Object) to_prepare(identifier = nil, &block)

Add a preparation callback. Preparation callbacks are run before every request in development mode, and before the first request in production mode.

An optional identifier may be supplied for the callback. If provided, to_prepare may be called again with the same identifier to replace the existing callback. Passing an identifier is a suggested practice if the code adding a preparation block may be reloaded.



38
39
40
41
42
# File 'actionpack/lib/action_controller/dispatcher.rb', line 38

def to_prepare(identifier = nil, &block)
  @prepare_dispatch_callbacks ||= ActiveSupport::Callbacks::CallbackChain.new
  callback = ActiveSupport::Callbacks::Callback.new(:prepare_dispatch, block, :identifier => identifier)
  @prepare_dispatch_callbacks.replace_or_append!(callback)
end

Instance Method Details

- (Object) _call(env)



119
120
121
122
# File 'actionpack/lib/action_controller/dispatcher.rb', line 119

def _call(env)
  @env = env
  dispatch
end

- (Object) call(env)



104
105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'actionpack/lib/action_controller/dispatcher.rb', line 104

def call(env)
  if @@cache_classes
    @app.call(env)
  else
    Reloader.run do
      # When class reloading is turned on, we will want to rebuild the
      # middleware stack every time we process a request. If we don't
      # rebuild the middleware stack, then the stack may contain references
      # to old classes metal classes, which will b0rk class reloading.
      build_middleware_stack
      @app.call(env)
    end
  end
end

- (Object) dispatch



84
85
86
87
88
89
90
91
92
93
94
95
96
97
# File 'actionpack/lib/action_controller/dispatcher.rb', line 84

def dispatch
  begin
    run_callbacks :before_dispatch
    Routing::Routes.call(@env)
  rescue Exception => exception
    if controller ||= (::ApplicationController rescue Base)
      controller.call_with_exception(@env, exception).to_a
    else
      raise exception
    end
  ensure
    run_callbacks :after_dispatch, :enumerator => :reverse_each
  end
end

- (Object) dispatch_cgi(cgi, session_options)

DEPRECATE: Remove CGI support



100
101
102
# File 'actionpack/lib/action_controller/dispatcher.rb', line 100

def dispatch_cgi(cgi, session_options)
  CGIHandler.dispatch_cgi(self, cgi, @output)
end

- (Object) flush_logger



124
125
126
# File 'actionpack/lib/action_controller/dispatcher.rb', line 124

def flush_logger
  Base.logger.flush
end