aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib/action_dispatch/middleware/callbacks.rb
blob: 7cf75ffe63f2dfee2fc6bc6028d663bdfbd3ee7c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
module ActionDispatch
  # Provide callbacks to be executed before and after the request dispatch.
  #
  # It also provides a to_prepare callback, which is performed in all requests
  # in development by only once in production and notification callback for async
  # operations.
  #
  class Callbacks
    include ActiveSupport::Callbacks

    define_callbacks :call, :terminator => "result == false", :rescuable => true
    define_callbacks :prepare, :scope => :name

    # Add a preparation callback. Preparation callbacks are run before every
    # request in development mode, and before the first request in production mode.
    #
    # If a symbol with a block is given, the symbol is used as an identifier.
    # That allows to_prepare to 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.
    def self.to_prepare(*args, &block)
      if args.first.is_a?(Symbol) && block_given?
        define_method :"__#{args.first}", &block
        set_callback(:prepare, :"__#{args.first}")
      else
        set_callback(:prepare, *args, &block)
      end
    end

    def self.before(*args, &block)
      set_callback(:call, :before, *args, &block)
    end

    def self.after(*args, &block)
      set_callback(:call, :after, *args, &block)
    end

    def initialize(app, prepare_each_request = false)
      @app, @prepare_each_request = app, prepare_each_request
      run_callbacks(:prepare) unless @prepare_each_request
    end

    def call(env)
      run_callbacks(:call) do
        run_callbacks(:prepare) if @prepare_each_request
        @app.call(env)
      end
    end
  end
end