Class: Rails::Configuration::MiddlewareStackProxy

Inherits:
Object
  • Object
show all
Defined in:
railties/lib/rails/configuration.rb

Overview

MiddlewareStackProxy is a proxy for the Rails middleware stack that allows you to configure middlewares in your application. It works basically as a command recorder, saving each command to be applied after initialization over the default middleware stack, so you can add, swap, or remove any middleware in Rails.

You can add your own middlewares by using the config.middleware.use method:

config.middleware.use Magical::Unicorns

This will put the Magical::Unicorns middleware on the end of the stack. You can use insert_before if you wish to add a middleware before another:

config.middleware.insert_before Rack::Head, Magical::Unicorns

There’s also insert_after which will insert a middleware after another:

config.middleware.insert_after Rack::Head, Magical::Unicorns

Middlewares can also be completely swapped out and replaced with others:

config.middleware.swap ActionDispatch::Flash, Magical::Unicorns

And finally they can also be removed from the stack completely:

config.middleware.delete ActionDispatch::Flash

Instance Method Summary collapse

Constructor Details

#initialize(operations = [], delete_operations = []) ⇒ MiddlewareStackProxy

Returns a new instance of MiddlewareStackProxy.



38
39
40
41
 
# File 'railties/lib/rails/configuration.rb', line 38

def initialize(operations = [], delete_operations = [])
  @operations = operations
  @delete_operations = delete_operations
end

Instance Method Details

#+(other) ⇒ Object

:nodoc:



82
83
84
 
# File 'railties/lib/rails/configuration.rb', line 82

def +(other) # :nodoc:
  MiddlewareStackProxy.new(@operations + other.operations, @delete_operations + other.delete_operations)
end

#delete(*args, &block) ⇒ Object 



65
66
67
 
# File 'railties/lib/rails/configuration.rb', line 65

def delete(*args, &block)
  @delete_operations << -> middleware { middleware.send(__method__, *args, &block) }
end

#insert_after(*args, &block) ⇒ Object 



50
51
52
 
# File 'railties/lib/rails/configuration.rb', line 50

def insert_after(*args, &block)
  @operations << -> middleware { middleware.send(__method__, *args, &block) }
end

#insert_before(*args, &block) ⇒ Object Also known as: insert 



43
44
45
 
# File 'railties/lib/rails/configuration.rb', line 43

def insert_before(*args, &block)
  @operations << -> middleware { middleware.send(__method__, *args, &block) }
end

#merge_into(other) ⇒ Object

:nodoc:



74
75
76
77
78
79
80
 
# File 'railties/lib/rails/configuration.rb', line 74

def merge_into(other) #:nodoc:
  (@operations + @delete_operations).each do |operation|
    operation.call(other)
  end

  other
end

#swap(*args, &block) ⇒ Object 



55
56
57
 
# File 'railties/lib/rails/configuration.rb', line 55

def swap(*args, &block)
  @operations << -> middleware { middleware.send(__method__, *args, &block) }
end

#unshift(*args, &block) ⇒ Object 



69
70
71
 
# File 'railties/lib/rails/configuration.rb', line 69

def unshift(*args, &block)
  @operations << -> middleware { middleware.send(__method__, *args, &block) }
end

#use(*args, &block) ⇒ Object 



60
61
62
 
# File 'railties/lib/rails/configuration.rb', line 60

def use(*args, &block)
  @operations << -> middleware { middleware.send(__method__, *args, &block) }
end