class ActionDispatch::MiddlewareStack

Attributes

middlewares[RW]

Public Class Methods

new(*args) { |self| ... } click to toggle source
# File lib/action_dispatch/middleware/stack.rb, line 70
def initialize(*args)
  @middlewares = []
  yield(self) if block_given?
end

Public Instance Methods

[](i) click to toggle source
# File lib/action_dispatch/middleware/stack.rb, line 87
def [](i)
  middlewares[i]
end
build(app = nil, &block) click to toggle source
# File lib/action_dispatch/middleware/stack.rb, line 160
def build(app = nil, &block)
  instrumenting = ActiveSupport::Notifications.notifier.listening?(InstrumentationProxy::EVENT_NAME)
  middlewares.freeze.reverse.inject(app || block) do |a, e|
    if instrumenting
      e.build_instrumented(a)
    else
      e.build(a)
    end
  end
end
delete(target) click to toggle source

Deletes a middleware from the middleware stack.

Returns the array of middlewares not including the deleted item, or returns nil if the target is not found.

# File lib/action_dispatch/middleware/stack.rb, line 125
def delete(target)
  middlewares.reject! { |m| m.name == target.name }
end
delete!(target) click to toggle source

Deletes a middleware from the middleware stack.

Returns the array of middlewares not including the deleted item, or raises RuntimeError if the target is not found.

# File lib/action_dispatch/middleware/stack.rb, line 133
def delete!(target)
  delete(target) || (raise "No such middleware to remove: #{target.inspect}")
end
each(&block) click to toggle source
# File lib/action_dispatch/middleware/stack.rb, line 75
def each(&block)
  @middlewares.each(&block)
end
initialize_copy(other) click to toggle source
# File lib/action_dispatch/middleware/stack.rb, line 96
def initialize_copy(other)
  self.middlewares = other.middlewares.dup
end
insert(index, klass, *args, &block) click to toggle source
# File lib/action_dispatch/middleware/stack.rb, line 100
def insert(index, klass, *args, &block)
  index = assert_index(index, :before)
  middlewares.insert(index, build_middleware(klass, args, block))
end
Also aliased as: insert_before
insert_after(index, *args, &block) click to toggle source
# File lib/action_dispatch/middleware/stack.rb, line 108
def insert_after(index, *args, &block)
  index = assert_index(index, :after)
  insert(index + 1, *args, &block)
end
insert_before(index, klass, *args, &block)
Alias for: insert
last() click to toggle source
# File lib/action_dispatch/middleware/stack.rb, line 83
def last
  middlewares.last
end
move(target, source) click to toggle source
# File lib/action_dispatch/middleware/stack.rb, line 137
def move(target, source)
  source_index = assert_index(source, :before)
  source_middleware = middlewares.delete_at(source_index)

  target_index = assert_index(target, :before)
  middlewares.insert(target_index, source_middleware)
end
Also aliased as: move_before
move_after(target, source) click to toggle source
# File lib/action_dispatch/middleware/stack.rb, line 147
def move_after(target, source)
  source_index = assert_index(source, :after)
  source_middleware = middlewares.delete_at(source_index)

  target_index = assert_index(target, :after)
  middlewares.insert(target_index + 1, source_middleware)
end
move_before(target, source)
Alias for: move
size() click to toggle source
# File lib/action_dispatch/middleware/stack.rb, line 79
def size
  middlewares.size
end
swap(target, *args, &block) click to toggle source
# File lib/action_dispatch/middleware/stack.rb, line 114
def swap(target, *args, &block)
  index = assert_index(target, :before)
  insert(index, *args, &block)
  middlewares.delete_at(index + 1)
end
unshift(klass, *args, &block) click to toggle source
# File lib/action_dispatch/middleware/stack.rb, line 91
def unshift(klass, *args, &block)
  middlewares.unshift(build_middleware(klass, args, block))
end
use(klass, *args, &block) click to toggle source
# File lib/action_dispatch/middleware/stack.rb, line 155
def use(klass, *args, &block)
  middlewares.push(build_middleware(klass, args, block))
end

Private Instance Methods

assert_index(index, where) click to toggle source
# File lib/action_dispatch/middleware/stack.rb, line 172
def assert_index(index, where)
  i = index.is_a?(Integer) ? index : index_of(index)
  raise "No such middleware to insert #{where}: #{index.inspect}" unless i
  i
end
build_middleware(klass, args, block) click to toggle source
# File lib/action_dispatch/middleware/stack.rb, line 178
def build_middleware(klass, args, block)
  Middleware.new(klass, args, block)
end
index_of(klass) click to toggle source
# File lib/action_dispatch/middleware/stack.rb, line 182
def index_of(klass)
  middlewares.index do |m|
    m.name == klass.name
  end
end