class Grape::Middleware::Stack

Class to handle the stack of middlewares based on ActionDispatch::MiddlewareStack It allows to insert and insert after

Attributes

middlewares[RW]
others[RW]

Public Class Methods

new() click to toggle source
# File lib/grape/middleware/stack.rb, line 43
def initialize
  @middlewares = []
  @others = []
end

Public Instance Methods

[](index) click to toggle source
# File lib/grape/middleware/stack.rb, line 60
def [](index)
  middlewares[index]
end
build(builder = Rack::Builder.new) click to toggle source

@return [Rack::Builder] the builder object with our middlewares applied

# File lib/grape/middleware/stack.rb, line 96
def build(builder = Rack::Builder.new)
  others.shift(others.size).each { |m| merge_with(m) }
  middlewares.each do |m|
    m.use_in(builder)
  end
  builder
end
concat(other_specs) click to toggle source

@description Add middlewares with :use operation to the stack. Store others with :insert_* operation for later @param [Array] other_specs An array of middleware specifications (e.g. [[:use, klass], [:insert_before, *args]])

# File lib/grape/middleware/stack.rb, line 106
def concat(other_specs)
  @others << Array(other_specs).reject { |o| o.first == :use }
  merge_with(Array(other_specs).select { |o| o.first == :use })
end
each(&block) click to toggle source
# File lib/grape/middleware/stack.rb, line 48
def each(&block)
  @middlewares.each(&block)
end
insert(index, *args, &block) click to toggle source
# File lib/grape/middleware/stack.rb, line 64
def insert(index, *args, &block)
  index = assert_index(index, :before)
  middleware = self.class::Middleware.new(*args, &block)
  middlewares.insert(index, middleware)
end
Also aliased as: insert_before
insert_after(index, *args, &block) click to toggle source
# File lib/grape/middleware/stack.rb, line 73
def insert_after(index, *args, &block)
  index = assert_index(index, :after)
  insert(index + 1, *args, &block)
end
insert_before(index, *args, &block)
Alias for: insert
last() click to toggle source
# File lib/grape/middleware/stack.rb, line 56
def last
  middlewares.last
end
merge_with(middleware_specs) click to toggle source
# File lib/grape/middleware/stack.rb, line 84
def merge_with(middleware_specs)
  middleware_specs.each do |operation, *args|
    if args.last.is_a?(Proc)
      last_proc = args.pop
      public_send(operation, *args, &last_proc)
    else
      public_send(operation, *args)
    end
  end
end
size() click to toggle source
# File lib/grape/middleware/stack.rb, line 52
def size
  middlewares.size
end
use(...) click to toggle source
# File lib/grape/middleware/stack.rb, line 79
def use(...)
  middleware = self.class::Middleware.new(...)
  middlewares.push(middleware)
end

Protected Instance Methods

assert_index(index, where) click to toggle source
# File lib/grape/middleware/stack.rb, line 113
def assert_index(index, where)
  i = index.is_a?(Integer) ? index : middlewares.index(index)
  i || raise("No such middleware to insert #{where}: #{index.inspect}")
end